org.apache.flink.table.runtime.functions

Class KeyedProcessFunctionWithCleanupState<K,IN,OUT>

java.lang.Object

org.apache.flink.api.common.functions.AbstractRichFunction

org.apache.flink.streaming.api.functions.KeyedProcessFunction<K,IN,OUT>

org.apache.flink.table.runtime.functions.KeyedProcessFunctionWithCleanupState<K,IN,OUT>

Type Parameters:

K - Type of the key.

IN - Type of the input elements.

OUT - Type of the output elements.

All Implemented Interfaces:

Serializable, Function, RichFunction, CleanupState

Direct Known Subclasses:

AbstractRowTimeUnboundedPrecedingOver, AbstractTopNFunction, DeduplicateKeepFirstRowFunction, DeduplicateKeepLastRowFunction, GroupAggFunction, GroupTableAggFunction, ProcTimeRangeBoundedPrecedingFunction, ProcTimeRowsBoundedPrecedingFunction, ProcTimeUnboundedPrecedingFunction, RowTimeRangeBoundedPrecedingFunction, RowTimeRowsBoundedPrecedingFunction

public abstract class KeyedProcessFunctionWithCleanupState<K,IN,OUT>
extends KeyedProcessFunction<K,IN,OUT>
implements CleanupState

A function that processes elements of a stream, and could cleanup state.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.flink.streaming.api.functions.KeyedProcessFunction

KeyedProcessFunction.Context, KeyedProcessFunction.OnTimerContext

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	stateCleaningEnabled

Constructor Summary

Constructors

Constructor and Description
KeyedProcessFunctionWithCleanupState(long minRetentionTime, long maxRetentionTime)

Method Summary

Modifier and Type	Method and Description
protected void	cleanupState(State... states)
protected void	initCleanupTimeState(String stateName)
protected boolean	isProcessingTimeTimer(KeyedProcessFunction.OnTimerContext ctx)
protected Boolean	needToCleanupState(Long timestamp)
protected void	registerProcessingCleanupTimer(KeyedProcessFunction.Context ctx, long currentTime)

Methods inherited from class org.apache.flink.streaming.api.functions.KeyedProcessFunction

onTimer, processElement

Methods inherited from class org.apache.flink.api.common.functions.AbstractRichFunction

close, getIterationRuntimeContext, getRuntimeContext, open, setRuntimeContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.flink.table.runtime.functions.CleanupState

registerProcessingCleanupTimer

Field Detail

stateCleaningEnabled

protected final boolean stateCleaningEnabled

Constructor Detail

KeyedProcessFunctionWithCleanupState

public KeyedProcessFunctionWithCleanupState(long minRetentionTime,
                                            long maxRetentionTime)

Method Detail

initCleanupTimeState

protected void initCleanupTimeState(String stateName)

registerProcessingCleanupTimer

protected void registerProcessingCleanupTimer(KeyedProcessFunction.Context ctx,
                                              long currentTime)
                                       throws Exception

Throws:

Exception

isProcessingTimeTimer

protected boolean isProcessingTimeTimer(KeyedProcessFunction.OnTimerContext ctx)

cleanupState

protected void cleanupState(State... states)

needToCleanupState

protected Boolean needToCleanupState(Long timestamp)
                              throws IOException

Throws:

IOException