org.elasticsearch.action.support.single.shard

Class SingleShardOperationRequest<T extends SingleShardOperationRequest>

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.SingleShardOperationRequest<T>

All Implemented Interfaces:

IndicesRequest, HasContext, HasContextAndHeaders, HasHeaders, Streamable

Direct Known Subclasses:

ExplainRequest, GetRequest, MultiGetShardRequest, MultiTermVectorsShardRequest, TermVectorRequest, TransportShardMultiPercolateAction.Request

public abstract class SingleShardOperationRequest<T extends SingleShardOperationRequest>
extends ActionRequest<T>
implements IndicesRequest

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

Modifier and Type	Field and Description
protected String	index
static IndicesOptions	INDICES_OPTIONS

Fields inherited from class org.elasticsearch.common.ContextAndHeaderHolder

headers

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SingleShardOperationRequest()
protected	SingleShardOperationRequest(ActionRequest request)
protected	SingleShardOperationRequest(ActionRequest request, String index)
protected	SingleShardOperationRequest(String index)

Method Summary

Modifier and Type	Method and Description
String	index()
T	index(String index) Sets the index.
String[]	indices() Returns the array of indices that the action relates to
IndicesOptions	indicesOptions() Returns the indices options used to resolve indices.
boolean	operationThreaded() Controls if the operation will be executed on a separate thread when executed locally.
T	operationThreaded(boolean threadedOperation) Controls if the operation will be executed on a separate thread when executed locally.
void	readFrom(StreamInput in)
ActionRequestValidationException	validate()
void	writeTo(StreamOutput out)

Methods inherited from class org.elasticsearch.action.ActionRequest

listenerThreaded, listenerThreaded

Methods inherited from class org.elasticsearch.transport.TransportMessage

putHeader, remoteAddress, remoteAddress

Methods inherited from class org.elasticsearch.common.ContextAndHeaderHolder

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

Methods inherited from class java.lang.Object

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

Field Detail

index

protected String index

INDICES_OPTIONS

public static final IndicesOptions INDICES_OPTIONS

Constructor Detail

SingleShardOperationRequest

protected SingleShardOperationRequest()

SingleShardOperationRequest

protected SingleShardOperationRequest(String index)

SingleShardOperationRequest

protected SingleShardOperationRequest(ActionRequest request)

SingleShardOperationRequest

protected SingleShardOperationRequest(ActionRequest request,
                                      String index)

Method Detail

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest<T extends SingleShardOperationRequest>

index

public String index()

index

public final T index(String index)

Sets the index.

indices

public String[] indices()

Description copied from interface: IndicesRequest

Returns the array of indices that the action relates to

Specified by:

indices in interface IndicesRequest

indicesOptions

public IndicesOptions indicesOptions()

Description copied from interface: IndicesRequest

Returns the indices options used to resolve indices. They tell for instance whether a single index is accepted, whether an empty array will be converted to _all, and how wildcards will be expanded if needed.

Specified by:

indicesOptions in interface IndicesRequest

operationThreaded

public boolean operationThreaded()

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

operationThreaded

public final T operationThreaded(boolean threadedOperation)

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

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class ActionRequest<T extends SingleShardOperationRequest>

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Overrides:

writeTo in class ActionRequest<T extends SingleShardOperationRequest>

Throws:

IOException