Search Results for

    Show / Hide Table of Contents

    Class NodesInfoDescriptor

    Descriptor for Info

    https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-info/

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

    Constructors

    | Edit this page View Source

    NodesInfoDescriptor()

    /_nodes

    Declaration
    public NodesInfoDescriptor()
    | Edit this page View Source

    NodesInfoDescriptor(Metrics)

    /_nodes/{metric}

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

    Optional, accepts null

    | Edit this page View Source

    NodesInfoDescriptor(NodeIds)

    /_nodes/{node_id}

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

    Optional, accepts null

    | Edit this page View Source

    NodesInfoDescriptor(NodeIds, Metrics)

    /_nodes/{node_id}/{metric}

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

    Optional, accepts null

    Metrics metric

    Optional, accepts null

    Methods

    | Edit this page View Source

    FlatSettings(bool?)

    If true, returns settings in flat format.

    Declaration
    public NodesInfoDescriptor FlatSettings(bool? flatsettings = true)
    Parameters
    Type Name Description
    bool? flatsettings
    Returns
    Type Description
    NodesInfoDescriptor
    | Edit this page View Source

    Metric(Metrics)

    Limits the information returned to the specific metrics. Supports a comma-separated list, such as http,ingest.

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

    NodeId(NodeIds)

    Comma-separated list of node IDs or names used to limit returned information.

    Declaration
    public NodesInfoDescriptor NodeId(NodeIds nodeId)
    Parameters
    Type Name Description
    NodeIds nodeId
    Returns
    Type Description
    NodesInfoDescriptor
    | 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 NodesInfoDescriptor Timeout(Time timeout)
    Parameters
    Type Name Description
    Time timeout
    Returns
    Type Description
    NodesInfoDescriptor

    Implements

    IDescriptor
    INodesInfoRequest
    IRequest<TParameters>
    IRequest

    Extension Methods

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