org.elasticsearch.action.support.single.instance

Class InstanceShardOperationRequest<T extends InstanceShardOperationRequest>

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.instance.InstanceShardOperationRequest<T>

All Implemented Interfaces:

IndicesRequest, HasContext, HasContextAndHeaders, HasHeaders, Streamable

Direct Known Subclasses:

UpdateRequest

public abstract class InstanceShardOperationRequest<T extends InstanceShardOperationRequest>
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
static TimeValue	DEFAULT_TIMEOUT
protected String	index
protected int	shardId
protected TimeValue	timeout

Fields inherited from class org.elasticsearch.common.ContextAndHeaderHolder

headers

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	InstanceShardOperationRequest()
	InstanceShardOperationRequest(String index)

Method Summary

Modifier and Type	Method and Description
String	concreteIndex()
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.
void	readFrom(StreamInput in)
TimeValue	timeout()
T	timeout(String timeout) A timeout to wait if the index operation can't be performed immediately.
T	timeout(TimeValue timeout) A timeout to wait if the index operation can't be performed immediately.
ActionRequestValidationException	validate()
void	writeTo(StreamOutput out)

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

DEFAULT_TIMEOUT

public static final TimeValue DEFAULT_TIMEOUT

timeout

protected TimeValue timeout

index

protected String index

shardId

protected int shardId

Constructor Detail

InstanceShardOperationRequest

protected InstanceShardOperationRequest()

InstanceShardOperationRequest

public InstanceShardOperationRequest(String index)

Method Detail

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest<T extends InstanceShardOperationRequest>

index

public String 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

index

public final T index(String index)

timeout

public TimeValue timeout()

timeout

public final T timeout(TimeValue timeout)

A timeout to wait if the index operation can't be performed immediately. Defaults to 1m.

timeout

public final T timeout(String timeout)

A timeout to wait if the index operation can't be performed immediately. Defaults to 1m.

concreteIndex

public String concreteIndex()

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class ActionRequest<T extends InstanceShardOperationRequest>

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Overrides:

writeTo in class ActionRequest<T extends InstanceShardOperationRequest>

Throws:

IOException