Class ClusterStateDescriptor

Descriptor for State

https://opensearch.org/docs/latest

Inheritance
object
RequestBase<ClusterStateRequestParameters>
RequestDescriptorBase<ClusterStateDescriptor, ClusterStateRequestParameters, IClusterStateRequest>
ClusterStateDescriptor
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class ClusterStateDescriptor : RequestDescriptorBase<ClusterStateDescriptor, ClusterStateRequestParameters, IClusterStateRequest>, IDescriptor, IClusterStateRequest, IRequest<ClusterStateRequestParameters>, IRequest

Constructors

| Edit this page View Source

ClusterStateDescriptor()

/_cluster/state

Declaration
public ClusterStateDescriptor()
| Edit this page View Source

ClusterStateDescriptor(Metrics)

/_cluster/state/{metric}

Declaration
public ClusterStateDescriptor(Metrics metric)
Parameters
Type Name Description
Metrics metric

Optional, accepts null
| Edit this page View Source

ClusterStateDescriptor(Metrics, Indices)

/_cluster/state/{metric}/{index}

Declaration
public ClusterStateDescriptor(Metrics metric, Indices index)
Parameters
Type Name Description
Metrics metric

Optional, accepts null
Indices index

Optional, accepts null

Methods

| Edit this page View Source

AllIndices()

A shortcut into calling Index(Indices.All)

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

AllowNoIndices(bool?)

Whether to ignore a wildcard index expression that resolves into no concrete indexes. This includes the _all string or when no indexes have been specified.

Declaration
public ClusterStateDescriptor AllowNoIndices(bool? allownoindices = true)
Parameters
Type Name Description
bool? allownoindices
Returns
Type Description
ClusterStateDescriptor
| 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 ClusterStateDescriptor ClusterManagerTimeout(Time clustermanagertimeout)
Parameters
Type Name Description
Time clustermanagertimeout
Returns
Type Description
ClusterStateDescriptor
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 ClusterStateDescriptor ExpandWildcards(ExpandWildcards? expandwildcards)
Parameters
Type Name Description
ExpandWildcards? expandwildcards
Returns
Type Description
ClusterStateDescriptor
| Edit this page View Source

FlatSettings(bool?)

Whether to return settings in the flat form, which can improve readability, especially for heavily nested settings. For example, the flat form of "cluster": { "max_shards_per_node": 500 } is "cluster.max_shards_per_node": "500".

Declaration
public ClusterStateDescriptor FlatSettings(bool? flatsettings = true)
Parameters
Type Name Description
bool? flatsettings
Returns
Type Description
ClusterStateDescriptor
| Edit this page View Source

IgnoreUnavailable(bool?)

Whether the specified concrete indexes should be ignored when unavailable (missing or closed).

Declaration
public ClusterStateDescriptor IgnoreUnavailable(bool? ignoreunavailable = true)
Parameters
Type Name Description
bool? ignoreunavailable
Returns
Type Description
ClusterStateDescriptor
| 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 ClusterStateDescriptor Index(Indices index)
Parameters
Type Name Description
Indices index
Returns
Type Description
ClusterStateDescriptor
| Edit this page View Source

Index<TOther>()

a shortcut into calling Index(typeof(TOther))

Declaration
public ClusterStateDescriptor Index<TOther>() where TOther : class
Returns
Type Description
ClusterStateDescriptor
Type Parameters
Name Description
TOther
| 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 ClusterStateDescriptor Local(bool? local = true)
Parameters
Type Name Description
bool? local
Returns
Type Description
ClusterStateDescriptor
| 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 ClusterStateDescriptor MasterTimeout(Time mastertimeout)
Parameters
Type Name Description
Time mastertimeout
Returns
Type Description
ClusterStateDescriptor
| Edit this page View Source

Metric(Metrics)

Limits the information returned to only the specified metric groups.

Declaration
public ClusterStateDescriptor Metric(Metrics metric)
Parameters
Type Name Description
Metrics metric
Returns
Type Description
ClusterStateDescriptor
| Edit this page View Source

WaitForMetadataVersion(long?)

Wait for the metadata version to be equal or greater than the specified metadata version.

Declaration
public ClusterStateDescriptor WaitForMetadataVersion(long? waitformetadataversion)
Parameters
Type Name Description
long? waitformetadataversion
Returns
Type Description
ClusterStateDescriptor
| Edit this page View Source

WaitForTimeout(Time)

The maximum time to wait for wait_for_metadata_version before timing out.

Declaration
public ClusterStateDescriptor WaitForTimeout(Time waitfortimeout)
Parameters
Type Name Description
Time waitfortimeout
Returns
Type Description
ClusterStateDescriptor

Implements

Extension Methods