Search Results for

    Show / Hide Table of Contents

    Class CatAllocationRequest

    Request for Allocation

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

    Inheritance
    object
    RequestBase<CatAllocationRequestParameters>
    PlainRequestBase<CatAllocationRequestParameters>
    CatAllocationRequest
    Implements
    ICatAllocationRequest
    IRequest<CatAllocationRequestParameters>
    IRequest
    Inherited Members
    PlainRequestBase<CatAllocationRequestParameters>.RequestConfiguration
    PlainRequestBase<CatAllocationRequestParameters>.ErrorTrace
    PlainRequestBase<CatAllocationRequestParameters>.FilterPath
    PlainRequestBase<CatAllocationRequestParameters>.Human
    PlainRequestBase<CatAllocationRequestParameters>.Pretty
    PlainRequestBase<CatAllocationRequestParameters>.SourceQueryString
    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 CatAllocationRequest : PlainRequestBase<CatAllocationRequestParameters>, ICatAllocationRequest, IRequest<CatAllocationRequestParameters>, IRequest

    Constructors

    | Edit this page View Source

    CatAllocationRequest()

    /_cat/allocation

    Declaration
    public CatAllocationRequest()
    | Edit this page View Source

    CatAllocationRequest(NodeIds)

    /_cat/allocation/{node_id}

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

    Optional, accepts null

    Properties

    | Edit this page View Source

    Bytes

    The units used to display byte values.

    Declaration
    public ByteUnit? Bytes { get; set; }
    Property Value
    Type Description
    ByteUnit?
    | 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 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 ICatAllocationRequest Self { get; }
    Property Value
    Type Description
    ICatAllocationRequest
    | 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

    ICatAllocationRequest
    IRequest<TParameters>
    IRequest

    Extension Methods

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