Package org.elasticsearch.index.reindex

Class UpdateByQueryRequest

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest

org.elasticsearch.index.reindex.AbstractBulkByScrollRequest<Self>

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

org.elasticsearch.index.reindex.UpdateByQueryRequest

All Implemented Interfaces:

IndicesRequest, IndicesRequest.Replaceable, Writeable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject, org.elasticsearch.core.RefCounted, TaskAwareRequest

public class UpdateByQueryRequest
extends AbstractBulkIndexByScrollRequest<UpdateByQueryRequest>
implements IndicesRequest.Replaceable, org.elasticsearch.common.xcontent.ToXContentObject

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

TransportRequest.Empty

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

IndicesRequest.Replaceable

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields inherited from class org.elasticsearch.index.reindex.AbstractBulkByScrollRequest

AUTO_SLICES, AUTO_SLICES_VALUE, DEFAULT_SCROLL_SIZE, DEFAULT_SCROLL_TIMEOUT, MAX_DOCS_ALL_MATCHES, SIZE_ALL_MATCHES

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
UpdateByQueryRequest()
UpdateByQueryRequest(String... indices)
UpdateByQueryRequest(StreamInput in)

Method Summary

Modifier and Type	Method	Description
UpdateByQueryRequest	forSlice(TaskId slicingTask, SearchRequest slice, int totalSlices)	Build a new request for a slice of the parent request.
int	getBatchSize()	Gets the batch size for this request
String[]	getDocTypes()	Deprecated. Types are in the process of being removed.
String	getPipeline()	Ingest pipeline to set on index requests made by this action.
String	getRouting()	Gets the routing value used for this request
String[]	indices()	Returns the array of indices that the action relates to
IndicesRequest	indices(String... indices)	Sets the indices that the action relates to.
IndicesOptions	indicesOptions()	Returns the indices options used to resolve indices.
protected UpdateByQueryRequest	self()	`this` cast to Self.
UpdateByQueryRequest	setBatchSize(int size)	The scroll size to control number of documents processed per batch
UpdateByQueryRequest	setDocTypes(String... types)	Deprecated. Types are in the process of being removed.
UpdateByQueryRequest	setIndicesOptions(IndicesOptions indicesOptions)	Set the IndicesOptions for controlling unavailable indices
UpdateByQueryRequest	setPipeline(String pipeline)	Set the ingest pipeline to set on index requests made by this action.
UpdateByQueryRequest	setQuery(QueryBuilder query)	Set the query for selective update
UpdateByQueryRequest	setRouting(String routing)	Set routing limiting the process to the shards that match that routing value
String	toString()
org.elasticsearch.common.xcontent.XContentBuilder	toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

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

doForSlice, getScript, searchToString, setScript

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

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

Methods inherited from class org.elasticsearch.transport.TransportRequest

getParentTask, setParentTask

Methods inherited from class org.elasticsearch.transport.TransportMessage

decRef, incRef, remoteAddress, remoteAddress, tryIncRef

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.action.IndicesRequest

allowsRemoteIndices, includeDataStreams

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

setParentTask

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject

isFragment

Constructor Details

UpdateByQueryRequest

public UpdateByQueryRequest()

UpdateByQueryRequest

public UpdateByQueryRequest(String... indices)

UpdateByQueryRequest

public UpdateByQueryRequest(StreamInput in)
                     throws IOException

Throws:

IOException

Method Details

setPipeline

public UpdateByQueryRequest setPipeline(String pipeline)

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

setQuery

public UpdateByQueryRequest setQuery(QueryBuilder query)

Set the query for selective update

setDocTypes

@Deprecated
public UpdateByQueryRequest setDocTypes(String... types)

Deprecated.

Types are in the process of being removed. Instead of using a type, prefer to filter on a field of the document.

Set the document types for the update

setRouting

public UpdateByQueryRequest setRouting(String routing)

Set routing limiting the process to the shards that match that routing value

setBatchSize

public UpdateByQueryRequest setBatchSize(int size)

The scroll size to control number of documents processed per batch

setIndicesOptions

public UpdateByQueryRequest setIndicesOptions(IndicesOptions indicesOptions)

Set the IndicesOptions for controlling unavailable indices

getBatchSize

public int getBatchSize()

Gets the batch size for this request

getRouting

public String getRouting()

Gets the routing value used for this request

getDocTypes

@Deprecated
public String[] getDocTypes()

Deprecated.

Types are in the process of being removed. Instead of using a type, prefer to filter on a field of the document.

Gets the document types on which this request would be executed. Returns an empty array if all types are to be processed.

getPipeline

public String getPipeline()

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

self

protected UpdateByQueryRequest self()

Description copied from class: AbstractBulkByScrollRequest

`this` cast to Self. Used for building fluent methods without cast warnings.

Specified by:

self in class AbstractBulkByScrollRequest<UpdateByQueryRequest>

forSlice

public UpdateByQueryRequest forSlice(TaskId slicingTask,
 SearchRequest slice,
 int totalSlices)

Description copied from class: AbstractBulkByScrollRequest

Build a new request for a slice of the parent request.

Specified by:

forSlice in class AbstractBulkByScrollRequest<UpdateByQueryRequest>

toString

public String toString()

Overrides:

toString in class TransportRequest

indices

public IndicesRequest indices(String... indices)

Description copied from interface: IndicesRequest.Replaceable

Sets the indices that the action relates to.

Specified by:

indices in interface IndicesRequest.Replaceable

indices

public String[] indices()

Description copied from interface: IndicesRequest

Returns the array of indices that the action relates to

Specified by:

indices in interface IndicesRequest

indicesOptions

public IndicesOptions indicesOptions()

Description copied from interface: IndicesRequest

Returns the indices options used to resolve indices. They tell for instance whether a single index is accepted, whether an empty array will be converted to _all, and how wildcards will be expanded if needed.

Specified by:

indicesOptions in interface IndicesRequest

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class AbstractBulkIndexByScrollRequest<UpdateByQueryRequest>

Throws:

IOException

toXContent

public org.elasticsearch.common.xcontent.XContentBuilder toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder,
 org.elasticsearch.common.xcontent.ToXContent.Params params)
                                                             throws IOException

Specified by:

toXContent in interface org.elasticsearch.common.xcontent.ToXContent

Throws:

IOException