Package org.ivoa.dm.execution

Enum Class ExecutionPhase

java.lang.Object
java.lang.Enum<ExecutionPhase>
org.ivoa.dm.execution.ExecutionPhase
All Implemented Interfaces:
Serializable, Comparable<ExecutionPhase>, Constable
@VoDml(id="execution:ExecutionPhase", role=enumeration) public enum ExecutionPhase extends Enum<ExecutionPhase>
Enumeration of possible phases of job execution. Enumeration ExecutionPhase :

  • 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
    ABORTED
    Value ABORTED : The job has been aborted, either by user request or by the server because of lack or overuse of resources.
    ARCHIVED
    Value ARCHIVED : The job has been archived by the server at destruction time.
    COMPLETED
    Value COMPLETED : A job has completed successfully.
    ERROR
    Value ERROR : Some form of error has occurred.
    EXECUTING
    Value EXECUTING : A job is running.
    FINALIZING
    Value FINALIZING : A job is finalizing - this is a phase that can be used to indicate that the job has finished execution but is still doing some work to finalize the results - e.g.
    HELD
    Value HELD : The job is HELD pending execution and will not automatically be executed - can occur after a PHASE=RUN request has been made (cf PENDING).
    PENDING
    Value PENDING : The first phase a job is entered into - this is where a job is being set up but no request to run has occurred.
    PREPARING
    Value PREPARING : A Job is preparing data mounts.
    QUEUED
    Value QUEUED : A job has been accepted for execution but is waiting in a queue.
    SUSPENDED
    Value SUSPENDED : The job has been suspended by the system during execution.
    UNKNOWN
    Value UNKNOWN : The job is in an unknown state.

  • Method Summary

    Modifier and Type
    Method
    Description
    static final ExecutionPhase
    fromValue(String v)
    Return the ExecutionPhase enum constant corresponding to the given string representation (value)
    final String
    toString()
    Return the string representation of this enum constant (value)
    final String
    value()
    Return the string representation of this enum constant (value)
    static ExecutionPhase
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static ExecutionPhase[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

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

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • PENDING

      public static final ExecutionPhase PENDING
      Value PENDING : The first phase a job is entered into - this is where a job is being set up but no request to run has occurred.

    • QUEUED

      public static final ExecutionPhase QUEUED
      Value QUEUED : A job has been accepted for execution but is waiting in a queue.

    • PREPARING

      public static final ExecutionPhase PREPARING
      Value PREPARING : A Job is preparing data mounts.

    • EXECUTING

      public static final ExecutionPhase EXECUTING
      Value EXECUTING : A job is running.

    • FINALIZING

      public static final ExecutionPhase FINALIZING
      Value FINALIZING : A job is finalizing - this is a phase that can be used to indicate that the job has finished execution but is still doing some work to finalize the results - e.g. copying results to a final location, cleaning up temporary resources etc.

    • COMPLETED

      public static final ExecutionPhase COMPLETED
      Value COMPLETED : A job has completed successfully.

    • ERROR

      public static final ExecutionPhase ERROR
      Value ERROR : Some form of error has occurred.

    • UNKNOWN

      public static final ExecutionPhase UNKNOWN
      Value UNKNOWN : The job is in an unknown state.

    • HELD

      public static final ExecutionPhase HELD
      Value HELD : The job is HELD pending execution and will not automatically be executed - can occur after a PHASE=RUN request has been made (cf PENDING).

    • SUSPENDED

      public static final ExecutionPhase SUSPENDED
      Value SUSPENDED : The job has been suspended by the system during execution.

    • ABORTED

      public static final ExecutionPhase ABORTED
      Value ABORTED : The job has been aborted, either by user request or by the server because of lack or overuse of resources.

    • ARCHIVED

      public static final ExecutionPhase ARCHIVED
      Value ARCHIVED : The job has been archived by the server at destruction time. An archived job may have deleted the results to reclaim resources, but must have job metadata preserved. This is an alternative that the server may choose in contrast to completely destroying all record of the job.

  • Method Details

    • values

      public static ExecutionPhase[] 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 ExecutionPhase 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

    • value

      public final String value()
      Return the string representation of this enum constant (value)
      Returns:
      string representation of this enum constant (value)

    • toString

      public final String toString()
      Return the string representation of this enum constant (value)
      Overrides:
      toString in class Enum<ExecutionPhase>
      Returns:
      string representation of this enum constant (value)
      See Also:

    • fromValue

      public static final ExecutionPhase fromValue(String v)
      Return the ExecutionPhase enum constant corresponding to the given string representation (value)
      Parameters:
      v - string representation (value)
      Returns:
      ExecutionPhase enum constant
      Throws:
      IllegalArgumentException - if there is no matching enum constant