org.apache.flink.api.common.state

Class FoldingStateDescriptor<T,ACC>

java.lang.Object

org.apache.flink.api.common.state.StateDescriptor<FoldingState<T,ACC>,ACC>

org.apache.flink.api.common.state.FoldingStateDescriptor<T,ACC>

Type Parameters:

T - Type of the values folded in the other state

ACC - Type of the value in the state

All Implemented Interfaces:

Serializable

Deprecated.

will be removed in a future version in favor of AggregatingStateDescriptor

@PublicEvolving
 @Deprecated
public class FoldingStateDescriptor<T,ACC>
extends StateDescriptor<FoldingState<T,ACC>,ACC>

StateDescriptor for FoldingState. This can be used to create partitioned folding state.

See Also:

Serialized Form

Nested Class Summary

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

StateDescriptor.Type

Field Summary

Fields inherited from class org.apache.flink.api.common.state.StateDescriptor

defaultValue, name

Constructor Summary

Constructors

Constructor and Description
FoldingStateDescriptor(String name, ACC initialValue, FoldFunction<T,ACC> foldFunction, Class<ACC> typeClass) Deprecated. Creates a new FoldingStateDescriptor with the given name, type, and initial value.
FoldingStateDescriptor(String name, ACC initialValue, FoldFunction<T,ACC> foldFunction, TypeInformation<ACC> typeInfo) Deprecated. Creates a new FoldingStateDescriptor with the given name and default value.
FoldingStateDescriptor(String name, ACC initialValue, FoldFunction<T,ACC> foldFunction, TypeSerializer<ACC> typeSerializer) Deprecated. Creates a new ValueStateDescriptor with the given name and default value.

Method Summary

Modifier and Type	Method and Description
FoldFunction<T,ACC>	getFoldFunction() Deprecated. Returns the fold function to be used for the folding state.
StateDescriptor.Type	getType() Deprecated.

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

enableTimeToLive, equals, getDefaultValue, getName, getQueryableStateName, getSerializer, getTtlConfig, hashCode, initializeSerializerUnlessSet, isQueryable, isSerializerInitialized, setQueryable, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

FoldingStateDescriptor

public FoldingStateDescriptor(String name,
                              ACC initialValue,
                              FoldFunction<T,ACC> foldFunction,
                              Class<ACC> typeClass)

Deprecated.

Creates a new FoldingStateDescriptor with the given name, type, and initial value.

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

Parameters:

name - The (unique) name for the state.

initialValue - The initial value of the fold.

foldFunction - The FoldFunction used to aggregate the state.

typeClass - The type of the values in the state.

FoldingStateDescriptor

public FoldingStateDescriptor(String name,
                              ACC initialValue,
                              FoldFunction<T,ACC> foldFunction,
                              TypeInformation<ACC> typeInfo)

Deprecated.

Creates a new FoldingStateDescriptor with the given name and default value.

Parameters:

name - The (unique) name for the state.

initialValue - The initial value of the fold.

foldFunction - The FoldFunction used to aggregate the state.

typeInfo - The type of the values in the state.

FoldingStateDescriptor

public FoldingStateDescriptor(String name,
                              ACC initialValue,
                              FoldFunction<T,ACC> foldFunction,
                              TypeSerializer<ACC> typeSerializer)

Deprecated.

Creates a new ValueStateDescriptor with the given name and default value.

Parameters:

name - The (unique) name for the state.

initialValue - The initial value of the fold.

foldFunction - The FoldFunction used to aggregate the state.

typeSerializer - The type serializer of the values in the state.

Method Detail

getFoldFunction

public FoldFunction<T,ACC> getFoldFunction()

Deprecated.

Returns the fold function to be used for the folding state.

getType

public StateDescriptor.Type getType()

Deprecated.

Specified by:

getType in class StateDescriptor<FoldingState<T,ACC>,ACC>