Module org.elasticsearch.server

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, IndicesRequest.RemoteClusterShardRequest, Writeable, RefCounted, TaskAwareRequest

Direct Known Subclasses:

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

public abstract class SingleShardRequest<Request extends SingleShardRequest<Request>>
extends ActionRequest
implements IndicesRequest.RemoteClusterShardRequest

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.RemoteClusterShardRequest, 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 String	index	The concrete index name Whether index property is optional depends on the concrete implementation.
static final IndicesOptions	INDICES_OPTIONS

Fields inherited from interface org.elasticsearch.core.RefCounted

ALWAYS_REFERENCED

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
String	index()
final Request	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.
List<ShardId>	shards()	Returns the shards this action is targeting directly, which may not obviously align with the indices returned by indices().
protected ActionRequestValidationException	validateNonNullIndex()
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class org.elasticsearch.action.ActionRequest

getShouldStoreResult, validate

Methods inherited from class org.elasticsearch.transport.TransportRequest

getParentTask, getRequestId, setParentTask, setRequestId, toString

Methods inherited from class org.elasticsearch.transport.TransportMessage

decRef, hasReferences, incRef, remoteAddress, remoteAddress, tryIncRef

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.action.IndicesRequest

includeDataStreams

Methods inherited from interface org.elasticsearch.core.RefCounted

mustIncRef

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

createTask, getDescription, setParentTask

Field Details

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 Details

SingleShardRequest

public SingleShardRequest()

SingleShardRequest

public SingleShardRequest(StreamInput in)
                   throws IOException

Throws:

IOException

SingleShardRequest

protected SingleShardRequest(String index)

Method Details

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

shards

public List<ShardId> shards()

Description copied from interface: IndicesRequest.RemoteClusterShardRequest

Returns the shards this action is targeting directly, which may not obviously align with the indices returned by indices(). This is mostly used by requests which fan out to a number of shards for the those fan-out requests. A default is intentionally not provided for this method. It is critical that this method be implemented correctly for all remote cluster requests,

Specified by:

shards in interface IndicesRequest.RemoteClusterShardRequest

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 IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class ActionRequest

Throws:

IOException