HeliosSoloDeployment.Builder (Helios Testing Library 0.9.46 API)

java.lang.Object
- com.spotify.helios.testing.HeliosSoloDeployment.Builder

Enclosing class:: HeliosSoloDeployment

public static class HeliosSoloDeployment.Builder
extends Object

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HeliosSoloDeployment`	`build()` Configures, deploys, and returns a `HeliosSoloDeployment` using the as specified by this Builder.
`HeliosSoloDeployment.Builder`	`checkForNewImages(boolean enabled)` By default, the `heliosSoloImage` will be checked for updates before creating a container by doing a "docker pull".
`HeliosSoloDeployment.Builder`	`containerDockerHost(com.spotify.docker.client.DockerHost containerDockerHost)` Optionally specify a DockerHost (i.e.
`HeliosSoloDeployment.Builder`	`dockerClient(com.spotify.docker.client.DockerClient dockerClient)` Specify a Docker client to be used for this Helios Solo deployment.
`HeliosSoloDeployment.Builder`	`dockerHost(com.spotify.docker.client.DockerHost dockerHost)` Optionally specify a DockerHost (i.e.
`HeliosSoloDeployment.Builder`	`env(String key, Object value)` Optionally specify an environment variable to be set inside the Helios solo container.
`HeliosSoloDeployment.Builder`	`heliosClient(HeliosClient heliosClient)` Optionally specify a `HeliosClient`.
`HeliosSoloDeployment.Builder`	`heliosSoloImage(String image)` Customize the image used for helios-solo.
`HeliosSoloDeployment.Builder`	`heliosUsername(String username)` Optionally specify the username to be used by the `HeliosClient` connected to the `HeliosSoloDeployment` created with this Builder.
`HeliosSoloDeployment.Builder`	`jobUndeployWaitSeconds(int seconds)` Set the number of seconds Helios solo will wait for jobs to be undeployed and, as a result, their associated Docker containers to stop running before shutting itself down.
`HeliosSoloDeployment.Builder`	`logStreamProvider(LogStreamFollower logStreamFollower)` Optionally provide a custom `LogStreamFollower` that provides streams for writing container stdout/stderr logs.
`HeliosSoloDeployment.Builder`	`namespace(String namespace)` Optionally specify a unique namespace for the Helios solo agent and Docker container names.
`HeliosSoloDeployment.Builder`	`removeHeliosSoloOnExit(boolean enabled)` By default the container running helios-solo is removed when `HeliosSoloDeployment.close()` is called.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - checkForNewImages
```
public HeliosSoloDeployment.Builder checkForNewImages(boolean enabled)
```
    By default, the heliosSoloImage will be checked for updates before creating a container by doing a "docker pull". Call this method with "false" to disable this behavior.
  - removeHeliosSoloOnExit
```
public HeliosSoloDeployment.Builder removeHeliosSoloOnExit(boolean enabled)
```
    By default the container running helios-solo is removed when HeliosSoloDeployment.close() is called. Call this method with "false" to disable this (which is probably only useful for developing helios-solo or this class itself and inspecting logs).
  - jobUndeployWaitSeconds
```
public HeliosSoloDeployment.Builder jobUndeployWaitSeconds(int seconds)
```
    Set the number of seconds Helios solo will wait for jobs to be undeployed and, as a result, their associated Docker containers to stop running before shutting itself down. The default is 30 seconds.
  - dockerClient
```
public HeliosSoloDeployment.Builder dockerClient(com.spotify.docker.client.DockerClient dockerClient)
```
    Specify a Docker client to be used for this Helios Solo deployment. A Docker client is necessary in order to deploy Helios Solo.
    
    Parameters:
    
    dockerClient - A client connected to the Docker instance in which to deploy Helios Solo.
    
    Returns:
    
    This Builder, with its Docker client configured.
  - dockerHost
```
public HeliosSoloDeployment.Builder dockerHost(com.spotify.docker.client.DockerHost dockerHost)
```
    Optionally specify a DockerHost (i.e. Docker socket and certificate info) to connect to Docker from the host OS. If unset the DOCKER_HOST and DOCKER_CERT_PATH environment variables will be used. If said variables are not present sensible defaults will be used.
    
    Parameters:
    
    dockerHost - Docker socket and certificate settings for the host OS.
    
    Returns:
    
    This Builder, with its Docker host configured.
  - containerDockerHost
```
public HeliosSoloDeployment.Builder containerDockerHost(com.spotify.docker.client.DockerHost containerDockerHost)
```
    Optionally specify a DockerHost (i.e. Docker socket and certificate info) to connect to Docker from inside the Helios container. If unset sensible defaults will be derived from the DOCKER_HOST and DOCKER_CERT_PATH environment variables and the Docker daemon's configuration.
    
    Parameters:
    
    containerDockerHost - Docker socket and certificate settings as seen from inside the Helios container.
    
    Returns:
    
    This Builder, with its container Docker host configured.
  - heliosClient
```
public HeliosSoloDeployment.Builder heliosClient(HeliosClient heliosClient)
```
    Optionally specify a HeliosClient. Used for unit tests.
    
    Parameters:
    
    heliosClient - HeliosClient
    
    Returns:
    
    This Builder, with its HeliosClient configured.
  - heliosSoloImage
```
public HeliosSoloDeployment.Builder heliosSoloImage(String image)
```
    Customize the image used for helios-solo. If not set defaults to "spotify/helios-solo:latest".
  - namespace
```
public HeliosSoloDeployment.Builder namespace(String namespace)
```
    Optionally specify a unique namespace for the Helios solo agent and Docker container names. If unset a random string will be used.
    
    Parameters:
    
    namespace - A unique namespace for the Helios solo agent and Docker container.
    
    Returns:
    
    This Builder, with its namespace configured.
  - heliosUsername
```
public HeliosSoloDeployment.Builder heliosUsername(String username)
```
    Optionally specify the username to be used by the HeliosClient connected to the HeliosSoloDeployment created with this Builder. If unset a random string will be used.
    
    Parameters:
    
    username - The Helios user to identify as.
    
    Returns:
    
    This Builder, with its Helios username configured.
  - logStreamProvider
```
public HeliosSoloDeployment.Builder logStreamProvider(LogStreamFollower logStreamFollower)
```
    Optionally provide a custom LogStreamFollower that provides streams for writing container stdout/stderr logs. If set to null, logging of container stdout/stderr will be disabled.
    
    Parameters:
    
    logStreamFollower - The provider to use.
    
    Returns:
    
    This Builder, with its log stream provider configured.
  - env
```
public HeliosSoloDeployment.Builder env(String key,
                                        Object value)
```
    Optionally specify an environment variable to be set inside the Helios solo container.
    
    Parameters:
    
    key - Environment variable to set.
    
    value - Environment variable value.
    
    Returns:
    
    This Builder, with the environment variable configured.
  - build
```
public HeliosSoloDeployment build()
```
    Configures, deploys, and returns a HeliosSoloDeployment using the as specified by this Builder.
    
    Returns:
    
    A Helios Solo deployment configured by this Builder.

Class HeliosSoloDeployment.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

checkForNewImages

removeHeliosSoloOnExit

jobUndeployWaitSeconds

dockerClient

dockerHost

containerDockerHost

heliosClient

heliosSoloImage

namespace

heliosUsername

logStreamProvider

env

build