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

Class ValidateQueryResponse

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:

Writeable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject, org.elasticsearch.core.RefCounted

public class ValidateQueryResponse
extends BroadcastResponse

The response of the validate action.

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.action.ActionResponse

ActionResponse.Empty

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

org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.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	EXPLANATIONS_FIELD
static	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(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)	Override in subclass to add custom fields following the common `_shards` field
static ValidateQueryResponse	fromXContent(org.elasticsearch.common.xcontent.XContentParser parser)
<? extends QueryExplanation>	getQueryExplanation()	The list of query explanations.
boolean	isValid()	A boolean denoting whether the query is valid.
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

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

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

Methods inherited from class org.elasticsearch.transport.TransportMessage

decRef, incRef, remoteAddress, remoteAddress, tryIncRef

Methods inherited from class java.lang.

, , , , , , , , , ,

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

isFragment

Field Details

VALID_FIELD

public static final  VALID_FIELD

See Also:

Constant Field Values

EXPLANATIONS_FIELD

public static final  EXPLANATIONS_FIELD

See Also:

Constant Field Values

Method Details

isValid

public boolean isValid()

A boolean denoting whether the query is valid.

getQueryExplanation

public <? extends QueryExplanation> getQueryExplanation()

The list of query explanations.

writeTo

public void writeTo(StreamOutput out)
             throws 

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class BroadcastResponse

Throws:

addCustomXContentFields

protected void addCustomXContentFields(org.elasticsearch.common.xcontent.XContentBuilder builder,
 org.elasticsearch.common.xcontent.ToXContent.Params params)
                                throws 

Description copied from class: BroadcastResponse

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

Overrides:

addCustomXContentFields in class BroadcastResponse

Throws:

fromXContent

public static ValidateQueryResponse fromXContent(org.elasticsearch.common.xcontent.XContentParser parser)