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

Class ListStateDescriptor<T>

java.lang.Object

org.apache.flink.api.common.state.v2.StateDescriptor<T>

org.apache.flink.api.common.state.v2.ListStateDescriptor<T>

Type Parameters:

T - The type of each value that the list state can hold.

All Implemented Interfaces:

Serializable

@Experimental
public class ListStateDescriptor<T>
extends StateDescriptor<T>

StateDescriptor for ListState. This can be used to create partitioned list state internally.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.flink.api.common.state.v2.StateDescriptor

StateDescriptor.Type

Constructor Summary

Constructors

Constructor	Description
ListStateDescriptor(String name, Class<T> elementTypeClass)	Creates a new ListStateDescriptor with the given name and list element type.
ListStateDescriptor(String stateId, TypeInformation<T> typeInfo)	Creates a new ListStateDescriptor with the given stateId and type.
ListStateDescriptor(String stateId, TypeSerializer<T> serializer)	Create a new ListStateDescriptor with the given stateId and the given type serializer.

Method Summary

Modifier and Type	Method	Description
StateDescriptor.Type	getType()	Return the specific Type of described state.

Methods inherited from class org.apache.flink.api.common.state.v2.StateDescriptor

enableTimeToLive, equals, getSerializer, getStateId, getTtlConfig, getTypeInformation, hashCode, initializeSerializerUnlessSet, initializeSerializerUnlessSet, isSerializerInitialized, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListStateDescriptor

public ListStateDescriptor(@Nonnull
                           String stateId,
                           @Nonnull
                           TypeInformation<T> typeInfo)

Creates a new ListStateDescriptor with the given stateId and type.

Parameters:

stateId - The (unique) stateId for the state.

typeInfo - The type of the values in the state.

ListStateDescriptor

public ListStateDescriptor(@Nonnull
                           String stateId,
                           @Nonnull
                           TypeSerializer<T> serializer)

Create a new ListStateDescriptor with the given stateId and the given type serializer.

Parameters:

stateId - The (unique) stateId for the state.

serializer - The type serializer for the values in the state.

ListStateDescriptor

public ListStateDescriptor(String name,
                           Class<T> elementTypeClass)

Creates a new ListStateDescriptor with the given name and list element type.

If this constructor fails (because it is not possible to describe the type via a class), consider using the ListStateDescriptor(String, TypeInformation) constructor.

Parameters:

name - The (unique) name for the state.

elementTypeClass - The type of the elements in the state.

Method Detail

getType

public StateDescriptor.Type getType()

Description copied from class: StateDescriptor

Return the specific Type of described state.

Specified by:

getType in class StateDescriptor<T>