Package org.elasticsearch.action.support.single.shard

Class SingleShardRequest<Request extends SingleShardRequest<Request>>

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest

org.elasticsearch.action.support.single.shard.SingleShardRequest<Request>

All Implemented Interfaces:

IndicesRequest, Streamable, Writeable, TaskAwareRequest

Direct Known Subclasses:

AnalyzeAction.Request, ExplainRequest, FieldCapabilitiesIndexRequest, GetFieldMappingsIndexRequest, GetRequest, MultiGetShardRequest, MultiTermVectorsShardRequest, RetentionLeaseActions.AddRequest, RetentionLeaseActions.RemoveRequest, RetentionLeaseActions.RenewRequest, TermVectorsRequest

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

Constructor Summary

Constructors

Modifier	Constructor	Description
	SingleShardRequest()
protected	SingleShardRequest(java.lang.String index)
	SingleShardRequest(StreamInput in)

Method Summary

Modifier and Type	Method	Description
java.lang.String	index()
Request	index(java.lang.String index)	Sets the index.
java.lang.String[]	indices()	Returns the array of indices that the action relates to
IndicesOptions	indicesOptions()	Returns the indices options used to resolve indices.
protected ActionRequestValidationException	validateNonNullIndex()
void	writeTo(StreamOutput out)	Write this object's fields to a StreamOutput.

Methods inherited from class org.elasticsearch.action.ActionRequest

getShouldStoreResult, readFrom, validate

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

INDICES_OPTIONS

public static final IndicesOptions INDICES_OPTIONS

index

@Nullable
protected java.lang.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

public SingleShardRequest(StreamInput in)
                   throws java.io.IOException

Throws:

java.io.IOException

SingleShardRequest

protected SingleShardRequest(java.lang.String index)

Method Detail

validateNonNullIndex

protected ActionRequestValidationException validateNonNullIndex()

Returns:

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

index

@Nullable
public java.lang.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 Request index(java.lang.String index)

Sets the index.

indices

public java.lang.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

writeTo

public void writeTo(StreamOutput out)
             throws java.io.IOException

Description copied from interface: Streamable

Write this object's fields to a StreamOutput.

Specified by:

writeTo in interface Streamable

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class ActionRequest

Throws:

java.io.IOException