org.springframework.cloud.deployer.spi.task

Class TaskStatus

java.lang.Object

org.springframework.cloud.deployer.spi.task.TaskStatus

public class TaskStatus
extends Object

Status of a task launch which is initially constructed from an AppDeploymentRequest and runtime properties by a TaskLauncher.

Consumers of the SPI obtain task status via TaskLauncher.status(java.lang.String), whereas SPI implementations create instances of this class via TaskStatus(String, LaunchState, Map)

Author:

Patrick Peralta, Mark Fisher

Constructor Summary

Constructors

Constructor and Description
TaskStatus(String id, LaunchState state, Map<String,String> attributes) Construct a new TaskStatus.

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,String>	getAttributes() Return a map of attributes for the launched task.
LaunchState	getState() Return the state for the the task.
String	getTaskLaunchId() Return the task launch id for the task.
String	toString() Return a string representation of this status.

Methods inherited from class java.lang.Object

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

Constructor Detail

TaskStatus

public TaskStatus(String id,
          LaunchState state,
          Map<String,String> attributes)

Construct a new TaskStatus.

Parameters:

id - the id of the task launch this status is for

state - the LaunchState of the task

attributes - map of attributes for the task

Method Detail

getTaskLaunchId

public String getTaskLaunchId()

Return the task launch id for the task.

Returns:

task launch id

getState

public LaunchState getState()

Return the state for the the task.

Returns:

state for the task

toString

public String toString()

Return a string representation of this status.

Overrides:

toString in class Object

Returns:

string representation of this status

getAttributes

public Map<String,String> getAttributes()

Return a map of attributes for the launched task. The specific keys and values returned are dependent on the runtime where the task has been launched. This may include extra information such as execution location or specific error messages in the case of failure.

Returns:

map of attributes for the task