- All Implemented Interfaces:
org.apache.lucene.util.Accountable,DocWriteRequest<UpdateRequest>,IndicesRequest,WriteRequest<UpdateRequest>,Writeable,RefCounted,TaskAwareRequest,TransportRequest,ToXContent,ToXContentObject
public class UpdateRequest
extends InstanceShardOperationRequest<UpdateRequest>
implements DocWriteRequest<UpdateRequest>, WriteRequest<UpdateRequest>, ToXContentObject
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.elasticsearch.action.DocWriteRequest
DocWriteRequest.OpTypeNested classes/interfaces inherited from interface org.elasticsearch.action.IndicesRequest
IndicesRequest.RemoteClusterShardRequest, IndicesRequest.Replaceable, IndicesRequest.SingleIndexNoWildcardsNested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.ParamsNested 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, timeoutFields inherited from interface org.apache.lucene.util.Accountable
NULL_ACCOUNTABLEFields inherited from interface org.elasticsearch.action.DocWriteRequest
LIST_EXECUTED_PIPELINES, REQUIRE_ALIAS, REQUIRE_DATA_STREAMFields inherited from interface org.elasticsearch.core.RefCounted
ALWAYS_REFERENCEDFields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY, EMPTY_PARAMS -
Constructor Summary
ConstructorsConstructorDescriptionUpdateRequest(String index, String id) UpdateRequest(ShardId shardId, StreamInput in) -
Method Summary
Modifier and TypeMethodDescriptionbooleanShould this update attempt to detect if it is a noop? Defaults to true.detectNoop(boolean detectNoop) Should this update attempt to detect if it is a noop? Defaults to true.doc()doc(byte[] source, int offset, int length, XContentType xContentType) Sets the doc to use for updates when a script is not specified.doc(byte[] source, XContentType xContentType) Sets the doc to use for updates when a script is not specified.Sets the doc to use for updates when a script is not specified, the doc provided is a field and value pairs.doc(String source, XContentType xContentType) Sets the doc to use for updates when a script is not specified.Sets the doc to use for updates when a script is not specified.doc(Map<String, Object> source, XContentType contentType) Sets the doc to use for updates when a script is not specified.doc(IndexRequest doc) Sets the doc to use for updates when a script is not specified.doc(BytesReference source, XContentType contentType) Sets the doc to use for updates when a script is not specified.doc(XContentBuilder source) Sets the doc to use for updates when a script is not specified.doc(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.booleandocAsUpsert(boolean shouldUpsertDoc) Gets theFetchSourceContextwhich defines how the _source should be fetched.fetchSource(boolean fetchSource) Indicates whether the response should contain the updated _source.fetchSource(String[] includes, String[] excludes) Indicate that _source should be returned, with an "include" and/or "exclude" set which can include simple wildcard elements.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.fetchSource(FetchSourceContext context) Explicitly set the fetch source context for this requestfromXContent(XContentParser parser) 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).id()The id of the indexed document.Sets the id of the indexed document.longIf set, only perform this update request if the document was last modification was assigned this primary term.longifSeqNo()If set, only perform this update request if the document was last modification was assigned this sequence number.booleanShould this request override specifically require the destination to be an alias?booleanShould this request override specifically require the destination to be a data stream?opType()Get the requested document operation type of the requestlongintretryOnConflict(int retryOnConflict) Sets the number of retries of a version conflict occurs because the document was updated between getting it and updating it.introute(IndexRouting indexRouting) Pick the appropriate shard id to receive this request.routing()Controls the shard routing of the request.Controls the shard routing of the request.script()The script to execute.booleanscriptedUpsert(boolean scriptedUpsert) setIfPrimaryTerm(long term) only performs this update request if the document's last modification was assigned the given primary term.setIfSeqNo(long seqNo) only perform this update request if the document's modification was assigned the given sequence number.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).setRequireAlias(boolean requireAlias) toString()toXContent(XContentBuilder builder, ToXContent.Params params) 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.upsert(byte[] source, XContentType xContentType) Sets the doc source of the update request to be used when the document does not exists.Sets the doc source of the update request to be used when the document does not exists.upsert(String source, XContentType xContentType) Sets the doc source of the update request to be used when the document does not exists.Sets the doc source of the update request to be used when the document does not exists.upsert(Map<String, Object> source, XContentType contentType) Sets the doc source of the update request to be used when the document does not exists.upsert(IndexRequest upsertRequest) Sets the index request to be used if the document does not exists.upsert(BytesReference source, XContentType contentType) Sets the doc source of the update request to be used when the document does not exists.upsert(XContentBuilder source) Sets the doc source of the update request to be used when the document does not exists.upsert(XContentType xContentType, Object... source) Sets the doc source of the update request to be used when the document does not exists.validate()longversion()Get the document version for this requestversion(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.Get the document version type for this requestversionType(VersionType versionType) Sets the versioning type.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.waitForActiveShards(ActiveShardCount waitForActiveShards) Sets the number of shard copies that must be active before proceeding with the write.voidwriteThin(StreamOutput out) voidwriteTo(StreamOutput out) Write this into the StreamOutput.Methods inherited from class org.elasticsearch.action.support.single.instance.InstanceShardOperationRequest
concreteIndex, index, index, indices, indicesOptions, timeout, timeoutMethods inherited from class org.elasticsearch.action.ActionRequest
getShouldStoreResultMethods inherited from class org.elasticsearch.transport.AbstractTransportRequest
getParentTask, getRequestId, remoteAddress, remoteAddress, setParentTask, setRequestIdMethods inherited from class org.elasticsearch.transport.TransportMessage
decRef, hasReferences, incRef, tryIncRefMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface org.apache.lucene.util.Accountable
getChildResourcesMethods inherited from interface org.elasticsearch.action.DocWriteRequest
getConcreteWriteIndex, index, index, indicesOptions, postRoutingProcess, preRoutingProcessMethods inherited from interface org.elasticsearch.action.IndicesRequest
includeDataStreams, indicesMethods inherited from interface org.elasticsearch.core.RefCounted
decRef, hasReferences, incRef, mustIncRef, tryIncRefMethods inherited from interface org.elasticsearch.tasks.TaskAwareRequest
createTask, createTask, getDescription, setParentTaskMethods inherited from interface org.elasticsearch.xcontent.ToXContentObject
isFragmentMethods inherited from interface org.elasticsearch.action.support.WriteRequest
setRefreshPolicy
-
Constructor Details
-
UpdateRequest
public UpdateRequest() -
UpdateRequest
- Throws:
IOException
-
UpdateRequest
- Throws:
IOException
-
UpdateRequest
-
-
Method Details
-
validate
- Specified by:
validatein interfaceWriteRequest<UpdateRequest>- Overrides:
validatein classInstanceShardOperationRequest<UpdateRequest>
-
id
The id of the indexed document.- Specified by:
idin 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:
routingin interfaceDocWriteRequest<UpdateRequest>- Returns:
- the Request
-
routing
Controls the shard routing of the request. Using this value to hash the shard and not the id.- Specified by:
routingin 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. -
fetchSource
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
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 theFetchSourceContextwhich 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:DocWriteRequestSets the version, which will perform the operation only if a matching version exists and no changes happened on the doc since then.- Specified by:
versionin interfaceDocWriteRequest<UpdateRequest>
-
version
public long version()Description copied from interface:DocWriteRequestGet the document version for this request- Specified by:
versionin interfaceDocWriteRequest<UpdateRequest>- Returns:
- the document version
-
versionType
Description copied from interface:DocWriteRequestSets the versioning type. Defaults toVersionType.INTERNAL.- Specified by:
versionTypein interfaceDocWriteRequest<UpdateRequest>
-
versionType
Description copied from interface:DocWriteRequestGet the document version type for this request- Specified by:
versionTypein 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 aVersionConflictEngineExceptionwill be thrown.- Specified by:
setIfSeqNoin 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 aVersionConflictEngineExceptionwill be thrown.- Specified by:
setIfPrimaryTermin 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 aVersionConflictEngineExceptionwill be thrown.- Specified by:
ifSeqNoin 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 aVersionConflictEngineExceptionwill be thrown.- Specified by:
ifPrimaryTermin interfaceDocWriteRequest<UpdateRequest>
-
opType
Description copied from interface:DocWriteRequestGet the requested document operation type of the request- Specified by:
opTypein interfaceDocWriteRequest<UpdateRequest>- Returns:
- the operation type
DocWriteRequest.OpType
-
setRefreshPolicy
Description copied from interface:WriteRequestShould 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:
setRefreshPolicyin interfaceWriteRequest<UpdateRequest>
-
getRefreshPolicy
Description copied from interface:WriteRequestShould 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:
getRefreshPolicyin 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
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 is provided in a bytes form. -
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 doc source of the update request to be used when the document does not exists. -
upsert
Sets the index request to be used if the document does not exists. Otherwise, aDocumentMissingExceptionis 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
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:
IOException
-
docAsUpsert
public boolean docAsUpsert() -
docAsUpsert
-
scriptedUpsert
public boolean scriptedUpsert() -
scriptedUpsert
-
isRequireAlias
public boolean isRequireAlias()Description copied from interface:DocWriteRequestShould this request override specifically require the destination to be an alias?- Specified by:
isRequireAliasin interfaceDocWriteRequest<UpdateRequest>- Returns:
- boolean flag, when true specifically requires an alias
-
isRequireDataStream
public boolean isRequireDataStream()Description copied from interface:DocWriteRequestShould this request override specifically require the destination to be a data stream?- Specified by:
isRequireDataStreamin interfaceDocWriteRequest<UpdateRequest>- Returns:
- boolean flag, when true specifically requires a data stream
-
route
Description copied from interface:DocWriteRequestPick the appropriate shard id to receive this request.- Specified by:
routein interfaceDocWriteRequest<UpdateRequest>
-
setRequireAlias
-
writeTo
Description copied from interface:WriteableWrite this into the StreamOutput.- Specified by:
writeToin interfaceWriteable- Overrides:
writeToin classInstanceShardOperationRequest<UpdateRequest>- Throws:
IOException
-
writeThin
- Overrides:
writeThinin classInstanceShardOperationRequest<UpdateRequest>- Throws:
IOException
-
toXContent
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws IOException - Specified by:
toXContentin interfaceToXContent- Throws:
IOException
-
toString
- Overrides:
toStringin classAbstractTransportRequest
-
ramBytesUsed
public long ramBytesUsed()- Specified by:
ramBytesUsedin interfaceorg.apache.lucene.util.Accountable
-