Package org.apache.flink.configuration

Class CheckpointingOptions

java.lang.Object

org.apache.flink.configuration.CheckpointingOptions

public class CheckpointingOptions
extends Object

A collection of all configuration options that relate to checkpoints and savepoints.

Field Summary

Fields

Modifier and Type	Field	Description
static ConfigOption<Boolean>	ASYNC_SNAPSHOTS	Deprecated. Checkpoints are always asynchronous.
static ConfigOption<String>	CHECKPOINT_STORAGE	The checkpoint storage used to checkpoint state for recovery.
static ConfigOption<String>	CHECKPOINTS_DIRECTORY	The default directory used for storing the data files and meta data of checkpoints in a Flink supported filesystem.
static ConfigOption<MemorySize>	FS_SMALL_FILE_THRESHOLD	The minimum size of state data files.
static ConfigOption<Integer>	FS_WRITE_BUFFER_SIZE	The default size of the write buffer for the checkpoint streams that write to file systems.
static ConfigOption<Boolean>	INCREMENTAL_CHECKPOINTS	Option whether the state backend should create incremental checkpoints, if possible.
static ConfigOption<Boolean>	LOCAL_RECOVERY	This option configures local recovery for this state backend.
static ConfigOption<String>	LOCAL_RECOVERY_TASK_MANAGER_STATE_ROOT_DIRS	The config parameter defining the root directories for storing file-based state for local recovery.
static ConfigOption<Integer>	MAX_RETAINED_CHECKPOINTS	The maximum number of completed checkpoints to retain.
static ConfigOption<String>	SAVEPOINT_DIRECTORY	The default directory for savepoints.
static ConfigOption<String>	STATE_BACKEND	Deprecated. Use StateBackendOptions.STATE_BACKEND.

Constructor Summary

Constructors

Constructor	Description
CheckpointingOptions()

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

STATE_BACKEND

@Deprecated
public static final ConfigOption<String> STATE_BACKEND

Deprecated.

Use StateBackendOptions.STATE_BACKEND.

The checkpoint storage used to store operator state locally within the cluster during execution.

The implementation can be specified either via their shortcut name, or via the class name of a StateBackendFactory. If a StateBackendFactory class name is specified, the factory is instantiated (via its zero-argument constructor) and its StateBackendFactory#createFromConfig(ReadableConfig, ClassLoader) method is called.

Recognized shortcut names are 'hashmap' and 'rocksdb'.

CHECKPOINT_STORAGE

public static final ConfigOption<String> CHECKPOINT_STORAGE

The checkpoint storage used to checkpoint state for recovery.

The implementation can be specified either via their shortcut name, or via the class name of a CheckpointStorageFactory. If a CheckpointStorageFactory class name is specified, the factory is instantiated (via its zero-argument constructor) and its CheckpointStorageFactory#createFromConfig(ReadableConfig, ClassLoader) method is called.

Recognized shortcut names are 'jobmanager' and 'filesystem'.

MAX_RETAINED_CHECKPOINTS

public static final ConfigOption<Integer> MAX_RETAINED_CHECKPOINTS

The maximum number of completed checkpoints to retain.

ASYNC_SNAPSHOTS

@Deprecated
public static final ConfigOption<Boolean> ASYNC_SNAPSHOTS

Deprecated.

Checkpoints are always asynchronous.

INCREMENTAL_CHECKPOINTS

public static final ConfigOption<Boolean> INCREMENTAL_CHECKPOINTS

Option whether the state backend should create incremental checkpoints, if possible. For an incremental checkpoint, only a diff from the previous checkpoint is stored, rather than the complete checkpoint state.

Once enabled, the state size shown in web UI or fetched from rest API only represents the delta checkpoint size instead of full checkpoint size.

Some state backends may not support incremental checkpoints and ignore this option.

LOCAL_RECOVERY

public static final ConfigOption<Boolean> LOCAL_RECOVERY

This option configures local recovery for this state backend. By default, local recovery is deactivated.

Local recovery currently only covers keyed state backends (including both the EmbeddedRocksDBStateBackend and the HashMapStateBackend).

LOCAL_RECOVERY_TASK_MANAGER_STATE_ROOT_DIRS

public static final ConfigOption<String> LOCAL_RECOVERY_TASK_MANAGER_STATE_ROOT_DIRS

The config parameter defining the root directories for storing file-based state for local recovery.

Local recovery currently only covers keyed state backends. Currently, MemoryStateBackend does not support local recovery and ignore this option.

SAVEPOINT_DIRECTORY

public static final ConfigOption<String> SAVEPOINT_DIRECTORY

The default directory for savepoints. Used by the state backends that write savepoints to file systems (HashMapStateBackend, EmbeddedRocksDBStateBackend).

CHECKPOINTS_DIRECTORY

public static final ConfigOption<String> CHECKPOINTS_DIRECTORY

The default directory used for storing the data files and meta data of checkpoints in a Flink supported filesystem. The storage path must be accessible from all participating processes/nodes(i.e. all TaskManagers and JobManagers).

FS_SMALL_FILE_THRESHOLD

public static final ConfigOption<MemorySize> FS_SMALL_FILE_THRESHOLD

The minimum size of state data files. All state chunks smaller than that are stored inline in the root checkpoint metadata file.

FS_WRITE_BUFFER_SIZE

public static final ConfigOption<Integer> FS_WRITE_BUFFER_SIZE

The default size of the write buffer for the checkpoint streams that write to file systems.

Constructor Detail

CheckpointingOptions

public CheckpointingOptions()