Package org.elasticsearch.action.bulk
Class BulkRequestBuilder
java.lang.Object
org.elasticsearch.action.ActionRequestBuilder<BulkRequest,BulkResponse>
org.elasticsearch.action.bulk.BulkRequestBuilder
- All Implemented Interfaces:
WriteRequestBuilder<BulkRequestBuilder>
public class BulkRequestBuilder extends ActionRequestBuilder<BulkRequest,BulkResponse> implements WriteRequestBuilder<BulkRequestBuilder>
A bulk request holds an ordered
IndexRequest
s and DeleteRequest
s and allows to executes
it in a single batch.-
Field Summary
-
Constructor Summary
Constructors Constructor Description BulkRequestBuilder(ElasticsearchClient client, BulkAction action)
BulkRequestBuilder(ElasticsearchClient client, BulkAction action, java.lang.String globalIndex)
BulkRequestBuilder(ElasticsearchClient client, BulkAction action, java.lang.String globalIndex, java.lang.String globalType)
Deprecated. -
Method Summary
Modifier and Type Method Description BulkRequestBuilder
add(byte[] data, int from, int length, java.lang.String defaultIndex, java.lang.String defaultType, org.elasticsearch.common.xcontent.XContentType xContentType)
Deprecated.useadd(byte[], int, int, String, XContentType)
insteadBulkRequestBuilder
add(byte[] data, int from, int length, java.lang.String defaultIndex, org.elasticsearch.common.xcontent.XContentType xContentType)
Adds a framed data in binary formatBulkRequestBuilder
add(byte[] data, int from, int length, org.elasticsearch.common.xcontent.XContentType xContentType)
Adds a framed data in binary formatBulkRequestBuilder
add(DeleteRequest request)
Adds anDeleteRequest
to the list of actions to execute.BulkRequestBuilder
add(DeleteRequestBuilder request)
Adds anDeleteRequest
to the list of actions to execute.BulkRequestBuilder
add(IndexRequest request)
Adds anIndexRequest
to the list of actions to execute.BulkRequestBuilder
add(IndexRequestBuilder request)
Adds anIndexRequest
to the list of actions to execute.BulkRequestBuilder
add(UpdateRequest request)
Adds anUpdateRequest
to the list of actions to execute.BulkRequestBuilder
add(UpdateRequestBuilder request)
Adds anUpdateRequest
to the list of actions to execute.int
numberOfActions()
The number of actions currently in the bulk.BulkRequestBuilder
pipeline(java.lang.String globalPipeline)
BulkRequestBuilder
routing(java.lang.String globalRouting)
BulkRequestBuilder
setTimeout(java.lang.String timeout)
A timeout to wait if the index operation can't be performed immediately.BulkRequestBuilder
setTimeout(org.elasticsearch.common.unit.TimeValue timeout)
A timeout to wait if the index operation can't be performed immediately.BulkRequestBuilder
setWaitForActiveShards(int waitForActiveShards)
A shortcut forsetWaitForActiveShards(ActiveShardCount)
where the numerical shard count is passed in, instead of having to first callActiveShardCount.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.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.elasticsearch.action.support.WriteRequestBuilder
request, setRefreshPolicy, setRefreshPolicy
-
Constructor Details
-
BulkRequestBuilder
@Deprecated public BulkRequestBuilder(ElasticsearchClient client, BulkAction action, @Nullable java.lang.String globalIndex, @Nullable java.lang.String globalType)Deprecated. -
BulkRequestBuilder
public BulkRequestBuilder(ElasticsearchClient client, BulkAction action, @Nullable java.lang.String globalIndex) -
BulkRequestBuilder
-
-
Method Details
-
add
Adds anIndexRequest
to the list of actions to execute. Follows the same behavior ofIndexRequest
(for example, if no id is provided, one will be generated, or usage of the create flag). -
add
Adds anIndexRequest
to the list of actions to execute. Follows the same behavior ofIndexRequest
(for example, if no id is provided, one will be generated, or usage of the create flag). -
add
Adds anDeleteRequest
to the list of actions to execute. -
add
Adds anDeleteRequest
to the list of actions to execute. -
add
Adds anUpdateRequest
to the list of actions to execute. -
add
Adds anUpdateRequest
to the list of actions to execute. -
add
public BulkRequestBuilder add(byte[] data, int from, int length, org.elasticsearch.common.xcontent.XContentType xContentType) throws java.lang.ExceptionAdds a framed data in binary format- Throws:
java.lang.Exception
-
add
@Deprecated public BulkRequestBuilder add(byte[] data, int from, int length, @Nullable java.lang.String defaultIndex, @Nullable java.lang.String defaultType, org.elasticsearch.common.xcontent.XContentType xContentType) throws java.lang.ExceptionDeprecated.useadd(byte[], int, int, String, XContentType)
insteadAdds a framed data in binary format- Throws:
java.lang.Exception
-
add
public BulkRequestBuilder add(byte[] data, int from, int length, @Nullable java.lang.String defaultIndex, org.elasticsearch.common.xcontent.XContentType xContentType) throws java.lang.ExceptionAdds a framed data in binary format- Throws:
java.lang.Exception
-
setWaitForActiveShards
Sets the number of shard copies that must be active before proceeding with the write. SeeReplicationRequest.waitForActiveShards(ActiveShardCount)
for details. -
setWaitForActiveShards
A shortcut forsetWaitForActiveShards(ActiveShardCount)
where the numerical shard count is passed in, instead of having to first callActiveShardCount.from(int)
to get the ActiveShardCount. -
setTimeout
A timeout to wait if the index operation can't be performed immediately. Defaults to1m
. -
setTimeout
A timeout to wait if the index operation can't be performed immediately. Defaults to1m
. -
numberOfActions
public int numberOfActions()The number of actions currently in the bulk. -
pipeline
-
routing
-