org.apache.flink.runtime.dispatcher

Enum TriggerSavepointMode

java.lang.Object

java.lang.Enum<TriggerSavepointMode>

org.apache.flink.runtime.dispatcher.TriggerSavepointMode

All Implemented Interfaces:

Serializable, Comparable<TriggerSavepointMode>

public enum TriggerSavepointMode
extends Enum<TriggerSavepointMode>

Describes the context of taking a savepoint: Whether it is a savepoint for a running job or whether the job is cancelled, suspended or terminated with a savepoint.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CANCEL_WITH_SAVEPOINT
SAVEPOINT
SUSPEND_WITH_SAVEPOINT
TERMINATE_WITH_SAVEPOINT

Method Summary

Modifier and Type	Method and Description
boolean	isTerminalMode() Whether the operation will result in a globally terminal job status.
static TriggerSavepointMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static TriggerSavepointMode[]	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

SAVEPOINT

public static final TriggerSavepointMode SAVEPOINT

CANCEL_WITH_SAVEPOINT

public static final TriggerSavepointMode CANCEL_WITH_SAVEPOINT

SUSPEND_WITH_SAVEPOINT

public static final TriggerSavepointMode SUSPEND_WITH_SAVEPOINT

TERMINATE_WITH_SAVEPOINT

public static final TriggerSavepointMode TERMINATE_WITH_SAVEPOINT

Method Detail

values

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

Returns:

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

valueOf

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

isTerminalMode

public boolean isTerminalMode()

Whether the operation will result in a globally terminal job status.