Package org.apache.flink.api.common.state

Interface Summary

Interface	Description
AggregatingState<IN,OUT>	State interface for aggregating state, based on an AggregateFunction.
AppendingState<IN,OUT>	Base interface for partitioned state that supports adding elements and inspecting the current state.
BroadcastState<K,V>	A type of state that can be created to store the state of a BroadcastStream.
CheckpointListener	This interface is typically only needed for transactional interaction with the "outside world", like committing external side effects on checkpoints.
InternalCheckpointListener	The internal checkpoint listener add another InternalCheckpointListener.notifyCheckpointSubsumed(long) interface for internal usage.
KeyedStateStore	This interface contains methods for registering keyed state with a managed store.
ListState<T>	State interface for partitioned list state in Operations.
MapState<UK,UV>	State interface for partitioned key-value state.
MergingState<IN,OUT>	Extension of AppendingState that allows merging of state.
OperatorStateStore	This interface contains methods for registering operator state with a managed store.
ReadOnlyBroadcastState<K,V>	A read-only view of the BroadcastState.
ReducingState<T>	State interface for reducing state.
State	Interface that different types of partitioned state must implement.
ValueState<T>	State interface for partitioned single-value state.

Class Summary

Class	Description
AggregatingStateDescriptor<IN,ACC,OUT>	A StateDescriptor for AggregatingState.
ListStateDescriptor<T>	A StateDescriptor for ListState.
MapStateDescriptor<UK,UV>	A StateDescriptor for MapState.
ReducingStateDescriptor<T>	StateDescriptor for ReducingState.
StateDescriptor<S extends State,T>	Base class for state descriptors.
StateTtlConfig	Configuration of state TTL logic.
StateTtlConfig.Builder	Builder for the StateTtlConfig.
StateTtlConfig.CleanupStrategies	TTL cleanup strategies.
StateTtlConfig.IncrementalCleanupStrategy	Configuration of cleanup strategy while taking the full snapshot.
StateTtlConfig.RocksdbCompactFilterCleanupStrategy	Configuration of cleanup strategy using custom compaction filter in RocksDB.
ValueStateDescriptor<T>	StateDescriptor for ValueState.

Enum Summary

Enum	Description
StateDescriptor.Type	An enumeration of the types of supported states.
StateTtlConfig.StateVisibility	This option configures whether expired user value can be returned or not.
StateTtlConfig.TtlTimeCharacteristic	This option configures time scale to use for ttl.
StateTtlConfig.UpdateType	This option value configures when to update last access timestamp which prolongs state TTL.