CancelRequest (java-client 2.8.0 API)

java.lang.Object
- org.opensearch.client.opensearch._types.RequestBase
- - org.opensearch.client.opensearch.tasks.CancelRequest

```
public class CancelRequest
extends RequestBase
```
Cancels a task, if it can be cancelled through an API.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class CancelRequest.Builder
Builder for CancelRequest.
- Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.RequestBase
  RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields
Modifier and Type Field Description

static Endpoint<CancelRequest,CancelResponse,ErrorResponse> _ENDPOINT
Endpoint "tasks.cancel".

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.util.List<java.lang.String>`	`actions()`	A comma-separated list of actions that should be cancelled.
`java.util.List<java.lang.String>`	`nodes()`	A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes
`static CancelRequest`	`of(java.util.function.Function<CancelRequest.Builder,ObjectBuilder<CancelRequest>> fn)`
`java.lang.String`	`parentTaskId()`	Cancel tasks with specified parent task id (node_id:task_number).
`java.lang.String`	`taskId()`	Cancel the task with specified task id (node_id:task_number)
`java.lang.Boolean`	`waitForCompletion()`	Should the request block until the cancellation of the task and its descendant tasks is completed.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - _ENDPOINT
```
public static final Endpoint<CancelRequest,CancelResponse,ErrorResponse> _ENDPOINT
```
    Endpoint "tasks.cancel".
- Method Detail
  - of
```
public static CancelRequest of(java.util.function.Function<CancelRequest.Builder,ObjectBuilder<CancelRequest>> fn)
```
  - actions
```
public final java.util.List<java.lang.String> actions()
```
    A comma-separated list of actions that should be cancelled. Leave empty to cancel all.
    API name: actions
  - nodes
```
public final java.util.List<java.lang.String> nodes()
```
    A comma-separated list of node IDs or names to limit the returned information; use _local to return information from the node you're connecting to, leave empty to get information from all nodes
    API name: nodes
  - parentTaskId
```
@Nullable
public final java.lang.String parentTaskId()
```
    Cancel tasks with specified parent task id (node_id:task_number). Set to -1 to cancel all.
    API name: parent_task_id
  - taskId
```
@Nullable
public final java.lang.String taskId()
```
    Cancel the task with specified task id (node_id:task_number)
    API name: task_id
  - waitForCompletion
```
@Nullable
public final java.lang.Boolean waitForCompletion()
```
    Should the request block until the cancellation of the task and its descendant tasks is completed. Defaults to false
    API name: wait_for_completion