Package org.opensearch.client.opensearch.core

Class UpdateRequest.Builder<TDocument,TPartialDocument>

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

All Implemented Interfaces:

ObjectBuilder<UpdateRequest<TDocument,TPartialDocument>>

Enclosing class:

UpdateRequest<TDocument,TPartialDocument>

public static class UpdateRequest.Builder<TDocument,TPartialDocument>
extends ObjectBuilderBase
implements ObjectBuilder<UpdateRequest<TDocument,TPartialDocument>>

Builder for UpdateRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
UpdateRequest<TDocument,TPartialDocument>	build()	Builds a UpdateRequest.
final UpdateRequest.Builder<TDocument,TPartialDocument>	detectNoop(Boolean value)	Set to false to disable setting 'result' in the response to 'noop' if no change to the document occurred.
final UpdateRequest.Builder<TDocument,TPartialDocument>	doc(TPartialDocument value)	A partial update to an existing document.
final UpdateRequest.Builder<TDocument,TPartialDocument>	docAsUpsert(Boolean value)	Set to true to use the contents of 'doc' as the value of 'upsert'
final UpdateRequest.Builder<TDocument,TPartialDocument>	id(String value)	Required - Document ID
final UpdateRequest.Builder<TDocument,TPartialDocument>	ifPrimaryTerm(Long value)	Only perform the operation if the document has this primary term.
final UpdateRequest.Builder<TDocument,TPartialDocument>	ifSeqNo(Long value)	Only perform the operation if the document has this sequence number.
final UpdateRequest.Builder<TDocument,TPartialDocument>	index(String value)	Required - The name of the index
final UpdateRequest.Builder<TDocument,TPartialDocument>	lang(String value)	The script language.
final UpdateRequest.Builder<TDocument,TPartialDocument>	refresh(Refresh value)	If 'true', OpenSearch refreshes 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' do nothing with refreshes.
final UpdateRequest.Builder<TDocument,TPartialDocument>	requireAlias(Boolean value)	If true, the destination must be an index alias.
final UpdateRequest.Builder<TDocument,TPartialDocument>	retryOnConflict(Integer value)	Specify how many times should the operation be retried when a conflict occurs.
final UpdateRequest.Builder<TDocument,TPartialDocument>	routing(String value)	Custom value used to route operations to a specific shard.
final UpdateRequest.Builder<TDocument,TPartialDocument>	script(Function<Script.Builder,ObjectBuilder<Script>> fn)	Script to execute to update the document.
final UpdateRequest.Builder<TDocument,TPartialDocument>	script(Script value)	Script to execute to update the document.
final UpdateRequest.Builder<TDocument,TPartialDocument>	scriptedUpsert(Boolean value)	Set to true to execute the script whether or not the document exists.
final UpdateRequest.Builder<TDocument,TPartialDocument>	source(Function<SourceConfig.Builder,ObjectBuilder<SourceConfig>> fn)	Set to false to disable source retrieval.
final UpdateRequest.Builder<TDocument,TPartialDocument>	source(SourceConfig value)	Set to false to disable source retrieval.
final UpdateRequest.Builder<TDocument,TPartialDocument>	tDocumentSerializer(JsonpSerializer<TDocument> value)	Serializer for TDocument.
final UpdateRequest.Builder<TDocument,TPartialDocument>	timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Period to wait for dynamic mapping updates and active shards.
final UpdateRequest.Builder<TDocument,TPartialDocument>	timeout(Time value)	Period to wait for dynamic mapping updates and active shards.
final UpdateRequest.Builder<TDocument,TPartialDocument>	tPartialDocumentSerializer(JsonpSerializer<TPartialDocument> value)	Serializer for TPartialDocument.
final UpdateRequest.Builder<TDocument,TPartialDocument>	upsert(TDocument value)	If the document does not already exist, the contents of 'upsert' are inserted as a new document.
final UpdateRequest.Builder<TDocument,TPartialDocument>	waitForActiveShards(Function<WaitForActiveShards.Builder,ObjectBuilder<WaitForActiveShards>> fn)	The number of shard copies that must be active before proceeding with the operations.
final UpdateRequest.Builder<TDocument,TPartialDocument>	waitForActiveShards(WaitForActiveShards value)	The number of shard copies that must be active before proceeding with the operations.

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

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

source

public final UpdateRequest.Builder<TDocument,TPartialDocument> source(@Nullable
 SourceConfig value)

Set to false to disable source retrieval. You can also specify a comma-separated list of the fields you want to retrieve.

API name: _source

source

public final UpdateRequest.Builder<TDocument,TPartialDocument> source(Function<SourceConfig.Builder,ObjectBuilder<SourceConfig>> fn)

Set to false to disable source retrieval. You can also specify a comma-separated list of the fields you want to retrieve.

API name: _source

detectNoop

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

Set to false to disable setting 'result' in the response to 'noop' if no change to the document occurred.

API name: detect_noop

doc

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

A partial update to an existing document.

API name: doc

docAsUpsert

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

Set to true to use the contents of 'doc' as the value of 'upsert'

API name: doc_as_upsert

id

public final UpdateRequest.Builder<TDocument,TPartialDocument> id(String value)

Required - Document ID

API name: id

ifPrimaryTerm

public final UpdateRequest.Builder<TDocument,TPartialDocument> ifPrimaryTerm(@Nullable
 Long value)

Only perform the operation if the document has this primary term.

API name: if_primary_term

ifSeqNo

public final UpdateRequest.Builder<TDocument,TPartialDocument> ifSeqNo(@Nullable
 Long value)

Only perform the operation if the document has this sequence number.

API name: if_seq_no

index

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

Required - The name of the index

API name: index

lang

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

The script language.

API name: lang

refresh

public final UpdateRequest.Builder<TDocument,TPartialDocument> refresh(@Nullable
 Refresh value)

If 'true', OpenSearch refreshes 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' do nothing with refreshes.

API name: refresh

requireAlias

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

If true, the destination must be an index alias.

API name: require_alias

retryOnConflict

public final UpdateRequest.Builder<TDocument,TPartialDocument> retryOnConflict(@Nullable
 Integer value)

Specify how many times should the operation be retried when a conflict occurs.

API name: retry_on_conflict

routing

public final UpdateRequest.Builder<TDocument,TPartialDocument> routing(@Nullable
 String value)

Custom value used to route operations to a specific shard.

API name: routing

script

public final UpdateRequest.Builder<TDocument,TPartialDocument> script(@Nullable
 Script value)

Script to execute to update the document.

API name: script

script

public final UpdateRequest.Builder<TDocument,TPartialDocument> script(Function<Script.Builder,ObjectBuilder<Script>> fn)

Script to execute to update the document.

API name: script

scriptedUpsert

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

Set to true to execute the script whether or not the document exists.

API name: scripted_upsert

timeout

public final UpdateRequest.Builder<TDocument,TPartialDocument> timeout(@Nullable
 Time value)

Period to wait for dynamic mapping updates and active shards. This guarantees OpenSearch waits for at least the timeout before failing. The actual wait time could be longer, particularly when multiple waits occur.

API name: timeout

timeout

public final UpdateRequest.Builder<TDocument,TPartialDocument> timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

Period to wait for dynamic mapping updates and active shards. This guarantees OpenSearch waits for at least the timeout before failing. The actual wait time could be longer, particularly when multiple waits occur.

API name: timeout

upsert

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

If the document does not already exist, the contents of 'upsert' are inserted as a new document. If the document exists, the 'script' is executed.

API name: upsert

waitForActiveShards

public final UpdateRequest.Builder<TDocument,TPartialDocument> waitForActiveShards(@Nullable
 WaitForActiveShards value)

The number of shard copies that must be active before proceeding with the operations. Set to 'all' or any positive integer up to the total number of shards in the index (number_of_replicas+1). Defaults to 1 meaning the primary shard.

API name: wait_for_active_shards

waitForActiveShards

public final UpdateRequest.Builder<TDocument,TPartialDocument> waitForActiveShards(Function<WaitForActiveShards.Builder,ObjectBuilder<WaitForActiveShards>> fn)

The number of shard copies that must be active before proceeding with the operations. Set to 'all' or any positive integer up to the total number of shards in the index (number_of_replicas+1). Defaults to 1 meaning the primary shard.

API name: wait_for_active_shards

tDocumentSerializer

public final 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 final 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:

NullPointerException - if some of the required fields are null.