Class ClusterAllocationExplainRequestBuilder
java.lang.Object
org.elasticsearch.action.ActionRequestBuilder<Request,Response>
org.elasticsearch.action.support.master.MasterNodeOperationRequestBuilder<ClusterAllocationExplainRequest,ClusterAllocationExplainResponse,ClusterAllocationExplainRequestBuilder>
org.elasticsearch.action.admin.cluster.allocation.ClusterAllocationExplainRequestBuilder
public class ClusterAllocationExplainRequestBuilder extends MasterNodeOperationRequestBuilder<ClusterAllocationExplainRequest,ClusterAllocationExplainResponse,ClusterAllocationExplainRequestBuilder>
Builder for requests to explain the allocation of a shard in the cluster
-
Field Summary
-
Constructor Summary
Constructors Constructor Description ClusterAllocationExplainRequestBuilder(ElasticsearchClient client, ClusterAllocationExplainAction action)
-
Method Summary
Modifier and Type Method Description ClusterAllocationExplainRequestBuilder
setCurrentNode(java.lang.String currentNode)
Requests the explain API to explain an already assigned replica shard currently allocated to the given node.ClusterAllocationExplainRequestBuilder
setIncludeDiskInfo(boolean includeDiskInfo)
Whether to include information about the gathered disk information of nodes in the clusterClusterAllocationExplainRequestBuilder
setIncludeYesDecisions(boolean includeYesDecisions)
Whether to include "YES" decider decisions in the response instead of only "NO" decisionsClusterAllocationExplainRequestBuilder
setIndex(java.lang.String index)
The index name to use when finding the shard to explainClusterAllocationExplainRequestBuilder
setPrimary(boolean primary)
Whether the primary or replica should be explainedClusterAllocationExplainRequestBuilder
setShard(int shard)
The shard number to use when finding the shard to explainClusterAllocationExplainRequestBuilder
useAnyUnassignedShard()
Signal that the first unassigned shard should be usedMethods inherited from class org.elasticsearch.action.support.master.MasterNodeOperationRequestBuilder
setMasterNodeTimeout, setMasterNodeTimeout
-
Constructor Details
-
ClusterAllocationExplainRequestBuilder
public ClusterAllocationExplainRequestBuilder(ElasticsearchClient client, ClusterAllocationExplainAction action)
-
-
Method Details
-
setIndex
The index name to use when finding the shard to explain -
setShard
The shard number to use when finding the shard to explain -
setPrimary
Whether the primary or replica should be explained -
setIncludeYesDecisions
Whether to include "YES" decider decisions in the response instead of only "NO" decisions -
setIncludeDiskInfo
Whether to include information about the gathered disk information of nodes in the cluster -
setCurrentNode
Requests the explain API to explain an already assigned replica shard currently allocated to the given node. -
useAnyUnassignedShard
Signal that the first unassigned shard should be used
-