Package org.elasticsearch.action.admin.indices.shards

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 IndicesShardStoresAction

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 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

Constructor Summary

Constructors

Constructor	Description
IndicesShardStoresRequest()
IndicesShardStoresRequest(String... indices)	Create a request for shard stores info for indices
IndicesShardStoresRequest(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	includeDataStreams()	Determines whether the request should be applied to data streams.
String[]	indices()	Returns the array of indices that the action relates to
IndicesShardStoresRequest	indices(String... indices)	Sets the indices for the shard stores request
IndicesOptions	indicesOptions()	Returns the indices options used to resolve indices.
IndicesShardStoresRequest	indicesOptions(IndicesOptions indicesOptions)	Specifies what type of requested indices to ignore and wildcard indices expressions By default, expands wildcards to both open and closed indices
EnumSet<ClusterHealthStatus>	shardStatuses()	Returns the shard criteria to get store information on
IndicesShardStoresRequest	shardStatuses(String... shardStatuses)	Set statuses to filter shards to get stores info on.
ActionRequestValidationException	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, setParentTask, 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.tasks.TaskAwareRequest

createTask, getDescription, setParentTask

Constructor Details

IndicesShardStoresRequest

public IndicesShardStoresRequest(String... indices)

Create a request for shard stores info for indices

IndicesShardStoresRequest

public IndicesShardStoresRequest()

IndicesShardStoresRequest

public IndicesShardStoresRequest(StreamInput in)
                          throws IOException

Throws:

IOException

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class MasterNodeReadRequest<IndicesShardStoresRequest>

Throws:

IOException

shardStatuses

public IndicesShardStoresRequest shardStatuses(String... shardStatuses)

Set statuses to filter shards to get stores info on. see ClusterHealthStatus for details. Defaults to "yellow" and "red" status

Parameters:

shardStatuses - acceptable values are "green", "yellow", "red" and "all"

indicesOptions

public IndicesShardStoresRequest indicesOptions(IndicesOptions indicesOptions)

Specifies what type of requested indices to ignore and wildcard indices expressions By default, expands wildcards to both open and closed indices

indices

public IndicesShardStoresRequest indices(String... indices)

Sets the indices for the shard stores request

Specified by:

indices in interface IndicesRequest.Replaceable

includeDataStreams

public boolean includeDataStreams()

Description copied from interface: IndicesRequest

Determines whether the request should be applied to data streams. When false, none of the names or wildcard expressions in IndicesRequest.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 interface IndicesRequest

shardStatuses

public EnumSet<ClusterHealthStatus> shardStatuses()

Returns the shard criteria to get store information on

indices

public String[] indices()

Description copied from interface: IndicesRequest

Returns the array of indices that the action relates to

Specified by:

indices in interface IndicesRequest

indicesOptions

public IndicesOptions 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 interface IndicesRequest

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest