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)

The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see Common parameters.

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?)

When true, the request retrieves information from the local node only. When false, information is retrieved from the cluster manager 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)

A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts 0 without a unit and -1 to indicate an unspecified value.

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