org.elasticsearch.action.deletebyquery
Class DeleteByQueryRequestBuilder

java.lang.Object
  org.elasticsearch.action.support.BaseRequestBuilder<DeleteByQueryRequest,DeleteByQueryResponse>
      org.elasticsearch.action.deletebyquery.DeleteByQueryRequestBuilder

All Implemented Interfaces:

ActionRequestBuilder<DeleteByQueryRequest,DeleteByQueryResponse>

public class DeleteByQueryRequestBuilder
extends BaseRequestBuilder<DeleteByQueryRequest,DeleteByQueryResponse>

Field Summary

Fields inherited from class org.elasticsearch.action.support.BaseRequestBuilder

client, request

Constructor Summary

DeleteByQueryRequestBuilder(Client client)

Method Summary

protected void	doExecute(ActionListener<DeleteByQueryResponse> listener)
DeleteByQueryRequestBuilder	setConsistencyLevel(WriteConsistencyLevel consistencyLevel)
DeleteByQueryRequestBuilder	setIndices(String... indices) The indices the delete by query will run against.
DeleteByQueryRequestBuilder	setListenerThreaded(boolean threadedListener) Should the listener be called on a separate thread if needed.
DeleteByQueryRequestBuilder	setQuery(byte[] querySource) The query source to execute.
DeleteByQueryRequestBuilder	setQuery(byte[] querySource, int offset, int length, boolean unsafe) The query source to execute.
DeleteByQueryRequestBuilder	setQuery(BytesReference querySource) The query source to execute.
DeleteByQueryRequestBuilder	setQuery(BytesReference querySource, boolean unsafe) The query source to execute.
DeleteByQueryRequestBuilder	setQuery(Map<String,Object> querySource) The query source to execute in the form of a map.
DeleteByQueryRequestBuilder	setQuery(QueryBuilder queryBuilder) The query source to execute.
DeleteByQueryRequestBuilder	setQuery(String querySource) The query source to execute.
DeleteByQueryRequestBuilder	setQuery(XContentBuilder builder) The query source to execute in the form of a builder.
DeleteByQueryRequestBuilder	setReplicationType(ReplicationType replicationType) The replication type to use with this operation.
DeleteByQueryRequestBuilder	setReplicationType(String replicationType) The replication type to use with this operation.
DeleteByQueryRequestBuilder	setRouting(String... routing) The routing values to control the shards that the action will be executed on.
DeleteByQueryRequestBuilder	setRouting(String routing) A comma separated list of routing values to control the shards the action will be executed on.
DeleteByQueryRequestBuilder	setTimeout(String timeout) A timeout to wait if the delete by query operation can't be performed immediately.
DeleteByQueryRequestBuilder	setTimeout(TimeValue timeout) A timeout to wait if the delete by query operation can't be performed immediately.
DeleteByQueryRequestBuilder	setTypes(String... types) The types of documents the query will run against.

Methods inherited from class org.elasticsearch.action.support.BaseRequestBuilder

execute, execute, request

Methods inherited from class java.lang.Object

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

Constructor Detail

DeleteByQueryRequestBuilder

public DeleteByQueryRequestBuilder(Client client)

Method Detail

setIndices

public DeleteByQueryRequestBuilder setIndices(String... indices)

The indices the delete by query will run against.

setTypes

public DeleteByQueryRequestBuilder setTypes(String... types)

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

setRouting

public DeleteByQueryRequestBuilder setRouting(String routing)

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

setRouting

public DeleteByQueryRequestBuilder setRouting(String... routing)

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

setQuery

public DeleteByQueryRequestBuilder setQuery(QueryBuilder queryBuilder)

The query source to execute.

See Also:

QueryBuilders

setQuery

public DeleteByQueryRequestBuilder setQuery(String querySource)

The query source to execute. It is preferable to use either setQuery(byte[]) or setQuery(org.elasticsearch.index.query.QueryBuilder).

setQuery

public DeleteByQueryRequestBuilder setQuery(Map<String,Object> querySource)

The query source to execute in the form of a map.

setQuery

public DeleteByQueryRequestBuilder setQuery(XContentBuilder builder)

The query source to execute in the form of a builder.

setQuery

public DeleteByQueryRequestBuilder setQuery(byte[] querySource)

The query source to execute.

setQuery

public DeleteByQueryRequestBuilder setQuery(BytesReference querySource)

The query source to execute.

setQuery

public DeleteByQueryRequestBuilder setQuery(BytesReference querySource,
                                            boolean unsafe)

The query source to execute.

setQuery

public DeleteByQueryRequestBuilder setQuery(byte[] querySource,
                                            int offset,
                                            int length,
                                            boolean unsafe)

The query source to execute.

setTimeout

public DeleteByQueryRequestBuilder setTimeout(TimeValue timeout)

A timeout to wait if the delete by query operation can't be performed immediately. Defaults to 1m.

setTimeout

public DeleteByQueryRequestBuilder setTimeout(String timeout)

A timeout to wait if the delete by query operation can't be performed immediately. Defaults to 1m.

setReplicationType

public DeleteByQueryRequestBuilder setReplicationType(ReplicationType replicationType)

The replication type to use with this operation.

setReplicationType

public DeleteByQueryRequestBuilder setReplicationType(String replicationType)

The replication type to use with this operation.

setConsistencyLevel

public DeleteByQueryRequestBuilder setConsistencyLevel(WriteConsistencyLevel consistencyLevel)

setListenerThreaded

public DeleteByQueryRequestBuilder setListenerThreaded(boolean threadedListener)

Should the listener be called on a separate thread if needed.

doExecute

protected void doExecute(ActionListener<DeleteByQueryResponse> listener)

Specified by:

doExecute in class BaseRequestBuilder<DeleteByQueryRequest,DeleteByQueryResponse>