org.apache.flink.runtime.state.filesystem

Class AbstractFsState<K,N,SV,S extends org.apache.flink.api.common.state.State,SD extends org.apache.flink.api.common.state.StateDescriptor<S,?>>

java.lang.Object

org.apache.flink.runtime.state.AbstractHeapState<K,N,SV,S,SD,FsStateBackend>

org.apache.flink.runtime.state.filesystem.AbstractFsState<K,N,SV,S,SD>

Type Parameters:

K - The type of the key.

N - The type of the namespace.

SV - The type of the values in the state.

S - The type of State

SD - The type of StateDescriptor for the State S

All Implemented Interfaces:

org.apache.flink.api.common.state.State, KvState<K,N,S,SD,FsStateBackend>

Direct Known Subclasses:

FsFoldingState, FsListState, FsReducingState, FsValueState

public abstract class AbstractFsState<K,N,SV,S extends org.apache.flink.api.common.state.State,SD extends org.apache.flink.api.common.state.StateDescriptor<S,?>>
extends AbstractHeapState<K,N,SV,S,SD,FsStateBackend>

Base class for partitioned ListState implementations that are backed by a regular heap hash map. The concrete implementations define how the state is checkpointed.

Field Summary

Fields inherited from class org.apache.flink.runtime.state.AbstractHeapState

currentKey, currentNamespace, currentNSState, keySerializer, namespaceSerializer, state, stateDesc, stateSerializer

Constructor Summary

Constructors

Constructor and Description
AbstractFsState(FsStateBackend backend, org.apache.flink.api.common.typeutils.TypeSerializer<K> keySerializer, org.apache.flink.api.common.typeutils.TypeSerializer<N> namespaceSerializer, org.apache.flink.api.common.typeutils.TypeSerializer<SV> stateSerializer, SD stateDesc)
AbstractFsState(FsStateBackend backend, org.apache.flink.api.common.typeutils.TypeSerializer<K> keySerializer, org.apache.flink.api.common.typeutils.TypeSerializer<N> namespaceSerializer, org.apache.flink.api.common.typeutils.TypeSerializer<SV> stateSerializer, SD stateDesc, HashMap<N,Map<K,SV>> state)

Method Summary

Modifier and Type	Method and Description
abstract KvStateSnapshot<K,N,S,SD,FsStateBackend>	createHeapSnapshot(org.apache.flink.core.fs.Path filePath)
KvStateSnapshot<K,N,S,SD,FsStateBackend>	snapshot(long checkpointId, long timestamp) Creates a snapshot of this state.

Methods inherited from class org.apache.flink.runtime.state.AbstractHeapState

clear, dispose, getKeySerializer, getNamespaceSerializer, setCurrentKey, setCurrentNamespace, size

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractFsState

public AbstractFsState(FsStateBackend backend,
                       org.apache.flink.api.common.typeutils.TypeSerializer<K> keySerializer,
                       org.apache.flink.api.common.typeutils.TypeSerializer<N> namespaceSerializer,
                       org.apache.flink.api.common.typeutils.TypeSerializer<SV> stateSerializer,
                       SD stateDesc)

AbstractFsState

public AbstractFsState(FsStateBackend backend,
                       org.apache.flink.api.common.typeutils.TypeSerializer<K> keySerializer,
                       org.apache.flink.api.common.typeutils.TypeSerializer<N> namespaceSerializer,
                       org.apache.flink.api.common.typeutils.TypeSerializer<SV> stateSerializer,
                       SD stateDesc,
                       HashMap<N,Map<K,SV>> state)

Method Detail

createHeapSnapshot

public abstract KvStateSnapshot<K,N,S,SD,FsStateBackend> createHeapSnapshot(org.apache.flink.core.fs.Path filePath)

snapshot

public KvStateSnapshot<K,N,S,SD,FsStateBackend> snapshot(long checkpointId,
                                                         long timestamp)
                                                  throws Exception

Description copied from interface: KvState

Creates a snapshot of this state.

Parameters:

checkpointId - The ID of the checkpoint for which the snapshot should be created.

timestamp - The timestamp of the checkpoint.

Returns:

A snapshot handle for this key/value state.

Throws:

Exception - Exceptions during snapshotting the state should be forwarded, so the system can react to failed snapshots.