org.elasticsearch.action.deletebyquery

Class DeleteByQueryRequestBuilder

java.lang.Object

org.elasticsearch.action.ActionRequestBuilder<Request,Response,RequestBuilder,Client>

org.elasticsearch.action.support.replication.IndicesReplicationOperationRequestBuilder<DeleteByQueryRequest,DeleteByQueryResponse,DeleteByQueryRequestBuilder>

org.elasticsearch.action.deletebyquery.DeleteByQueryRequestBuilder

public class DeleteByQueryRequestBuilder
extends IndicesReplicationOperationRequestBuilder<DeleteByQueryRequest,DeleteByQueryResponse,DeleteByQueryRequestBuilder>

Field Summary

Fields inherited from class org.elasticsearch.action.ActionRequestBuilder

client, request

Constructor Summary

Constructors

Constructor and Description
DeleteByQueryRequestBuilder(Client client)

Method Summary

Modifier and Type	Method and Description
protected void	doExecute(ActionListener<DeleteByQueryResponse> listener)
DeleteByQueryRequestBuilder	setConsistencyLevel(WriteConsistencyLevel consistencyLevel) Sets the consistency level of write.
DeleteByQueryRequestBuilder	setQuery(QueryBuilder queryBuilder) The query to delete documents for.
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	setSource(byte[] source) The source to execute.
DeleteByQueryRequestBuilder	setSource(byte[] source, int offset, int length, boolean unsafe) The source to execute.
DeleteByQueryRequestBuilder	setSource(BytesReference source) The source to execute.
DeleteByQueryRequestBuilder	setSource(BytesReference source, boolean unsafe) The source to execute.
DeleteByQueryRequestBuilder	setSource(Map<String,Object> source) The source to execute in the form of a map.
DeleteByQueryRequestBuilder	setSource(String source) The source to execute.
DeleteByQueryRequestBuilder	setSource(XContentBuilder builder) The source to execute in the form of a builder.
DeleteByQueryRequestBuilder	setTypes(String... types) The types of documents the query will run against.

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

setIndices, setIndicesOptions, setTimeout, setTimeout

Methods inherited from class org.elasticsearch.action.ActionRequestBuilder

execute, execute, get, get, get, putHeader, request, setListenerThreaded

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

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 to delete documents for.

See Also:

QueryBuilders

setSource

public DeleteByQueryRequestBuilder setSource(String source)

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

setSource

public DeleteByQueryRequestBuilder setSource(Map<String,Object> source)

The source to execute in the form of a map.

setSource

public DeleteByQueryRequestBuilder setSource(XContentBuilder builder)

The source to execute in the form of a builder.

setSource

public DeleteByQueryRequestBuilder setSource(byte[] source)

The source to execute.

setSource

public DeleteByQueryRequestBuilder setSource(BytesReference source)

The source to execute.

setSource

public DeleteByQueryRequestBuilder setSource(BytesReference source,
                                             boolean unsafe)

The source to execute.

setSource

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

The source to execute.

setReplicationType

public DeleteByQueryRequestBuilder setReplicationType(ReplicationType replicationType)

The replication type to use with this operation.

Overrides:

setReplicationType in class IndicesReplicationOperationRequestBuilder<DeleteByQueryRequest,DeleteByQueryResponse,DeleteByQueryRequestBuilder>

setReplicationType

public DeleteByQueryRequestBuilder setReplicationType(String replicationType)

The replication type to use with this operation.

Overrides:

setReplicationType in class IndicesReplicationOperationRequestBuilder<DeleteByQueryRequest,DeleteByQueryResponse,DeleteByQueryRequestBuilder>

setConsistencyLevel

public DeleteByQueryRequestBuilder setConsistencyLevel(WriteConsistencyLevel consistencyLevel)

Description copied from class: IndicesReplicationOperationRequestBuilder

Sets the consistency level of write. Defaults to WriteConsistencyLevel.DEFAULT

Overrides:

setConsistencyLevel in class IndicesReplicationOperationRequestBuilder<DeleteByQueryRequest,DeleteByQueryResponse,DeleteByQueryRequestBuilder>

doExecute

protected void doExecute(ActionListener<DeleteByQueryResponse> listener)

Specified by:

doExecute in class ActionRequestBuilder<DeleteByQueryRequest,DeleteByQueryResponse,DeleteByQueryRequestBuilder,Client>