Package org.opensearch.client.opensearch._global

Class IndexRequest<TDocument>

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

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

All Implemented Interfaces:

ToJsonp

public final class IndexRequest<TDocument>
extends RequestBase
implements ToJsonp

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static Endpoint<IndexRequest<?>,IndexResponse,OpenSearchError>	ENDPOINT	Endpoint "index".

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	IndexRequest(IndexRequest.Builder<TDocument> builder)

Method Summary

Modifier and Type	Method	Description
static <TDocument> JsonpDeserializer<IndexRequest<TDocument>>	createIndexRequestDeserializer(JsonpDeserializer<TDocument> tDocumentDeserializer)	Create a json deserializer for IndexRequest
java.lang.String	id()	API name: id
java.lang.Number	ifPrimaryTerm()	API name: if_primary_term
java.lang.Number	ifSeqNo()	API name: if_seq_no
java.lang.String	index()	API name: index
jakarta.json.JsonValue	opType()	API name: op_type
java.lang.String	pipeline()	API name: pipeline
jakarta.json.JsonValue	refresh()	API name: refresh
java.lang.Boolean	requireAlias()	API name: require_alias
jakarta.json.JsonValue	routing()	API name: routing
protected static <TDocument> void	setupIndexRequestDeserializer(DelegatingDeserializer<IndexRequest.Builder<TDocument>> op, JsonpDeserializer<TDocument> tDocumentDeserializer)
jakarta.json.JsonValue	timeout()	API name: timeout
void	toJsonp(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this value to JSON.
java.lang.String	type()	API name: type
TDocument	value()	Request body.
java.lang.Number	version()	API name: version
jakarta.json.JsonValue	versionType()	API name: version_type
jakarta.json.JsonValue	waitForActiveShards()	API name: wait_for_active_shards

Methods inherited from class java.lang.Object

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

Field Details

ENDPOINT

public static final Endpoint<IndexRequest<?>,IndexResponse,OpenSearchError> ENDPOINT

Endpoint "index".

Constructor Details

IndexRequest

protected IndexRequest(IndexRequest.Builder<TDocument> builder)

Method Details

id

@Nullable public java.lang.String id()

API name: id

index

public java.lang.String index()

API name: index

type

@Nullable public java.lang.String type()

API name: type

ifPrimaryTerm

@Nullable public java.lang.Number ifPrimaryTerm()

API name: if_primary_term

ifSeqNo

@Nullable public java.lang.Number ifSeqNo()

API name: if_seq_no

opType

@Nullable public jakarta.json.JsonValue opType()

API name: op_type

pipeline

@Nullable public java.lang.String pipeline()

API name: pipeline

refresh

@Nullable public jakarta.json.JsonValue refresh()

API name: refresh

routing

@Nullable public jakarta.json.JsonValue routing()

API name: routing

timeout

@Nullable public jakarta.json.JsonValue timeout()

API name: timeout

version

@Nullable public java.lang.Number version()

API name: version

versionType

@Nullable public jakarta.json.JsonValue versionType()

API name: version_type

waitForActiveShards

@Nullable public jakarta.json.JsonValue waitForActiveShards()

API name: wait_for_active_shards

requireAlias

@Nullable public java.lang.Boolean requireAlias()

API name: require_alias

value

public TDocument value()

Request body. API name: value

toJsonp

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

Serialize this value to JSON.

Specified by:

toJsonp in interface ToJsonp

createIndexRequestDeserializer

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

Create a json deserializer for IndexRequest

setupIndexRequestDeserializer

protected static <TDocument> void setupIndexRequestDeserializer(DelegatingDeserializer<IndexRequest.Builder<TDocument>> op, JsonpDeserializer<TDocument> tDocumentDeserializer)