pyflink.datastream.state.ListState

class ListState

State interface for partitioned list state in Operations. The state is accessed and modified by user functions, and checkpointed consistently by the system as part of the distributed snapshots.

Currently only keyed list state is supported.

When it is a keyed list state, the state key is automatically supplied by the system, so the user 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.

Methods

add(value)	Adding the given value to the tail of this list state.
add_all(values)	Adding the given values to the tail of this list state.
clear()	Removes the value mapped under the current key.
get()	Returns the elements under the current key.
update(values)	Updating existing values to the given list of values.