Class ClusterStatsDescriptor

Descriptor for Stats

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

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

Constructors

| Edit this page View Source

ClusterStatsDescriptor()

/_cluster/stats

Declaration
public ClusterStatsDescriptor()
| Edit this page View Source

ClusterStatsDescriptor(Metrics, IndexMetrics, NodeIds)

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

Declaration
public ClusterStatsDescriptor(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

ClusterStatsDescriptor(Metrics, NodeIds)

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

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

Optional, accepts null
NodeIds nodeId

Optional, accepts null
| Edit this page View Source

ClusterStatsDescriptor(NodeIds)

/_cluster/stats/nodes/{node_id}

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

Optional, accepts null

Methods

| 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 ClusterStatsDescriptor FlatSettings(bool? flatsettings = true)
Parameters
Type Name Description
bool? flatsettings
Returns
Type Description
ClusterStatsDescriptor
| Edit this page View Source

IndexMetric(IndexMetrics)

A comma-separated list of index metric groups, for example, docs,store.

Declaration
public ClusterStatsDescriptor IndexMetric(IndexMetrics indexMetric)
Parameters
Type Name Description
IndexMetrics indexMetric
Returns
Type Description
ClusterStatsDescriptor
| Edit this page View Source

Metric(Metrics)

Limit the information returned to the specified metrics.

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

NodeId(NodeIds)

A comma-separated list of node IDs used to filter results. Supports node filters.

Declaration
public ClusterStatsDescriptor NodeId(NodeIds nodeId)
Parameters
Type Name Description
NodeIds nodeId
Returns
Type Description
ClusterStatsDescriptor
| Edit this page View Source

Timeout(Time)

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 ClusterStatsDescriptor Timeout(Time timeout)
Parameters
Type Name Description
Time timeout
Returns
Type Description
ClusterStatsDescriptor

Implements

Extension Methods