|
|||||||||
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 |
---|
indices, timeout |
Constructor Summary | |
---|---|
DeleteByQueryRequest(java.lang.String... indices)
Constructs a new delete by query request to run against the provided indices. |
Method Summary | |
---|---|
DeleteByQueryRequest |
indices(java.lang.String... indices)
|
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)
The query source to execute. |
DeleteByQueryRequest |
query(java.util.Map querySource)
The query source to execute in the form of a map. |
DeleteByQueryRequest |
query(QueryBuilder queryBuilder)
The query source to execute. |
DeleteByQueryRequest |
query(java.lang.String querySource)
The query source to execute. |
DeleteByQueryRequest |
query(XContentBuilder builder)
|
DeleteByQueryRequest |
queryParserName(java.lang.String queryParserName)
The query parse name to use. |
void |
readFrom(StreamInput in)
|
DeleteByQueryRequest |
timeout(TimeValue timeout)
A timeout to wait if the delete by query operation can't be performed immediately. |
java.lang.String |
toString()
|
DeleteByQueryRequest |
types(java.lang.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 |
---|
indices, listenerThreaded, timeout |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public DeleteByQueryRequest(java.lang.String... indices)
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(java.lang.String... indices)
indices
in class IndicesReplicationOperationRequest
@Required public DeleteByQueryRequest query(QueryBuilder queryBuilder)
QueryBuilders
@Required public DeleteByQueryRequest query(java.lang.String querySource)
query(byte[])
or query(org.elasticsearch.index.query.QueryBuilder)
.
@Required public DeleteByQueryRequest query(java.util.Map querySource)
@Required public DeleteByQueryRequest query(XContentBuilder builder)
@Required public DeleteByQueryRequest query(byte[] querySource)
@Required public DeleteByQueryRequest query(byte[] querySource, int offset, int length)
public DeleteByQueryRequest queryParserName(java.lang.String queryParserName)
public DeleteByQueryRequest types(java.lang.String... types)
public DeleteByQueryRequest timeout(TimeValue timeout)
public void readFrom(StreamInput in) throws java.io.IOException
readFrom
in interface Streamable
readFrom
in class IndicesReplicationOperationRequest
java.io.IOException
public void writeTo(StreamOutput out) throws java.io.IOException
writeTo
in interface Streamable
writeTo
in class IndicesReplicationOperationRequest
java.io.IOException
public java.lang.String toString()
toString
in class java.lang.Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |