Class ClusterPendingTasksDescriptor

Descriptor for PendingTasks

https://opensearch.org/docs/latest

Inheritance
object
RequestBase<ClusterPendingTasksRequestParameters>
RequestDescriptorBase<ClusterPendingTasksDescriptor, ClusterPendingTasksRequestParameters, IClusterPendingTasksRequest>
ClusterPendingTasksDescriptor
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class ClusterPendingTasksDescriptor : RequestDescriptorBase<ClusterPendingTasksDescriptor, ClusterPendingTasksRequestParameters, IClusterPendingTasksRequest>, IDescriptor, IClusterPendingTasksRequest, IRequest<ClusterPendingTasksRequestParameters>, IRequest

Methods

| Edit this page View Source

ClusterManagerTimeout(Time)

Operation timeout for connection to cluster-manager node.

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

Supported by OpenSearch servers of version 2.0.0 or greater.

| Edit this page View Source

Local(bool?)

If true, the request retrieves information from the local node only. If false, information is retrieved from the master node.

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

MasterTimeout(Time)

Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

Declaration
[Obsolete("Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead.")]
public ClusterPendingTasksDescriptor MasterTimeout(Time mastertimeout)
Parameters
Type Name Description
Time mastertimeout
Returns
Type Description
ClusterPendingTasksDescriptor

Implements

Extension Methods