Module org.elasticsearch.server
Class IndicesShardStoresRequest
java.lang.Object
org.elasticsearch.transport.TransportMessage
org.elasticsearch.transport.TransportRequest
org.elasticsearch.action.ActionRequest
org.elasticsearch.action.LegacyActionRequest
org.elasticsearch.action.support.master.MasterNodeRequest<IndicesShardStoresRequest>
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 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
Fields inherited from class org.elasticsearch.action.support.master.MasterNodeReadRequest
localFields inherited from class org.elasticsearch.action.support.master.MasterNodeRequest
TRAPPY_IMPLICIT_DEFAULT_MASTER_NODE_TIMEOUTFields inherited from interface org.elasticsearch.core.RefCounted
ALWAYS_REFERENCED -
Constructor Summary
ConstructorsConstructorDescriptionIndicesShardStoresRequest(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.booleanDetermines 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 indicesintvoidmaxConcurrentShardRequests(int maxConcurrentShardRequests) Returns the shard criteria to get store information onshardStatuses(String... shardStatuses) Set statuses to filter shards to get stores info on.validate()voidwriteTo(StreamOutput out) Write this into the StreamOutput.Methods inherited from class org.elasticsearch.action.support.master.MasterNodeReadRequest
local, localMethods inherited from class org.elasticsearch.action.support.master.MasterNodeRequest
infiniteMasterNodeTimeout, masterNodeTimeout, masterNodeTimeout, masterTermMethods inherited from class org.elasticsearch.action.ActionRequest
getShouldStoreResultMethods inherited from class org.elasticsearch.transport.TransportRequest
getParentTask, getRequestId, setParentTask, setRequestId, toStringMethods inherited from class org.elasticsearch.transport.TransportMessage
decRef, hasReferences, incRef, remoteAddress, remoteAddress, tryIncRefMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface org.elasticsearch.action.IndicesRequest.Replaceable
allowsRemoteIndicesMethods inherited from interface org.elasticsearch.core.RefCounted
mustIncRefMethods 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:WriteableWrite this into the StreamOutput.- Specified by:
writeToin interfaceWriteable- Overrides:
writeToin classMasterNodeReadRequest<IndicesShardStoresRequest>- Throws:
IOException
-
shardStatuses
Set statuses to filter shards to get stores info on. seeClusterHealthStatusfor 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:
indicesin interfaceIndicesRequest.Replaceable
-
includeDataStreams
public boolean includeDataStreams()Description copied from interface:IndicesRequestDetermines 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:
includeDataStreamsin interfaceIndicesRequest
-
shardStatuses
Returns the shard criteria to get store information on -
indices
Description copied from interface:IndicesRequestReturns the array of indices that the action relates to- Specified by:
indicesin interfaceIndicesRequest
-
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
-
maxConcurrentShardRequests
public void maxConcurrentShardRequests(int maxConcurrentShardRequests) -
maxConcurrentShardRequests
public int maxConcurrentShardRequests() -
validate
- Specified by:
validatein classActionRequest
-
createTask
public Task createTask(long id, String type, String action, TaskId parentTaskId, Map<String, String> headers) Description copied from interface:TaskAwareRequestReturns the task object that should be used to keep track of the processing of the request.- Specified by:
createTaskin interfaceTaskAwareRequest
-