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, Streamable, Writeable, TaskAwareRequest

public class IndicesShardStoresRequest
extends MasterNodeReadRequest<IndicesShardStoresRequest>
implements IndicesRequest.Replaceable

Request for IndicesShardStoresAction

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.action.IndicesRequest

IndicesRequest.Replaceable

Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportRequest

TransportRequest.Empty

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(java.lang.String... indices)	Create a request for shard stores info for indices

Method Summary

Modifier and Type	Method	Description
java.lang.String[]	indices()	Returns the array of indices that the action relates to
IndicesShardStoresRequest	indices(java.lang.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
void	readFrom(StreamInput in)	Set this object's fields from a StreamInput.
java.util.EnumSet<ClusterHealthStatus>	shardStatuses()	Returns the shard criteria to get store information on
IndicesShardStoresRequest	shardStatuses(java.lang.String... shardStatuses)	Set statuses to filter shards to get stores info on.
ActionRequestValidationException	validate()
void	writeTo(StreamOutput out)	Write this object's fields to a StreamOutput.

Methods inherited from class org.elasticsearch.action.ActionRequest

getShouldStoreResult

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 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.elasticsearch.common.io.stream.Streamable

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

createTask, getDescription, setParentTask

Methods inherited from class org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class org.elasticsearch.transport.TransportRequest

getParentTask, setParentTask

Constructor Detail

IndicesShardStoresRequest

public IndicesShardStoresRequest(java.lang.String... indices)

Create a request for shard stores info for indices

IndicesShardStoresRequest

public IndicesShardStoresRequest()

Method Detail

shardStatuses

public IndicesShardStoresRequest shardStatuses(java.lang.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(java.lang.String... indices)

Sets the indices for the shard stores request

Specified by:

indices in interface IndicesRequest.Replaceable

shardStatuses

public java.util.EnumSet<ClusterHealthStatus> shardStatuses()

Returns the shard criteria to get store information on

indices

public java.lang.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

writeTo

public void writeTo(StreamOutput out)
             throws java.io.IOException

Description copied from interface: Streamable

Write this object's fields to a StreamOutput.

Specified by:

writeTo in interface Streamable

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class MasterNodeReadRequest<IndicesShardStoresRequest>

Throws:

java.io.IOException

readFrom

public void readFrom(StreamInput in)
              throws java.io.IOException

Description copied from interface: Streamable

Set this object's fields from a StreamInput.

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class MasterNodeReadRequest<IndicesShardStoresRequest>

Throws:

java.io.IOException