Module org.elasticsearch.server
Class IndicesShardStoresRequest
java.lang.Object
org.elasticsearch.transport.TransportMessage
org.elasticsearch.transport.TransportRequest
org.elasticsearch.action.ActionRequest
org.elasticsearch.action.support.master.MasterNodeRequest<Request>
org.elasticsearch.action.support.master.MasterNodeReadRequest<IndicesShardStoresRequest>
org.elasticsearch.action.admin.indices.shards.IndicesShardStoresRequest
- All Implemented Interfaces:
IndicesRequest
,IndicesRequest.Replaceable
,Writeable
,RefCounted
,TaskAwareRequest
public class IndicesShardStoresRequest
extends MasterNodeReadRequest<IndicesShardStoresRequest>
implements IndicesRequest.Replaceable
Request for
TransportIndicesShardStoresAction
-
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 inherited from class org.elasticsearch.action.support.master.MasterNodeReadRequest
local
Fields inherited from class org.elasticsearch.action.support.master.MasterNodeRequest
DEFAULT_MASTER_NODE_TIMEOUT, masterNodeTimeout
Fields inherited from interface org.elasticsearch.core.RefCounted
ALWAYS_REFERENCED
-
Constructor Summary
ConstructorDescriptionIndicesShardStoresRequest
(String... indices) Create a request for shard stores info forindices
-
Method Summary
Modifier and TypeMethodDescriptionReturns the task object that should be used to keep track of the processing of the request.boolean
Determines whether the request should be applied to data streams.String[]
indices()
Returns the array of indices that the action relates toSets the indices for the shard stores requestReturns the indices options used to resolve indices.indicesOptions
(IndicesOptions indicesOptions) Specifies what type of requested indices to ignore and wildcard indices expressions By default, expands wildcards to both open and closed indicesint
void
maxConcurrentShardRequests
(int maxConcurrentShardRequests) Returns the shard criteria to get store information onshardStatuses
(String... shardStatuses) Set statuses to filter shards to get stores info on.validate()
void
writeTo
(StreamOutput out) Write this into the StreamOutput.Methods inherited from class org.elasticsearch.action.support.master.MasterNodeReadRequest
local, local
Methods inherited from class org.elasticsearch.action.support.master.MasterNodeRequest
masterNodeTimeout, masterNodeTimeout, masterNodeTimeout
Methods inherited from class org.elasticsearch.action.ActionRequest
getShouldStoreResult
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.Replaceable
allowsRemoteIndices
Methods inherited from interface org.elasticsearch.core.RefCounted
mustIncRef
Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest
getDescription, setParentTask
-
Constructor Details
-
IndicesShardStoresRequest
Create a request for shard stores info forindices
-
IndicesShardStoresRequest
public IndicesShardStoresRequest() -
IndicesShardStoresRequest
- Throws:
IOException
-
-
Method Details
-
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput.- Specified by:
writeTo
in interfaceWriteable
- Overrides:
writeTo
in classMasterNodeReadRequest<IndicesShardStoresRequest>
- Throws:
IOException
-
shardStatuses
Set statuses to filter shards to get stores info on. seeClusterHealthStatus
for details. Defaults to "yellow" and "red" status- Parameters:
shardStatuses
- acceptable values are "green", "yellow", "red" and "all"
-
indicesOptions
Specifies what type of requested indices to ignore and wildcard indices expressions By default, expands wildcards to both open and closed indices -
indices
Sets the indices for the shard stores request- Specified by:
indices
in interfaceIndicesRequest.Replaceable
-
includeDataStreams
public boolean includeDataStreams()Description copied from interface:IndicesRequest
Determines whether the request should be applied to data streams. Whenfalse
, none of the names or wildcard expressions inIndicesRequest.indices()
should be applied to or expanded to any data streams. All layers involved in the request's fulfillment including security, name resolution, etc., should respect this flag.- Specified by:
includeDataStreams
in interfaceIndicesRequest
-
shardStatuses
Returns the shard criteria to get store information on -
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
-
maxConcurrentShardRequests
public void maxConcurrentShardRequests(int maxConcurrentShardRequests) -
maxConcurrentShardRequests
public int maxConcurrentShardRequests() -
validate
- Specified by:
validate
in classActionRequest
-
createTask
public Task createTask(long id, String type, String action, TaskId parentTaskId, Map<String, String> headers) Description copied from interface:TaskAwareRequest
Returns the task object that should be used to keep track of the processing of the request.- Specified by:
createTask
in interfaceTaskAwareRequest
-