Class ClusterHealthRequestParameters

Request options for Health

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

Inheritance

object

RequestParameters<ClusterHealthRequestParameters>

ClusterHealthRequestParameters

Implements

IRequestParameters

Inherited Members

RequestParameters<ClusterHealthRequestParameters>.CustomResponseBuilder

RequestParameters<ClusterHealthRequestParameters>.QueryString

RequestParameters<ClusterHealthRequestParameters>.RequestConfiguration

RequestParameters<ClusterHealthRequestParameters>.ContainsQueryString(string)

RequestParameters<ClusterHealthRequestParameters>.GetQueryStringValue<TOut>(string)

RequestParameters<ClusterHealthRequestParameters>.GetResolvedQueryStringValue(string, IConnectionConfigurationValues)

RequestParameters<ClusterHealthRequestParameters>.SetQueryString(string, object)

RequestParameters<ClusterHealthRequestParameters>.Q<TOut>(string)

RequestParameters<ClusterHealthRequestParameters>.Q(string, object)

RequestParameters<ClusterHealthRequestParameters>.SetAcceptHeader(string)

RequestParameters<ClusterHealthRequestParameters>.SetAcceptHeader(Enum)

RequestParameters<ClusterHealthRequestParameters>.AcceptHeaderFromFormat(string)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: OpenSearch.Net.Specification.ClusterApi

Assembly: OpenSearch.Net.dll

Syntax

public class ClusterHealthRequestParameters : RequestParameters<ClusterHealthRequestParameters>, IRequestParameters

Properties

AwarenessAttribute

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
TimeSpan

Remarks

Supported by OpenSearch servers of version 2.0.0 or greater.

DefaultHttpMethod

Declaration

public override HttpMethod DefaultHttpMethod { get; }

Property Value

Type	Description
HttpMethod

Overrides

RequestParameters<ClusterHealthRequestParameters>.DefaultHttpMethod

ExpandWildcards

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

Declaration

public ExpandWildcards? ExpandWildcards { get; set; }

Property Value

Type	Description
ExpandWildcards?

Level

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

Declaration

public ClusterHealthLevel? Level { get; set; }

Property Value

Type	Description
ClusterHealthLevel?

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
TimeSpan

OperationName

The OpenSearch REST API operation name this request maps to (for example search or indices.create), used as the OpenTelemetry span name and db.operation tag. null for requests that do not correspond to a named API operation.

Declaration

public override string OperationName { get; }

Property Value

Type	Description
string

Overrides

RequestParameters<ClusterHealthRequestParameters>.OperationName

SupportsBody

Declaration

public override bool SupportsBody { get; }

Property Value

Type	Description
bool

Overrides

RequestParameters<ClusterHealthRequestParameters>.SupportsBody

Timeout

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
TimeSpan

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
WaitForEvents?

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
HealthStatus?

Implements

IRequestParameters

Extension Methods

SuffixExtensions.Suffix(object, string)