Package org.opensearch.action.bulk

Class BulkRequestBuilder

java.lang.Object

org.opensearch.action.ActionRequestBuilder<BulkRequest,BulkResponse>

org.opensearch.action.bulk.BulkRequestBuilder

All Implemented Interfaces:

WriteRequestBuilder<BulkRequestBuilder>

@PublicApi(since="1.0.0")
public class BulkRequestBuilder
extends ActionRequestBuilder<BulkRequest,BulkResponse>
implements WriteRequestBuilder<BulkRequestBuilder>

A bulk request holds an ordered IndexRequests and DeleteRequests and allows to executes it in a single batch.

Opensearch.api:

Field Summary

Fields inherited from class org.opensearch.action.ActionRequestBuilder

action, client, request

Constructor Summary

Constructors

Constructor	Description
BulkRequestBuilder(OpenSearchClient client, BulkAction action)
BulkRequestBuilder(OpenSearchClient client, BulkAction action, String globalIndex)

Method Summary

Modifier and Type	Method	Description
BulkRequestBuilder	add(byte[] data, int from, int length, String defaultIndex, org.opensearch.core.xcontent.MediaType mediaType)	Adds a framed data in binary format
BulkRequestBuilder	add(byte[] data, int from, int length, org.opensearch.common.xcontent.XContentType xContentType)	Adds a framed data in binary format
BulkRequestBuilder	add(DeleteRequest request)	Adds an DeleteRequest to the list of actions to execute.
BulkRequestBuilder	add(DeleteRequestBuilder request)	Adds an DeleteRequest to the list of actions to execute.
BulkRequestBuilder	add(IndexRequest request)	Adds an IndexRequest to the list of actions to execute.
BulkRequestBuilder	add(IndexRequestBuilder request)	Adds an IndexRequest to the list of actions to execute.
BulkRequestBuilder	add(UpdateRequest request)	Adds an UpdateRequest to the list of actions to execute.
BulkRequestBuilder	add(UpdateRequestBuilder request)	Adds an UpdateRequest to the list of actions to execute.
int	numberOfActions()	The number of actions currently in the bulk.
BulkRequestBuilder	pipeline(String globalPipeline)
BulkRequestBuilder	routing(String globalRouting)
final BulkRequestBuilder	setTimeout(String timeout)	A timeout to wait if the index operation can't be performed immediately.
final BulkRequestBuilder	setTimeout(org.opensearch.common.unit.TimeValue timeout)	A timeout to wait if the index operation can't be performed immediately.
BulkRequestBuilder	setWaitForActiveShards(int waitForActiveShards)	A shortcut for setWaitForActiveShards(ActiveShardCount) where the numerical shard count is passed in, instead of having to first call ActiveShardCount.from(int) to get the ActiveShardCount.
BulkRequestBuilder	setWaitForActiveShards(ActiveShardCount waitForActiveShards)	Sets the number of shard copies that must be active before proceeding with the write.

Methods inherited from class org.opensearch.action.ActionRequestBuilder

execute, execute, get, get, get, request

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opensearch.action.support.WriteRequestBuilder

request, setRefreshPolicy, setRefreshPolicy

Constructor Details

BulkRequestBuilder

public BulkRequestBuilder(OpenSearchClient client,
 BulkAction action,
 @Nullable
 String globalIndex)

BulkRequestBuilder

public BulkRequestBuilder(OpenSearchClient client,
 BulkAction action)

Method Details

add

public BulkRequestBuilder add(IndexRequest request)

Adds an IndexRequest to the list of actions to execute. Follows the same behavior of IndexRequest (for example, if no id is provided, one will be generated, or usage of the create flag).

add

public BulkRequestBuilder add(IndexRequestBuilder request)

Adds an IndexRequest to the list of actions to execute. Follows the same behavior of IndexRequest (for example, if no id is provided, one will be generated, or usage of the create flag).

add

public BulkRequestBuilder add(DeleteRequest request)

Adds an DeleteRequest to the list of actions to execute.

add

public BulkRequestBuilder add(DeleteRequestBuilder request)

Adds an DeleteRequest to the list of actions to execute.

add

public BulkRequestBuilder add(UpdateRequest request)

Adds an UpdateRequest to the list of actions to execute.

add

public BulkRequestBuilder add(UpdateRequestBuilder request)

Adds an UpdateRequest to the list of actions to execute.

add

public BulkRequestBuilder add(byte[] data,
 int from,
 int length,
 org.opensearch.common.xcontent.XContentType xContentType)
                       throws Exception

Adds a framed data in binary format

Throws:

Exception

add

public BulkRequestBuilder add(byte[] data,
 int from,
 int length,
 @Nullable
 String defaultIndex,
 org.opensearch.core.xcontent.MediaType mediaType)
                       throws Exception

Adds a framed data in binary format

Throws:

Exception

setWaitForActiveShards

public BulkRequestBuilder setWaitForActiveShards(ActiveShardCount waitForActiveShards)

Sets the number of shard copies that must be active before proceeding with the write. See ReplicationRequest.waitForActiveShards(ActiveShardCount) for details.

setWaitForActiveShards

public BulkRequestBuilder setWaitForActiveShards(int waitForActiveShards)

A shortcut for setWaitForActiveShards(ActiveShardCount) where the numerical shard count is passed in, instead of having to first call ActiveShardCount.from(int) to get the ActiveShardCount.

setTimeout

public final BulkRequestBuilder setTimeout(org.opensearch.common.unit.TimeValue timeout)

A timeout to wait if the index operation can't be performed immediately. Defaults to 1m.

setTimeout

public final BulkRequestBuilder setTimeout(String timeout)

A timeout to wait if the index operation can't be performed immediately. Defaults to 1m.

numberOfActions

public int numberOfActions()

The number of actions currently in the bulk.

pipeline

public BulkRequestBuilder pipeline(String globalPipeline)

routing

public BulkRequestBuilder routing(String globalRouting)