Package org.opensearch.client.opensearch.core

Class BulkRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.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 a BulkRequest.
BulkRequest.Builder	index(java.lang.String value)	Default index for items which don't provide one
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	operations(BulkOperation value, BulkOperation... values)	Required - Request body.
BulkRequest.Builder	pipeline(java.lang.String value)	The pipeline id to preprocess incoming documents with
BulkRequest.Builder	refresh(Refresh value)	If true then refresh the affected shards to make this operation visible to search, if wait_for then wait for a refresh to make this operation visible to search, if false (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 value
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-request
BulkRequest.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-request
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-request
BulkRequest.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-request
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-request
BulkRequest.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-request
BulkRequest.Builder	timeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)	Explicit operation timeout
BulkRequest.Builder	timeout(Time value)	Explicit operation timeout
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.
BulkRequest.Builder	waitForActiveShards(WaitForActiveShards value)	Sets the number of shard copies that must be active before proceeding with the bulk operation.

Methods inherited from class org.opensearch.client.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 Detail

Builder

public Builder()

Method Detail

source

public final BulkRequest.Builder source(@Nullable
                                        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-request

API 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-request

API name: _source

sourceExcludes

public final BulkRequest.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-request

API name: _source_excludes

Adds all elements of list to sourceExcludes.

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-request

API name: _source_excludes

Adds one or more values to sourceExcludes.

sourceIncludes

public final BulkRequest.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-request

API name: _source_includes

Adds all elements of list to sourceIncludes.

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-request

API name: _source_includes

Adds one or more values to sourceIncludes.

index

public final BulkRequest.Builder index(@Nullable
                                       java.lang.String value)

Default index for items which don't provide one

API name: index

pipeline

public final BulkRequest.Builder pipeline(@Nullable
                                          java.lang.String value)

The pipeline id to preprocess incoming documents with

API name: pipeline

refresh

public final BulkRequest.Builder refresh(@Nullable
                                         Refresh value)

If true then refresh the affected shards to make this operation visible to search, if wait_for then wait for a refresh to make this operation visible to search, if false (the default) then do nothing with refreshes.

API name: refresh

requireAlias

public final BulkRequest.Builder requireAlias(@Nullable
                                              java.lang.Boolean value)

Sets require_alias for all incoming documents. Defaults to unset (false)

API name: require_alias

routing

public final BulkRequest.Builder routing(@Nullable
                                         java.lang.String value)

Specific routing value

API name: routing

timeout

public final BulkRequest.Builder timeout(@Nullable
                                         Time value)

Explicit operation timeout

API name: timeout

timeout

public final BulkRequest.Builder timeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)

Explicit operation timeout

API name: timeout

waitForActiveShards

public final BulkRequest.Builder waitForActiveShards(@Nullable
                                                     WaitForActiveShards value)

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 to all 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 to all 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

public final BulkRequest.Builder operations(java.util.List<BulkOperation> list)

Required - Request body.

API name: _value_body

Adds all elements of list to operations.

operations

public final BulkRequest.Builder operations(BulkOperation value,
                                            BulkOperation... values)

Required - Request body.

API name: _value_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.

API name: _value_body

Adds a value to operations using a builder lambda.

build

public BulkRequest build()

Builds a BulkRequest.

Specified by:

build in interface ObjectBuilder<BulkRequest>

Throws:

java.lang.NullPointerException - if some of the required fields are null.