Package co.elastic.clients.elasticsearch.core.bulk

Class UpdateAction.Builder<TDocument,TPartialDocument>

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<UpdateAction.Builder<TDocument,TPartialDocument>>

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

All Implemented Interfaces:

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

Enclosing class:

UpdateAction<TDocument,TPartialDocument>

public static class UpdateAction.Builder<TDocument,TPartialDocument>
extends WithJsonObjectBuilderBase<UpdateAction.Builder<TDocument,TPartialDocument>>
implements ObjectBuilder<UpdateAction<TDocument,TPartialDocument>>

Builder for UpdateAction.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
UpdateAction<TDocument,TPartialDocument>	build()	Builds a UpdateAction.
final UpdateAction.Builder<TDocument,TPartialDocument>	detectNoop(Boolean value)	If true, the result in the response is set to 'noop' when no changes to the document occur.
final UpdateAction.Builder<TDocument,TPartialDocument>	doc(TPartialDocument value)	A partial update to an existing document.
final UpdateAction.Builder<TDocument,TPartialDocument>	docAsUpsert(Boolean value)	Set to true to use the contents of doc as the value of upsert.
final UpdateAction.Builder<TDocument,TPartialDocument>	script(Script value)	The script to run to update the document.
final UpdateAction.Builder<TDocument,TPartialDocument>	script(Function<Script.Builder,ObjectBuilder<Script>> fn)	The script to run to update the document.
final UpdateAction.Builder<TDocument,TPartialDocument>	scriptedUpsert(Boolean value)	Set to true to run the script whether or not the document exists.
protected UpdateAction.Builder<TDocument,TPartialDocument>	self()
final UpdateAction.Builder<TDocument,TPartialDocument>	source(SourceConfig value)	If false, source retrieval is turned off.
final UpdateAction.Builder<TDocument,TPartialDocument>	source(Function<SourceConfig.Builder,ObjectBuilder<SourceConfig>> fn)	If false, source retrieval is turned off.
final UpdateAction.Builder<TDocument,TPartialDocument>	tDocumentSerializer(JsonpSerializer<TDocument> value)	Serializer for TDocument.
final UpdateAction.Builder<TDocument,TPartialDocument>	tPartialDocumentSerializer(JsonpSerializer<TPartialDocument> value)	Serializer for TPartialDocument.
final UpdateAction.Builder<TDocument,TPartialDocument>	upsert(TDocument value)	If the document does not already exist, the contents of upsert are inserted as a new document.

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

detectNoop

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

If true, the result in the response is set to 'noop' when no changes to the document occur.

API name: detect_noop

doc

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

A partial update to an existing document.

API name: doc

docAsUpsert

public final UpdateAction.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

script

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

The script to run to update the document.

API name: script

script

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

The script to run to update the document.

API name: script

scriptedUpsert

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

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

API name: scripted_upsert

source

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

If false, source retrieval is turned off. You can also specify a comma-separated list of the fields you want to retrieve.

API name: _source

source

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

If false, source retrieval is turned off. You can also specify a comma-separated list of the fields you want to retrieve.

API name: _source

upsert

public final UpdateAction.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

tDocumentSerializer

public final UpdateAction.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 UpdateAction.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 UpdateAction.Builder<TDocument,TPartialDocument> self()

Specified by:

self in class WithJsonObjectBuilderBase<UpdateAction.Builder<TDocument,TPartialDocument>>

build

public UpdateAction<TDocument,TPartialDocument> build()

Builds a UpdateAction.

Specified by:

build in interface ObjectBuilder<TDocument>

Throws:

NullPointerException - if some of the required fields are null.