Class CatAliasesRequestParameters

Request options for Aliases

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

Inheritance

object

RequestParameters<CatAliasesRequestParameters>

CatAliasesRequestParameters

Implements

IRequestParameters

Inherited Members

RequestParameters<CatAliasesRequestParameters>.CustomResponseBuilder

RequestParameters<CatAliasesRequestParameters>.QueryString

RequestParameters<CatAliasesRequestParameters>.RequestConfiguration

RequestParameters<CatAliasesRequestParameters>.ContainsQueryString(string)

RequestParameters<CatAliasesRequestParameters>.GetQueryStringValue<TOut>(string)

RequestParameters<CatAliasesRequestParameters>.GetResolvedQueryStringValue(string, IConnectionConfigurationValues)

RequestParameters<CatAliasesRequestParameters>.SetQueryString(string, object)

RequestParameters<CatAliasesRequestParameters>.Q<TOut>(string)

RequestParameters<CatAliasesRequestParameters>.Q(string, object)

RequestParameters<CatAliasesRequestParameters>.SetAcceptHeader(string)

RequestParameters<CatAliasesRequestParameters>.AcceptHeaderFromFormat(string)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: OpenSearch.Net.Specification.CatApi

Assembly: OpenSearch.Net.dll

Syntax

public class CatAliasesRequestParameters : RequestParameters<CatAliasesRequestParameters>, IRequestParameters

Properties

DefaultHttpMethod

Declaration

public override HttpMethod DefaultHttpMethod { get; }

Property Value

Type	Description
HttpMethod

Overrides

RequestParameters<CatAliasesRequestParameters>.DefaultHttpMethod

ExpandWildcards

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

Declaration

public ExpandWildcards? ExpandWildcards { get; set; }

Property Value

Type	Description
ExpandWildcards?

Format

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

Declaration

public string Format { get; set; }

Property Value

Type	Description
string

Headers

Comma-separated list of column names to display.

Declaration

public string[] Headers { get; set; }

Property Value

Type	Description
string[]

Help

Return help information.

Declaration

public bool? Help { get; set; }

Property Value

Type	Description
bool?

Local

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

Declaration

public bool? Local { get; set; }

Property Value

Type	Description
bool?

SortByColumns

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

Declaration

public string[] SortByColumns { get; set; }

Property Value

Type	Description
string[]

SupportsBody

Declaration

public override bool SupportsBody { get; }

Property Value

Type	Description
bool

Overrides

RequestParameters<CatAliasesRequestParameters>.SupportsBody

Verbose

Verbose mode. Display column headers.

Declaration

public bool? Verbose { get; set; }

Property Value

Type	Description
bool?

Implements

IRequestParameters

Extension Methods

SuffixExtensions.Suffix(object, string)