com.spotify.helios.common.descriptors

Class Deployment

java.lang.Object

com.spotify.helios.common.descriptors.Descriptor

com.spotify.helios.common.descriptors.Deployment

public class Deployment
extends Descriptor

Basically, a pair of JobId and Goal. This is different than Task which has a Job and not a JobId. A typical JSON representation might be:

 {
   "job": "myservice:0.5:3539b7bc2235d53f79e6e8511942bbeaa8816265",
   "goal": "START",
 }
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Deployment.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static String	EMPTY_DEPLOYER_MASTER
static String	EMPTY_DEPLOYMENT_GROUP_NAME
static String	EMTPY_DEPLOYER_USER

Constructor Summary

Constructors

Constructor and Description
Deployment(JobId jobId, Goal goal, String deployerUser, String deployerMaster, String deploymentGroupName) Constructor

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getDeployerMaster()
String	getDeployerUser()
String	getDeploymentGroupName()
Goal	getGoal()
JobId	getJobId()
int	hashCode()
static Deployment.Builder	newBuilder()
static Deployment	of(JobId jobId, Goal goal)
static Deployment	of(JobId jobId, Goal goal, String deployerUser)
static Deployment	of(JobId jobId, Goal goal, String deployerUser, String deployerMaster, String deploymentGroupName)
Deployment.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

EMTPY_DEPLOYER_USER

public static final String EMTPY_DEPLOYER_USER

EMPTY_DEPLOYER_MASTER

public static final String EMPTY_DEPLOYER_MASTER

EMPTY_DEPLOYMENT_GROUP_NAME

public static final String EMPTY_DEPLOYMENT_GROUP_NAME

Constructor Detail

Deployment

public Deployment(JobId jobId,
                  Goal goal,
                  @Nullable
                  String deployerUser,
                  @Nullable
                  String deployerMaster,
                  @Nullable
                  String deploymentGroupName)

Constructor

Parameters:

jobId - The id of the job.

goal - The desired state (i.e. goal) of the task/deployment.

deployerUser - The user doing the deployment.

deployerMaster - The master that created this deployment.

deploymentGroupName - The deployment group this deployment is created by.

Method Detail

of

public static Deployment of(JobId jobId,
                            Goal goal)

of

public static Deployment of(JobId jobId,
                            Goal goal,
                            String deployerUser)

of

public static Deployment of(JobId jobId,
                            Goal goal,
                            String deployerUser,
                            String deployerMaster,
                            String deploymentGroupName)

getJobId

public JobId getJobId()

getGoal

public Goal getGoal()

getDeployerUser

public String getDeployerUser()

getDeploymentGroupName

public String getDeploymentGroupName()

getDeployerMaster

public String getDeployerMaster()

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toBuilder

public Deployment.Builder toBuilder()

newBuilder

public static Deployment.Builder newBuilder()