com.spotify.helios.common.descriptors

Class TaskStatus

java.lang.Object

com.spotify.helios.common.descriptors.Descriptor

com.spotify.helios.common.descriptors.TaskStatus

public class TaskStatus
extends Descriptor

The state of the deployed job (aka a task).

A typical JSON representation might be:

 {
   "containerId" : "e890d827e802934a29c97d7e9e3c96a55ca049e519ab0c28be8020621a0a3750",
   "env" : {
     "SYSLOG_HOST_PORT" : "10.99.0.1:514"
   },
   "goal" : "START",
   "job" : { #... see the definition of Job },
   "ports" : {
     "http" : {
       "externalPort" : 8080,
       "internalPort" : 8080,
       "protocol" : "tcp"
     },
     "http-admin" : {
       "externalPort" : 8081,
       "internalPort" : 8081,
       "protocol" : "tcp"
     }
   },
   "state" : "RUNNING",
   "throttled" : "NO",
   "containerError": "Something broke starting the container!"
 },
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TaskStatus.Builder
static class	TaskStatus.State

Constructor Summary

Constructors

Constructor and Description
TaskStatus(Job job, Goal goal, TaskStatus.State state, String containerId, ThrottleState throttled, Map<String,PortMapping> ports, Map<String,String> env, String containerError)

Method Summary

Modifier and Type	Method and Description
TaskStatus.Builder	asBuilder()
boolean	equals(Object obj)
String	getContainerError()
String	getContainerId()
Map<String,String>	getEnv()
Goal	getGoal()
Job	getJob()
Map<String,PortMapping>	getPorts()
TaskStatus.State	getState()
ThrottleState	getThrottled()
int	hashCode()
static TaskStatus.Builder	newBuilder()
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

Constructor Detail

TaskStatus

public TaskStatus(Job job,
                  @Nullable
                  Goal goal,
                  TaskStatus.State state,
                  @Nullable
                  String containerId,
                  ThrottleState throttled,
                  Map<String,PortMapping> ports,
                  @Nullable
                  Map<String,String> env,
                  @Nullable
                  String containerError)

Parameters:

job - The job the task is running.

goal - The desired state of the task.

state - The state of the task.

containerId - The containerId, if the task has one (yet).

throttled - The throttle state of the task.

ports - The ports actually assigned to the task.

env - The environment passed to the container.

containerError - The last Docker error encountered while starting the container.

Method Detail

asBuilder

public TaskStatus.Builder asBuilder()

getThrottled

public ThrottleState getThrottled()

getContainerId

@Nullable
public String getContainerId()

getGoal

public Goal getGoal()

getState

public TaskStatus.State getState()

getJob

public Job getJob()

getPorts

public Map<String,PortMapping> getPorts()

getEnv

public Map<String,String> getEnv()

getContainerError

public String getContainerError()

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

newBuilder

public static TaskStatus.Builder newBuilder()