org.apache.flink.streaming.python.api.functions

Class PythonGeneratorFunction

java.lang.Object

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

org.apache.flink.streaming.python.api.functions.AbstractPythonUDF<org.apache.flink.streaming.api.functions.source.SourceFunction<Object>>

org.apache.flink.streaming.python.api.functions.PythonGeneratorFunction

All Implemented Interfaces:

Serializable, org.apache.flink.api.common.functions.Function, org.apache.flink.api.common.functions.RichFunction, org.apache.flink.streaming.api.functions.source.SourceFunction<Object>

public class PythonGeneratorFunction
extends AbstractPythonUDF<org.apache.flink.streaming.api.functions.source.SourceFunction<Object>>
implements org.apache.flink.streaming.api.functions.source.SourceFunction<Object>

The PythonGeneratorFunction is a thin wrapper layer over a Python UDF SourceFunction. It receives a SourceFunction as an input and keeps it internally in a serialized form. It is then delivered, as part of the job graph, up to the TaskManager, then it is opened and becomes a sort of mediator to the Python UDF SourceFunction.

This function is used internally by the Python thin wrapper layer over the streaming data functionality

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.flink.streaming.api.functions.source.SourceFunction

org.apache.flink.streaming.api.functions.source.SourceFunction.SourceContext<T>

Field Summary

Fields inherited from class org.apache.flink.streaming.python.api.functions.AbstractPythonUDF

fun, log

Constructor Summary

Constructors

Constructor and Description
PythonGeneratorFunction(org.apache.flink.streaming.api.functions.source.SourceFunction<Object> fun)

Method Summary

Modifier and Type	Method and Description
void	cancel()
void	run(org.apache.flink.streaming.api.functions.source.SourceFunction.SourceContext<Object> ctx)

Methods inherited from class org.apache.flink.streaming.python.api.functions.AbstractPythonUDF

close, open

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

getIterationRuntimeContext, getRuntimeContext, setRuntimeContext

Methods inherited from class java.lang.Object

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

Constructor Detail

PythonGeneratorFunction

public PythonGeneratorFunction(org.apache.flink.streaming.api.functions.source.SourceFunction<Object> fun)
                        throws IOException

Throws:

IOException

Method Detail

run

public void run(org.apache.flink.streaming.api.functions.source.SourceFunction.SourceContext<Object> ctx)
         throws Exception

Specified by:

run in interface org.apache.flink.streaming.api.functions.source.SourceFunction<Object>

Throws:

Exception

cancel

public void cancel()

Specified by:

cancel in interface org.apache.flink.streaming.api.functions.source.SourceFunction<Object>