Package org.apache.spark.launcher

Enum Class SparkAppHandle.State

Object

Enum<SparkAppHandle.State>

org.apache.spark.launcher.SparkAppHandle.State

All Implemented Interfaces:

Serializable, Comparable<SparkAppHandle.State>, Constable

Enclosing interface:

SparkAppHandle

public static enum SparkAppHandle.State
extends Enum<SparkAppHandle.State>

Represents the application's state. A state can be "final", in which case it will not change after it's reached, and means the application is not running anymore.

Since:

1.6.0

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CONNECTED	The application has connected to the handle.
FAILED	The application finished with a failed status.
FINISHED	The application finished with a successful status.
KILLED	The application was killed.
LOST	The Spark Submit JVM exited with a unknown status.
RUNNING	The application is running.
SUBMITTED	The application has been submitted to the cluster.
UNKNOWN	The application has not reported back yet.

Method Summary

Modifier and Type	Method	Description
boolean	isFinal()	Whether this state is a final state, meaning the application is not running anymore once it's reached.
static SparkAppHandle.State	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SparkAppHandle.State[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

UNKNOWN

public static final SparkAppHandle.State UNKNOWN

The application has not reported back yet.

CONNECTED

public static final SparkAppHandle.State CONNECTED

The application has connected to the handle.

SUBMITTED

public static final SparkAppHandle.State SUBMITTED

The application has been submitted to the cluster.

RUNNING

public static final SparkAppHandle.State RUNNING

The application is running.

FINISHED

public static final SparkAppHandle.State FINISHED

The application finished with a successful status.

FAILED

public static final SparkAppHandle.State FAILED

The application finished with a failed status.

KILLED

public static final SparkAppHandle.State KILLED

The application was killed.

LOST

public static final SparkAppHandle.State LOST

The Spark Submit JVM exited with a unknown status.

Method Details

values

public static SparkAppHandle.State[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static SparkAppHandle.State valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

isFinal

public boolean isFinal()

Whether this state is a final state, meaning the application is not running anymore once it's reached.