Package co.elastic.clients.elasticsearch.tasks

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 for CancelRequest.

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 final Endpoint<CancelRequest,CancelResponse,ErrorResponse>	_ENDPOINT	Endpoint "tasks.cancel".

Method Summary

Modifier and Type	Method	Description
final List<String>	actions()	A comma-separated list of actions that should be cancelled.
final List<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 nodes
static CancelRequest	of(Function<CancelRequest.Builder,ObjectBuilder<CancelRequest>> fn)
final String	parentTaskId()	Cancel tasks with specified parent task id (node_id:task_number).
final String	taskId()	Cancel the task with specified task id (node_id:task_number)
final 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

public static final Endpoint<CancelRequest,CancelResponse,ErrorResponse> _ENDPOINT

Endpoint "tasks.cancel".

Method Details

of

public static CancelRequest of(Function<CancelRequest.Builder,ObjectBuilder<CancelRequest>> fn)

actions

public final List<String> actions()

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

API name: actions

nodes

public final List<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 nodes

API name: nodes

parentTaskId

@Nullable
public final 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 String taskId()

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

API name: task_id

waitForCompletion

@Nullable
public final Boolean waitForCompletion()

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

API name: wait_for_completion