Class BulkRequestParameters

Request options for Bulk

<p>https://docs.opensearch.org/latest/api-reference/document-apis/bulk/</p>
Inheritance
object
RequestParameters<BulkRequestParameters>
BulkRequestParameters
Implements
Inherited Members
Namespace: OpenSearch.Net
Assembly: OpenSearch.Net.dll
Syntax
public class BulkRequestParameters : RequestParameters<BulkRequestParameters>, 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

Index

Name of the data stream, index, or index alias to perform bulk actions on.

Declaration
public string Index { 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

Pipeline

ID of the pipeline to use to preprocess incoming documents. If the index has a default ingest pipeline specified, then setting the value to _none disables the default ingest pipeline for this request. If a final pipeline is configured it will always run, regardless of the value of this parameter.

Declaration
public string Pipeline { get; set; }
Property Value
Type Description
string
| 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. Valid values: true, false, wait_for.

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

RequireAlias

If true, the request's actions must target an index alias.

Declaration
public bool? RequireAlias { get; set; }
Property Value
Type Description
bool?
| 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

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?
| Edit this page View Source

SourceExcludes

A comma-separated list of source fields to exclude from the response.

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

SourceIncludes

A comma-separated list of source fields to include in the response.

Declaration
public string[] SourceIncludes { get; set; }
Property Value
Type Description
string[]
| 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 each action waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards.

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

Type

Default document type for items which don't provide one.

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

WaitForActiveShards

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

Declaration
public string WaitForActiveShards { get; set; }
Property Value
Type Description
string

Implements

Extension Methods