Package org.opensearch.client.opensearch.core.bulk

Class UpdateOperation.Builder<TDocument>

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.core.bulk.BulkOperationBase.AbstractBuilder<UpdateOperation.Builder<TDocument>>

org.opensearch.client.opensearch.core.bulk.UpdateOperation.Builder<TDocument>

All Implemented Interfaces:

ObjectBuilder<UpdateOperation<TDocument>>

Enclosing class:

UpdateOperation<TDocument>

public static class UpdateOperation.Builder<TDocument>
extends BulkOperationBase.AbstractBuilder<UpdateOperation.Builder<TDocument>>
implements ObjectBuilder<UpdateOperation<TDocument>>

Builder for UpdateOperation.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
UpdateOperation<TDocument>	build()	Builds a UpdateOperation.
UpdateOperation.Builder<TDocument>	docAsUpsert(java.lang.Boolean value)	API name: docAsUpsert
UpdateOperation.Builder<TDocument>	document(TDocument value)	API name: document
UpdateOperation.Builder<TDocument>	requireAlias(java.lang.Boolean value)	API name: require_alias
UpdateOperation.Builder<TDocument>	retryOnConflict(java.lang.Integer value)	API name: retry_on_conflict
UpdateOperation.Builder<TDocument>	script(Script value)	API name: script
protected UpdateOperation.Builder<TDocument>	self()
UpdateOperation.Builder<TDocument>	tDocumentSerializer(JsonpSerializer<TDocument> value)	Serializer for TDocument.
UpdateOperation.Builder<TDocument>	upsert(TDocument value)	API name: upsert

Methods inherited from class org.opensearch.client.opensearch.core.bulk.BulkOperationBase.AbstractBuilder

id, ifPrimaryTerm, ifSeqNo, index, routing, version, versionType

Methods inherited from class org.opensearch.client.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

Constructor Detail

Builder

public Builder()

Method Detail

document

public final UpdateOperation.Builder<TDocument> document(TDocument value)

API name: document

docAsUpsert

public final UpdateOperation.Builder<TDocument> docAsUpsert(@Nullable
                                                            java.lang.Boolean value)

API name: docAsUpsert

upsert

public final UpdateOperation.Builder<TDocument> upsert(@Nullable
                                                       TDocument value)

API name: upsert

script

public final UpdateOperation.Builder<TDocument> script(@Nullable
                                                       Script value)

API name: script

requireAlias

public final UpdateOperation.Builder<TDocument> requireAlias(@Nullable
                                                             java.lang.Boolean value)

API name: require_alias

retryOnConflict

public final UpdateOperation.Builder<TDocument> retryOnConflict(@Nullable
                                                                java.lang.Integer value)

API name: retry_on_conflict

tDocumentSerializer

public final UpdateOperation.Builder<TDocument> tDocumentSerializer(@Nullable
                                                                    JsonpSerializer<TDocument> value)

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

self

protected UpdateOperation.Builder<TDocument> self()

Specified by:

self in class BulkOperationBase.AbstractBuilder<UpdateOperation.Builder<TDocument>>

build

public UpdateOperation<TDocument> build()

Builds a UpdateOperation.

Specified by:

build in interface ObjectBuilder<TDocument>

Throws:

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