Enum TaskGroupStatus

java.lang.Object
java.lang.Enum<TaskGroupStatus>
co.yellowdog.platform.model.TaskGroupStatus
All Implemented Interfaces:
Serializable, Comparable<TaskGroupStatus>, java.lang.constant.Constable
public enum TaskGroupStatus extends Enum<TaskGroupStatus>
Describes the status of a task group.
The status of the task group provides an aggregated view of the statuses of tasks within the task group.

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    CANCELLED
    The parent work requirement has been cancelled, no tasks are currently being executed or will be executed.
    CANCELLING
    The parent work requirement is in the process of being cancelled, no further tasks will be executed.
    COMPLETED
    All tasks within the task group have been completed.
    FAILED
    All tasks within the task group have been finished but at least one has failed.
    FAILING
    At least one task in the task group has failed and the task group is in the process of discarding any outstanding tasks.
    HELD
    The task group parent work requirement has been held by the user such that no further tasks are executed.
    PENDING
    The task group is awaiting resources required to execute tasks.
    RUNNING
    The task group has sufficient resources to execute tasks.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    isFinished()
    Returns true, if the status indicates the task group has finished; otherwise, false.
    boolean
    isFinishing()
    Returns true, if the status indicates the task group is finishing; otherwise, false.
    static TaskGroupStatus
    valueOf(String name)
    Returns the enum constant of this type with the specified name.
    static TaskGroupStatus[]
    values()
    Returns an array containing the constants of this enum type, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • PENDING

      public static final TaskGroupStatus PENDING
      The task group is awaiting resources required to execute tasks.

    • RUNNING

      public static final TaskGroupStatus RUNNING
      The task group has sufficient resources to execute tasks.

    • HELD

      public static final TaskGroupStatus HELD
      The task group parent work requirement has been held by the user such that no further tasks are executed. Resources (e.g. Workers) will be released. The task group will remain in HELD state until the user reactivates the parent work requirement.

    • COMPLETED

      public static final TaskGroupStatus COMPLETED
      All tasks within the task group have been completed.

    • FAILING

      public static final TaskGroupStatus FAILING
      At least one task in the task group has failed and the task group is in the process of discarding any outstanding tasks.

    • FAILED

      public static final TaskGroupStatus FAILED
      All tasks within the task group have been finished but at least one has failed.

    • CANCELLING

      public static final TaskGroupStatus CANCELLING
      The parent work requirement is in the process of being cancelled, no further tasks will be executed.

    • CANCELLED

      public static final TaskGroupStatus CANCELLED
      The parent work requirement has been cancelled, no tasks are currently being executed or will be executed.

  • Method Details

    • values

      public static TaskGroupStatus[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static TaskGroupStatus valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null

    • isFinishing

      public boolean isFinishing()
      Returns true, if the status indicates the task group is finishing; otherwise, false.
      Returns:
      true, if the status indicates the task group is finishing; otherwise, false

    • isFinished

      public boolean isFinished()
      Returns true, if the status indicates the task group has finished; otherwise, false.
      Returns:
      true, if the status indicates the task group has finished; otherwise, false