org.apache.beam.sdk.extensions.python

Class PythonService

java.lang.Object

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

public class PythonService
extends java.lang.Object

Utility to bootstrap and start a Beam Python service.

Constructor Summary

Constructors

Constructor and Description
PythonService(java.lang.String module, java.util.List<java.lang.String> args)
PythonService(java.lang.String module, java.util.List<java.lang.String> args, java.util.List<java.lang.String> extraPackages)
PythonService(java.lang.String module, java.lang.String... args)

Method Summary

Modifier and Type	Method and Description
static int	findAvailablePort()
java.lang.AutoCloseable	start()
static void	waitForPort(java.lang.String host, int port, int timeoutMs)
PythonService	withCustomBeamRequirement(java.lang.String customBeamRequirement) Override the Beam version to be installed in the service environment.
PythonService	withExtraPackages(java.util.List<java.lang.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 Detail

PythonService

public PythonService(java.lang.String module,
                     java.util.List<java.lang.String> args,
                     java.util.List<java.lang.String> extraPackages)

PythonService

public PythonService(java.lang.String module,
                     java.util.List<java.lang.String> args)

PythonService

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

Method Detail

withExtraPackages

public PythonService withExtraPackages(java.util.List<java.lang.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(java.lang.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 java.lang.AutoCloseable start()
                              throws java.io.IOException,
                                     java.lang.InterruptedException

Throws:

java.io.IOException

java.lang.InterruptedException

findAvailablePort

public static int findAvailablePort()
                             throws java.io.IOException

Throws:

java.io.IOException

waitForPort

public static void waitForPort(java.lang.String host,
                               int port,
                               int timeoutMs)
                        throws java.util.concurrent.TimeoutException,
                               java.lang.InterruptedException

Throws:

java.util.concurrent.TimeoutException

java.lang.InterruptedException