T
- Type of the value in the state.@PublicEvolving public interface ValueState<T> extends State
State
interface for partitioned single-value state. The value can be retrieved or
updated.
The state is accessed and modified by user functions, and checkpointed consistently by the system as part of the distributed snapshots.
The state is only accessible by functions applied on a KeyedStream
. The key is
automatically supplied by the system, so the function always sees the value mapped to the
key of the current element. That way, the system can handle stream and state partitioning
consistently together.
Modifier and Type | Method and Description |
---|---|
void |
update(T value)
Updates the operator state accessible by
value() to the given
value. |
T |
value()
Returns the current value for the state.
|
T value() throws IOException
If you didn't specify a default value when creating the ValueStateDescriptor
this will return null
when to value was previously set using update(Object)
.
IOException
- Thrown if the system cannot access the state.void update(T value) throws IOException
value()
to the given
value. The next time value()
is called (for the same state
partition) the returned state will represent the updated value. When a
partitioned state is updated with null, the state for the current key
will be removed and the default value is returned on the next access.value
- The new value for the state.IOException
- Thrown if the system cannot access the state.Copyright © 2014–2018 The Apache Software Foundation. All rights reserved.