org.apache.tez.dag.api.event

Enum VertexState

java.lang.Object

java.lang.Enum<VertexState>

org.apache.tez.dag.api.event.VertexState

All Implemented Interfaces:

Serializable, Comparable<VertexState>

@InterfaceAudience.Public
@InterfaceStability.Unstable
public enum VertexState
extends Enum<VertexState>

Vertex state information.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONFIGURED Indicates that the vertex has been completely configured.
FAILED Indicates that the Vertex has FAILED
KILLED Indicates that the Vertex has been KILLED
PARALLELISM_UPDATED Indicates that the parallelism for the vertex had changed.
RUNNING Indicates that the Vertex had entered the RUNNING state.
SUCCEEDED Indicates that the Vertex had entered the SUCCEEDED state.

Method Summary

Methods

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

Indicates that the Vertex had entered the SUCCEEDED state. A vertex could go back into RUNNING state after SUCCEEDING

RUNNING

public static final VertexState RUNNING

Indicates that the Vertex had entered the RUNNING state. This state can be reached after SUCCEEDED, if some tasks belonging to the vertex are restarted due to errors

FAILED

public static final VertexState FAILED

Indicates that the Vertex has FAILED

KILLED

public static final VertexState KILLED

Indicates that the Vertex has been KILLED

PARALLELISM_UPDATED

public static final VertexState PARALLELISM_UPDATED

Indicates that the parallelism for the vertex had changed.

CONFIGURED

public static final VertexState CONFIGURED

Indicates that the vertex has been completely configured. Parallelism, edges, edge properties, inputs/outputs have been set and will not be changed any further. Listeners can depend on the vertex's configured state after receiving this notification.

Method Detail

values

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

Returns:

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

valueOf

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