Class CatThreadPoolDescriptor

Descriptor for ThreadPool

https://opensearch.org/docs/latest/api-reference/cat/cat-thread-pool/

Inheritance
object
RequestBase<CatThreadPoolRequestParameters>
RequestDescriptorBase<CatThreadPoolDescriptor, CatThreadPoolRequestParameters, ICatThreadPoolRequest>
CatThreadPoolDescriptor
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class CatThreadPoolDescriptor : RequestDescriptorBase<CatThreadPoolDescriptor, CatThreadPoolRequestParameters, ICatThreadPoolRequest>, IDescriptor, ICatThreadPoolRequest, IRequest<CatThreadPoolRequestParameters>, IRequest

Constructors

| Edit this page View Source

CatThreadPoolDescriptor()

/_cat/thread_pool

Declaration
public CatThreadPoolDescriptor()
| Edit this page View Source

CatThreadPoolDescriptor(Names)

/_cat/thread_pool/{thread_pool_patterns}

Declaration
public CatThreadPoolDescriptor(Names threadPoolPatterns)
Parameters
Type Name Description
Names threadPoolPatterns

Optional, accepts null

Methods

| Edit this page View Source

ClusterManagerTimeout(Time)

A timeout for connection to the cluster manager node.

Declaration
public CatThreadPoolDescriptor ClusterManagerTimeout(Time clustermanagertimeout)
Parameters
Type Name Description
Time clustermanagertimeout
Returns
Type Description
CatThreadPoolDescriptor
Remarks

Supported by OpenSearch servers of version 2.0.0 or greater.

| Edit this page View Source

Format(string)

A short version of the Accept header, such as json or yaml.

Declaration
public CatThreadPoolDescriptor Format(string format)
Parameters
Type Name Description
string format
Returns
Type Description
CatThreadPoolDescriptor
| Edit this page View Source

Headers(params string[])

A comma-separated list of column names to display.

Declaration
public CatThreadPoolDescriptor Headers(params string[] headers)
Parameters
Type Name Description
string[] headers
Returns
Type Description
CatThreadPoolDescriptor
| Edit this page View Source

Help(bool?)

Returns help information.

Declaration
public CatThreadPoolDescriptor Help(bool? help = true)
Parameters
Type Name Description
bool? help
Returns
Type Description
CatThreadPoolDescriptor
| Edit this page View Source

Local(bool?)

Returns local information but does not retrieve the state from the cluster manager node.

Declaration
public CatThreadPoolDescriptor Local(bool? local = true)
Parameters
Type Name Description
bool? local
Returns
Type Description
CatThreadPoolDescriptor
| Edit this page View Source

MasterTimeout(Time)

The amount of time allowed to establish a connection to the cluster manager node.

Declaration
[Obsolete("Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead.")]
public CatThreadPoolDescriptor MasterTimeout(Time mastertimeout)
Parameters
Type Name Description
Time mastertimeout
Returns
Type Description
CatThreadPoolDescriptor
| Edit this page View Source

Size(int?)

The multiplier in which to display values.

Declaration
public CatThreadPoolDescriptor Size(int? size)
Parameters
Type Name Description
int? size
Returns
Type Description
CatThreadPoolDescriptor
| Edit this page View Source

SortByColumns(params string[])

A comma-separated list of column names or column aliases to sort by.

Declaration
public CatThreadPoolDescriptor SortByColumns(params string[] sortbycolumns)
Parameters
Type Name Description
string[] sortbycolumns
Returns
Type Description
CatThreadPoolDescriptor
| Edit this page View Source

ThreadPoolPatterns(Names)

A comma-separated list of thread pool names used to limit the request. Accepts wildcard expressions.

Declaration
public CatThreadPoolDescriptor ThreadPoolPatterns(Names threadPoolPatterns)
Parameters
Type Name Description
Names threadPoolPatterns
Returns
Type Description
CatThreadPoolDescriptor
| Edit this page View Source

Verbose(bool?)

Enables verbose mode, which displays column headers.

Declaration
public CatThreadPoolDescriptor Verbose(bool? verbose = true)
Parameters
Type Name Description
bool? verbose
Returns
Type Description
CatThreadPoolDescriptor

Implements

Extension Methods