Package org.opensearch.client.opensearch._global

Class UpdateRequest.Builder<TDocument,TPartialDocument>

java.lang.Object

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

All Implemented Interfaces:

ObjectBuilder<UpdateRequest<TDocument,TPartialDocument>>

Enclosing class:

UpdateRequest<TDocument,TPartialDocument>

public static class UpdateRequest.Builder<TDocument,TPartialDocument>
extends java.lang.Object
implements ObjectBuilder<UpdateRequest<TDocument,TPartialDocument>>

Builder for UpdateRequest.

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
UpdateRequest.Builder<TDocument,TPartialDocument>	addSourceExcludes(java.lang.String value)	Add a value to sourceExcludes(List), creating the list if needed.
UpdateRequest.Builder<TDocument,TPartialDocument>	addSourceIncludes(java.lang.String value)	Add a value to sourceIncludes(List), creating the list if needed.
UpdateRequest<TDocument,TPartialDocument>	build()	Builds a UpdateRequest.
UpdateRequest.Builder<TDocument,TPartialDocument>	detectNoop(java.lang.Boolean value)	API name: detect_noop
UpdateRequest.Builder<TDocument,TPartialDocument>	doc(TPartialDocument value)	API name: doc
UpdateRequest.Builder<TDocument,TPartialDocument>	docAsUpsert(java.lang.Boolean value)	API name: doc_as_upsert
UpdateRequest.Builder<TDocument,TPartialDocument>	id(java.lang.String value)	API name: id
UpdateRequest.Builder<TDocument,TPartialDocument>	ifPrimaryTerm(java.lang.Number value)	API name: if_primary_term
UpdateRequest.Builder<TDocument,TPartialDocument>	ifSeqNo(java.lang.Number value)	API name: if_seq_no
UpdateRequest.Builder<TDocument,TPartialDocument>	index(java.lang.String value)	API name: index
UpdateRequest.Builder<TDocument,TPartialDocument>	lang(java.lang.String value)	API name: lang
UpdateRequest.Builder<TDocument,TPartialDocument>	refresh(jakarta.json.JsonValue value)	API name: refresh
UpdateRequest.Builder<TDocument,TPartialDocument>	requireAlias(java.lang.Boolean value)	API name: require_alias
UpdateRequest.Builder<TDocument,TPartialDocument>	retryOnConflict(java.lang.Number value)	API name: retry_on_conflict
UpdateRequest.Builder<TDocument,TPartialDocument>	routing(jakarta.json.JsonValue value)	API name: routing
UpdateRequest.Builder<TDocument,TPartialDocument>	script(jakarta.json.JsonValue value)	API name: script
UpdateRequest.Builder<TDocument,TPartialDocument>	scriptedUpsert(java.lang.Boolean value)	API name: scripted_upsert
UpdateRequest.Builder<TDocument,TPartialDocument>	source(jakarta.json.JsonValue value)	API name: _source
UpdateRequest.Builder<TDocument,TPartialDocument>	sourceEnabled(java.lang.Boolean value)	API name: source_enabled
UpdateRequest.Builder<TDocument,TPartialDocument>	sourceExcludes(java.lang.String... value)	API name: _source_excludes
UpdateRequest.Builder<TDocument,TPartialDocument>	sourceExcludes(java.util.List<java.lang.String> value)	API name: _source_excludes
UpdateRequest.Builder<TDocument,TPartialDocument>	sourceIncludes(java.lang.String... value)	API name: _source_includes
UpdateRequest.Builder<TDocument,TPartialDocument>	sourceIncludes(java.util.List<java.lang.String> value)	API name: _source_includes
UpdateRequest.Builder<TDocument,TPartialDocument>	tDocumentSerializer(JsonpSerializer<TDocument> value)	Serializer for TDocument.
UpdateRequest.Builder<TDocument,TPartialDocument>	timeout(jakarta.json.JsonValue value)	API name: timeout
UpdateRequest.Builder<TDocument,TPartialDocument>	tPartialDocumentSerializer(JsonpSerializer<TPartialDocument> value)	Serializer for TPartialDocument.
UpdateRequest.Builder<TDocument,TPartialDocument>	type(java.lang.String value)	API name: type
UpdateRequest.Builder<TDocument,TPartialDocument>	upsert(TDocument value)	API name: upsert
UpdateRequest.Builder<TDocument,TPartialDocument>	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 UpdateRequest.Builder<TDocument,TPartialDocument> id(java.lang.String value)

API name: id

index

public UpdateRequest.Builder<TDocument,TPartialDocument> index(java.lang.String value)

API name: index

type

public UpdateRequest.Builder<TDocument,TPartialDocument> type(@Nullable java.lang.String value)

API name: type

ifPrimaryTerm

public UpdateRequest.Builder<TDocument,TPartialDocument> ifPrimaryTerm(@Nullable java.lang.Number value)

API name: if_primary_term

ifSeqNo

public UpdateRequest.Builder<TDocument,TPartialDocument> ifSeqNo(@Nullable java.lang.Number value)

API name: if_seq_no

lang

public UpdateRequest.Builder<TDocument,TPartialDocument> lang(@Nullable java.lang.String value)

API name: lang

refresh

public UpdateRequest.Builder<TDocument,TPartialDocument> refresh(@Nullable jakarta.json.JsonValue value)

API name: refresh

requireAlias

public UpdateRequest.Builder<TDocument,TPartialDocument> requireAlias(@Nullable java.lang.Boolean value)

API name: require_alias

retryOnConflict

public UpdateRequest.Builder<TDocument,TPartialDocument> retryOnConflict(@Nullable java.lang.Number value)

API name: retry_on_conflict

routing

public UpdateRequest.Builder<TDocument,TPartialDocument> routing(@Nullable jakarta.json.JsonValue value)

API name: routing

sourceEnabled

public UpdateRequest.Builder<TDocument,TPartialDocument> sourceEnabled(@Nullable java.lang.Boolean value)

API name: source_enabled

timeout

public UpdateRequest.Builder<TDocument,TPartialDocument> timeout(@Nullable jakarta.json.JsonValue value)

API name: timeout

waitForActiveShards

public UpdateRequest.Builder<TDocument,TPartialDocument> waitForActiveShards(@Nullable jakarta.json.JsonValue value)

API name: wait_for_active_shards

sourceExcludes

public UpdateRequest.Builder<TDocument,TPartialDocument> sourceExcludes(@Nullable java.util.List<java.lang.String> value)

API name: _source_excludes

sourceExcludes

public UpdateRequest.Builder<TDocument,TPartialDocument> sourceExcludes(java.lang.String... value)

API name: _source_excludes

addSourceExcludes

public UpdateRequest.Builder<TDocument,TPartialDocument> addSourceExcludes(java.lang.String value)

Add a value to sourceExcludes(List), creating the list if needed.

sourceIncludes

public UpdateRequest.Builder<TDocument,TPartialDocument> sourceIncludes(@Nullable java.util.List<java.lang.String> value)

API name: _source_includes

sourceIncludes

public UpdateRequest.Builder<TDocument,TPartialDocument> sourceIncludes(java.lang.String... value)

API name: _source_includes

addSourceIncludes

public UpdateRequest.Builder<TDocument,TPartialDocument> addSourceIncludes(java.lang.String value)

Add a value to sourceIncludes(List), creating the list if needed.

detectNoop

public UpdateRequest.Builder<TDocument,TPartialDocument> detectNoop(@Nullable java.lang.Boolean value)

API name: detect_noop

doc

public UpdateRequest.Builder<TDocument,TPartialDocument> doc(@Nullable TPartialDocument value)

API name: doc

docAsUpsert

public UpdateRequest.Builder<TDocument,TPartialDocument> docAsUpsert(@Nullable java.lang.Boolean value)

API name: doc_as_upsert

script

public UpdateRequest.Builder<TDocument,TPartialDocument> script(@Nullable jakarta.json.JsonValue value)

API name: script

scriptedUpsert

public UpdateRequest.Builder<TDocument,TPartialDocument> scriptedUpsert(@Nullable java.lang.Boolean value)

API name: scripted_upsert

source

public UpdateRequest.Builder<TDocument,TPartialDocument> source(@Nullable jakarta.json.JsonValue value)

API name: _source

upsert

public UpdateRequest.Builder<TDocument,TPartialDocument> upsert(@Nullable TDocument value)

API name: upsert

tDocumentSerializer

public UpdateRequest.Builder<TDocument,TPartialDocument> tDocumentSerializer(@Nullable JsonpSerializer<TDocument> value)

Serializer for TDocument. If not set, an attempt will be made to find a serializer from the JSON context.

tPartialDocumentSerializer

public UpdateRequest.Builder<TDocument,TPartialDocument> tPartialDocumentSerializer(@Nullable JsonpSerializer<TPartialDocument> value)

Serializer for TPartialDocument. If not set, an attempt will be made to find a serializer from the JSON context.

build

public UpdateRequest<TDocument,TPartialDocument> build()

Builds a UpdateRequest.

Specified by:

build in interface ObjectBuilder<TDocument>

Throws:

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