Uses of Interface
org.apache.flink.api.common.state.State

Packages that use State

Package	Description
org.apache.flink.api.common.state
org.apache.flink.contrib.streaming.state
org.apache.flink.queryablestate.client
org.apache.flink.queryablestate.client.state
org.apache.flink.runtime.state
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.internal	This package holds the classes of the internal state type hierarchy.
org.apache.flink.runtime.state.ttl
org.apache.flink.streaming.api.functions.co
org.apache.flink.streaming.api.operators
org.apache.flink.streaming.api.operators.util
org.apache.flink.streaming.api.windowing.triggers
org.apache.flink.streaming.runtime.operators.windowing	This package contains the operators that implement the various window operations on data streams.
org.apache.flink.streaming.tests.verify
org.apache.flink.table.runtime.functions
org.apache.flink.table.runtime.operators.window.internal
org.apache.flink.table.runtime.operators.window.triggers

Uses of State in org.apache.flink.api.common.state

Classes in org.apache.flink.api.common.state with type parameters of type State

Modifier and Type	Class and Description
class	StateDescriptor<S extends State,T> Base class for state descriptors.

Subinterfaces of State in org.apache.flink.api.common.state

Modifier and Type	Interface and Description
interface	AggregatingState<IN,OUT> State interface for aggregating state, based on an AggregateFunction.
interface	AppendingState<IN,OUT> Base interface for partitioned state that supports adding elements and inspecting the current state.
interface	BroadcastState<K,V> A type of state that can be created to store the state of a BroadcastStream.
interface	FoldingState<T,ACC> Deprecated. will be removed in a future version in favor of AggregatingState
interface	ListState<T> State interface for partitioned list state in Operations.
interface	MapState<UK,UV> State interface for partitioned key-value state.
interface	MergingState<IN,OUT> Extension of AppendingState that allows merging of state.
interface	ReadOnlyBroadcastState<K,V> A read-only view of the BroadcastState.
interface	ReducingState<T> State interface for reducing state.
interface	ValueState<T> State interface for partitioned single-value state.

Uses of State in org.apache.flink.contrib.streaming.state

Classes in org.apache.flink.contrib.streaming.state that implement State

Modifier and Type	Class and Description
class	AbstractRocksDBState<K,N,V> Base class for State implementations that store state in a RocksDB database.

Methods in org.apache.flink.contrib.streaming.state with type parameters of type State

Modifier and Type	Method and Description
<N,SV,SEV,S extends State,IS extends S> IS	RocksDBKeyedStateBackend.createInternalState(TypeSerializer<N> namespaceSerializer, StateDescriptor<S,SV> stateDesc, StateSnapshotTransformer.StateSnapshotTransformFactory<SEV> snapshotTransformFactory)

Uses of State in org.apache.flink.queryablestate.client

Methods in org.apache.flink.queryablestate.client with type parameters of type State

Modifier and Type	Method and Description
<K,S extends State,V> CompletableFuture<S>	QueryableStateClient.getKvState(JobID jobId, String queryableStateName, K key, TypeHint<K> keyTypeHint, StateDescriptor<S,V> stateDescriptor) Returns a future holding the request result.
<K,S extends State,V> CompletableFuture<S>	QueryableStateClient.getKvState(JobID jobId, String queryableStateName, K key, TypeInformation<K> keyTypeInfo, StateDescriptor<S,V> stateDescriptor) Returns a future holding the request result.

Uses of State in org.apache.flink.queryablestate.client.state

Classes in org.apache.flink.queryablestate.client.state that implement State

Modifier and Type	Class and Description
class	ImmutableAggregatingState<IN,OUT> A read-only AggregatingState that does not allow for modifications.
class	ImmutableFoldingState<IN,ACC> Deprecated.
class	ImmutableListState<V> A read-only ListState that does not allow for modifications.
class	ImmutableMapState<K,V> A read-only MapState that does not allow for modifications.
class	ImmutableReducingState<V> A read-only ReducingState that does not allow for modifications.
class	ImmutableValueState<V> A read-only ValueState that does not allow for modifications.

Methods in org.apache.flink.queryablestate.client.state with type parameters of type State

Modifier and Type	Method and Description
static <ACC,S extends State> S	ImmutableFoldingState.createState(StateDescriptor<S,ACC> stateDescriptor, byte[] serializedState) Deprecated.
static <OUT,ACC,S extends State> S	ImmutableAggregatingState.createState(StateDescriptor<S,ACC> stateDescriptor, byte[] serializedState)
static <K,V,T,S extends State> S	ImmutableMapState.createState(StateDescriptor<S,T> stateDescriptor, byte[] serializedState)
static <V,T,S extends State> S	ImmutableListState.createState(StateDescriptor<S,T> stateDescriptor, byte[] serializedState)
static <V,S extends State> S	ImmutableReducingState.createState(StateDescriptor<S,V> stateDescriptor, byte[] serializedState)
static <V,S extends State> S	ImmutableValueState.createState(StateDescriptor<S,V> stateDescriptor, byte[] serializedState)

Uses of State in org.apache.flink.runtime.state

Classes in org.apache.flink.runtime.state with type parameters of type State

Modifier and Type	Interface and Description
interface	KeyedStateFunction<K,S extends State> A function to be applied to all keyed states.

Subinterfaces of State in org.apache.flink.runtime.state

Modifier and Type	Interface and Description
interface	BackendWritableBroadcastState<K,V> An interface with methods related to the interplay between the Broadcast State and the OperatorStateBackend.

Classes in org.apache.flink.runtime.state that implement State

Modifier and Type	Class and Description
class	HeapBroadcastState<K,V> A Broadcast State backed a heap-based Map.
class	PartitionableListState<S> Implementation of operator list state.

Methods in org.apache.flink.runtime.state with type parameters of type State

Modifier and Type	Method and Description
<N,S extends State,T> void	KeyedStateBackend.applyToAllKeys(N namespace, TypeSerializer<N> namespaceSerializer, StateDescriptor<S,T> stateDescriptor, KeyedStateFunction<K,S> function) Applies the provided KeyedStateFunction to the state with the provided StateDescriptor of all the currently active keys.
<N,S extends State,T> void	AbstractKeyedStateBackend.applyToAllKeys(N namespace, TypeSerializer<N> namespaceSerializer, StateDescriptor<S,T> stateDescriptor, KeyedStateFunction<K,S> function)
default <N,SV,S extends State,IS extends S> IS	KeyedStateFactory.createInternalState(TypeSerializer<N> namespaceSerializer, StateDescriptor<S,SV> stateDesc) Creates and returns a new InternalKvState.
<N,SV,SEV,S extends State,IS extends S> IS	KeyedStateFactory.createInternalState(TypeSerializer<N> namespaceSerializer, StateDescriptor<S,SV> stateDesc, StateSnapshotTransformer.StateSnapshotTransformFactory<SEV> snapshotTransformFactory) Creates and returns a new InternalKvState.
<N,S extends State,T> S	KeyedStateBackend.getOrCreateKeyedState(TypeSerializer<N> namespaceSerializer, StateDescriptor<S,T> stateDescriptor) Creates or retrieves a keyed state backed by this state backend.
<N,S extends State,V> S	AbstractKeyedStateBackend.getOrCreateKeyedState(TypeSerializer<N> namespaceSerializer, StateDescriptor<S,V> stateDescriptor)
<N,S extends State> S	KeyedStateBackend.getPartitionedState(N namespace, TypeSerializer<N> namespaceSerializer, StateDescriptor<S,?> stateDescriptor) Creates or retrieves a partitioned state backed by this state backend.
<N,S extends State> S	AbstractKeyedStateBackend.getPartitionedState(N namespace, TypeSerializer<N> namespaceSerializer, StateDescriptor<S,?> stateDescriptor) TODO: NOTE: This method does a lot of work caching / retrieving states just to update the namespace.
protected <S extends State> S	DefaultKeyedStateStore.getPartitionedState(StateDescriptor<S,?> stateDescriptor)

Uses of State in org.apache.flink.runtime.state.heap

Classes in org.apache.flink.runtime.state.heap that implement State

Modifier and Type	Class and Description
class	AbstractHeapState<K,N,SV> Base class for partitioned State implementations that are backed by a regular heap hash map.

Methods in org.apache.flink.runtime.state.heap with type parameters of type State

Modifier and Type	Method and Description
<N,S extends State,T> void	HeapKeyedStateBackend.applyToAllKeys(N namespace, TypeSerializer<N> namespaceSerializer, StateDescriptor<S,T> stateDescriptor, KeyedStateFunction<K,S> function)
<N,SV,SEV,S extends State,IS extends S> IS	HeapKeyedStateBackend.createInternalState(TypeSerializer<N> namespaceSerializer, StateDescriptor<S,SV> stateDesc, StateSnapshotTransformer.StateSnapshotTransformFactory<SEV> snapshotTransformFactory)

Uses of State in org.apache.flink.runtime.state.internal

Subinterfaces of State in org.apache.flink.runtime.state.internal

Modifier and Type	Interface and Description
interface	InternalAggregatingState<K,N,IN,SV,OUT> The peer to the AggregatingState in the internal state type hierarchy.
interface	InternalAppendingState<K,N,IN,SV,OUT> The peer to the AppendingState in the internal state type hierarchy.
interface	InternalFoldingState<K,N,T,ACC> Deprecated. will be removed in a future version
interface	InternalKvState<K,N,V> The InternalKvState is the root of the internal state type hierarchy, similar to the State being the root of the public API state hierarchy.
interface	InternalListState<K,N,T> The peer to the ListState in the internal state type hierarchy.
interface	InternalMapState<K,N,UK,UV> The peer to the MapState in the internal state type hierarchy.
interface	InternalMergingState<K,N,IN,SV,OUT> The peer to the MergingState in the internal state type hierarchy.
interface	InternalReducingState<K,N,T> The peer to the ReducingState in the internal state type hierarchy.
interface	InternalValueState<K,N,T> The peer to the ValueState in the internal state type hierarchy.

Uses of State in org.apache.flink.runtime.state.ttl

Classes in org.apache.flink.runtime.state.ttl with type parameters of type State

Modifier and Type	Class and Description
class	TtlStateFactory<K,N,SV,TTLSV,S extends State,IS extends S> This state factory wraps state objects, produced by backends, with TTL logic.

Methods in org.apache.flink.runtime.state.ttl with type parameters of type State

Modifier and Type	Method and Description
static <K,N,SV,TTLSV,S extends State,IS extends S> IS	TtlStateFactory.createStateAndWrapWithTtlIfEnabled(TypeSerializer<N> namespaceSerializer, StateDescriptor<S,SV> stateDesc, KeyedStateBackend<K> stateBackend, TtlTimeProvider timeProvider)

Uses of State in org.apache.flink.streaming.api.functions.co

Methods in org.apache.flink.streaming.api.functions.co with type parameters of type State

Modifier and Type	Method and Description
abstract <VS,S extends State> void	KeyedBroadcastProcessFunction.Context.applyToKeyedState(StateDescriptor<S,VS> stateDescriptor, KeyedStateFunction<KS,S> function) Applies the provided function to the state associated with the provided state descriptor.

Uses of State in org.apache.flink.streaming.api.operators

Methods in org.apache.flink.streaming.api.operators with type parameters of type State

Modifier and Type	Method and Description
protected <N,S extends State,T> S	AbstractStreamOperator.getOrCreateKeyedState(TypeSerializer<N> namespaceSerializer, StateDescriptor<S,T> stateDescriptor)
protected <N,S extends State,T> S	AbstractStreamOperatorV2.getOrCreateKeyedState(TypeSerializer<N> namespaceSerializer, StateDescriptor<S,T> stateDescriptor)
<N,S extends State,T> S	StreamOperatorStateHandler.getOrCreateKeyedState(TypeSerializer<N> namespaceSerializer, StateDescriptor<S,T> stateDescriptor)
protected <S extends State,N> S	AbstractStreamOperator.getPartitionedState(N namespace, TypeSerializer<N> namespaceSerializer, StateDescriptor<S,?> stateDescriptor) Creates a partitioned state handle, using the state backend configured for this task.
protected <S extends State,N> S	AbstractStreamOperatorV2.getPartitionedState(N namespace, TypeSerializer<N> namespaceSerializer, StateDescriptor<S,?> stateDescriptor) Creates a partitioned state handle, using the state backend configured for this task.
protected <S extends State,N> S	StreamOperatorStateHandler.getPartitionedState(N namespace, TypeSerializer<N> namespaceSerializer, StateDescriptor<S,?> stateDescriptor) Creates a partitioned state handle, using the state backend configured for this task.
protected <S extends State> S	AbstractStreamOperator.getPartitionedState(StateDescriptor<S,?> stateDescriptor) Creates a partitioned state handle, using the state backend configured for this task.
protected <S extends State> S	AbstractStreamOperatorV2.getPartitionedState(StateDescriptor<S,?> stateDescriptor) Creates a partitioned state handle, using the state backend configured for this task.

Uses of State in org.apache.flink.streaming.api.operators.util

Classes in org.apache.flink.streaming.api.operators.util that implement State

Modifier and Type	Class and Description
class	SimpleVersionedListState<T> A ListState that uses a SimpleVersionedSerializer instead of a TypeSerializer.

Uses of State in org.apache.flink.streaming.api.windowing.triggers

Methods in org.apache.flink.streaming.api.windowing.triggers with type parameters of type State

Modifier and Type	Method and Description
<S extends State> S	Trigger.TriggerContext.getPartitionedState(StateDescriptor<S,?> stateDescriptor) Retrieves a State object that can be used to interact with fault-tolerant state that is scoped to the window and key of the current trigger invocation.

Uses of State in org.apache.flink.streaming.runtime.operators.windowing

Methods in org.apache.flink.streaming.runtime.operators.windowing with type parameters of type State

Modifier and Type	Method and Description
protected <S extends State> S	WindowOperator.PerWindowStateStore.getPartitionedState(StateDescriptor<S,?> stateDescriptor)
<S extends State> S	WindowOperator.Context.getPartitionedState(StateDescriptor<S,?> stateDescriptor)

Uses of State in org.apache.flink.streaming.tests.verify

Methods in org.apache.flink.streaming.tests.verify that return State

Modifier and Type	Method and Description
State	TtlStateVerifier.createState(FunctionInitializationContext context, StateTtlConfig ttlConfig)

Methods in org.apache.flink.streaming.tests.verify with parameters of type State

Modifier and Type	Method and Description
GV	TtlStateVerifier.get(State state)
void	TtlStateVerifier.update(State state, Object update)

Uses of State in org.apache.flink.table.runtime.functions

Methods in org.apache.flink.table.runtime.functions with parameters of type State

Modifier and Type	Method and Description
protected void	KeyedProcessFunctionWithCleanupState.cleanupState(State... states)

Uses of State in org.apache.flink.table.runtime.operators.window.internal

Methods in org.apache.flink.table.runtime.operators.window.internal with type parameters of type State

Modifier and Type	Method and Description
<S extends State> S	InternalWindowProcessFunction.Context.getPartitionedState(StateDescriptor<S,?> stateDescriptor) Creates a partitioned state handle, using the state backend configured for this task.

Uses of State in org.apache.flink.table.runtime.operators.window.triggers

Methods in org.apache.flink.table.runtime.operators.window.triggers with type parameters of type State

Modifier and Type	Method and Description
<S extends State> S	Trigger.TriggerContext.getPartitionedState(StateDescriptor<S,?> stateDescriptor) Retrieves a State object that can be used to interact with fault-tolerant state that is scoped to the window and key of the current trigger invocation.