Package org.elasticsearch.tasks

Class CancellableTask

java.lang.Object

org.elasticsearch.tasks.Task

org.elasticsearch.tasks.CancellableTask

Direct Known Subclasses:

AllocatedPersistentTask, BulkByScrollTask, SearchTask

public abstract class CancellableTask
extends Task

A task that can be canceled

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.tasks.Task

Task.Status

Field Summary

Fields inherited from class org.elasticsearch.tasks.Task

X_OPAQUE_ID

Constructor Summary

Constructors

Constructor	Description
CancellableTask(long id, java.lang.String type, java.lang.String action, java.lang.String description, TaskId parentTaskId, java.util.Map<java.lang.String,java.lang.String> headers)

Method Summary

Modifier and Type	Method	Description
boolean	cancelOnParentLeaving()	Returns true if this task should be automatically cancelled if the coordinating node that requested this task left the cluster.
java.lang.String	getReasonCancelled()	The reason the task was cancelled or null if it hasn't been cancelled.
boolean	isCancelled()
protected void	onCancelled()	Called after the task is cancelled so that it can take any actions that it has to take.
abstract boolean	shouldCancelChildrenOnCancellation()	Returns true if this task can potentially have children that need to be cancelled when it parent is cancelled.

Methods inherited from class org.elasticsearch.tasks.Task

getAction, getDescription, getHeader, getId, getParentTaskId, getStartTime, getStatus, getType, result, result, taskInfo, taskInfo

Methods inherited from class java.lang.Object

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

Constructor Detail

CancellableTask

public CancellableTask(long id,
                       java.lang.String type,
                       java.lang.String action,
                       java.lang.String description,
                       TaskId parentTaskId,
                       java.util.Map<java.lang.String,java.lang.String> headers)

Method Detail

cancelOnParentLeaving

public boolean cancelOnParentLeaving()

Returns true if this task should be automatically cancelled if the coordinating node that requested this task left the cluster.

shouldCancelChildrenOnCancellation

public abstract boolean shouldCancelChildrenOnCancellation()

Returns true if this task can potentially have children that need to be cancelled when it parent is cancelled.

isCancelled

public boolean isCancelled()

getReasonCancelled

@Nullable
public java.lang.String getReasonCancelled()

The reason the task was cancelled or null if it hasn't been cancelled.

onCancelled

protected void onCancelled()

Called after the task is cancelled so that it can take any actions that it has to take.