org.apache.flink.runtime.state

Enum CheckpointedStateScope

java.lang.Object

java.lang.Enum<CheckpointedStateScope>

org.apache.flink.runtime.state.CheckpointedStateScope

All Implemented Interfaces:

Serializable, Comparable<CheckpointedStateScope>

public enum CheckpointedStateScope
extends Enum<CheckpointedStateScope>

The scope for a chunk of checkpointed state. Defines whether state is owned by one checkpoint, or whether it is shared by multiple checkpoints.

Different checkpoint storage implementations may treat checkpointed state of different scopes differently, for example put it into different folders or tables.

Enum Constant Summary

Enum Constants

Enum Constant and Description
EXCLUSIVE Exclusive state belongs exclusively to one specific checkpoint / savepoint.
SHARED Shared state may belong to more than one checkpoint.

Method Summary

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

EXCLUSIVE

public static final CheckpointedStateScope EXCLUSIVE

Exclusive state belongs exclusively to one specific checkpoint / savepoint.

SHARED

public static final CheckpointedStateScope SHARED

Shared state may belong to more than one checkpoint.

Shared state is typically used for incremental or differential checkpointing methods, where only deltas are written, and state from prior checkpoints is referenced in newer checkpoints as well.

Method Detail

values

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

Returns:

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

valueOf

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