Package org.elasticsearch.action.support.single.instance

Class InstanceShardOperationRequest<Request extends InstanceShardOperationRequest<Request>>

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest

org.elasticsearch.action.support.single.instance.InstanceShardOperationRequest<Request>

All Implemented Interfaces:

IndicesRequest, Writeable, TaskAwareRequest

Direct Known Subclasses:

UpdateRequest

public abstract class InstanceShardOperationRequest<Request extends InstanceShardOperationRequest<Request>>
extends ActionRequest
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

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static TimeValue	DEFAULT_TIMEOUT
protected String	index
protected ShardId	shardId
protected TimeValue	timeout

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	InstanceShardOperationRequest()
	InstanceShardOperationRequest(String index)
protected	InstanceShardOperationRequest(StreamInput in)

Method Summary

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

Methods inherited from class org.elasticsearch.action.ActionRequest

getShouldStoreResult

Methods inherited from class org.elasticsearch.transport.TransportRequest

getParentTask, setParentTask

Methods inherited from class org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

createTask, getDescription, setParentTask

Field Detail

DEFAULT_TIMEOUT

public static final TimeValue DEFAULT_TIMEOUT

timeout

protected TimeValue timeout

index

protected String index

shardId

protected ShardId shardId

Constructor Detail

InstanceShardOperationRequest

protected InstanceShardOperationRequest()

InstanceShardOperationRequest

protected InstanceShardOperationRequest(StreamInput in)
                                 throws IOException

Throws:

IOException

InstanceShardOperationRequest

public InstanceShardOperationRequest(String index)

Method Detail

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest

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 Request index(String index)

timeout

public TimeValue timeout()

timeout

public final Request timeout(TimeValue timeout)

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

timeout

public final Request timeout(String timeout)

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

concreteIndex

public String concreteIndex()

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class ActionRequest

Throws:

IOException