Class ClusterHealthRequestBuilder
- java.lang.Object
-
- org.elasticsearch.action.ActionRequestBuilder<Request,Response>
-
- org.elasticsearch.action.support.master.MasterNodeOperationRequestBuilder<Request,Response,RequestBuilder>
-
- org.elasticsearch.action.support.master.MasterNodeReadOperationRequestBuilder<ClusterHealthRequest,ClusterHealthResponse,ClusterHealthRequestBuilder>
-
- org.elasticsearch.action.admin.cluster.health.ClusterHealthRequestBuilder
-
public class ClusterHealthRequestBuilder extends MasterNodeReadOperationRequestBuilder<ClusterHealthRequest,ClusterHealthResponse,ClusterHealthRequestBuilder>
-
-
Field Summary
-
Fields inherited from class org.elasticsearch.action.ActionRequestBuilder
action, client, request
-
-
Constructor Summary
Constructors Constructor Description ClusterHealthRequestBuilder(ElasticsearchClient client, ClusterHealthAction action)
-
Method Summary
Modifier and Type Method Description ClusterHealthRequestBuilder
setIndices(java.lang.String... indices)
ClusterHealthRequestBuilder
setTimeout(java.lang.String timeout)
ClusterHealthRequestBuilder
setTimeout(TimeValue timeout)
ClusterHealthRequestBuilder
setWaitForActiveShards(int waitForActiveShards)
A shortcut forsetWaitForActiveShards(ActiveShardCount)
where the numerical shard count is passed in, instead of having to first callActiveShardCount.from(int)
to get the ActiveShardCount.ClusterHealthRequestBuilder
setWaitForActiveShards(ActiveShardCount waitForActiveShards)
Sets the number of shard copies that must be active before getting the health status.ClusterHealthRequestBuilder
setWaitForEvents(Priority waitForEvents)
ClusterHealthRequestBuilder
setWaitForGreenStatus()
ClusterHealthRequestBuilder
setWaitForNodes(java.lang.String waitForNodes)
Waits for N number of nodes.ClusterHealthRequestBuilder
setWaitForNoInitializingShards(boolean waitForNoInitializingShards)
Sets whether the request should wait for there to be no initializing shards before retrieving the cluster health status.ClusterHealthRequestBuilder
setWaitForNoRelocatingShards(boolean waitForRelocatingShards)
Sets whether the request should wait for there to be no relocating shards before retrieving the cluster health status.ClusterHealthRequestBuilder
setWaitForStatus(ClusterHealthStatus waitForStatus)
ClusterHealthRequestBuilder
setWaitForYellowStatus()
-
Methods inherited from class org.elasticsearch.action.support.master.MasterNodeReadOperationRequestBuilder
setLocal
-
Methods inherited from class org.elasticsearch.action.support.master.MasterNodeOperationRequestBuilder
setMasterNodeTimeout, setMasterNodeTimeout
-
-
-
-
Constructor Detail
-
ClusterHealthRequestBuilder
public ClusterHealthRequestBuilder(ElasticsearchClient client, ClusterHealthAction action)
-
-
Method Detail
-
setIndices
public ClusterHealthRequestBuilder setIndices(java.lang.String... indices)
-
setTimeout
public ClusterHealthRequestBuilder setTimeout(TimeValue timeout)
-
setTimeout
public ClusterHealthRequestBuilder setTimeout(java.lang.String timeout)
-
setWaitForStatus
public ClusterHealthRequestBuilder setWaitForStatus(ClusterHealthStatus waitForStatus)
-
setWaitForGreenStatus
public ClusterHealthRequestBuilder setWaitForGreenStatus()
-
setWaitForYellowStatus
public ClusterHealthRequestBuilder setWaitForYellowStatus()
-
setWaitForNoRelocatingShards
public ClusterHealthRequestBuilder setWaitForNoRelocatingShards(boolean waitForRelocatingShards)
Sets whether the request should wait for there to be no relocating shards before retrieving the cluster health status. Defaults tofalse
, meaning the operation does not wait on there being no more relocating shards. Set totrue
to wait until the number of relocating shards in the cluster is 0.
-
setWaitForNoInitializingShards
public ClusterHealthRequestBuilder setWaitForNoInitializingShards(boolean waitForNoInitializingShards)
Sets whether the request should wait for there to be no initializing shards before retrieving the cluster health status. Defaults tofalse
, meaning the operation does not wait on there being no more initializing shards. Set totrue
to wait until the number of initializing shards in the cluster is 0.
-
setWaitForActiveShards
public ClusterHealthRequestBuilder setWaitForActiveShards(ActiveShardCount waitForActiveShards)
Sets the number of shard copies that must be active before getting the health status. Defaults toActiveShardCount.NONE
, meaning we don't wait on any active shards. Set this value toActiveShardCount.ALL
to wait for all shards (primary and all replicas) to be active across all indices in the cluster. Otherwise, useActiveShardCount.from(int)
to set this value to any non-negative integer, up to the total number of shard copies that would exist across all indices in the cluster.
-
setWaitForActiveShards
public ClusterHealthRequestBuilder setWaitForActiveShards(int waitForActiveShards)
A shortcut forsetWaitForActiveShards(ActiveShardCount)
where the numerical shard count is passed in, instead of having to first callActiveShardCount.from(int)
to get the ActiveShardCount.
-
setWaitForNodes
public ClusterHealthRequestBuilder setWaitForNodes(java.lang.String waitForNodes)
Waits for N number of nodes. Use "12" for exact mapping, ">12" and "<12" for range.
-
setWaitForEvents
public ClusterHealthRequestBuilder setWaitForEvents(Priority waitForEvents)
-
-