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
Inherited Members
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

Methods

| Edit this page View Source

IgnoreIdleThreads(bool?)

Whether to 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 time interval between thread stack trace samples.

Declaration
public NodesHotThreadsDescriptor Interval(Time interval)
Parameters
Type Name Description
Time interval
Returns
Type Description
NodesHotThreadsDescriptor
| 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 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
| Edit this page View Source

Snapshots(int?)

The number of thread stack trace samples to collect.

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

Threads(int?)

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)

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

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

Extension Methods