Class ClusterStatsRequest
Request for Stats
https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-stats/
Inheritance
ClusterStatsRequest
Inherited Members
Namespace: OpenSearch .Client
Assembly: OpenSearch.Client.dll
Syntax
public class ClusterStatsRequest : PlainRequestBase<ClusterStatsRequestParameters>, IClusterStatsRequest, IRequest<ClusterStatsRequestParameters>, IRequest
Constructors
| Edit this page View SourceClusterStatsRequest()
/_cluster/stats
Declaration
public ClusterStatsRequest()
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 |
Index |
indexMetric | Optional, accepts null |
Node |
nodeId | Optional, accepts null |
ClusterStatsRequest(Metrics, NodeIds)
/_cluster/stats/{metric}/nodes/{node_id}
Declaration
public ClusterStatsRequest(Metrics metric, NodeIds nodeId)
Parameters
| Edit this page View SourceClusterStatsRequest(NodeIds)
/_cluster/stats/nodes/{node_id}
Declaration
public ClusterStatsRequest(NodeIds nodeId)
Parameters
Type | Name | Description |
---|---|---|
Node |
nodeId | Optional, accepts null |
Properties
| Edit this page View SourceFlatSettings
When true
, returns settings in a flat format.
Declaration
public bool? FlatSettings { get; set; }
Property Value
Type | Description |
---|---|
bool? |
Self
Declaration
protected IClusterStatsRequest Self { get; }
Property Value
Type | Description |
---|---|
ICluster |
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 |