Class NodesStatsRequest

Request for Stats

https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-usage/

Inheritance
object
RequestBase<NodesStatsRequestParameters>
PlainRequestBase<NodesStatsRequestParameters>
NodesStatsRequest
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class NodesStatsRequest : PlainRequestBase<NodesStatsRequestParameters>, INodesStatsRequest, IRequest<NodesStatsRequestParameters>, IRequest

Constructors

| Edit this page View Source

NodesStatsRequest()

/_nodes/stats

Declaration
public NodesStatsRequest()
| Edit this page View Source

NodesStatsRequest(Metrics)

/_nodes/stats/{metric}

Declaration
public NodesStatsRequest(Metrics metric)
Parameters
Type Name Description
Metrics metric

Optional, accepts null
| Edit this page View Source

NodesStatsRequest(Metrics, IndexMetrics)

/_nodes/stats/{metric}/{index_metric}

Declaration
public NodesStatsRequest(Metrics metric, IndexMetrics indexMetric)
Parameters
Type Name Description
Metrics metric

Optional, accepts null
IndexMetrics indexMetric

Optional, accepts null
| Edit this page View Source

NodesStatsRequest(NodeIds)

/_nodes/{node_id}/stats

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

Optional, accepts null
| Edit this page View Source

NodesStatsRequest(NodeIds, Metrics)

/_nodes/{node_id}/stats/{metric}

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

Optional, accepts null
Metrics metric

Optional, accepts null
| Edit this page View Source

NodesStatsRequest(NodeIds, Metrics, IndexMetrics)

/_nodes/{node_id}/stats/{metric}/{index_metric}

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

Optional, accepts null
Metrics metric

Optional, accepts null
IndexMetrics indexMetric

Optional, accepts null

Properties

| Edit this page View Source

CompletionFields

Comma-separated list or wildcard expressions of fields to include in field data and suggest statistics.

Declaration
public Fields CompletionFields { get; set; }
Property Value
Type Description
Fields
| Edit this page View Source

FielddataFields

Comma-separated list or wildcard expressions of fields to include in field data statistics.

Declaration
public Fields FielddataFields { get; set; }
Property Value
Type Description
Fields
| Edit this page View Source

Fields

Comma-separated list or wildcard expressions of fields to include in the statistics.

Declaration
public Fields Fields { get; set; }
Property Value
Type Description
Fields
| Edit this page View Source

Groups

Comma-separated list of search groups to include in the search statistics.

Declaration
public string[] Groups { get; set; }
Property Value
Type Description
string[]
| Edit this page View Source

IncludeSegmentFileSizes

If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested).

Declaration
public bool? IncludeSegmentFileSizes { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

Level

Indicates whether statistics are aggregated at the cluster, index, or shard level.

Declaration
public Level? Level { get; set; }
Property Value
Type Description
Level?
| Edit this page View Source

Self

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

Timeout

Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

Declaration
public Time Timeout { get; set; }
Property Value
Type Description
Time
| Edit this page View Source

Types

A comma-separated list of document types for the indexing index metric.

Declaration
public string[] Types { get; set; }
Property Value
Type Description
string[]

Implements

Extension Methods