org.elasticsearch.action.explain

Class ExplainRequest

java.lang.Object

org.elasticsearch.common.ContextAndHeaderHolder

org.elasticsearch.transport.TransportMessage<TransportRequest>

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest<T>

org.elasticsearch.action.support.single.shard.SingleShardRequest<ExplainRequest>

org.elasticsearch.action.explain.ExplainRequest

All Implemented Interfaces:

IndicesRequest, HasContext, HasContextAndHeaders, HasHeaders, Streamable

public class ExplainRequest
extends SingleShardRequest<ExplainRequest>

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

Field Summary

Fields inherited from class org.elasticsearch.action.support.single.shard.SingleShardRequest

index, INDICES_OPTIONS

Fields inherited from class org.elasticsearch.common.ContextAndHeaderHolder

headers

Constructor Summary

Constructors

Constructor and Description
ExplainRequest()
ExplainRequest(String index, String type, String id)

Method Summary

Methods

Modifier and Type	Method and Description
FetchSourceContext	fetchSourceContext()
ExplainRequest	fetchSourceContext(FetchSourceContext context) Allows setting the FetchSourceContext for this request, controlling if and how _source should be returned.
String[]	fields()
ExplainRequest	fields(String[] fields)
String[]	filteringAlias()
ExplainRequest	filteringAlias(String[] filteringAlias)
String	id()
ExplainRequest	id(String id)
ExplainRequest	parent(String parent) Simple sets the routing.
String	preference()
ExplainRequest	preference(String preference)
void	readFrom(StreamInput in)
String	routing()
ExplainRequest	routing(String routing)
BytesReference	source()
ExplainRequest	source(BytesReference source)
ExplainRequest	source(QuerySourceBuilder sourceBuilder)
String	type()
ExplainRequest	type(String type)
ActionRequestValidationException	validate()
void	writeTo(StreamOutput out)

Methods inherited from class org.elasticsearch.action.support.single.shard.SingleShardRequest

index, index, indices, indicesOptions, operationThreaded, operationThreaded, validateNonNullIndex

Methods inherited from class org.elasticsearch.transport.TransportRequest

createTask, getDescription

Methods inherited from class org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class org.elasticsearch.common.ContextAndHeaderHolder

contextSize, copyContextAndHeadersFrom, copyContextFrom, copyHeadersFrom, getContext, getFromContext, getFromContext, getHeader, getHeaders, hasHeader, hasInContext, isContextEmpty, putAllInContext, putHeader, putInContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ExplainRequest

public ExplainRequest()

ExplainRequest

public ExplainRequest(String index,
              String type,
              String id)

Method Detail

type

public String type()

type

public ExplainRequest type(String type)

id

public String id()

id

public ExplainRequest id(String id)

routing

public String routing()

routing

public ExplainRequest routing(String routing)

parent

public ExplainRequest parent(String parent)

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

preference

public String preference()

preference

public ExplainRequest preference(String preference)

source

public BytesReference source()

source

public ExplainRequest source(QuerySourceBuilder sourceBuilder)

source

public ExplainRequest source(BytesReference source)

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()

fields

public String[] fields()

fields

public ExplainRequest fields(String[] fields)

filteringAlias

public String[] filteringAlias()

filteringAlias

public ExplainRequest filteringAlias(String[] filteringAlias)

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest<ExplainRequest>

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class SingleShardRequest<ExplainRequest>

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Overrides:

writeTo in class SingleShardRequest<ExplainRequest>

Throws:

IOException