Class ClusterStatsDescriptor
Descriptor for Stats
https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-stats/
Inheritance
ClusterStatsDescriptor
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class ClusterStatsDescriptor : RequestDescriptorBase<ClusterStatsDescriptor, ClusterStatsRequestParameters, IClusterStatsRequest>, IDescriptor, IClusterStatsRequest, IRequest<ClusterStatsRequestParameters>, IRequestConstructors
| Edit this page View SourceClusterStatsDescriptor()
/_cluster/stats
Declaration
public ClusterStatsDescriptor()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 SourceFlatSettings(bool?)
If true, returns settings in flat format.
Declaration
public ClusterStatsDescriptor FlatSettings(bool? flatsettings = true)Parameters
| Type | Name | Description |
|---|---|---|
| bool? | flatsettings |
Returns
| Type | Description |
|---|---|
| ClusterStatsDescriptor |
NodeId(NodeIds)
Comma-separated list of node filters used to limit returned information. Defaults to all nodes in the cluster.
Declaration
public ClusterStatsDescriptor NodeId(NodeIds nodeId)Parameters
| Type | Name | Description |
|---|---|---|
| NodeIds | nodeId |
Returns
| Type | Description |
|---|---|
| ClusterStatsDescriptor |
Timeout(Time)
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 ClusterStatsDescriptor Timeout(Time timeout)Parameters
| Type | Name | Description |
|---|---|---|
| Time | timeout |
Returns
| Type | Description |
|---|---|
| ClusterStatsDescriptor |