Class BulkRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.core.BulkRequest
- All Implemented Interfaces:
JsonpSerializable
,NdJsonpSerializable
Allows to perform multiple index/update/delete operations in a single
request.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Modifier and TypeFieldDescriptionstatic final Endpoint<BulkRequest,
BulkResponse, ErrorResponse> Endpoint "bulk
". -
Method Summary
Modifier and TypeMethodDescriptionIterator<?>
final String
index()
Default index for items which don't provide onestatic BulkRequest
final List<BulkOperation>
Required - Request body.final String
pipeline()
The pipeline id to preprocess incoming documents withfinal Refresh
refresh()
Iftrue
then refresh the affected shards to make this operation visible to search, ifwait_for
then wait for a refresh to make this operation visible to search, iffalse
(the default) then do nothing with refreshes.final Boolean
Sets require_alias for all incoming documents.final String
routing()
Specific routing valuevoid
serialize
(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) Serialize this value to JSON.final SourceConfigParam
source()
True or false to return the _source field or not, or default list of fields to return, can be overridden on each sub-requestDefault list of fields to exclude from the returned _source field, can be overridden on each sub-requestDefault list of fields to extract and return from the _source field, can be overridden on each sub-requestfinal Time
timeout()
Explicit operation timeoutfinal WaitForActiveShards
Sets the number of shard copies that must be active before proceeding with the bulk operation.Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
-
Field Details
-
_ENDPOINT
Endpoint "bulk
".
-
-
Method Details
-
of
-
_serializables
- Specified by:
_serializables
in interfaceNdJsonpSerializable
-
source
True or false to return the _source field or not, or default list of fields to return, can be overridden on each sub-requestAPI name:
_source
-
sourceExcludes
Default list of fields to exclude from the returned _source field, can be overridden on each sub-requestAPI name:
_source_excludes
-
sourceIncludes
Default list of fields to extract and return from the _source field, can be overridden on each sub-requestAPI name:
_source_includes
-
index
Default index for items which don't provide oneAPI name:
index
-
pipeline
The pipeline id to preprocess incoming documents withAPI name:
pipeline
-
refresh
Iftrue
then refresh the affected shards to make this operation visible to search, ifwait_for
then wait for a refresh to make this operation visible to search, iffalse
(the default) then do nothing with refreshes.API name:
refresh
-
requireAlias
Sets require_alias for all incoming documents. Defaults to unset (false)API name:
require_alias
-
routing
Specific routing valueAPI name:
routing
-
timeout
Explicit operation timeoutAPI name:
timeout
-
waitForActiveShards
Sets the number of shard copies that must be active before proceeding with the bulk operation. Defaults to 1, meaning the primary shard only. Set toall
for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)API name:
wait_for_active_shards
-
operations
Required - Request body. -
serialize
Serialize this value to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-