Module org.elasticsearch.server

Package org.elasticsearch.action.admin.cluster.health

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

All Implemented Interfaces:

RequestBuilder<ClusterHealthRequest,ClusterHealthResponse>

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)

Method Summary

Modifier and Type	Method	Description
ClusterHealthRequestBuilder	setIndices(String... indices)
ClusterHealthRequestBuilder	setIndicesOptions(IndicesOptions indicesOptions)
ClusterHealthRequestBuilder	setTimeout(String timeout)
ClusterHealthRequestBuilder	setTimeout(TimeValue timeout)
ClusterHealthRequestBuilder	setWaitForActiveShards(int waitForActiveShards)	A shortcut for setWaitForActiveShards(ActiveShardCount) where the numerical shard count is passed in, instead of having to first call ActiveShardCount.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(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

Methods inherited from class org.elasticsearch.action.ActionRequestBuilder

execute, execute, get, get, request

Methods inherited from class java.lang.Object

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

Constructor Details

ClusterHealthRequestBuilder

public ClusterHealthRequestBuilder(ElasticsearchClient client)

Method Details

setIndices

public ClusterHealthRequestBuilder setIndices(String... indices)

setIndicesOptions

public ClusterHealthRequestBuilder setIndicesOptions(IndicesOptions indicesOptions)

setTimeout

public ClusterHealthRequestBuilder setTimeout(TimeValue timeout)

setTimeout

public ClusterHealthRequestBuilder setTimeout(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 to false, meaning the operation does not wait on there being no more relocating shards. Set to true 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 to false, meaning the operation does not wait on there being no more initializing shards. Set to true 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 to ActiveShardCount.NONE, meaning we don't wait on any active shards. Set this value to ActiveShardCount.ALL to wait for all shards (primary and all replicas) to be active across all indices in the cluster. Otherwise, use ActiveShardCount.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 for setWaitForActiveShards(ActiveShardCount) where the numerical shard count is passed in, instead of having to first call ActiveShardCount.from(int) to get the ActiveShardCount.

setWaitForNodes

public ClusterHealthRequestBuilder setWaitForNodes(String waitForNodes)

Waits for N number of nodes. Use "12" for exact mapping, ">12" and "<12" for range.

setWaitForEvents

public ClusterHealthRequestBuilder setWaitForEvents(Priority waitForEvents)