IndicesRequest
, Streamable
, Writeable
, TaskAwareRequest
AnalyzeRequest
, ExplainRequest
, FieldCapabilitiesIndexRequest
, GetFieldMappingsIndexRequest
, GetRequest
, MultiGetShardRequest
, MultiTermVectorsShardRequest
, TermVectorsRequest
public abstract class SingleShardRequest<Request extends SingleShardRequest<Request>> extends ActionRequest implements IndicesRequest
IndicesRequest.Replaceable
TransportRequest.Empty
Writeable.Reader<V>, Writeable.Writer<V>
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 |
Modifier | Constructor | Description |
---|---|---|
|
SingleShardRequest() |
|
protected |
SingleShardRequest(java.lang.String index) |
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.
|
void |
readFrom(StreamInput in) |
Set this object's fields from a StreamInput.
|
protected ActionRequestValidationException |
validateNonNullIndex() |
|
void |
writeTo(StreamOutput out) |
Write this object's fields to a StreamOutput.
|
getShouldStoreResult, validate
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
createTask, getDescription, setParentTask
remoteAddress, remoteAddress
getParentTask, setParentTask
public static final IndicesOptions INDICES_OPTIONS
@Nullable protected java.lang.String index
validateNonNullIndex()
to check if the index property has been setpublic SingleShardRequest()
protected SingleShardRequest(java.lang.String index)
protected ActionRequestValidationException validateNonNullIndex()
@Nullable public java.lang.String index()
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 setpublic final Request index(java.lang.String index)
public java.lang.String[] indices()
IndicesRequest
indices
in interface IndicesRequest
public IndicesOptions indicesOptions()
IndicesRequest
indicesOptions
in interface IndicesRequest
public void readFrom(StreamInput in) throws java.io.IOException
Streamable
readFrom
in interface Streamable
readFrom
in class ActionRequest
java.io.IOException
public void writeTo(StreamOutput out) throws java.io.IOException
Streamable
writeTo
in interface Streamable
writeTo
in interface Writeable
writeTo
in class ActionRequest
java.io.IOException