org.apache.flink.runtime.executiongraph

Enum InternalJobStatus

java.lang.Object

java.lang.Enum<InternalJobStatus>

org.apache.flink.runtime.executiongraph.InternalJobStatus

All Implemented Interfaces:

Serializable, Comparable<InternalJobStatus>

public enum InternalJobStatus
extends Enum<InternalJobStatus>

This enumeration contains all states a job represented by an ExecutionGraph can have during its lifetime. It contains all states from JobStatus but also internal states to keep track of shutdown processes.

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.
CANCELING At least one task has been 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.
FAILING At least one task of the job has definitely failed and cannot be recovered.
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	toJobStatus(InternalJobStatus status) Converts an internal job status in a JobStatus state.
static InternalJobStatus	valueOf(String name) Returns the enum constant of this type with the specified name.
static InternalJobStatus[]	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 InternalJobStatus CREATED

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

SCHEDULED

public static final InternalJobStatus SCHEDULED

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

RUNNING

public static final InternalJobStatus RUNNING

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

FAILING

public static final InternalJobStatus FAILING

At least one task of the job has definitely failed and cannot be recovered. The job is in the process of being terminated.

FAILED

public static final InternalJobStatus FAILED

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

CANCELING

public static final InternalJobStatus CANCELING

At least one task has been canceled as a result of a user request. The job is in the process of being canceled completely.

CANCELED

public static final InternalJobStatus CANCELED

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

FINISHED

public static final InternalJobStatus FINISHED

All of the job's tasks have successfully finished.

Method Detail

values

public static InternalJobStatus[] 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 (InternalJobStatus c : InternalJobStatus.values())
    System.out.println(c);

Returns:

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

valueOf

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

toJobStatus

public static JobStatus toJobStatus(InternalJobStatus status)

Converts an internal job status in a JobStatus state.

Parameters:

status - the internal job status to converted.

Returns:

the corresponding job status or null if no corresponding job status exists