Package org.apache.flink.streaming.api.operators.python.embedded

Class EmbeddedPythonKeyedProcessOperator<K,IN,OUT>

java.lang.Object

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

org.apache.flink.streaming.api.operators.python.AbstractPythonFunctionOperator<OUT>

org.apache.flink.streaming.api.operators.python.embedded.AbstractEmbeddedPythonFunctionOperator<OUT>

org.apache.flink.streaming.api.operators.python.embedded.AbstractEmbeddedDataStreamPythonFunctionOperator<OUT>

org.apache.flink.streaming.api.operators.python.embedded.AbstractOneInputEmbeddedPythonFunctionOperator<IN,OUT>

org.apache.flink.streaming.api.operators.python.embedded.EmbeddedPythonKeyedProcessOperator<K,IN,OUT>

All Implemented Interfaces:

Serializable, CheckpointListener, ResultTypeQueryable<OUT>, BoundedOneInput, Input<IN>, KeyContext, KeyContextHandler, OneInputStreamOperator<IN,OUT>, DataStreamPythonFunctionOperator<OUT>, StreamOperator<OUT>, StreamOperatorStateHandler.CheckpointedStreamOperator, Triggerable<K,VoidNamespace>, YieldingOperator<OUT>

@Internal
public class EmbeddedPythonKeyedProcessOperator<K,IN,OUT>
extends AbstractOneInputEmbeddedPythonFunctionOperator<IN,OUT>
implements Triggerable<K,VoidNamespace>

EmbeddedPythonKeyedProcessOperator is responsible for executing user defined python KeyedProcessFunction in embedded Python environment. It is also able to handle the timer and state request from the python stateful user defined function.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.apache.flink.streaming.api.operators.python.embedded.AbstractOneInputEmbeddedPythonFunctionOperator

timestamp

Fields inherited from class org.apache.flink.streaming.api.operators.python.embedded.AbstractEmbeddedDataStreamPythonFunctionOperator

collector, hasSideOutput, outputTypeInfo, sideOutputContext

Fields inherited from class org.apache.flink.streaming.api.operators.python.embedded.AbstractEmbeddedPythonFunctionOperator

interpreter

Fields inherited from class org.apache.flink.streaming.api.operators.python.AbstractPythonFunctionOperator

bundleFinishedCallback, config, elementCount, lastFinishBundleTime, maxBundleSize, systemEnvEnabled

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

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

Constructor Summary

Constructors

Constructor	Description
EmbeddedPythonKeyedProcessOperator(Configuration config, DataStreamPythonFunctionInfo pythonFunctionInfo, TypeInformation<IN> inputTypeInfo, TypeInformation<OUT> outputTypeInfo)

Method Summary

Modifier and Type	Method	Description
<T> AbstractEmbeddedDataStreamPythonFunctionOperator<T>	copy(DataStreamPythonFunctionInfo pythonFunctionInfo, TypeInformation<T> outputTypeInfo)	Make a copy of the DataStreamPythonFunctionOperator with the given pythonFunctionInfo and outputTypeInfo.
List<FlinkFnApi.UserDefinedDataStreamFunction>	createUserDefinedFunctionsProto()	Gets the proto representation of the Python user-defined functions to be executed.
Object	getFunctionContext()	Gets The function context.
Object	getTimerContext()	Gets The Timer context.
void	onEventTime(InternalTimer<K,VoidNamespace> timer)	Invoked when an event-time timer fires.
void	onProcessingTime(InternalTimer<K,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.

Methods inherited from class org.apache.flink.streaming.api.operators.python.embedded.AbstractOneInputEmbeddedPythonFunctionOperator

endInput, openPythonInterpreter, processElement

Methods inherited from class org.apache.flink.streaming.api.operators.python.embedded.AbstractEmbeddedDataStreamPythonFunctionOperator

addSideOutputTags, getJobParameters, getProducedType, getPythonFunctionInfo, getSideOutputTags, setNumPartitions

Methods inherited from class org.apache.flink.streaming.api.operators.python.embedded.AbstractEmbeddedPythonFunctionOperator

close, createPythonEnvironmentManager, invokeFinishBundle

Methods inherited from class org.apache.flink.streaming.api.operators.python.AbstractPythonFunctionOperator

checkInvokeFinishBundleByCount, finish, getConfiguration, getFlinkMetricContainer, isBundleFinished, prepareSnapshotPreBarrier, processWatermark, setCurrentKey

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, initializeState, isUsingCustomRawKeyedState, notifyCheckpointAborted, notifyCheckpointComplete, processLatencyMarker, processLatencyMarker1, processLatencyMarker2, processRecordAttributes, processRecordAttributes1, processRecordAttributes2, processWatermark1, processWatermark2, processWatermarkStatus, processWatermarkStatus1, processWatermarkStatus2, reportOrForwardLatencyMarker, setKeyContextElement1, setKeyContextElement2, setMailboxExecutor, setProcessingTimeService, setup, snapshotState, 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.Input

processLatencyMarker, processRecordAttributes, processWatermark, processWatermarkStatus

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.OneInputStreamOperator

setKeyContextElement

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

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

Constructor Detail

EmbeddedPythonKeyedProcessOperator

public EmbeddedPythonKeyedProcessOperator(Configuration config,
                                          DataStreamPythonFunctionInfo pythonFunctionInfo,
                                          TypeInformation<IN> inputTypeInfo,
                                          TypeInformation<OUT> outputTypeInfo)

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<K>

Overrides:

open in class AbstractOneInputEmbeddedPythonFunctionOperator<IN,OUT>

Throws:

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

createUserDefinedFunctionsProto

public List<FlinkFnApi.UserDefinedDataStreamFunction> createUserDefinedFunctionsProto()

Description copied from class: AbstractOneInputEmbeddedPythonFunctionOperator

Gets the proto representation of the Python user-defined functions to be executed.

Specified by:

createUserDefinedFunctionsProto in class AbstractOneInputEmbeddedPythonFunctionOperator<IN,OUT>

onEventTime

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

Description copied from interface: Triggerable

Invoked when an event-time timer fires.

Specified by:

onEventTime in interface Triggerable<K,IN>

Throws:

Exception

onProcessingTime

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

Description copied from interface: Triggerable

Invoked when a processing-time timer fires.

Specified by:

onProcessingTime in interface Triggerable<K,IN>

Throws:

Exception

getFunctionContext

public Object getFunctionContext()

Description copied from class: AbstractOneInputEmbeddedPythonFunctionOperator

Gets The function context.

Specified by:

getFunctionContext in class AbstractOneInputEmbeddedPythonFunctionOperator<IN,OUT>

getTimerContext

public Object getTimerContext()

Description copied from class: AbstractOneInputEmbeddedPythonFunctionOperator

Gets The Timer context.

Specified by:

getTimerContext in class AbstractOneInputEmbeddedPythonFunctionOperator<IN,OUT>

copy

public <T> AbstractEmbeddedDataStreamPythonFunctionOperator<T> copy(DataStreamPythonFunctionInfo pythonFunctionInfo,
                                                                    TypeInformation<T> outputTypeInfo)

Description copied from interface: DataStreamPythonFunctionOperator

Make a copy of the DataStreamPythonFunctionOperator with the given pythonFunctionInfo and outputTypeInfo. This is used for chaining optimization which may need to update the underlying pythonFunctionInfo and outputTypeInfo with the other fields not changed.

Specified by:

copy in interface DataStreamPythonFunctionOperator<K>