Class ClusterStatsRequestParameters

Request options for Stats

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

Inheritance

object

RequestParameters<ClusterStatsRequestParameters>

ClusterStatsRequestParameters

Implements

IRequestParameters

Inherited Members

RequestParameters<ClusterStatsRequestParameters>.CustomResponseBuilder

RequestParameters<ClusterStatsRequestParameters>.QueryString

RequestParameters<ClusterStatsRequestParameters>.RequestConfiguration

RequestParameters<ClusterStatsRequestParameters>.ContainsQueryString(string)

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

RequestParameters<ClusterStatsRequestParameters>.GetResolvedQueryStringValue(string, IConnectionConfigurationValues)

RequestParameters<ClusterStatsRequestParameters>.SetQueryString(string, object)

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

RequestParameters<ClusterStatsRequestParameters>.Q(string, object)

RequestParameters<ClusterStatsRequestParameters>.SetAcceptHeader(string)

RequestParameters<ClusterStatsRequestParameters>.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 ClusterStatsRequestParameters : RequestParameters<ClusterStatsRequestParameters>, IRequestParameters

Properties

DefaultHttpMethod

Declaration

public override HttpMethod DefaultHttpMethod { get; }

Property Value

Type	Description
HttpMethod

Overrides

RequestParameters<ClusterStatsRequestParameters>.DefaultHttpMethod

FlatSettings

If true, returns settings in flat format.

Declaration

public bool? FlatSettings { get; set; }

Property Value

Type	Description
bool?

SupportsBody

Declaration

public override bool SupportsBody { get; }

Property Value

Type	Description
bool

Overrides

RequestParameters<ClusterStatsRequestParameters>.SupportsBody

Timeout

Period to wait for each node to respond. If a node does not respond before its timeout expires, the response does not include its stats. However, timed out nodes are included in the response's _nodes.failed property. Defaults to no timeout.

Declaration

public TimeSpan Timeout { get; set; }

Property Value

Type	Description
TimeSpan

Implements

IRequestParameters

Extension Methods

SuffixExtensions.Suffix(object, string)