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

Comma-separated list or wildcard expression of actions used to limit the request.

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

Nodes

Comma-separated list of node IDs or names used to limit the request.

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

ParentTaskId

Parent task ID used to limit the tasks.

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

Should the request block until the cancellation of the task and its descendant tasks is completed. Defaults to false.

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

Implements

Extension Methods