Class NodesStatsRequest

Request for Stats

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

Inheritance

object

RequestBase<NodesStatsRequestParameters>

PlainRequestBase<NodesStatsRequestParameters>

NodesStatsRequest

Implements

INodesStatsRequest

IRequest<NodesStatsRequestParameters>

IRequest

Inherited Members

PlainRequestBase<NodesStatsRequestParameters>.RequestConfiguration

PlainRequestBase<NodesStatsRequestParameters>.ErrorTrace

PlainRequestBase<NodesStatsRequestParameters>.FilterPath

PlainRequestBase<NodesStatsRequestParameters>.Human

PlainRequestBase<NodesStatsRequestParameters>.Pretty

PlainRequestBase<NodesStatsRequestParameters>.SourceQueryString

RequestBase<NodesStatsRequestParameters>.HttpMethod

RequestBase<NodesStatsRequestParameters>.RequestState

RequestBase<NodesStatsRequestParameters>.ContentType

RequestBase<NodesStatsRequestParameters>.ResolveUrl(RouteValues, IConnectionSettingsValues)

RequestBase<NodesStatsRequestParameters>.RequestDefaults(NodesStatsRequestParameters)

RequestBase<NodesStatsRequestParameters>.Q<TOut>(string)

RequestBase<NodesStatsRequestParameters>.Q(string, object)

RequestBase<NodesStatsRequestParameters>.SetAcceptHeader(string)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: OpenSearch.Client

Assembly: OpenSearch.Client.dll

Syntax

public class NodesStatsRequest : PlainRequestBase<NodesStatsRequestParameters>, INodesStatsRequest, IRequest<NodesStatsRequestParameters>, IRequest

Constructors

NodesStatsRequest()

/_nodes/stats

Declaration

public NodesStatsRequest()

NodesStatsRequest(Metrics)

/_nodes/stats/{metric}

Declaration

public NodesStatsRequest(Metrics metric)

Parameters

Type	Name	Description
Metrics	metric	Optional, accepts null

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

NodesStatsRequest(NodeIds)

/_nodes/{node_id}/stats

Declaration

public NodesStatsRequest(NodeIds nodeId)

Parameters

Type	Name	Description
NodeIds	nodeId	Optional, accepts null

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

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

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

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

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

Groups

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

Declaration

public string[] Groups { get; set; }

Property Value

Type	Description
string[]

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?

Level

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

Declaration

public Level? Level { get; set; }

Property Value

Type	Description
Level?

Self

Declaration

protected INodesStatsRequest Self { get; }

Property Value

Type	Description
INodesStatsRequest

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

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

INodesStatsRequest

IRequest<TParameters>

IRequest

Extension Methods

SuffixExtensions.Suffix(object, string)