Class NodesStatsRequestParameters

Request options for Stats

<p>https://docs.opensearch.org/latest/api-reference/nodes-apis/nodes-usage/</p>
Inheritance
object
RequestParameters<NodesStatsRequestParameters>
NodesStatsRequestParameters
Implements
Inherited Members
Namespace: OpenSearch.Net.Specification.NodesApi
Assembly: OpenSearch.Net.dll
Syntax
public class NodesStatsRequestParameters : RequestParameters<NodesStatsRequestParameters>, IRequestParameters

Properties

| Edit this page View Source

CompletionFields

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

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

DefaultHttpMethod

Declaration
public override HttpMethod DefaultHttpMethod { get; }
Property Value
Type Description
HttpMethod
Overrides
| Edit this page View Source

FielddataFields

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

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

Fields

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

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

Groups

A 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

When true, 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

OperationName

The OpenSearch REST API operation name this request maps to (for example search or indices.create), used as the OpenTelemetry span name and db.operation tag. null for requests that do not correspond to a named API operation.

Declaration
public override string OperationName { get; }
Property Value
Type Description
string
Overrides
| Edit this page View Source

SupportsBody

Declaration
public override bool SupportsBody { get; }
Property Value
Type Description
bool
Overrides
| Edit this page View Source

Timeout

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

Declaration
public TimeSpan Timeout { get; set; }
Property Value
Type Description
TimeSpan
| 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