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
Comma-separated list or wildcard expression of actions used to limit the request.final CancelRequest.Builder
Comma-separated list or wildcard expression of actions used to limit the request.build()
Builds aCancelRequest
.final CancelRequest.Builder
Comma-separated list of node IDs or names used to limit the request.final CancelRequest.Builder
Comma-separated list of node IDs or names used to limit the request.final CancelRequest.Builder
parentTaskId
(String value) Parent task ID used to limit the tasks.protected CancelRequest.Builder
self()
final CancelRequest.Builder
ID of the task.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
Comma-separated list or wildcard expression of actions used to limit the request.API name:
actions
Adds all elements of
list
toactions
. -
actions
Comma-separated list or wildcard expression of actions used to limit the request.API name:
actions
Adds one or more values to
actions
. -
nodes
Comma-separated list of node IDs or names used to limit the request.API name:
nodes
Adds all elements of
list
tonodes
. -
nodes
Comma-separated list of node IDs or names used to limit the request.API name:
nodes
Adds one or more values to
nodes
. -
parentTaskId
Parent task ID used to limit the tasks.API name:
parent_task_id
-
taskId
ID of the task.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.
-