pipeline.api.workflow

Enum JobStatus

java.lang.Object

java.lang.Enum<JobStatus>

pipeline.api.workflow.JobStatus

All Implemented Interfaces:

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

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

Set of possible job's statuses.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACTIVE Signifies this instance is either running or queued.
ALREADY_INITIALIZED Signifies this instance has already been initialized.
BACKLOGGED Signifies this instance is currently backlogged, waiting to be allowed to submit to grid or to execute.
CANCELLED Signifies this instance is cancelled.
FAILED Signifies that the instance has failed, either because it has errors, or a non-zero exit code
FALSE Signifies this instance condition returned result FALSE.
FINISHED Signifies this instance is already finished, either success or fail..
INITIALIZED Signifies this instance is currently processed by engine and soon it will start execution.
NOT_YET_QUEUED Signifies this instance has not been queued yet.
NOTFINISHED Signifies this instance has not finished yet.
QUEUED Signifies this job is currently queued, waiting to be scheduled to run.
RUNNING Signifies this instance is currently running (scheduled for CPU time).
SUBMITTING Signifies this instance is currently submitting to the grid.
SUCCESS Signifies this instance has finished with success.
TRANSLATED Signifies this instance has already been translated.
TRUE Signifies this instance condition returned result TRUE.
WAITING Signifies this job is waiting to start execution

Method Summary

Modifier and Type	Method and Description
static JobStatus	fromCode(int statusCode) From code.
int	getCode() Gets numeric code of status.
static JobStatus	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static JobStatus[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

WAITING

public static final JobStatus WAITING

Signifies this job is waiting to start execution

QUEUED

public static final JobStatus QUEUED

Signifies this job is currently queued, waiting to be scheduled to run.

RUNNING

public static final JobStatus RUNNING

Signifies this instance is currently running (scheduled for CPU time).

SUCCESS

public static final JobStatus SUCCESS

Signifies this instance has finished with success. Meaning, it has no errors, it exited normally, and has an exit code of zero.

FAILED

public static final JobStatus FAILED

Signifies that the instance has failed, either because it has errors, or a non-zero exit code

BACKLOGGED

public static final JobStatus BACKLOGGED

Signifies this instance is currently backlogged, waiting to be allowed to submit to grid or to execute.

INITIALIZED

public static final JobStatus INITIALIZED

Signifies this instance is currently processed by engine and soon it will start execution.

SUBMITTING

public static final JobStatus SUBMITTING

Signifies this instance is currently submitting to the grid.

CANCELLED

public static final JobStatus CANCELLED

Signifies this instance is cancelled.

FINISHED

public static final JobStatus FINISHED

Signifies this instance is already finished, either success or fail..

NOTFINISHED

public static final JobStatus NOTFINISHED

Signifies this instance has not finished yet.

ALREADY_INITIALIZED

public static final JobStatus ALREADY_INITIALIZED

Signifies this instance has already been initialized.

ACTIVE

public static final JobStatus ACTIVE

Signifies this instance is either running or queued.

NOT_YET_QUEUED

public static final JobStatus NOT_YET_QUEUED

Signifies this instance has not been queued yet.

TRANSLATED

public static final JobStatus TRANSLATED

Signifies this instance has already been translated.

TRUE

public static final JobStatus TRUE

Signifies this instance condition returned result TRUE.

FALSE

public static final JobStatus FALSE

Signifies this instance condition returned result FALSE.

Method Detail

values

public static JobStatus[] values()

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

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

Returns:

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

valueOf

public static JobStatus 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

java.lang.NullPointerException - if the argument is null

getCode

public int getCode()

Gets numeric code of status.

Returns:

the code

fromCode

public static JobStatus fromCode(int statusCode)

From code.

Parameters:

statusCode - the status code

Returns:

the job status