Package org.apache.flink.streaming.api.operators.co

Class CoBroadcastWithKeyedOperator<KS,IN1,IN2,OUT>

java.lang.Object

org.apache.flink.streaming.api.operators.AbstractStreamOperator<OUT>

org.apache.flink.streaming.api.operators.AbstractUdfStreamOperator<OUT,KeyedBroadcastProcessFunction<KS,IN1,IN2,OUT>>

org.apache.flink.streaming.api.operators.co.CoBroadcastWithKeyedOperator<KS,IN1,IN2,OUT>

Type Parameters:

KS - The key type of the input keyed stream.

IN1 - The input type of the keyed (non-broadcast) side.

IN2 - The input type of the broadcast side.

OUT - The output type of the operator.

All Implemented Interfaces:

Serializable, CheckpointListener, KeyContext, KeyContextHandler, OutputTypeConfigurable<OUT>, StreamOperator<OUT>, StreamOperatorStateHandler.CheckpointedStreamOperator, Triggerable<KS,VoidNamespace>, TwoInputStreamOperator<IN1,IN2,OUT>, UserFunctionProvider<KeyedBroadcastProcessFunction<KS,IN1,IN2,OUT>>, YieldingOperator<OUT>

Direct Known Subclasses:

BatchCoBroadcastWithKeyedOperator

@Internal
public class CoBroadcastWithKeyedOperator<KS,IN1,IN2,OUT>
extends AbstractUdfStreamOperator<OUT,KeyedBroadcastProcessFunction<KS,IN1,IN2,OUT>>
implements TwoInputStreamOperator<IN1,IN2,OUT>, Triggerable<KS,VoidNamespace>

A TwoInputStreamOperator for executing KeyedBroadcastProcessFunctions.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.apache.flink.streaming.api.operators.AbstractUdfStreamOperator

userFunction

Fields inherited from class org.apache.flink.streaming.api.operators.AbstractStreamOperator

config, lastRecordAttributes1, lastRecordAttributes2, latencyStats, LOG, metrics, output, processingTimeService, stateHandler, stateKeySelector1, stateKeySelector2, timeServiceManager

Constructor Summary

Constructors

Constructor	Description
CoBroadcastWithKeyedOperator(KeyedBroadcastProcessFunction<KS,IN1,IN2,OUT> function, List<MapStateDescriptor<?,?>> broadcastStateDescriptors)

Method Summary

Modifier and Type	Method	Description
void	onEventTime(InternalTimer<KS,VoidNamespace> timer)	Invoked when an event-time timer fires.
void	onProcessingTime(InternalTimer<KS,VoidNamespace> timer)	Invoked when a processing-time timer fires.
void	open()	This method is called immediately before any elements are processed, it should contain the operator's initialization logic, e.g. state initialization.
void	processElement1(StreamRecord<IN1> element)	Processes one element that arrived on the first input of this two-input operator.
void	processElement2(StreamRecord<IN2> element)	Processes one element that arrived on the second input of this two-input operator.

Methods inherited from class org.apache.flink.streaming.api.operators.AbstractUdfStreamOperator

close, finish, getUserFunction, getUserFunctionParameters, initializeState, notifyCheckpointAborted, notifyCheckpointComplete, setOutputType, setup, snapshotState

Methods inherited from class org.apache.flink.streaming.api.operators.AbstractStreamOperator

getContainingTask, getCurrentKey, getExecutionConfig, getInternalTimerService, getKeyedStateBackend, getKeyedStateStore, getMetricGroup, getOperatorConfig, getOperatorID, getOperatorName, getOperatorStateBackend, getOrCreateKeyedState, getPartitionedState, getPartitionedState, getProcessingTimeService, getRuntimeContext, getStateKeySelector1, getStateKeySelector2, getTimeServiceManager, getUserCodeClassloader, hasKeyContext1, hasKeyContext2, initializeState, isUsingCustomRawKeyedState, prepareSnapshotPreBarrier, processLatencyMarker, processLatencyMarker1, processLatencyMarker2, processRecordAttributes, processRecordAttributes1, processRecordAttributes2, processWatermark, processWatermark1, processWatermark2, processWatermarkStatus, processWatermarkStatus1, processWatermarkStatus2, reportOrForwardLatencyMarker, setCurrentKey, setKeyContextElement1, setKeyContextElement2, setMailboxExecutor, setProcessingTimeService, snapshotState, useSplittableTimers

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.api.common.state.CheckpointListener

notifyCheckpointAborted, notifyCheckpointComplete

Methods inherited from interface org.apache.flink.streaming.api.operators.KeyContext

getCurrentKey, setCurrentKey

Methods inherited from interface org.apache.flink.streaming.api.operators.KeyContextHandler

hasKeyContext

Methods inherited from interface org.apache.flink.streaming.api.operators.StreamOperator

close, finish, getMetricGroup, getOperatorAttributes, getOperatorID, initializeState, prepareSnapshotPreBarrier, setKeyContextElement1, setKeyContextElement2, snapshotState

Methods inherited from interface org.apache.flink.streaming.api.operators.TwoInputStreamOperator

processLatencyMarker1, processLatencyMarker2, processRecordAttributes1, processRecordAttributes2, processWatermark1, processWatermark2, processWatermarkStatus1, processWatermarkStatus2

Constructor Detail

CoBroadcastWithKeyedOperator

public CoBroadcastWithKeyedOperator(KeyedBroadcastProcessFunction<KS,IN1,IN2,OUT> function,
                                    List<MapStateDescriptor<?,?>> broadcastStateDescriptors)

Method Detail

open

public void open()
          throws Exception

Description copied from class: AbstractStreamOperator

This method is called immediately before any elements are processed, it should contain the operator's initialization logic, e.g. state initialization.

The default implementation does nothing.

Specified by:

open in interface StreamOperator<KS>

Overrides:

open in class AbstractUdfStreamOperator<OUT,KeyedBroadcastProcessFunction<KS,IN1,IN2,OUT>>

Throws:

Exception - An exception in this method causes the operator to fail.

processElement1

public void processElement1(StreamRecord<IN1> element)
                     throws Exception

Description copied from interface: TwoInputStreamOperator

Processes one element that arrived on the first input of this two-input operator. This method is guaranteed to not be called concurrently with other methods of the operator.

Specified by:

processElement1 in interface TwoInputStreamOperator<KS,IN1,IN2>

Throws:

Exception

processElement2

public void processElement2(StreamRecord<IN2> element)
                     throws Exception

Description copied from interface: TwoInputStreamOperator

Processes one element that arrived on the second input of this two-input operator. This method is guaranteed to not be called concurrently with other methods of the operator.

Specified by:

processElement2 in interface TwoInputStreamOperator<KS,IN1,IN2>

Throws:

Exception

onEventTime

public void onEventTime(InternalTimer<KS,VoidNamespace> timer)
                 throws Exception

Description copied from interface: Triggerable

Invoked when an event-time timer fires.

Specified by:

onEventTime in interface Triggerable<KS,IN1>

Throws:

Exception

onProcessingTime

public void onProcessingTime(InternalTimer<KS,VoidNamespace> timer)
                      throws Exception

Description copied from interface: Triggerable

Invoked when a processing-time timer fires.

Specified by:

onProcessingTime in interface Triggerable<KS,IN1>

Throws:

Exception