Package co.elastic.clients.elasticsearch.tasks

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

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final CancelRequest.Builder	actions(String value, String... values)	Comma-separated list or wildcard expression of actions used to limit the request.
final CancelRequest.Builder	actions(List<String> list)	Comma-separated list or wildcard expression of actions used to limit the request.
CancelRequest	build()	Builds a CancelRequest.
final CancelRequest.Builder	nodes(String value, String... values)	Comma-separated list of node IDs or names used to limit the request.
final CancelRequest.Builder	nodes(List<String> list)	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	taskId(String value)	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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

actions

public final CancelRequest.Builder actions(List<String> list)

Comma-separated list or wildcard expression of actions used to limit the request.

API name: actions

Adds all elements of list to actions.

actions

public final CancelRequest.Builder actions(String value,
 String... values)

Comma-separated list or wildcard expression of actions used to limit the request.

API name: actions

Adds one or more values to actions.

nodes

public final CancelRequest.Builder nodes(List<String> list)

Comma-separated list of node IDs or names used to limit the request.

API name: nodes

Adds all elements of list to nodes.

nodes

public final CancelRequest.Builder nodes(String value,
 String... values)

Comma-separated list of node IDs or names used to limit the request.

API name: nodes

Adds one or more values to nodes.

parentTaskId

public final CancelRequest.Builder parentTaskId(@Nullable
 String value)

Parent task ID used to limit the tasks.

API name: parent_task_id

taskId

public final CancelRequest.Builder taskId(@Nullable
 String value)

ID of the task.

API name: task_id

waitForCompletion

public final CancelRequest.Builder waitForCompletion(@Nullable
 Boolean value)

Should the request block until the cancellation of the task and its descendant tasks is completed. Defaults to false

API name: wait_for_completion

self

protected CancelRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<CancelRequest.Builder>

build

public CancelRequest build()

Builds a CancelRequest.

Specified by:

build in interface ObjectBuilder<CancelRequest>

Throws:

NullPointerException - if some of the required fields are null.