Class IndicesStatsRequest

Request for Stats

https://opensearch.org/docs/latest

Inheritance
object
RequestBase<IndicesStatsRequestParameters>
PlainRequestBase<IndicesStatsRequestParameters>
IndicesStatsRequest
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class IndicesStatsRequest : PlainRequestBase<IndicesStatsRequestParameters>, IIndicesStatsRequest, IRequest<IndicesStatsRequestParameters>, IRequest

Constructors

| Edit this page View Source

IndicesStatsRequest()

/_stats

Declaration
public IndicesStatsRequest()
| Edit this page View Source

IndicesStatsRequest(Indices)

/{index}/_stats

Declaration
public IndicesStatsRequest(Indices index)
Parameters
Type Name Description
Indices index

Optional, accepts null
| Edit this page View Source

IndicesStatsRequest(Indices, Metrics)

/{index}/_stats/{metric}

Declaration
public IndicesStatsRequest(Indices index, Metrics metric)
Parameters
Type Name Description
Indices index

Optional, accepts null
Metrics metric

Optional, accepts null
| Edit this page View Source

IndicesStatsRequest(Metrics)

/_stats/{metric}

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

Optional, accepts null

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 Fields CompletionFields { get; set; }
Property Value
Type Description
Fields
| Edit this page View Source

ExpandWildcards

Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden.

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

FielddataFields

A 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

A 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

ForbidClosedIndices

If true, statistics are not collected from closed indexes.

Declaration
public bool? ForbidClosedIndices { get; set; }
Property Value
Type Description
bool?
| 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

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

IncludeUnloadedSegments

If true, the response includes information from segments that are not loaded into memory.

Declaration
public bool? IncludeUnloadedSegments { 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 IIndicesStatsRequest Self { get; }
Property Value
Type Description
IIndicesStatsRequest

Implements

Extension Methods