org.apache.reef.driver.restart

Enum EvaluatorRestartState

java.lang.Object

java.lang.Enum<EvaluatorRestartState>

org.apache.reef.driver.restart.EvaluatorRestartState

All Implemented Interfaces:

Serializable, Comparable<EvaluatorRestartState>

public enum EvaluatorRestartState
extends Enum<EvaluatorRestartState>

The state that the evaluator is in in the driver restart process.

Enum Constant Summary

Enum Constants

Enum Constant and Description
EXPECTED Have not yet heard back from an evaluator, but we are expecting it to report back.
EXPIRED The evaluator has only contacted the driver after the expiration period.
FAILED The evaluator has failed on driver restart.
NOT_EXPECTED The evaluator is not a restarted instance.
PROCESSED The evaluator has had its context/running task processed.
REPORTED Received the evaluator heartbeat, but have not yet processed it.
REREGISTERED The evaluator has had its recovery heartbeat processed.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	hasReported()
boolean	isFailedOrExpired()
boolean	isFailedOrNotExpected()
static boolean	isLegalTransition(EvaluatorRestartState from, EvaluatorRestartState to)
static EvaluatorRestartState	valueOf(String name) Returns the enum constant of this type with the specified name.
static EvaluatorRestartState[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NOT_EXPECTED

public static final EvaluatorRestartState NOT_EXPECTED

The evaluator is not a restarted instance. Not expecting.

EXPECTED

public static final EvaluatorRestartState EXPECTED

Have not yet heard back from an evaluator, but we are expecting it to report back.

REPORTED

public static final EvaluatorRestartState REPORTED

Received the evaluator heartbeat, but have not yet processed it.

REREGISTERED

public static final EvaluatorRestartState REREGISTERED

The evaluator has had its recovery heartbeat processed.

PROCESSED

public static final EvaluatorRestartState PROCESSED

The evaluator has had its context/running task processed.

EXPIRED

public static final EvaluatorRestartState EXPIRED

The evaluator has only contacted the driver after the expiration period.

FAILED

public static final EvaluatorRestartState FAILED

The evaluator has failed on driver restart.

Method Detail

values

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

Returns:

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

valueOf

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

isLegalTransition

public static boolean isLegalTransition(EvaluatorRestartState from,
                        EvaluatorRestartState to)

Returns:

true if the transition of EvaluatorRestartState is legal.

hasReported

public boolean hasReported()

Returns:

true if the evaluator has heartbeated back to the driver.

isFailedOrNotExpected

public boolean isFailedOrNotExpected()

Returns:

true if the evaluator has failed on driver restart or is not expected to report back to the driver.

isFailedOrExpired

public boolean isFailedOrExpired()

Returns:

true if the evaluator has failed on driver restart or has been expired.