com.spotify.helios.testing

Class TemporaryJobBuilder

java.lang.Object

com.spotify.helios.testing.TemporaryJobBuilder

public class TemporaryJobBuilder
extends Object

Constructor Summary

Constructors

Constructor and Description
TemporaryJobBuilder(Deployer deployer, String jobNamePrefix, Prober defaultProber, Map<String,String> env, TemporaryJobReports.ReportWriter reportWriter, Job.Builder jobBuilder)

Method Summary

Modifier and Type	Method and Description
TemporaryJobBuilder	addCapabilities(Collection<String> capabilities)
TemporaryJobBuilder	command(List<String> command)
TemporaryJobBuilder	command(String... command)
TemporaryJob	deploy(List<String> hosts) Deploys the job to the specified hosts.
TemporaryJob	deploy(String... hosts) Deploys the job to the specified hosts.
TemporaryJobBuilder	disablePrivateRegistrationDomain()
TemporaryJobBuilder	env(String key, Object value)
TemporaryJobBuilder	expires(Date expires) The Helios master will undeploy and delete the job at the specified date, if it has not already been removed.
TemporaryJobBuilder	gracePeriod(Integer seconds)
TemporaryJobBuilder	healthCheck(HealthCheck healthCheck)
TemporaryJobBuilder	host(String host)
TemporaryJobBuilder	hostFilter(String hostFilter)
TemporaryJobBuilder	httpHealthCheck(String port, String path)
TemporaryJobBuilder	image(String image)
TemporaryJobBuilder	imageFromBuild() Set the image(String) field for the Docker image to use in this job from the output of docker-maven-plugin (image_info.json on classpath) or dockerfile-maven-plugin (docker/image-name on classpath)
TemporaryJobBuilder	imageFromInfoFile(File file)
TemporaryJobBuilder	imageFromInfoFile(Path path)
TemporaryJobBuilder	imageFromInfoFile(String path)
TemporaryJobBuilder	port(String name, int internalPort)
TemporaryJobBuilder	port(String name, int internalPort, boolean wait)
TemporaryJobBuilder	port(String name, int internalPort, Integer externalPort)
TemporaryJobBuilder	port(String name, int internalPort, Integer externalPort, boolean wait)
TemporaryJobBuilder	port(String name, int internalPort, Integer externalPort, String protocol)
TemporaryJobBuilder	port(String name, int internalPort, String protocol)
TemporaryJobBuilder	prober(Prober prober) This will override the default prober provided by TemporaryJobs to the constructor.
TemporaryJobBuilder	registration(Map<ServiceEndpoint,ServicePorts> registration)
TemporaryJobBuilder	registration(ServiceEndpoint endpoint, ServicePorts ports)
TemporaryJobBuilder	registration(String service, String protocol, String... ports)
TemporaryJobBuilder	registrationDomain(String domain)
TemporaryJobBuilder	tcpHealthCheck(String port)
TemporaryJobBuilder	version(String jobVersion)
TemporaryJobBuilder	volume(String path, String source)

Methods inherited from class java.lang.Object

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

Constructor Detail

TemporaryJobBuilder

public TemporaryJobBuilder(Deployer deployer,
                           String jobNamePrefix,
                           Prober defaultProber,
                           Map<String,String> env,
                           TemporaryJobReports.ReportWriter reportWriter,
                           Job.Builder jobBuilder)

Method Detail

version

public TemporaryJobBuilder version(String jobVersion)

image

public TemporaryJobBuilder image(String image)

registrationDomain

public TemporaryJobBuilder registrationDomain(String domain)

command

public TemporaryJobBuilder command(List<String> command)

command

public TemporaryJobBuilder command(String... command)

env

public TemporaryJobBuilder env(String key,
                               Object value)

disablePrivateRegistrationDomain

public TemporaryJobBuilder disablePrivateRegistrationDomain()

gracePeriod

public TemporaryJobBuilder gracePeriod(Integer seconds)

port

public TemporaryJobBuilder port(String name,
                                int internalPort)

port

public TemporaryJobBuilder port(String name,
                                int internalPort,
                                boolean wait)

port

public TemporaryJobBuilder port(String name,
                                int internalPort,
                                Integer externalPort)

port

public TemporaryJobBuilder port(String name,
                                int internalPort,
                                Integer externalPort,
                                boolean wait)

port

public TemporaryJobBuilder port(String name,
                                int internalPort,
                                String protocol)

port

public TemporaryJobBuilder port(String name,
                                int internalPort,
                                Integer externalPort,
                                String protocol)

registration

public TemporaryJobBuilder registration(ServiceEndpoint endpoint,
                                        ServicePorts ports)

registration

public TemporaryJobBuilder registration(String service,
                                        String protocol,
                                        String... ports)

registration

public TemporaryJobBuilder registration(Map<ServiceEndpoint,ServicePorts> registration)

volume

public TemporaryJobBuilder volume(String path,
                                  String source)

host

public TemporaryJobBuilder host(String host)

hostFilter

public TemporaryJobBuilder hostFilter(String hostFilter)

expires

public TemporaryJobBuilder expires(Date expires)

The Helios master will undeploy and delete the job at the specified date, if it has not already been removed. If not set, jobs will be removed after 30 minutes. This is for the case when a TemporaryJob is not cleaned up properly, perhaps because the process terminated prematurely.

Parameters:

expires - the Date when the job should be removed

Returns:

the TemporaryJobBuilder

prober

public TemporaryJobBuilder prober(Prober prober)

This will override the default prober provided by TemporaryJobs to the constructor.

Parameters:

prober - the prober to use for this job

Returns:

the TemporaryJobBuilder

healthCheck

public TemporaryJobBuilder healthCheck(HealthCheck healthCheck)

httpHealthCheck

public TemporaryJobBuilder httpHealthCheck(String port,
                                           String path)

tcpHealthCheck

public TemporaryJobBuilder tcpHealthCheck(String port)

addCapabilities

public TemporaryJobBuilder addCapabilities(Collection<String> capabilities)

deploy

public TemporaryJob deploy(String... hosts)

Deploys the job to the specified hosts. If no hosts are specified, a host will be chosen at random from the current Helios cluster. If the HELIOS_HOST_FILTER environment variable is set, it will be used to filter the list of hosts in the current Helios cluster.

Parameters:

hosts - the list of helios hosts to deploy to. A random host will be chosen if the list is empty.

Returns:

a TemporaryJob representing the deployed job

deploy

public TemporaryJob deploy(List<String> hosts)

Deploys the job to the specified hosts. If no hosts are specified, a host will be chosen at random from the current Helios cluster. If the HELIOS_HOST_FILTER environment variable is set, it will be used to filter the list of hosts in the current Helios cluster.

Parameters:

hosts - the list of helios hosts to deploy to. A random host will be chosen if the list is empty.

Returns:

a TemporaryJob representing the deployed job

imageFromBuild

public TemporaryJobBuilder imageFromBuild()

Set the image(String) field for the Docker image to use in this job from the output of docker-maven-plugin (image_info.json on classpath) or dockerfile-maven-plugin (docker/image-name on classpath)

imageFromInfoFile

public TemporaryJobBuilder imageFromInfoFile(Path path)

imageFromInfoFile

public TemporaryJobBuilder imageFromInfoFile(String path)

imageFromInfoFile

public TemporaryJobBuilder imageFromInfoFile(File file)