Class UpdateDescriptor<TDocument, TPartialDocument>

Descriptor for Update

https://opensearch.org/docs/latest/api-reference/document-apis/update-document/

Inheritance

object

RequestBase<UpdateRequestParameters>

RequestDescriptorBase<UpdateDescriptor<TDocument, TPartialDocument>, UpdateRequestParameters, IUpdateRequest<TDocument, TPartialDocument>>

UpdateDescriptor<TDocument, TPartialDocument>

Implements

IDescriptor

IUpdateRequest<TDocument, TPartialDocument>

IRequest<UpdateRequestParameters>

IRequest

Inherited Members

RequestDescriptorBase<UpdateDescriptor<TDocument, TPartialDocument>, UpdateRequestParameters, IUpdateRequest<TDocument, TPartialDocument>>.Self

RequestDescriptorBase<UpdateDescriptor<TDocument, TPartialDocument>, UpdateRequestParameters, IUpdateRequest<TDocument, TPartialDocument>>.Assign<TValue>(TValue, Action<IUpdateRequest<TDocument, TPartialDocument>, TValue>)

RequestDescriptorBase<UpdateDescriptor<TDocument, TPartialDocument>, UpdateRequestParameters, IUpdateRequest<TDocument, TPartialDocument>>.Qs(string, object)

RequestDescriptorBase<UpdateDescriptor<TDocument, TPartialDocument>, UpdateRequestParameters, IUpdateRequest<TDocument, TPartialDocument>>.RequestConfiguration(Func<RequestConfigurationDescriptor, IRequestConfiguration>)

RequestDescriptorBase<UpdateDescriptor<TDocument, TPartialDocument>, UpdateRequestParameters, IUpdateRequest<TDocument, TPartialDocument>>.ErrorTrace(bool?)

RequestDescriptorBase<UpdateDescriptor<TDocument, TPartialDocument>, UpdateRequestParameters, IUpdateRequest<TDocument, TPartialDocument>>.FilterPath(params string[])

RequestDescriptorBase<UpdateDescriptor<TDocument, TPartialDocument>, UpdateRequestParameters, IUpdateRequest<TDocument, TPartialDocument>>.FilterPath(IEnumerable<string>)

RequestDescriptorBase<UpdateDescriptor<TDocument, TPartialDocument>, UpdateRequestParameters, IUpdateRequest<TDocument, TPartialDocument>>.Human(bool?)

RequestDescriptorBase<UpdateDescriptor<TDocument, TPartialDocument>, UpdateRequestParameters, IUpdateRequest<TDocument, TPartialDocument>>.Pretty(bool?)

RequestDescriptorBase<UpdateDescriptor<TDocument, TPartialDocument>, UpdateRequestParameters, IUpdateRequest<TDocument, TPartialDocument>>.SourceQueryString(string)

RequestBase<UpdateRequestParameters>.HttpMethod

RequestBase<UpdateRequestParameters>.RequestState

RequestBase<UpdateRequestParameters>.ContentType

RequestBase<UpdateRequestParameters>.ResolveUrl(RouteValues, IConnectionSettingsValues)

RequestBase<UpdateRequestParameters>.RequestDefaults(UpdateRequestParameters)

RequestBase<UpdateRequestParameters>.Q<TOut>(string)

RequestBase<UpdateRequestParameters>.Q(string, object)

RequestBase<UpdateRequestParameters>.SetAcceptHeader(string)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: OpenSearch.Client

Assembly: OpenSearch.Client.dll

Syntax

public class UpdateDescriptor<TDocument, TPartialDocument> : RequestDescriptorBase<UpdateDescriptor<TDocument, TPartialDocument>, UpdateRequestParameters, IUpdateRequest<TDocument, TPartialDocument>>, IDescriptor, IUpdateRequest<TDocument, TPartialDocument>, IRequest<UpdateRequestParameters>, IRequest where TDocument : class where TPartialDocument : class

Type Parameters

Name	Description
TDocument
TPartialDocument

Constructors

UpdateDescriptor()

Used for serialization purposes, making sure we have a parameterless constructor

Declaration

protected UpdateDescriptor()

UpdateDescriptor(Id)

/{index}/_update/{id}

Declaration

public UpdateDescriptor(Id id)

Parameters

Type	Name	Description
Id	id	this parameter is required

UpdateDescriptor(IndexName, Id)

/{index}/_update/{id}

Declaration

public UpdateDescriptor(IndexName index, Id id)

Parameters

Type	Name	Description
IndexName	index	this parameter is required
Id	id	this parameter is required

UpdateDescriptor(TDocument, IndexName, Id)

/{index}/_update/{id}

Declaration

public UpdateDescriptor(TDocument documentWithId, IndexName index = null, Id id = null)

Parameters

Type	Name	Description
TDocument	documentWithId
IndexName	index
Id	id	The document used to resolve the path from

Methods

DetectNoop(bool?)

Declaration

public UpdateDescriptor<TDocument, TPartialDocument> DetectNoop(bool? detectNoop = true)

Parameters

Type	Name	Description
bool?	detectNoop

Returns

Type	Description
UpdateDescriptor<TDocument, TPartialDocument>

Doc(TPartialDocument)

The partial update document to be merged on to the existing object.

Declaration

public UpdateDescriptor<TDocument, TPartialDocument> Doc(TPartialDocument @object)

Parameters

Type	Name	Description
TPartialDocument	object

Returns

Type	Description
UpdateDescriptor<TDocument, TPartialDocument>

DocAsUpsert(bool?)

Declaration

public UpdateDescriptor<TDocument, TPartialDocument> DocAsUpsert(bool? docAsUpsert = true)

Parameters

Type	Name	Description
bool?	docAsUpsert

Returns

Type	Description
UpdateDescriptor<TDocument, TPartialDocument>

IfPrimaryTerm(long?)

Only perform the operation if the document has this primary term.

Declaration

public UpdateDescriptor<TDocument, TPartialDocument> IfPrimaryTerm(long? ifprimaryterm)

Parameters

Type	Name	Description
long?	ifprimaryterm

Returns

Type	Description
UpdateDescriptor<TDocument, TPartialDocument>

IfSequenceNumber(long?)

Only perform the operation if the document has this sequence number.

Declaration

public UpdateDescriptor<TDocument, TPartialDocument> IfSequenceNumber(long? ifsequencenumber)

Parameters

Type	Name	Description
long?	ifsequencenumber

Returns

Type	Description
UpdateDescriptor<TDocument, TPartialDocument>

Index(IndexName)

The name of the index.

Declaration

public UpdateDescriptor<TDocument, TPartialDocument> Index(IndexName index)

Parameters

Type	Name	Description
IndexName	index

Returns

Type	Description
UpdateDescriptor<TDocument, TPartialDocument>

Index<TOther>()

a shortcut into calling Index(typeof(TOther))

Declaration

public UpdateDescriptor<TDocument, TPartialDocument> Index<TOther>() where TOther : class

Returns

Type	Description
UpdateDescriptor<TDocument, TPartialDocument>

Type Parameters

Name	Description
TOther

Lang(string)

The script language.

Declaration

public UpdateDescriptor<TDocument, TPartialDocument> Lang(string lang)

Parameters

Type	Name	Description
string	lang

Returns

Type	Description
UpdateDescriptor<TDocument, TPartialDocument>

Refresh(Refresh?)

If 'true', OpenSearch refreshes the affected shards to make this operation visible to search, if 'wait_for' then wait for a refresh to make this operation visible to search, if 'false' do nothing with refreshes.

Declaration

public UpdateDescriptor<TDocument, TPartialDocument> Refresh(Refresh? refresh)

Parameters

Type	Name	Description
Refresh?	refresh

Returns

Type	Description
UpdateDescriptor<TDocument, TPartialDocument>

RequireAlias(bool?)

If true, the destination must be an index alias.

Declaration

public UpdateDescriptor<TDocument, TPartialDocument> RequireAlias(bool? requirealias = true)

Parameters

Type	Name	Description
bool?	requirealias

Returns

Type	Description
UpdateDescriptor<TDocument, TPartialDocument>

RetryOnConflict(long?)

Specify how many times should the operation be retried when a conflict occurs.

Declaration

public UpdateDescriptor<TDocument, TPartialDocument> RetryOnConflict(long? retryonconflict)

Parameters

Type	Name	Description
long?	retryonconflict

Returns

Type	Description
UpdateDescriptor<TDocument, TPartialDocument>

Routing(Routing)

A document is routed to a particular shard in an index using the following formula

shard_num = hash(_routing) % num_primary_shards

OpenSearch will use the document id if not provided.

For requests that are constructed from/for a document OpenSearch.Client will automatically infer the routing key if that document has a JoinField or a routing mapping on for its type exists on ConnectionSettings

Declaration

public UpdateDescriptor<TDocument, TPartialDocument> Routing(Routing routing)

Parameters

Type	Name	Description
Routing	routing

Returns

Type	Description
UpdateDescriptor<TDocument, TPartialDocument>

Script(Func<ScriptDescriptor, IScript>)

Declaration

public UpdateDescriptor<TDocument, TPartialDocument> Script(Func<ScriptDescriptor, IScript> scriptSelector)

Parameters

Type	Name	Description
Func<ScriptDescriptor, IScript>	scriptSelector

Returns

Type	Description
UpdateDescriptor<TDocument, TPartialDocument>

ScriptedUpsert(bool?)

Declaration

public UpdateDescriptor<TDocument, TPartialDocument> ScriptedUpsert(bool? scriptedUpsert = true)

Parameters

Type	Name	Description
bool?	scriptedUpsert

Returns

Type	Description
UpdateDescriptor<TDocument, TPartialDocument>

Source(Func<SourceFilterDescriptor<TDocument>, ISourceFilter>)

Declaration

public UpdateDescriptor<TDocument, TPartialDocument> Source(Func<SourceFilterDescriptor<TDocument>, ISourceFilter> selector)

Parameters

Type	Name	Description
Func<SourceFilterDescriptor<TDocument>, ISourceFilter>	selector

Returns

Type	Description
UpdateDescriptor<TDocument, TPartialDocument>

Source(bool?)

Declaration

public UpdateDescriptor<TDocument, TPartialDocument> Source(bool? enabled = true)

Parameters

Type	Name	Description
bool?	enabled

Returns

Type	Description
UpdateDescriptor<TDocument, TPartialDocument>

SourceEnabled(bool?)

Whether the _source should be included in the response.

Declaration

public UpdateDescriptor<TDocument, TPartialDocument> SourceEnabled(bool? sourceenabled = true)

Parameters

Type	Name	Description
bool?	sourceenabled

Returns

Type	Description
UpdateDescriptor<TDocument, TPartialDocument>

Timeout(Time)

Period to wait for dynamic mapping updates and active shards. This guarantees OpenSearch waits for at least the timeout before failing. The actual wait time could be longer, particularly when multiple waits occur.

Declaration

public UpdateDescriptor<TDocument, TPartialDocument> Timeout(Time timeout)

Parameters

Type	Name	Description
Time	timeout

Returns

Type	Description
UpdateDescriptor<TDocument, TPartialDocument>

Upsert(TDocument)

The full document to be created if an existing document does not exist for a partial merge.

Declaration

public UpdateDescriptor<TDocument, TPartialDocument> Upsert(TDocument upsertObject)

Parameters

Type	Name	Description
TDocument	upsertObject

Returns

Type	Description
UpdateDescriptor<TDocument, TPartialDocument>

WaitForActiveShards(string)

The number of shard copies that must be active before proceeding with the operations. Set to 'all' or any positive integer up to the total number of shards in the index (number_of_replicas+1). Defaults to 1 meaning the primary shard.

Declaration

public UpdateDescriptor<TDocument, TPartialDocument> WaitForActiveShards(string waitforactiveshards)

Parameters

Type	Name	Description
string	waitforactiveshards

Returns

Type	Description
UpdateDescriptor<TDocument, TPartialDocument>

Implements

IDescriptor

IUpdateRequest<TDocument, TPartialDocument>

IRequest<TParameters>

IRequest

Extension Methods

SuffixExtensions.Suffix(object, string)