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

Class ValidateQueryResponse

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportResponse

org.elasticsearch.action.ActionResponse

org.elasticsearch.action.support.broadcast.BroadcastResponse

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

All Implemented Interfaces:

Streamable, Writeable, ToXContent, ToXContentObject

public class ValidateQueryResponse
extends BroadcastResponse

The response of the validate action.

Nested Class Summary

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

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

TransportResponse.Empty

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 java.lang.String	ERROR_FIELD
static java.lang.String	EXPLANATION_FIELD
static java.lang.String	EXPLANATIONS_FIELD
static java.lang.String	INDEX_FIELD
static java.lang.String	SHARD_FIELD
static java.lang.String	VALID_FIELD

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

EMPTY

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Method Summary

Modifier and Type	Method	Description
protected void	addCustomXContentFields(XContentBuilder builder, ToXContent.Params params)	Override in subclass to add custom fields following the common `_shards` field
java.util.List<? extends QueryExplanation>	getQueryExplanation()	The list of query explanations.
boolean	isValid()	A boolean denoting whether the query is valid.
void	readFrom(StreamInput in)	Set this object's fields from a StreamInput.
void	writeTo(StreamOutput out)	Write this object's fields to a StreamOutput.

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

declareBroadcastFields, getFailedShards, getShardFailures, getStatus, getSuccessfulShards, getTotalShards, toXContent

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.common.io.stream.Streamable

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject

isFragment

Methods inherited from class org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

Field Detail

INDEX_FIELD

public static final java.lang.String INDEX_FIELD

See Also:

Constant Field Values

SHARD_FIELD

public static final java.lang.String SHARD_FIELD

See Also:

Constant Field Values

VALID_FIELD

public static final java.lang.String VALID_FIELD

See Also:

Constant Field Values

EXPLANATIONS_FIELD

public static final java.lang.String EXPLANATIONS_FIELD

See Also:

Constant Field Values

ERROR_FIELD

public static final java.lang.String ERROR_FIELD

See Also:

Constant Field Values

EXPLANATION_FIELD

public static final java.lang.String EXPLANATION_FIELD

See Also:

Constant Field Values

Method Detail

isValid

public boolean isValid()

A boolean denoting whether the query is valid.

getQueryExplanation

public java.util.List<? extends QueryExplanation> getQueryExplanation()

The list of query explanations.

readFrom

public void readFrom(StreamInput in)
              throws java.io.IOException

Description copied from interface: Streamable

Set this object's fields from a StreamInput.

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class BroadcastResponse

Throws:

java.io.IOException

writeTo

public void writeTo(StreamOutput out)
             throws java.io.IOException

Description copied from interface: Streamable

Write this object's fields to a StreamOutput.

Specified by:

writeTo in interface Streamable

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class BroadcastResponse

Throws:

java.io.IOException

addCustomXContentFields

protected void addCustomXContentFields(XContentBuilder builder,
                                       ToXContent.Params params)
                                throws java.io.IOException

Description copied from class: BroadcastResponse

Override in subclass to add custom fields following the common `_shards` field

Overrides:

addCustomXContentFields in class BroadcastResponse

Throws:

java.io.IOException