Package org.opensearch.client.opensearch._global

Class BulkRequest.Builder<TSource>

java.lang.Object

org.opensearch.client.opensearch._global.BulkRequest.Builder<TSource>

All Implemented Interfaces:

ObjectBuilder<BulkRequest<TSource>>

Enclosing class:

BulkRequest<TSource>

public static class BulkRequest.Builder<TSource>
extends java.lang.Object
implements ObjectBuilder<BulkRequest<TSource>>

Builder for BulkRequest.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.client.util.ObjectBuilder

ObjectBuilder.Constant<V>

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
BulkRequest.Builder<TSource>	addSourceExcludes(java.lang.String value)	Add a value to sourceExcludes(List), creating the list if needed.
BulkRequest.Builder<TSource>	addSourceIncludes(java.lang.String value)	Add a value to sourceIncludes(List), creating the list if needed.
BulkRequest.Builder<TSource>	addValue(jakarta.json.JsonValue value)	Add a value to value(List), creating the list if needed.
BulkRequest<TSource>	build()	Builds a BulkRequest.
BulkRequest.Builder<TSource>	index(java.lang.String value)	A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices API name: index
BulkRequest.Builder<TSource>	pipeline(java.lang.String value)	API name: pipeline
BulkRequest.Builder<TSource>	refresh(jakarta.json.JsonValue value)	API name: refresh
BulkRequest.Builder<TSource>	requireAlias(java.lang.Boolean value)	API name: require_alias
BulkRequest.Builder<TSource>	routing(jakarta.json.JsonValue value)	API name: routing
BulkRequest.Builder<TSource>	source(jakarta.json.JsonValue value)	API name: _source
BulkRequest.Builder<TSource>	sourceExcludes(java.lang.String... value)	API name: _source_excludes
BulkRequest.Builder<TSource>	sourceExcludes(java.util.List<java.lang.String> value)	API name: _source_excludes
BulkRequest.Builder<TSource>	sourceIncludes(java.lang.String... value)	API name: _source_includes
BulkRequest.Builder<TSource>	sourceIncludes(java.util.List<java.lang.String> value)	API name: _source_includes
BulkRequest.Builder<TSource>	timeout(jakarta.json.JsonValue value)	API name: timeout
BulkRequest.Builder<TSource>	tSourceSerializer(JsonpSerializer<TSource> value)	Serializer for TSource.
BulkRequest.Builder<TSource>	type(java.lang.String value)	A comma-separated list of document types to search; leave empty to perform the operation on all types API name: type
BulkRequest.Builder<TSource>	value(jakarta.json.JsonValue... value)	Request body.
BulkRequest.Builder<TSource>	value(java.util.List<jakarta.json.JsonValue> value)	Request body.
BulkRequest.Builder<TSource>	waitForActiveShards(jakarta.json.JsonValue value)	API name: wait_for_active_shards

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

index

public BulkRequest.Builder<TSource> index(@Nullable java.lang.String value)

A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices API name: index

type

public BulkRequest.Builder<TSource> type(@Nullable java.lang.String value)

A comma-separated list of document types to search; leave empty to perform the operation on all types API name: type

pipeline

public BulkRequest.Builder<TSource> pipeline(@Nullable java.lang.String value)

API name: pipeline

refresh

public BulkRequest.Builder<TSource> refresh(@Nullable jakarta.json.JsonValue value)

API name: refresh

routing

public BulkRequest.Builder<TSource> routing(@Nullable jakarta.json.JsonValue value)

API name: routing

source

public BulkRequest.Builder<TSource> source(@Nullable jakarta.json.JsonValue value)

API name: _source

sourceExcludes

public BulkRequest.Builder<TSource> sourceExcludes(@Nullable java.util.List<java.lang.String> value)

API name: _source_excludes

sourceExcludes

public BulkRequest.Builder<TSource> sourceExcludes(java.lang.String... value)

API name: _source_excludes

addSourceExcludes

public BulkRequest.Builder<TSource> addSourceExcludes(java.lang.String value)

Add a value to sourceExcludes(List), creating the list if needed.

sourceIncludes

public BulkRequest.Builder<TSource> sourceIncludes(@Nullable java.util.List<java.lang.String> value)

API name: _source_includes

sourceIncludes

public BulkRequest.Builder<TSource> sourceIncludes(java.lang.String... value)

API name: _source_includes

addSourceIncludes

public BulkRequest.Builder<TSource> addSourceIncludes(java.lang.String value)

Add a value to sourceIncludes(List), creating the list if needed.

timeout

public BulkRequest.Builder<TSource> timeout(@Nullable jakarta.json.JsonValue value)

API name: timeout

waitForActiveShards

public BulkRequest.Builder<TSource> waitForActiveShards(@Nullable jakarta.json.JsonValue value)

API name: wait_for_active_shards

requireAlias

public BulkRequest.Builder<TSource> requireAlias(@Nullable java.lang.Boolean value)

API name: require_alias

value

public BulkRequest.Builder<TSource> value(java.util.List<jakarta.json.JsonValue> value)

Request body. API name: value

value

public BulkRequest.Builder<TSource> value(jakarta.json.JsonValue... value)

Request body. API name: value

addValue

public BulkRequest.Builder<TSource> addValue(jakarta.json.JsonValue value)

Add a value to value(List), creating the list if needed.

tSourceSerializer

public BulkRequest.Builder<TSource> tSourceSerializer(@Nullable JsonpSerializer<TSource> value)

Serializer for TSource. If not set, an attempt will be made to find a serializer from the JSON context.

build

public BulkRequest<TSource> build()

Builds a BulkRequest.

Specified by:

build in interface ObjectBuilder<TSource>

Throws:

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