Package org.elasticsearch.action.update
Class UpdateRequest
java.lang.Object
- All Implemented Interfaces:
DocWriteRequest<UpdateRequest>
,IndicesRequest
,WriteRequest<UpdateRequest>
,Writeable
,ToXContent
,ToXContentObject
,TaskAwareRequest
public class UpdateRequest extends InstanceShardOperationRequest<UpdateRequest> implements DocWriteRequest<UpdateRequest>, WriteRequest<UpdateRequest>, ToXContentObject
-
Nested Class Summary
Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportRequest
TransportRequest.Empty
Nested classes/interfaces inherited from interface org.elasticsearch.action.DocWriteRequest
DocWriteRequest.OpType
Nested classes/interfaces inherited from interface org.elasticsearch.action.IndicesRequest
IndicesRequest.Replaceable
Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params
Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V>
Nested classes/interfaces inherited from interface org.elasticsearch.action.support.WriteRequest
WriteRequest.RefreshPolicy
-
Field Summary
Fields inherited from class org.elasticsearch.action.support.single.instance.InstanceShardOperationRequest
DEFAULT_TIMEOUT, index, shardId, timeout
-
Constructor Summary
Constructors Constructor Description UpdateRequest()
UpdateRequest(java.lang.String index, java.lang.String id)
UpdateRequest(java.lang.String index, java.lang.String type, java.lang.String id)
Deprecated.Types are in the process of being removed.UpdateRequest(StreamInput in)
-
Method Summary
Modifier and Type Method Description UpdateRequest
addScriptParam(java.lang.String name, java.lang.Object value)
Deprecated.Usescript(Script)
insteadUpdateRequest
defaultTypeIfNull(java.lang.String defaultType)
Deprecated.Types are in the process of being removed.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, XContentType xContentType)
Sets the doc to use for updates when a script is not specified.UpdateRequest
doc(byte[] source, XContentType xContentType)
Sets the doc to use for updates when a script is not specified.UpdateRequest
doc(java.lang.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(java.lang.String source, XContentType xContentType)
Sets the doc to use for updates when a script is not specified.UpdateRequest
doc(java.util.Map<java.lang.String,java.lang.Object> source)
Sets the doc to use for updates when a script is not specified.UpdateRequest
doc(java.util.Map<java.lang.String,java.lang.Object> source, 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(XContentBuilder source)
Sets the doc to use for updates when a script is not specified.UpdateRequest
doc(XContentType xContentType, java.lang.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 theFetchSourceContext
which defines how the _source should be fetched.UpdateRequest
fetchSource(boolean fetchSource)
Indicates whether the response should contain the updated _source.UpdateRequest
fetchSource(java.lang.String[] includes, java.lang.String[] excludes)
Indicate that _source should be returned, with an "include" and/or "exclude" set which can include simple wildcard elements.UpdateRequest
fetchSource(java.lang.String include, java.lang.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 requestUpdateRequest
fromXContent(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()
java.lang.String
id()
The id of the indexed document.UpdateRequest
id(java.lang.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.DocWriteRequest.OpType
opType()
Get the requested document operation type of the requestint
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.java.lang.String
routing()
Controls the shard routing of the request.UpdateRequest
routing(java.lang.String routing)
Controls the shard routing of the request.Script
script()
UpdateRequest
script(java.lang.String script)
Deprecated.Usescript(Script)
insteadUpdateRequest
script(java.lang.String script, java.lang.String scriptLang, ScriptType scriptType, java.util.Map<java.lang.String,java.lang.Object> scriptParams)
Deprecated.Usescript(Script)
insteadUpdateRequest
script(java.lang.String script, ScriptType scriptType)
Deprecated.Usescript(Script)
insteadUpdateRequest
script(java.lang.String script, ScriptType scriptType, java.util.Map<java.lang.String,java.lang.Object> scriptParams)
Deprecated.Usescript(Script)
insteadUpdateRequest
script(Script script)
The script to execute.boolean
scriptedUpsert()
UpdateRequest
scriptedUpsert(boolean scriptedUpsert)
java.lang.String
scriptLang()
Deprecated.Usescript()
insteadUpdateRequest
scriptLang(java.lang.String scriptLang)
Deprecated.Usescript(Script)
insteadjava.util.Map<java.lang.String,java.lang.Object>
scriptParams()
Deprecated.Usescript()
insteadUpdateRequest
scriptParams(java.util.Map<java.lang.String,java.lang.Object> scriptParams)
Deprecated.Usescript(Script)
insteadjava.lang.String
scriptString()
Deprecated.Usescript()
insteadScriptType
scriptType()
Deprecated.Usescript()
insteadUpdateRequest
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).java.lang.String
toString()
XContentBuilder
toXContent(XContentBuilder builder, ToXContent.Params params)
java.lang.String
type()
Deprecated.Types are in the process of being removed.UpdateRequest
type(java.lang.String type)
Deprecated.Types are in the process of being removed.UpdateRequest
upsert(byte[] source, int offset, int length, XContentType xContentType)
Sets the doc source of the update request to be used when the document does not exists.UpdateRequest
upsert(byte[] source, XContentType xContentType)
Sets the doc source of the update request to be used when the document does not exists.UpdateRequest
upsert(java.lang.Object... source)
Sets the doc source of the update request to be used when the document does not exists.UpdateRequest
upsert(java.lang.String source, XContentType xContentType)
Sets the doc source of the update request to be used when the document does not exists.UpdateRequest
upsert(java.util.Map<java.lang.String,java.lang.Object> source)
Sets the doc source of the update request to be used when the document does not exists.UpdateRequest
upsert(java.util.Map<java.lang.String,java.lang.Object> source, 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(XContentBuilder source)
Sets the doc source of the update request to be used when the document does not exists.UpdateRequest
upsert(XContentType xContentType, java.lang.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 requestUpdateRequest
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 requestUpdateRequest
versionType(VersionType versionType)
Sets the versioning type.ActiveShardCount
waitForActiveShards()
UpdateRequest
waitForActiveShards(int waitForActiveShards)
A shortcut forwaitForActiveShards(ActiveShardCount)
where the numerical shard count is passed in, instead of having to first callActiveShardCount.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
writeTo(StreamOutput out)
Write this into the StreamOutput.Methods inherited from class org.elasticsearch.action.support.single.instance.InstanceShardOperationRequest
concreteIndex, index, index, indices, indicesOptions, timeout, timeout, timeout
Methods inherited from class org.elasticsearch.transport.TransportRequest
getParentTask, setParentTask
Methods inherited from class org.elasticsearch.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.elasticsearch.action.DocWriteRequest
index, index, indicesOptions
Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest
createTask, getDescription, setParentTask
-
Constructor Details
-
UpdateRequest
public UpdateRequest() -
UpdateRequest
- Throws:
java.io.IOException
-
UpdateRequest
public UpdateRequest(java.lang.String index, java.lang.String id) -
UpdateRequest
@Deprecated public UpdateRequest(java.lang.String index, java.lang.String type, java.lang.String id)Deprecated.Types are in the process of being removed. UseUpdateRequest(String, String)
instead.
-
-
Method Details
-
validate
- Specified by:
validate
in interfaceWriteRequest<UpdateRequest>
- Overrides:
validate
in classInstanceShardOperationRequest<UpdateRequest>
-
type
@Deprecated public java.lang.String type()Deprecated.Types are in the process of being removed.The type of the indexed document.- Specified by:
type
in interfaceDocWriteRequest<UpdateRequest>
- Returns:
- the type
-
type
Deprecated.Types are in the process of being removed.Sets the type of the indexed document.- Specified by:
type
in interfaceDocWriteRequest<UpdateRequest>
- Returns:
- the Request
-
defaultTypeIfNull
Deprecated.Types are in the process of being removed.Set the default type supplied to a bulk request if this individual request's type is null or empty- Specified by:
defaultTypeIfNull
in interfaceDocWriteRequest<UpdateRequest>
- Returns:
- the Request
-
id
public java.lang.String id()The id of the indexed document.- Specified by:
id
in interfaceDocWriteRequest<UpdateRequest>
- Returns:
- the id
-
id
Sets the id of the indexed document. -
routing
Controls the shard routing of the request. Using this value to hash the shard and not the id.- Specified by:
routing
in interfaceDocWriteRequest<UpdateRequest>
- Returns:
- the Request
-
routing
public java.lang.String routing()Controls the shard routing of the request. Using this value to hash the shard and not the id.- Specified by:
routing
in interfaceDocWriteRequest<UpdateRequest>
- Returns:
- the Routing
-
getShardId
-
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 java.lang.String scriptString()Deprecated.Usescript()
instead -
scriptType
Deprecated.Usescript()
instead -
scriptParams
@Deprecated public java.util.Map<java.lang.String,java.lang.Object> scriptParams()Deprecated.Usescript()
instead -
script
Deprecated.Usescript(Script)
insteadThe 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.Usescript(Script)
insteadThe 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.Usescript(Script)
insteadThe language of the script to execute. -
scriptLang
@Deprecated public java.lang.String scriptLang()Deprecated.Usescript()
instead -
addScriptParam
Deprecated.Usescript(Script)
insteadAdd a script parameter. -
scriptParams
@Deprecated public UpdateRequest scriptParams(java.util.Map<java.lang.String,java.lang.Object> scriptParams)Deprecated.Usescript(Script)
insteadSets the script parameters to use with the script. -
script
@Deprecated public UpdateRequest script(java.lang.String script, ScriptType scriptType, @Nullable java.util.Map<java.lang.String,java.lang.Object> scriptParams)Deprecated.Usescript(Script)
insteadThe 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(java.lang.String script, @Nullable java.lang.String scriptLang, ScriptType scriptType, @Nullable java.util.Map<java.lang.String,java.lang.Object> scriptParams)Deprecated.Usescript(Script)
insteadThe 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 executescriptLang
- The script languagescriptType
- The script typescriptParams
- The script parameters
-
fetchSource
public UpdateRequest fetchSource(@Nullable java.lang.String include, @Nullable java.lang.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 _sourceexclude
- An optional exclude (optionally wildcarded) pattern to filter the returned _source
-
fetchSource
public UpdateRequest fetchSource(@Nullable java.lang.String[] includes, @Nullable java.lang.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 _sourceexcludes
- An optional list of exclude (optionally wildcarded) pattern to filter the returned _source
-
fetchSource
Indicates whether the response should contain the updated _source. -
fetchSource
Explicitly set the fetch source context for this request -
fetchSource
Gets theFetchSourceContext
which defines how the _source should be fetched. -
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
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 interfaceDocWriteRequest<UpdateRequest>
-
version
public long version()Description copied from interface:DocWriteRequest
Get the document version for this request- Specified by:
version
in interfaceDocWriteRequest<UpdateRequest>
- Returns:
- the document version
-
versionType
Description copied from interface:DocWriteRequest
Sets the versioning type. Defaults toVersionType.INTERNAL
.- Specified by:
versionType
in interfaceDocWriteRequest<UpdateRequest>
-
versionType
Description copied from interface:DocWriteRequest
Get the document version type for this request- Specified by:
versionType
in interfaceDocWriteRequest<UpdateRequest>
- Returns:
- the document version type
-
setIfSeqNo
only perform this update request if the document's modification was assigned the given sequence number. Must be used in combination withsetIfPrimaryTerm(long)
If the document last modification was assigned a different sequence number aVersionConflictEngineException
will be thrown.- Specified by:
setIfSeqNo
in interfaceDocWriteRequest<UpdateRequest>
-
setIfPrimaryTerm
only performs this update request if the document's last modification was assigned the given primary term. Must be used in combination withsetIfSeqNo(long)
If the document last modification was assigned a different term aVersionConflictEngineException
will be thrown.- Specified by:
setIfPrimaryTerm
in interfaceDocWriteRequest<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 aVersionConflictEngineException
will be thrown.- Specified by:
ifSeqNo
in interfaceDocWriteRequest<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 aVersionConflictEngineException
will be thrown.- Specified by:
ifPrimaryTerm
in interfaceDocWriteRequest<UpdateRequest>
-
opType
Description copied from interface:DocWriteRequest
Get the requested document operation type of the request- Specified by:
opType
in interfaceDocWriteRequest<UpdateRequest>
- Returns:
- the operation type
DocWriteRequest.OpType
-
setRefreshPolicy
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 interfaceWriteRequest<UpdateRequest>
-
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 interfaceWriteRequest<UpdateRequest>
-
waitForActiveShards
-
waitForActiveShards
Sets the number of shard copies that must be active before proceeding with the write. SeeReplicationRequest.waitForActiveShards(ActiveShardCount)
for details. -
waitForActiveShards
A shortcut forwaitForActiveShards(ActiveShardCount)
where the numerical shard count is passed in, instead of having to first callActiveShardCount.from(int)
to get the ActiveShardCount. -
doc
Sets the doc to use for updates when a script is not specified. -
doc
Sets the doc to use for updates when a script is not specified. -
doc
Sets the doc to use for updates when a script is not specified. -
doc
public UpdateRequest doc(java.util.Map<java.lang.String,java.lang.Object> source, XContentType contentType)Sets the doc to use for updates when a script is not specified. -
doc
Sets the doc to use for updates when a script is not specified. -
doc
Sets the doc to use for updates when a script is not specified. -
doc
Sets the doc to use for updates when a script is not specified. -
doc
Sets the doc to use for updates when a script is not specified, the doc provided is a field and value pairs. -
doc
Sets the doc to use for updates when a script is not specified, the doc provided is a field and value pairs. -
doc
-
upsert
Sets the index request to be used if the document does not exists. Otherwise, aDocumentMissingException
is thrown. -
upsert
Sets the doc source of the update request to be used when the document does not exists. -
upsert
Sets the doc source of the update request to be used when the document does not exists. -
upsert
public UpdateRequest upsert(java.util.Map<java.lang.String,java.lang.Object> source, XContentType contentType)Sets the doc source of the update request to be used when the document does not exists. -
upsert
Sets the doc source of the update request to be used when the document does not exists. -
upsert
Sets the doc source of the update request to be used when the document does not exists. -
upsert
Sets the doc source of the update request to be used when the document does not exists. -
upsert
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
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
-
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
- Throws:
java.io.IOException
-
docAsUpsert
public boolean docAsUpsert() -
docAsUpsert
-
scriptedUpsert
public boolean scriptedUpsert() -
scriptedUpsert
-
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput.- Specified by:
writeTo
in interfaceWriteable
- Overrides:
writeTo
in classInstanceShardOperationRequest<UpdateRequest>
- Throws:
java.io.IOException
-
toXContent
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException- Specified by:
toXContent
in interfaceToXContent
- Throws:
java.io.IOException
-
toString
public java.lang.String toString()- Overrides:
toString
in classjava.lang.Object
-