org.apache.flink.python

Interface PythonFunctionRunner<IN>

Type Parameters:

IN - Type of the input elements.

All Known Implementing Classes:

AbstractArrowPythonScalarFunctionRunner, AbstractGeneralPythonScalarFunctionRunner, AbstractPythonFunctionRunner, AbstractPythonScalarFunctionRunner, AbstractPythonStatelessFunctionRunner, AbstractPythonTableFunctionRunner, ArrowPythonScalarFunctionRunner, PythonScalarFunctionRunner, PythonTableFunctionRunner, RowDataArrowPythonScalarFunctionRunner, RowDataPythonScalarFunctionRunner, RowDataPythonTableFunctionRunner

@Internal
public interface PythonFunctionRunner<IN>

The base interface of runner which is responsible for the execution of Python functions.

Method Summary

Modifier and Type	Method and Description
void	close() Tear-down the Python function runner.
void	finishBundle() Forces to finish the processing of the current bundle of elements.
void	open() Prepares the Python function runner, such as preparing the Python execution environment, etc.
void	processElement(IN element) Executes the Python function with the input element.
void	startBundle() Prepares to process the next bundle of elements.

Method Detail

open

void open()
   throws Exception

Prepares the Python function runner, such as preparing the Python execution environment, etc.

Throws:

Exception

close

void close()
    throws Exception

Tear-down the Python function runner.

Throws:

Exception

startBundle

void startBundle()
          throws Exception

Prepares to process the next bundle of elements.

Throws:

Exception

finishBundle

void finishBundle()
           throws Exception

Forces to finish the processing of the current bundle of elements. It will flush the data cached in the data buffer for processing and retrieves the state mutations (if exists) made by the Python function. The call blocks until all of the outputs produced by this bundle have been received.

Throws:

Exception

processElement

void processElement(IN element)
             throws Exception

Executes the Python function with the input element. It's not required to execute the Python function immediately. The runner may choose to buffer the input element and execute them in batch for better performance.

Throws:

Exception