Package org.opensearch.client.opensearch.core

Class CreateRequest<TDocument>

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.core.CreateRequest<TDocument>

All Implemented Interfaces:

JsonpSerializable

public class CreateRequest<TDocument>
extends RequestBase
implements JsonpSerializable

Creates a new document in the index.

Returns a 409 response when a document with a same ID already exists in the index.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CreateRequest.Builder<TDocument>	Builder for CreateRequest.

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static Endpoint<CreateRequest<?>,CreateResponse,ErrorResponse>	_ENDPOINT	Endpoint "create".

Method Summary

Modifier and Type	Method	Description
static <TDocument> JsonpDeserializer<CreateRequest<TDocument>>	createCreateRequestDeserializer(JsonpDeserializer<TDocument> tDocumentDeserializer)
TDocument	document()	Required - Request body.
java.lang.String	id()	Required - Document ID
java.lang.String	index()	Required - The name of the index
static <TDocument> CreateRequest<TDocument>	of(java.util.function.Function<CreateRequest.Builder<TDocument>,ObjectBuilder<CreateRequest<TDocument>>> fn)
java.lang.String	pipeline()	The pipeline id to preprocess incoming documents with
Refresh	refresh()	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.
java.lang.String	routing()	Specific routing value
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this value to JSON.
Time	timeout()	Explicit operation timeout
java.lang.Long	version()	Explicit version number for concurrency control
VersionType	versionType()	Specific version type
WaitForActiveShards	waitForActiveShards()	Sets the number of shard copies that must be active before proceeding with the index operation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

_ENDPOINT

public static final Endpoint<CreateRequest<?>,CreateResponse,ErrorResponse> _ENDPOINT

Endpoint "create".

Method Detail

of

public static <TDocument> CreateRequest<TDocument> of(java.util.function.Function<CreateRequest.Builder<TDocument>,ObjectBuilder<CreateRequest<TDocument>>> fn)

id

public final java.lang.String id()

Required - Document ID

API name: id

index

public final java.lang.String index()

Required - The name of the index

API name: index

pipeline

@Nullable
public final java.lang.String pipeline()

The pipeline id to preprocess incoming documents with

API name: pipeline

refresh

@Nullable
public final Refresh refresh()

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

routing

@Nullable
public final java.lang.String routing()

Specific routing value

API name: routing

timeout

@Nullable
public final Time timeout()

Explicit operation timeout

API name: timeout

version

@Nullable
public final java.lang.Long version()

Explicit version number for concurrency control

API name: version

versionType

@Nullable
public final VersionType versionType()

Specific version type

API name: version_type

waitForActiveShards

@Nullable
public final WaitForActiveShards waitForActiveShards()

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 TDocument document()

Required - Request body.

API name: _value_body

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
                      JsonpMapper mapper)

Serialize this value to JSON.

Specified by:

serialize in interface JsonpSerializable

createCreateRequestDeserializer

public static <TDocument> JsonpDeserializer<CreateRequest<TDocument>> createCreateRequestDeserializer(JsonpDeserializer<TDocument> tDocumentDeserializer)