org.elasticsearch.action.support.single.shard

Class SingleShardRequest<T extends SingleShardRequest>

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

All Implemented Interfaces:

IndicesRequest, HasContext, HasContextAndHeaders, HasHeaders, Streamable

Direct Known Subclasses:

AnalyzeRequest, ExplainRequest, GetFieldMappingsIndexRequest, GetRequest, MultiGetShardRequest, MultiTermVectorsShardRequest, TermVectorsRequest, TransportShardMultiPercolateAction.Request

public abstract class SingleShardRequest<T extends SingleShardRequest>
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 The concrete index name Whether index property is optional depends on the concrete implementation.
static IndicesOptions	INDICES_OPTIONS

Fields inherited from class org.elasticsearch.common.ContextAndHeaderHolder

headers

Constructor Summary

Constructors

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

Method Summary

Methods

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)
protected ActionRequestValidationException	validateNonNullIndex()
void	writeTo(StreamOutput out)

Methods inherited from class org.elasticsearch.action.ActionRequest

validate

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

Field Detail

INDICES_OPTIONS

public static final IndicesOptions INDICES_OPTIONS

index

@Nullable
protected String index

The concrete index name Whether index property is optional depends on the concrete implementation. If index property is required the concrete implementation should use validateNonNullIndex() to check if the index property has been set

Constructor Detail

SingleShardRequest

public SingleShardRequest()

SingleShardRequest

protected SingleShardRequest(String index)

SingleShardRequest

protected SingleShardRequest(ActionRequest request)

SingleShardRequest

protected SingleShardRequest(ActionRequest request,
                  String index)

Method Detail

validateNonNullIndex

protected ActionRequestValidationException validateNonNullIndex()

Returns:

a validation exception if the index property hasn't been set

index

@Nullable
public String index()

Returns:

The concrete index this request is targeted for or null if index is optional. Whether index property is optional depends on the concrete implementation. If index property is required the concrete implementation should use validateNonNullIndex() to check if the index property has been set

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

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Overrides:

writeTo in class ActionRequest<T extends SingleShardRequest>

Throws:

IOException