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
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds aUpdateRequest
.detectNoop
(Boolean value) Set to false to disable setting 'result' in the response to 'noop' if no change to the document occurred.doc
(TPartialDocument value) A partial update to an existing document.docAsUpsert
(Boolean value) Set to true to use the contents of 'doc' as the value of 'upsert'Required - Document IDifPrimaryTerm
(Long value) Only perform the operation if the document has this primary term.Only perform the operation if the document has this sequence number.Required - The name of the indexThe script language.If 'true', Elasticsearch 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.requireAlias
(Boolean value) If true, the destination must be an index alias.retryOnConflict
(Integer value) Specify how many times should the operation be retried when a conflict occurs.Custom value used to route operations to a specific shard.Script to execute to update the document.Script to execute to update the document.scriptedUpsert
(Boolean value) Set to true to execute the script whether or not the document exists.protected UpdateRequest.Builder<TDocument,
TPartialDocument> self()
source
(SourceConfig value) Set to false to disable source retrieval.Set to false to disable source retrieval.Serializer for TDocument.Period to wait for dynamic mapping updates and active shards.Period to wait for dynamic mapping updates and active shards.Serializer for TPartialDocument.If the document does not already exist, the contents of 'upsert' are inserted as a new document.The number of shard copies that must be active before proceeding with the operations.The number of shard copies that must be active before proceeding with the operations.Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase
withJson
Methods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
source
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
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
Set to true to use the contents of 'doc' as the value of 'upsert'API name:
doc_as_upsert
-
id
Required - Document IDAPI name:
id
-
ifPrimaryTerm
Only perform the operation if the document has this primary term.API name:
if_primary_term
-
ifSeqNo
Only perform the operation if the document has this sequence number.API name:
if_seq_no
-
index
Required - The name of the indexAPI name:
index
-
lang
The script language.API name:
lang
-
refresh
If 'true', Elasticsearch 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
Custom value used to route operations to a specific shard.API name:
routing
-
script
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
Period to wait for dynamic mapping updates and active shards. This guarantees Elasticsearch 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 Elasticsearch waits for at least the timeout before failing. The actual wait time could be longer, particularly when multiple waits occur.API name:
timeout
-
upsert
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. -
self
- Specified by:
self
in classRequestBase.AbstractBuilder<UpdateRequest.Builder<TDocument,
TPartialDocument>>
-
build
Builds aUpdateRequest
.- Specified by:
build
in interfaceObjectBuilder<TDocument>
- Throws:
NullPointerException
- if some of the required fields are null.
-