com.spotify.helios.common.descriptors

Class DeploymentGroup

java.lang.Object

com.spotify.helios.common.descriptors.Descriptor

com.spotify.helios.common.descriptors.DeploymentGroup

public class DeploymentGroup
extends Descriptor

Represents a Helios deployment group.

An sample expression of it in JSON might be:

 {
   "name":"foo-group",
   "jobId":"foo:0.1.0",
   "hostSelectors":[
     {
       "label":"foo",
       "operator":"EQUALS"
       "operand":"bar",
     },
     {
       "label":"baz",
       "operator":"EQUALS"
       "operand":"qux",
     }
   ],
   "rolloutOptions":{
     "migrate":false,
     "parallelism":2,
     "timeout":1000,
     "overlap":true,
     "token": "insecure-access-token"
   },
   "rollingUpdateReason": "MANUAL"
 }
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DeploymentGroup.Builder
static class	DeploymentGroup.RollingUpdateReason

Field Summary

Fields

Modifier and Type	Field and Description
static JobId	EMPTY_JOB_ID
static String	EMPTY_NAME

Constructor Summary

Constructors

Constructor and Description
DeploymentGroup(String name, List<HostSelector> hostSelectors, JobId jobId, RolloutOptions rolloutOptions, DeploymentGroup.RollingUpdateReason reason) Create a Job.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
List<HostSelector>	getHostSelectors()
JobId	getJobId()
String	getName()
DeploymentGroup.RollingUpdateReason	getRollingUpdateReason()
RolloutOptions	getRolloutOptions()
int	hashCode()
static DeploymentGroup.Builder	newBuilder()
DeploymentGroup.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_NAME

public static final String EMPTY_NAME

See Also:

Constant Field Values

EMPTY_JOB_ID

public static final JobId EMPTY_JOB_ID

Constructor Detail

DeploymentGroup

public DeploymentGroup(String name,
                       List<HostSelector> hostSelectors,
                       @Nullable
                       JobId jobId,
                       @Nullable
                       RolloutOptions rolloutOptions,
                       @Nullable
                       DeploymentGroup.RollingUpdateReason reason)

Create a Job.

Note that despite annotating jobId as @JsonProperty("job") in practice it's serialised as "jobId" because we neglected to annotate the getter to match. The annotation has been left here to ensure backwards compatibility.

Parameters:

name - The docker name to use.

jobId - The job ID for the deployment group.

hostSelectors - The selectors that determine which agents are part of the deployment group.

reason - The reason the most recent rolling update (if any) occurred.

Method Detail

getName

public String getName()

getJobId

public JobId getJobId()

getHostSelectors

public List<HostSelector> getHostSelectors()

getRolloutOptions

public RolloutOptions getRolloutOptions()

getRollingUpdateReason

public DeploymentGroup.RollingUpdateReason getRollingUpdateReason()

newBuilder

public static DeploymentGroup.Builder newBuilder()

equals

public boolean equals(Object obj)

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 DeploymentGroup.Builder toBuilder()