org.apache.flink.runtime.state.filesystem

Class FsHeapKvStateSnapshot<K,V>

java.lang.Object

org.apache.flink.runtime.state.filesystem.AbstractFileState

org.apache.flink.runtime.state.filesystem.FsHeapKvStateSnapshot<K,V>

Type Parameters:

K - The type of the key in the snapshot state.

V - The type of the value in the snapshot state.

All Implemented Interfaces:

Serializable, KvStateSnapshot<K,V,FsStateBackend>

public class FsHeapKvStateSnapshot<K,V>
extends AbstractFileState
implements KvStateSnapshot<K,V,FsStateBackend>

A snapshot of a heap key/value state stored in a file.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
FsHeapKvStateSnapshot(org.apache.flink.api.common.typeutils.TypeSerializer<K> keySerializer, org.apache.flink.api.common.typeutils.TypeSerializer<V> valueSerializer, org.apache.flink.core.fs.Path filePath) Creates a new state snapshot with data in the file system.

Method Summary

Modifier and Type	Method and Description
FsHeapKvState<K,V>	restoreState(FsStateBackend stateBackend, org.apache.flink.api.common.typeutils.TypeSerializer<K> keySerializer, org.apache.flink.api.common.typeutils.TypeSerializer<V> valueSerializer, V defaultValue, ClassLoader classLoader) Loads the key/value state back from this snapshot.

Methods inherited from class org.apache.flink.runtime.state.filesystem.AbstractFileState

discardState, getFilePath, getFileSystem

Methods inherited from class java.lang.Object

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

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

discardState

Constructor Detail

FsHeapKvStateSnapshot

public FsHeapKvStateSnapshot(org.apache.flink.api.common.typeutils.TypeSerializer<K> keySerializer,
                             org.apache.flink.api.common.typeutils.TypeSerializer<V> valueSerializer,
                             org.apache.flink.core.fs.Path filePath)

Creates a new state snapshot with data in the file system.

Parameters:

keySerializer - The serializer for the keys.

valueSerializer - The serializer for the values.

filePath - The path where the snapshot data is stored.

Method Detail

restoreState

public FsHeapKvState<K,V> restoreState(FsStateBackend stateBackend,
                                       org.apache.flink.api.common.typeutils.TypeSerializer<K> keySerializer,
                                       org.apache.flink.api.common.typeutils.TypeSerializer<V> valueSerializer,
                                       V defaultValue,
                                       ClassLoader classLoader)
                                throws Exception

Description copied from interface: KvStateSnapshot

Loads the key/value state back from this snapshot.

Specified by:

restoreState in interface KvStateSnapshot<K,V,FsStateBackend>

Parameters:

stateBackend - The state backend that created this snapshot and can restore the key/value state from this snapshot.

keySerializer - The serializer for the keys.

valueSerializer - The serializer for the values.

defaultValue - The value that is returned when no other value has been associated with a key, yet.

classLoader - The class loader for user-defined types.

Returns:

An instance of the key/value state loaded from this snapshot.

Throws:

Exception - Exceptions can occur during the state loading and are forwarded.