Class ClusterStateRequest

Request for State

https://opensearch.org/docs/latest

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

Constructors

| Edit this page View Source

ClusterStateRequest()

/_cluster/state

Declaration
public ClusterStateRequest()
| Edit this page View Source

ClusterStateRequest(Metrics)

/_cluster/state/{metric}

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

Optional, accepts null
| Edit this page View Source

ClusterStateRequest(Metrics, Indices)

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

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

Optional, accepts null
Indices index

Optional, accepts null

Properties

| Edit this page View Source

AllowNoIndices

Whether to ignore if a wildcard indexes expression resolves into no concrete indexes. (This includes _all string or when no indexes have been specified).

Declaration
public bool? AllowNoIndices { get; set; }
Property Value
Type Description
bool?
| 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

FlatSettings

Return settings in flat format.

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

IgnoreUnavailable

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

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

Local

Return local information, do not retrieve the state from cluster-manager node.

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

MasterTimeout

Specify timeout for connection to cluster manager.

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 IClusterStateRequest Self { get; }
Property Value
Type Description
IClusterStateRequest
| Edit this page View Source

WaitForMetadataVersion

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

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

WaitForTimeout

The maximum time to wait for wait_for_metadata_version before timing out.

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

Implements

Extension Methods