Module org.elasticsearch.server
Class ValidateQueryResponse
java.lang.Object
org.elasticsearch.transport.TransportMessage
org.elasticsearch.transport.TransportResponse
org.elasticsearch.action.ActionResponse
org.elasticsearch.action.support.broadcast.BaseBroadcastResponse
org.elasticsearch.action.support.broadcast.BroadcastResponse
org.elasticsearch.action.admin.indices.validate.query.ValidateQueryResponse
- All Implemented Interfaces:
Writeable
,RefCounted
,ToXContent
,ToXContentObject
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.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 inherited from class org.elasticsearch.action.support.broadcast.BaseBroadcastResponse
EMPTY
Fields inherited from interface org.elasticsearch.core.RefCounted
ALWAYS_REFERENCED
Fields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY, EMPTY_PARAMS
-
Method Summary
Modifier and TypeMethodDescriptionprotected void
addCustomXContentFields
(XContentBuilder builder, ToXContent.Params params) Override in subclass to add custom fields following the common `_shards` fieldstatic ValidateQueryResponse
fromXContent
(XContentParser parser) List<? extends QueryExplanation>
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
toXContent
Methods inherited from class org.elasticsearch.action.support.broadcast.BaseBroadcastResponse
declareBroadcastFields, getFailedShards, getShardFailures, getStatus, getSuccessfulShards, getTotalShards
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, toString, wait, wait, wait
Methods inherited from interface org.elasticsearch.core.RefCounted
mustIncRef
Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject
isFragment
-
Field Details
-
VALID_FIELD
- See Also:
-
EXPLANATIONS_FIELD
- See Also:
-
-
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 classBaseBroadcastResponse
- Throws:
IOException
-
addCustomXContentFields
protected void addCustomXContentFields(XContentBuilder builder, ToXContent.Params params) throws IOException Description copied from class:BroadcastResponse
Override in subclass to add custom fields following the common `_shards` field- Overrides:
addCustomXContentFields
in classBroadcastResponse
- Throws:
IOException
-
fromXContent
-