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

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() Explain the first unassigned shard
ClusterAllocationExplainRequest(java.lang.String index, int shard, boolean primary) Create a new allocation explain request.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getIndex()
java.lang.Integer	getShard()
boolean	includeDiskInfo() Returns true if information about disk usage and shard sizes should also be returned
void	includeDiskInfo(boolean includeDiskInfo) true to include information about the gathered disk information of nodes in the cluster
boolean	includeYesDecisions() Returns true if all decisions should be included.
void	includeYesDecisions(boolean includeYesDecisions)
java.lang.Boolean	isPrimary()
static ClusterAllocationExplainRequest	parse(XContentParser parser)
void	readFrom(StreamInput in) Set this object's fields from a StreamInput.
ClusterAllocationExplainRequest	setIndex(java.lang.String index)
ClusterAllocationExplainRequest	setPrimary(java.lang.Boolean primary)
ClusterAllocationExplainRequest	setShard(java.lang.Integer shard)
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

createTask, getDescription, getParentTask, setParentTask, 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

Constructor Detail

ClusterAllocationExplainRequest

public ClusterAllocationExplainRequest()

Explain the first unassigned shard

ClusterAllocationExplainRequest

public ClusterAllocationExplainRequest(java.lang.String index,
                                       int shard,
                                       boolean primary)

Create a new allocation explain request. If primary is false, the first unassigned replica will be picked for explanation. If no replicas are unassigned, the first assigned replica will be explained.

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)

getIndex

@Nullable
public java.lang.String getIndex()

setShard

public ClusterAllocationExplainRequest setShard(java.lang.Integer shard)

getShard

@Nullable
public java.lang.Integer getShard()

setPrimary

public ClusterAllocationExplainRequest setPrimary(java.lang.Boolean primary)

isPrimary

@Nullable
public java.lang.Boolean isPrimary()

includeYesDecisions

public void includeYesDecisions(boolean includeYesDecisions)

includeYesDecisions

public boolean includeYesDecisions()

Returns true if all decisions should be included. Otherwise only "NO" and "THROTTLE" decisions are returned

includeDiskInfo

public void includeDiskInfo(boolean includeDiskInfo)

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