Module org.elasticsearch.server

Package org.elasticsearch.action.bulk

Class BulkRequestBuilder

java.lang.Object

org.elasticsearch.action.ActionRequestLazyBuilder<BulkRequest,BulkResponse>

org.elasticsearch.action.bulk.BulkRequestBuilder

All Implemented Interfaces:

RequestBuilder<BulkRequest,BulkResponse>, WriteRequestBuilder<BulkRequestBuilder>

public class BulkRequestBuilder
extends ActionRequestLazyBuilder<BulkRequest,BulkResponse>
implements WriteRequestBuilder<BulkRequestBuilder>

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

Field Summary

Fields inherited from class org.elasticsearch.action.ActionRequestLazyBuilder

action, client

Constructor Summary

Constructors

Constructor	Description
BulkRequestBuilder(ElasticsearchClient client)
BulkRequestBuilder(ElasticsearchClient client, String globalIndex)

Method Summary

Modifier and Type	Method	Description
BulkRequestBuilder	add(byte[] data, int from, int length, String defaultIndex, XContentType xContentType)	Adds a framed data in binary format
BulkRequestBuilder	add(byte[] data, int from, int length, XContentType xContentType)	Adds a framed data in binary format
BulkRequestBuilder	add(DeleteRequest request)	Deprecated. use add(DeleteRequestBuilder) instead
BulkRequestBuilder	add(DeleteRequestBuilder request)	Adds an DeleteRequest to the list of actions to execute.
BulkRequestBuilder	add(IndexRequest request)	Deprecated. use add(IndexRequestBuilder) instead
BulkRequestBuilder	add(IndexRequestBuilder request)	Adds an IndexRequest to the list of actions to execute.
BulkRequestBuilder	add(UpdateRequest request)	Deprecated. use add(UpdateRequestBuilder) instead
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)
BulkRequest	request()	This method creates the request.
BulkRequestBuilder	routing(String globalRouting)
BulkRequestBuilder	setRefreshPolicy(String refreshPolicy)	Parse the refresh policy from a string, only modifying it if the string is non null.
BulkRequestBuilder	setRefreshPolicy(WriteRequest.RefreshPolicy refreshPolicy)	Should this request trigger a refresh (WriteRequest.RefreshPolicy.IMMEDIATE), wait for a refresh ( WriteRequest.RefreshPolicy.WAIT_UNTIL), or proceed ignore refreshes entirely (WriteRequest.RefreshPolicy.NONE, the default).
final BulkRequestBuilder	setTimeout(String timeout)	A timeout to wait if the index operation can't be performed immediately.
final BulkRequestBuilder	setTimeout(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.elasticsearch.action.ActionRequestLazyBuilder

execute, execute, get, get

Methods inherited from class java.lang.Object

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

Constructor Details

BulkRequestBuilder

public BulkRequestBuilder(ElasticsearchClient client,
 @Nullable
 String globalIndex)

BulkRequestBuilder

public BulkRequestBuilder(ElasticsearchClient client)

Method Details

add

@Deprecated
public BulkRequestBuilder add(IndexRequest request)

Deprecated.

use add(IndexRequestBuilder) instead

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

@Deprecated
public BulkRequestBuilder add(DeleteRequest request)

Deprecated.

use add(DeleteRequestBuilder) instead

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

@Deprecated
public BulkRequestBuilder add(UpdateRequest request)

Deprecated.

use add(UpdateRequestBuilder) instead

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,
 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,
 XContentType xContentType)
                       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(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)

setRefreshPolicy

public BulkRequestBuilder setRefreshPolicy(WriteRequest.RefreshPolicy refreshPolicy)

Description copied from interface: WriteRequestBuilder

Should this request trigger a refresh (WriteRequest.RefreshPolicy.IMMEDIATE), wait for a refresh ( WriteRequest.RefreshPolicy.WAIT_UNTIL), or proceed ignore refreshes entirely (WriteRequest.RefreshPolicy.NONE, the default).

Specified by:

setRefreshPolicy in interface WriteRequestBuilder<BulkRequestBuilder>

setRefreshPolicy

public BulkRequestBuilder setRefreshPolicy(String refreshPolicy)

Description copied from interface: WriteRequestBuilder

Parse the refresh policy from a string, only modifying it if the string is non null. Convenient to use with request parsing.

Specified by:

setRefreshPolicy in interface WriteRequestBuilder<BulkRequestBuilder>

request

public BulkRequest request()

Description copied from class: ActionRequestLazyBuilder

This method creates the request. The caller of this method is responsible for calling Request#decRef.

Specified by:

request in interface RequestBuilder<BulkRequest,BulkResponse>

Specified by:

request in interface WriteRequestBuilder<BulkRequestBuilder>

Specified by:

request in class ActionRequestLazyBuilder<BulkRequest,BulkResponse>

Returns:

A newly-built Request, fully initialized by this builder.