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
,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 toIndicesOptions
indicesOptions()
Returns the indices options used to resolve indices.protected ActionRequestValidationException
validateNonNullIndex()
void
writeTo(StreamOutput out)
Write this into the StreamOutput.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 Details
-
INDICES_OPTIONS
-
index
The concrete index name 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
-
-
Constructor Details
-
SingleShardRequest
public SingleShardRequest() -
SingleShardRequest
- Throws:
java.io.IOException
-
SingleShardRequest
protected SingleShardRequest(java.lang.String index)
-
-
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
null
if 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
public java.lang.String[] indices()Description copied from interface:IndicesRequest
Returns the array of indices that the action relates to- Specified by:
indices
in interfaceIndicesRequest
-
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 interfaceIndicesRequest
-
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput.- Specified by:
writeTo
in interfaceWriteable
- Overrides:
writeTo
in classActionRequest
- Throws:
java.io.IOException
-