org.apache.flink.runtime.state

Interface ConfigurableStateBackend

All Superinterfaces:

Serializable, StateBackend

All Known Implementing Classes:

ChangelogStateBackend, EmbeddedRocksDBStateBackend, ForStStateBackend, FsStateBackend, HashMapStateBackend, MemoryStateBackend, RocksDBStateBackend

@Internal
public interface ConfigurableStateBackend
extends StateBackend

An interface for state backends that pick up additional parameters from a configuration.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.flink.runtime.state.StateBackend

StateBackend.CustomInitializationMetrics, StateBackend.KeyedStateBackendParameters<K>, StateBackend.OperatorStateBackendParameters

Method Summary

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

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

createAsyncKeyedStateBackend, createKeyedStateBackend, createOperatorStateBackend, getName, supportsAsyncKeyedStateBackend, supportsNoClaimRestoreMode, supportsSavepointFormat, useManagedMemory

Method Detail

configure

StateBackend configure(ReadableConfig config,
                       ClassLoader classLoader)
                throws IllegalConfigurationException

Creates a variant of the state backend that applies additional configuration parameters.

Settings that were directly done on the original state backend 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) state backend object, this method may return the original state backend 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 state backend.

Returns:

A reconfigured state backend.

Throws:

IllegalConfigurationException - Thrown if the configuration contained invalid entries.