org.elasticsearch.action.support.single.custom

Class SingleCustomOperationRequest<T extends SingleCustomOperationRequest>

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.custom.SingleCustomOperationRequest<T>

All Implemented Interfaces:

IndicesRequest, HasContext, HasContextAndHeaders, HasHeaders, Streamable

Direct Known Subclasses:

AnalyzeRequest

public abstract class SingleCustomOperationRequest<T extends SingleCustomOperationRequest>
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 inherited from class org.elasticsearch.common.ContextAndHeaderHolder

headers

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SingleCustomOperationRequest()
protected	SingleCustomOperationRequest(ActionRequest request)

Method Summary

Modifier and Type	Method and Description
void	beforeLocalFork()
String	index()
T	index(String 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.
T	preferLocal(boolean preferLocal) if this operation hits a node with a local relevant shard, should it be preferred to be executed on, or just do plain round robin.
boolean	preferLocalShard() if this operation hits a node with a local relevant shard, should it be preferred to be executed on, or just do plain round robin.
void	readFrom(StreamInput in)
protected void	readIndex(StreamInput in)
ActionRequestValidationException	validate()
protected void	writeIndex(StreamOutput out)
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

Constructor Detail

SingleCustomOperationRequest

protected SingleCustomOperationRequest()

SingleCustomOperationRequest

protected SingleCustomOperationRequest(ActionRequest request)

Method Detail

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest<T extends SingleCustomOperationRequest>

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.

preferLocal

public final T preferLocal(boolean preferLocal)

if this operation hits a node with a local relevant shard, should it be preferred to be executed on, or just do plain round robin. Defaults to true

index

public T index(String index)

index

public String index()

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

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

preferLocalShard

public boolean preferLocalShard()

if this operation hits a node with a local relevant shard, should it be preferred to be executed on, or just do plain round robin. Defaults to true

beforeLocalFork

public void beforeLocalFork()

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class ActionRequest<T extends SingleCustomOperationRequest>

Throws:

IOException

readIndex

protected void readIndex(StreamInput in)
                  throws IOException

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Overrides:

writeTo in class ActionRequest<T extends SingleCustomOperationRequest>

Throws:

IOException

writeIndex

protected void writeIndex(StreamOutput out)
                   throws IOException

Throws:

IOException