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

Cancel a task.

WARNING: The task management API is new and should still be considered a beta feature. The API may change in ways that are not backwards compatible.

A task may continue to run for some time after it has been cancelled because it may not be able to safely stop its current activity straight away. It is also possible that Elasticsearch must complete its work on other tasks before it can process the cancellation. The get task information API will continue to list these cancelled tasks until they complete. The cancelled flag in the response indicates that the cancellation command has been processed and the task will stop as soon as possible.

To troubleshoot why a cancelled task does not complete promptly, use the get task information API with the ?detailed parameter to identify the other tasks the system is running. You can also use the node hot threads API to obtain detailed information about the work the system is doing instead of completing the cancelled task.

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 or wildcard expression of actions that is used to limit the request.
final List<String>	nodes()	A comma-separated list of node IDs or names that is used to limit the request.
static CancelRequest	of(Function<CancelRequest.Builder,ObjectBuilder<CancelRequest>> fn)
final String	parentTaskId()	A parent task ID that is used to limit the tasks.
final String	taskId()	The task identifier.
final Boolean	waitForCompletion()	If true, the request blocks until all found tasks are complete.

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 or wildcard expression of actions that is used to limit the request.

API name: actions

nodes

public final List<String> nodes()

A comma-separated list of node IDs or names that is used to limit the request.

API name: nodes

parentTaskId

@Nullable
public final String parentTaskId()

A parent task ID that is used to limit the tasks.

API name: parent_task_id

taskId

@Nullable
public final String taskId()

The task identifier.

API name: task_id

waitForCompletion

@Nullable
public final Boolean waitForCompletion()

If true, the request blocks until all found tasks are complete.

API name: wait_for_completion