java.lang.Object
org.elasticsearch.transport.TransportMessage
org.elasticsearch.transport.AbstractTransportRequest
org.elasticsearch.action.ActionRequest
org.elasticsearch.action.LegacyActionRequest
org.elasticsearch.action.support.single.shard.SingleShardRequest<ExplainRequest>
org.elasticsearch.action.explain.ExplainRequest
- All Implemented Interfaces:
IndicesRequest,IndicesRequest.RemoteClusterShardRequest,Writeable,RefCounted,TaskAwareRequest,TransportRequest,ToXContent,ToXContentObject
Explain request encapsulating the explain query and document identifier to get an explanation for.
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.elasticsearch.action.IndicesRequest
IndicesRequest.RemoteClusterShardRequest, IndicesRequest.Replaceable, IndicesRequest.SingleIndexNoWildcardsNested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.ParamsNested 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.single.shard.SingleShardRequest
index, INDICES_OPTIONSFields inherited from interface org.elasticsearch.core.RefCounted
ALWAYS_REFERENCEDFields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY, EMPTY_PARAMS -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionfetchSourceContext(FetchSourceContext context) Allows setting theFetchSourceContextfor this request, controlling if and how _source should be returned.filteringAlias(AliasFilter filteringAlias) id()Simple sets the routing.preference(String preference) query()query(QueryBuilder query) routing()String[]storedFields(String[] fields) toXContent(XContentBuilder builder, ToXContent.Params params) validate()voidwriteTo(StreamOutput out) Write this into the StreamOutput.Methods inherited from class org.elasticsearch.action.support.single.shard.SingleShardRequest
index, index, indices, indicesOptions, shards, validateNonNullIndexMethods inherited from class org.elasticsearch.action.ActionRequest
getShouldStoreResultMethods inherited from class org.elasticsearch.transport.AbstractTransportRequest
getParentTask, getRequestId, remoteAddress, remoteAddress, setParentTask, setRequestId, toStringMethods inherited from class org.elasticsearch.transport.TransportMessage
decRef, hasReferences, incRef, tryIncRefMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface org.elasticsearch.action.IndicesRequest
includeDataStreamsMethods inherited from interface org.elasticsearch.core.RefCounted
decRef, hasReferences, incRef, mustIncRef, tryIncRefMethods inherited from interface org.elasticsearch.tasks.TaskAwareRequest
createTask, createTask, getDescription, setParentTaskMethods inherited from interface org.elasticsearch.xcontent.ToXContentObject
isFragment
-
Constructor Details
-
ExplainRequest
public ExplainRequest() -
ExplainRequest
-
-
Method Details
-
id
-
id
-
routing
-
routing
-
parent
Simple sets the routing. Since the parent is only used to get to the right shard. -
preference
-
preference
-
query
-
query
-
fetchSourceContext
Allows setting theFetchSourceContextfor this request, controlling if and how _source should be returned. -
fetchSourceContext
-
storedFields
-
storedFields
-
filteringAlias
-
filteringAlias
-
validate
- Specified by:
validatein classActionRequest
-
writeTo
Description copied from interface:WriteableWrite this into the StreamOutput.- Specified by:
writeToin interfaceWriteable- Overrides:
writeToin classSingleShardRequest<ExplainRequest>- Throws:
IOException
-
toXContent
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws IOException - Specified by:
toXContentin interfaceToXContent- Throws:
IOException
-