Search Results for

    Show / Hide Table of Contents

    Class CatClusterManagerRequest

    Request for ClusterManager

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

    Inheritance
    object
    RequestBase<CatClusterManagerRequestParameters>
    PlainRequestBase<CatClusterManagerRequestParameters>
    CatClusterManagerRequest
    Implements
    ICatClusterManagerRequest
    IRequest<CatClusterManagerRequestParameters>
    IRequest
    Inherited Members
    PlainRequestBase<CatClusterManagerRequestParameters>.RequestConfiguration
    PlainRequestBase<CatClusterManagerRequestParameters>.ErrorTrace
    PlainRequestBase<CatClusterManagerRequestParameters>.FilterPath
    PlainRequestBase<CatClusterManagerRequestParameters>.Human
    PlainRequestBase<CatClusterManagerRequestParameters>.Pretty
    PlainRequestBase<CatClusterManagerRequestParameters>.SourceQueryString
    RequestBase<CatClusterManagerRequestParameters>.HttpMethod
    RequestBase<CatClusterManagerRequestParameters>.RequestState
    RequestBase<CatClusterManagerRequestParameters>.ContentType
    RequestBase<CatClusterManagerRequestParameters>.ResolveUrl(RouteValues, IConnectionSettingsValues)
    RequestBase<CatClusterManagerRequestParameters>.RequestDefaults(CatClusterManagerRequestParameters)
    RequestBase<CatClusterManagerRequestParameters>.Q<TOut>(string)
    RequestBase<CatClusterManagerRequestParameters>.Q(string, object)
    RequestBase<CatClusterManagerRequestParameters>.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 CatClusterManagerRequest : PlainRequestBase<CatClusterManagerRequestParameters>, ICatClusterManagerRequest, IRequest<CatClusterManagerRequestParameters>, IRequest
    Remarks

    Introduced in OpenSearch 2.0 instead of CatMasterRequest

    Properties

    | Edit this page View Source

    ClusterManagerTimeout

    A timeout for connection to the cluster manager node.

    Declaration
    public Time ClusterManagerTimeout { get; set; }
    Property Value
    Type Description
    Time
    Remarks

    Supported by OpenSearch servers of version 2.0.0 or greater.

    | Edit this page View Source

    Format

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

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

    Headers

    A 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

    Returns help information.

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

    Local

    Returns local information but does not retrieve the state from the cluster manager node.

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

    MasterTimeout

    A timeout for connection to the cluster manager node.

    Declaration
    [Obsolete("Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead.")]
    public Time MasterTimeout { get; set; }
    Property Value
    Type Description
    Time
    | Edit this page View Source

    Self

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

    SortByColumns

    A 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

    Enables verbose mode, which displays column headers.

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

    Implements

    ICatClusterManagerRequest
    IRequest<TParameters>
    IRequest

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Properties
      • ClusterManagerTimeout
      • Format
      • Headers
      • Help
      • Local
      • MasterTimeout
      • Self
      • SortByColumns
      • Verbose
    • Implements
    • Extension Methods
    Back to top Generated by DocFX