Search Results for

    Show / Hide Table of Contents

    Class NodesHotThreadsDescriptor

    Descriptor for HotThreads

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

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

    Constructors

    | Edit this page View Source

    NodesHotThreadsDescriptor()

    /_nodes/hot_threads

    Declaration
    public NodesHotThreadsDescriptor()
    | Edit this page View Source

    NodesHotThreadsDescriptor(NodeIds)

    /_nodes/{node_id}/hot_threads

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

    Optional, accepts null

    Properties

    | Edit this page View Source

    ContentType

    Declaration
    protected override string ContentType { get; }
    Property Value
    Type Description
    string
    Overrides
    RequestBase<NodesHotThreadsRequestParameters>.ContentType

    Methods

    | Edit this page View Source

    IgnoreIdleThreads(bool?)

    Don't show threads that are in known-idle places, such as waiting on a socket select or pulling from an empty task queue.

    Declaration
    public NodesHotThreadsDescriptor IgnoreIdleThreads(bool? ignoreidlethreads = true)
    Parameters
    Type Name Description
    bool? ignoreidlethreads
    Returns
    Type Description
    NodesHotThreadsDescriptor
    | Edit this page View Source

    Interval(Time)

    The interval for the second sampling of threads.

    Declaration
    public NodesHotThreadsDescriptor Interval(Time interval)
    Parameters
    Type Name Description
    Time interval
    Returns
    Type Description
    NodesHotThreadsDescriptor
    | Edit this page View Source

    NodeId(NodeIds)

    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 NodesHotThreadsDescriptor NodeId(NodeIds nodeId)
    Parameters
    Type Name Description
    NodeIds nodeId
    Returns
    Type Description
    NodesHotThreadsDescriptor
    | Edit this page View Source

    RequestDefaults(NodesHotThreadsRequestParameters)

    Allows a request implementation to set certain request parameter defaults, use sparingly!

    Declaration
    protected override sealed void RequestDefaults(NodesHotThreadsRequestParameters parameters)
    Parameters
    Type Name Description
    NodesHotThreadsRequestParameters parameters
    Overrides
    RequestBase<NodesHotThreadsRequestParameters>.RequestDefaults(NodesHotThreadsRequestParameters)
    | Edit this page View Source

    Snapshots(int?)

    Number of samples of thread stack trace.

    Declaration
    public NodesHotThreadsDescriptor Snapshots(int? snapshots)
    Parameters
    Type Name Description
    int? snapshots
    Returns
    Type Description
    NodesHotThreadsDescriptor
    | Edit this page View Source

    Threads(int?)

    Specify the number of threads to provide information for.

    Declaration
    public NodesHotThreadsDescriptor Threads(int? threads)
    Parameters
    Type Name Description
    int? threads
    Returns
    Type Description
    NodesHotThreadsDescriptor
    | Edit this page View Source

    Timeout(Time)

    Operation timeout.

    Declaration
    public NodesHotThreadsDescriptor Timeout(Time timeout)
    Parameters
    Type Name Description
    Time timeout
    Returns
    Type Description
    NodesHotThreadsDescriptor
    | Edit this page View Source

    Type(NodesSampleType?)

    The type to sample.

    Declaration
    public NodesHotThreadsDescriptor Type(NodesSampleType? type)
    Parameters
    Type Name Description
    NodesSampleType? type
    Returns
    Type Description
    NodesHotThreadsDescriptor

    Implements

    IDescriptor
    INodesHotThreadsRequest
    IRequest<TParameters>
    IRequest

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Constructors
      • NodesHotThreadsDescriptor()
      • NodesHotThreadsDescriptor(NodeIds)
    • Properties
      • ContentType
    • Methods
      • IgnoreIdleThreads(bool?)
      • Interval(Time)
      • NodeId(NodeIds)
      • RequestDefaults(NodesHotThreadsRequestParameters)
      • Snapshots(int?)
      • Threads(int?)
      • Timeout(Time)
      • Type(NodesSampleType?)
    • Implements
    • Extension Methods
    Back to top Generated by DocFX