Class CancelTasksRequest

Request for Cancel

https://opensearch.org/docs/latest/api-reference/tasks/#task-canceling

Inheritance
object
RequestBase<CancelTasksRequestParameters>
PlainRequestBase<CancelTasksRequestParameters>
CancelTasksRequest
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class CancelTasksRequest : PlainRequestBase<CancelTasksRequestParameters>, ICancelTasksRequest, IRequest<CancelTasksRequestParameters>, IRequest

Constructors

| Edit this page View Source

CancelTasksRequest()

/_tasks/_cancel

Declaration
public CancelTasksRequest()
| Edit this page View Source

CancelTasksRequest(TaskId)

/_tasks/{task_id}/_cancel

Declaration
public CancelTasksRequest(TaskId taskId)
Parameters
Type Name Description
TaskId taskId

Optional, accepts null

Properties

| Edit this page View Source

Actions

A comma-separated list of actions that should be returned. Keep empty to return all.

Declaration
public string[] Actions { get; set; }
Property Value
Type Description
string[]
| Edit this page View Source

Nodes

A comma-separated list of node IDs or names used to limit the returned information. Use _local to return information from the node you're connecting to, specify the node name to get information from a specific node, or keep the parameter empty to get information from all nodes.

Declaration
public string[] Nodes { get; set; }
Property Value
Type Description
string[]
| Edit this page View Source

ParentTaskId

Returns tasks with a specified parent task ID (node_id:task_number). Keep empty or set to -1 to return all.

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

Self

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

WaitForCompletion

Waits for the matching task to complete. When true, the request is blocked until the task has completed.

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

Implements

Extension Methods