com.netflix.genie.common.dto

Enum JobStatus

java.lang.Object

java.lang.Enum<JobStatus>

com.netflix.genie.common.dto.JobStatus

All Implemented Interfaces:

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

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

Possible statuses for a Job.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FAILED Job failed.
INIT Job has been initialized, but not running yet.
INVALID Job cannot be run due to invalid criteria.
KILLED Job has been killed.
RUNNING Job is now running.
SUCCEEDED Job has finished executing, and is successful.

Method Summary

Modifier and Type	Method and Description
static java.util.Set<JobStatus>	getActiveStatuses() Get an unmodifiable set of all the statuses that make up a job being considered active.
static java.util.Set<JobStatus>	getFinishedStatuses() Get an unmodifiable set of all the statuses that make up a job being considered finished.
boolean	isActive() Check whether this job is in an active state or not.
boolean	isFinished() Check whether the job is no longer running.
static JobStatus	parse(java.lang.String value) Parse job 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

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INIT

public static final JobStatus INIT

Job has been initialized, but not running yet.

RUNNING

public static final JobStatus RUNNING

Job is now running.

SUCCEEDED

public static final JobStatus SUCCEEDED

Job has finished executing, and is successful.

KILLED

public static final JobStatus KILLED

Job has been killed.

FAILED

public static final JobStatus FAILED

Job failed.

INVALID

public static final JobStatus INVALID

Job cannot be run due to invalid criteria.

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

parse

public static JobStatus parse(java.lang.String value)
                       throws GeniePreconditionException

Parse job status.

Parameters:

value - string to parse/convert

Returns:

INIT, RUNNING, SUCCEEDED, KILLED, FAILED if match

Throws:

GeniePreconditionException - if invalid value passed in

isActive

public boolean isActive()

Check whether this job is in an active state or not.

Returns:

True if the job is still actively processing in some manner

isFinished

public boolean isFinished()

Check whether the job is no longer running.

Returns:

True if the job is no longer processing for one reason or another.

getActiveStatuses

public static java.util.Set<JobStatus> getActiveStatuses()

Get an unmodifiable set of all the statuses that make up a job being considered active.

Returns:

Unmodifiable set of all active statuses

getFinishedStatuses

public static java.util.Set<JobStatus> getFinishedStatuses()

Get an unmodifiable set of all the statuses that make up a job being considered finished.

Returns:

Unmodifiable set of all finished statuses