Module org.elasticsearch.server
Class SingleShardRequest<Request extends SingleShardRequest<Request>>
java.lang.Object
org.elasticsearch.transport.TransportMessage
org.elasticsearch.transport.AbstractTransportRequest
org.elasticsearch.action.ActionRequest
org.elasticsearch.action.LegacyActionRequest
org.elasticsearch.action.support.single.shard.SingleShardRequest<Request>
- All Implemented Interfaces:
IndicesRequest,IndicesRequest.RemoteClusterShardRequest,Writeable,RefCounted,TaskAwareRequest,TransportRequest
- Direct Known Subclasses:
AnalyzeAction.Request,EnsureDocsSearchableAction.EnsureDocsSearchableRequest,ExplainRequest,GetFieldMappingsIndexRequest,GetRequest,MultiGetShardRequest,MultiTermVectorsShardRequest,RetentionLeaseActions.AddRequest,RetentionLeaseActions.RemoveRequest,RetentionLeaseActions.RenewRequest,TermVectorsRequest
public abstract class SingleShardRequest<Request extends SingleShardRequest<Request>>
extends LegacyActionRequest
implements IndicesRequest.RemoteClusterShardRequest
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.elasticsearch.action.IndicesRequest
IndicesRequest.RemoteClusterShardRequest, IndicesRequest.Replaceable, IndicesRequest.SingleIndexNoWildcardsNested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V> -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected StringThe concrete index namestatic final IndicesOptionsFields inherited from interface org.elasticsearch.core.RefCounted
ALWAYS_REFERENCED -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionindex()final RequestSets the index.String[]indices()Returns the array of indices that the action relates toReturns the indices options used to resolve indices.shards()Returns the shards this action is targeting directly, which may not obviously align with the indices returned byindices().protected ActionRequestValidationExceptionvoidwriteTo(StreamOutput out) Write this into the StreamOutput.Methods inherited from class org.elasticsearch.action.ActionRequest
getShouldStoreResult, validateMethods inherited from class org.elasticsearch.transport.AbstractTransportRequest
getParentTask, getRequestId, remoteAddress, remoteAddress, setParentTask, setRequestId, toStringMethods inherited from class org.elasticsearch.transport.TransportMessage
decRef, hasReferences, incRef, tryIncRefMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface org.elasticsearch.action.IndicesRequest
includeDataStreamsMethods inherited from interface org.elasticsearch.core.RefCounted
decRef, hasReferences, incRef, mustIncRef, tryIncRefMethods inherited from interface org.elasticsearch.tasks.TaskAwareRequest
createTask, createTask, getDescription, setParentTask
-
Field Details
-
INDICES_OPTIONS
-
index
The concrete index nameWhether 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
- Throws:
IOException
-
SingleShardRequest
-
-
Method Details
-
validateNonNullIndex
- Returns:
- a validation exception if the index property hasn't been set
-
index
- Returns:
- The concrete index this request is targeted for or
nullif index is optional. Whether index property is optional depends on the concrete implementation. If index property is required the concrete implementation should usevalidateNonNullIndex()to check if the index property has been set
-
index
Sets the index. -
indices
Description copied from interface:IndicesRequestReturns the array of indices that the action relates to- Specified by:
indicesin interfaceIndicesRequest
-
shards
Description copied from interface:IndicesRequest.RemoteClusterShardRequestReturns the shards this action is targeting directly, which may not obviously align with the indices returned byindices(). 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:
shardsin interfaceIndicesRequest.RemoteClusterShardRequest
-
indicesOptions
Description copied from interface:IndicesRequestReturns 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:
indicesOptionsin interfaceIndicesRequest
-
writeTo
Description copied from interface:WriteableWrite this into the StreamOutput.- Specified by:
writeToin interfaceWriteable- Overrides:
writeToin classActionRequest- Throws:
IOException
-