接口的使用
org.apache.flink.runtime.state.KeyedStateHandle

使用KeyedStateHandle的程序包

程序包	说明
org.apache.flink.runtime.checkpoint
org.apache.flink.runtime.checkpoint.metadata
org.apache.flink.runtime.state
org.apache.flink.runtime.state.changelog
org.apache.flink.runtime.state.changelog.inmemory
org.apache.flink.runtime.state.filesystem
org.apache.flink.runtime.state.hashmap
org.apache.flink.runtime.state.heap	This package contains the classes for key/value state backends that store the state on the JVM heap as objects.
org.apache.flink.runtime.state.memory
org.apache.flink.runtime.state.restore

org.apache.flink.runtime.checkpoint中KeyedStateHandle的使用

返回KeyedStateHandle的org.apache.flink.runtime.checkpoint中的方法

限定符和类型	方法和说明
KeyedStateHandle	SubtaskState.getManagedKeyedState() 已过时。
KeyedStateHandle	SubtaskState.getRawKeyedState() 已过时。

返回变量类型为KeyedStateHandle的类型的org.apache.flink.runtime.checkpoint中的方法

限定符和类型	方法和说明
StateObjectCollection<KeyedStateHandle>	PrioritizedOperatorSubtaskState.getJobManagerManagedKeyedState() Returns the managed keyed state from the job manager, which represents the ground truth about what this state should represent.
StateObjectCollection<KeyedStateHandle>	PrioritizedOperatorSubtaskState.getJobManagerRawKeyedState() Returns the raw keyed state from the job manager, which represents the ground truth about what this state should represent.
StateObjectCollection<KeyedStateHandle>	OperatorSubtaskState.getManagedKeyedState()
static List<KeyedStateHandle>	StateAssignmentOperation.getManagedKeyedStateHandles(OperatorState operatorState, KeyGroupRange subtaskKeyGroupRange) Collect managedKeyedStateHandles which have intersection with given KeyGroupRange from operatorState.
List<StateObjectCollection<KeyedStateHandle>>	PrioritizedOperatorSubtaskState.getPrioritizedManagedKeyedState() Returns an immutable list with all alternative snapshots to restore the managed keyed state, in the order in which we should attempt to restore.
List<StateObjectCollection<KeyedStateHandle>>	PrioritizedOperatorSubtaskState.getPrioritizedRawKeyedState() Returns an immutable list with all alternative snapshots to restore the raw keyed state, in the order in which we should attempt to restore.
StateObjectCollection<KeyedStateHandle>	OperatorSubtaskState.getRawKeyedState()
static List<KeyedStateHandle>	StateAssignmentOperation.getRawKeyedStateHandles(OperatorState operatorState, KeyGroupRange subtaskKeyGroupRange) Collect rawKeyedStateHandles which have intersection with given KeyGroupRange from operatorState.

参数类型为KeyedStateHandle的org.apache.flink.runtime.checkpoint中的方法

限定符和类型	方法和说明
OperatorSubtaskState.Builder	OperatorSubtaskState.Builder.setManagedKeyedState(KeyedStateHandle managedKeyedState)
OperatorSubtaskState.Builder	OperatorSubtaskState.Builder.setRawKeyedState(KeyedStateHandle rawKeyedState)

类型变量类型为KeyedStateHandle的org.apache.flink.runtime.checkpoint中的方法参数

限定符和类型	方法和说明
static void	StateAssignmentOperation.extractIntersectingState(Collection<? extends KeyedStateHandle> originalSubtaskStateHandles, KeyGroupRange rangeToExtract, List<KeyedStateHandle> extractedStateCollector) Extracts certain key group ranges from the given state handles and adds them to the collector.
static void	StateAssignmentOperation.extractIntersectingState(Collection<? extends KeyedStateHandle> originalSubtaskStateHandles, KeyGroupRange rangeToExtract, List<KeyedStateHandle> extractedStateCollector) Extracts certain key group ranges from the given state handles and adds them to the collector.
OperatorSubtaskState.Builder	OperatorSubtaskState.Builder.setManagedKeyedState(StateObjectCollection<KeyedStateHandle> managedKeyedState)
OperatorSubtaskState.Builder	OperatorSubtaskState.Builder.setRawKeyedState(StateObjectCollection<KeyedStateHandle> rawKeyedState)

参数类型为KeyedStateHandle的org.apache.flink.runtime.checkpoint中的构造器

构造器和说明
SubtaskState(ChainedStateHandle<OperatorStateHandle> managedOperatorState, ChainedStateHandle<OperatorStateHandle> rawOperatorState, KeyedStateHandle managedKeyedState, KeyedStateHandle rawKeyedState) 已过时。

org.apache.flink.runtime.checkpoint.metadata中KeyedStateHandle的使用

返回KeyedStateHandle的org.apache.flink.runtime.checkpoint.metadata中的方法

限定符和类型	方法和说明
static KeyedStateHandle	MetadataV3Serializer.deserializeKeyedStateHandleUtil(DataInputStream dis)

参数类型为KeyedStateHandle的org.apache.flink.runtime.checkpoint.metadata中的方法

限定符和类型	方法和说明
static void	MetadataV3Serializer.serializeKeyedStateHandleUtil(KeyedStateHandle stateHandle, DataOutputStream dos)

org.apache.flink.runtime.state中KeyedStateHandle的使用

org.apache.flink.runtime.state中KeyedStateHandle的子接口

限定符和类型	接口和说明
interface	IncrementalKeyedStateHandle Common interface to all incremental KeyedStateHandle.
interface	SavepointKeyedStateHandle A KeyedStateHandle that points to a savepoint taken in the unified format.

实现KeyedStateHandle的org.apache.flink.runtime.state中的类

限定符和类型	类和说明
class	DirectoryKeyedStateHandle This class is a keyed state handle based on a directory.
class	IncrementalLocalKeyedStateHandle State handle for local copies of IncrementalRemoteKeyedStateHandle.
class	IncrementalRemoteKeyedStateHandle The handle to states of an incremental snapshot.
class	KeyGroupsSavepointStateHandle A KeyGroupsStateHandle that describes a savepoint in the unified format.
class	KeyGroupsStateHandle A handle to the partitioned stream operator state after it has been checkpointed.

类型参数类型为KeyedStateHandle的org.apache.flink.runtime.state中的字段

限定符和类型	字段和说明
protected RunnableFuture<SnapshotResult<KeyedStateHandle>>	StateSnapshotContextSynchronousImpl.keyedStateCheckpointClosingFuture
protected Collection<KeyedStateHandle>	AbstractKeyedStateBackendBuilder.restoreStateHandles

返回KeyedStateHandle的org.apache.flink.runtime.state中的方法

限定符和类型	方法和说明
KeyedStateHandle	CheckpointStreamWithResultProvider.KeyedStateHandleFactory.create(KeyGroupRangeOffsets keyGroupRangeOffsets, StreamStateHandle streamStateHandle)
KeyedStateHandle	IncrementalRemoteKeyedStateHandle.getIntersection(KeyGroupRange keyGroupRange)
KeyedStateHandle	DirectoryKeyedStateHandle.getIntersection(KeyGroupRange otherKeyGroupRange)
KeyedStateHandle	KeyedStateHandle.getIntersection(KeyGroupRange keyGroupRange) Returns a state over a range that is the intersection between this handle's key-group range and the provided key-group range.

返回变量类型为KeyedStateHandle的类型的org.apache.flink.runtime.state中的方法

限定符和类型	方法和说明
SnapshotStrategy.SnapshotResultSupplier<KeyedStateHandle>	SavepointSnapshotStrategy.asyncSnapshot(FullSnapshotResources<K> savepointResources, long checkpointId, long timestamp, CheckpointStreamFactory streamFactory, CheckpointOptions checkpointOptions)
SnapshotResult<KeyedStateHandle>	FullSnapshotAsyncWriter.get(org.apache.flink.core.fs.CloseableRegistry snapshotCloseableRegistry)
RunnableFuture<SnapshotResult<KeyedStateHandle>>	StateSnapshotContextSynchronousImpl.getKeyedStateStreamFuture()
static SnapshotResult<KeyedStateHandle>	CheckpointStreamWithResultProvider.toKeyedStateHandleSnapshotResult(SnapshotResult<StreamStateHandle> snapshotResult, KeyGroupRangeOffsets keyGroupRangeOffsets, CheckpointStreamWithResultProvider.KeyedStateHandleFactory stateHandleFactory) Helper method that takes a SnapshotResult and a KeyGroupRangeOffsets and creates a SnapshotResult by combining the key groups offsets with all the present stream state handles.

类型变量类型为KeyedStateHandle的org.apache.flink.runtime.state中的方法参数

限定符和类型	方法和说明
abstract <K> AbstractKeyedStateBackend<K>	AbstractStateBackend.createKeyedStateBackend(Environment env, org.apache.flink.api.common.JobID jobID, String operatorIdentifier, org.apache.flink.api.common.typeutils.TypeSerializer<K> keySerializer, int numberOfKeyGroups, KeyGroupRange keyGroupRange, TaskKvStateRegistry kvStateRegistry, TtlTimeProvider ttlTimeProvider, org.apache.flink.metrics.MetricGroup metricGroup, Collection<KeyedStateHandle> stateHandles, org.apache.flink.core.fs.CloseableRegistry cancelStreamRegistry)
<K> CheckpointableKeyedStateBackend<K>	StateBackend.createKeyedStateBackend(Environment env, org.apache.flink.api.common.JobID jobID, String operatorIdentifier, org.apache.flink.api.common.typeutils.TypeSerializer<K> keySerializer, int numberOfKeyGroups, KeyGroupRange keyGroupRange, TaskKvStateRegistry kvStateRegistry, TtlTimeProvider ttlTimeProvider, org.apache.flink.metrics.MetricGroup metricGroup, Collection<KeyedStateHandle> stateHandles, org.apache.flink.core.fs.CloseableRegistry cancelStreamRegistry) Creates a new CheckpointableKeyedStateBackend that is responsible for holding keyed state and checkpointing it.
abstract <K> AbstractKeyedStateBackend<K>	AbstractManagedMemoryStateBackend.createKeyedStateBackend(Environment env, org.apache.flink.api.common.JobID jobID, String operatorIdentifier, org.apache.flink.api.common.typeutils.TypeSerializer<K> keySerializer, int numberOfKeyGroups, KeyGroupRange keyGroupRange, TaskKvStateRegistry kvStateRegistry, TtlTimeProvider ttlTimeProvider, org.apache.flink.metrics.MetricGroup metricGroup, Collection<KeyedStateHandle> stateHandles, org.apache.flink.core.fs.CloseableRegistry cancelStreamRegistry, double managedMemoryFraction)
default <K> CheckpointableKeyedStateBackend<K>	StateBackend.createKeyedStateBackend(Environment env, org.apache.flink.api.common.JobID jobID, String operatorIdentifier, org.apache.flink.api.common.typeutils.TypeSerializer<K> keySerializer, int numberOfKeyGroups, KeyGroupRange keyGroupRange, TaskKvStateRegistry kvStateRegistry, TtlTimeProvider ttlTimeProvider, org.apache.flink.metrics.MetricGroup metricGroup, Collection<KeyedStateHandle> stateHandles, org.apache.flink.core.fs.CloseableRegistry cancelStreamRegistry, double managedMemoryFraction) Creates a new CheckpointableKeyedStateBackend with the given managed memory fraction.

类型变量类型为KeyedStateHandle的org.apache.flink.runtime.state中的构造器参数

构造器和说明

AbstractKeyedStateBackendBuilder(TaskKvStateRegistry kvStateRegistry, org.apache.flink.api.common.typeutils.TypeSerializer<K> keySerializer, ClassLoader userCodeClassLoader, int numberOfKeyGroups, KeyGroupRange keyGroupRange, org.apache.flink.api.common.ExecutionConfig executionConfig, TtlTimeProvider ttlTimeProvider, LatencyTrackingStateConfig latencyTrackingStateConfig, Collection<KeyedStateHandle> stateHandles, StreamCompressionDecorator keyGroupCompressionDecorator, org.apache.flink.core.fs.CloseableRegistry cancelStreamRegistry)

org.apache.flink.runtime.state.changelog中KeyedStateHandle的使用

org.apache.flink.runtime.state.changelog中KeyedStateHandle的子接口

限定符和类型	接口和说明
interface	ChangelogStateBackendHandle A handle to ChangelogStateBackend state.
interface	ChangelogStateHandle A handle to saved state changes.

实现KeyedStateHandle的org.apache.flink.runtime.state.changelog中的类

限定符和类型	类和说明
static class	ChangelogStateBackendHandle.ChangelogStateBackendHandleImpl
class	ChangelogStateHandleStreamImpl ChangelogStateHandle implementation based on StreamStateHandle.

返回KeyedStateHandle的org.apache.flink.runtime.state.changelog中的方法

限定符和类型	方法和说明
KeyedStateHandle	ChangelogStateHandleStreamImpl.getIntersection(KeyGroupRange keyGroupRange)
KeyedStateHandle	ChangelogStateBackendHandle.ChangelogStateBackendHandleImpl.getIntersection(KeyGroupRange keyGroupRange)

返回变量类型为KeyedStateHandle的类型的org.apache.flink.runtime.state.changelog中的方法

限定符和类型	方法和说明
List<KeyedStateHandle>	ChangelogStateBackendHandle.getMaterializedStateHandles()
List<KeyedStateHandle>	ChangelogStateBackendHandle.ChangelogStateBackendHandleImpl.getMaterializedStateHandles()

类型变量类型为KeyedStateHandle的org.apache.flink.runtime.state.changelog中的方法参数

限定符和类型	方法和说明
static ChangelogStateBackendHandle.ChangelogStateBackendHandleImpl	ChangelogStateBackendHandle.ChangelogStateBackendHandleImpl.restore(List<KeyedStateHandle> materialized, List<ChangelogStateHandle> nonMaterialized, KeyGroupRange keyGroupRange, long materializationID, long persistedSizeOfThisCheckpoint, StateHandleID stateHandleId)

类型变量类型为KeyedStateHandle的org.apache.flink.runtime.state.changelog中的构造器参数

构造器和说明
ChangelogStateBackendHandleImpl(List<KeyedStateHandle> materialized, List<ChangelogStateHandle> nonMaterialized, KeyGroupRange keyGroupRange, long materializationID, long persistedSizeOfThisCheckpoint)

org.apache.flink.runtime.state.changelog.inmemory中KeyedStateHandle的使用

实现KeyedStateHandle的org.apache.flink.runtime.state.changelog.inmemory中的类

限定符和类型	类和说明
class	InMemoryChangelogStateHandle In-memory ChangelogStateHandle.

返回KeyedStateHandle的org.apache.flink.runtime.state.changelog.inmemory中的方法

限定符和类型	方法和说明
KeyedStateHandle	InMemoryChangelogStateHandle.getIntersection(KeyGroupRange keyGroupRange)

org.apache.flink.runtime.state.filesystem中KeyedStateHandle的使用

类型变量类型为KeyedStateHandle的org.apache.flink.runtime.state.filesystem中的方法参数

限定符和类型

方法和说明

<K> AbstractKeyedStateBackend<K>

FsStateBackend.createKeyedStateBackend(Environment env, org.apache.flink.api.common.JobID jobID, String operatorIdentifier, org.apache.flink.api.common.typeutils.TypeSerializer<K> keySerializer, int numberOfKeyGroups, KeyGroupRange keyGroupRange, TaskKvStateRegistry kvStateRegistry, TtlTimeProvider ttlTimeProvider, org.apache.flink.metrics.MetricGroup metricGroup, Collection<KeyedStateHandle> stateHandles, org.apache.flink.core.fs.CloseableRegistry cancelStreamRegistry) 已过时。

org.apache.flink.runtime.state.hashmap中KeyedStateHandle的使用

类型变量类型为KeyedStateHandle的org.apache.flink.runtime.state.hashmap中的方法参数

限定符和类型

方法和说明

<K> AbstractKeyedStateBackend<K>

HashMapStateBackend.createKeyedStateBackend(Environment env, org.apache.flink.api.common.JobID jobID, String operatorIdentifier, org.apache.flink.api.common.typeutils.TypeSerializer<K> keySerializer, int numberOfKeyGroups, KeyGroupRange keyGroupRange, TaskKvStateRegistry kvStateRegistry, TtlTimeProvider ttlTimeProvider, org.apache.flink.metrics.MetricGroup metricGroup, Collection<KeyedStateHandle> stateHandles, org.apache.flink.core.fs.CloseableRegistry cancelStreamRegistry)

org.apache.flink.runtime.state.heap中KeyedStateHandle的使用

返回变量类型为KeyedStateHandle的类型的org.apache.flink.runtime.state.heap中的方法

限定符和类型	方法和说明
RunnableFuture<SnapshotResult<KeyedStateHandle>>	HeapKeyedStateBackend.snapshot(long checkpointId, long timestamp, CheckpointStreamFactory streamFactory, CheckpointOptions checkpointOptions)

类型变量类型为KeyedStateHandle的org.apache.flink.runtime.state.heap中的构造器参数

构造器和说明

HeapKeyedStateBackendBuilder(TaskKvStateRegistry kvStateRegistry, org.apache.flink.api.common.typeutils.TypeSerializer<K> keySerializer, ClassLoader userCodeClassLoader, int numberOfKeyGroups, KeyGroupRange keyGroupRange, org.apache.flink.api.common.ExecutionConfig executionConfig, TtlTimeProvider ttlTimeProvider, LatencyTrackingStateConfig latencyTrackingStateConfig, Collection<KeyedStateHandle> stateHandles, StreamCompressionDecorator keyGroupCompressionDecorator, LocalRecoveryConfig localRecoveryConfig, HeapPriorityQueueSetFactory priorityQueueSetFactory, boolean asynchronousSnapshots, org.apache.flink.core.fs.CloseableRegistry cancelStreamRegistry)

org.apache.flink.runtime.state.memory中KeyedStateHandle的使用

类型变量类型为KeyedStateHandle的org.apache.flink.runtime.state.memory中的方法参数

限定符和类型

方法和说明

<K> AbstractKeyedStateBackend<K>

MemoryStateBackend.createKeyedStateBackend(Environment env, org.apache.flink.api.common.JobID jobID, String operatorIdentifier, org.apache.flink.api.common.typeutils.TypeSerializer<K> keySerializer, int numberOfKeyGroups, KeyGroupRange keyGroupRange, TaskKvStateRegistry kvStateRegistry, TtlTimeProvider ttlTimeProvider, org.apache.flink.metrics.MetricGroup metricGroup, Collection<KeyedStateHandle> stateHandles, org.apache.flink.core.fs.CloseableRegistry cancelStreamRegistry) 已过时。

org.apache.flink.runtime.state.restore中KeyedStateHandle的使用

类型变量类型为KeyedStateHandle的org.apache.flink.runtime.state.restore中的构造器参数

构造器和说明
FullSnapshotRestoreOperation(KeyGroupRange keyGroupRange, ClassLoader userCodeClassLoader, Collection<KeyedStateHandle> restoreStateHandles, StateSerializerProvider<K> keySerializerProvider)