public class BulkRequest extends ActionRequest implements CompositeIndicesRequest, WriteRequest<BulkRequest>
IndexRequest
s, DeleteRequest
s and UpdateRequest
s
and allows to executes it in a single batch.
Note that we only support refresh on the bulk request not per item.Client.bulk(BulkRequest)
TransportRequest.Empty
WriteRequest.RefreshPolicy
Constructor and Description |
---|
BulkRequest() |
Modifier and Type | Method and Description |
---|---|
BulkRequest |
add(byte[] data,
int from,
int length)
Deprecated.
|
BulkRequest |
add(byte[] data,
int from,
int length,
java.lang.String defaultIndex,
java.lang.String defaultType)
Deprecated.
|
BulkRequest |
add(byte[] data,
int from,
int length,
java.lang.String defaultIndex,
java.lang.String defaultType,
XContentType xContentType)
Adds a framed data in binary format
|
BulkRequest |
add(byte[] data,
int from,
int length,
XContentType xContentType)
Adds a framed data in binary format
|
BulkRequest |
add(BytesReference data,
java.lang.String defaultIndex,
java.lang.String defaultType)
Deprecated.
|
BulkRequest |
add(BytesReference data,
java.lang.String defaultIndex,
java.lang.String defaultType,
boolean allowExplicitIndex)
Deprecated.
|
BulkRequest |
add(BytesReference data,
java.lang.String defaultIndex,
java.lang.String defaultType,
boolean allowExplicitIndex,
XContentType xContentType)
Adds a framed data in binary format
|
BulkRequest |
add(BytesReference data,
java.lang.String defaultIndex,
java.lang.String defaultType,
java.lang.String defaultRouting,
java.lang.String[] defaultFields,
FetchSourceContext defaultFetchSourceContext,
java.lang.String defaultPipeline,
java.lang.Object payload,
boolean allowExplicitIndex)
Deprecated.
|
BulkRequest |
add(BytesReference data,
java.lang.String defaultIndex,
java.lang.String defaultType,
java.lang.String defaultRouting,
java.lang.String[] defaultFields,
FetchSourceContext defaultFetchSourceContext,
java.lang.String defaultPipeline,
java.lang.Object payload,
boolean allowExplicitIndex,
XContentType xContentType) |
BulkRequest |
add(BytesReference data,
java.lang.String defaultIndex,
java.lang.String defaultType,
XContentType xContentType)
Adds a framed data in binary format
|
BulkRequest |
add(DeleteRequest request)
Adds an
DeleteRequest to the list of actions to execute. |
BulkRequest |
add(DeleteRequest request,
java.lang.Object payload) |
BulkRequest |
add(DocWriteRequest... requests)
Adds a list of requests to be executed.
|
BulkRequest |
add(DocWriteRequest request) |
BulkRequest |
add(DocWriteRequest request,
java.lang.Object payload)
Add a request to the current BulkRequest.
|
BulkRequest |
add(IndexRequest request)
Adds an
IndexRequest to the list of actions to execute. |
BulkRequest |
add(IndexRequest request,
java.lang.Object payload) |
BulkRequest |
add(java.lang.Iterable<DocWriteRequest> 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,
java.lang.Object payload) |
long |
estimatedSizeInBytes()
The estimated size in bytes of the bulk request.
|
WriteRequest.RefreshPolicy |
getRefreshPolicy()
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).
|
boolean |
hasIndexRequestsWithPipelines() |
int |
numberOfActions()
The number of actions in the bulk request.
|
java.util.List<java.lang.Object> |
payloads()
The list of optional payloads associated with requests in the same order as the requests.
|
void |
readFrom(StreamInput in)
Set this object's fields from a StreamInput.
|
java.util.List<DocWriteRequest> |
requests()
The list of requests in this bulk request.
|
BulkRequest |
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).
|
TimeValue |
timeout() |
BulkRequest |
timeout(java.lang.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() |
ActiveShardCount |
waitForActiveShards() |
BulkRequest |
waitForActiveShards(ActiveShardCount waitForActiveShards)
Sets the number of shard copies that must be active before proceeding with the write.
|
BulkRequest |
waitForActiveShards(int waitForActiveShards)
A shortcut for
waitForActiveShards(ActiveShardCount) where the numerical
shard count is passed in, instead of having to first call ActiveShardCount.from(int)
to get the ActiveShardCount. |
void |
writeTo(StreamOutput out)
Write this object's fields to a StreamOutput.
|
getShouldStoreResult
getParentTask, setParentTask
remoteAddress, remoteAddress
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
setRefreshPolicy
createTask, getDescription, setParentTask
protected TimeValue timeout
public BulkRequest add(DocWriteRequest... requests)
public BulkRequest add(DocWriteRequest request)
public BulkRequest add(DocWriteRequest request, @Nullable java.lang.Object payload)
request
- Request to addpayload
- Optional payloadpublic BulkRequest add(java.lang.Iterable<DocWriteRequest> requests)
public BulkRequest add(IndexRequest request)
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).public BulkRequest add(IndexRequest request, @Nullable java.lang.Object payload)
public BulkRequest add(UpdateRequest request)
UpdateRequest
to the list of actions to execute.public BulkRequest add(UpdateRequest request, @Nullable java.lang.Object payload)
public BulkRequest add(DeleteRequest request)
DeleteRequest
to the list of actions to execute.public BulkRequest add(DeleteRequest request, @Nullable java.lang.Object payload)
public java.util.List<DocWriteRequest> requests()
@Nullable public java.util.List<java.lang.Object> payloads()
Note, if no payloads have been provided, this method will return null (as to conserve memory overhead).
public int numberOfActions()
public long estimatedSizeInBytes()
@Deprecated public BulkRequest add(byte[] data, int from, int length) throws java.io.IOException
add(byte[], int, int, XContentType)
java.io.IOException
public BulkRequest add(byte[] data, int from, int length, XContentType xContentType) throws java.io.IOException
java.io.IOException
@Deprecated public BulkRequest add(byte[] data, int from, int length, @Nullable java.lang.String defaultIndex, @Nullable java.lang.String defaultType) throws java.io.IOException
add(byte[], int, int, String, String, XContentType)
java.io.IOException
public BulkRequest add(byte[] data, int from, int length, @Nullable java.lang.String defaultIndex, @Nullable java.lang.String defaultType, XContentType xContentType) throws java.io.IOException
java.io.IOException
@Deprecated public BulkRequest add(BytesReference data, @Nullable java.lang.String defaultIndex, @Nullable java.lang.String defaultType) throws java.io.IOException
add(BytesReference, String, String, XContentType)
java.io.IOException
public BulkRequest add(BytesReference data, @Nullable java.lang.String defaultIndex, @Nullable java.lang.String defaultType, XContentType xContentType) throws java.io.IOException
java.io.IOException
@Deprecated public BulkRequest add(BytesReference data, @Nullable java.lang.String defaultIndex, @Nullable java.lang.String defaultType, boolean allowExplicitIndex) throws java.io.IOException
add(BytesReference, String, String, boolean, XContentType)
java.io.IOException
public BulkRequest add(BytesReference data, @Nullable java.lang.String defaultIndex, @Nullable java.lang.String defaultType, boolean allowExplicitIndex, XContentType xContentType) throws java.io.IOException
java.io.IOException
@Deprecated public BulkRequest add(BytesReference data, @Nullable java.lang.String defaultIndex, @Nullable java.lang.String defaultType, @Nullable java.lang.String defaultRouting, @Nullable java.lang.String[] defaultFields, @Nullable FetchSourceContext defaultFetchSourceContext, @Nullable java.lang.String defaultPipeline, @Nullable java.lang.Object payload, boolean allowExplicitIndex) throws java.io.IOException
java.io.IOException
public BulkRequest add(BytesReference data, @Nullable java.lang.String defaultIndex, @Nullable java.lang.String defaultType, @Nullable java.lang.String defaultRouting, @Nullable java.lang.String[] defaultFields, @Nullable FetchSourceContext defaultFetchSourceContext, @Nullable java.lang.String defaultPipeline, @Nullable java.lang.Object payload, boolean allowExplicitIndex, XContentType xContentType) throws java.io.IOException
java.io.IOException
public BulkRequest waitForActiveShards(ActiveShardCount waitForActiveShards)
ReplicationRequest.waitForActiveShards(ActiveShardCount)
for details.public BulkRequest waitForActiveShards(int waitForActiveShards)
waitForActiveShards(ActiveShardCount)
where the numerical
shard count is passed in, instead of having to first call ActiveShardCount.from(int)
to get the ActiveShardCount.public ActiveShardCount waitForActiveShards()
public BulkRequest setRefreshPolicy(WriteRequest.RefreshPolicy refreshPolicy)
WriteRequest
setRefreshPolicy
in interface WriteRequest<BulkRequest>
public WriteRequest.RefreshPolicy getRefreshPolicy()
WriteRequest
getRefreshPolicy
in interface WriteRequest<BulkRequest>
public final BulkRequest timeout(TimeValue timeout)
public final BulkRequest timeout(java.lang.String timeout)
public TimeValue timeout()
public boolean hasIndexRequestsWithPipelines()
public ActionRequestValidationException validate()
validate
in interface WriteRequest<BulkRequest>
validate
in class ActionRequest
public void readFrom(StreamInput in) throws java.io.IOException
Streamable
readFrom
in interface Streamable
readFrom
in class ActionRequest
java.io.IOException
public void writeTo(StreamOutput out) throws java.io.IOException
Streamable
writeTo
in interface Streamable
writeTo
in class ActionRequest
java.io.IOException