Package org.opensearch.action.update

Class UpdateRequest

java.lang.Object

org.opensearch.transport.TransportMessage

org.opensearch.transport.TransportRequest

org.opensearch.action.ActionRequest

org.opensearch.action.support.single.instance.InstanceShardOperationRequest<UpdateRequest>

org.opensearch.action.update.UpdateRequest

All Implemented Interfaces:

org.apache.lucene.util.Accountable, DocWriteRequest<UpdateRequest>, IndicesRequest, WriteRequest<UpdateRequest>, Writeable, org.opensearch.common.xcontent.ToXContent, org.opensearch.common.xcontent.ToXContentObject, TaskAwareRequest

public class UpdateRequest
extends InstanceShardOperationRequest<UpdateRequest>
implements DocWriteRequest<UpdateRequest>, WriteRequest<UpdateRequest>, org.opensearch.common.xcontent.ToXContentObject

Transport request for updating an index

Opensearch.internal:

Nested Class Summary

Nested classes/interfaces inherited from class org.opensearch.transport.TransportRequest

TransportRequest.Empty

Nested classes/interfaces inherited from interface org.opensearch.action.DocWriteRequest

DocWriteRequest.OpType

Nested classes/interfaces inherited from interface org.opensearch.action.IndicesRequest

IndicesRequest.Replaceable

Nested classes/interfaces inherited from interface org.opensearch.common.xcontent.ToXContent

org.opensearch.common.xcontent.ToXContent.DelegatingMapParams, org.opensearch.common.xcontent.ToXContent.MapParams, org.opensearch.common.xcontent.ToXContent.Params

Nested classes/interfaces inherited from interface org.opensearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Nested classes/interfaces inherited from interface org.opensearch.action.support.WriteRequest

WriteRequest.RefreshPolicy

Field Summary

Fields inherited from class org.opensearch.action.support.single.instance.InstanceShardOperationRequest

DEFAULT_TIMEOUT, index, shardId, timeout

Fields inherited from interface org.apache.lucene.util.Accountable

NULL_ACCOUNTABLE

Fields inherited from interface org.opensearch.action.DocWriteRequest

REQUIRE_ALIAS

Fields inherited from interface org.opensearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
UpdateRequest()
UpdateRequest(String index, String id)
UpdateRequest(StreamInput in)
UpdateRequest(ShardId shardId, StreamInput in)

Method Summary

Modifier and Type	Method	Description
UpdateRequest	addScriptParam(String name, Object value)	Deprecated. Use script(Script) instead
boolean	detectNoop()	Should this update attempt to detect if it is a noop? Defaults to true.
UpdateRequest	detectNoop(boolean detectNoop)	Should this update attempt to detect if it is a noop? Defaults to true.
IndexRequest	doc()
UpdateRequest	doc(byte[] source, int offset, int length, org.opensearch.common.xcontent.XContentType xContentType)	Sets the doc to use for updates when a script is not specified.
UpdateRequest	doc(byte[] source, org.opensearch.common.xcontent.XContentType xContentType)	Sets the doc to use for updates when a script is not specified.
UpdateRequest	doc(Object... source)	Sets the doc to use for updates when a script is not specified, the doc provided is a field and value pairs.
UpdateRequest	doc(String source, org.opensearch.common.xcontent.XContentType xContentType)	Sets the doc to use for updates when a script is not specified.
UpdateRequest	doc(Map<String,Object> source)	Sets the doc to use for updates when a script is not specified.
UpdateRequest	doc(Map<String,Object> source, org.opensearch.common.xcontent.XContentType contentType)	Sets the doc to use for updates when a script is not specified.
UpdateRequest	doc(IndexRequest doc)	Sets the doc to use for updates when a script is not specified.
UpdateRequest	doc(org.opensearch.common.xcontent.XContentBuilder source)	Sets the doc to use for updates when a script is not specified.
UpdateRequest	doc(org.opensearch.common.xcontent.XContentType xContentType, Object... source)	Sets the doc to use for updates when a script is not specified, the doc provided is a field and value pairs.
boolean	docAsUpsert()
UpdateRequest	docAsUpsert(boolean shouldUpsertDoc)
FetchSourceContext	fetchSource()	Gets the FetchSourceContext which defines how the _source should be fetched.
UpdateRequest	fetchSource(boolean fetchSource)	Indicates whether the response should contain the updated _source.
UpdateRequest	fetchSource(String[] includes, String[] excludes)	Indicate that _source should be returned, with an "include" and/or "exclude" set which can include simple wildcard elements.
UpdateRequest	fetchSource(String include, String exclude)	Indicate that _source should be returned with every hit, with an "include" and/or "exclude" set which can include simple wildcard elements.
UpdateRequest	fetchSource(FetchSourceContext context)	Explicitly set the fetch source context for this request
UpdateRequest	fromXContent(org.opensearch.common.xcontent.XContentParser parser)
WriteRequest.RefreshPolicy	getRefreshPolicy()	Should this request trigger a refresh (WriteRequest.RefreshPolicy.IMMEDIATE), wait for a refresh ( WriteRequest.RefreshPolicy.WAIT_UNTIL), or proceed ignore refreshes entirely (WriteRequest.RefreshPolicy.NONE, the default).
ShardId	getShardId()
String	id()	The id of the indexed document.
UpdateRequest	id(String id)	Sets the id of the indexed document.
long	ifPrimaryTerm()	If set, only perform this update request if the document was last modification was assigned this primary term.
long	ifSeqNo()	If set, only perform this update request if the document was last modification was assigned this sequence number.
boolean	isRequireAlias()	Should this request override specifically require the destination to be an alias?
DocWriteRequest.OpType	opType()	Get the requested document operation type of the request
long	ramBytesUsed()
int	retryOnConflict()
UpdateRequest	retryOnConflict(int retryOnConflict)	Sets the number of retries of a version conflict occurs because the document was updated between getting it and updating it.
String	routing()	Controls the shard routing of the request.
UpdateRequest	routing(String routing)	Controls the shard routing of the request.
Script	script()
UpdateRequest	script(String script)	Deprecated. Use script(Script) instead
UpdateRequest	script(String script, String scriptLang, ScriptType scriptType, Map<String,Object> scriptParams)	Deprecated. Use script(Script) instead
UpdateRequest	script(String script, ScriptType scriptType)	Deprecated. Use script(Script) instead
UpdateRequest	script(String script, ScriptType scriptType, Map<String,Object> scriptParams)	Deprecated. Use script(Script) instead
UpdateRequest	script(Script script)	The script to execute.
boolean	scriptedUpsert()
UpdateRequest	scriptedUpsert(boolean scriptedUpsert)
String	scriptLang()	Deprecated. Use script() instead
UpdateRequest	scriptLang(String scriptLang)	Deprecated. Use script(Script) instead
Map<String,Object>	scriptParams()	Deprecated. Use script() instead
UpdateRequest	scriptParams(Map<String,Object> scriptParams)	Deprecated. Use script(Script) instead
String	scriptString()	Deprecated. Use script() instead
ScriptType	scriptType()	Deprecated. Use script() instead
UpdateRequest	setIfPrimaryTerm(long term)	only performs this update request if the document's last modification was assigned the given primary term.
UpdateRequest	setIfSeqNo(long seqNo)	only perform this update request if the document's modification was assigned the given sequence number.
UpdateRequest	setRefreshPolicy(WriteRequest.RefreshPolicy refreshPolicy)	Should this request trigger a refresh (WriteRequest.RefreshPolicy.IMMEDIATE), wait for a refresh ( WriteRequest.RefreshPolicy.WAIT_UNTIL), or proceed ignore refreshes entirely (WriteRequest.RefreshPolicy.NONE, the default).
UpdateRequest	setRequireAlias(boolean requireAlias)
String	toString()
org.opensearch.common.xcontent.XContentBuilder	toXContent(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params params)
UpdateRequest	upsert(byte[] source, int offset, int length, org.opensearch.common.xcontent.XContentType xContentType)	Sets the doc source of the update request to be used when the document does not exists.
UpdateRequest	upsert(byte[] source, org.opensearch.common.xcontent.XContentType xContentType)	Sets the doc source of the update request to be used when the document does not exists.
UpdateRequest	upsert(Object... source)	Sets the doc source of the update request to be used when the document does not exists.
UpdateRequest	upsert(String source, org.opensearch.common.xcontent.XContentType xContentType)	Sets the doc source of the update request to be used when the document does not exists.
UpdateRequest	upsert(Map<String,Object> source)	Sets the doc source of the update request to be used when the document does not exists.
UpdateRequest	upsert(Map<String,Object> source, org.opensearch.common.xcontent.XContentType contentType)	Sets the doc source of the update request to be used when the document does not exists.
UpdateRequest	upsert(IndexRequest upsertRequest)	Sets the index request to be used if the document does not exists.
UpdateRequest	upsert(org.opensearch.common.xcontent.XContentBuilder source)	Sets the doc source of the update request to be used when the document does not exists.
UpdateRequest	upsert(org.opensearch.common.xcontent.XContentType xContentType, Object... source)	Sets the doc source of the update request to be used when the document does not exists.
IndexRequest	upsertRequest()
ActionRequestValidationException	validate()
long	version()	Get the document version for this request
UpdateRequest	version(long version)	Sets the version, which will perform the operation only if a matching version exists and no changes happened on the doc since then.
VersionType	versionType()	Get the document version type for this request
UpdateRequest	versionType(VersionType versionType)	Sets the versioning type.
ActiveShardCount	waitForActiveShards()
UpdateRequest	waitForActiveShards(int waitForActiveShards)	A shortcut for waitForActiveShards(ActiveShardCount) where the numerical shard count is passed in, instead of having to first call ActiveShardCount.from(int) to get the ActiveShardCount.
UpdateRequest	waitForActiveShards(ActiveShardCount waitForActiveShards)	Sets the number of shard copies that must be active before proceeding with the write.
void	writeThin(StreamOutput out)
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class org.opensearch.action.support.single.instance.InstanceShardOperationRequest

concreteIndex, index, index, indices, indicesOptions, timeout, timeout, timeout

Methods inherited from class org.opensearch.action.ActionRequest

getShouldStoreResult

Methods inherited from class org.opensearch.transport.TransportRequest

getParentTask, setParentTask

Methods inherited from class org.opensearch.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.lucene.util.Accountable

getChildResources

Methods inherited from interface org.opensearch.action.DocWriteRequest

index, index, indicesOptions

Methods inherited from interface org.opensearch.action.IndicesRequest

includeDataStreams, indices

Methods inherited from interface org.opensearch.tasks.TaskAwareRequest

createTask, getDescription, setParentTask

Methods inherited from interface org.opensearch.common.xcontent.ToXContentObject

isFragment

Methods inherited from interface org.opensearch.action.support.WriteRequest

setRefreshPolicy

Constructor Details

UpdateRequest

public UpdateRequest()

UpdateRequest

public UpdateRequest(StreamInput in)
              throws IOException

Throws:

IOException

UpdateRequest

public UpdateRequest(@Nullable
 ShardId shardId,
 StreamInput in)
              throws IOException

Throws:

IOException

UpdateRequest

public UpdateRequest(String index,
 String id)

Method Details

validate

public ActionRequestValidationException validate()

Specified by:

validate in interface WriteRequest<UpdateRequest>

Overrides:

validate in class InstanceShardOperationRequest<UpdateRequest>

id

public String id()

The id of the indexed document.

Specified by:

id in interface DocWriteRequest<UpdateRequest>

Returns:

the id

id

public UpdateRequest id(String id)

Sets the id of the indexed document.

routing

public UpdateRequest routing(String routing)

Controls the shard routing of the request. Using this value to hash the shard and not the id.

Specified by:

routing in interface DocWriteRequest<UpdateRequest>

Returns:

the Request

routing

public String routing()

Controls the shard routing of the request. Using this value to hash the shard and not the id.

Specified by:

routing in interface DocWriteRequest<UpdateRequest>

Returns:

the Routing

getShardId

public ShardId getShardId()

script

public Script script()

script

public UpdateRequest script(Script script)

The script to execute. Note, make sure not to send different script each times and instead use script params if possible with the same (automatically compiled) script.

scriptString

@Deprecated
public String scriptString()

Deprecated.

Use script() instead

scriptType

@Deprecated
public ScriptType scriptType()

Deprecated.

Use script() instead

scriptParams

@Deprecated
public Map<String,Object> scriptParams()

Deprecated.

Use script() instead

script

@Deprecated
public UpdateRequest script(String script,
 ScriptType scriptType)

Deprecated.

Use script(Script) instead

The script to execute. Note, make sure not to send different script each times and instead use script params if possible with the same (automatically compiled) script.

script

@Deprecated
public UpdateRequest script(String script)

Deprecated.

Use script(Script) instead

The script to execute. Note, make sure not to send different script each times and instead use script params if possible with the same (automatically compiled) script.

scriptLang

@Deprecated
public UpdateRequest scriptLang(String scriptLang)

Deprecated.

Use script(Script) instead

The language of the script to execute.

scriptLang

@Deprecated
public String scriptLang()

Deprecated.

Use script() instead

addScriptParam

@Deprecated
public UpdateRequest addScriptParam(String name,
 Object value)

Deprecated.

Use script(Script) instead

Add a script parameter.

scriptParams

@Deprecated
public UpdateRequest scriptParams(Map<String,Object> scriptParams)

Deprecated.

Use script(Script) instead

Sets the script parameters to use with the script.

script

@Deprecated
public UpdateRequest script(String script,
 ScriptType scriptType,
 @Nullable
 Map<String,Object> scriptParams)

Deprecated.

Use script(Script) instead

The script to execute. Note, make sure not to send different script each times and instead use script params if possible with the same (automatically compiled) script.

script

@Deprecated
public UpdateRequest script(String script,
 @Nullable
 String scriptLang,
 ScriptType scriptType,
 @Nullable
 Map<String,Object> scriptParams)

Deprecated.

Use script(Script) instead

The script to execute. Note, make sure not to send different script each times and instead use script params if possible with the same (automatically compiled) script.

Parameters:

script - The script to execute

scriptLang - The script language

scriptType - The script type

scriptParams - The script parameters

fetchSource

public UpdateRequest fetchSource(@Nullable
 String include,
 @Nullable
 String exclude)

Indicate that _source should be returned with every hit, with an "include" and/or "exclude" set which can include simple wildcard elements.

Parameters:

include - An optional include (optionally wildcarded) pattern to filter the returned _source

exclude - An optional exclude (optionally wildcarded) pattern to filter the returned _source

fetchSource

public UpdateRequest fetchSource(@Nullable
 String[] includes,
 @Nullable
 String[] excludes)

Indicate that _source should be returned, with an "include" and/or "exclude" set which can include simple wildcard elements.

Parameters:

includes - An optional list of include (optionally wildcarded) pattern to filter the returned _source

excludes - An optional list of exclude (optionally wildcarded) pattern to filter the returned _source

fetchSource

public UpdateRequest fetchSource(boolean fetchSource)

Indicates whether the response should contain the updated _source.

fetchSource

public UpdateRequest fetchSource(FetchSourceContext context)

Explicitly set the fetch source context for this request

fetchSource

public FetchSourceContext fetchSource()

Gets the FetchSourceContext which defines how the _source should be fetched.

retryOnConflict

public UpdateRequest retryOnConflict(int retryOnConflict)

Sets the number of retries of a version conflict occurs because the document was updated between getting it and updating it. Defaults to 0.

retryOnConflict

public int retryOnConflict()

version

public UpdateRequest version(long version)

Description copied from interface: DocWriteRequest

Sets the version, which will perform the operation only if a matching version exists and no changes happened on the doc since then.

Specified by:

version in interface DocWriteRequest<UpdateRequest>

version

public long version()

Description copied from interface: DocWriteRequest

Get the document version for this request

Specified by:

version in interface DocWriteRequest<UpdateRequest>

Returns:

the document version

versionType

public UpdateRequest versionType(VersionType versionType)

Description copied from interface: DocWriteRequest

Sets the versioning type. Defaults to VersionType.INTERNAL.

Specified by:

versionType in interface DocWriteRequest<UpdateRequest>

versionType

public VersionType versionType()

Description copied from interface: DocWriteRequest

Get the document version type for this request

Specified by:

versionType in interface DocWriteRequest<UpdateRequest>

Returns:

the document version type

setIfSeqNo

public UpdateRequest setIfSeqNo(long seqNo)

only perform this update request if the document's modification was assigned the given sequence number. Must be used in combination with setIfPrimaryTerm(long) If the document last modification was assigned a different sequence number a VersionConflictEngineException will be thrown.

Specified by:

setIfSeqNo in interface DocWriteRequest<UpdateRequest>

setIfPrimaryTerm

public UpdateRequest setIfPrimaryTerm(long term)

only performs this update request if the document's last modification was assigned the given primary term. Must be used in combination with setIfSeqNo(long) If the document last modification was assigned a different term a VersionConflictEngineException will be thrown.

Specified by:

setIfPrimaryTerm in interface DocWriteRequest<UpdateRequest>

ifSeqNo

public long ifSeqNo()

If set, only perform this update request if the document was last modification was assigned this sequence number. If the document last modification was assigned a different sequence number a VersionConflictEngineException will be thrown.

Specified by:

ifSeqNo in interface DocWriteRequest<UpdateRequest>

ifPrimaryTerm

public long ifPrimaryTerm()

If set, only perform this update request if the document was last modification was assigned this primary term. If the document last modification was assigned a different term a VersionConflictEngineException will be thrown.

Specified by:

ifPrimaryTerm in interface DocWriteRequest<UpdateRequest>

opType

public DocWriteRequest.OpType opType()

Description copied from interface: DocWriteRequest

Get the requested document operation type of the request

Specified by:

opType in interface DocWriteRequest<UpdateRequest>

Returns:

the operation type DocWriteRequest.OpType

setRefreshPolicy

public UpdateRequest setRefreshPolicy(WriteRequest.RefreshPolicy refreshPolicy)

Description copied from interface: WriteRequest

Should this request trigger a refresh (WriteRequest.RefreshPolicy.IMMEDIATE), wait for a refresh ( WriteRequest.RefreshPolicy.WAIT_UNTIL), or proceed ignore refreshes entirely (WriteRequest.RefreshPolicy.NONE, the default).

Specified by:

setRefreshPolicy in interface WriteRequest<UpdateRequest>

getRefreshPolicy

public WriteRequest.RefreshPolicy getRefreshPolicy()

Description copied from interface: WriteRequest

Should this request trigger a refresh (WriteRequest.RefreshPolicy.IMMEDIATE), wait for a refresh ( WriteRequest.RefreshPolicy.WAIT_UNTIL), or proceed ignore refreshes entirely (WriteRequest.RefreshPolicy.NONE, the default).

Specified by:

getRefreshPolicy in interface WriteRequest<UpdateRequest>

waitForActiveShards

public ActiveShardCount waitForActiveShards()

waitForActiveShards

public UpdateRequest waitForActiveShards(ActiveShardCount waitForActiveShards)

Sets the number of shard copies that must be active before proceeding with the write. See ReplicationRequest.waitForActiveShards(ActiveShardCount) for details.

waitForActiveShards

public UpdateRequest waitForActiveShards(int waitForActiveShards)

A shortcut for waitForActiveShards(ActiveShardCount) where the numerical shard count is passed in, instead of having to first call ActiveShardCount.from(int) to get the ActiveShardCount.

doc

public UpdateRequest doc(IndexRequest doc)

Sets the doc to use for updates when a script is not specified.

doc

public UpdateRequest doc(org.opensearch.common.xcontent.XContentBuilder source)

Sets the doc to use for updates when a script is not specified.

doc

public UpdateRequest doc(Map<String,Object> source)

Sets the doc to use for updates when a script is not specified.

doc

public UpdateRequest doc(Map<String,Object> source,
 org.opensearch.common.xcontent.XContentType contentType)

Sets the doc to use for updates when a script is not specified.

doc

public UpdateRequest doc(String source,
 org.opensearch.common.xcontent.XContentType xContentType)

Sets the doc to use for updates when a script is not specified.

doc

public UpdateRequest doc(byte[] source,
 org.opensearch.common.xcontent.XContentType xContentType)

Sets the doc to use for updates when a script is not specified.

doc

public UpdateRequest doc(byte[] source,
 int offset,
 int length,
 org.opensearch.common.xcontent.XContentType xContentType)

Sets the doc to use for updates when a script is not specified.

doc

public UpdateRequest doc(Object... source)

Sets the doc to use for updates when a script is not specified, the doc provided is a field and value pairs.

doc

public UpdateRequest doc(org.opensearch.common.xcontent.XContentType xContentType,
 Object... source)

Sets the doc to use for updates when a script is not specified, the doc provided is a field and value pairs.

doc

public IndexRequest doc()

upsert

public UpdateRequest upsert(IndexRequest upsertRequest)

Sets the index request to be used if the document does not exists. Otherwise, a DocumentMissingException is thrown.

upsert

public UpdateRequest upsert(org.opensearch.common.xcontent.XContentBuilder source)

Sets the doc source of the update request to be used when the document does not exists.

upsert

public UpdateRequest upsert(Map<String,Object> source)

Sets the doc source of the update request to be used when the document does not exists.

upsert

public UpdateRequest upsert(Map<String,Object> source,
 org.opensearch.common.xcontent.XContentType contentType)

Sets the doc source of the update request to be used when the document does not exists.

upsert

public UpdateRequest upsert(String source,
 org.opensearch.common.xcontent.XContentType xContentType)

Sets the doc source of the update request to be used when the document does not exists.

upsert

public UpdateRequest upsert(byte[] source,
 org.opensearch.common.xcontent.XContentType xContentType)

Sets the doc source of the update request to be used when the document does not exists.

upsert

public UpdateRequest upsert(byte[] source,
 int offset,
 int length,
 org.opensearch.common.xcontent.XContentType xContentType)

Sets the doc source of the update request to be used when the document does not exists.

upsert

public UpdateRequest upsert(Object... source)

Sets the doc source of the update request to be used when the document does not exists. The doc includes field and value pairs.

upsert

public UpdateRequest upsert(org.opensearch.common.xcontent.XContentType xContentType,
 Object... source)

Sets the doc source of the update request to be used when the document does not exists. The doc includes field and value pairs.

upsertRequest

public IndexRequest upsertRequest()

detectNoop

public UpdateRequest detectNoop(boolean detectNoop)

Should this update attempt to detect if it is a noop? Defaults to true.

Returns:

this for chaining

detectNoop

public boolean detectNoop()

Should this update attempt to detect if it is a noop? Defaults to true.

fromXContent

public UpdateRequest fromXContent(org.opensearch.common.xcontent.XContentParser parser)
                           throws IOException

Throws:

IOException

docAsUpsert

public boolean docAsUpsert()

docAsUpsert

public UpdateRequest docAsUpsert(boolean shouldUpsertDoc)

scriptedUpsert

public boolean scriptedUpsert()

scriptedUpsert

public UpdateRequest scriptedUpsert(boolean scriptedUpsert)

isRequireAlias

public boolean isRequireAlias()

Description copied from interface: DocWriteRequest

Should this request override specifically require the destination to be an alias?

Specified by:

isRequireAlias in interface DocWriteRequest<UpdateRequest>

Returns:

boolean flag, when true specifically requires an alias

setRequireAlias

public UpdateRequest setRequireAlias(boolean requireAlias)

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class InstanceShardOperationRequest<UpdateRequest>

Throws:

IOException

writeThin

public void writeThin(StreamOutput out)
               throws IOException

Overrides:

writeThin in class InstanceShardOperationRequest<UpdateRequest>

Throws:

IOException

toXContent

public org.opensearch.common.xcontent.XContentBuilder toXContent(org.opensearch.common.xcontent.XContentBuilder builder,
 org.opensearch.common.xcontent.ToXContent.Params params)
                                                          throws IOException

Specified by:

toXContent in interface org.opensearch.common.xcontent.ToXContent

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object

ramBytesUsed

public long ramBytesUsed()

Specified by:

ramBytesUsed in interface org.apache.lucene.util.Accountable