Class CatAliasesRequest

Request for Aliases

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

Inheritance
object
RequestBase<CatAliasesRequestParameters>
PlainRequestBase<CatAliasesRequestParameters>
CatAliasesRequest
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class CatAliasesRequest : PlainRequestBase<CatAliasesRequestParameters>, ICatAliasesRequest, IRequest<CatAliasesRequestParameters>, IRequest

Constructors

| Edit this page View Source

CatAliasesRequest()

/_cat/aliases

Declaration
public CatAliasesRequest()
| Edit this page View Source

CatAliasesRequest(Names)

/_cat/aliases/{name}

Declaration
public CatAliasesRequest(Names name)
Parameters
Type Name Description
Names name

Optional, accepts null

Properties

| Edit this page View Source

ExpandWildcards

Whether to expand wildcard expression to concrete indexes that are open, closed or both.

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

Format

A short version of the Accept header (for example, json, yaml).

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

Headers

Comma-separated list of column names to display.

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

Help

Return help information.

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

Local

Return local information, do not retrieve the state from cluster-manager node.

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

Self

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

SortByColumns

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

Verbose mode. Display column headers.

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

Implements

Extension Methods