Class ClusterStateRequestParameters

Request options for State

https://opensearch.org/docs/latest

Inheritance
object
RequestParameters<ClusterStateRequestParameters>
ClusterStateRequestParameters
Implements
Inherited Members
Namespace: OpenSearch.Net.Specification.ClusterApi
Assembly: OpenSearch.Net.dll
Syntax
public class ClusterStateRequestParameters : RequestParameters<ClusterStateRequestParameters>, IRequestParameters

Properties

| Edit this page View Source

AllowNoIndices

Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes _all string or when no indices 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 TimeSpan ClusterManagerTimeout { get; set; }
Property Value
Type Description
TimeSpan
Remarks

Supported by OpenSearch servers of version 2.0.0 or greater.

| Edit this page View Source

DefaultHttpMethod

Declaration
public override HttpMethod DefaultHttpMethod { get; }
Property Value
Type Description
HttpMethod
Overrides
| Edit this page View Source

ExpandWildcards

Whether to expand wildcard expression to concrete indices 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 indices 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 master.

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
| Edit this page View Source

SupportsBody

Declaration
public override bool SupportsBody { get; }
Property Value
Type Description
bool
Overrides
| 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 TimeSpan WaitForTimeout { get; set; }
Property Value
Type Description
TimeSpan

Implements

Extension Methods