Package org.elasticsearch.action.bulk
Class BulkRequestBuilder
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
Fields inherited from class org.elasticsearch.action.ActionRequestBuilder
action, client, request
-
Constructor Summary
ConstructorDescriptionBulkRequestBuilder(ElasticsearchClient client, BulkAction action)
BulkRequestBuilder(ElasticsearchClient client, BulkAction action, globalIndex)
BulkRequestBuilder(ElasticsearchClient client, BulkAction action, globalIndex, globalType)
Deprecated. -
Method Summary
Modifier and TypeMethodDescriptionadd(byte[] data, int from, int length, defaultIndex, defaultType, org.elasticsearch.common.xcontent.XContentType xContentType)
Deprecated.useadd(byte[], int, int, String, XContentType)
insteadadd(byte[] data, int from, int length, defaultIndex, org.elasticsearch.common.xcontent.XContentType xContentType)
Adds a framed data in binary formatadd(byte[] data, int from, int length, org.elasticsearch.common.xcontent.XContentType xContentType)
Adds a framed data in binary formatadd(DeleteRequest request)
Adds anDeleteRequest
to the list of actions to execute.add(DeleteRequestBuilder request)
Adds anDeleteRequest
to the list of actions to execute.add(IndexRequest request)
Adds anIndexRequest
to the list of actions to execute.add(IndexRequestBuilder request)
Adds anIndexRequest
to the list of actions to execute.add(UpdateRequest request)
Adds anUpdateRequest
to the list of actions to execute.add(UpdateRequestBuilder request)
Adds anUpdateRequest
to the list of actions to execute.int
The number of actions currently in the bulk.globalPipeline)
globalRouting)
timeout)
A timeout to wait if the index operation can't be performed immediately.setTimeout(org.elasticsearch.core.TimeValue timeout)
A timeout to wait if the index operation can't be performed immediately.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.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.
, , , , , , , , , ,
Methods inherited from interface org.elasticsearch.action.support.WriteRequestBuilder
request, setRefreshPolicy, setRefreshPolicy
-
Constructor Details
-
BulkRequestBuilder
public BulkRequestBuilder(ElasticsearchClient client, BulkAction action, @Nullable globalIndex, @Nullable globalType)Deprecated. -
BulkRequestBuilder
-
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) throwsAdds a framed data in binary format- Throws:
-
add
public BulkRequestBuilder add(byte[] data, int from, int length, @Nullable defaultIndex, @Nullable defaultType, org.elasticsearch.common.xcontent.XContentType xContentType) throwsDeprecated.useadd(byte[], int, int, String, XContentType)
insteadAdds a framed data in binary format- Throws:
-
add
public BulkRequestBuilder add(byte[] data, int from, int length, @Nullable defaultIndex, org.elasticsearch.common.xcontent.XContentType xContentType) throwsAdds a framed data in binary format- Throws:
-
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
public final timeout)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
public globalPipeline) -
routing
public globalRouting)
-
BulkRequestBuilder(ElasticsearchClient, BulkAction, String)
instead