org.elasticsearch.action.deletebyquery

Class DeleteByQueryRequest

java.lang.Object

org.elasticsearch.common.ContextHolder

org.elasticsearch.transport.TransportMessage<TransportRequest>

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest<T>

org.elasticsearch.action.support.replication.IndicesReplicationOperationRequest<DeleteByQueryRequest>

org.elasticsearch.action.deletebyquery.DeleteByQueryRequest

All Implemented Interfaces:

IndicesRequest, IndicesRequest.Replaceable, Streamable

public class DeleteByQueryRequest
extends IndicesReplicationOperationRequest<DeleteByQueryRequest>

A request to delete all documents that matching a specific query. Best created with Requests.deleteByQueryRequest(String...).

The request requires the source to be set either using source(QuerySourceBuilder), or source(byte[]).

See Also:

DeleteByQueryResponse, Requests.deleteByQueryRequest(String...), Client.deleteByQuery(DeleteByQueryRequest)

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.replication.IndicesReplicationOperationRequest

consistencyLevel, indices, replicationType, timeout

Constructor Summary

Constructors

Constructor and Description
DeleteByQueryRequest()
DeleteByQueryRequest(ActionRequest originalRequest) Copy constructor that creates a new delete by query request that is a copy of the one provided as an argument.
DeleteByQueryRequest(String... indices) Constructs a new delete by query request to run against the provided indices.

Method Summary

Modifier and Type	Method and Description
void	readFrom(StreamInput in)
String	routing() A comma separated list of routing values to control the shards the search will be executed on.
DeleteByQueryRequest	routing(String... routings) The routing values to control the shards that the search will be executed on.
DeleteByQueryRequest	routing(String routing) A comma separated list of routing values to control the shards the search will be executed on.
BytesReference	source() The source to execute.
DeleteByQueryRequest	source(byte[] source) The source to execute.
DeleteByQueryRequest	source(byte[] source, int offset, int length, boolean unsafe) The source to execute.
DeleteByQueryRequest	source(BytesReference source, boolean unsafe)
DeleteByQueryRequest	source(Map source) The source to execute in the form of a map.
DeleteByQueryRequest	source(QuerySourceBuilder sourceBuilder) The source to execute.
DeleteByQueryRequest	source(String query) The source to execute.
DeleteByQueryRequest	source(XContentBuilder builder)
String	toString()
String[]	types() The types of documents the query will run against.
DeleteByQueryRequest	types(String... types) The types of documents the query will run against.
ActionRequestValidationException	validate()
void	writeTo(StreamOutput out)

Methods inherited from class org.elasticsearch.action.support.replication.IndicesReplicationOperationRequest

consistencyLevel, consistencyLevel, indices, indices, indicesOptions, indicesOptions, replicationType, replicationType, replicationType, timeout, timeout, timeout

Methods inherited from class org.elasticsearch.action.ActionRequest

listenerThreaded, listenerThreaded

Methods inherited from class org.elasticsearch.transport.TransportMessage

getHeader, getHeaders, hasHeader, putHeader, remoteAddress, remoteAddress

Methods inherited from class org.elasticsearch.common.ContextHolder

contextSize, copyContextFrom, getContext, getFromContext, getFromContext, hasInContext, isContextEmpty, putAllInContext, putInContext

Methods inherited from class java.lang.Object

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

Constructor Detail

DeleteByQueryRequest

public DeleteByQueryRequest(String... indices)

Constructs a new delete by query request to run against the provided indices. No indices means it will run against all indices.

DeleteByQueryRequest

public DeleteByQueryRequest()

DeleteByQueryRequest

public DeleteByQueryRequest(ActionRequest originalRequest)

Copy constructor that creates a new delete by query request that is a copy of the one provided as an argument. The new request will inherit though headers and context from the original request that caused it.

Method Detail

validate

public ActionRequestValidationException validate()

Overrides:

validate in class IndicesReplicationOperationRequest<DeleteByQueryRequest>

source

public BytesReference source()

The source to execute.

source

public DeleteByQueryRequest source(QuerySourceBuilder sourceBuilder)

The source to execute.

source

public DeleteByQueryRequest source(String query)

The source to execute. It is preferable to use either source(byte[]) or source(QuerySourceBuilder).

source

public DeleteByQueryRequest source(Map source)

The source to execute in the form of a map.

source

public DeleteByQueryRequest source(XContentBuilder builder)

source

public DeleteByQueryRequest source(byte[] source)

The source to execute.

source

public DeleteByQueryRequest source(byte[] source,
                                   int offset,
                                   int length,
                                   boolean unsafe)

The source to execute.

source

public DeleteByQueryRequest source(BytesReference source,
                                   boolean unsafe)

types

public String[] types()

The types of documents the query will run against. Defaults to all types.

routing

public String routing()

A comma separated list of routing values to control the shards the search will be executed on.

routing

public DeleteByQueryRequest routing(String routing)

A comma separated list of routing values to control the shards the search will be executed on.

routing

public DeleteByQueryRequest routing(String... routings)

The routing values to control the shards that the search will be executed on.

types

public DeleteByQueryRequest types(String... types)

The types of documents the query will run against. Defaults to all types.

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class IndicesReplicationOperationRequest<DeleteByQueryRequest>

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Overrides:

writeTo in class IndicesReplicationOperationRequest<DeleteByQueryRequest>

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object