Package 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 Details

    • 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 Details

    • values

      public static CheckpointedStateScope[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      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