Package org.opensearch.client.opensearch.tasks

Class CancelRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.tasks.CancelRequest.Builder

All Implemented Interfaces:

ObjectBuilder<CancelRequest>

Enclosing class:

CancelRequest

public static class CancelRequest.Builder
extends ObjectBuilderBase
implements ObjectBuilder<CancelRequest>

Builder for CancelRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CancelRequest.Builder	actions(java.lang.String value, java.lang.String... values)	A comma-separated list of actions that should be cancelled.
CancelRequest.Builder	actions(java.util.List<java.lang.String> list)	A comma-separated list of actions that should be cancelled.
CancelRequest	build()	Builds a CancelRequest.
CancelRequest.Builder	nodes(java.lang.String value, java.lang.String... values)	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 nodes
CancelRequest.Builder	nodes(java.util.List<java.lang.String> list)	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 nodes
CancelRequest.Builder	parentTaskId(java.lang.String value)	Cancel tasks with specified parent task id (node_id:task_number).
CancelRequest.Builder	taskId(java.lang.String value)	Cancel the task with specified task id (node_id:task_number)
CancelRequest.Builder	waitForCompletion(java.lang.Boolean value)	Should the request block until the cancellation of the task and its descendant tasks is completed.

Methods inherited from class org.opensearch.client.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

Constructor Detail

Builder

public Builder()

Method Detail

actions

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

A comma-separated list of actions that should be cancelled. Leave empty to cancel all.

API name: actions

Adds all elements of list to actions.

actions

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

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

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

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 nodes

API name: nodes

Adds all elements of list to nodes.

nodes

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

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 nodes

API name: nodes

Adds one or more values to nodes.

parentTaskId

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

Cancel tasks with specified parent task id (node_id:task_number). Set to -1 to cancel all.

API name: parent_task_id

taskId

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

Cancel the task with specified task id (node_id:task_number)

API name: task_id

waitForCompletion

public final CancelRequest.Builder waitForCompletion(@Nullable
                                                     java.lang.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

build

public CancelRequest build()

Builds a CancelRequest.

Specified by:

build in interface ObjectBuilder<CancelRequest>

Throws:

java.lang.NullPointerException - if some of the required fields are null.