org.apache.flink.runtime.clusterframework

Enum ApplicationStatus

java.lang.Object

java.lang.Enum<ApplicationStatus>

org.apache.flink.runtime.clusterframework.ApplicationStatus

All Implemented Interfaces:

Serializable, Comparable<ApplicationStatus>

public enum ApplicationStatus
extends Enum<ApplicationStatus>

The status of an application.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CANCELED Application was canceled or killed on request.
FAILED Application encountered an unrecoverable failure or error.
SUCCEEDED Application finished successfully.
UNKNOWN Application status is not known.

Method Summary

Modifier and Type	Method and Description
JobStatus	deriveJobStatus() Derives the JobStatus from the ApplicationStatus.
static ApplicationStatus	fromJobStatus(JobStatus jobStatus) Derives the ApplicationStatus that should be used for a job that resulted in the given job status.
int	processExitCode() Gets the process exit code associated with this status.
static ApplicationStatus	valueOf(String name) Returns the enum constant of this type with the specified name.
static ApplicationStatus[]	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

SUCCEEDED

public static final ApplicationStatus SUCCEEDED

Application finished successfully.

FAILED

public static final ApplicationStatus FAILED

Application encountered an unrecoverable failure or error.

CANCELED

public static final ApplicationStatus CANCELED

Application was canceled or killed on request.

UNKNOWN

public static final ApplicationStatus UNKNOWN

Application status is not known.

Method Detail

values

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

Returns:

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

valueOf

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

processExitCode

public int processExitCode()

Gets the process exit code associated with this status.

Returns:

The associated process exit code.

fromJobStatus

public static ApplicationStatus fromJobStatus(JobStatus jobStatus)

Derives the ApplicationStatus that should be used for a job that resulted in the given job status. If the job is not yet in a globally terminal state, this method returns UNKNOWN.

deriveJobStatus

public JobStatus deriveJobStatus()

Derives the JobStatus from the ApplicationStatus.

Returns:

The corresponding JobStatus.

Throws:

UnsupportedOperationException - for UNKNOWN.