org.apache.flink.python.env

Interface PythonEnvironmentManager

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

ProcessPythonEnvironmentManager

@Internal
public interface PythonEnvironmentManager
extends AutoCloseable

The base interface of python environment manager which is used to create the Environment object and the RetrievalToken of Beam Fn API.

Method Summary

Modifier and Type	Method and Description
org.apache.beam.model.pipeline.v1.RunnerApi.Environment	createEnvironment() Creates the Environment object used in Apache Beam Fn API.
String	createRetrievalToken() Creates the RetrievalToken used in Apache Beam Fn API.
String	getBootLog() Returns the boot log of the Python Environment.
void	open() Initialize the environment manager.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

open

void open()
   throws Exception

Initialize the environment manager.

Throws:

Exception

createEnvironment

org.apache.beam.model.pipeline.v1.RunnerApi.Environment createEnvironment()
                                                                   throws Exception

Creates the Environment object used in Apache Beam Fn API.

Returns:

The Environment object which represents the environment(process, docker, etc) the python worker would run in.

Throws:

Exception

createRetrievalToken

String createRetrievalToken()
                     throws Exception

Creates the RetrievalToken used in Apache Beam Fn API. It contains a list of files which need to transmit through ArtifactService provided by Apache Beam.

Returns:

The path of the RetrievalToken file.

Throws:

Exception

getBootLog

String getBootLog()
           throws Exception

Returns the boot log of the Python Environment.

Throws:

Exception