Class NodesHotThreadsRequest

Request for HotThreads

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

Inheritance
object
RequestBase<NodesHotThreadsRequestParameters>
PlainRequestBase<NodesHotThreadsRequestParameters>
NodesHotThreadsRequest
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class NodesHotThreadsRequest : PlainRequestBase<NodesHotThreadsRequestParameters>, INodesHotThreadsRequest, IRequest<NodesHotThreadsRequestParameters>, IRequest

Constructors

| Edit this page View Source

NodesHotThreadsRequest()

/_nodes/hot_threads

Declaration
public NodesHotThreadsRequest()
| Edit this page View Source

NodesHotThreadsRequest(NodeIds)

/_nodes/{node_id}/hot_threads

Declaration
public NodesHotThreadsRequest(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
| Edit this page View Source

IgnoreIdleThreads

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 bool? IgnoreIdleThreads { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

Interval

The time interval between thread stack trace samples.

Declaration
public Time Interval { get; set; }
Property Value
Type Description
Time
| Edit this page View Source

Self

Declaration
protected INodesHotThreadsRequest Self { get; }
Property Value
Type Description
INodesHotThreadsRequest
| Edit this page View Source

Snapshots

The number of thread stack trace samples to collect.

Declaration
public int? Snapshots { get; set; }
Property Value
Type Description
int?
| Edit this page View Source

Threads

The number of threads to provide information for.

Declaration
public int? Threads { get; set; }
Property Value
Type Description
int?
| Edit this page View Source

Timeout

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 Time Timeout { get; set; }
Property Value
Type Description
Time
| Edit this page View Source

Type

The type to sample.

Declaration
public NodesSampleType? Type { get; set; }
Property Value
Type Description
NodesSampleType?

Methods

| 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

Implements

Extension Methods