Class BulkStreamRequest

Request for BulkStream

<p>https://docs.opensearch.org/latest/api-reference/document-apis/bulk-streaming/</p>
Inheritance
object
RequestBase<BulkStreamRequestParameters>
PlainRequestBase<BulkStreamRequestParameters>
BulkStreamRequest
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class BulkStreamRequest : PlainRequestBase<BulkStreamRequestParameters>, IBulkStreamRequest, IRequest<BulkStreamRequestParameters>, IRequest

Constructors

| Edit this page View Source

BulkStreamRequest()

/_bulk/stream

Declaration
public BulkStreamRequest()
| Edit this page View Source

BulkStreamRequest(IndexName)

/{index}/_bulk/stream

Declaration
public BulkStreamRequest(IndexName index)
Parameters
Type Name Description
IndexName index

Optional, accepts null

Properties

| Edit this page View Source

BatchInterval

Specifies for how long bulk operations should be accumulated into a batch before sending the batch to data nodes.

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

BatchSize

Specifies how many bulk operations should be accumulated into a batch before sending the batch to data nodes.

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

Operations

Declaration
public BulkOperationsCollection<IBulkOperation> Operations { get; set; }
Property Value
Type Description
BulkOperationsCollection<IBulkOperation>
| 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 document is routed to a particular shard in an index using the following formula

shard_num = hash(_routing) % num_primary_shards

OpenSearch will use the document id if not provided.

For requests that are constructed from/for a document OpenSearch.Client will automatically infer the routing key if that document has a JoinField or a routing mapping on for its type exists on ConnectionSettings

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

Self

Declaration
protected IBulkStreamRequest Self { get; }
Property Value
Type Description
IBulkStreamRequest
| Edit this page View Source

SourceEnabled

Whether the _source should be included in the response.

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

SourceIncludes

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

Declaration
public Fields SourceIncludes { get; set; }
Property Value
Type Description
Fields
| 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 Time Timeout { get; set; }
Property Value
Type Description
Time
| 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

Methods

| Edit this page View Source

RequestDefaults(BulkStreamRequestParameters)

Allows a request implementation to set certain request parameter defaults, use sparingly!

Declaration
protected override sealed void RequestDefaults(BulkStreamRequestParameters parameters)
Parameters
Type Name Description
BulkStreamRequestParameters parameters
Overrides

Implements

Extension Methods