org.apache.flink.runtime.execution

Enum ExecutionState

java.lang.Object

java.lang.Enum<ExecutionState>

org.apache.flink.runtime.execution.ExecutionState

All Implemented Interfaces:

Serializable, Comparable<ExecutionState>

public enum ExecutionState
extends Enum<ExecutionState>

An enumeration of all states that a task can be in during its execution. Tasks usually start in the state CREATED and switch states according to this diagram:

CREATED  -> SCHEDULED -> DEPLOYING -> RUNNING -> FINISHED
                     |            |          |
                     |            |   +------+
                     |            V   V
                     |         CANCELLING -----+----> CANCELED
                     |                         |
                     +-------------------------+

                                               ... -> FAILED
 

It is possible to enter the FAILED state from any other state.

The states FINISHED, CANCELED, and FAILED are considered terminal states.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CANCELED
CANCELING
CREATED
DEPLOYING
FAILED
FINISHED
RUNNING
SCHEDULED

Method Summary

Methods

Modifier and Type	Method and Description
boolean	isTerminal()
static ExecutionState	valueOf(String name) Returns the enum constant of this type with the specified name.
static ExecutionState[]	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 ExecutionState CREATED

SCHEDULED

public static final ExecutionState SCHEDULED

DEPLOYING

public static final ExecutionState DEPLOYING

RUNNING

public static final ExecutionState RUNNING

FINISHED

public static final ExecutionState FINISHED

CANCELING

public static final ExecutionState CANCELING

CANCELED

public static final ExecutionState CANCELED

FAILED

public static final ExecutionState FAILED

Method Detail

values

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

Returns:

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

valueOf

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

isTerminal

public boolean isTerminal()