org.elasticsearch.action.admin.cluster.allocation

Class ClusterAllocationExplainRequest

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest

org.elasticsearch.action.support.master.MasterNodeRequest<ClusterAllocationExplainRequest>

org.elasticsearch.action.admin.cluster.allocation.ClusterAllocationExplainRequest

All Implemented Interfaces:

Streamable, TaskAwareRequest

public class ClusterAllocationExplainRequest
extends MasterNodeRequest<ClusterAllocationExplainRequest>

A request to explain the allocation of a shard in the cluster

Nested Class Summary

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

TransportRequest.Empty

Field Summary

Fields inherited from class org.elasticsearch.action.support.master.MasterNodeRequest

DEFAULT_MASTER_NODE_TIMEOUT, masterNodeTimeout

Constructor Summary

Constructors

Constructor and Description
ClusterAllocationExplainRequest() Create a new allocation explain request to explain any unassigned shard in the cluster.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCurrentNode() Returns the node holding the replica shard to be explained.
java.lang.String	getIndex() Returns the index name of the shard to explain, or null to use any unassigned shard (see useAnyUnassignedShard()).
java.lang.Integer	getShard() Returns the shard id of the shard to explain, or null to use any unassigned shard (see useAnyUnassignedShard()).
boolean	includeDiskInfo() Returns true if information about disk usage and shard sizes should also be returned.
void	includeDiskInfo(boolean includeDiskInfo) Set to true to include information about the gathered disk information of nodes in the cluster.
boolean	includeYesDecisions() Returns true if yes decisions should be included.
void	includeYesDecisions(boolean includeYesDecisions) Set to true to include yes decisions for a particular node.
java.lang.Boolean	isPrimary() Returns true if explaining the primary shard for the shard id (see getShard()), false if explaining a replica shard copy for the shard id, or null to use any unassigned shard (see useAnyUnassignedShard()).
static ClusterAllocationExplainRequest	parse(XContentParser parser)
void	readFrom(StreamInput in) Set this object's fields from a StreamInput.
ClusterAllocationExplainRequest	setCurrentNode(java.lang.String currentNodeId) Requests the explain API to explain an already assigned replica shard currently allocated to the given node.
ClusterAllocationExplainRequest	setIndex(java.lang.String index) Sets the index name of the shard to explain.
ClusterAllocationExplainRequest	setPrimary(java.lang.Boolean primary) Sets whether to explain the allocation of the primary shard or a replica shard copy for the shard id (see getShard()).
ClusterAllocationExplainRequest	setShard(java.lang.Integer shard) Sets the shard id of the shard to explain.
java.lang.String	toString()
boolean	useAnyUnassignedShard() Returns true iff the first unassigned shard is to be used
ActionRequestValidationException	validate()
void	writeTo(StreamOutput out) Write this object's fields to a StreamOutput.

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

Methods inherited from class org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

createTask, getDescription, setParentTask

Constructor Detail

ClusterAllocationExplainRequest

public ClusterAllocationExplainRequest()

Create a new allocation explain request to explain any unassigned shard in the cluster.

Method Detail

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest

useAnyUnassignedShard

public boolean useAnyUnassignedShard()

Returns true iff the first unassigned shard is to be used

setIndex

public ClusterAllocationExplainRequest setIndex(java.lang.String index)

Sets the index name of the shard to explain.

getIndex

@Nullable
public java.lang.String getIndex()

Returns the index name of the shard to explain, or null to use any unassigned shard (see useAnyUnassignedShard()).

setShard

public ClusterAllocationExplainRequest setShard(java.lang.Integer shard)

Sets the shard id of the shard to explain.

getShard

@Nullable
public java.lang.Integer getShard()

Returns the shard id of the shard to explain, or null to use any unassigned shard (see useAnyUnassignedShard()).

setPrimary

public ClusterAllocationExplainRequest setPrimary(java.lang.Boolean primary)

Sets whether to explain the allocation of the primary shard or a replica shard copy for the shard id (see getShard()).

isPrimary

@Nullable
public java.lang.Boolean isPrimary()

Returns true if explaining the primary shard for the shard id (see getShard()), false if explaining a replica shard copy for the shard id, or null to use any unassigned shard (see useAnyUnassignedShard()).

setCurrentNode

public ClusterAllocationExplainRequest setCurrentNode(java.lang.String currentNodeId)

Requests the explain API to explain an already assigned replica shard currently allocated to the given node.

getCurrentNode

@Nullable
public java.lang.String getCurrentNode()

Returns the node holding the replica shard to be explained. Returns null if any replica shard can be explained.

includeYesDecisions

public void includeYesDecisions(boolean includeYesDecisions)

Set to true to include yes decisions for a particular node.

includeYesDecisions

public boolean includeYesDecisions()

Returns true if yes decisions should be included. Otherwise only "no" and "throttle" decisions are returned.

includeDiskInfo

public void includeDiskInfo(boolean includeDiskInfo)

Set to true to include information about the gathered disk information of nodes in the cluster.

includeDiskInfo

public boolean includeDiskInfo()

Returns true if information about disk usage and shard sizes should also be returned.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

parse

public static ClusterAllocationExplainRequest parse(XContentParser parser)
                                             throws java.io.IOException

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

Throws:

java.io.IOException

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

Overrides:

writeTo in class MasterNodeRequest<ClusterAllocationExplainRequest>

Throws:

java.io.IOException