com.ace.moab.api.jobs
Enum JobState

java.lang.Object
  java.lang.Enum<JobState>
      com.ace.moab.api.jobs.JobState

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<JobState>

public enum JobState
extends java.lang.Enum<JobState>

Represents the various states a job may have at any one time. A Job is guaranteed to have at most 1 state at any given time (but may have many states during the job's lifetime).

Author:

Scott Brown

Enum Constant Summary

ALLOCATING
Resources are selected and are being prepared for job

BATCH_HOLD
Job has a batch hold in place

COMPLETED
Job successfully completed execution

DEFERRED
Job temporarily blocked

HOLD
Job is blocked by RM hold

IDLE
Eligible according to all RM constraints

LOST
Job is LOST.

NONE
No state: A sentinal value.

NOT_QUEUED
Job not eligible for execution

NOT_RUN
Job was not run

REMOVED
Job cancelled before executing

RUNNING
Job is executing

STAGED
All staging pre-reqs are satisified - waiting for remote RM to start

STAGING
Staging of input/output data is currently underway

STARTING
Job launching, executing prolog

SUBMIT_ERROR
Job encountered an error during submission.

SUSPENDED
Job is in suspended state

SYSTEM_HOLD
Job has a system hold in place

UNKNOWN
Unknown job status

USER_HOLD
Job has a user hold in place

VACATED
Job cancelled after partial execution

Method Summary

static JobState	parseString(java.lang.String str) Attempts to parse a string and convert it into a corresponding JobState enum value.
java.lang.String	toString()
static JobState	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static JobState[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NONE

public static final JobState NONE

No state: A sentinal value. Not used.

IDLE

public static final JobState IDLE

Eligible according to all RM constraints

STARTING

public static final JobState STARTING

Job launching, executing prolog

RUNNING

public static final JobState RUNNING

Job is executing

REMOVED

public static final JobState REMOVED

Job cancelled before executing

COMPLETED

public static final JobState COMPLETED

Job successfully completed execution

HOLD

public static final JobState HOLD

Job is blocked by RM hold

DEFERRED

public static final JobState DEFERRED

Job temporarily blocked

SUBMIT_ERROR

public static final JobState SUBMIT_ERROR

Job encountered an error during submission.

VACATED

public static final JobState VACATED

Job cancelled after partial execution

NOT_RUN

public static final JobState NOT_RUN

Job was not run

NOT_QUEUED

public static final JobState NOT_QUEUED

Job not eligible for execution

UNKNOWN

public static final JobState UNKNOWN

Unknown job status

BATCH_HOLD

public static final JobState BATCH_HOLD

Job has a batch hold in place

USER_HOLD

public static final JobState USER_HOLD

Job has a user hold in place

SYSTEM_HOLD

public static final JobState SYSTEM_HOLD

Job has a system hold in place

STAGING

public static final JobState STAGING

Staging of input/output data is currently underway

STAGED

public static final JobState STAGED

All staging pre-reqs are satisified - waiting for remote RM to start

SUSPENDED

public static final JobState SUSPENDED

Job is in suspended state

LOST

public static final JobState LOST

Job is LOST. 4 8 15 16 23 42

ALLOCATING

public static final JobState ALLOCATING

Resources are selected and are being prepared for job

Method Detail

values

public static final JobState[] values()

Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:

for(JobState c : JobState.values())
        System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they're declared

valueOf

public static JobState valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<JobState>

parseString

public static JobState parseString(java.lang.String str)
                            throws java.text.ParseException

Attempts to parse a string and convert it into a corresponding JobState enum value.

Parameters:

str - the string to parse into a corresponding JobState enum value.

Returns:

the corresponding JobState enum value.

Throws:

java.text.ParseException - thrown if the string cannot be parsed into a respective JobState.