org.elasticsearch.action.admin.indices.validate.query

Class ValidateQueryRequest

java.lang.Object

org.elasticsearch.common.ContextHolder

org.elasticsearch.transport.TransportMessage<TransportRequest>

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest<T>

org.elasticsearch.action.support.broadcast.BroadcastOperationRequest<ValidateQueryRequest>

org.elasticsearch.action.admin.indices.validate.query.ValidateQueryRequest

All Implemented Interfaces:

IndicesRequest, IndicesRequest.Replaceable, Streamable

public class ValidateQueryRequest
extends BroadcastOperationRequest<ValidateQueryRequest>

A request to validate a specific query.

The request requires the query source to be set either using source(QuerySourceBuilder), or source(byte[]).

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportRequest

TransportRequest.Empty

Nested classes/interfaces inherited from interface org.elasticsearch.action.IndicesRequest

IndicesRequest.Replaceable

Field Summary

Fields inherited from class org.elasticsearch.action.support.broadcast.BroadcastOperationRequest

indices

Constructor Summary

Constructors

Constructor and Description
ValidateQueryRequest(String... indices) Constructs a new validate request against the provided indices.

Method Summary

Modifier and Type	Method and Description
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
void	readFrom(StreamInput in)
BytesReference	source() The source to execute.
ValidateQueryRequest	source(byte[] source) The source to validate.
ValidateQueryRequest	source(byte[] source, int offset, int length, boolean unsafe) The source to validate.
ValidateQueryRequest	source(BytesReference source, boolean unsafe) The source to validate.
ValidateQueryRequest	source(Map source) The source to execute in the form of a map.
ValidateQueryRequest	source(QuerySourceBuilder sourceBuilder)
ValidateQueryRequest	source(String source) The query source to validate.
ValidateQueryRequest	source(XContentBuilder builder)
String	toString()
String[]	types() The types of documents the query will run against.
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, indices, indices, indicesOptions, indicesOptions

Methods inherited from class org.elasticsearch.action.ActionRequest

listenerThreaded, listenerThreaded

Methods inherited from class org.elasticsearch.transport.TransportMessage

getHeader, getHeaders, hasHeader, putHeader, remoteAddress, remoteAddress

Methods inherited from class org.elasticsearch.common.ContextHolder

contextSize, copyContextFrom, getContext, getFromContext, getFromContext, hasInContext, isContextEmpty, putAllInContext, putInContext

Methods inherited from class java.lang.Object

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

Constructor Detail

ValidateQueryRequest

public ValidateQueryRequest(String... indices)

Constructs a new validate request against the provided indices. No indices provided means it will run against all indices.

Method Detail

validate

public ActionRequestValidationException validate()

Overrides:

validate in class BroadcastOperationRequest<ValidateQueryRequest>

beforeStart

protected void beforeStart()

Overrides:

beforeStart in class BroadcastOperationRequest<ValidateQueryRequest>

source

public BytesReference source()

The source to execute.

source

public ValidateQueryRequest source(QuerySourceBuilder sourceBuilder)

source

public ValidateQueryRequest source(Map source)

The source to execute in the form of a map.

source

public ValidateQueryRequest source(XContentBuilder builder)

source

public ValidateQueryRequest source(String source)

The query source to validate. It is preferable to use either source(byte[]) or source(QuerySourceBuilder).

source

public ValidateQueryRequest source(byte[] source)

The source to validate.

source

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

The source to validate.

source

public ValidateQueryRequest source(BytesReference source,
                                   boolean unsafe)

The source to validate.

types

public String[] types()

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

types

public ValidateQueryRequest types(String... types)

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

explain

public void explain(boolean explain)

Indicate if detailed information about query is requested

explain

public boolean explain()

Indicates if detailed information about query is requested

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class BroadcastOperationRequest<ValidateQueryRequest>

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Overrides:

writeTo in class BroadcastOperationRequest<ValidateQueryRequest>

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object