Class ClusterHealthDescriptor

Descriptor for Health

https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-health/

Inheritance
object
RequestBase<ClusterHealthRequestParameters>
RequestDescriptorBase<ClusterHealthDescriptor, ClusterHealthRequestParameters, IClusterHealthRequest>
ClusterHealthDescriptor
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class ClusterHealthDescriptor : RequestDescriptorBase<ClusterHealthDescriptor, ClusterHealthRequestParameters, IClusterHealthRequest>, IDescriptor, IClusterHealthRequest, IRequest<ClusterHealthRequestParameters>, IRequest

Constructors

| Edit this page View Source

ClusterHealthDescriptor()

/_cluster/health

Declaration
public ClusterHealthDescriptor()
| Edit this page View Source

ClusterHealthDescriptor(Indices)

/_cluster/health/{index}

Declaration
public ClusterHealthDescriptor(Indices index)
Parameters
Type Name Description
Indices index

Optional, accepts null

Methods

| Edit this page View Source

AllIndices()

A shortcut into calling Index(Indices.All)

Declaration
public ClusterHealthDescriptor AllIndices()
Returns
Type Description
ClusterHealthDescriptor
| Edit this page View Source

AwarenessAttribute(string)

The name of the awareness attribute for which to return the cluster health status (for example, zone). Applicable only if level is set to awareness_attributes.

Declaration
public ClusterHealthDescriptor AwarenessAttribute(string awarenessattribute)
Parameters
Type Name Description
string awarenessattribute
Returns
Type Description
ClusterHealthDescriptor
| Edit this page View Source

ClusterManagerTimeout(Time)

The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see Common parameters.

Declaration
public ClusterHealthDescriptor ClusterManagerTimeout(Time clustermanagertimeout)
Parameters
Type Name Description
Time clustermanagertimeout
Returns
Type Description
ClusterHealthDescriptor
Remarks

Supported by OpenSearch servers of version 2.0.0 or greater.

| Edit this page View Source

ExpandWildcards(ExpandWildcards?)

Specifies the type of index that wildcard expressions can match. Supports comma-separated values.

Declaration
public ClusterHealthDescriptor ExpandWildcards(ExpandWildcards? expandwildcards)
Parameters
Type Name Description
ExpandWildcards? expandwildcards
Returns
Type Description
ClusterHealthDescriptor
| Edit this page View Source

Index(Indices)

A comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indexes, omit this parameter or use * or _all.

Declaration
public ClusterHealthDescriptor Index(Indices index)
Parameters
Type Name Description
Indices index
Returns
Type Description
ClusterHealthDescriptor
| Edit this page View Source

Index<TOther>()

a shortcut into calling Index(typeof(TOther))

Declaration
public ClusterHealthDescriptor Index<TOther>() where TOther : class
Returns
Type Description
ClusterHealthDescriptor
Type Parameters
Name Description
TOther
| Edit this page View Source

Level(ClusterHealthLevel?)

Controls the amount of detail included in the cluster health response.

Declaration
public ClusterHealthDescriptor Level(ClusterHealthLevel? level)
Parameters
Type Name Description
ClusterHealthLevel? level
Returns
Type Description
ClusterHealthDescriptor
| Edit this page View Source

Local(bool?)

Whether to return information from the local node only instead of from the cluster manager node.

Declaration
public ClusterHealthDescriptor Local(bool? local = true)
Parameters
Type Name Description
bool? local
Returns
Type Description
ClusterHealthDescriptor
| Edit this page View Source

MasterTimeout(Time)

A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts 0 without a unit and -1 to indicate an unspecified value.

Declaration
[Obsolete("Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead.")]
public ClusterHealthDescriptor MasterTimeout(Time mastertimeout)
Parameters
Type Name Description
Time mastertimeout
Returns
Type Description
ClusterHealthDescriptor
| Edit this page View Source

Timeout(Time)

The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see Common parameters.

Declaration
public ClusterHealthDescriptor Timeout(Time timeout)
Parameters
Type Name Description
Time timeout
Returns
Type Description
ClusterHealthDescriptor
| Edit this page View Source

WaitForActiveShards(string)

Waits until the specified number of shards is active before returning a response. Use all for all shards.

Declaration
public ClusterHealthDescriptor WaitForActiveShards(string waitforactiveshards)
Parameters
Type Name Description
string waitforactiveshards
Returns
Type Description
ClusterHealthDescriptor
| Edit this page View Source

WaitForEvents(WaitForEvents?)

Waits until all currently queued events with the given priority are processed.

Declaration
public ClusterHealthDescriptor WaitForEvents(WaitForEvents? waitforevents)
Parameters
Type Name Description
WaitForEvents? waitforevents
Returns
Type Description
ClusterHealthDescriptor
| Edit this page View Source

WaitForNoInitializingShards(bool?)

Whether to wait until there are no initializing shards in the cluster.

Declaration
public ClusterHealthDescriptor WaitForNoInitializingShards(bool? waitfornoinitializingshards = true)
Parameters
Type Name Description
bool? waitfornoinitializingshards
Returns
Type Description
ClusterHealthDescriptor
| Edit this page View Source

WaitForNoRelocatingShards(bool?)

Whether to wait until there are no relocating shards in the cluster.

Declaration
public ClusterHealthDescriptor WaitForNoRelocatingShards(bool? waitfornorelocatingshards = true)
Parameters
Type Name Description
bool? waitfornorelocatingshards
Returns
Type Description
ClusterHealthDescriptor
| Edit this page View Source

WaitForNodes(string)

Waits until the specified number of nodes (N) is available. Accepts >=N, <=N, >N, and <N. You can also use ge(N), le(N), gt(N), and lt(N) notation.

Declaration
public ClusterHealthDescriptor WaitForNodes(string waitfornodes)
Parameters
Type Name Description
string waitfornodes
Returns
Type Description
ClusterHealthDescriptor
| Edit this page View Source

WaitForStatus(HealthStatus?)

Waits until the cluster health reaches the specified status or better.

Declaration
public ClusterHealthDescriptor WaitForStatus(HealthStatus? waitforstatus)
Parameters
Type Name Description
HealthStatus? waitforstatus
Returns
Type Description
ClusterHealthDescriptor

Implements

Extension Methods