org.elasticsearch.action.update

Class UpdateRequestBuilder

java.lang.Object

org.elasticsearch.action.ActionRequestBuilder<Request,Response,RequestBuilder>

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

org.elasticsearch.action.update.UpdateRequestBuilder

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

Field Summary

Fields inherited from class org.elasticsearch.action.ActionRequestBuilder

action, client, request

Constructor Summary

Constructors

Constructor and Description
UpdateRequestBuilder(ElasticsearchClient client, UpdateAction action)
UpdateRequestBuilder(ElasticsearchClient client, UpdateAction action, String index, String type, String id)

Method Summary

Methods

Modifier and Type	Method and Description
UpdateRequestBuilder	setConsistencyLevel(WriteConsistencyLevel consistencyLevel) Sets the consistency level of write.
UpdateRequestBuilder	setDetectNoop(boolean detectNoop) Sets whether to perform extra effort to detect noop updates via docAsUpsert.
UpdateRequestBuilder	setDoc(byte[] source) Sets the doc to use for updates when a script is not specified.
UpdateRequestBuilder	setDoc(byte[] source, int offset, int length) 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(Map source) Sets the doc to use for updates when a script is not specified.
UpdateRequestBuilder	setDoc(Map source, XContentType contentType) 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) Sets the doc to use for updates when a script is not specified.
UpdateRequestBuilder	setDoc(String field, Object value) 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	setDocAsUpsert(boolean shouldUpsertDoc) Sets whether the specified doc parameter should be used as upsert document.
UpdateRequestBuilder	setFields(String... fields) Explicitly specify the fields that will be returned.
UpdateRequestBuilder	setId(String id) Sets the id of the indexed document.
UpdateRequestBuilder	setParent(String parent)
UpdateRequestBuilder	setRefresh(boolean refresh) Should a refresh be executed post this update operation causing the operation to be searchable.
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	setSource(byte[] source)
UpdateRequestBuilder	setSource(byte[] source, int offset, int length)
UpdateRequestBuilder	setSource(BytesReference source)
UpdateRequestBuilder	setSource(XContentBuilder source)
UpdateRequestBuilder	setTtl(Long ttl) Set the new ttl of the document as a long.
UpdateRequestBuilder	setTtl(String ttl) Set the new ttl of the document as a time value expression.
UpdateRequestBuilder	setTtl(TimeValue ttl) Set the new ttl of the document as a TimeValue instance.
UpdateRequestBuilder	setType(String type) Sets the type of the indexed document.
UpdateRequestBuilder	setUpsert(byte[] source) Sets the doc source of the update request to be used when the document does not exists.
UpdateRequestBuilder	setUpsert(byte[] source, int offset, int length) 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(Map source) Sets the doc source of the update request to be used when the document does not exists.
UpdateRequestBuilder	setUpsert(Map source, XContentType contentType) 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) Sets the doc source of the update request to be used when 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	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.

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

setIndex, setTimeout, setTimeout

Methods inherited from class org.elasticsearch.action.ActionRequestBuilder

beforeExecute, execute, execute, get, get, get, putHeader, request

Methods inherited from class java.lang.Object

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

Constructor Detail

UpdateRequestBuilder

public UpdateRequestBuilder(ElasticsearchClient client,
                    UpdateAction action)

UpdateRequestBuilder

public UpdateRequestBuilder(ElasticsearchClient client,
                    UpdateAction action,
                    String index,
                    String type,
                    String id)

Method Detail

setType

public UpdateRequestBuilder setType(String type)

Sets the type of the indexed document.

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.

setParent

public UpdateRequestBuilder setParent(String parent)

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.

setFields

public UpdateRequestBuilder setFields(String... fields)

Explicitly specify the fields that will be returned. By default, nothing is returned.

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.

setRefresh

public UpdateRequestBuilder setRefresh(boolean refresh)

Should a refresh be executed post this update operation causing the operation to be searchable. Note, heavy indexing should not set this to true. Defaults to false.

setConsistencyLevel

public UpdateRequestBuilder setConsistencyLevel(WriteConsistencyLevel consistencyLevel)

Sets the consistency level of write. Defaults to WriteConsistencyLevel.DEFAULT

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 source)

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

setDoc

public UpdateRequestBuilder setDoc(Map source,
                          XContentType contentType)

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

setDoc

public UpdateRequestBuilder setDoc(String source)

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

setDoc

public UpdateRequestBuilder setDoc(byte[] source)

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

setDoc

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

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

setDoc

public UpdateRequestBuilder setDoc(String field,
                          Object value)

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.

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 source)

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

setUpsert

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

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

setUpsert

public UpdateRequestBuilder setUpsert(byte[] source)

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)

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.

setSource

public UpdateRequestBuilder setSource(XContentBuilder source)
                               throws Exception

Throws:

Exception

setSource

public UpdateRequestBuilder setSource(byte[] source)
                               throws Exception

Throws:

Exception

setSource

public UpdateRequestBuilder setSource(byte[] source,
                             int offset,
                             int length)
                               throws Exception

Throws:

Exception

setSource

public UpdateRequestBuilder setSource(BytesReference source)
                               throws Exception

Throws:

Exception

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. Defautls to true.

setScriptedUpsert

public UpdateRequestBuilder setScriptedUpsert(boolean scriptedUpsert)

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

setTtl

public UpdateRequestBuilder setTtl(Long ttl)

Set the new ttl of the document as a long. Note that if detectNoop is true (the default) and the source of the document isn't changed then the ttl update won't take effect.

setTtl

public UpdateRequestBuilder setTtl(String ttl)

Set the new ttl of the document as a time value expression. Note that if detectNoop is true (the default) and the source of the document isn't changed then the ttl update won't take effect.

setTtl

public UpdateRequestBuilder setTtl(TimeValue ttl)

Set the new ttl of the document as a TimeValue instance. Note that if detectNoop is true (the default) and the source of the document isn't changed then the ttl update won't take effect.