|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.elasticsearch.action.support.broadcast.BroadcastOperationRequest org.elasticsearch.action.admin.indices.validate.query.ValidateQueryRequest
public class ValidateQueryRequest
A request to validate a specific query.
The request requires the query source to be set either using query(org.elasticsearch.index.query.QueryBuilder)
,
or query(byte[])
.
Field Summary |
---|
Fields inherited from class org.elasticsearch.action.support.broadcast.BroadcastOperationRequest |
---|
indices |
Constructor Summary | |
---|---|
ValidateQueryRequest(String... indices)
Constructs a new validate request against the provided indices. |
Method Summary | |
---|---|
protected void |
beforeStart()
|
boolean |
explain()
Indicates if detailed information about query is requested |
void |
explain(boolean explain)
Indicate if detailed information about query is requested |
ValidateQueryRequest |
indices(String... indices)
|
ValidateQueryRequest |
listenerThreaded(boolean threadedListener)
Should the listener be called on a separate thread if needed. |
ValidateQueryRequest |
operationThreading(BroadcastOperationThreading operationThreading)
Controls the operation threading model. |
ValidateQueryRequest |
query(byte[] querySource)
The query source to validate. |
ValidateQueryRequest |
query(byte[] querySource,
int offset,
int length,
boolean unsafe)
The query source to validate. |
ValidateQueryRequest |
query(BytesReference querySource,
boolean unsafe)
The query source to validate. |
ValidateQueryRequest |
query(Map querySource)
The query source to execute in the form of a map. |
ValidateQueryRequest |
query(QueryBuilder queryBuilder)
The query source to execute. |
ValidateQueryRequest |
query(String querySource)
The query source to validate. |
ValidateQueryRequest |
query(XContentBuilder builder)
|
void |
readFrom(StreamInput in)
|
String |
toString()
|
ValidateQueryRequest |
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.broadcast.BroadcastOperationRequest |
---|
beforeLocalFork, ignoreIndices, ignoreIndices, indices, listenerThreaded, operationThreading, operationThreading |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public ValidateQueryRequest(String... indices)
Method Detail |
---|
public ActionRequestValidationException validate()
validate
in interface ActionRequest
validate
in class BroadcastOperationRequest
public ValidateQueryRequest operationThreading(BroadcastOperationThreading operationThreading)
operationThreading
in class BroadcastOperationRequest
protected void beforeStart()
beforeStart
in class BroadcastOperationRequest
public ValidateQueryRequest listenerThreaded(boolean threadedListener)
listenerThreaded
in interface ActionRequest
listenerThreaded
in class BroadcastOperationRequest
public ValidateQueryRequest indices(String... indices)
indices
in class BroadcastOperationRequest
@Required public ValidateQueryRequest query(QueryBuilder queryBuilder)
QueryBuilders
@Required public ValidateQueryRequest query(Map querySource)
@Required public ValidateQueryRequest query(XContentBuilder builder)
@Required public ValidateQueryRequest query(String querySource)
query(byte[])
or query(org.elasticsearch.index.query.QueryBuilder)
.
@Required public ValidateQueryRequest query(byte[] querySource)
@Required public ValidateQueryRequest query(byte[] querySource, int offset, int length, boolean unsafe)
@Required public ValidateQueryRequest query(BytesReference querySource, boolean unsafe)
public ValidateQueryRequest types(String... types)
public void explain(boolean explain)
public boolean explain()
public void readFrom(StreamInput in) throws IOException
readFrom
in interface Streamable
readFrom
in class BroadcastOperationRequest
IOException
public void writeTo(StreamOutput out) throws IOException
writeTo
in interface Streamable
writeTo
in class BroadcastOperationRequest
IOException
public String toString()
toString
in class Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |