org.apache.flink.streaming.api.operators

Interface StreamOperatorStateContext

public interface StreamOperatorStateContext

This interface represents a context from which a stream operator can initialize everything connected to state such as e.g. backends, raw state, and timer service manager.

Method Summary

Modifier and Type	Method and Description
OptionalLong	getRestoredCheckpointId() Returns non-empty if the states provided by this context are restored from a checkpoint/savepoint.
InternalTimeServiceManager<?>	internalTimerServiceManager() Returns the internal timer service manager for the stream operator.
default boolean	isRestored() Returns true if the states provided by this context are restored from a checkpoint/savepoint.
CheckpointableKeyedStateBackend<?>	keyedStateBackend() Returns the keyed state backend for the stream operator.
OperatorStateBackend	operatorStateBackend() Returns the operator state backend for the stream operator.
CloseableIterable<KeyGroupStatePartitionStreamProvider>	rawKeyedStateInputs() Returns an iterable to obtain input streams for previously stored keyed state partitions that are assigned to this operator.
CloseableIterable<StatePartitionStreamProvider>	rawOperatorStateInputs() Returns an iterable to obtain input streams for previously stored operator state partitions that are assigned to this stream operator.

Method Detail

isRestored

default boolean isRestored()

Returns true if the states provided by this context are restored from a checkpoint/savepoint.

getRestoredCheckpointId

OptionalLong getRestoredCheckpointId()

Returns non-empty if the states provided by this context are restored from a checkpoint/savepoint.

operatorStateBackend

OperatorStateBackend operatorStateBackend()

Returns the operator state backend for the stream operator.

keyedStateBackend

CheckpointableKeyedStateBackend<?> keyedStateBackend()

Returns the keyed state backend for the stream operator. This method returns null for non-keyed operators.

internalTimerServiceManager

InternalTimeServiceManager<?> internalTimerServiceManager()

Returns the internal timer service manager for the stream operator. This method returns null for non-keyed operators.

rawOperatorStateInputs

CloseableIterable<StatePartitionStreamProvider> rawOperatorStateInputs()

Returns an iterable to obtain input streams for previously stored operator state partitions that are assigned to this stream operator.

rawKeyedStateInputs

CloseableIterable<KeyGroupStatePartitionStreamProvider> rawKeyedStateInputs()

Returns an iterable to obtain input streams for previously stored keyed state partitions that are assigned to this operator. This method returns null for non-keyed operators.