public abstract class SingleShardRequest<Request extends SingleShardRequest<Request>> extends ActionRequest implements IndicesRequest
TransportRequest.Empty
IndicesRequest.Replaceable
Modifier and Type | Field and 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 and Description |
---|---|
|
SingleShardRequest() |
protected |
SingleShardRequest(java.lang.String index) |
Modifier and Type | Method and 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.
|
boolean |
operationThreaded()
Controls if the operation will be executed on a separate thread when executed locally.
|
Request |
operationThreaded(boolean threadedOperation)
Controls if the operation will be executed on a separate thread when executed locally.
|
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
getParentTask, setParentTask
remoteAddress, remoteAddress
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
createTask, getDescription, 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 boolean operationThreaded()
public final Request operationThreaded(boolean threadedOperation)
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 class ActionRequest
java.io.IOException