Class BulkRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.elasticsearch.core.BulkRequest.Builder
- All Implemented Interfaces:
ObjectBuilder<BulkRequest>
- Enclosing class:
- BulkRequest
public static class BulkRequest.Builder extends ObjectBuilderBase implements ObjectBuilder<BulkRequest>
Builder for
BulkRequest
.-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
Modifier and Type Method Description BulkRequest
build()
Builds aBulkRequest
.BulkRequest.Builder
index(java.lang.String value)
Default index for items which don't provide oneBulkRequest.Builder
operations(BulkOperation value, BulkOperation... values)
Required - Request body.BulkRequest.Builder
operations(java.util.function.Function<BulkOperation.Builder,ObjectBuilder<BulkOperation>> fn)
Required - Request body.BulkRequest.Builder
operations(java.util.List<BulkOperation> list)
Required - Request body.BulkRequest.Builder
pipeline(java.lang.String value)
The pipeline id to preprocess incoming documents withBulkRequest.Builder
refresh(Refresh value)
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.BulkRequest.Builder
requireAlias(java.lang.Boolean value)
Sets require_alias for all incoming documents.BulkRequest.Builder
routing(java.lang.String value)
Specific routing valueBulkRequest.Builder
source(SourceConfigParam value)
True or false to return the _source field or not, or default list of fields to return, can be overridden on each sub-requestBulkRequest.Builder
source(java.util.function.Function<SourceConfigParam.Builder,ObjectBuilder<SourceConfigParam>> fn)
True or false to return the _source field or not, or default list of fields to return, can be overridden on each sub-requestBulkRequest.Builder
sourceExcludes(java.lang.String value, java.lang.String... values)
Default list of fields to exclude from the returned _source field, can be overridden on each sub-requestBulkRequest.Builder
sourceExcludes(java.util.List<java.lang.String> list)
Default list of fields to exclude from the returned _source field, can be overridden on each sub-requestBulkRequest.Builder
sourceIncludes(java.lang.String value, java.lang.String... values)
Default list of fields to extract and return from the _source field, can be overridden on each sub-requestBulkRequest.Builder
sourceIncludes(java.util.List<java.lang.String> list)
Default list of fields to extract and return from the _source field, can be overridden on each sub-requestBulkRequest.Builder
timeout(Time value)
Explicit operation timeoutBulkRequest.Builder
timeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)
Explicit operation timeoutBulkRequest.Builder
type(java.lang.String value)
Default document type for items which don't provide oneBulkRequest.Builder
waitForActiveShards(WaitForActiveShards value)
Sets the number of shard copies that must be active before proceeding with the bulk operation.BulkRequest.Builder
waitForActiveShards(java.util.function.Function<WaitForActiveShards.Builder,ObjectBuilder<WaitForActiveShards>> fn)
Sets the number of shard copies that must be active before proceeding with the bulk operation.Methods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
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
-
source
public final BulkRequest.Builder source(java.util.function.Function<SourceConfigParam.Builder,ObjectBuilder<SourceConfigParam>> fn)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
Adds all elements of
list
tosourceExcludes
. -
sourceExcludes
public final BulkRequest.Builder sourceExcludes(java.lang.String value, java.lang.String... values)Default list of fields to exclude from the returned _source field, can be overridden on each sub-requestAPI name:
_source_excludes
Adds one or more values to
sourceExcludes
. -
sourceIncludes
Default list of fields to extract and return from the _source field, can be overridden on each sub-requestAPI name:
_source_includes
Adds all elements of
list
tosourceIncludes
. -
sourceIncludes
public final BulkRequest.Builder sourceIncludes(java.lang.String value, java.lang.String... values)Default list of fields to extract and return from the _source field, can be overridden on each sub-requestAPI name:
_source_includes
Adds one or more values to
sourceIncludes
. -
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
-
timeout
public final BulkRequest.Builder timeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)Explicit operation timeoutAPI name:
timeout
-
type
Default document type for items which don't provide oneAPI name:
type
-
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
-
waitForActiveShards
public final BulkRequest.Builder waitForActiveShards(java.util.function.Function<WaitForActiveShards.Builder,ObjectBuilder<WaitForActiveShards>> fn)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.Adds all elements of
list
tooperations
. -
operations
Required - Request body.Adds one or more values to
operations
. -
operations
public final BulkRequest.Builder operations(java.util.function.Function<BulkOperation.Builder,ObjectBuilder<BulkOperation>> fn)Required - Request body.Adds a value to
operations
using a builder lambda. -
build
Builds aBulkRequest
.- Specified by:
build
in interfaceObjectBuilder<BulkRequest>
- Throws:
java.lang.NullPointerException
- if some of the required fields are null.
-