Class CancelRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.tasks.CancelRequest
Cancels a task, if it can be cancelled through an API.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Modifier and TypeFieldDescriptionstatic final Endpoint<CancelRequest,
CancelResponse, ErrorResponse> Endpoint "tasks.cancel
". -
Method Summary
Modifier and TypeMethodDescriptionactions()
A comma-separated list of actions that should be cancelled.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 nodesstatic CancelRequest
final String
Cancel tasks with specified parent task id (node_id:task_number).final String
taskId()
Cancel the task with specified task id (node_id:task_number)final Boolean
Should the request block until the cancellation of the task and its descendant tasks is completed.Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
-
Field Details
-
_ENDPOINT
Endpoint "tasks.cancel
".
-
-
Method Details
-
of
-
actions
A comma-separated list of actions that should be cancelled. Leave empty to cancel all.API name:
actions
-
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 nodesAPI name:
nodes
-
parentTaskId
Cancel tasks with specified parent task id (node_id:task_number). Set to -1 to cancel all.API name:
parent_task_id
-
taskId
Cancel the task with specified task id (node_id:task_number)API name:
task_id
-
waitForCompletion
Should the request block until the cancellation of the task and its descendant tasks is completed. Defaults to falseAPI name:
wait_for_completion
-