Package co.elastic.clients.elasticsearch.core

Class UpdateRequest.Builder<TDocument,TPartialDocument>

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<UpdateRequest.Builder<TDocument,TPartialDocument>>

co.elastic.clients.elasticsearch.core.UpdateRequest.Builder<TDocument,TPartialDocument>

All Implemented Interfaces:

WithJson<UpdateRequest.Builder<TDocument,TPartialDocument>>, ObjectBuilder<UpdateRequest<TDocument,TPartialDocument>>

Enclosing class:

UpdateRequest<TDocument,TPartialDocument>

public static class UpdateRequest.Builder<TDocument,TPartialDocument>
extends RequestBase.AbstractBuilder<UpdateRequest.Builder<TDocument,TPartialDocument>>
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)	If true, the result in the response is set to noop (no operation) when there are no changes to the document.
final UpdateRequest.Builder<TDocument,TPartialDocument>	doc(TPartialDocument value)	A partial update to an existing document.
final UpdateRequest.Builder<TDocument,TPartialDocument>	docAsUpsert(Boolean value)	If true, use the contents of 'doc' as the value of 'upsert'.
final UpdateRequest.Builder<TDocument,TPartialDocument>	id(String value)	Required - A unique identifier for the document to be updated.
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>	includeSourceOnError(Boolean value)	True or false if to include the document source in the error message in case of parsing errors.
final UpdateRequest.Builder<TDocument,TPartialDocument>	index(String value)	Required - The name of the target index.
final UpdateRequest.Builder<TDocument,TPartialDocument>	lang(String value)	The script language.
final UpdateRequest.Builder<TDocument,TPartialDocument>	refresh(Refresh value)	If 'true', Elasticsearch refreshes the affected shards to make this operation visible to search.
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)	The number of times the operation should be retried when a conflict occurs.
final UpdateRequest.Builder<TDocument,TPartialDocument>	routing(String value)	A custom value used to route operations to a specific shard.
final UpdateRequest.Builder<TDocument,TPartialDocument>	script(Script value)	The script to run to update the document.
final UpdateRequest.Builder<TDocument,TPartialDocument>	script(Function<Script.Builder,ObjectBuilder<Script>> fn)	The script to run to update the document.
final UpdateRequest.Builder<TDocument,TPartialDocument>	scriptedUpsert(Boolean value)	If true, run the script whether or not the document exists.
protected UpdateRequest.Builder<TDocument,TPartialDocument>	self()
final UpdateRequest.Builder<TDocument,TPartialDocument>	source(SourceConfig value)	If false, turn off source retrieval.
final UpdateRequest.Builder<TDocument,TPartialDocument>	source(Function<SourceConfig.Builder,ObjectBuilder<SourceConfig>> fn)	If false, turn off source retrieval.
final UpdateRequest.Builder<TDocument,TPartialDocument>	tDocumentSerializer(JsonpSerializer<TDocument> value)	Serializer for TDocument.
final UpdateRequest.Builder<TDocument,TPartialDocument>	timeout(Time value)	The period to wait for the following operations: dynamic mapping updates and waiting for active shards.
final UpdateRequest.Builder<TDocument,TPartialDocument>	timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	The period to wait for the following operations: dynamic mapping updates and waiting for 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(WaitForActiveShards value)	The number of copies of each shard that must be active before proceeding with the operation.
final UpdateRequest.Builder<TDocument,TPartialDocument>	waitForActiveShards(Function<WaitForActiveShards.Builder,ObjectBuilder<WaitForActiveShards>> fn)	The number of copies of each shard that must be active before proceeding with the operation.

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

source

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

If false, turn off 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)

If false, turn off 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)

If true, the result in the response is set to noop (no operation) when there are no changes to the document.

API name: detect_noop

doc

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

A partial update to an existing document. If both doc and script are specified, doc is ignored.

API name: doc

docAsUpsert

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

If true, use the contents of 'doc' as the value of 'upsert'. NOTE: Using ingest pipelines with doc_as_upsert is not supported.

API name: doc_as_upsert

id

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

Required - A unique identifier for the document to be updated.

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

includeSourceOnError

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

True or false if to include the document source in the error message in case of parsing errors.

API name: include_source_on_error

index

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

Required - The name of the target index. By default, the index is created automatically if it doesn't exist.

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', Elasticsearch refreshes the affected shards to make this operation visible to search. If 'wait_for', it waits for a refresh to make this operation visible to search. If 'false', it does 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)

The number of times the operation should be retried when a conflict occurs.

API name: retry_on_conflict

routing

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

A custom value used to route operations to a specific shard.

API name: routing

script

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

The script to run to update the document.

API name: script

script

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

The script to run to update the document.

API name: script

scriptedUpsert

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

If true, run the script whether or not the document exists.

API name: scripted_upsert

timeout

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

The period to wait for the following operations: dynamic mapping updates and waiting for active shards. Elasticsearch waits for at least the timeout period 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)

The period to wait for the following operations: dynamic mapping updates and waiting for active shards. Elasticsearch waits for at least the timeout period 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 run.

API name: upsert

waitForActiveShards

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

The number of copies of each shard that must be active before proceeding with the operation. Set to 'all' or any positive integer up to the total number of shards in the index (number_of_replicas+1). The default value of 1 means it waits for each primary shard to be active.

API name: wait_for_active_shards

waitForActiveShards

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

The number of copies of each shard that must be active before proceeding with the operation. Set to 'all' or any positive integer up to the total number of shards in the index (number_of_replicas+1). The default value of 1 means it waits for each primary shard to be active.

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.

self

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

Specified by:

self in class RequestBase.AbstractBuilder<UpdateRequest.Builder<TDocument,TPartialDocument>>

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.