Package org.apache.flink.configuration

Class StateRecoveryOptions

java.lang.Object

org.apache.flink.configuration.StateRecoveryOptions

@PublicEvolving
public class StateRecoveryOptions
extends Object

The configuration options used when restoring state from a savepoint or a checkpoint.

Field Summary

Fields

Modifier and Type	Field	Description
static ConfigOption<Boolean>	APPROXIMATE_LOCAL_RECOVERY	Access to this option is officially only supported via org.apache.flink.runtime.jobgraph.CheckpointConfig#enableApproximateLocalRecovery(boolean), but there is no good reason behind this.
static ConfigOption<Long>	CHECKPOINT_ID_OF_IGNORED_IN_FLIGHT_DATA
static ConfigOption<Boolean>	LOCAL_RECOVERY	This option configures local recovery for the state backend, which indicates whether to recovery from local snapshot.
static ConfigOption<RecoveryClaimMode>	RESTORE_MODE	Describes the mode how Flink should restore from the given savepoint or retained checkpoint.
static ConfigOption<Boolean>	SAVEPOINT_IGNORE_UNCLAIMED_STATE	A flag indicating if we allow Flink to skip savepoint state that cannot be restored, e.g.
static ConfigOption<String>	SAVEPOINT_PATH	The path to a savepoint that will be used to bootstrap the pipeline's state.

Constructor Summary

Constructors

Constructor	Description
StateRecoveryOptions()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

SAVEPOINT_PATH

public static final ConfigOption<String> SAVEPOINT_PATH

The path to a savepoint that will be used to bootstrap the pipeline's state.

SAVEPOINT_IGNORE_UNCLAIMED_STATE

public static final ConfigOption<Boolean> SAVEPOINT_IGNORE_UNCLAIMED_STATE

A flag indicating if we allow Flink to skip savepoint state that cannot be restored, e.g. because the corresponding operator has been removed.

RESTORE_MODE

public static final ConfigOption<RecoveryClaimMode> RESTORE_MODE

Describes the mode how Flink should restore from the given savepoint or retained checkpoint.

APPROXIMATE_LOCAL_RECOVERY

@Internal
public static final ConfigOption<Boolean> APPROXIMATE_LOCAL_RECOVERY

Access to this option is officially only supported via org.apache.flink.runtime.jobgraph.CheckpointConfig#enableApproximateLocalRecovery(boolean), but there is no good reason behind this.

CHECKPOINT_ID_OF_IGNORED_IN_FLIGHT_DATA

public static final ConfigOption<Long> CHECKPOINT_ID_OF_IGNORED_IN_FLIGHT_DATA

LOCAL_RECOVERY

public static final ConfigOption<Boolean> LOCAL_RECOVERY

This option configures local recovery for the state backend, which indicates whether to recovery from local snapshot. By default, local recovery is deactivated.

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

Constructor Detail

StateRecoveryOptions

public StateRecoveryOptions()