Class CatAliasesDescriptor

Descriptor for Aliases

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

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

Constructors

| Edit this page View Source

CatAliasesDescriptor()

/_cat/aliases

Declaration
public CatAliasesDescriptor()
| Edit this page View Source

CatAliasesDescriptor(Names)

/_cat/aliases/{name}

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

Optional, accepts null

Methods

| Edit this page View Source

ExpandWildcards(ExpandWildcards?)

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

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

Format(string)

A short version of the Accept header, e.g. json, yaml.

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

Headers(params string[])

Comma-separated list of column names to display.

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

Help(bool?)

Return help information.

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

Local(bool?)

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

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

Name(Names)

A comma-separated list of aliases to retrieve. Supports wildcards (*). To retrieve all aliases, omit this parameter or use * or _all.

Declaration
public CatAliasesDescriptor Name(Names name)
Parameters
Type Name Description
Names name
Returns
Type Description
CatAliasesDescriptor
| Edit this page View Source

SortByColumns(params string[])

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

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

Verbose(bool?)

Verbose mode. Display column headers.

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

Implements

Extension Methods