org.elasticsearch.index.reindex

Class UpdateByQueryRequest

java.lang.Object

org.elasticsearch.common.ContextAndHeaderHolder

org.elasticsearch.transport.TransportMessage<TransportRequest>

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest<Self>

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

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

org.elasticsearch.index.reindex.UpdateByQueryRequest

All Implemented Interfaces:

CompositeIndicesRequest, HasContext, HasContextAndHeaders, HasHeaders, Streamable

public class UpdateByQueryRequest
extends AbstractBulkIndexByScrollRequest<UpdateByQueryRequest>
implements CompositeIndicesRequest

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

Field Summary

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

SIZE_ALL_MATCHES

Fields inherited from class org.elasticsearch.common.ContextAndHeaderHolder

headers

Constructor Summary

Constructors

Constructor and Description
UpdateByQueryRequest()
UpdateByQueryRequest(SearchRequest search)

Method Summary

Methods

Modifier and Type	Method and Description
protected UpdateByQueryRequest	self() `this` cast to Self.
List<? extends IndicesRequest>	subRequests() Accessor to get the underlying IndicesRequests that this request wraps.
String	toString()

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

getScript, readFrom, searchToString, setScript, writeTo

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

createTask, getConsistency, getMaxRetries, getRequestsPerSecond, getRetryBackoffInitialTime, getSearchRequest, getSize, getTimeout, isAbortOnVersionConflict, isRefresh, setAbortOnVersionConflict, setConflicts, setConsistency, setMaxRetries, setRefresh, setRequestsPerSecond, setRetryBackoffInitialTime, setSize, setTimeout, validate

Methods inherited from class org.elasticsearch.transport.TransportRequest

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, wait, wait, wait

Constructor Detail

UpdateByQueryRequest

public UpdateByQueryRequest()

UpdateByQueryRequest

public UpdateByQueryRequest(SearchRequest search)

Method Detail

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>

toString

public String toString()

Overrides:

toString in class Object

subRequests

public List<? extends IndicesRequest> subRequests()

Accessor to get the underlying IndicesRequests that this request wraps. Note that this method is not accurate since it returns dummy IndexRequests and not the actual requests that will be issued as part of the execution of this request.

Specified by:

subRequests in interface CompositeIndicesRequest

Returns:

a list comprising of the SearchRequest and dummy IndexRequests