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:
Writeable
,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
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.MasterNodeRequest
DEFAULT_MASTER_NODE_TIMEOUT, masterNodeTimeout
-
Constructor Summary
Constructors Constructor Description ClusterAllocationExplainRequest()
Create a new allocation explain request to explain any unassigned shard in the cluster.ClusterAllocationExplainRequest(StreamInput in)
-
Method Summary
Modifier and Type Method 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, ornull
to use any unassigned shard (seeuseAnyUnassignedShard()
).java.lang.Integer
getShard()
Returns the shard id of the shard to explain, ornull
to use any unassigned shard (seeuseAnyUnassignedShard()
).boolean
includeDiskInfo()
Returnstrue
if information about disk usage and shard sizes should also be returned.void
includeDiskInfo(boolean includeDiskInfo)
Set totrue
to include information about the gathered disk information of nodes in the cluster.boolean
includeYesDecisions()
Returnstrue
if yes decisions should be included.void
includeYesDecisions(boolean includeYesDecisions)
Set totrue
to include yes decisions for a particular node.java.lang.Boolean
isPrimary()
Returnstrue
if explaining the primary shard for the shard id (seegetShard()
),false
if explaining a replica shard copy for the shard id, ornull
to use any unassigned shard (seeuseAnyUnassignedShard()
).static ClusterAllocationExplainRequest
parse(org.elasticsearch.common.xcontent.XContentParser parser)
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 (seegetShard()
).ClusterAllocationExplainRequest
setShard(java.lang.Integer shard)
Sets the shard id of the shard to explain.java.lang.String
toString()
boolean
useAnyUnassignedShard()
Returnstrue
iff the first unassigned shard is to be usedActionRequestValidationException
validate()
void
writeTo(StreamOutput out)
Write this into the StreamOutput.Methods inherited from class org.elasticsearch.action.support.master.MasterNodeRequest
masterNodeTimeout, masterNodeTimeout, masterNodeTimeout
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 Details
-
ClusterAllocationExplainRequest
public ClusterAllocationExplainRequest()Create a new allocation explain request to explain any unassigned shard in the cluster. -
ClusterAllocationExplainRequest
- Throws:
java.io.IOException
-
-
Method Details
-
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput.- Specified by:
writeTo
in interfaceWriteable
- Overrides:
writeTo
in classMasterNodeRequest<ClusterAllocationExplainRequest>
- Throws:
java.io.IOException
-
validate
- Specified by:
validate
in classActionRequest
-
useAnyUnassignedShard
public boolean useAnyUnassignedShard()Returnstrue
iff the first unassigned shard is to be used -
setIndex
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, ornull
to use any unassigned shard (seeuseAnyUnassignedShard()
). -
setShard
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, ornull
to use any unassigned shard (seeuseAnyUnassignedShard()
). -
setPrimary
Sets whether to explain the allocation of the primary shard or a replica shard copy for the shard id (seegetShard()
). -
isPrimary
@Nullable public java.lang.Boolean isPrimary()Returnstrue
if explaining the primary shard for the shard id (seegetShard()
),false
if explaining a replica shard copy for the shard id, ornull
to use any unassigned shard (seeuseAnyUnassignedShard()
). -
setCurrentNode
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. Returnsnull
if any replica shard can be explained. -
includeYesDecisions
public void includeYesDecisions(boolean includeYesDecisions)Set totrue
to include yes decisions for a particular node. -
includeYesDecisions
public boolean includeYesDecisions()Returnstrue
if yes decisions should be included. Otherwise only "no" and "throttle" decisions are returned. -
includeDiskInfo
public void includeDiskInfo(boolean includeDiskInfo)Set totrue
to include information about the gathered disk information of nodes in the cluster. -
includeDiskInfo
public boolean includeDiskInfo()Returnstrue
if information about disk usage and shard sizes should also be returned. -
toString
public java.lang.String toString()- Overrides:
toString
in classjava.lang.Object
-
parse
public static ClusterAllocationExplainRequest parse(org.elasticsearch.common.xcontent.XContentParser parser) throws java.io.IOException- Throws:
java.io.IOException
-