Package org.opensearch.client.opensearch._global

Class IndexRequest.Builder<TDocument>

java.lang.Object

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

All Implemented Interfaces:

ObjectBuilder<IndexRequest<TDocument>>

Enclosing class:

IndexRequest<TDocument>

public static class IndexRequest.Builder<TDocument>
extends java.lang.Object
implements ObjectBuilder<IndexRequest<TDocument>>

Builder for IndexRequest.

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
IndexRequest<TDocument>	build()	Builds a IndexRequest.
IndexRequest.Builder<TDocument>	id(java.lang.String value)	API name: id
IndexRequest.Builder<TDocument>	ifPrimaryTerm(java.lang.Number value)	API name: if_primary_term
IndexRequest.Builder<TDocument>	ifSeqNo(java.lang.Number value)	API name: if_seq_no
IndexRequest.Builder<TDocument>	index(java.lang.String value)	API name: index
IndexRequest.Builder<TDocument>	opType(jakarta.json.JsonValue value)	API name: op_type
IndexRequest.Builder<TDocument>	pipeline(java.lang.String value)	API name: pipeline
IndexRequest.Builder<TDocument>	refresh(jakarta.json.JsonValue value)	API name: refresh
IndexRequest.Builder<TDocument>	requireAlias(java.lang.Boolean value)	API name: require_alias
IndexRequest.Builder<TDocument>	routing(jakarta.json.JsonValue value)	API name: routing
IndexRequest.Builder<TDocument>	tDocumentSerializer(JsonpSerializer<TDocument> value)	Serializer for TDocument.
IndexRequest.Builder<TDocument>	timeout(jakarta.json.JsonValue value)	API name: timeout
IndexRequest.Builder<TDocument>	type(java.lang.String value)	API name: type
IndexRequest.Builder<TDocument>	value(TDocument value)	Request body.
IndexRequest.Builder<TDocument>	version(java.lang.Number value)	API name: version
IndexRequest.Builder<TDocument>	versionType(jakarta.json.JsonValue value)	API name: version_type
IndexRequest.Builder<TDocument>	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

id

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

API name: id

index

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

API name: index

type

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

API name: type

ifPrimaryTerm

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

API name: if_primary_term

ifSeqNo

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

API name: if_seq_no

opType

public IndexRequest.Builder<TDocument> opType(@Nullable jakarta.json.JsonValue value)

API name: op_type

pipeline

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

API name: pipeline

refresh

public IndexRequest.Builder<TDocument> refresh(@Nullable jakarta.json.JsonValue value)

API name: refresh

routing

public IndexRequest.Builder<TDocument> routing(@Nullable jakarta.json.JsonValue value)

API name: routing

timeout

public IndexRequest.Builder<TDocument> timeout(@Nullable jakarta.json.JsonValue value)

API name: timeout

version

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

API name: version

versionType

public IndexRequest.Builder<TDocument> versionType(@Nullable jakarta.json.JsonValue value)

API name: version_type

waitForActiveShards

public IndexRequest.Builder<TDocument> waitForActiveShards(@Nullable jakarta.json.JsonValue value)

API name: wait_for_active_shards

requireAlias

public IndexRequest.Builder<TDocument> requireAlias(@Nullable java.lang.Boolean value)

API name: require_alias

value

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

Request body. API name: value

tDocumentSerializer

public 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.