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

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

DefaultHttpMethod

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

SupportsBody

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