Class ClusterHealthRequestParameters
Request options for Health
https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-health/
Implements
Inherited Members
Namespace: OpenSearch .Net.Specification.ClusterApi
Assembly: OpenSearch.Net.dll
Syntax
public class ClusterHealthRequestParameters : RequestParameters<ClusterHealthRequestParameters>, IRequestParametersProperties
| Edit this page View SourceAwarenessAttribute
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 string AwarenessAttribute { get; set; }Property Value
| Type | Description |
|---|---|
| string |
ClusterManagerTimeout
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 TimeSpan ClusterManagerTimeout { get; set; }Property Value
| Type | Description |
|---|---|
| Time |
Remarks
Supported by OpenSearch servers of version 2.0.0 or greater.
DefaultHttpMethod
Declaration
public override HttpMethod DefaultHttpMethod { get; }Property Value
| Type | Description |
|---|---|
| Http |
Overrides
| Edit this page View SourceExpandWildcards
Specifies the type of index that wildcard expressions can match. Supports comma-separated values.
Declaration
public ExpandWildcards? ExpandWildcards { get; set; }Property Value
| Type | Description |
|---|---|
| Expand |
Level
Controls the amount of detail included in the cluster health response.
Declaration
public ClusterHealthLevel? Level { get; set; }Property Value
| Type | Description |
|---|---|
| Cluster |
Local
Whether to return information from the local node only instead of from the cluster manager node.
Declaration
public bool? Local { get; set; }Property Value
| Type | Description |
|---|---|
| bool? |
MasterTimeout
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 TimeSpan MasterTimeout { get; set; }Property Value
| Type | Description |
|---|---|
| Time |
SupportsBody
Declaration
public override bool SupportsBody { get; }Property Value
| Type | Description |
|---|---|
| bool |
Overrides
| Edit this page View SourceTimeout
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 TimeSpan Timeout { get; set; }Property Value
| Type | Description |
|---|---|
| Time |
WaitForActiveShards
Waits until the specified number of shards is active before returning a response. Use all for all shards.
Declaration
public string WaitForActiveShards { get; set; }Property Value
| Type | Description |
|---|---|
| string |
WaitForEvents
Waits until all currently queued events with the given priority are processed.
Declaration
public WaitForEvents? WaitForEvents { get; set; }Property Value
| Type | Description |
|---|---|
| Wait |
WaitForNoInitializingShards
Whether to wait until there are no initializing shards in the cluster.
Declaration
public bool? WaitForNoInitializingShards { get; set; }Property Value
| Type | Description |
|---|---|
| bool? |
WaitForNoRelocatingShards
Whether to wait until there are no relocating shards in the cluster.
Declaration
public bool? WaitForNoRelocatingShards { get; set; }Property Value
| Type | Description |
|---|---|
| bool? |
WaitForNodes
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 string WaitForNodes { get; set; }Property Value
| Type | Description |
|---|---|
| string |
WaitForStatus
Waits until the cluster health reaches the specified status or better.
Declaration
public HealthStatus? WaitForStatus { get; set; }Property Value
| Type | Description |
|---|---|
| Health |