Package org.apache.beam.sdk.extensions.python

Class PythonService

java.lang.Object

org.apache.beam.sdk.extensions.python.PythonService

public class PythonService
extends Object

Utility to bootstrap and start a Beam Python service.

Constructor Summary

Constructors

Constructor	Description
PythonService(String module, String... args)
PythonService(String module, List<String> args)
PythonService(String module, List<String> args, List<String> extraPackages)

Method Summary

Modifier and Type	Method	Description
static int	findAvailablePort()
AutoCloseable	start()
static void	waitForPort(String host, int port, int timeoutMs)
PythonService	withCustomBeamRequirement(String customBeamRequirement)	Override the Beam version to be installed in the service environment.
PythonService	withExtraPackages(List<String> extraPackages)	Specifies that the given Python packages should be installed for this service environment.

Methods inherited from class java.lang.Object

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

Constructor Details

PythonService

public PythonService(String module,
 List<String> args,
 List<String> extraPackages)

PythonService

public PythonService(String module,
 List<String> args)

PythonService

public PythonService(String module,
 String... args)

Method Details

withExtraPackages

public PythonService withExtraPackages(List<String> extraPackages)

Specifies that the given Python packages should be installed for this service environment.

Parameters:

extraPackages - a list of pip-installable package specifications, such as would be found in a requirements file.

Returns:

a Python Service object that will ensure these dependencies are available.

withCustomBeamRequirement

public PythonService withCustomBeamRequirement(String customBeamRequirement)

Override the Beam version to be installed in the service environment.

Parameters:

customBeamRequirement - the custom Beam requirement, can be a version (e.g. 2.57.0) or a path (e.g. /path/to/apache-beam.whl).

Returns:

this instance where Beam version overriden in place.

start

public AutoCloseable start()
                    throws IOException,
InterruptedException

Throws:

IOException

InterruptedException

findAvailablePort

public static int findAvailablePort()
                             throws IOException

Throws:

IOException

waitForPort

public static void waitForPort(String host,
 int port,
 int timeoutMs)
                        throws TimeoutException,
InterruptedException

Throws:

TimeoutException

InterruptedException