com.amazonaws.services.ecs.model

Class Task

java.lang.Object

com.amazonaws.services.ecs.model.Task

All Implemented Interfaces:

Serializable, Cloneable

public class Task
extends Object
implements Serializable, Cloneable

Details on a task in a cluster.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Task()

Method Summary

Methods

Modifier and Type	Method and Description
Task	clone()
boolean	equals(Object obj)
String	getClusterArn() The Amazon Resource Name (ARN) of the of the cluster that hosts the task.
String	getContainerInstanceArn() The Amazon Resource Name (ARN) of the container instances that host the task.
List<Container>	getContainers() The containers associated with the task.
String	getDesiredStatus() The desired status of the task.
String	getLastStatus() The last known status of the task.
TaskOverride	getOverrides() One or more container overrides.
String	getStartedBy() The tag specified when a task is started.
String	getTaskArn() The Amazon Resource Name (ARN) of the task.
String	getTaskDefinitionArn() The Amazon Resource Name (ARN) of the of the task definition that creates the task.
int	hashCode()
void	setClusterArn(String clusterArn) The Amazon Resource Name (ARN) of the of the cluster that hosts the task.
void	setContainerInstanceArn(String containerInstanceArn) The Amazon Resource Name (ARN) of the container instances that host the task.
void	setContainers(Collection<Container> containers) The containers associated with the task.
void	setDesiredStatus(String desiredStatus) The desired status of the task.
void	setLastStatus(String lastStatus) The last known status of the task.
void	setOverrides(TaskOverride overrides) One or more container overrides.
void	setStartedBy(String startedBy) The tag specified when a task is started.
void	setTaskArn(String taskArn) The Amazon Resource Name (ARN) of the task.
void	setTaskDefinitionArn(String taskDefinitionArn) The Amazon Resource Name (ARN) of the of the task definition that creates the task.
String	toString() Returns a string representation of this object; useful for testing and debugging.
Task	withClusterArn(String clusterArn) The Amazon Resource Name (ARN) of the of the cluster that hosts the task.
Task	withContainerInstanceArn(String containerInstanceArn) The Amazon Resource Name (ARN) of the container instances that host the task.
Task	withContainers(Collection<Container> containers) The containers associated with the task.
Task	withContainers(Container... containers) The containers associated with the task.
Task	withDesiredStatus(String desiredStatus) The desired status of the task.
Task	withLastStatus(String lastStatus) The last known status of the task.
Task	withOverrides(TaskOverride overrides) One or more container overrides.
Task	withStartedBy(String startedBy) The tag specified when a task is started.
Task	withTaskArn(String taskArn) The Amazon Resource Name (ARN) of the task.
Task	withTaskDefinitionArn(String taskDefinitionArn) The Amazon Resource Name (ARN) of the of the task definition that creates the task.

Methods inherited from class java.lang.Object

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

Constructor Detail

Task

public Task()

Method Detail

getTaskArn

public String getTaskArn()

The Amazon Resource Name (ARN) of the task.

Returns:

The Amazon Resource Name (ARN) of the task.

setTaskArn

public void setTaskArn(String taskArn)

The Amazon Resource Name (ARN) of the task.

Parameters:

taskArn - The Amazon Resource Name (ARN) of the task.

withTaskArn

public Task withTaskArn(String taskArn)

The Amazon Resource Name (ARN) of the task.

Returns a reference to this object so that method calls can be chained together.

Parameters:

taskArn - The Amazon Resource Name (ARN) of the task.

Returns:

A reference to this updated object so that method calls can be chained together.

getClusterArn

public String getClusterArn()

The Amazon Resource Name (ARN) of the of the cluster that hosts the task.

Returns:

The Amazon Resource Name (ARN) of the of the cluster that hosts the task.

setClusterArn

public void setClusterArn(String clusterArn)

The Amazon Resource Name (ARN) of the of the cluster that hosts the task.

Parameters:

clusterArn - The Amazon Resource Name (ARN) of the of the cluster that hosts the task.

withClusterArn

public Task withClusterArn(String clusterArn)

The Amazon Resource Name (ARN) of the of the cluster that hosts the task.

Returns a reference to this object so that method calls can be chained together.

Parameters:

clusterArn - The Amazon Resource Name (ARN) of the of the cluster that hosts the task.

Returns:

A reference to this updated object so that method calls can be chained together.

getTaskDefinitionArn

public String getTaskDefinitionArn()

The Amazon Resource Name (ARN) of the of the task definition that creates the task.

Returns:

The Amazon Resource Name (ARN) of the of the task definition that creates the task.

setTaskDefinitionArn

public void setTaskDefinitionArn(String taskDefinitionArn)

The Amazon Resource Name (ARN) of the of the task definition that creates the task.

Parameters:

taskDefinitionArn - The Amazon Resource Name (ARN) of the of the task definition that creates the task.

withTaskDefinitionArn

public Task withTaskDefinitionArn(String taskDefinitionArn)

The Amazon Resource Name (ARN) of the of the task definition that creates the task.

Returns a reference to this object so that method calls can be chained together.

Parameters:

taskDefinitionArn - The Amazon Resource Name (ARN) of the of the task definition that creates the task.

Returns:

A reference to this updated object so that method calls can be chained together.

getContainerInstanceArn

public String getContainerInstanceArn()

The Amazon Resource Name (ARN) of the container instances that host the task.

Returns:

The Amazon Resource Name (ARN) of the container instances that host the task.

setContainerInstanceArn

public void setContainerInstanceArn(String containerInstanceArn)

The Amazon Resource Name (ARN) of the container instances that host the task.

Parameters:

containerInstanceArn - The Amazon Resource Name (ARN) of the container instances that host the task.

withContainerInstanceArn

public Task withContainerInstanceArn(String containerInstanceArn)

The Amazon Resource Name (ARN) of the container instances that host the task.

Returns a reference to this object so that method calls can be chained together.

Parameters:

containerInstanceArn - The Amazon Resource Name (ARN) of the container instances that host the task.

Returns:

A reference to this updated object so that method calls can be chained together.

getOverrides

public TaskOverride getOverrides()

One or more container overrides.

Returns:

One or more container overrides.

setOverrides

public void setOverrides(TaskOverride overrides)

One or more container overrides.

Parameters:

overrides - One or more container overrides.

withOverrides

public Task withOverrides(TaskOverride overrides)

One or more container overrides.

Returns a reference to this object so that method calls can be chained together.

Parameters:

overrides - One or more container overrides.

Returns:

A reference to this updated object so that method calls can be chained together.

getLastStatus

public String getLastStatus()

The last known status of the task.

Returns:

The last known status of the task.

setLastStatus

public void setLastStatus(String lastStatus)

The last known status of the task.

Parameters:

lastStatus - The last known status of the task.

withLastStatus

public Task withLastStatus(String lastStatus)

The last known status of the task.

Returns a reference to this object so that method calls can be chained together.

Parameters:

lastStatus - The last known status of the task.

Returns:

A reference to this updated object so that method calls can be chained together.

getDesiredStatus

public String getDesiredStatus()

The desired status of the task.

Returns:

The desired status of the task.

setDesiredStatus

public void setDesiredStatus(String desiredStatus)

The desired status of the task.

Parameters:

desiredStatus - The desired status of the task.

withDesiredStatus

public Task withDesiredStatus(String desiredStatus)

The desired status of the task.

Returns a reference to this object so that method calls can be chained together.

Parameters:

desiredStatus - The desired status of the task.

Returns:

A reference to this updated object so that method calls can be chained together.

getContainers

public List<Container> getContainers()

The containers associated with the task.

Returns:

The containers associated with the task.

setContainers

public void setContainers(Collection<Container> containers)

The containers associated with the task.

Parameters:

containers - The containers associated with the task.

withContainers

public Task withContainers(Container... containers)

The containers associated with the task.

NOTE: This method appends the values to the existing list (if any). Use setContainers(java.util.Collection) or withContainers(java.util.Collection) if you want to override the existing values.

Returns a reference to this object so that method calls can be chained together.

Parameters:

containers - The containers associated with the task.

Returns:

A reference to this updated object so that method calls can be chained together.

withContainers

public Task withContainers(Collection<Container> containers)

The containers associated with the task.

Returns a reference to this object so that method calls can be chained together.

Parameters:

containers - The containers associated with the task.

Returns:

A reference to this updated object so that method calls can be chained together.

getStartedBy

public String getStartedBy()

The tag specified when a task is started. If the task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.

Returns:

The tag specified when a task is started. If the task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.

setStartedBy

public void setStartedBy(String startedBy)

The tag specified when a task is started. If the task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.

Parameters:

startedBy - The tag specified when a task is started. If the task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.

withStartedBy

public Task withStartedBy(String startedBy)

The tag specified when a task is started. If the task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.

Returns a reference to this object so that method calls can be chained together.

Parameters:

startedBy - The tag specified when a task is started. If the task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public Task clone()

Overrides:

clone in class Object