Class ClusterHealthRequestParameters

Request options for Health

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

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>.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 awareness attribute for which the health is required.

Declaration

public string AwarenessAttribute { get; set; }

Property Value

Type	Description
string

ClusterManagerTimeout

Operation timeout for connection to cluster-manager node.

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

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?

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?

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?

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 TimeSpan MasterTimeout { get; set; }

Property Value

Type	Description
TimeSpan

SupportsBody

Declaration

public override bool SupportsBody { get; }

Property Value

Type	Description
bool

Overrides

RequestParameters<ClusterHealthRequestParameters>.SupportsBody

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 TimeSpan Timeout { get; set; }

Property Value

Type	Description
TimeSpan

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

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?

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?

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?

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

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

IRequestParameters

Extension Methods

SuffixExtensions.Suffix(object, string)