Package org.elasticsearch.action.explain
Class ExplainRequest
java.lang.Object
org.elasticsearch.transport.TransportMessage
org.elasticsearch.transport.TransportRequest
org.elasticsearch.action.ActionRequest
org.elasticsearch.action.support.single.shard.SingleShardRequest<ExplainRequest>
org.elasticsearch.action.explain.ExplainRequest
- All Implemented Interfaces:
IndicesRequest
,Writeable
,org.elasticsearch.common.util.concurrent.RefCounted
,org.elasticsearch.common.xcontent.ToXContent
,org.elasticsearch.common.xcontent.ToXContentObject
,TaskAwareRequest
public class ExplainRequest extends SingleShardRequest<ExplainRequest> implements org.elasticsearch.common.xcontent.ToXContentObject
Explain request encapsulating the explain query and document identifier to get an explanation for.
-
Nested Class Summary
Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportRequest
TransportRequest.Empty
Nested classes/interfaces inherited from interface org.elasticsearch.action.IndicesRequest
IndicesRequest.Replaceable
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 inherited from class org.elasticsearch.action.support.single.shard.SingleShardRequest
index, INDICES_OPTIONS
Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent
EMPTY_PARAMS
-
Constructor Summary
Constructors Constructor Description ExplainRequest()
ExplainRequest(java.lang.String index, java.lang.String id)
ExplainRequest(java.lang.String index, java.lang.String type, java.lang.String id)
Deprecated.Types are in the process of being removed. -
Method Summary
Modifier and Type Method Description FetchSourceContext
fetchSourceContext()
ExplainRequest
fetchSourceContext(FetchSourceContext context)
Allows setting theFetchSourceContext
for this request, controlling if and how _source should be returned.AliasFilter
filteringAlias()
ExplainRequest
filteringAlias(AliasFilter filteringAlias)
java.lang.String
id()
ExplainRequest
id(java.lang.String id)
ExplainRequest
parent(java.lang.String parent)
Simple sets the routing.java.lang.String
preference()
ExplainRequest
preference(java.lang.String preference)
QueryBuilder
query()
ExplainRequest
query(QueryBuilder query)
java.lang.String
routing()
ExplainRequest
routing(java.lang.String routing)
java.lang.String[]
storedFields()
ExplainRequest
storedFields(java.lang.String[] fields)
org.elasticsearch.common.xcontent.XContentBuilder
toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
java.lang.String
type()
Deprecated.Types are in the process of being removed.ExplainRequest
type(java.lang.String type)
Deprecated.Types are in the process of being removed.ActionRequestValidationException
validate()
void
writeTo(StreamOutput out)
Write this into the StreamOutput.Methods inherited from class org.elasticsearch.action.support.single.shard.SingleShardRequest
index, index, indices, indicesOptions, validateNonNullIndex
Methods inherited from class org.elasticsearch.action.ActionRequest
getShouldStoreResult
Methods inherited from class org.elasticsearch.transport.TransportRequest
getParentTask, setParentTask
Methods inherited from class org.elasticsearch.transport.TransportMessage
decRef, 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.action.IndicesRequest
includeDataStreams
Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest
createTask, getDescription, setParentTask
Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject
isFragment
-
Constructor Details
-
ExplainRequest
public ExplainRequest() -
ExplainRequest
@Deprecated public ExplainRequest(java.lang.String index, java.lang.String type, java.lang.String id)Deprecated.Types are in the process of being removed. Useinstead.
-
ExplainRequest
public ExplainRequest(java.lang.String index, java.lang.String id)
-
-
Method Details
-
type
@Deprecated public java.lang.String type()Deprecated.Types are in the process of being removed. -
type
Deprecated.Types are in the process of being removed. -
id
public java.lang.String id() -
id
-
routing
public java.lang.String routing() -
routing
-
parent
Simple sets the routing. Since the parent is only used to get to the right shard. -
preference
public java.lang.String preference() -
preference
-
query
-
query
-
fetchSourceContext
Allows setting theFetchSourceContext
for this request, controlling if and how _source should be returned. -
fetchSourceContext
-
storedFields
public java.lang.String[] storedFields() -
storedFields
-
filteringAlias
-
filteringAlias
-
validate
- Specified by:
validate
in classActionRequest
-
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput.- Specified by:
writeTo
in interfaceWriteable
- Overrides:
writeTo
in classSingleShardRequest<ExplainRequest>
- Throws:
java.io.IOException
-
toXContent
public org.elasticsearch.common.xcontent.XContentBuilder toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws java.io.IOException- Specified by:
toXContent
in interfaceorg.elasticsearch.common.xcontent.ToXContent
- Throws:
java.io.IOException
-