org.elasticsearch.action.update

Class UpdateRequest

java.lang.Object

org.elasticsearch.common.ContextAndHeaderHolder

org.elasticsearch.transport.TransportMessage<TransportRequest>

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest<T>

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

org.elasticsearch.action.update.UpdateRequest

All Implemented Interfaces:

DocumentRequest<UpdateRequest>, IndicesRequest, HasContext, HasContextAndHeaders, HasHeaders, Streamable

public class UpdateRequest
extends InstanceShardOperationRequest<UpdateRequest>
implements DocumentRequest<UpdateRequest>

Nested Class Summary

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

TransportRequest.Empty

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

IndicesRequest.Replaceable

Field Summary

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

DEFAULT_TIMEOUT, index, shardId, timeout

Fields inherited from class org.elasticsearch.common.ContextAndHeaderHolder

headers

Constructor Summary

Constructors

Constructor and Description
UpdateRequest()
UpdateRequest(String index, String type, String id)

Method Summary

Methods

Modifier and Type	Method and Description
UpdateRequest	addScriptParam(String name, Object value) Deprecated. Use script(Script) instead
WriteConsistencyLevel	consistencyLevel()
UpdateRequest	consistencyLevel(WriteConsistencyLevel consistencyLevel) Sets the consistency level of write.
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) Sets the doc to use for updates when a script is not specified.
UpdateRequest	doc(byte[] source, int offset, int length) 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(Map source) Sets the doc to use for updates when a script is not specified.
UpdateRequest	doc(Map source, XContentType contentType) 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) Sets the doc to use for updates when a script is not specified.
UpdateRequest	doc(String field, Object value) 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.
boolean	docAsUpsert()
UpdateRequest	docAsUpsert(boolean shouldUpsertDoc)
String[]	fields() Get the fields to be returned.
UpdateRequest	fields(String... fields) Explicitly specify the fields that will be returned.
String	id() The id of the indexed document.
UpdateRequest	id(String id) Sets the id of the indexed document.
String	parent()
UpdateRequest	parent(String parent) The parent id is used for the upsert request and also implicitely sets the routing if not already set.
void	readFrom(StreamInput in)
boolean	refresh()
UpdateRequest	refresh(boolean refresh) Should a refresh be executed post this update operation causing the operation to be searchable.
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(Script script) The script to execute.
UpdateRequest	script(String script) Deprecated. Use script(Script) instead
UpdateRequest	script(String script, ScriptService.ScriptType scriptType) Deprecated. Use script(Script) instead
UpdateRequest	script(String script, ScriptService.ScriptType scriptType, Map<String,Object> scriptParams) Deprecated. Use script(Script) instead
UpdateRequest	script(String script, String scriptLang, ScriptService.ScriptType scriptType, Map<String,Object> scriptParams) Deprecated. Use script(Script) instead
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
ScriptService.ScriptType	scriptType() Deprecated. Use script() instead
UpdateRequest	source(byte[] source)
UpdateRequest	source(byte[] source, int offset, int length)
UpdateRequest	source(BytesReference source)
UpdateRequest	source(XContentBuilder source)
String	type() The type of the indexed document.
UpdateRequest	type(String type) Sets the type of the indexed document.
UpdateRequest	upsert(byte[] source) Sets the doc source of the update request to be used when the document does not exists.
UpdateRequest	upsert(byte[] source, int offset, int length) 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(Map source) Sets the doc source of the update request to be used when the document does not exists.
UpdateRequest	upsert(Map source, XContentType contentType) 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) Sets the doc source of the update request to be used when 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.
IndexRequest	upsertRequest()
ActionRequestValidationException	validate()
long	version()
UpdateRequest	version(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.
VersionType	versionType()
UpdateRequest	versionType(VersionType versionType) Sets the versioning type.
void	writeTo(StreamOutput out)

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

createTask, getDescription

Methods inherited from class org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class org.elasticsearch.common.ContextAndHeaderHolder

contextSize, copyContextAndHeadersFrom, copyContextFrom, copyHeadersFrom, getContext, getFromContext, getFromContext, getHeader, getHeaders, hasHeader, hasInContext, isContextEmpty, putAllInContext, putHeader, putInContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.action.DocumentRequest

index, indicesOptions

Methods inherited from interface org.elasticsearch.action.IndicesRequest

indices

Constructor Detail

UpdateRequest

public UpdateRequest()

UpdateRequest

public UpdateRequest(String index,
             String type,
             String id)

Method Detail

validate

public ActionRequestValidationException validate()

Overrides:

validate in class InstanceShardOperationRequest<UpdateRequest>

type

public String type()

The type of the indexed document.

Specified by:

type in interface DocumentRequest<UpdateRequest>

Returns:

the type

type

public UpdateRequest type(String type)

Sets the type of the indexed document.

id

public String id()

The id of the indexed document.

Specified by:

id in interface DocumentRequest<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 DocumentRequest<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 DocumentRequest<UpdateRequest>

Returns:

the Routing

parent

public UpdateRequest parent(String parent)

The parent id is used for the upsert request and also implicitely sets the routing if not already set.

parent

public String parent()

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 ScriptService.ScriptType scriptType()

Deprecated. Use script() instead

scriptParams

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

Deprecated. Use script() instead

script

@Deprecated
public UpdateRequest script(String script,
                              ScriptService.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,
                              ScriptService.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,
                              ScriptService.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

fields

public UpdateRequest fields(String... fields)

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

fields

public String[] fields()

Get the fields to be returned.

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)

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.

version

public long version()

versionType

public UpdateRequest versionType(VersionType versionType)

Sets the versioning type. Defaults to VersionType.INTERNAL.

versionType

public VersionType versionType()

refresh

public UpdateRequest refresh(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.

refresh

public boolean refresh()

consistencyLevel

public WriteConsistencyLevel consistencyLevel()

consistencyLevel

public UpdateRequest consistencyLevel(WriteConsistencyLevel consistencyLevel)

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

doc

public UpdateRequest doc(IndexRequest doc)

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

doc

public UpdateRequest doc(XContentBuilder source)

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

doc

public UpdateRequest doc(Map source)

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

doc

public UpdateRequest doc(Map source,
                XContentType contentType)

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

doc

public UpdateRequest doc(String source)

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

doc

public UpdateRequest doc(byte[] source)

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

doc

public UpdateRequest doc(byte[] source,
                int offset,
                int length)

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(String field,
                Object value)

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

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

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

upsert

public UpdateRequest upsert(Map source)

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

upsert

public UpdateRequest upsert(Map source,
                   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)

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

upsert

public UpdateRequest upsert(byte[] source)

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)

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.

upsertRequest

public IndexRequest upsertRequest()

source

public UpdateRequest source(XContentBuilder source)
                     throws Exception

Throws:

Exception

source

public UpdateRequest source(byte[] source)
                     throws Exception

Throws:

Exception

source

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

Throws:

Exception

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.

source

public UpdateRequest source(BytesReference source)
                     throws Exception

Throws:

Exception

docAsUpsert

public boolean docAsUpsert()

docAsUpsert

public UpdateRequest docAsUpsert(boolean shouldUpsertDoc)

scriptedUpsert

public boolean scriptedUpsert()

scriptedUpsert

public UpdateRequest scriptedUpsert(boolean scriptedUpsert)

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class InstanceShardOperationRequest<UpdateRequest>

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Overrides:

writeTo in class InstanceShardOperationRequest<UpdateRequest>

Throws:

IOException