Package org.apache.flink.core.execution

Enum RestoreMode

java.lang.Object

java.lang.Enum<RestoreMode>

org.apache.flink.core.execution.RestoreMode

All Implemented Interfaces:

Serializable, Comparable<RestoreMode>, DescribedEnum

@PublicEvolving
public enum RestoreMode
extends Enum<RestoreMode>
implements DescribedEnum

Defines state files ownership when Flink restore from a given savepoint or retained checkpoint. TODO: Rename 'RestoreMode' to 'RecoveryClaimMode' in Flink 2.0. Any related variable names should be adjusted accordingly.

Enum Constant Summary

Enum Constants

Enum Constant	Description
CLAIM
LEGACY	Deprecated.
NO_CLAIM

Field Summary

Fields

Modifier and Type	Field	Description
static RestoreMode	DEFAULT

Method Summary

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

CLAIM

public static final RestoreMode CLAIM

NO_CLAIM

public static final RestoreMode NO_CLAIM

LEGACY

@Deprecated
public static final RestoreMode LEGACY

Deprecated.

Field Detail

DEFAULT

public static final RestoreMode DEFAULT

Method Detail

values

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

Returns:

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

valueOf

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

getDescription

@Internal
public InlineElement getDescription()

Description copied from interface: DescribedEnum

Returns the description for the enum constant.

If you want to include links or code blocks, use TextElement.wrap(InlineElement...) to wrap multiple inline elements into a single one.

Specified by:

getDescription in interface DescribedEnum