Class ClusterHealthRequest

Request for Health

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

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

Constructors

| Edit this page View Source

ClusterHealthRequest()

/_cluster/health

Declaration
public ClusterHealthRequest()
| Edit this page View Source

ClusterHealthRequest(Indices)

/_cluster/health/{index}

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

Optional, accepts null

Properties

| Edit this page View Source

AwarenessAttribute

The awareness attribute for which the health is required.

Declaration
public string AwarenessAttribute { get; set; }
Property Value
Type Description
string
| Edit this page View Source

ClusterManagerTimeout

Operation timeout for connection to cluster-manager node.

Declaration
public Time ClusterManagerTimeout { get; set; }
Property Value
Type Description
Time
Remarks

Supported by OpenSearch servers of version 2.0.0 or greater.

| Edit this page View Source

ExpandWildcards

Whether to expand wildcard expression to concrete indexes that are open, closed or both.

Declaration
public ExpandWildcards? ExpandWildcards { get; set; }
Property Value
Type Description
ExpandWildcards?
| Edit this page View Source

Level

Can be one of cluster, indexes or shards. Controls the details level of the health information returned.

Declaration
public ClusterHealthLevel? Level { get; set; }
Property Value
Type Description
ClusterHealthLevel?
| Edit this page View Source

Local

If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the cluster-manager node.

Declaration
public bool? Local { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

MasterTimeout

Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error.

Declaration
[Obsolete("Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead.")]
public Time MasterTimeout { get; set; }
Property Value
Type Description
Time
| Edit this page View Source

Self

Declaration
protected IClusterHealthRequest Self { get; }
Property Value
Type Description
IClusterHealthRequest
| Edit this page View Source

Timeout

Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

Declaration
public Time Timeout { get; set; }
Property Value
Type Description
Time
| Edit this page View Source

WaitForActiveShards

A number controlling to how many active shards to wait for, all to wait for all shards in the cluster to be active, or 0 to not wait.

Declaration
public string WaitForActiveShards { get; set; }
Property Value
Type Description
string
| Edit this page View Source

WaitForEvents

Can be one of immediate, urgent, high, normal, low, languid. Wait until all currently queued events with the given priority are processed.

Declaration
public WaitForEvents? WaitForEvents { get; set; }
Property Value
Type Description
WaitForEvents?
| Edit this page View Source

WaitForNoInitializingShards

A Boolean value which controls whether to wait (until the timeout provided) for the cluster to have no shard initializations. Defaults to false, which means it will not wait for initializing shards.

Declaration
public bool? WaitForNoInitializingShards { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

WaitForNoRelocatingShards

A Boolean value which controls whether to wait (until the timeout provided) for the cluster to have no shard relocations. Defaults to false, which means it will not wait for relocating shards.

Declaration
public bool? WaitForNoRelocatingShards { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

WaitForNodes

The request waits until the specified number N of nodes is available. It also accepts >=N, <=N, >N and <N. Alternatively, it is possible to use ge(N), le(N), gt(N) and lt(N) notation.

Declaration
public string WaitForNodes { get; set; }
Property Value
Type Description
string
| Edit this page View Source

WaitForStatus

One of green, yellow or red. Will wait (until the timeout provided) until the status of the cluster changes to the one provided or better, i.e. green > yellow > red. By default, will not wait for any status.

Declaration
public HealthStatus? WaitForStatus { get; set; }
Property Value
Type Description
HealthStatus?

Implements

Extension Methods