org.apache.flink.streaming.api.functions.co

Class KeyedBroadcastProcessFunction.OnTimerContext

java.lang.Object

org.apache.flink.streaming.api.functions.co.BaseBroadcastProcessFunction.ReadOnlyContext

org.apache.flink.streaming.api.functions.co.KeyedBroadcastProcessFunction.ReadOnlyContext

org.apache.flink.streaming.api.functions.co.KeyedBroadcastProcessFunction.OnTimerContext

Enclosing class:

KeyedBroadcastProcessFunction<KS,IN1,IN2,OUT>

public abstract class KeyedBroadcastProcessFunction.OnTimerContext
extends KeyedBroadcastProcessFunction.ReadOnlyContext

Information available in an invocation of KeyedBroadcastProcessFunction.onTimer(long, OnTimerContext, Collector).

Constructor Summary

Constructors

Constructor and Description
OnTimerContext()

Method Summary

Modifier and Type	Method and Description
abstract long	currentProcessingTime() Returns the current processing time.
abstract long	currentWatermark() Returns the current event-time watermark.
abstract KS	getCurrentKey() Get the key of the firing timer.
abstract <X> void	output(OutputTag<X> outputTag, X value) Emits a record to the side output identified by the OutputTag.
abstract TimeDomain	timeDomain() The TimeDomain of the firing timer, i.e.
abstract Long	timestamp() Timestamp of the element currently being processed or timestamp of a firing timer.

Methods inherited from class org.apache.flink.streaming.api.functions.co.KeyedBroadcastProcessFunction.ReadOnlyContext

timerService

Methods inherited from class org.apache.flink.streaming.api.functions.co.BaseBroadcastProcessFunction.ReadOnlyContext

getBroadcastState

Methods inherited from class java.lang.Object

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

Constructor Detail

OnTimerContext

public OnTimerContext()

Method Detail

timeDomain

public abstract TimeDomain timeDomain()

The TimeDomain of the firing timer, i.e. if it is event or processing time timer.

getCurrentKey

public abstract KS getCurrentKey()

Get the key of the firing timer.

Specified by:

getCurrentKey in class KeyedBroadcastProcessFunction.ReadOnlyContext

timestamp

public abstract Long timestamp()

Timestamp of the element currently being processed or timestamp of a firing timer.

This might be null, for example if the time characteristic of your program is set to TimeCharacteristic.ProcessingTime.

output

public abstract <X> void output(OutputTag<X> outputTag,
                                X value)

Emits a record to the side output identified by the OutputTag.

Parameters:

outputTag - the OutputTag that identifies the side output to emit to.

value - The record to emit.

currentProcessingTime

public abstract long currentProcessingTime()

Returns the current processing time.

currentWatermark

public abstract long currentWatermark()

Returns the current event-time watermark.