Class CatIndicesDescriptor

Descriptor for Indices

https://opensearch.org/docs/latest/api-reference/cat/cat-indices/

Inheritance
object
RequestBase<CatIndicesRequestParameters>
RequestDescriptorBase<CatIndicesDescriptor, CatIndicesRequestParameters, ICatIndicesRequest>
CatIndicesDescriptor
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class CatIndicesDescriptor : RequestDescriptorBase<CatIndicesDescriptor, CatIndicesRequestParameters, ICatIndicesRequest>, IDescriptor, ICatIndicesRequest, IRequest<CatIndicesRequestParameters>, IRequest

Constructors

| Edit this page View Source

CatIndicesDescriptor()

/_cat/indices

Declaration
public CatIndicesDescriptor()
| Edit this page View Source

CatIndicesDescriptor(Indices)

/_cat/indices/{index}

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

Optional, accepts null

Methods

| Edit this page View Source

AllIndices()

A shortcut into calling Index(Indices.All)

Declaration
public CatIndicesDescriptor AllIndices()
Returns
Type Description
CatIndicesDescriptor
| Edit this page View Source

Bytes(ByteUnit?)

The units used to display byte values.

Declaration
public CatIndicesDescriptor Bytes(ByteUnit? bytes)
Parameters
Type Name Description
ByteUnit? bytes
Returns
Type Description
CatIndicesDescriptor
| Edit this page View Source

ClusterManagerTimeout(Time)

The amount of time allowed to establish a connection to the cluster manager node.

Declaration
public CatIndicesDescriptor ClusterManagerTimeout(Time clustermanagertimeout)
Parameters
Type Name Description
Time clustermanagertimeout
Returns
Type Description
CatIndicesDescriptor
Remarks

Supported by OpenSearch servers of version 2.0.0 or greater.

| Edit this page View Source

ExpandWildcards(ExpandWildcards?)

Specifies the type of index that wildcard expressions can match. Supports comma-separated values.

Declaration
public CatIndicesDescriptor ExpandWildcards(ExpandWildcards? expandwildcards)
Parameters
Type Name Description
ExpandWildcards? expandwildcards
Returns
Type Description
CatIndicesDescriptor
| Edit this page View Source

Format(string)

A short version of the Accept header, such as json or yaml.

Declaration
public CatIndicesDescriptor Format(string format)
Parameters
Type Name Description
string format
Returns
Type Description
CatIndicesDescriptor
| Edit this page View Source

Headers(params string[])

A comma-separated list of column names to display.

Declaration
public CatIndicesDescriptor Headers(params string[] headers)
Parameters
Type Name Description
string[] headers
Returns
Type Description
CatIndicesDescriptor
| Edit this page View Source

Health(HealthStatus?)

Limits indexes based on their health status. Supported values are green, yellow, and red.

Declaration
public CatIndicesDescriptor Health(HealthStatus? health)
Parameters
Type Name Description
HealthStatus? health
Returns
Type Description
CatIndicesDescriptor
| Edit this page View Source

Help(bool?)

Returns help information.

Declaration
public CatIndicesDescriptor Help(bool? help = true)
Parameters
Type Name Description
bool? help
Returns
Type Description
CatIndicesDescriptor
| Edit this page View Source

IncludeUnloadedSegments(bool?)

Whether to include information from segments not loaded into memory.

Declaration
public CatIndicesDescriptor IncludeUnloadedSegments(bool? includeunloadedsegments = true)
Parameters
Type Name Description
bool? includeunloadedsegments
Returns
Type Description
CatIndicesDescriptor
| Edit this page View Source

Index(Indices)

A comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indexes, omit this parameter or use * or _all.

Declaration
public CatIndicesDescriptor Index(Indices index)
Parameters
Type Name Description
Indices index
Returns
Type Description
CatIndicesDescriptor
| Edit this page View Source

Index<TOther>()

a shortcut into calling Index(typeof(TOther))

Declaration
public CatIndicesDescriptor Index<TOther>() where TOther : class
Returns
Type Description
CatIndicesDescriptor
Type Parameters
Name Description
TOther
| Edit this page View Source

Local(bool?)

Returns local information but does not retrieve the state from the cluster manager node.

Declaration
public CatIndicesDescriptor Local(bool? local = true)
Parameters
Type Name Description
bool? local
Returns
Type Description
CatIndicesDescriptor
| Edit this page View Source

MasterTimeout(Time)

The amount of time allowed to establish a connection to the cluster manager node.

Declaration
[Obsolete("Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead.")]
public CatIndicesDescriptor MasterTimeout(Time mastertimeout)
Parameters
Type Name Description
Time mastertimeout
Returns
Type Description
CatIndicesDescriptor
| Edit this page View Source

Pri(bool?)

When true, returns information only from the primary shards.

Declaration
public CatIndicesDescriptor Pri(bool? pri = true)
Parameters
Type Name Description
bool? pri
Returns
Type Description
CatIndicesDescriptor
| Edit this page View Source

SortByColumns(params string[])

A comma-separated list of column names or column aliases to sort by.

Declaration
public CatIndicesDescriptor SortByColumns(params string[] sortbycolumns)
Parameters
Type Name Description
string[] sortbycolumns
Returns
Type Description
CatIndicesDescriptor
| Edit this page View Source

Verbose(bool?)

Enables verbose mode, which displays column headers.

Declaration
public CatIndicesDescriptor Verbose(bool? verbose = true)
Parameters
Type Name Description
bool? verbose
Returns
Type Description
CatIndicesDescriptor

Implements

Extension Methods