org.elasticsearch.action.bulk

Class BulkRequest

java.lang.Object

org.elasticsearch.common.ContextAndHeaderHolder

org.elasticsearch.transport.TransportMessage<TransportRequest>

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest<BulkRequest>

org.elasticsearch.action.bulk.BulkRequest

All Implemented Interfaces:

CompositeIndicesRequest, HasContext, HasContextAndHeaders, HasHeaders, Streamable

public class BulkRequest
extends ActionRequest<BulkRequest>
implements CompositeIndicesRequest

A bulk request holds an ordered IndexRequests, DeleteRequests and UpdateRequests and allows to executes it in a single batch. Note that we only support refresh on the bulk request not per item.

See Also:

Client.bulk(BulkRequest)

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportRequest

TransportRequest.Empty

Field Summary

Fields

Modifier and Type	Field and Description
protected TimeValue	timeout

Fields inherited from class org.elasticsearch.common.ContextAndHeaderHolder

headers

Constructor Summary

Constructors

Constructor and Description
BulkRequest()
BulkRequest(ActionRequest request) Creates a bulk request caused by some other request, which is provided as an argument so that its headers and context can be copied to the new request

Method Summary

Methods

Modifier and Type	Method and Description
BulkRequest	add(ActionRequest... requests) Adds a list of requests to be executed.
BulkRequest	add(ActionRequest request)
BulkRequest	add(ActionRequest request, Object payload) Add a request to the current BulkRequest.
BulkRequest	add(byte[] data, int from, int length) Adds a framed data in binary format
BulkRequest	add(byte[] data, int from, int length, String defaultIndex, String defaultType) Adds a framed data in binary format
BulkRequest	add(BytesReference data, String defaultIndex, String defaultType) Adds a framed data in binary format
BulkRequest	add(BytesReference data, String defaultIndex, String defaultType, boolean allowExplicitIndex) Adds a framed data in binary format
BulkRequest	add(BytesReference data, String defaultIndex, String defaultType, String defaultRouting, String[] defaultFields, Object payload, boolean allowExplicitIndex)
BulkRequest	add(DeleteRequest request) Adds an DeleteRequest to the list of actions to execute.
BulkRequest	add(DeleteRequest request, Object payload)
BulkRequest	add(IndexRequest request) Adds an IndexRequest to the list of actions to execute.
BulkRequest	add(IndexRequest request, Object payload)
BulkRequest	add(Iterable<ActionRequest> requests) Adds a list of requests to be executed.
BulkRequest	add(UpdateRequest request) Adds an UpdateRequest to the list of actions to execute.
BulkRequest	add(UpdateRequest request, Object payload)
WriteConsistencyLevel	consistencyLevel()
BulkRequest	consistencyLevel(WriteConsistencyLevel consistencyLevel) Sets the consistency level of write.
long	estimatedSizeInBytes() The estimated size in bytes of the bulk request.
int	numberOfActions() The number of actions in the bulk request.
List<Object>	payloads() The list of optional payloads associated with requests in the same order as the requests.
void	readFrom(StreamInput in)
boolean	refresh()
BulkRequest	refresh(boolean refresh) Should a refresh be executed post this bulk operation causing the operations to be searchable.
List<ActionRequest>	requests() The list of requests in this bulk request.
List<? extends IndicesRequest>	subRequests() Returns the subrequests that a composite request is composed of
TimeValue	timeout()
BulkRequest	timeout(String timeout) A timeout to wait if the index operation can't be performed immediately.
BulkRequest	timeout(TimeValue timeout) A timeout to wait if the index operation can't be performed immediately.
ActionRequestValidationException	validate()
void	writeTo(StreamOutput out)

Methods inherited from class org.elasticsearch.transport.TransportRequest

createTask, getDescription

Methods inherited from class org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class org.elasticsearch.common.ContextAndHeaderHolder

contextSize, copyContextAndHeadersFrom, copyContextFrom, copyHeadersFrom, getContext, getFromContext, getFromContext, getHeader, getHeaders, hasHeader, hasInContext, isContextEmpty, putAllInContext, putHeader, putInContext

Methods inherited from class java.lang.Object

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

Field Detail

timeout

protected TimeValue timeout

Constructor Detail

BulkRequest

public BulkRequest()

BulkRequest

public BulkRequest(ActionRequest request)

Creates a bulk request caused by some other request, which is provided as an argument so that its headers and context can be copied to the new request

Method Detail

add

public BulkRequest add(ActionRequest... requests)

Adds a list of requests to be executed. Either index or delete requests.

add

public BulkRequest add(ActionRequest request)

add

public BulkRequest add(ActionRequest request,
              @Nullable
              Object payload)

Add a request to the current BulkRequest.

Parameters:

request - Request to add

payload - Optional payload

Returns:

the current bulk request

add

public BulkRequest add(Iterable<ActionRequest> requests)

Adds a list of requests to be executed. Either index or delete requests.

add

public BulkRequest 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 BulkRequest add(IndexRequest request,
              @Nullable
              Object payload)

add

public BulkRequest add(UpdateRequest request)

Adds an UpdateRequest to the list of actions to execute.

add

public BulkRequest add(UpdateRequest request,
              @Nullable
              Object payload)

add

public BulkRequest add(DeleteRequest request)

Adds an DeleteRequest to the list of actions to execute.

add

public BulkRequest add(DeleteRequest request,
              @Nullable
              Object payload)

requests

public List<ActionRequest> requests()

The list of requests in this bulk request.

subRequests

public List<? extends IndicesRequest> subRequests()

Description copied from interface: CompositeIndicesRequest

Returns the subrequests that a composite request is composed of

Specified by:

subRequests in interface CompositeIndicesRequest

payloads

@Nullable
public List<Object> payloads()

The list of optional payloads associated with requests in the same order as the requests. Note, elements within it might be null if no payload has been provided.

Note, if no payloads have been provided, this method will return null (as to conserve memory overhead).

numberOfActions

public int numberOfActions()

The number of actions in the bulk request.

estimatedSizeInBytes

public long estimatedSizeInBytes()

The estimated size in bytes of the bulk request.

add

public BulkRequest add(byte[] data,
              int from,
              int length)
                throws Exception

Adds a framed data in binary format

Throws:

Exception

add

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

Adds a framed data in binary format

Throws:

Exception

add

public BulkRequest add(BytesReference data,
              @Nullable
              String defaultIndex,
              @Nullable
              String defaultType)
                throws Exception

Adds a framed data in binary format

Throws:

Exception

add

public BulkRequest add(BytesReference data,
              @Nullable
              String defaultIndex,
              @Nullable
              String defaultType,
              boolean allowExplicitIndex)
                throws Exception

Adds a framed data in binary format

Throws:

Exception

add

public BulkRequest add(BytesReference data,
              @Nullable
              String defaultIndex,
              @Nullable
              String defaultType,
              @Nullable
              String defaultRouting,
              @Nullable
              String[] defaultFields,
              @Nullable
              Object payload,
              boolean allowExplicitIndex)
                throws Exception

Throws:

Exception

consistencyLevel

public BulkRequest consistencyLevel(WriteConsistencyLevel consistencyLevel)

Sets the consistency level of write. Defaults to WriteConsistencyLevel.DEFAULT

consistencyLevel

public WriteConsistencyLevel consistencyLevel()

refresh

public BulkRequest refresh(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.

refresh

public boolean refresh()

timeout

public final BulkRequest timeout(TimeValue timeout)

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

timeout

public final BulkRequest timeout(String timeout)

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

timeout

public TimeValue timeout()

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest<BulkRequest>

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class ActionRequest<BulkRequest>

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Overrides:

writeTo in class ActionRequest<BulkRequest>

Throws:

IOException