Class BulkRequestParameters
Request options for Bulk
https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/bulk/
Implements
Inherited Members
Namespace: OpenSearch.Net
Assembly: OpenSearch.Net.dll
Syntax
public class BulkRequestParameters : RequestParameters<BulkRequestParameters>, IRequestParameters
Properties
| Edit this page View SourceDefaultHttpMethod
Declaration
public override HttpMethod DefaultHttpMethod { get; }
Property Value
Type | Description |
---|---|
HttpMethod |
Overrides
| Edit this page View SourcePipeline
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
Sets require_alias for all incoming documents. Defaults to unset (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 |
SourceEnabled
True or false to return the _source field or not, or default list of fields to return, can be overridden on each sub-request
Declaration
public bool? SourceEnabled { get; set; }
Property Value
Type | Description |
---|---|
bool? |
SourceExcludes
Default list of fields to exclude from the returned _source field, can be overridden on each sub-request
Declaration
public string[] SourceExcludes { get; set; }
Property Value
Type | Description |
---|---|
string[] |
SourceIncludes
Default list of fields to extract and return from the _source field, can be overridden on each sub-request
Declaration
public string[] SourceIncludes { 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 |
TypeQueryString
Default document type for items which don't provide one
Declaration
public string TypeQueryString { get; set; }
Property Value
Type | Description |
---|---|
string |
WaitForActiveShards
Sets the number of shard copies that must be active before proceeding with the bulk 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 |