org.apache.spark.launcher

Enum SparkAppHandle.State

java.lang.Object

java.lang.Enum<SparkAppHandle.State>

org.apache.spark.launcher.SparkAppHandle.State

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SparkAppHandle.State>

Enclosing interface:

SparkAppHandle

public static enum SparkAppHandle.State
extends java.lang.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

Enum Constant Summary

Enum Constants

Enum Constant and 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.
RUNNING The application is running.
SUBMITTED The application has been submitted to the cluster.
UNKNOWN The application has not reported back yet.

Method Summary

Methods

Modifier and Type	Method and 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(java.lang.String name) Returns the enum constant of this type with the specified name.
static SparkAppHandle.State[]	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

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.

Method Detail

values

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

Returns:

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

valueOf

public static SparkAppHandle.State valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.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.