Package org.opensearch.client.opensearch.core

Class IndexRequest.Builder<TDocument>

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.core.IndexRequest.Builder<TDocument>

All Implemented Interfaces:

ObjectBuilder<IndexRequest<TDocument>>

Enclosing class:

IndexRequest<TDocument>

public static class IndexRequest.Builder<TDocument>
extends ObjectBuilderBase
implements ObjectBuilder<IndexRequest<TDocument>>

Builder for IndexRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
IndexRequest<TDocument>	build()	Builds a IndexRequest.
IndexRequest.Builder<TDocument>	document(TDocument value)	Required - Request body.
IndexRequest.Builder<TDocument>	id(java.lang.String value)	Document ID
IndexRequest.Builder<TDocument>	ifPrimaryTerm(java.lang.Long value)	only perform the index operation if the last operation that has changed the document has the specified primary term
IndexRequest.Builder<TDocument>	ifSeqNo(java.lang.Long value)	only perform the index operation if the last operation that has changed the document has the specified sequence number
IndexRequest.Builder<TDocument>	index(java.lang.String value)	Required - The name of the index
IndexRequest.Builder<TDocument>	opType(OpType value)	Explicit operation type.
IndexRequest.Builder<TDocument>	pipeline(java.lang.String value)	The pipeline id to preprocess incoming documents with
IndexRequest.Builder<TDocument>	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.
IndexRequest.Builder<TDocument>	requireAlias(java.lang.Boolean value)	When true, requires destination to be an alias.
IndexRequest.Builder<TDocument>	routing(java.lang.String value)	Specific routing value
IndexRequest.Builder<TDocument>	tDocumentSerializer(JsonpSerializer<TDocument> value)	Serializer for TDocument.
IndexRequest.Builder<TDocument>	timeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)	Explicit operation timeout
IndexRequest.Builder<TDocument>	timeout(Time value)	Explicit operation timeout
IndexRequest.Builder<TDocument>	version(java.lang.Long value)	Explicit version number for concurrency control
IndexRequest.Builder<TDocument>	versionType(VersionType value)	Specific version type
IndexRequest.Builder<TDocument>	waitForActiveShards(java.util.function.Function<WaitForActiveShards.Builder,ObjectBuilder<WaitForActiveShards>> fn)	Sets the number of shard copies that must be active before proceeding with the index operation.
IndexRequest.Builder<TDocument>	waitForActiveShards(WaitForActiveShards value)	Sets the number of shard copies that must be active before proceeding with the index 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

id

public final IndexRequest.Builder<TDocument> id(@Nullable
                                                java.lang.String value)

Document ID

API name: id

ifPrimaryTerm

public final IndexRequest.Builder<TDocument> ifPrimaryTerm(@Nullable
                                                           java.lang.Long value)

only perform the index operation if the last operation that has changed the document has the specified primary term

API name: if_primary_term

ifSeqNo

public final IndexRequest.Builder<TDocument> ifSeqNo(@Nullable
                                                     java.lang.Long value)

only perform the index operation if the last operation that has changed the document has the specified sequence number

API name: if_seq_no

index

public final IndexRequest.Builder<TDocument> index(java.lang.String value)

Required - The name of the index

API name: index

opType

public final IndexRequest.Builder<TDocument> opType(@Nullable
                                                    OpType value)

Explicit operation type. Defaults to index for requests with an explicit document ID, and to createfor requests without an explicit document ID

API name: op_type

pipeline

public final IndexRequest.Builder<TDocument> pipeline(@Nullable
                                                      java.lang.String value)

The pipeline id to preprocess incoming documents with

API name: pipeline

refresh

public final IndexRequest.Builder<TDocument> 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 IndexRequest.Builder<TDocument> requireAlias(@Nullable
                                                          java.lang.Boolean value)

When true, requires destination to be an alias. Default is false

API name: require_alias

routing

public final IndexRequest.Builder<TDocument> routing(@Nullable
                                                     java.lang.String value)

Specific routing value

API name: routing

timeout

public final IndexRequest.Builder<TDocument> timeout(@Nullable
                                                     Time value)

Explicit operation timeout

API name: timeout

timeout

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

Explicit operation timeout

API name: timeout

version

public final IndexRequest.Builder<TDocument> version(@Nullable
                                                     java.lang.Long value)

Explicit version number for concurrency control

API name: version

versionType

public final IndexRequest.Builder<TDocument> versionType(@Nullable
                                                         VersionType value)

Specific version type

API name: version_type

waitForActiveShards

public final IndexRequest.Builder<TDocument> waitForActiveShards(@Nullable
                                                                 WaitForActiveShards value)

Sets the number of shard copies that must be active before proceeding with the index 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 IndexRequest.Builder<TDocument> waitForActiveShards(java.util.function.Function<WaitForActiveShards.Builder,ObjectBuilder<WaitForActiveShards>> fn)

Sets the number of shard copies that must be active before proceeding with the index 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

document

public final IndexRequest.Builder<TDocument> document(TDocument value)

Required - Request body.

API name: _value_body

tDocumentSerializer

public final IndexRequest.Builder<TDocument> tDocumentSerializer(@Nullable
                                                                 JsonpSerializer<TDocument> value)

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

build

public IndexRequest<TDocument> build()

Builds a IndexRequest.

Specified by:

build in interface ObjectBuilder<TDocument>

Throws:

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