Search Results for

    Show / Hide Table of Contents

    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
    IDescriptor
    ICatAliasesRequest
    IRequest<CatAliasesRequestParameters>
    IRequest
    Inherited Members
    RequestDescriptorBase<CatAliasesDescriptor, CatAliasesRequestParameters, ICatAliasesRequest>.Self
    RequestDescriptorBase<CatAliasesDescriptor, CatAliasesRequestParameters, ICatAliasesRequest>.Assign<TValue>(TValue, Action<ICatAliasesRequest, TValue>)
    RequestDescriptorBase<CatAliasesDescriptor, CatAliasesRequestParameters, ICatAliasesRequest>.Qs(string, object)
    RequestDescriptorBase<CatAliasesDescriptor, CatAliasesRequestParameters, ICatAliasesRequest>.RequestConfiguration(Func<RequestConfigurationDescriptor, IRequestConfiguration>)
    RequestDescriptorBase<CatAliasesDescriptor, CatAliasesRequestParameters, ICatAliasesRequest>.ErrorTrace(bool?)
    RequestDescriptorBase<CatAliasesDescriptor, CatAliasesRequestParameters, ICatAliasesRequest>.FilterPath(params string[])
    RequestDescriptorBase<CatAliasesDescriptor, CatAliasesRequestParameters, ICatAliasesRequest>.FilterPath(IEnumerable<string>)
    RequestDescriptorBase<CatAliasesDescriptor, CatAliasesRequestParameters, ICatAliasesRequest>.Human(bool?)
    RequestDescriptorBase<CatAliasesDescriptor, CatAliasesRequestParameters, ICatAliasesRequest>.Pretty(bool?)
    RequestDescriptorBase<CatAliasesDescriptor, CatAliasesRequestParameters, ICatAliasesRequest>.SourceQueryString(string)
    RequestBase<CatAliasesRequestParameters>.HttpMethod
    RequestBase<CatAliasesRequestParameters>.RequestState
    RequestBase<CatAliasesRequestParameters>.ContentType
    RequestBase<CatAliasesRequestParameters>.ResolveUrl(RouteValues, IConnectionSettingsValues)
    RequestBase<CatAliasesRequestParameters>.RequestDefaults(CatAliasesRequestParameters)
    RequestBase<CatAliasesRequestParameters>.Q<TOut>(string)
    RequestBase<CatAliasesRequestParameters>.Q(string, object)
    RequestBase<CatAliasesRequestParameters>.SetAcceptHeader(string)
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    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?)

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

    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, such as json or 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[])

    A 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?)

    Returns 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?)

    Whether to return information from the local node only instead of from the 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[])

    A 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?)

    Enables verbose mode, which displays column headers.

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

    Implements

    IDescriptor
    ICatAliasesRequest
    IRequest<TParameters>
    IRequest

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Constructors
      • CatAliasesDescriptor()
      • CatAliasesDescriptor(Names)
    • Methods
      • ExpandWildcards(ExpandWildcards?)
      • Format(string)
      • Headers(params string[])
      • Help(bool?)
      • Local(bool?)
      • Name(Names)
      • SortByColumns(params string[])
      • Verbose(bool?)
    • Implements
    • Extension Methods
    Back to top Generated by DocFX