Package org.opensearch.client.opensearch._global

Class CreateRequest.Builder<TDocument>

java.lang.Object

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

All Implemented Interfaces:

ObjectBuilder<CreateRequest<TDocument>>

Enclosing class:

CreateRequest<TDocument>

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

Builder for CreateRequest.

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
CreateRequest<TDocument>	build()	Builds a CreateRequest.
CreateRequest.Builder<TDocument>	id(java.lang.String value)	API name: id
CreateRequest.Builder<TDocument>	index(java.lang.String value)	API name: index
CreateRequest.Builder<TDocument>	pipeline(java.lang.String value)	API name: pipeline
CreateRequest.Builder<TDocument>	refresh(jakarta.json.JsonValue value)	API name: refresh
CreateRequest.Builder<TDocument>	routing(jakarta.json.JsonValue value)	API name: routing
CreateRequest.Builder<TDocument>	tDocumentSerializer(JsonpSerializer<TDocument> value)	Serializer for TDocument.
CreateRequest.Builder<TDocument>	timeout(jakarta.json.JsonValue value)	API name: timeout
CreateRequest.Builder<TDocument>	type(java.lang.String value)	API name: type
CreateRequest.Builder<TDocument>	value(TDocument value)	Request body.
CreateRequest.Builder<TDocument>	version(java.lang.Number value)	API name: version
CreateRequest.Builder<TDocument>	versionType(jakarta.json.JsonValue value)	API name: version_type
CreateRequest.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 CreateRequest.Builder<TDocument> id(java.lang.String value)

API name: id

index

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

API name: index

type

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

API name: type

pipeline

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

API name: pipeline

refresh

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

API name: refresh

routing

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

API name: routing

timeout

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

API name: timeout

version

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

API name: version

versionType

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

API name: version_type

waitForActiveShards

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

API name: wait_for_active_shards

value

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

Request body. API name: value

tDocumentSerializer

public CreateRequest.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 CreateRequest<TDocument> build()

Builds a CreateRequest.

Specified by:

build in interface ObjectBuilder<TDocument>

Throws:

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