@DefaultAnnotation(org.checkerframework.checker.nullness.qual.NonNull.class) @Experimental(STATE)
Package org.apache.beam.sdk.state
Classes and interfaces for interacting with state.
-
Interface Summary Interface Description BagState<T> AReadableState
cell containing a bag of values.CombiningState<InputT,AccumT,OutputT> AReadableState
cell defined by aCombine.CombineFn
, accepting multiple input values, combining them as specified into accumulators, and producing a single output value.GroupingState<InputT,OutputT> AReadableState
cell that combines multiple input values and outputs a single value of a different type.MapState<K,V> AReadableState
cell mapping keys to values.OrderedListState<T> AReadableState
cell containing a list of values sorted by timestamp.ReadableState<T> AState
that can be read viaReadableState.read()
.SetState<T> AReadableState
cell containing a set of elements.State A state cell, supporting aState.clear()
operation.StateBinder For internal use only; no backwards-compatibility guarantees.StateContext<W extends BoundedWindow> For internal use only; no backwards-compatibility guarantees.StateSpec<StateT extends State> A specification of a persistent state cell.StateSpec.Cases<ResultT> Cases for doing a "switch" on the type ofStateSpec
.Timer A timer for a specified time domain that can be set to register the desire for further processing at particular time in its specified time domain.TimerMap Timers Interface for interacting with time.TimerSpec A specification for aTimer
.ValueState<T> AReadableState
cell containing a single value.WatermarkHoldState For internal use only; no backwards-compatibility guarantees. -
Class Summary Class Description ReadableStates For internal use only; no backwards-compatibility guarantees.StateContexts For internal use only; no backwards-compatibility guarantees.StateKeySpec StateSpec.Cases.WithDefault<ResultT> A base class for a visitor with a default method for cases it is not interested in.StateSpecs Static methods for working withStateSpecs
.TimerSpecs Static methods for working withTimerSpecs
. -
Enum Summary Enum Description TimeDomain TimeDomain
specifies whether an operation is based on timestamps of elements or current "real-world" time as reported while processing.