org.elasticsearch.index.reindex

Class UpdateByQueryRequest

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest

org.elasticsearch.action.bulk.byscroll.AbstractBulkByScrollRequest<Self>

org.elasticsearch.index.reindex.AbstractBulkIndexByScrollRequest<UpdateByQueryRequest>

org.elasticsearch.index.reindex.UpdateByQueryRequest

All Implemented Interfaces:

org.elasticsearch.action.IndicesRequest, org.elasticsearch.action.IndicesRequest.Replaceable, org.elasticsearch.common.io.stream.Streamable, org.elasticsearch.tasks.TaskAwareRequest

public class UpdateByQueryRequest
extends AbstractBulkIndexByScrollRequest<UpdateByQueryRequest>
implements org.elasticsearch.action.IndicesRequest.Replaceable

Request to update some documents. That means you can't change their type, id, index, or anything like that. This implements CompositeIndicesRequest but in a misleading way. Rather than returning all the subrequests that it will make it tries to return a representative set of subrequests. This is best-effort but better than ReindexRequest because scripts can't change the destination index and things.

Nested Class Summary

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

org.elasticsearch.transport.TransportRequest.Empty

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

org.elasticsearch.action.IndicesRequest.Replaceable

Field Summary

Fields inherited from class org.elasticsearch.action.bulk.byscroll.AbstractBulkByScrollRequest

SIZE_ALL_MATCHES

Constructor Summary

Constructors

Constructor and Description
UpdateByQueryRequest()
UpdateByQueryRequest(org.elasticsearch.action.search.SearchRequest search)

Method Summary

Modifier and Type	Method and Description
protected UpdateByQueryRequest	forSlice(org.elasticsearch.tasks.TaskId slicingTask, org.elasticsearch.action.search.SearchRequest slice)
java.lang.String	getPipeline() Ingest pipeline to set on index requests made by this action.
java.lang.String[]	indices()
org.elasticsearch.action.IndicesRequest	indices(java.lang.String... indices)
org.elasticsearch.action.support.IndicesOptions	indicesOptions()
void	readFrom(org.elasticsearch.common.io.stream.StreamInput in)
protected UpdateByQueryRequest	self()
void	setPipeline(java.lang.String pipeline) Set the ingest pipeline to set on index requests made by this action.
java.lang.String	toString()
void	writeTo(org.elasticsearch.common.io.stream.StreamOutput out)

Methods inherited from class org.elasticsearch.index.reindex.AbstractBulkIndexByScrollRequest

doForSlice, getScript, searchToString, setScript

Methods inherited from class org.elasticsearch.action.bulk.byscroll.AbstractBulkByScrollRequest

createTask, getDescription, getMaxRetries, getRequestsPerSecond, getRetryBackoffInitialTime, getSearchRequest, getShouldStoreResult, getSize, getSlices, getTimeout, getWaitForActiveShards, isAbortOnVersionConflict, isRefresh, setAbortOnVersionConflict, setConflicts, setMaxRetries, setRefresh, setRequestsPerSecond, setRetryBackoffInitialTime, setShouldStoreResult, setSize, setSlices, setTimeout, setWaitForActiveShards, setWaitForActiveShards, validate

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.tasks.TaskAwareRequest

setParentTask

Constructor Detail

UpdateByQueryRequest

public UpdateByQueryRequest()

UpdateByQueryRequest

public UpdateByQueryRequest(org.elasticsearch.action.search.SearchRequest search)

Method Detail

setPipeline

public void setPipeline(java.lang.String pipeline)

Set the ingest pipeline to set on index requests made by this action.

getPipeline

public java.lang.String getPipeline()

Ingest pipeline to set on index requests made by this action.

self

protected UpdateByQueryRequest self()

Specified by:

self in class org.elasticsearch.action.bulk.byscroll.AbstractBulkByScrollRequest<UpdateByQueryRequest>

forSlice

protected UpdateByQueryRequest forSlice(org.elasticsearch.tasks.TaskId slicingTask,
                                        org.elasticsearch.action.search.SearchRequest slice)

Specified by:

forSlice in class org.elasticsearch.action.bulk.byscroll.AbstractBulkByScrollRequest<UpdateByQueryRequest>

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

indices

public org.elasticsearch.action.IndicesRequest indices(java.lang.String... indices)

Specified by:

indices in interface org.elasticsearch.action.IndicesRequest.Replaceable

indices

public java.lang.String[] indices()

Specified by:

indices in interface org.elasticsearch.action.IndicesRequest

indicesOptions

public org.elasticsearch.action.support.IndicesOptions indicesOptions()

Specified by:

indicesOptions in interface org.elasticsearch.action.IndicesRequest

readFrom

public void readFrom(org.elasticsearch.common.io.stream.StreamInput in)
              throws java.io.IOException

Specified by:

readFrom in interface org.elasticsearch.common.io.stream.Streamable

Overrides:

readFrom in class AbstractBulkIndexByScrollRequest<UpdateByQueryRequest>

Throws:

java.io.IOException

writeTo

public void writeTo(org.elasticsearch.common.io.stream.StreamOutput out)
             throws java.io.IOException

Specified by:

writeTo in interface org.elasticsearch.common.io.stream.Streamable

Overrides:

writeTo in class AbstractBulkIndexByScrollRequest<UpdateByQueryRequest>

Throws:

java.io.IOException