com.spotify.helios.common.descriptors

Class Job

java.lang.Object

com.spotify.helios.common.descriptors.Descriptor

com.spotify.helios.common.descriptors.Job

All Implemented Interfaces:

Comparable<Job>

public class Job
extends Descriptor
implements Comparable<Job>

Represents a Helios job. An sample expression of it in JSON might be:

 {
   "command" : [ "server", "serverconfig.yaml" ],
   "env" : {
     "JVM_ARGS" : "-Ddw.feature.randomFeatureFlagEnabled=true"
   },
   "expires" : null,
   "id" : "myservice:0.5:3539b7bc2235d53f79e6e8511942bbeaa8816265",
   "image" : "myregistry:80/janedoe/myservice:0.5-98c6ff4",
   "ports" : {
     "http" : {
       "externalPort" : 8060,
       "internalPort" : 8080,
       "protocol" : "tcp"
     },
     "http-admin" : {
       "externalPort" : 8061,
       "internalPort" : 8081,
       "protocol" : "tcp"
     }
   },
   "registration" : {
     "service/http" : {
       "ports" : {
         "http" : { }
       }
     }
   },
   "registrationDomain" : "",
   "volumes" : {
     "/path/to/mysecretconfig.yaml:ro:ro" : "/path/to/mysecretconfig.yaml"
   }
 }
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Job.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static List<String>	EMPTY_COMMAND
static Map<String,String>	EMPTY_ENV
static Date	EMPTY_EXPIRES
static Integer	EMPTY_GRACE_PERIOD
static String	EMPTY_MOUNT
static Map<String,PortMapping>	EMPTY_PORTS
static Map<ServiceEndpoint,ServicePorts>	EMPTY_REGISTRATION
static String	EMPTY_REGISTRATION_DOMAIN
static Map<String,String>	EMPTY_VOLUMES

Constructor Summary

Constructors

Constructor and Description
Job(JobId id, String image, List<String> command, Map<String,String> env, Map<String,PortMapping> ports, Map<ServiceEndpoint,ServicePorts> registration, Integer gracePeriod, Map<String,String> volumes, Date expires, String registrationDomain) Create a Job.

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(Job o)
boolean	equals(Object o)
List<String>	getCommand()
Map<String,String>	getEnv()
Date	getExpires()
Integer	getGracePeriod()
JobId	getId()
String	getImage()
Map<String,PortMapping>	getPorts()
Map<ServiceEndpoint,ServicePorts>	getRegistration()
String	getRegistrationDomain()
Map<String,String>	getVolumes()
int	hashCode()
static Job.Builder	newBuilder()
Job.Builder	toBuilder()
String	toString()

Methods inherited from class com.spotify.helios.common.descriptors.Descriptor

parse, parse, toJsonBytes, toJsonString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

EMPTY_ENV

public static final Map<String,String> EMPTY_ENV

EMPTY_PORTS

public static final Map<String,PortMapping> EMPTY_PORTS

EMPTY_COMMAND

public static final List<String> EMPTY_COMMAND

EMPTY_REGISTRATION

public static final Map<ServiceEndpoint,ServicePorts> EMPTY_REGISTRATION

EMPTY_GRACE_PERIOD

public static final Integer EMPTY_GRACE_PERIOD

EMPTY_VOLUMES

public static final Map<String,String> EMPTY_VOLUMES

EMPTY_MOUNT

public static final String EMPTY_MOUNT

See Also:

Constant Field Values

EMPTY_EXPIRES

public static final Date EMPTY_EXPIRES

EMPTY_REGISTRATION_DOMAIN

public static final String EMPTY_REGISTRATION_DOMAIN

See Also:

Constant Field Values

Constructor Detail

Job

public Job(JobId id,
   String image,
   @Nullable
   List<String> command,
   @Nullable
   Map<String,String> env,
   @Nullable
   Map<String,PortMapping> ports,
   @Nullable
   Map<ServiceEndpoint,ServicePorts> registration,
   @Nullable
   Integer gracePeriod,
   @Nullable
   Map<String,String> volumes,
   @Nullable
   Date expires,
   @Nullable
   String registrationDomain)

Create a Job.

Parameters:

id - The id if the job.

image - The docker image to use.

command - The command to pass to the container.

env - Environment variables to set

ports - The ports you wish to expose from the container.

registration - Configuration information for the discovery service (if applicable)

gracePeriod - How long to let the container run after deregistering with the discovery service. If nothing is configured in registration, this option is ignored.

volumes - Docker volumes to mount.

expires - If set, a timestamp at which the job and any deployments will be removed.

registrationDomain - If set, override the default domain in which discovery service registration occurs. What is allowed here will vary based upon the discovery service plugin used.

Method Detail

getId

public JobId getId()

getImage

public String getImage()

getCommand

public List<String> getCommand()

getEnv

public Map<String,String> getEnv()

getPorts

public Map<String,PortMapping> getPorts()

getRegistration

public Map<ServiceEndpoint,ServicePorts> getRegistration()

getRegistrationDomain

public String getRegistrationDomain()

getGracePeriod

public Integer getGracePeriod()

getVolumes

public Map<String,String> getVolumes()

getExpires

public Date getExpires()

newBuilder

public static Job.Builder newBuilder()

compareTo

public int compareTo(Job o)

Specified by:

compareTo in interface Comparable<Job>

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

toBuilder

public Job.Builder toBuilder()