Enum Class JobState

java.lang.Object
java.lang.Enum<JobState>
com.atlassian.bitbucket.job.JobState
All Implemented Interfaces:
Serializable, Comparable<JobState>, Constable

public enum JobState extends Enum<JobState>
Since:
5.13
  • Enum Constant Details

    • INITIALISING

      public static final JobState INITIALISING
      The job is initialising in preparation for running
    • READY

      public static final JobState READY
      The job is ready to run and awaiting scheduling
    • RUNNING

      public static final JobState RUNNING
      The job is currently running
    • FINALISING

      public static final JobState FINALISING
      The job is finalising its activities in preparation for stopping
    • COMPLETED

      public static final JobState COMPLETED
      The job has run to completion and is now stopped. Errors or warning messages may have been logged determining whether the job failed or succeeded overall, depending on the type of job.
    • FAILED

      public static final JobState FAILED
      The job has run to completion and is now stopped. Errors or warning messages may have been logged determining whether the job failed or succeeded overall, depending on the type of job.
    • CANCELING

      public static final JobState CANCELING
      The job was canceled by the system or a user and is in the process of stopping.
    • CANCELED

      public static final JobState CANCELED
      The job was canceled by the system or a user and has now stopped.
    • TIMED_OUT

      public static final JobState TIMED_OUT
      The job ran for too long without an update and is now considered stopped
    • ABORTED

      public static final JobState ABORTED
      The job encountered an unrecoverable error and was forced to terminate abnormally
  • Method Details

    • values

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

      public static JobState valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      NullPointerException - if the argument is null
    • fromId

      @Nonnull public static JobState fromId(int id)
    • getId

      public int getId()
    • isFailed

      public boolean isFailed()
    • isTerminated

      public boolean isTerminated()