Class StatsRequestParameters
Request options for Stats
Implements
Inherited Members
Namespace: OpenSearch .Net.Specification.NeuralApi
Assembly: OpenSearch.Net.dll
Syntax
public class StatsRequestParameters : RequestParameters<StatsRequestParameters>, IRequestParameters
Properties
| Edit this page View SourceDefaultHttpMethod
Declaration
public override HttpMethod DefaultHttpMethod { get; }
Property Value
Type | Description |
---|---|
Http |
Overrides
| Edit this page View SourceFlatStatPaths
Whether to return stats in the flat form, which can improve readability, especially for heavily nested stats. For example, the flat form
of "processors": { "ingest": { "text_embedding_executions": 20181212 } }
is
"processors.ingest.text_embedding_executions": "20181212"
.
Declaration
public bool? FlatStatPaths { get; set; }
Property Value
Type | Description |
---|---|
bool? |
IncludeAllNodes
When true
includes aggregated statistics across all nodes in the all_nodes
category. When false
, excludes the
all_nodes
category from the response.
Declaration
public bool? IncludeAllNodes { get; set; }
Property Value
Type | Description |
---|---|
bool? |
Remarks
Supported by OpenSearch servers of version 3.1.0 or greater.
IncludeIndividualNodes
When true
includes statistics for individual nodes in the nodes
category. When false
, excludes the nodes
category from the response.
Declaration
public bool? IncludeIndividualNodes { get; set; }
Property Value
Type | Description |
---|---|
bool? |
Remarks
Supported by OpenSearch servers of version 3.1.0 or greater.
IncludeInfo
When true
includes cluster-wide information in the info
category. When false
, excludes the info
category from
the response.
Declaration
public bool? IncludeInfo { get; set; }
Property Value
Type | Description |
---|---|
bool? |
Remarks
Supported by OpenSearch servers of version 3.1.0 or greater.
IncludeMetadata
Whether to return stat metadata instead of the raw stat value, includes additional information about the stat. These can include things like type hints, time since last stats being recorded, or recent rolling interval values.
Declaration
public bool? IncludeMetadata { get; set; }
Property Value
Type | Description |
---|---|
bool? |
SupportsBody
Declaration
public override bool SupportsBody { get; }
Property Value
Type | Description |
---|---|
bool |