org.elasticsearch.action.bulk

Class BulkRequestBuilder

java.lang.Object

org.elasticsearch.action.ActionRequestBuilder<BulkRequest,BulkResponse,BulkRequestBuilder>

org.elasticsearch.action.bulk.BulkRequestBuilder

public class BulkRequestBuilder
extends ActionRequestBuilder<BulkRequest,BulkResponse,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.ActionRequestBuilder

action, client, request

Constructor Summary

Constructors

Constructor and Description
BulkRequestBuilder(ElasticsearchClient client, BulkAction action)

Method Summary

Methods

Modifier and Type	Method and Description
BulkRequestBuilder	add(byte[] data, int from, int length) Adds a framed data in binary format
BulkRequestBuilder	add(byte[] data, int from, int length, String defaultIndex, String defaultType) 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	setConsistencyLevel(WriteConsistencyLevel consistencyLevel) Sets the consistency level.
BulkRequestBuilder	setRefresh(boolean refresh) Should a refresh be executed post this bulk operation causing the operations to be searchable.
BulkRequestBuilder	setTimeout(String timeout) A timeout to wait if the index operation can't be performed immediately.
BulkRequestBuilder	setTimeout(TimeValue timeout) A timeout to wait if the index operation can't be performed immediately.

Methods inherited from class org.elasticsearch.action.ActionRequestBuilder

beforeExecute, execute, execute, get, get, get, putHeader, request

Methods inherited from class java.lang.Object

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

Constructor Detail

BulkRequestBuilder

public BulkRequestBuilder(ElasticsearchClient client,
                  BulkAction action)

Method Detail

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)
                       throws Exception

Adds a framed data in binary format

Throws:

Exception

add

public BulkRequestBuilder add(byte[] data,
                     int from,
                     int length,
                     @Nullable
                     String defaultIndex,
                     @Nullable
                     String defaultType)
                       throws Exception

Adds a framed data in binary format

Throws:

Exception

setConsistencyLevel

public BulkRequestBuilder setConsistencyLevel(WriteConsistencyLevel consistencyLevel)

Sets the consistency level. Defaults to WriteConsistencyLevel.DEFAULT.

setRefresh

public BulkRequestBuilder setRefresh(boolean refresh)

Should a refresh be executed post this bulk operation causing the operations to be searchable. Note, heavy indexing should not set this to true. Defaults to false.

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.