Class CatIndicesRequestParameters

Request options for Indices

<p>https://docs.opensearch.org/latest/api-reference/cat/cat-indices/</p>
Inheritance
object
RequestParameters<CatIndicesRequestParameters>
CatIndicesRequestParameters
Implements
Inherited Members
Namespace: OpenSearch.Net.Specification.CatApi
Assembly: OpenSearch.Net.dll
Syntax
public class CatIndicesRequestParameters : RequestParameters<CatIndicesRequestParameters>, IRequestParameters

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 TimeSpan ClusterManagerTimeout { get; set; }
Property Value
Type Description
TimeSpan
Remarks

Supported by OpenSearch servers of version 2.0.0 or greater.

| Edit this page View Source

DefaultHttpMethod

Declaration
public override HttpMethod DefaultHttpMethod { get; }
Property Value
Type Description
HttpMethod
Overrides
| 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 CatResponseFormat? Format { get; set; }
Property Value
Type Description
CatResponseFormat?
| 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 TimeSpan MasterTimeout { get; set; }
Property Value
Type Description
TimeSpan
| Edit this page View Source

OperationName

The OpenSearch REST API operation name this request maps to (for example search or indices.create), used as the OpenTelemetry span name and db.operation tag. null for requests that do not correspond to a named API operation.

Declaration
public override string OperationName { get; }
Property Value
Type Description
string
Overrides
| 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

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

SupportsBody

Declaration
public override bool SupportsBody { get; }
Property Value
Type Description
bool
Overrides
| 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