Class IndexRequestParameters
Request options for Index
https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/index-document/
Implements
Inherited Members
Namespace: OpenSearch.Net
Assembly: OpenSearch.Net.dll
Syntax
public class IndexRequestParameters : RequestParameters<IndexRequestParameters>, 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 index 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 index 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? |
OpType
Explicit operation type. Defaults to index
for requests with an explicit document ID, and to create
for requests without an explicit
document ID
Declaration
public OpType? OpType { get; set; }
Property Value
Type | Description |
---|---|
OpType? |
Pipeline
The pipeline id to preprocess incoming documents with
Declaration
public string Pipeline { 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 to be an alias. Default is false
Declaration
public bool? RequireAlias { get; set; }
Property Value
Type | Description |
---|---|
bool? |
Routing
Specific routing value
Declaration
public string Routing { get; set; }
Property Value
Type | Description |
---|---|
string |
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 |
Version
Explicit version number for concurrency control
Declaration
public long? Version { get; set; }
Property Value
Type | Description |
---|---|
long? |
VersionType
Specific version type
Declaration
public VersionType? VersionType { get; set; }
Property Value
Type | Description |
---|---|
VersionType? |
WaitForActiveShards
Sets the number of shard copies that must be active before proceeding with the index 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 |