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:
Writeable
,ToXContent
,ToXContentObject
public class ValidateQueryResponse extends BroadcastResponse
The response of the validate action.
-
Nested Class Summary
Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportResponse
TransportResponse.Empty
Nested classes/interfaces inherited from interface org.elasticsearch.common.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 java.lang.String
EXPLANATIONS_FIELD
static java.lang.String
VALID_FIELD
-
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` fieldstatic ValidateQueryResponse
fromXContent(XContentParser parser)
java.util.List<? 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
remoteAddress, remoteAddress
-
Field Details
-
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
-
-
Method Details
-
isValid
public boolean isValid()A boolean denoting whether the query is valid. -
getQueryExplanation
The list of query explanations. -
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput.- Specified by:
writeTo
in interfaceWriteable
- Overrides:
writeTo
in classBroadcastResponse
- Throws:
java.io.IOException
-
addCustomXContentFields
protected void addCustomXContentFields(XContentBuilder builder, ToXContent.Params params) throws java.io.IOExceptionDescription copied from class:BroadcastResponse
Override in subclass to add custom fields following the common `_shards` field- Overrides:
addCustomXContentFields
in classBroadcastResponse
- Throws:
java.io.IOException
-
fromXContent
-