org.apache.flink.streaming.api.operators.sorted.state

Class BatchExecutionStateBackend

java.lang.Object

org.apache.flink.streaming.api.operators.sorted.state.BatchExecutionStateBackend

All Implemented Interfaces:

Serializable, StateBackend

public class BatchExecutionStateBackend
extends Object
implements StateBackend

A simple StateBackend which is used in a BATCH style execution.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BatchExecutionStateBackend()

Method Summary

Modifier and Type	Method and Description
<K> CheckpointableKeyedStateBackend<K>	createKeyedStateBackend(Environment env, JobID jobID, String operatorIdentifier, TypeSerializer<K> keySerializer, int numberOfKeyGroups, KeyGroupRange keyGroupRange, TaskKvStateRegistry kvStateRegistry, TtlTimeProvider ttlTimeProvider, MetricGroup metricGroup, Collection<KeyedStateHandle> stateHandles, CloseableRegistry cancelStreamRegistry) Creates a new CheckpointableKeyedStateBackend that is responsible for holding keyed state and checkpointing it.
OperatorStateBackend	createOperatorStateBackend(Environment env, String operatorIdentifier, Collection<OperatorStateHandle> stateHandles, CloseableRegistry cancelStreamRegistry) Creates a new OperatorStateBackend that can be used for storing operator state.

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.StateBackend

createKeyedStateBackend, getName, supportsNoClaimRestoreMode, supportsSavepointFormat, useManagedMemory

Constructor Detail

BatchExecutionStateBackend

public BatchExecutionStateBackend()

Method Detail

createKeyedStateBackend

public <K> CheckpointableKeyedStateBackend<K> createKeyedStateBackend(Environment env,
                                                                      JobID jobID,
                                                                      String operatorIdentifier,
                                                                      TypeSerializer<K> keySerializer,
                                                                      int numberOfKeyGroups,
                                                                      KeyGroupRange keyGroupRange,
                                                                      TaskKvStateRegistry kvStateRegistry,
                                                                      TtlTimeProvider ttlTimeProvider,
                                                                      MetricGroup metricGroup,
                                                                      @Nonnull
                                                                      Collection<KeyedStateHandle> stateHandles,
                                                                      CloseableRegistry cancelStreamRegistry)

Description copied from interface: StateBackend

Creates a new CheckpointableKeyedStateBackend that is responsible for holding keyed state and checkpointing it.

Keyed State is state where each value is bound to a key.

Specified by:

createKeyedStateBackend in interface StateBackend

Type Parameters:

K - The type of the keys by which the state is organized.

Parameters:

env - The environment of the task.

jobID - The ID of the job that the task belongs to.

operatorIdentifier - The identifier text of the operator.

keySerializer - The key-serializer for the operator.

numberOfKeyGroups - The number of key-groups aka max parallelism.

keyGroupRange - Range of key-groups for which the to-be-created backend is responsible.

kvStateRegistry - KvStateRegistry helper for this task.

ttlTimeProvider - Provider for TTL logic to judge about state expiration.

metricGroup - The parent metric group for all state backend metrics.

stateHandles - The state handles for restore.

cancelStreamRegistry - The registry to which created closeable objects will be registered during restore.

Returns:

The Keyed State Backend for the given job, operator, and key group range.

createOperatorStateBackend

public OperatorStateBackend createOperatorStateBackend(Environment env,
                                                       String operatorIdentifier,
                                                       @Nonnull
                                                       Collection<OperatorStateHandle> stateHandles,
                                                       CloseableRegistry cancelStreamRegistry)
                                                throws Exception

Description copied from interface: StateBackend

Creates a new OperatorStateBackend that can be used for storing operator state.

Operator state is state that is associated with parallel operator (or function) instances, rather than with keys.

Specified by:

createOperatorStateBackend in interface StateBackend

Parameters:

env - The runtime environment of the executing task.

operatorIdentifier - The identifier of the operator whose state should be stored.

stateHandles - The state handles for restore.

cancelStreamRegistry - The registry to register streams to close if task canceled.

Returns:

The OperatorStateBackend for operator identified by the job and operator identifier.

Throws:

Exception - This method may forward all exceptions that occur while instantiating the backend.