Module org.elasticsearch.server

Package org.elasticsearch.action.update

Class UpdateRequestBuilder

java.lang.Object

org.elasticsearch.action.ActionRequestLazyBuilder<Request,Response>

org.elasticsearch.action.support.single.instance.InstanceShardOperationRequestBuilder<UpdateRequest,UpdateResponse,UpdateRequestBuilder>

org.elasticsearch.action.update.UpdateRequestBuilder

All Implemented Interfaces:

RequestBuilder<UpdateRequest,UpdateResponse>, WriteRequestBuilder<UpdateRequestBuilder>

public class UpdateRequestBuilder
extends InstanceShardOperationRequestBuilder<UpdateRequest,UpdateResponse,UpdateRequestBuilder>
implements WriteRequestBuilder<UpdateRequestBuilder>

Field Summary

Fields inherited from class org.elasticsearch.action.ActionRequestLazyBuilder

action, client

Constructor Summary

Constructors

Constructor	Description
UpdateRequestBuilder(ElasticsearchClient client)
UpdateRequestBuilder(ElasticsearchClient client, String index, String id)

Method Summary

Modifier and Type	Method	Description
UpdateRequest	request()	This method creates the request.
UpdateRequestBuilder	setDetectNoop(boolean detectNoop)	Sets whether to perform extra effort to detect noop updates via docAsUpsert.
UpdateRequestBuilder	setDoc(byte[] source, int offset, int length, XContentType xContentType)	Sets the doc to use for updates when a script is not specified.
UpdateRequestBuilder	setDoc(byte[] source, XContentType xContentType)	Sets the doc to use for updates when a script is not specified.
UpdateRequestBuilder	setDoc(Object... source)	Sets the doc to use for updates when a script is not specified, the doc provided is a field and value pairs.
UpdateRequestBuilder	setDoc(String source, XContentType xContentType)	Sets the doc to use for updates when a script is not specified.
UpdateRequestBuilder	setDoc(Map<String,Object> source)	Sets the doc to use for updates when a script is not specified.
UpdateRequestBuilder	setDoc(Map<String,Object> source, XContentType contentType)	Sets the doc to use for updates when a script is not specified.
UpdateRequestBuilder	setDoc(IndexRequest indexRequest)	Sets the doc to use for updates when a script is not specified.
UpdateRequestBuilder	setDoc(XContentBuilder source)	Sets the doc to use for updates when a script is not specified.
UpdateRequestBuilder	setDoc(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.
UpdateRequestBuilder	setDocAsUpsert(boolean shouldUpsertDoc)	Sets whether the specified doc parameter should be used as upsert document.
UpdateRequestBuilder	setFetchSource(boolean fetchSource)	Indicates whether the response should contain the updated _source.
UpdateRequestBuilder	setFetchSource(String[] includes, String[] excludes)	Indicate that _source should be returned, with an "include" and/or "exclude" set which can include simple wildcard elements.
UpdateRequestBuilder	setFetchSource(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.
UpdateRequestBuilder	setId(String id)	Sets the id of the indexed document.
UpdateRequestBuilder	setIfPrimaryTerm(long term)	only perform this update request if the document was last modification was assigned the given primary term.
UpdateRequestBuilder	setIfSeqNo(long seqNo)	only perform this update request if the document was last modification was assigned the given sequence number.
UpdateRequestBuilder	setRefreshPolicy(String refreshPolicy)	Parse the refresh policy from a string, only modifying it if the string is non null.
UpdateRequestBuilder	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).
UpdateRequestBuilder	setRequireAlias(boolean requireAlias)	Sets the require_alias flag
UpdateRequestBuilder	setRetryOnConflict(int retryOnConflict)	Sets the number of retries of a version conflict occurs because the document was updated between getting it and updating it.
UpdateRequestBuilder	setRouting(String routing)	Controls the shard routing of the request.
UpdateRequestBuilder	setScript(Script script)	The script to execute.
UpdateRequestBuilder	setScriptedUpsert(boolean scriptedUpsert)	Sets whether the script should be run in the case of an insert
UpdateRequestBuilder	setUpsert(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.
UpdateRequestBuilder	setUpsert(byte[] source, XContentType xContentType)	Sets the doc source of the update request to be used when the document does not exists.
UpdateRequestBuilder	setUpsert(Object... source)	Sets the doc source of the update request to be used when the document does not exists.
UpdateRequestBuilder	setUpsert(String source, XContentType xContentType)	Sets the doc source of the update request to be used when the document does not exists.
UpdateRequestBuilder	setUpsert(Map<String,Object> source)	Sets the doc source of the update request to be used when the document does not exists.
UpdateRequestBuilder	setUpsert(Map<String,Object> source, XContentType contentType)	Sets the doc source of the update request to be used when the document does not exists.
UpdateRequestBuilder	setUpsert(IndexRequest indexRequest)	Sets the index request to be used if the document does not exists.
UpdateRequestBuilder	setUpsert(XContentBuilder source)	Sets the doc source of the update request to be used when the document does not exists.
UpdateRequestBuilder	setUpsert(XContentType xContentType, Object... source)	Sets the doc source of the update request to be used when the document does not exists.
UpdateRequestBuilder	setVersion(long version)	Sets the version, which will cause the index operation to only be performed if a matching version exists and no changes happened on the doc since then.
UpdateRequestBuilder	setVersionType(VersionType versionType)	Sets the versioning type.
UpdateRequestBuilder	setWaitForActiveShards(int waitForActiveShards)	A shortcut for setWaitForActiveShards(ActiveShardCount) where the numerical shard count is passed in, instead of having to first call ActiveShardCount.from(int) to get the ActiveShardCount.
UpdateRequestBuilder	setWaitForActiveShards(ActiveShardCount waitForActiveShards)	Sets the number of shard copies that must be active before proceeding with the write.
protected void	validate()

Methods inherited from class org.elasticsearch.action.support.single.instance.InstanceShardOperationRequestBuilder

apply, getIndex, setIndex, setTimeout, setTimeout

Methods inherited from class org.elasticsearch.action.ActionRequestLazyBuilder

execute, execute, get, get

Methods inherited from class java.lang.Object

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

Constructor Details

UpdateRequestBuilder

public UpdateRequestBuilder(ElasticsearchClient client)

UpdateRequestBuilder

public UpdateRequestBuilder(ElasticsearchClient client,
 String index,
 String id)

Method Details

setId

public UpdateRequestBuilder setId(String id)

Sets the id of the indexed document.

setRouting

public UpdateRequestBuilder setRouting(String routing)

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

setScript

public UpdateRequestBuilder setScript(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.

The script works with the variable ctx, which is bound to the entry, e.g. ctx._source.mycounter += 1.

setFetchSource

public UpdateRequestBuilder setFetchSource(@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

setFetchSource

public UpdateRequestBuilder setFetchSource(@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

setFetchSource

public UpdateRequestBuilder setFetchSource(boolean fetchSource)

Indicates whether the response should contain the updated _source.

setRetryOnConflict

public UpdateRequestBuilder setRetryOnConflict(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.

setVersion

public UpdateRequestBuilder setVersion(long version)

Sets the version, which will cause the index operation to only be performed if a matching version exists and no changes happened on the doc since then.

setVersionType

public UpdateRequestBuilder setVersionType(VersionType versionType)

Sets the versioning type. Defaults to VersionType.INTERNAL.

setIfSeqNo

public UpdateRequestBuilder setIfSeqNo(long seqNo)

only perform this update request if the document was last 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.

setIfPrimaryTerm

public UpdateRequestBuilder setIfPrimaryTerm(long term)

only perform this update request if the document was 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.

setWaitForActiveShards

public UpdateRequestBuilder setWaitForActiveShards(ActiveShardCount waitForActiveShards)

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

setWaitForActiveShards

public UpdateRequestBuilder setWaitForActiveShards(int waitForActiveShards)

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

setDoc

public UpdateRequestBuilder setDoc(IndexRequest indexRequest)

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

setDoc

public UpdateRequestBuilder setDoc(XContentBuilder source)

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

setDoc

public UpdateRequestBuilder setDoc(Map<String,Object> source)

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

setDoc

public UpdateRequestBuilder setDoc(Map<String,Object> source,
 XContentType contentType)

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

setDoc

public UpdateRequestBuilder setDoc(String source,
 XContentType xContentType)

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

setDoc

public UpdateRequestBuilder setDoc(byte[] source,
 XContentType xContentType)

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

setDoc

public UpdateRequestBuilder setDoc(byte[] source,
 int offset,
 int length,
 XContentType xContentType)

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

setDoc

public UpdateRequestBuilder setDoc(Object... source)

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

setDoc

public UpdateRequestBuilder setDoc(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.

setUpsert

public UpdateRequestBuilder setUpsert(IndexRequest indexRequest)

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

setUpsert

public UpdateRequestBuilder setUpsert(XContentBuilder source)

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

setUpsert

public UpdateRequestBuilder setUpsert(Map<String,Object> source)

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

setUpsert

public UpdateRequestBuilder setUpsert(Map<String,Object> source,
 XContentType contentType)

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

setUpsert

public UpdateRequestBuilder setUpsert(String source,
 XContentType xContentType)

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

setUpsert

public UpdateRequestBuilder setUpsert(byte[] source,
 XContentType xContentType)

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

setUpsert

public UpdateRequestBuilder setUpsert(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.

setUpsert

public UpdateRequestBuilder setUpsert(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.

setUpsert

public UpdateRequestBuilder setUpsert(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.

setDocAsUpsert

public UpdateRequestBuilder setDocAsUpsert(boolean shouldUpsertDoc)

Sets whether the specified doc parameter should be used as upsert document.

setDetectNoop

public UpdateRequestBuilder setDetectNoop(boolean detectNoop)

Sets whether to perform extra effort to detect noop updates via docAsUpsert. Defaults to true.

setScriptedUpsert

public UpdateRequestBuilder setScriptedUpsert(boolean scriptedUpsert)

Sets whether the script should be run in the case of an insert

setRequireAlias

public UpdateRequestBuilder setRequireAlias(boolean requireAlias)

Sets the require_alias flag

setRefreshPolicy

public UpdateRequestBuilder setRefreshPolicy(WriteRequest.RefreshPolicy refreshPolicy)

Description copied from interface: WriteRequestBuilder

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 WriteRequestBuilder<UpdateRequestBuilder>

setRefreshPolicy

public UpdateRequestBuilder setRefreshPolicy(String refreshPolicy)

Description copied from interface: WriteRequestBuilder

Parse the refresh policy from a string, only modifying it if the string is non null. Convenient to use with request parsing.

Specified by:

setRefreshPolicy in interface WriteRequestBuilder<UpdateRequestBuilder>

request

public UpdateRequest request()

Description copied from class: ActionRequestLazyBuilder

This method creates the request. The caller of this method is responsible for calling Request#decRef.

Specified by:

request in interface RequestBuilder<UpdateRequest,UpdateResponse>

Specified by:

request in interface WriteRequestBuilder<UpdateRequestBuilder>

Specified by:

request in class ActionRequestLazyBuilder<UpdateRequest,UpdateResponse>

Returns:

A newly-built Request, fully initialized by this builder.

validate

protected void validate()
                 throws IllegalStateException

Throws:

IllegalStateException