Class IndicesStatsDescriptor

Descriptor for Stats

https://opensearch.org/docs/latest

Inheritance

object

RequestBase<IndicesStatsRequestParameters>

RequestDescriptorBase<IndicesStatsDescriptor, IndicesStatsRequestParameters, IIndicesStatsRequest>

IndicesStatsDescriptor

Implements

IDescriptor

IIndicesStatsRequest

IRequest<IndicesStatsRequestParameters>

IRequest

Inherited Members

RequestDescriptorBase<IndicesStatsDescriptor, IndicesStatsRequestParameters, IIndicesStatsRequest>.Self

RequestDescriptorBase<IndicesStatsDescriptor, IndicesStatsRequestParameters, IIndicesStatsRequest>.Assign<TValue>(TValue, Action<IIndicesStatsRequest, TValue>)

RequestDescriptorBase<IndicesStatsDescriptor, IndicesStatsRequestParameters, IIndicesStatsRequest>.Qs(string, object)

RequestDescriptorBase<IndicesStatsDescriptor, IndicesStatsRequestParameters, IIndicesStatsRequest>.RequestConfiguration(Func<RequestConfigurationDescriptor, IRequestConfiguration>)

RequestDescriptorBase<IndicesStatsDescriptor, IndicesStatsRequestParameters, IIndicesStatsRequest>.ErrorTrace(bool?)

RequestDescriptorBase<IndicesStatsDescriptor, IndicesStatsRequestParameters, IIndicesStatsRequest>.FilterPath(params string[])

RequestDescriptorBase<IndicesStatsDescriptor, IndicesStatsRequestParameters, IIndicesStatsRequest>.FilterPath(IEnumerable<string>)

RequestDescriptorBase<IndicesStatsDescriptor, IndicesStatsRequestParameters, IIndicesStatsRequest>.Human(bool?)

RequestDescriptorBase<IndicesStatsDescriptor, IndicesStatsRequestParameters, IIndicesStatsRequest>.Pretty(bool?)

RequestDescriptorBase<IndicesStatsDescriptor, IndicesStatsRequestParameters, IIndicesStatsRequest>.SourceQueryString(string)

RequestBase<IndicesStatsRequestParameters>.HttpMethod

RequestBase<IndicesStatsRequestParameters>.RequestState

RequestBase<IndicesStatsRequestParameters>.ContentType

RequestBase<IndicesStatsRequestParameters>.ResolveUrl(RouteValues, IConnectionSettingsValues)

RequestBase<IndicesStatsRequestParameters>.RequestDefaults(IndicesStatsRequestParameters)

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

RequestBase<IndicesStatsRequestParameters>.Q(string, object)

RequestBase<IndicesStatsRequestParameters>.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 IndicesStatsDescriptor : RequestDescriptorBase<IndicesStatsDescriptor, IndicesStatsRequestParameters, IIndicesStatsRequest>, IDescriptor, IIndicesStatsRequest, IRequest<IndicesStatsRequestParameters>, IRequest

Constructors

IndicesStatsDescriptor()

/_stats

Declaration

public IndicesStatsDescriptor()

IndicesStatsDescriptor(Indices)

/{index}/_stats

Declaration

public IndicesStatsDescriptor(Indices index)

Parameters

Type	Name	Description
Indices	index	Optional, accepts null

IndicesStatsDescriptor(Indices, Metrics)

/{index}/_stats/{metric}

Declaration

public IndicesStatsDescriptor(Indices index, Metrics metric)

Parameters

Type	Name	Description
Indices	index	Optional, accepts null
Metrics	metric	Optional, accepts null

IndicesStatsDescriptor(Metrics)

/_stats/{metric}

Declaration

public IndicesStatsDescriptor(Metrics metric)

Parameters

Type	Name	Description
Metrics	metric	Optional, accepts null

Methods

AllIndices()

A shortcut into calling Index(Indices.All)

Declaration

public IndicesStatsDescriptor AllIndices()

Returns

Type	Description
IndicesStatsDescriptor

CompletionFields(Fields)

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

Declaration

public IndicesStatsDescriptor CompletionFields(Fields completionfields)

Parameters

Type	Name	Description
Fields	completionfields

Returns

Type	Description
IndicesStatsDescriptor

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 IndicesStatsDescriptor CompletionFields<T>(params Expression<Func<T, object>>[] fields) where T : class

Parameters

Type	Name	Description
Expression<Func<T, object>>[]	fields

Returns

Type	Description
IndicesStatsDescriptor

Type Parameters

Name	Description
T

ExpandWildcards(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 IndicesStatsDescriptor ExpandWildcards(ExpandWildcards? expandwildcards)

Parameters

Type	Name	Description
ExpandWildcards?	expandwildcards

Returns

Type	Description
IndicesStatsDescriptor

FielddataFields(Fields)

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

Declaration

public IndicesStatsDescriptor FielddataFields(Fields fielddatafields)

Parameters

Type	Name	Description
Fields	fielddatafields

Returns

Type	Description
IndicesStatsDescriptor

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

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

Declaration

public IndicesStatsDescriptor FielddataFields<T>(params Expression<Func<T, object>>[] fields) where T : class

Parameters

Type	Name	Description
Expression<Func<T, object>>[]	fields

Returns

Type	Description
IndicesStatsDescriptor

Type Parameters

Name	Description
T

Fields(Fields)

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

Declaration

public IndicesStatsDescriptor Fields(Fields fields)

Parameters

Type	Name	Description
Fields	fields

Returns

Type	Description
IndicesStatsDescriptor

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

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

Declaration

public IndicesStatsDescriptor Fields<T>(params Expression<Func<T, object>>[] fields) where T : class

Parameters

Type	Name	Description
Expression<Func<T, object>>[]	fields

Returns

Type	Description
IndicesStatsDescriptor

Type Parameters

Name	Description
T

ForbidClosedIndices(bool?)

If true, statistics are not collected from closed indexes.

Declaration

public IndicesStatsDescriptor ForbidClosedIndices(bool? forbidclosedindices = true)

Parameters

Type	Name	Description
bool?	forbidclosedindices

Returns

Type	Description
IndicesStatsDescriptor

Groups(params string[])

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

Declaration

public IndicesStatsDescriptor Groups(params string[] groups)

Parameters

Type	Name	Description
string[]	groups

Returns

Type	Description
IndicesStatsDescriptor

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 IndicesStatsDescriptor IncludeSegmentFileSizes(bool? includesegmentfilesizes = true)

Parameters

Type	Name	Description
bool?	includesegmentfilesizes

Returns

Type	Description
IndicesStatsDescriptor

IncludeUnloadedSegments(bool?)

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

Declaration

public IndicesStatsDescriptor IncludeUnloadedSegments(bool? includeunloadedsegments = true)

Parameters

Type	Name	Description
bool?	includeunloadedsegments

Returns

Type	Description
IndicesStatsDescriptor

Index(Indices)

A comma-separated list of index names; use the special string _all or Indices.All to perform the operation on all indexes.

Declaration

public IndicesStatsDescriptor Index(Indices index)

Parameters

Type	Name	Description
Indices	index

Returns

Type	Description
IndicesStatsDescriptor

Index<TOther>()

a shortcut into calling Index(typeof(TOther))

Declaration

public IndicesStatsDescriptor Index<TOther>() where TOther : class

Returns

Type	Description
IndicesStatsDescriptor

Type Parameters

Name	Description
TOther

Level(Level?)

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

Declaration

public IndicesStatsDescriptor Level(Level? level)

Parameters

Type	Name	Description
Level?	level

Returns

Type	Description
IndicesStatsDescriptor

Metric(Metrics)

Limit the information returned the specific metrics.

Declaration

public IndicesStatsDescriptor Metric(Metrics metric)

Parameters

Type	Name	Description
Metrics	metric

Returns

Type	Description
IndicesStatsDescriptor

Implements

IDescriptor

IIndicesStatsRequest

IRequest<TParameters>

IRequest

Extension Methods

SuffixExtensions.Suffix(object, string)