Class ClusterStatsRequest

Request for Stats

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

Inheritance
object
RequestBase<ClusterStatsRequestParameters>
PlainRequestBase<ClusterStatsRequestParameters>
ClusterStatsRequest
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class ClusterStatsRequest : PlainRequestBase<ClusterStatsRequestParameters>, IClusterStatsRequest, IRequest<ClusterStatsRequestParameters>, IRequest

Constructors

| Edit this page View Source

ClusterStatsRequest()

/_cluster/stats

Declaration
public ClusterStatsRequest()
| Edit this page View Source

ClusterStatsRequest(Metrics, IndexMetrics, NodeIds)

/_cluster/stats/{metric}/{index_metric}/nodes/{node_id}

Declaration
public ClusterStatsRequest(Metrics metric, IndexMetrics indexMetric, NodeIds nodeId)
Parameters
Type Name Description
Metrics metric

Optional, accepts null
IndexMetrics indexMetric

Optional, accepts null
NodeIds nodeId

Optional, accepts null
| Edit this page View Source

ClusterStatsRequest(Metrics, NodeIds)

/_cluster/stats/{metric}/nodes/{node_id}

Declaration
public ClusterStatsRequest(Metrics metric, NodeIds nodeId)
Parameters
Type Name Description
Metrics metric

Optional, accepts null
NodeIds nodeId

Optional, accepts null
| Edit this page View Source

ClusterStatsRequest(NodeIds)

/_cluster/stats/nodes/{node_id}

Declaration
public ClusterStatsRequest(NodeIds nodeId)
Parameters
Type Name Description
NodeIds nodeId

Optional, accepts null

Properties

| Edit this page View Source

FlatSettings

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 bool? FlatSettings { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

Self

Declaration
protected IClusterStatsRequest Self { get; }
Property Value
Type Description
IClusterStatsRequest
| Edit this page View Source

Timeout

The amount of time 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 Time Timeout { get; set; }
Property Value
Type Description
Time

Implements

Extension Methods