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

Class KeyedBroadcastProcessFunction.ReadOnlyContext

java.lang.Object

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

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

Direct Known Subclasses:

KeyedBroadcastProcessFunction.OnTimerContext

Enclosing class:

KeyedBroadcastProcessFunction<KS,IN1,IN2,OUT>

public abstract class KeyedBroadcastProcessFunction.ReadOnlyContext
extends BaseBroadcastProcessFunction.ReadOnlyContext

A context available to the keyed stream side of a BroadcastConnectedStream (if any).

Apart from the basic functionality of a context, this also allows to get a read-only Iterable over the elements stored in the broadcast state and a TimerService for querying time and registering timers.

Constructor Summary

Constructors

Constructor and Description
ReadOnlyContext()

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 key of the element being processed.
abstract <X> void	output(org.apache.flink.util.OutputTag<X> outputTag, X value) Emits a record to the side output identified by the OutputTag.
abstract TimerService	timerService() A TimerService for querying time and registering timers.
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.BaseBroadcastProcessFunction.ReadOnlyContext

getBroadcastState

Methods inherited from class java.lang.Object

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

Constructor Detail

ReadOnlyContext

public ReadOnlyContext()

Method Detail

timerService

public abstract TimerService timerService()

A TimerService for querying time and registering timers.

getCurrentKey

public abstract KS getCurrentKey()

Get key of the element being processed.

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(org.apache.flink.util.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.