Package oracle.as.scheduler

Enum Class State

java.lang.Object
java.lang.Enum<State>
oracle.as.scheduler.State
All Implemented Interfaces:
Serializable, Comparable<State>, java.lang.constant.Constable
public enum State extends Enum<State>
Enum of ESS request states.

  • 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
    BLOCKED
    Request execution is blocked by one or more incompatible requests.
    CANCELLED
    The request was cancelled.
    CANCELLING
    The request has been cancelled and is awaiting acknowledgement.
    COMPLETED
    Job executable has completed and request post-processing has commenced.
    ERROR
    Request processing resulted in error.
    ERROR_AUTO_RETRY
    The request ran, resulted in an error, and is eligible for automatic retry.
    ERROR_MANUAL_RECOVERY
    The request requires manual intervention in order to be retried or go to a terminal state.
    EXPIRED
    The request expired before it could be processed.
    FINISHED
    The request, and all child requests, are finished.
    HOLD
    Request has been explicitly held.
    PAUSED
    The request paused for sub-request completion.
    PENDING_VALIDATION
    The request has been submitted but not yet validated.
    READY
    Request has been dispatched and is awaiting processing.
    RUNNING
    Request is being processed.
    SCHEDULE_ENDED
    The schedule for the request has ended, or a request expiration time specified at request submission has been reached.
    SUCCEEDED
    The request ran and was successful.
    UNKNOWN
    Unknown or invalid state.
    VALIDATION_FAILED
    The request was submitted but failed validation.
    WAIT
    Request is awaiting dispatch.
    WARNING
    The request ran and resulted in a warning.

  • Method Summary

    Modifier and Type
    Method
    Description
    static State
    fromString(String stateStr)
    Converts a stringified state into a State object.
    static EnumSet<State>
    getNonTerminalStates()
    The set of the non-terminal states based on the value returned by isTerminal.
    static State
    getState(int value)
    The State associated with the given numeric value.
    static EnumSet<State>
    getTerminalStates()
    The set of the terminal states based on the value returned by isTerminal.
    boolean
    isTerminal()
    Indicates if the state is a terminal state.
    String
    toString(Locale locale)
    Enterprise Manager support to acquire a localized string value.
    int
    value()
    The numeric value associated with the State.
    static State
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static State[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

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

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • UNKNOWN

      public static final State UNKNOWN
      Unknown or invalid state.

    • WAIT

      public static final State WAIT
      Request is awaiting dispatch.

    • READY

      public static final State READY
      Request has been dispatched and is awaiting processing.

    • RUNNING

      public static final State RUNNING
      Request is being processed.

    • COMPLETED

      public static final State COMPLETED
      Job executable has completed and request post-processing has commenced.

    • BLOCKED

      public static final State BLOCKED
      Request execution is blocked by one or more incompatible requests.

    • HOLD

      public static final State HOLD
      Request has been explicitly held.

    • CANCELLING

      public static final State CANCELLING
      The request has been cancelled and is awaiting acknowledgement.

    • EXPIRED

      public static final State EXPIRED
      The request expired before it could be processed.

    • CANCELLED

      public static final State CANCELLED
      The request was cancelled.

    • ERROR

      public static final State ERROR
      Request processing resulted in error. The job executable may or may not have been run depending on where the error was encountered in processing lifecycle of the request.

    • WARNING

      public static final State WARNING
      The request ran and resulted in a warning.

    • SUCCEEDED

      public static final State SUCCEEDED
      The request ran and was successful.

    • PAUSED

      public static final State PAUSED
      The request paused for sub-request completion.

    • PENDING_VALIDATION

      public static final State PENDING_VALIDATION
      The request has been submitted but not yet validated.

    • VALIDATION_FAILED

      public static final State VALIDATION_FAILED
      The request was submitted but failed validation.

    • SCHEDULE_ENDED

      public static final State SCHEDULE_ENDED
      The schedule for the request has ended, or a request expiration time specified at request submission has been reached.

      This is a non-terminal state for a schedule-based request that indicates that no new child request will be generated. One or more child requests may still be in a non-terminal state.

    • FINISHED

      public static final State FINISHED
      The request, and all child requests, are finished.

      This is a terminal state for a schedule-based request that indicates that all child requests are in a terminal state.

    • ERROR_AUTO_RETRY

      public static final State ERROR_AUTO_RETRY
      The request ran, resulted in an error, and is eligible for automatic retry.

    • ERROR_MANUAL_RECOVERY

      public static final State ERROR_MANUAL_RECOVERY
      The request requires manual intervention in order to be retried or go to a terminal state.

  • Method Details

    • values

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

    • isTerminal

      public boolean isTerminal()
      Indicates if the state is a terminal state.
      Returns:
      true if terminal, false otherwise.

    • value

      public int value()
      The numeric value associated with the State.
      Returns:
      value for this state.

    • getState

      public static State getState(int value)
      The State associated with the given numeric value.
      Parameters:
      value - the value to convert to state.
      Returns:
      associated state.

    • getTerminalStates

      public static EnumSet<State> getTerminalStates()
      The set of the terminal states based on the value returned by isTerminal.
      Returns:
      a set of the terminal states

    • getNonTerminalStates

      public static EnumSet<State> getNonTerminalStates()
      The set of the non-terminal states based on the value returned by isTerminal.
      Returns:
      set of non-terminal states

    • fromString

      public static State fromString(String stateStr)
      Converts a stringified state into a State object.
      Parameters:
      stateStr - the string to convert
      Returns:
      the state derived from stateStr, or {State.UNKNOWN} if the conversion could not be made.

    • toString

      public String toString(Locale locale)
      Enterprise Manager support to acquire a localized string value.
      Parameters:
      locale - the desired locale.
      Returns:
      the localized string