Package org.elasticsearch.action.explain

Class ExplainRequest

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.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject, org.elasticsearch.core.RefCounted, 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()
index, id)
index, type, 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 the FetchSourceContext for this request, controlling if and how _source should be returned.
AliasFilter	filteringAlias()
ExplainRequest	filteringAlias(AliasFilter filteringAlias)
	id()
ExplainRequest	id)
ExplainRequest	parent)	Simple sets the routing.
	preference()
ExplainRequest	preference)
QueryBuilder	query()
ExplainRequest	query(QueryBuilder query)
	routing()
ExplainRequest	routing)
[]	storedFields()
ExplainRequest	[] fields)
org.elasticsearch.common.xcontent.XContentBuilder	toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
	type()	Deprecated. Types are in the process of being removed.
ExplainRequest	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, toString

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.action.IndicesRequest

allowsRemoteIndices, 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

public ExplainRequest( index,
  type,
  id)

Deprecated.

Types are in the process of being removed. Use instead.

ExplainRequest

public ExplainRequest( index,
  id)

Method Details

type

public  type()

Deprecated.

Types are in the process of being removed.

type

public  type)

Deprecated.

Types are in the process of being removed.

id

public  id()

id

public  id)

routing

public  routing()

routing

public  routing)

parent

public  parent)

Simple sets the routing. Since the parent is only used to get to the right shard.

preference

public  preference()

preference

public  preference)

query

public QueryBuilder query()

query

public ExplainRequest query(QueryBuilder query)

fetchSourceContext

public ExplainRequest fetchSourceContext(FetchSourceContext context)

Allows setting the FetchSourceContext for this request, controlling if and how _source should be returned.

fetchSourceContext

public FetchSourceContext fetchSourceContext()

storedFields

public [] storedFields()

storedFields

public [] fields)

filteringAlias

public AliasFilter filteringAlias()

filteringAlias

public ExplainRequest filteringAlias(AliasFilter filteringAlias)

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest

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 SingleShardRequest<ExplainRequest>

Throws:

toXContent

public org.elasticsearch.common.xcontent.XContentBuilder toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder,
 org.elasticsearch.common.xcontent.ToXContent.Params params)
                                                             throws 

Specified by:

toXContent in interface org.elasticsearch.common.xcontent.ToXContent

Throws: