org.elasticsearch.action.explain
Class ExplainRequest

java.lang.Object
  org.elasticsearch.action.support.single.shard.SingleShardOperationRequest
      org.elasticsearch.action.explain.ExplainRequest

All Implemented Interfaces:

ActionRequest, Streamable

public class ExplainRequest
extends SingleShardOperationRequest

Explain request encapsulating the explain query and document identifier to get an explanation for.

Field Summary

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

index

Constructor Summary

ExplainRequest(String index, String type, String id)

Method Summary

protected void	beforeLocalFork()
String[]	fields()
ExplainRequest	fields(String[] fields)
String[]	filteringAlias()
void	filteringAlias(String[] filteringAlias)
String	id()
ExplainRequest	id(String id)
ExplainRequest	index(String index)
ExplainRequest	listenerThreaded(boolean threadedListener) Sets if the response listener be executed on a thread or not.
ExplainRequest	operationThreaded(boolean threadedOperation) Controls if the operation will be executed on a separate thread when executed locally.
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, boolean unsafe)
ExplainRequest	source(ExplainSourceBuilder sourceBuilder)
boolean	sourceUnsafe()
String	type()
ExplainRequest	type(String type)
ActionRequestValidationException	validate()
void	writeTo(StreamOutput out)

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

index, listenerThreaded, operationThreaded

Methods inherited from class java.lang.Object

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

Constructor Detail

ExplainRequest

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

Method Detail

index

public ExplainRequest index(String index)

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

sourceUnsafe

public boolean sourceUnsafe()

source

public ExplainRequest source(ExplainSourceBuilder sourceBuilder)

source

public ExplainRequest source(BytesReference source,
                             boolean unsafe)

fields

public String[] fields()

fields

public ExplainRequest fields(String[] fields)

filteringAlias

public String[] filteringAlias()

filteringAlias

public void filteringAlias(String[] filteringAlias)

listenerThreaded

public ExplainRequest listenerThreaded(boolean threadedListener)

Description copied from interface: ActionRequest

Sets if the response listener be executed on a thread or not.

Specified by:

listenerThreaded in interface ActionRequest

Overrides:

listenerThreaded in class SingleShardOperationRequest

operationThreaded

public ExplainRequest operationThreaded(boolean threadedOperation)

Description copied from class: SingleShardOperationRequest

Controls if the operation will be executed on a separate thread when executed locally.

Overrides:

operationThreaded in class SingleShardOperationRequest

beforeLocalFork

protected void beforeLocalFork()

Overrides:

beforeLocalFork in class SingleShardOperationRequest

validate

public ActionRequestValidationException validate()

Specified by:

validate in interface ActionRequest

Overrides:

validate in class SingleShardOperationRequest

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class SingleShardOperationRequest

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Overrides:

writeTo in class SingleShardOperationRequest

Throws:

IOException