Class CancelTasksRequestParameters
Request options for Cancel
<p>https://docs.opensearch.org/latest/api-reference/tasks/cancel-tasks/</p>
Inheritance
CancelTasksRequestParameters
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
|
Edit this page
View Source
DefaultHttpMethod
Declaration
public override HttpMethod DefaultHttpMethod { get; }
Property Value
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
|
Edit this page
View Source
OperationName
The OpenSearch REST API operation name this request maps to (for example search or
indices.create), used as the OpenTelemetry span name and db.operation tag.
null for requests that do not correspond to a named API operation.
Declaration
public override string OperationName { get; }
Property Value
Overrides
|
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
|
Edit this page
View Source
SupportsBody
Declaration
public override bool SupportsBody { get; }
Property Value
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
Implements
Extension Methods