org.apache.flink.runtime.state

Interface ConfigurableCheckpointStorage

All Superinterfaces:

CheckpointStorage, Serializable

All Known Implementing Classes:

FileSystemCheckpointStorage, JobManagerCheckpointStorage

@Internal
public interface ConfigurableCheckpointStorage
extends CheckpointStorage

An interface for checkpoint storage types that pick up additional parameters from a configuration.

Method Summary

Modifier and Type	Method and Description
CheckpointStorage	configure(ReadableConfig config, ClassLoader classLoader) Creates a variant of the checkpoint storage that applies additional configuration parameters.

Methods inherited from interface org.apache.flink.runtime.state.CheckpointStorage

createCheckpointStorage, resolveCheckpoint

Method Detail

configure

CheckpointStorage configure(ReadableConfig config,
                            ClassLoader classLoader)
                     throws IllegalConfigurationException

Creates a variant of the checkpoint storage that applies additional configuration parameters.

Settings that were directly done on the original checkpoint storage object in the application program typically have precedence over setting picked up from the configuration.

If no configuration is applied, or if the method directly applies configuration values to the (mutable) checkpoint storage object, this method may return the original checkpoint storage object. Otherwise it typically returns a modified copy.

Parameters:

config - The configuration to pick the values from.

classLoader - The class loader that should be used to load the checkpoint storage.

Returns:

A reconfigured checkpoint storage.

Throws:

IllegalConfigurationException - Thrown if the configuration contained invalid entries.