Package org.opensearch.client.opensearch.core

Class IndexRequest<TDocument>

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

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

All Implemented Interfaces:

JsonpSerializable

public class IndexRequest<TDocument>
extends RequestBase
implements JsonpSerializable

Creates or updates a document in an index.

Nested Class Summary

Nested Classes

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

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<IndexRequest<?>,IndexResponse,ErrorResponse>	_ENDPOINT	Endpoint "index".

Method Summary

Modifier and Type	Method	Description
static <TDocument> JsonpDeserializer<IndexRequest<TDocument>>	createIndexRequestDeserializer(JsonpDeserializer<TDocument> tDocumentDeserializer)
TDocument	document()	Required - Request body.
java.lang.String	id()	Document ID
java.lang.Long	ifPrimaryTerm()	only perform the index operation if the last operation that has changed the document has the specified primary term
java.lang.Long	ifSeqNo()	only perform the index operation if the last operation that has changed the document has the specified sequence number
java.lang.String	index()	Required - The name of the index
static <TDocument> IndexRequest<TDocument>	of(java.util.function.Function<IndexRequest.Builder<TDocument>,ObjectBuilder<IndexRequest<TDocument>>> fn)
OpType	opType()	Explicit operation type.
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.Boolean	requireAlias()	When true, requires destination to be an alias.
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<IndexRequest<?>,IndexResponse,ErrorResponse> _ENDPOINT

Endpoint "index".

Method Detail

of

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

id

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

Document ID

API name: id

ifPrimaryTerm

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

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

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

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 java.lang.String index()

Required - The name of the index

API name: index

opType

@Nullable
public final OpType opType()

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

@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

requireAlias

@Nullable
public final java.lang.Boolean requireAlias()

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

API name: require_alias

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

createIndexRequestDeserializer

public static <TDocument> JsonpDeserializer<IndexRequest<TDocument>> createIndexRequestDeserializer(JsonpDeserializer<TDocument> tDocumentDeserializer)