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

Class ValidateQueryRequest

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest

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

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

All Implemented Interfaces:

IndicesRequest, IndicesRequest.Replaceable, Writeable, RefCounted, TaskAwareRequest, ToXContent, ToXContentObject

public class ValidateQueryRequest
extends BroadcastRequest<ValidateQueryRequest>
implements ToXContentObject

A request to validate a specific query.

The request requires the query to be set using query(QueryBuilder)

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

Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final IndicesOptions	DEFAULT_INDICES_OPTIONS

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

indices

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
boolean	allShards()	Indicates whether the query should be validated on all shards instead of one random shard
void	allShards(boolean allShards)	Indicates whether the query should be validated on all shards instead of one random shard
boolean	explain()	Indicates if detailed information about query is requested
void	explain(boolean explain)	Indicate if detailed information about query is requested
QueryBuilder	query()	The query to validate.
ValidateQueryRequest	query(QueryBuilder query)
boolean	rewrite()	Indicates whether the query should be rewritten into primitive queries
void	rewrite(boolean rewrite)	Indicates whether the query should be rewritten into primitive queries
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
String[]	types()	Deprecated. Types are in the process of being removed.
ValidateQueryRequest	types(String... types)	Deprecated. Types are in the process of being removed.
ActionRequestValidationException	validate()
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class org.elasticsearch.action.support.broadcast.BroadcastRequest

includeDataStreams, indices, indices, indicesOptions, indicesOptions, timeout, timeout

Methods inherited from class org.elasticsearch.action.ActionRequest

getShouldStoreResult

Methods inherited from class org.elasticsearch.transport.TransportRequest

getParentTask, setParentTask

Methods inherited from class org.elasticsearch.transport.TransportMessage

decRef, hasReferences, incRef, remoteAddress, remoteAddress, tryIncRef

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.action.IndicesRequest.Replaceable

allowsRemoteIndices

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

createTask, getDescription, setParentTask

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Field Details

DEFAULT_INDICES_OPTIONS

public static final IndicesOptions DEFAULT_INDICES_OPTIONS

Constructor Details

ValidateQueryRequest

public ValidateQueryRequest()

ValidateQueryRequest

public ValidateQueryRequest(StreamInput in)
                     throws IOException

Throws:

IOException

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 Details

validate

public ActionRequestValidationException validate()

Overrides:

validate in class BroadcastRequest<ValidateQueryRequest>

query

public QueryBuilder query()

The query to validate.

query

public ValidateQueryRequest query(QueryBuilder query)

types

@Deprecated
public String[] types()

Deprecated.

Types are in the process of being removed. Instead of using a type, prefer to filter on a field on the document.

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

types

@Deprecated
public ValidateQueryRequest types(String... types)

Deprecated.

Types are in the process of being removed. Instead of using a type, prefer to filter on a field on the document.

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

rewrite

public void rewrite(boolean rewrite)

Indicates whether the query should be rewritten into primitive queries

rewrite

public boolean rewrite()

Indicates whether the query should be rewritten into primitive queries

allShards

public void allShards(boolean allShards)

Indicates whether the query should be validated on all shards instead of one random shard

allShards

public boolean allShards()

Indicates whether the query should be validated on all shards instead of one random shard

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class BroadcastRequest<ValidateQueryRequest>

Throws:

IOException

toString

public String toString()

Overrides:

toString in class TransportRequest

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException