Search Results for

    Show / Hide Table of Contents

    Class CatAllocationDescriptor

    Descriptor for Allocation

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

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

    Constructors

    | Edit this page View Source

    CatAllocationDescriptor()

    /_cat/allocation

    Declaration
    public CatAllocationDescriptor()
    | Edit this page View Source

    CatAllocationDescriptor(NodeIds)

    /_cat/allocation/{node_id}

    Declaration
    public CatAllocationDescriptor(NodeIds nodeId)
    Parameters
    Type Name Description
    NodeIds nodeId

    Optional, accepts null

    Methods

    | Edit this page View Source

    Bytes(ByteUnit?)

    The units used to display byte values.

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

    ClusterManagerTimeout(Time)

    A timeout for connection to the cluster manager node.

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

    Supported by OpenSearch servers of version 2.0.0 or greater.

    | Edit this page View Source

    Format(string)

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

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

    Headers(params string[])

    A comma-separated list of column names to display.

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

    Help(bool?)

    Returns help information.

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

    Local(bool?)

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

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

    MasterTimeout(Time)

    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 CatAllocationDescriptor MasterTimeout(Time mastertimeout)
    Parameters
    Type Name Description
    Time mastertimeout
    Returns
    Type Description
    CatAllocationDescriptor
    | Edit this page View Source

    NodeId(NodeIds)

    A comma-separated list of node IDs or names used to limit the returned information.

    Declaration
    public CatAllocationDescriptor NodeId(NodeIds nodeId)
    Parameters
    Type Name Description
    NodeIds nodeId
    Returns
    Type Description
    CatAllocationDescriptor
    | Edit this page View Source

    SortByColumns(params string[])

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

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

    Verbose(bool?)

    Enables verbose mode, which displays column headers.

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

    Implements

    IDescriptor
    ICatAllocationRequest
    IRequest<TParameters>
    IRequest

    Extension Methods

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