Class CancelTasksRequestParameters

Request options for Cancel

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

Inheritance
object
RequestParameters<CancelTasksRequestParameters>
CancelTasksRequestParameters
Implements
Inherited Members
Namespace: OpenSearch.Net.Specification.TasksApi
Assembly: OpenSearch.Net.dll
Syntax
public class CancelTasksRequestParameters : RequestParameters<CancelTasksRequestParameters>, IRequestParameters

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

DefaultHttpMethod

Declaration
public override HttpMethod DefaultHttpMethod { get; }
Property Value
Type Description
HttpMethod
Overrides
| 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

SupportsBody

Declaration
public override bool SupportsBody { get; }
Property Value
Type Description
bool
Overrides
| 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