Class NodesStatsDescriptor

Descriptor for Stats

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

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

Constructors

| Edit this page View Source

NodesStatsDescriptor()

/_nodes/stats

Declaration
public NodesStatsDescriptor()
| Edit this page View Source

NodesStatsDescriptor(Metrics)

/_nodes/stats/{metric}

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

Optional, accepts null
| Edit this page View Source

NodesStatsDescriptor(Metrics, IndexMetrics)

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

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

Optional, accepts null
IndexMetrics indexMetric

Optional, accepts null
| Edit this page View Source

NodesStatsDescriptor(NodeIds)

/_nodes/{node_id}/stats

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

Optional, accepts null
| Edit this page View Source

NodesStatsDescriptor(NodeIds, Metrics)

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

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

Optional, accepts null
Metrics metric

Optional, accepts null
| Edit this page View Source

NodesStatsDescriptor(NodeIds, Metrics, IndexMetrics)

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

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

Methods

| Edit this page View Source

CompletionFields(Fields)

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

Declaration
public NodesStatsDescriptor CompletionFields(Fields completionfields)
Parameters
Type Name Description
Fields completionfields
Returns
Type Description
NodesStatsDescriptor
| Edit this page View Source

CompletionFields<T>(params Expression<Func<T, object>>[])

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

Declaration
public NodesStatsDescriptor CompletionFields<T>(params Expression<Func<T, object>>[] fields) where T : class
Parameters
Type Name Description
Expression<Func<T, object>>[] fields
Returns
Type Description
NodesStatsDescriptor
Type Parameters
Name Description
T
| Edit this page View Source

FielddataFields(Fields)

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

Declaration
public NodesStatsDescriptor FielddataFields(Fields fielddatafields)
Parameters
Type Name Description
Fields fielddatafields
Returns
Type Description
NodesStatsDescriptor
| Edit this page View Source

FielddataFields<T>(params Expression<Func<T, object>>[])

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

Declaration
public NodesStatsDescriptor FielddataFields<T>(params Expression<Func<T, object>>[] fields) where T : class
Parameters
Type Name Description
Expression<Func<T, object>>[] fields
Returns
Type Description
NodesStatsDescriptor
Type Parameters
Name Description
T
| Edit this page View Source

Fields(Fields)

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

Declaration
public NodesStatsDescriptor Fields(Fields fields)
Parameters
Type Name Description
Fields fields
Returns
Type Description
NodesStatsDescriptor
| Edit this page View Source

Fields<T>(params Expression<Func<T, object>>[])

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

Declaration
public NodesStatsDescriptor Fields<T>(params Expression<Func<T, object>>[] fields) where T : class
Parameters
Type Name Description
Expression<Func<T, object>>[] fields
Returns
Type Description
NodesStatsDescriptor
Type Parameters
Name Description
T
| Edit this page View Source

Groups(params string[])

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

Declaration
public NodesStatsDescriptor Groups(params string[] groups)
Parameters
Type Name Description
string[] groups
Returns
Type Description
NodesStatsDescriptor
| Edit this page View Source

IncludeSegmentFileSizes(bool?)

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

IndexMetric(IndexMetrics)

Limit the information returned for indexes metric to the specific index metrics. It can be used only if indexes (or all) metric is specified.

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

Level(Level?)

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

Declaration
public NodesStatsDescriptor Level(Level? level)
Parameters
Type Name Description
Level? level
Returns
Type Description
NodesStatsDescriptor
| Edit this page View Source

Metric(Metrics)

Limit the information returned to the specified metrics.

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

NodeId(NodeIds)

Comma-separated list of node IDs or names used to limit returned information.

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

Timeout(Time)

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

Declaration
public NodesStatsDescriptor Timeout(Time timeout)
Parameters
Type Name Description
Time timeout
Returns
Type Description
NodesStatsDescriptor
| Edit this page View Source

Types(params string[])

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

Declaration
public NodesStatsDescriptor Types(params string[] types)
Parameters
Type Name Description
string[] types
Returns
Type Description
NodesStatsDescriptor

Implements

Extension Methods