Class CancellableTask

    • Nested Class Summary

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

        Task.Status
    • Field Summary

    • 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)  
    • 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.