org.apache.flink.runtime.jobgraph

Enum JobStatus

java.lang.Object

java.lang.Enum<JobStatus>

org.apache.flink.runtime.jobgraph.JobStatus

All Implemented Interfaces:

Serializable, Comparable<JobStatus>

public enum JobStatus
extends Enum<JobStatus>

Possible states of a job once it has been accepted by the job manager.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CANCELED Job has been cancelled
CANCELLING Job is being cancelled
CREATED Job is newly created, no task has started to run.
FAILED The job has failed to to non-recoverable task failure
FAILING The job has failed and is currently waiting for the cleanup to complete
FINISHED All of the job's tasks have successfully finished.
RESTARTING The job is currently undergoing a reset and total restart
RUNNING Some tasks are scheduled or running, some may be pending, some may be finished.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	isTerminalState()
static JobStatus	valueOf(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

CREATED

public static final JobStatus CREATED

Job is newly created, no task has started to run.

RUNNING

public static final JobStatus RUNNING

Some tasks are scheduled or running, some may be pending, some may be finished.

FAILING

public static final JobStatus FAILING

The job has failed and is currently waiting for the cleanup to complete

FAILED

public static final JobStatus FAILED

The job has failed to to non-recoverable task failure

CANCELLING

public static final JobStatus CANCELLING

Job is being cancelled

CANCELED

public static final JobStatus CANCELED

Job has been cancelled

FINISHED

public static final JobStatus FINISHED

All of the job's tasks have successfully finished.

RESTARTING

public static final JobStatus RESTARTING

The job is currently undergoing a reset and total restart

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(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:

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

NullPointerException - if the argument is null

isTerminalState

public boolean isTerminalState()