Search Results for

    Show / Hide Table of Contents

    Class CatRecoveryDescriptor

    Descriptor for Recovery

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

    Inheritance
    object
    RequestBase<CatRecoveryRequestParameters>
    RequestDescriptorBase<CatRecoveryDescriptor, CatRecoveryRequestParameters, ICatRecoveryRequest>
    CatRecoveryDescriptor
    Implements
    IDescriptor
    ICatRecoveryRequest
    IRequest<CatRecoveryRequestParameters>
    IRequest
    Inherited Members
    RequestDescriptorBase<CatRecoveryDescriptor, CatRecoveryRequestParameters, ICatRecoveryRequest>.Self
    RequestDescriptorBase<CatRecoveryDescriptor, CatRecoveryRequestParameters, ICatRecoveryRequest>.Assign<TValue>(TValue, Action<ICatRecoveryRequest, TValue>)
    RequestDescriptorBase<CatRecoveryDescriptor, CatRecoveryRequestParameters, ICatRecoveryRequest>.Qs(string, object)
    RequestDescriptorBase<CatRecoveryDescriptor, CatRecoveryRequestParameters, ICatRecoveryRequest>.RequestConfiguration(Func<RequestConfigurationDescriptor, IRequestConfiguration>)
    RequestDescriptorBase<CatRecoveryDescriptor, CatRecoveryRequestParameters, ICatRecoveryRequest>.ErrorTrace(bool?)
    RequestDescriptorBase<CatRecoveryDescriptor, CatRecoveryRequestParameters, ICatRecoveryRequest>.FilterPath(params string[])
    RequestDescriptorBase<CatRecoveryDescriptor, CatRecoveryRequestParameters, ICatRecoveryRequest>.FilterPath(IEnumerable<string>)
    RequestDescriptorBase<CatRecoveryDescriptor, CatRecoveryRequestParameters, ICatRecoveryRequest>.Human(bool?)
    RequestDescriptorBase<CatRecoveryDescriptor, CatRecoveryRequestParameters, ICatRecoveryRequest>.Pretty(bool?)
    RequestDescriptorBase<CatRecoveryDescriptor, CatRecoveryRequestParameters, ICatRecoveryRequest>.SourceQueryString(string)
    RequestBase<CatRecoveryRequestParameters>.HttpMethod
    RequestBase<CatRecoveryRequestParameters>.RequestState
    RequestBase<CatRecoveryRequestParameters>.ContentType
    RequestBase<CatRecoveryRequestParameters>.ResolveUrl(RouteValues, IConnectionSettingsValues)
    RequestBase<CatRecoveryRequestParameters>.RequestDefaults(CatRecoveryRequestParameters)
    RequestBase<CatRecoveryRequestParameters>.Q<TOut>(string)
    RequestBase<CatRecoveryRequestParameters>.Q(string, object)
    RequestBase<CatRecoveryRequestParameters>.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 CatRecoveryDescriptor : RequestDescriptorBase<CatRecoveryDescriptor, CatRecoveryRequestParameters, ICatRecoveryRequest>, IDescriptor, ICatRecoveryRequest, IRequest<CatRecoveryRequestParameters>, IRequest

    Constructors

    | Edit this page View Source

    CatRecoveryDescriptor()

    /_cat/recovery

    Declaration
    public CatRecoveryDescriptor()
    | Edit this page View Source

    CatRecoveryDescriptor(Indices)

    /_cat/recovery/{index}

    Declaration
    public CatRecoveryDescriptor(Indices index)
    Parameters
    Type Name Description
    Indices index

    Optional, accepts null

    Methods

    | Edit this page View Source

    ActiveOnly(bool?)

    If true, the response only includes ongoing shard recoveries.

    Declaration
    public CatRecoveryDescriptor ActiveOnly(bool? activeonly = true)
    Parameters
    Type Name Description
    bool? activeonly
    Returns
    Type Description
    CatRecoveryDescriptor
    | Edit this page View Source

    AllIndices()

    A shortcut into calling Index(Indices.All)

    Declaration
    public CatRecoveryDescriptor AllIndices()
    Returns
    Type Description
    CatRecoveryDescriptor
    | Edit this page View Source

    Bytes(ByteUnit?)

    The units used to display byte values.

    Declaration
    public CatRecoveryDescriptor Bytes(ByteUnit? bytes)
    Parameters
    Type Name Description
    ByteUnit? bytes
    Returns
    Type Description
    CatRecoveryDescriptor
    | Edit this page View Source

    Detailed(bool?)

    When true, includes detailed information about shard recoveries.

    Declaration
    public CatRecoveryDescriptor Detailed(bool? detailed = true)
    Parameters
    Type Name Description
    bool? detailed
    Returns
    Type Description
    CatRecoveryDescriptor
    | Edit this page View Source

    Format(string)

    A short version of the Accept header, such as json or yaml.

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

    Headers(params string[])

    A comma-separated list of column names to display.

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

    Help(bool?)

    Returns help information.

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

    Index(Indices)

    A comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indexes, omit this parameter or use * or _all.

    Declaration
    public CatRecoveryDescriptor Index(Indices index)
    Parameters
    Type Name Description
    Indices index
    Returns
    Type Description
    CatRecoveryDescriptor
    | Edit this page View Source

    Index<TOther>()

    a shortcut into calling Index(typeof(TOther))

    Declaration
    public CatRecoveryDescriptor Index<TOther>() where TOther : class
    Returns
    Type Description
    CatRecoveryDescriptor
    Type Parameters
    Name Description
    TOther
    | Edit this page View Source

    SortByColumns(params string[])

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

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

    Verbose(bool?)

    Enables verbose mode, which displays column headers.

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

    Implements

    IDescriptor
    ICatRecoveryRequest
    IRequest<TParameters>
    IRequest

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Constructors
      • CatRecoveryDescriptor()
      • CatRecoveryDescriptor(Indices)
    • Methods
      • ActiveOnly(bool?)
      • AllIndices()
      • Bytes(ByteUnit?)
      • Detailed(bool?)
      • Format(string)
      • Headers(params string[])
      • Help(bool?)
      • Index(Indices)
      • Index<TOther>()
      • SortByColumns(params string[])
      • Verbose(bool?)
    • Implements
    • Extension Methods
    Back to top Generated by DocFX