org.apache.flink.runtime.state.v2

Class AggregatingStateDescriptor<IN,ACC,OUT>

java.lang.Object

org.apache.flink.runtime.state.v2.StateDescriptor<ACC>

org.apache.flink.runtime.state.v2.AggregatingStateDescriptor<IN,ACC,OUT>

Type Parameters:

IN - The type of the values that are added to the state.

ACC - The type of the accumulator (intermediate aggregation state).

OUT - The type of the values that are returned from the state.

All Implemented Interfaces:

Serializable

public class AggregatingStateDescriptor<IN,ACC,OUT>
extends StateDescriptor<ACC>

A StateDescriptor for AggregatingState.

The type internally stored in the state is the type of the Accumulator of the AggregateFunction.

See Also:

Serialized Form

Nested Class Summary

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

StateDescriptor.Type

Constructor Summary

Constructors

Constructor and Description
AggregatingStateDescriptor(String stateId, AggregateFunction<IN,ACC,OUT> aggregateFunction, TypeInformation<ACC> typeInfo) Create a new state descriptor with the given name, function, and type.
AggregatingStateDescriptor(String stateId, AggregateFunction<IN,ACC,OUT> aggregateFunction, TypeInformation<ACC> typeInfo, SerializerConfig serializerConfig) Create a new state descriptor with the given name, function, and type.

Method Summary

Modifier and Type	Method and Description
AggregateFunction<IN,ACC,OUT>	getAggregateFunction() Returns the Aggregate function for this state.
StateDescriptor.Type	getType() Return the specific Type of described state.

Methods inherited from class org.apache.flink.runtime.state.v2.StateDescriptor

enableTimeToLive, equals, getSerializer, getStateId, getTtlConfig, hashCode, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

AggregatingStateDescriptor

public AggregatingStateDescriptor(@Nonnull
                                  String stateId,
                                  @Nonnull
                                  AggregateFunction<IN,ACC,OUT> aggregateFunction,
                                  @Nonnull
                                  TypeInformation<ACC> typeInfo)

Create a new state descriptor with the given name, function, and type.

Parameters:

stateId - The (unique) name for the state.

aggregateFunction - The AggregateFunction used to aggregate the state.

typeInfo - The type of the accumulator. The accumulator is stored in the state.

AggregatingStateDescriptor

public AggregatingStateDescriptor(@Nonnull
                                  String stateId,
                                  @Nonnull
                                  AggregateFunction<IN,ACC,OUT> aggregateFunction,
                                  @Nonnull
                                  TypeInformation<ACC> typeInfo,
                                  SerializerConfig serializerConfig)

Create a new state descriptor with the given name, function, and type.

Parameters:

stateId - The (unique) name for the state.

aggregateFunction - The AggregateFunction used to aggregate the state.

typeInfo - The type of the accumulator. The accumulator is stored in the state.

serializerConfig - The serializer related config used to generate TypeSerializer.

Method Detail

getAggregateFunction

public AggregateFunction<IN,ACC,OUT> getAggregateFunction()

Returns the Aggregate function for this state.

getType

public StateDescriptor.Type getType()

Description copied from class: StateDescriptor

Return the specific Type of described state.

Specified by:

getType in class StateDescriptor<ACC>