Package org.opensearch.client.opensearch._global

Class UpdateRequest<TDocument,TPartialDocument>

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch._global.UpdateRequest<TDocument,TPartialDocument>

All Implemented Interfaces:

ToJsonp

public final class UpdateRequest<TDocument,TPartialDocument>
extends RequestBase
implements ToJsonp

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UpdateRequest.Builder<TDocument,TPartialDocument>	Builder for UpdateRequest.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	UpdateRequest(UpdateRequest.Builder<TDocument,TPartialDocument> builder)

Method Summary

Modifier and Type	Method	Description
static <TDocument> Endpoint<UpdateRequest<?,?>,UpdateResponse<TDocument>,OpenSearchError>	createUpdateEndpoint(JsonpDeserializer<TDocument> tDocumentDeserializer)	Create an "update" endpoint.
static <TDocument, TPartialDocument> JsonpDeserializer<UpdateRequest<TDocument,TPartialDocument>>	createUpdateRequestDeserializer(JsonpDeserializer<TDocument> tDocumentDeserializer, JsonpDeserializer<TPartialDocument> tPartialDocumentDeserializer)	Create a json deserializer for UpdateRequest
java.lang.Boolean	detectNoop()	API name: detect_noop
TPartialDocument	doc()	API name: doc
java.lang.Boolean	docAsUpsert()	API name: doc_as_upsert
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
java.lang.String	lang()	API name: lang
jakarta.json.JsonValue	refresh()	API name: refresh
java.lang.Boolean	requireAlias()	API name: require_alias
java.lang.Number	retryOnConflict()	API name: retry_on_conflict
jakarta.json.JsonValue	routing()	API name: routing
jakarta.json.JsonValue	script()	API name: script
java.lang.Boolean	scriptedUpsert()	API name: scripted_upsert
protected static <TDocument, TPartialDocument> void	setupUpdateRequestDeserializer(DelegatingDeserializer<UpdateRequest.Builder<TDocument,TPartialDocument>> op, JsonpDeserializer<TDocument> tDocumentDeserializer, JsonpDeserializer<TPartialDocument> tPartialDocumentDeserializer)
jakarta.json.JsonValue	source()	API name: _source
java.lang.Boolean	sourceEnabled()	API name: source_enabled
java.util.List<java.lang.String>	sourceExcludes()	API name: _source_excludes
java.util.List<java.lang.String>	sourceIncludes()	API name: _source_includes
jakarta.json.JsonValue	timeout()	API name: timeout
void	toJsonp(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	toJsonpInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
java.lang.String	type()	API name: type
TDocument	upsert()	API name: upsert
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

Constructor Details

UpdateRequest

protected UpdateRequest(UpdateRequest.Builder<TDocument,TPartialDocument> builder)

Method Details

id

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

lang

@Nullable public java.lang.String lang()

API name: lang

refresh

@Nullable public jakarta.json.JsonValue refresh()

API name: refresh

requireAlias

@Nullable public java.lang.Boolean requireAlias()

API name: require_alias

retryOnConflict

@Nullable public java.lang.Number retryOnConflict()

API name: retry_on_conflict

routing

@Nullable public jakarta.json.JsonValue routing()

API name: routing

sourceEnabled

@Nullable public java.lang.Boolean sourceEnabled()

API name: source_enabled

timeout

@Nullable public jakarta.json.JsonValue timeout()

API name: timeout

waitForActiveShards

@Nullable public jakarta.json.JsonValue waitForActiveShards()

API name: wait_for_active_shards

sourceExcludes

@Nullable public java.util.List<java.lang.String> sourceExcludes()

API name: _source_excludes

sourceIncludes

@Nullable public java.util.List<java.lang.String> sourceIncludes()

API name: _source_includes

detectNoop

@Nullable public java.lang.Boolean detectNoop()

API name: detect_noop

doc

@Nullable public TPartialDocument doc()

API name: doc

docAsUpsert

@Nullable public java.lang.Boolean docAsUpsert()

API name: doc_as_upsert

script

@Nullable public jakarta.json.JsonValue script()

API name: script

scriptedUpsert

@Nullable public java.lang.Boolean scriptedUpsert()

API name: scripted_upsert

source

@Nullable public jakarta.json.JsonValue source()

API name: _source

upsert

@Nullable public TDocument upsert()

API name: upsert

toJsonp

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

Serialize this object to JSON.

Specified by:

toJsonp in interface ToJsonp

toJsonpInternal

protected void toJsonpInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)

createUpdateRequestDeserializer

public static <TDocument, TPartialDocument> JsonpDeserializer<UpdateRequest<TDocument,TPartialDocument>> createUpdateRequestDeserializer(JsonpDeserializer<TDocument> tDocumentDeserializer, JsonpDeserializer<TPartialDocument> tPartialDocumentDeserializer)

Create a json deserializer for UpdateRequest

setupUpdateRequestDeserializer

protected static <TDocument, TPartialDocument> void setupUpdateRequestDeserializer(DelegatingDeserializer<UpdateRequest.Builder<TDocument,TPartialDocument>> op, JsonpDeserializer<TDocument> tDocumentDeserializer, JsonpDeserializer<TPartialDocument> tPartialDocumentDeserializer)

createUpdateEndpoint

public static <TDocument> Endpoint<UpdateRequest<?,?>,UpdateResponse<TDocument>,OpenSearchError> createUpdateEndpoint(JsonpDeserializer<TDocument> tDocumentDeserializer)

Create an "update" endpoint.