Package org.elasticsearch.action.admin.cluster.allocation

Class ClusterAllocationExplainRequestBuilder

java.lang.Object

org.elasticsearch.action.ActionRequestBuilder<Request,Response,RequestBuilder>

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

Fields inherited from class org.elasticsearch.action.ActionRequestBuilder

action, client, request

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 cluster
ClusterAllocationExplainRequestBuilder	setIncludeYesDecisions(boolean includeYesDecisions)	Whether to include "YES" decider decisions in the response instead of only "NO" decisions
ClusterAllocationExplainRequestBuilder	setIndex(java.lang.String index)	The index name to use when finding the shard to explain
ClusterAllocationExplainRequestBuilder	setPrimary(boolean primary)	Whether the primary or replica should be explained
ClusterAllocationExplainRequestBuilder	setShard(int shard)	The shard number to use when finding the shard to explain
ClusterAllocationExplainRequestBuilder	useAnyUnassignedShard()	Signal that the first unassigned shard should be used

Methods inherited from class org.elasticsearch.action.ActionRequestBuilder

execute, execute, get, get, get, request

Methods inherited from class org.elasticsearch.action.support.master.MasterNodeOperationRequestBuilder

setMasterNodeTimeout, setMasterNodeTimeout

Methods inherited from class java.lang.Object

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

Constructor Detail

ClusterAllocationExplainRequestBuilder

public ClusterAllocationExplainRequestBuilder(ElasticsearchClient client,
                                              ClusterAllocationExplainAction action)

Method Detail

setIndex

public ClusterAllocationExplainRequestBuilder setIndex(java.lang.String index)

The index name to use when finding the shard to explain

setShard

public ClusterAllocationExplainRequestBuilder setShard(int shard)

The shard number to use when finding the shard to explain

setPrimary

public ClusterAllocationExplainRequestBuilder setPrimary(boolean primary)

Whether the primary or replica should be explained

setIncludeYesDecisions

public ClusterAllocationExplainRequestBuilder setIncludeYesDecisions(boolean includeYesDecisions)

Whether to include "YES" decider decisions in the response instead of only "NO" decisions

setIncludeDiskInfo

public ClusterAllocationExplainRequestBuilder setIncludeDiskInfo(boolean includeDiskInfo)

Whether to include information about the gathered disk information of nodes in the cluster

setCurrentNode

public ClusterAllocationExplainRequestBuilder setCurrentNode(java.lang.String currentNode)

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

useAnyUnassignedShard

public ClusterAllocationExplainRequestBuilder useAnyUnassignedShard()

Signal that the first unassigned shard should be used