org.apache.flink.runtime.state

Interface CheckpointableKeyedStateBackend<K>

Type Parameters:

K - Type of the key by which state is keyed.

All Superinterfaces:

AutoCloseable, Closeable, Disposable, KeyedStateBackend<K>, KeyedStateFactory, PriorityQueueSetFactory, Snapshotable<SnapshotResult<KeyedStateHandle>>

All Known Implementing Classes:

AbstractKeyedStateBackend, BatchExecutionKeyedStateBackend, ChangelogKeyedStateBackend, HeapKeyedStateBackend, RocksDBKeyedStateBackend

public interface CheckpointableKeyedStateBackend<K>
extends KeyedStateBackend<K>, Snapshotable<SnapshotResult<KeyedStateHandle>>, Closeable

Interface that combines both, the KeyedStateBackend interface, which encapsulates methods responsible for keyed state management and the Snapshotable which tells the system how to snapshot the underlying state.

NOTE: State backends that need to be notified of completed checkpoints can additionally implement the CheckpointListener interface.

Nested Class Summary

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

KeyedStateBackend.KeySelectionListener<K>

Method Summary

Modifier and Type	Method and Description
KeyGroupRange	getKeyGroupRange() Returns the key groups which this state backend is responsible for.
SavepointResources<K>	savepoint() Returns a SavepointResources that can be used by SavepointSnapshotStrategy to write out a savepoint in the common/unified format.

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

applyToAllKeys, deregisterKeySelectionListener, dispose, getCurrentKey, getKeys, getKeysAndNamespaces, getKeySerializer, getOrCreateKeyedState, getPartitionedState, isSafeToReuseKVState, isStateImmutableInStateBackend, registerKeySelectionListener, setCurrentKey

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

createOrUpdateInternalState, createOrUpdateInternalState, createOrUpdateInternalState

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

create, create

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

snapshot

Methods inherited from interface java.io.Closeable

close

Method Detail

getKeyGroupRange

KeyGroupRange getKeyGroupRange()

Returns the key groups which this state backend is responsible for.

savepoint

@Nonnull
SavepointResources<K> savepoint()
                                  throws Exception

Returns a SavepointResources that can be used by SavepointSnapshotStrategy to write out a savepoint in the common/unified format.

Throws:

Exception