org.elasticsearch.action.deletebyquery

Class DeleteByQueryRequestBuilder

java.lang.Object

org.elasticsearch.action.ActionRequestBuilder<DeleteByQueryRequest,DeleteByQueryResponse,DeleteByQueryRequestBuilder>

org.elasticsearch.action.deletebyquery.DeleteByQueryRequestBuilder

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

Creates a new DeleteByQueryRequestBuilder

See Also:

DeleteByQueryRequest

Field Summary

Fields inherited from class org.elasticsearch.action.ActionRequestBuilder

action, client, request

Constructor Summary

Constructors

Constructor and Description
DeleteByQueryRequestBuilder(ElasticsearchClient client, DeleteByQueryAction action)

Method Summary

Methods

Modifier and Type	Method and Description
ListenableActionFuture<DeleteByQueryResponse>	execute()
DeleteByQueryRequestBuilder	setIndices(String... indices)
DeleteByQueryRequestBuilder	setIndicesOptions(IndicesOptions options) Specifies what type of requested indices to ignore and wildcard indices expressions.
DeleteByQueryRequestBuilder	setQuery(BytesReference queryBinary) The query binary used to delete documents.
DeleteByQueryRequestBuilder	setQuery(QueryBuilder queryBuilder) The query used to delete documents.
DeleteByQueryRequestBuilder	setQuery(XContentBuilder query) Constructs a new builder with a raw search query.
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(BytesReference source) 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	setTimeout(String timeout) An optional timeout to control how long the delete by query is allowed to take.
DeleteByQueryRequestBuilder	setTimeout(TimeValue timeout) An optional timeout to control how long the delete by query is allowed to take.
DeleteByQueryRequestBuilder	setTypes(String... types) The types of documents the query will run against.

Methods inherited from class org.elasticsearch.action.ActionRequestBuilder

beforeExecute, execute, get, get, get, putHeader, request

Methods inherited from class java.lang.Object

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

Constructor Detail

DeleteByQueryRequestBuilder

public DeleteByQueryRequestBuilder(ElasticsearchClient client,
                           DeleteByQueryAction action)

Method Detail

setIndices

public DeleteByQueryRequestBuilder setIndices(String... indices)

setIndicesOptions

public DeleteByQueryRequestBuilder setIndicesOptions(IndicesOptions options)

Specifies what type of requested indices to ignore and wildcard indices expressions.

For example indices that don't exist.

setQuery

public DeleteByQueryRequestBuilder setQuery(QueryBuilder queryBuilder)

The query used to delete documents.

See Also:

QueryBuilders

setQuery

public DeleteByQueryRequestBuilder setQuery(BytesReference queryBinary)

The query binary used to delete documents.

setQuery

public DeleteByQueryRequestBuilder setQuery(XContentBuilder query)

Constructs a new builder with a raw search query.

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.

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.

setTimeout

public DeleteByQueryRequestBuilder setTimeout(TimeValue timeout)

An optional timeout to control how long the delete by query is allowed to take.

setTimeout

public DeleteByQueryRequestBuilder setTimeout(String timeout)

An optional timeout to control how long the delete by query is allowed to take.

setTypes

public DeleteByQueryRequestBuilder setTypes(String... types)

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

execute

public ListenableActionFuture<DeleteByQueryResponse> execute()

Overrides:

execute in class ActionRequestBuilder<DeleteByQueryRequest,DeleteByQueryResponse,DeleteByQueryRequestBuilder>