Search Results for

    Show / Hide Table of Contents

    Class CatMasterDescriptor

    Descriptor for Master

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

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

    Deprecated as of OpenSearch 2.0, use CatClusterManagerDescriptor instead

    Methods

    | Edit this page View Source

    ClusterManagerTimeout(Time)

    The amount of time allowed to establish a connection to the cluster manager node.

    Declaration
    public CatMasterDescriptor ClusterManagerTimeout(Time clustermanagertimeout)
    Parameters
    Type Name Description
    Time clustermanagertimeout
    Returns
    Type Description
    CatMasterDescriptor
    Remarks

    Supported by OpenSearch servers of version 2.0.0 or greater.

    | Edit this page View Source

    Format(string)

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

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

    Headers(params string[])

    A comma-separated list of column names to display.

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

    Help(bool?)

    Returns help information.

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

    Local(bool?)

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

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

    MasterTimeout(Time)

    The amount of time allowed to establish a 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 CatMasterDescriptor MasterTimeout(Time mastertimeout)
    Parameters
    Type Name Description
    Time mastertimeout
    Returns
    Type Description
    CatMasterDescriptor
    | Edit this page View Source

    SortByColumns(params string[])

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

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

    Verbose(bool?)

    Enables verbose mode, which displays column headers.

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

    Implements

    IDescriptor
    ICatMasterRequest
    IRequest<TParameters>
    IRequest

    Extension Methods

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