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>

Defines the possible status of a job once it has been accepted by the job manager.

This class is thread-safe.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CANCELED All tasks of the job are canceled as a result of a user request.
CREATED All tasks of the job are in the execution state CREATED.
FAILED At least one task of the job has definitively failed and cannot be recovered anymore.
FINISHED All of the job's tasks have successfully finished.
RUNNING At least one task of the job is running, none has definitely failed.
SCHEDULED All tasks of the job have been accepted by the scheduler, resources have been requested.

Method Summary

Methods

Modifier and Type	Method and Description
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

All tasks of the job are in the execution state CREATED.

SCHEDULED

public static final JobStatus SCHEDULED

All tasks of the job have been accepted by the scheduler, resources have been requested.

RUNNING

public static final JobStatus RUNNING

At least one task of the job is running, none has definitely failed.

FAILED

public static final JobStatus FAILED

At least one task of the job has definitively failed and cannot be recovered anymore. As a result, the job has been terminated.

CANCELED

public static final JobStatus CANCELED

All tasks of the job are canceled as a result of a user request. The job has been terminated.

FINISHED

public static final JobStatus FINISHED

All of the job's tasks have successfully finished.

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