Class CatIndicesRequest

Request for Indices

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

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

Constructors

| Edit this page View Source

CatIndicesRequest()

/_cat/indices

Declaration
public CatIndicesRequest()
| Edit this page View Source

CatIndicesRequest(Indices)

/_cat/indices/{index}

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

Optional, accepts null

Properties

| Edit this page View Source

Bytes

The units used to display byte values.

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

ClusterManagerTimeout

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

Declaration
public Time ClusterManagerTimeout { get; set; }
Property Value
Type Description
Time
Remarks

Supported by OpenSearch servers of version 2.0.0 or greater.

| Edit this page View Source

ExpandWildcards

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

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

Format

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

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

Headers

A comma-separated list of column names to display.

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

Health

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

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

Help

Returns help information.

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

IncludeUnloadedSegments

Whether to include information from segments not loaded into memory.

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

Local

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

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

MasterTimeout

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

Pri

When true, returns information only from the primary shards.

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

Self

Declaration
protected ICatIndicesRequest Self { get; }
Property Value
Type Description
ICatIndicesRequest
| Edit this page View Source

SortByColumns

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

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

Verbose

Enables verbose mode, which displays column headers.

Declaration
public bool? Verbose { get; set; }
Property Value
Type Description
bool?

Implements

Extension Methods