Search Results for

    Show / Hide Table of Contents

    Class NodesUsageDescriptor

    Descriptor for Usage

    https://opensearch.org/docs/latest

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

    Constructors

    | Edit this page View Source

    NodesUsageDescriptor()

    /_nodes/usage

    Declaration
    public NodesUsageDescriptor()
    | Edit this page View Source

    NodesUsageDescriptor(Metrics)

    /_nodes/usage/{metric}

    Declaration
    public NodesUsageDescriptor(Metrics metric)
    Parameters
    Type Name Description
    Metrics metric

    Optional, accepts null

    | Edit this page View Source

    NodesUsageDescriptor(NodeIds)

    /_nodes/{node_id}/usage

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

    Optional, accepts null

    | Edit this page View Source

    NodesUsageDescriptor(NodeIds, Metrics)

    /_nodes/{node_id}/usage/{metric}

    Declaration
    public NodesUsageDescriptor(NodeIds nodeId, Metrics metric)
    Parameters
    Type Name Description
    NodeIds nodeId

    Optional, accepts null

    Metrics metric

    Optional, accepts null

    Methods

    | Edit this page View Source

    Metric(Metrics)

    Limits the information returned to the specific metrics. A comma-separated list of the following options: _all, rest_actions.

    Declaration
    public NodesUsageDescriptor Metric(Metrics metric)
    Parameters
    Type Name Description
    Metrics metric
    Returns
    Type Description
    NodesUsageDescriptor
    | Edit this page View Source

    NodeId(NodeIds)

    A comma-separated list of node IDs or names to limit the returned information; use _local to return information from the node you're connecting to, leave empty to get information from all nodes.

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

    Timeout(Time)

    Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

    Declaration
    public NodesUsageDescriptor Timeout(Time timeout)
    Parameters
    Type Name Description
    Time timeout
    Returns
    Type Description
    NodesUsageDescriptor

    Implements

    IDescriptor
    INodesUsageRequest
    IRequest<TParameters>
    IRequest

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Constructors
      • NodesUsageDescriptor()
      • NodesUsageDescriptor(Metrics)
      • NodesUsageDescriptor(NodeIds)
      • NodesUsageDescriptor(NodeIds, Metrics)
    • Methods
      • Metric(Metrics)
      • NodeId(NodeIds)
      • Timeout(Time)
    • Implements
    • Extension Methods
    Back to top Generated by DocFX