|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.elasticsearch.action.support.replication.IndicesReplicationOperationRequest org.elasticsearch.action.deletebyquery.DeleteByQueryRequest
public class DeleteByQueryRequest
A request to delete all documents that matching a specific query. Best created with
Requests.deleteByQueryRequest(String...)
.
The request requires the query source to be set either using query(org.elasticsearch.index.query.QueryBuilder)
,
or query(byte[])
.
DeleteByQueryResponse
,
Requests.deleteByQueryRequest(String...)
,
Client.deleteByQuery(DeleteByQueryRequest)
Field Summary |
---|
Fields inherited from class org.elasticsearch.action.support.replication.IndicesReplicationOperationRequest |
---|
consistencyLevel, indices, replicationType, timeout |
Constructor Summary | |
---|---|
DeleteByQueryRequest()
|
|
DeleteByQueryRequest(String... indices)
Constructs a new delete by query request to run against the provided indices. |
Method Summary | |
---|---|
DeleteByQueryRequest |
consistencyLevel(WriteConsistencyLevel consistencyLevel)
|
DeleteByQueryRequest |
indices(String... indices)
The indices the delete by query will run against. |
DeleteByQueryRequest |
listenerThreaded(boolean threadedListener)
Should the listener be called on a separate thread if needed. |
DeleteByQueryRequest |
query(byte[] querySource)
The query source to execute. |
DeleteByQueryRequest |
query(byte[] querySource,
int offset,
int length,
boolean unsafe)
The query source to execute. |
DeleteByQueryRequest |
query(BytesReference source,
boolean unsafe)
|
DeleteByQueryRequest |
query(Map querySource)
The query source to execute in the form of a map. |
DeleteByQueryRequest |
query(QueryBuilder queryBuilder)
The query source to execute. |
DeleteByQueryRequest |
query(String querySource)
The query source to execute. |
DeleteByQueryRequest |
query(XContentBuilder builder)
|
void |
readFrom(StreamInput in)
|
DeleteByQueryRequest |
replicationType(ReplicationType replicationType)
The replication type to use with this operation. |
DeleteByQueryRequest |
replicationType(String replicationType)
The replication type to use with this operation. |
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. |
DeleteByQueryRequest |
timeout(String timeout)
A timeout to wait if the delete by query operation can't be performed immediately. |
DeleteByQueryRequest |
timeout(TimeValue timeout)
A timeout to wait if the delete by query operation can't be performed immediately. |
String |
toString()
|
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, indices, listenerThreaded, replicationType, timeout |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public DeleteByQueryRequest(String... indices)
public DeleteByQueryRequest()
Method Detail |
---|
public DeleteByQueryRequest listenerThreaded(boolean threadedListener)
listenerThreaded
in interface ActionRequest
listenerThreaded
in class IndicesReplicationOperationRequest
public ActionRequestValidationException validate()
validate
in interface ActionRequest
validate
in class IndicesReplicationOperationRequest
public DeleteByQueryRequest indices(String... indices)
indices
in class IndicesReplicationOperationRequest
@Required public DeleteByQueryRequest query(QueryBuilder queryBuilder)
QueryBuilders
@Required public DeleteByQueryRequest query(String querySource)
query(byte[])
or query(org.elasticsearch.index.query.QueryBuilder)
.
@Required public DeleteByQueryRequest query(Map querySource)
@Required public DeleteByQueryRequest query(XContentBuilder builder)
@Required public DeleteByQueryRequest query(byte[] querySource)
@Required public DeleteByQueryRequest query(byte[] querySource, int offset, int length, boolean unsafe)
public DeleteByQueryRequest query(BytesReference source, boolean unsafe)
public String routing()
routing
in class IndicesReplicationOperationRequest
public DeleteByQueryRequest routing(String routing)
public DeleteByQueryRequest routing(String... routings)
public DeleteByQueryRequest types(String... types)
public DeleteByQueryRequest timeout(TimeValue timeout)
public DeleteByQueryRequest timeout(String timeout)
public DeleteByQueryRequest replicationType(ReplicationType replicationType)
public DeleteByQueryRequest consistencyLevel(WriteConsistencyLevel consistencyLevel)
public DeleteByQueryRequest replicationType(String replicationType)
public void readFrom(StreamInput in) throws IOException
readFrom
in interface Streamable
readFrom
in class IndicesReplicationOperationRequest
IOException
public void writeTo(StreamOutput out) throws IOException
writeTo
in interface Streamable
writeTo
in class IndicesReplicationOperationRequest
IOException
public String toString()
toString
in class Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |