Class CancelRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<CancelRequest.Builder>
co.elastic.clients.elasticsearch.tasks.CancelRequest.Builder
- All Implemented Interfaces:
WithJson<CancelRequest.Builder>
,ObjectBuilder<CancelRequest>
- Enclosing class:
- CancelRequest
public static class CancelRequest.Builder
extends RequestBase.AbstractBuilder<CancelRequest.Builder>
implements ObjectBuilder<CancelRequest>
Builder for
CancelRequest
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal CancelRequest.Builder
A comma-separated list of actions that should be cancelled.final CancelRequest.Builder
A comma-separated list of actions that should be cancelled.build()
Builds aCancelRequest
.final CancelRequest.Builder
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 nodesfinal CancelRequest.Builder
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 nodesfinal CancelRequest.Builder
parentTaskId
(String value) Cancel tasks with specified parent task id (node_id:task_number).protected CancelRequest.Builder
self()
final CancelRequest.Builder
Cancel the task with specified task id (node_id:task_number)final CancelRequest.Builder
waitForCompletion
(Boolean value) Should the request block until the cancellation of the task and its descendant tasks is completed.Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase
withJson
Methods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
actions
A comma-separated list of actions that should be cancelled. Leave empty to cancel all.API name:
actions
Adds all elements of
list
toactions
. -
actions
A comma-separated list of actions that should be cancelled. Leave empty to cancel all.API name:
actions
Adds one or more values to
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
Adds all elements of
list
tonodes
. -
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
Adds one or more values to
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
-
self
- Specified by:
self
in classRequestBase.AbstractBuilder<CancelRequest.Builder>
-
build
Builds aCancelRequest
.- Specified by:
build
in interfaceObjectBuilder<CancelRequest>
- Throws:
NullPointerException
- if some of the required fields are null.
-