Package org.apache.beam.sdk.transformservice.launcher

Class TransformServiceLauncher

java.lang.Object

org.apache.beam.sdk.transformservice.launcher.TransformServiceLauncher

public class TransformServiceLauncher
extends Object

A utility that can be used to manage a Beam Transform Service.

Can be either used programatically or as an executable jar.

Method Summary

Modifier and Type	Method	Description
static TransformServiceLauncher	forProject(@Nullable String projectName, int port, @Nullable String pythonRequirementsFile)	Initializes a client for managing transform service instances.
static void	main(String[] args)
void	setBeamVersion(String beamVersion)	Specifies the Beam version to get containers for the transform service.
void	shutdown()
void	start()
void	status()
void	waitTillUp(int timeout)

Methods inherited from class java.lang.Object

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

Method Details

setBeamVersion

public void setBeamVersion(String beamVersion)

Specifies the Beam version to get containers for the transform service.

Could be a release Beam version with containers in Docker Hub or an unreleased Beam version for which containers are available locally.

Parameters:

beamVersion - a Beam version to get containers from.

forProject

public static TransformServiceLauncher forProject(@Nullable String projectName,
 int port,
 @Nullable String pythonRequirementsFile)
                                           throws IOException

Initializes a client for managing transform service instances.

Parameters:

projectName - project name for the transform service.

port - port exposed by the transform service.

pythonRequirementsFile - a requirements file with extra dependencies for the Python expansion services.

Returns:

an initialized client for managing the transform service.

Throws:

IOException

start

public void start()
           throws IOException,
TimeoutException

Throws:

IOException

TimeoutException

shutdown

public void shutdown()
              throws IOException

Throws:

IOException

status

public void status()
            throws IOException

Throws:

IOException

waitTillUp

public void waitTillUp(int timeout)
                throws IOException,
TimeoutException

Throws:

IOException

TimeoutException

main

public static void main(String[] args)
                 throws IOException,
TimeoutException

Throws:

IOException

TimeoutException