Class CancelRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.tasks.CancelRequest
public class CancelRequest extends RequestBase
Cancels a task, if it can be cancelled through an API.
- See Also:
- API specification
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
CancelRequest.Builder
Builder forCancelRequest
.Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._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
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 nodesstatic 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 co.elastic.clients.elasticsearch._types.RequestBase
toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Field Details
-
_ENDPOINT
Endpoint "tasks.cancel
".
-
-
Method Details
-
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 nodesAPI 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 falseAPI name:
wait_for_completion
-