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

Class StateDeclarations

java.lang.Object

org.apache.flink.api.common.state.StateDeclarations

@Experimental
public class StateDeclarations
extends Object

This is a helper class for declaring various states.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StateDeclarations.AggregatingStateDeclarationBuilder<IN,OUT,ACC>	Builder for AggregatingStateDeclaration.
static class	StateDeclarations.ListStateDeclarationBuilder<T>	Builder for ListStateDeclaration.
static class	StateDeclarations.MapStateDeclarationBuilder<K,V>	Builder for MapStateDeclaration.
static class	StateDeclarations.ReducingStateDeclarationBuilder<T>	Builder for ReducingStateDeclaration.
static class	StateDeclarations.ValueStateDeclarationBuilder<T>	Builder for ValueStateDeclaration.

Constructor Summary

Constructors

Constructor	Description
StateDeclarations()

Method Summary

Modifier and Type	Method	Description
static <IN,ACC,OUT> AggregatingStateDeclaration<IN,ACC,OUT>	aggregatingState(String name, TypeDescriptor<ACC> aggTypeDescriptor, AggregateFunction<IN,ACC,OUT> aggregateFunction)	Get the AggregatingStateDeclaration of aggregating state.
static <IN,OUT,ACC> StateDeclarations.AggregatingStateDeclarationBuilder<IN,OUT,ACC>	aggregatingStateBuilder(String name, TypeDescriptor<ACC> aggTypeDescriptor, AggregateFunction<IN,ACC,OUT> aggregateFunction)	Get the builder of AggregatingStateDeclaration.
static <T> ListStateDeclaration<T>	listState(String name, TypeDescriptor<T> elementTypeInformation)	Get the ListStateDeclaration of list state with StateDeclaration.RedistributionMode.NONE.
static <T> StateDeclarations.ListStateDeclarationBuilder<T>	listStateBuilder(String name, TypeDescriptor<T> elementTypeInformation)	Get the builder of ListStateDeclaration.
static <K,V> MapStateDeclaration<K,V>	mapState(String name, TypeDescriptor<K> keyTypeInformation, TypeDescriptor<V> valueTypeInformation)	Get the MapStateDeclaration of map state with StateDeclaration.RedistributionMode.NONE.
static <K,V> StateDeclarations.MapStateDeclarationBuilder<K,V>	mapStateBuilder(String name, TypeDescriptor<K> keyTypeInformation, TypeDescriptor<V> valueTypeInformation)	Get the builder of MapStateDeclaration.
static <T> ReducingStateDeclaration<T>	reducingState(String name, TypeDescriptor<T> typeInformation, ReduceFunction<T> reduceFunction)	Get the ReducingStateDeclaration of list state.
static <T> StateDeclarations.ReducingStateDeclarationBuilder<T>	reducingStateBuilder(String name, TypeDescriptor<T> typeInformation, ReduceFunction<T> reduceFunction)	Get the builder of ReducingStateDeclaration.
static <T> ValueStateDeclaration<T>	valueState(String name, TypeDescriptor<T> valueType)	Get the ValueStateDeclaration of value state.
<T> StateDeclarations.ValueStateDeclarationBuilder<T>	valueStateBuilder(String name, TypeDescriptor<T> valueType)	Get the builder of ValueStateDeclaration.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StateDeclarations

public StateDeclarations()

Method Detail

aggregatingStateBuilder

public static <IN,OUT,ACC> StateDeclarations.AggregatingStateDeclarationBuilder<IN,OUT,ACC> aggregatingStateBuilder(String name,
                                                                                                                                            TypeDescriptor<ACC> aggTypeDescriptor,
                                                                                                                                            AggregateFunction<IN,ACC,OUT> aggregateFunction)

Get the builder of AggregatingStateDeclaration.

reducingStateBuilder

public static <T> StateDeclarations.ReducingStateDeclarationBuilder<T> reducingStateBuilder(String name,
                                                                                            TypeDescriptor<T> typeInformation,
                                                                                            ReduceFunction<T> reduceFunction)

Get the builder of ReducingStateDeclaration.

mapStateBuilder

public static <K,V> StateDeclarations.MapStateDeclarationBuilder<K,V> mapStateBuilder(String name,
                                                                                                  TypeDescriptor<K> keyTypeInformation,
                                                                                                  TypeDescriptor<V> valueTypeInformation)

Get the builder of MapStateDeclaration.

listStateBuilder

public static <T> StateDeclarations.ListStateDeclarationBuilder<T> listStateBuilder(String name,
                                                                                    TypeDescriptor<T> elementTypeInformation)

Get the builder of ListStateDeclaration.

valueStateBuilder

public <T> StateDeclarations.ValueStateDeclarationBuilder<T> valueStateBuilder(String name,
                                                                               TypeDescriptor<T> valueType)

Get the builder of ValueStateDeclaration.

aggregatingState

public static <IN,ACC,OUT> AggregatingStateDeclaration<IN,ACC,OUT> aggregatingState(String name,
                                                                                                            TypeDescriptor<ACC> aggTypeDescriptor,
                                                                                                            AggregateFunction<IN,ACC,OUT> aggregateFunction)

Get the AggregatingStateDeclaration of aggregating state. If you want to configure it more elaborately, use aggregatingStateBuilder(String, TypeDescriptor, AggregateFunction).

reducingState

public static <T> ReducingStateDeclaration<T> reducingState(String name,
                                                            TypeDescriptor<T> typeInformation,
                                                            ReduceFunction<T> reduceFunction)

Get the ReducingStateDeclaration of list state. If you want to configure it more elaborately, use reducingStateBuilder(String, TypeDescriptor, ReduceFunction).

mapState

public static <K,V> MapStateDeclaration<K,V> mapState(String name,
                                                                  TypeDescriptor<K> keyTypeInformation,
                                                                  TypeDescriptor<V> valueTypeInformation)

Get the MapStateDeclaration of map state with StateDeclaration.RedistributionMode.NONE. If you want to configure it more elaborately, use mapStateBuilder(String, TypeDescriptor, TypeDescriptor).

listState

public static <T> ListStateDeclaration<T> listState(String name,
                                                    TypeDescriptor<T> elementTypeInformation)

Get the ListStateDeclaration of list state with StateDeclaration.RedistributionMode.NONE. If you want to configure it more elaborately, use listStateBuilder(String, TypeDescriptor).

valueState

public static <T> ValueStateDeclaration<T> valueState(String name,
                                                      TypeDescriptor<T> valueType)

Get the ValueStateDeclaration of value state. If you want to configure it more elaborately, use valueStateBuilder(String, TypeDescriptor).