Class UpdateRequestParameters

Request options for Update

<p>https://docs.opensearch.org/latest/api-reference/document-apis/update-document/</p>
Inheritance
object
RequestParameters<UpdateRequestParameters>
UpdateRequestParameters
Implements
Inherited Members
Namespace: OpenSearch.Net
Assembly: OpenSearch.Net.dll
Syntax
public class UpdateRequestParameters : RequestParameters<UpdateRequestParameters>, IRequestParameters

Properties

| Edit this page View Source

DefaultHttpMethod

Declaration
public override HttpMethod DefaultHttpMethod { get; }
Property Value
Type Description
HttpMethod
Overrides
| Edit this page View Source

IfPrimaryTerm

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

Declaration
public long? IfPrimaryTerm { get; set; }
Property Value
Type Description
long?
| Edit this page View Source

IfSequenceNumber

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

Declaration
public long? IfSequenceNumber { get; set; }
Property Value
Type Description
long?
| Edit this page View Source

Lang

The script language.

Declaration
public string Lang { get; set; }
Property Value
Type Description
string
| Edit this page View Source

OperationName

The OpenSearch REST API operation name this request maps to (for example search or indices.create), used as the OpenTelemetry span name and db.operation tag. null for requests that do not correspond to a named API operation.

Declaration
public override string OperationName { get; }
Property Value
Type Description
string
Overrides
| Edit this page View Source

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 Refresh? Refresh { get; set; }
Property Value
Type Description
Refresh?
| Edit this page View Source

RequireAlias

If true, the destination must be an index alias.

Declaration
public bool? RequireAlias { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

RetryOnConflict

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

Declaration
public int? RetryOnConflict { get; set; }
Property Value
Type Description
int?
| Edit this page View Source

Routing

A custom value used to route operations to a specific shard.

Declaration
public string[] Routing { get; set; }
Property Value
Type Description
string[]
| Edit this page View Source

SourceEnabled

Set to false to disable source retrieval. You can also specify a comma-separated list of the fields you want to retrieve.

Declaration
public bool? SourceEnabled { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

SupportsBody

Declaration
public override bool SupportsBody { get; }
Property Value
Type Description
bool
Overrides
| Edit this page View Source

Timeout

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 TimeSpan Timeout { get; set; }
Property Value
Type Description
TimeSpan
| Edit this page View Source

WaitForActiveShards

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 string WaitForActiveShards { get; set; }
Property Value
Type Description
string

Implements

Extension Methods