Class UpdateRequestParameters
Request options for Update
https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/update-document/
Implements
Inherited Members
Namespace: OpenSearch.Net
Assembly: OpenSearch.Net.dll
Syntax
public class UpdateRequestParameters : RequestParameters<UpdateRequestParameters>, IRequestParameters
Properties
| Edit this page View SourceDefaultHttpMethod
Declaration
public override HttpMethod DefaultHttpMethod { get; }
Property Value
Type | Description |
---|---|
HttpMethod |
Overrides
| Edit this page View SourceIfPrimaryTerm
only perform the update operation if the last operation that has changed the document has the specified primary term
Declaration
public long? IfPrimaryTerm { get; set; }
Property Value
Type | Description |
---|---|
long? |
IfSequenceNumber
only perform the update operation if the last operation that has changed the document has the specified sequence number
Declaration
public long? IfSequenceNumber { get; set; }
Property Value
Type | Description |
---|---|
long? |
Lang
The script language (default: painless)
Declaration
public string Lang { get; set; }
Property Value
Type | Description |
---|---|
string |
Refresh
If true
then refresh 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
(the default) then do nothing with refreshes.
Declaration
public Refresh? Refresh { get; set; }
Property Value
Type | Description |
---|---|
Refresh? |
RequireAlias
When true, requires destination is an alias. Default is false
Declaration
public bool? RequireAlias { get; set; }
Property Value
Type | Description |
---|---|
bool? |
RetryOnConflict
Specify how many times should the operation be retried when a conflict occurs (default: 0)
Declaration
public long? RetryOnConflict { get; set; }
Property Value
Type | Description |
---|---|
long? |
Routing
Specific routing value
Declaration
public string Routing { get; set; }
Property Value
Type | Description |
---|---|
string |
SourceEnabled
True or false to return the _source field or not, or a list of fields to return
Declaration
public bool? SourceEnabled { get; set; }
Property Value
Type | Description |
---|---|
bool? |
SupportsBody
Declaration
public override bool SupportsBody { get; }
Property Value
Type | Description |
---|---|
bool |
Overrides
| Edit this page View SourceTimeout
Explicit operation timeout
Declaration
public TimeSpan Timeout { get; set; }
Property Value
Type | Description |
---|---|
TimeSpan |
WaitForActiveShards
Sets the number of shard copies that must be active before proceeding with the update operation. Defaults to 1, meaning the primary shard
only. Set to all
for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the
shard (number of replicas + 1)
Declaration
public string WaitForActiveShards { get; set; }
Property Value
Type | Description |
---|---|
string |