Task (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.ecs.model.Task

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Task
extends Object
implements Serializable, Cloneable, StructuredPojo

Details on a task in a cluster.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Task()

Constructors
Constructor and Description
`Task()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Task`	`clone()`
`boolean`	`equals(Object obj)`
`List<Attachment>`	`getAttachments()` The Elastic Network Adapter associated with the task if the task uses the `awsvpc` network mode.
`String`	`getClusterArn()` The ARN of the cluster that hosts the task.
`String`	`getConnectivity()` The connectivity status of a task.
`Date`	`getConnectivityAt()` The Unix time stamp for when the task last went into `CONNECTED` status.
`String`	`getContainerInstanceArn()` The ARN of the container instances that host the task.
`List<Container>`	`getContainers()` The containers associated with the task.
`String`	`getCpu()` The number of `cpu` units used by the task.
`Date`	`getCreatedAt()` The Unix time stamp for when the task was created (the task entered the `PENDING` state).
`String`	`getDesiredStatus()` The desired status of the task.
`Date`	`getExecutionStoppedAt()` The Unix timestamp for when the task execution stopped.
`String`	`getGroup()` The name of the task group associated with the task.
`String`	`getLastStatus()` The last known status of the task.
`String`	`getLaunchType()` The launch type on which your task is running.
`String`	`getMemory()` The amount (in MiB) of memory used by the task.
`TaskOverride`	`getOverrides()` One or more container overrides.
`String`	`getPlatformVersion()` The platform version on which your task is running.
`Date`	`getPullStartedAt()` The Unix time stamp for when the container image pull began.
`Date`	`getPullStoppedAt()` The Unix time stamp for when the container image pull completed.
`Date`	`getStartedAt()` The Unix time stamp for when the task started (the task transitioned from the `PENDING` state to the `RUNNING` state).
`String`	`getStartedBy()` The tag specified when a task is started.
`Date`	`getStoppedAt()` The Unix time stamp for when the task was stopped (the task transitioned from the `RUNNING` state to the `STOPPED` state).
`String`	`getStoppedReason()` The reason the task was stopped.
`Date`	`getStoppingAt()` The Unix time stamp for when the task will stop (the task transitioned from the `RUNNING` state to the `STOPPED` state).
`String`	`getTaskArn()` The Amazon Resource Name (ARN) of the task.
`String`	`getTaskDefinitionArn()` The ARN of the task definition that creates the task.
`Long`	`getVersion()` The version counter for the task.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAttachments(Collection<Attachment> attachments)` The Elastic Network Adapter associated with the task if the task uses the `awsvpc` network mode.
`void`	`setClusterArn(String clusterArn)` The ARN of the cluster that hosts the task.
`void`	`setConnectivity(String connectivity)` The connectivity status of a task.
`void`	`setConnectivityAt(Date connectivityAt)` The Unix time stamp for when the task last went into `CONNECTED` status.
`void`	`setContainerInstanceArn(String containerInstanceArn)` The ARN of the container instances that host the task.
`void`	`setContainers(Collection<Container> containers)` The containers associated with the task.
`void`	`setCpu(String cpu)` The number of `cpu` units used by the task.
`void`	`setCreatedAt(Date createdAt)` The Unix time stamp for when the task was created (the task entered the `PENDING` state).
`void`	`setDesiredStatus(String desiredStatus)` The desired status of the task.
`void`	`setExecutionStoppedAt(Date executionStoppedAt)` The Unix timestamp for when the task execution stopped.
`void`	`setGroup(String group)` The name of the task group associated with the task.
`void`	`setLastStatus(String lastStatus)` The last known status of the task.
`void`	`setLaunchType(String launchType)` The launch type on which your task is running.
`void`	`setMemory(String memory)` The amount (in MiB) of memory used by the task.
`void`	`setOverrides(TaskOverride overrides)` One or more container overrides.
`void`	`setPlatformVersion(String platformVersion)` The platform version on which your task is running.
`void`	`setPullStartedAt(Date pullStartedAt)` The Unix time stamp for when the container image pull began.
`void`	`setPullStoppedAt(Date pullStoppedAt)` The Unix time stamp for when the container image pull completed.
`void`	`setStartedAt(Date startedAt)` The Unix time stamp for when the task started (the task transitioned from the `PENDING` state to the `RUNNING` state).
`void`	`setStartedBy(String startedBy)` The tag specified when a task is started.
`void`	`setStoppedAt(Date stoppedAt)` The Unix time stamp for when the task was stopped (the task transitioned from the `RUNNING` state to the `STOPPED` state).
`void`	`setStoppedReason(String stoppedReason)` The reason the task was stopped.
`void`	`setStoppingAt(Date stoppingAt)` The Unix time stamp for when the task will stop (the task transitioned from the `RUNNING` state to the `STOPPED` state).
`void`	`setTaskArn(String taskArn)` The Amazon Resource Name (ARN) of the task.
`void`	`setTaskDefinitionArn(String taskDefinitionArn)` The ARN of the task definition that creates the task.
`void`	`setVersion(Long version)` The version counter for the task.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`Task`	`withAttachments(Attachment... attachments)` The Elastic Network Adapter associated with the task if the task uses the `awsvpc` network mode.
`Task`	`withAttachments(Collection<Attachment> attachments)` The Elastic Network Adapter associated with the task if the task uses the `awsvpc` network mode.
`Task`	`withClusterArn(String clusterArn)` The ARN of the cluster that hosts the task.
`Task`	`withConnectivity(Connectivity connectivity)` The connectivity status of a task.
`Task`	`withConnectivity(String connectivity)` The connectivity status of a task.
`Task`	`withConnectivityAt(Date connectivityAt)` The Unix time stamp for when the task last went into `CONNECTED` status.
`Task`	`withContainerInstanceArn(String containerInstanceArn)` The 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`	`withCpu(String cpu)` The number of `cpu` units used by the task.
`Task`	`withCreatedAt(Date createdAt)` The Unix time stamp for when the task was created (the task entered the `PENDING` state).
`Task`	`withDesiredStatus(String desiredStatus)` The desired status of the task.
`Task`	`withExecutionStoppedAt(Date executionStoppedAt)` The Unix timestamp for when the task execution stopped.
`Task`	`withGroup(String group)` The name of the task group associated with the task.
`Task`	`withLastStatus(String lastStatus)` The last known status of the task.
`Task`	`withLaunchType(LaunchType launchType)` The launch type on which your task is running.
`Task`	`withLaunchType(String launchType)` The launch type on which your task is running.
`Task`	`withMemory(String memory)` The amount (in MiB) of memory used by the task.
`Task`	`withOverrides(TaskOverride overrides)` One or more container overrides.
`Task`	`withPlatformVersion(String platformVersion)` The platform version on which your task is running.
`Task`	`withPullStartedAt(Date pullStartedAt)` The Unix time stamp for when the container image pull began.
`Task`	`withPullStoppedAt(Date pullStoppedAt)` The Unix time stamp for when the container image pull completed.
`Task`	`withStartedAt(Date startedAt)` The Unix time stamp for when the task started (the task transitioned from the `PENDING` state to the `RUNNING` state).
`Task`	`withStartedBy(String startedBy)` The tag specified when a task is started.
`Task`	`withStoppedAt(Date stoppedAt)` The Unix time stamp for when the task was stopped (the task transitioned from the `RUNNING` state to the `STOPPED` state).
`Task`	`withStoppedReason(String stoppedReason)` The reason the task was stopped.
`Task`	`withStoppingAt(Date stoppingAt)` The Unix time stamp for when the task will stop (the task transitioned from the `RUNNING` state to the `STOPPED` state).
`Task`	`withTaskArn(String taskArn)` The Amazon Resource Name (ARN) of the task.
`Task`	`withTaskDefinitionArn(String taskDefinitionArn)` The ARN of the task definition that creates the task.
`Task`	`withVersion(Long version)` The version counter for the task.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Task
```
public Task()
```
- Method Detail
  - setTaskArn
```
public void setTaskArn(String taskArn)
```
    The Amazon Resource Name (ARN) of the task.
    
    Parameters:
    
    taskArn - The Amazon Resource Name (ARN) of the task.
  - getTaskArn
```
public String getTaskArn()
```
    The Amazon Resource Name (ARN) of the task.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the task.
  - withTaskArn
```
public Task withTaskArn(String taskArn)
```
    The Amazon Resource Name (ARN) of the task.
    
    Parameters:
    
    taskArn - The Amazon Resource Name (ARN) of the task.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setClusterArn
```
public void setClusterArn(String clusterArn)
```
    The ARN of the cluster that hosts the task.
    
    Parameters:
    
    clusterArn - The ARN of the cluster that hosts the task.
  - getClusterArn
```
public String getClusterArn()
```
    The ARN of the cluster that hosts the task.
    
    Returns:
    
    The ARN of the cluster that hosts the task.
  - withClusterArn
```
public Task withClusterArn(String clusterArn)
```
    The ARN of the cluster that hosts the task.
    
    Parameters:
    
    clusterArn - The ARN of the cluster that hosts the task.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTaskDefinitionArn
```
public void setTaskDefinitionArn(String taskDefinitionArn)
```
    The ARN of the task definition that creates the task.
    
    Parameters:
    
    taskDefinitionArn - The ARN of the task definition that creates the task.
  - getTaskDefinitionArn
```
public String getTaskDefinitionArn()
```
    The ARN of the task definition that creates the task.
    
    Returns:
    
    The ARN of the task definition that creates the task.
  - withTaskDefinitionArn
```
public Task withTaskDefinitionArn(String taskDefinitionArn)
```
    The ARN of the task definition that creates the task.
    
    Parameters:
    
    taskDefinitionArn - The ARN of the task definition that creates the task.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setContainerInstanceArn
```
public void setContainerInstanceArn(String containerInstanceArn)
```
    The ARN of the container instances that host the task.
    
    Parameters:
    
    containerInstanceArn - The ARN of the container instances that host the task.
  - getContainerInstanceArn
```
public String getContainerInstanceArn()
```
    The ARN of the container instances that host the task.
    
    Returns:
    
    The ARN of the container instances that host the task.
  - withContainerInstanceArn
```
public Task withContainerInstanceArn(String containerInstanceArn)
```
    The ARN of the container instances that host the task.
    
    Parameters:
    
    containerInstanceArn - The ARN of the container instances that host the task.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOverrides
```
public void setOverrides(TaskOverride overrides)
```
    One or more container overrides.
    
    Parameters:
    
    overrides - One or more container overrides.
  - getOverrides
```
public TaskOverride getOverrides()
```
    One or more container overrides.
    
    Returns:
    
    One or more container overrides.
  - withOverrides
```
public Task withOverrides(TaskOverride overrides)
```
    One or more container overrides.
    
    Parameters:
    
    overrides - One or more container overrides.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastStatus
```
public void setLastStatus(String lastStatus)
```
    The last known status of the task.
    
    Parameters:
    
    lastStatus - The last known status of the task.
  - getLastStatus
```
public String getLastStatus()
```
    The last known status of the task.
    
    Returns:
    
    The last known status of the task.
  - withLastStatus
```
public Task withLastStatus(String lastStatus)
```
    The last known status of the task.
    
    Parameters:
    
    lastStatus - The last known status of the task.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDesiredStatus
```
public void setDesiredStatus(String desiredStatus)
```
    The desired status of the task.
    
    Parameters:
    
    desiredStatus - The desired status of the task.
  - getDesiredStatus
```
public String getDesiredStatus()
```
    The desired status of the task.
    
    Returns:
    
    The desired status of the task.
  - withDesiredStatus
```
public Task withDesiredStatus(String desiredStatus)
```
    The desired status of the task.
    
    Parameters:
    
    desiredStatus - The desired status of the task.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCpu
```
public void setCpu(String cpu)
```
    The number of cpu units used by the task. If using the EC2 launch type, this field is optional and any value can be used. If using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of valid values for the memory parameter:
    - 256 (.25 vCPU) - Available memory values: 0.5GB, 1GB, 2GB
    - 512 (.5 vCPU) - Available memory values: 1GB, 2GB, 3GB, 4GB
    - 1024 (1 vCPU) - Available memory values: 2GB, 3GB, 4GB, 5GB, 6GB, 7GB, 8GB
    - 2048 (2 vCPU) - Available memory values: Between 4GB and 16GB in 1GB increments
    - 4096 (4 vCPU) - Available memory values: Between 8GB and 30GB in 1GB increments
    Parameters:
    cpu - The number of cpu units used by the task. If using the EC2 launch type, this field is optional and any value can be used. If using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of valid values for the memory parameter:
    
    256 (.25 vCPU) - Available memory values: 0.5GB, 1GB, 2GB
    
    512 (.5 vCPU) - Available memory values: 1GB, 2GB, 3GB, 4GB
    
    1024 (1 vCPU) - Available memory values: 2GB, 3GB, 4GB, 5GB, 6GB, 7GB, 8GB
    
    2048 (2 vCPU) - Available memory values: Between 4GB and 16GB in 1GB increments
    
    4096 (4 vCPU) - Available memory values: Between 8GB and 30GB in 1GB increments
  - getCpu
```
public String getCpu()
```
    The number of cpu units used by the task. If using the EC2 launch type, this field is optional and any value can be used. If using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of valid values for the memory parameter:
    - 256 (.25 vCPU) - Available memory values: 0.5GB, 1GB, 2GB
    - 512 (.5 vCPU) - Available memory values: 1GB, 2GB, 3GB, 4GB
    - 1024 (1 vCPU) - Available memory values: 2GB, 3GB, 4GB, 5GB, 6GB, 7GB, 8GB
    - 2048 (2 vCPU) - Available memory values: Between 4GB and 16GB in 1GB increments
    - 4096 (4 vCPU) - Available memory values: Between 8GB and 30GB in 1GB increments
    Returns:
    The number of cpu units used by the task. If using the EC2 launch type, this field is optional and any value can be used. If using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of valid values for the memory parameter:
    
    256 (.25 vCPU) - Available memory values: 0.5GB, 1GB, 2GB
    
    512 (.5 vCPU) - Available memory values: 1GB, 2GB, 3GB, 4GB
    
    1024 (1 vCPU) - Available memory values: 2GB, 3GB, 4GB, 5GB, 6GB, 7GB, 8GB
    
    2048 (2 vCPU) - Available memory values: Between 4GB and 16GB in 1GB increments
    
    4096 (4 vCPU) - Available memory values: Between 8GB and 30GB in 1GB increments
  - withCpu
```
public Task withCpu(String cpu)
```
    The number of cpu units used by the task. If using the EC2 launch type, this field is optional and any value can be used. If using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of valid values for the memory parameter:
    - 256 (.25 vCPU) - Available memory values: 0.5GB, 1GB, 2GB
    - 512 (.5 vCPU) - Available memory values: 1GB, 2GB, 3GB, 4GB
    - 1024 (1 vCPU) - Available memory values: 2GB, 3GB, 4GB, 5GB, 6GB, 7GB, 8GB
    - 2048 (2 vCPU) - Available memory values: Between 4GB and 16GB in 1GB increments
    - 4096 (4 vCPU) - Available memory values: Between 8GB and 30GB in 1GB increments
    Parameters:
    cpu - The number of cpu units used by the task. If using the EC2 launch type, this field is optional and any value can be used. If using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of valid values for the memory parameter:
    
    256 (.25 vCPU) - Available memory values: 0.5GB, 1GB, 2GB
    
    512 (.5 vCPU) - Available memory values: 1GB, 2GB, 3GB, 4GB
    
    1024 (1 vCPU) - Available memory values: 2GB, 3GB, 4GB, 5GB, 6GB, 7GB, 8GB
    
    2048 (2 vCPU) - Available memory values: Between 4GB and 16GB in 1GB increments
    
    4096 (4 vCPU) - Available memory values: Between 8GB and 30GB in 1GB increments
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMemory
```
public void setMemory(String memory)
```
    The amount (in MiB) of memory used by the task. If using the EC2 launch type, this field is optional and any value can be used. If using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of valid values for the cpu parameter:
    - 0.5GB, 1GB, 2GB - Available cpu values: 256 (.25 vCPU)
    - 1GB, 2GB, 3GB, 4GB - Available cpu values: 512 (.5 vCPU)
    - 2GB, 3GB, 4GB, 5GB, 6GB, 7GB, 8GB - Available cpu values: 1024 (1 vCPU)
    - Between 4GB and 16GB in 1GB increments - Available cpu values: 2048 (2 vCPU)
    - Between 8GB and 30GB in 1GB increments - Available cpu values: 4096 (4 vCPU)
    Parameters:
    memory - The amount (in MiB) of memory used by the task. If using the EC2 launch type, this field is optional and any value can be used. If using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of valid values for the cpu parameter:
    
    0.5GB, 1GB, 2GB - Available cpu values: 256 (.25 vCPU)
    
    1GB, 2GB, 3GB, 4GB - Available cpu values: 512 (.5 vCPU)
    
    2GB, 3GB, 4GB, 5GB, 6GB, 7GB, 8GB - Available cpu values: 1024 (1 vCPU)
    
    Between 4GB and 16GB in 1GB increments - Available cpu values: 2048 (2 vCPU)
    
    Between 8GB and 30GB in 1GB increments - Available cpu values: 4096 (4 vCPU)
  - getMemory
```
public String getMemory()
```
    The amount (in MiB) of memory used by the task. If using the EC2 launch type, this field is optional and any value can be used. If using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of valid values for the cpu parameter:
    - 0.5GB, 1GB, 2GB - Available cpu values: 256 (.25 vCPU)
    - 1GB, 2GB, 3GB, 4GB - Available cpu values: 512 (.5 vCPU)
    - 2GB, 3GB, 4GB, 5GB, 6GB, 7GB, 8GB - Available cpu values: 1024 (1 vCPU)
    - Between 4GB and 16GB in 1GB increments - Available cpu values: 2048 (2 vCPU)
    - Between 8GB and 30GB in 1GB increments - Available cpu values: 4096 (4 vCPU)
    Returns:
    The amount (in MiB) of memory used by the task. If using the EC2 launch type, this field is optional and any value can be used. If using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of valid values for the cpu parameter:
    
    0.5GB, 1GB, 2GB - Available cpu values: 256 (.25 vCPU)
    
    1GB, 2GB, 3GB, 4GB - Available cpu values: 512 (.5 vCPU)
    
    2GB, 3GB, 4GB, 5GB, 6GB, 7GB, 8GB - Available cpu values: 1024 (1 vCPU)
    
    Between 4GB and 16GB in 1GB increments - Available cpu values: 2048 (2 vCPU)
    
    Between 8GB and 30GB in 1GB increments - Available cpu values: 4096 (4 vCPU)
  - withMemory
```
public Task withMemory(String memory)
```
    The amount (in MiB) of memory used by the task. If using the EC2 launch type, this field is optional and any value can be used. If using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of valid values for the cpu parameter:
    - 0.5GB, 1GB, 2GB - Available cpu values: 256 (.25 vCPU)
    - 1GB, 2GB, 3GB, 4GB - Available cpu values: 512 (.5 vCPU)
    - 2GB, 3GB, 4GB, 5GB, 6GB, 7GB, 8GB - Available cpu values: 1024 (1 vCPU)
    - Between 4GB and 16GB in 1GB increments - Available cpu values: 2048 (2 vCPU)
    - Between 8GB and 30GB in 1GB increments - Available cpu values: 4096 (4 vCPU)
    Parameters:
    memory - The amount (in MiB) of memory used by the task. If using the EC2 launch type, this field is optional and any value can be used. If using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of valid values for the cpu parameter:
    
    0.5GB, 1GB, 2GB - Available cpu values: 256 (.25 vCPU)
    
    1GB, 2GB, 3GB, 4GB - Available cpu values: 512 (.5 vCPU)
    
    2GB, 3GB, 4GB, 5GB, 6GB, 7GB, 8GB - Available cpu values: 1024 (1 vCPU)
    
    Between 4GB and 16GB in 1GB increments - Available cpu values: 2048 (2 vCPU)
    
    Between 8GB and 30GB in 1GB increments - Available cpu values: 4096 (4 vCPU)
    Returns:
    
    Returns a reference to this 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.
    
    Parameters:
    
    containers - The containers associated with the task.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withContainers
```
public Task withContainers(Collection<Container> containers)
```
    The containers associated with the task.
    
    Parameters:
    
    containers - The containers associated with the task.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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.
  - 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.
  - 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.
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVersion
```
public void setVersion(Long version)
```
    The version counter for the task. Every time a task experiences a change that triggers a CloudWatch event, the version counter is incremented. If you are replicating your Amazon ECS task state with CloudWatch Events, you can compare the version of a task reported by the Amazon ECS APIs with the version reported in CloudWatch Events for the task (inside the detail object) to verify that the version in your event stream is current.
    
    Parameters:
    
    version - The version counter for the task. Every time a task experiences a change that triggers a CloudWatch event, the version counter is incremented. If you are replicating your Amazon ECS task state with CloudWatch Events, you can compare the version of a task reported by the Amazon ECS APIs with the version reported in CloudWatch Events for the task (inside the detail object) to verify that the version in your event stream is current.
  - getVersion
```
public Long getVersion()
```
    The version counter for the task. Every time a task experiences a change that triggers a CloudWatch event, the version counter is incremented. If you are replicating your Amazon ECS task state with CloudWatch Events, you can compare the version of a task reported by the Amazon ECS APIs with the version reported in CloudWatch Events for the task (inside the detail object) to verify that the version in your event stream is current.
    
    Returns:
    
    The version counter for the task. Every time a task experiences a change that triggers a CloudWatch event, the version counter is incremented. If you are replicating your Amazon ECS task state with CloudWatch Events, you can compare the version of a task reported by the Amazon ECS APIs with the version reported in CloudWatch Events for the task (inside the detail object) to verify that the version in your event stream is current.
  - withVersion
```
public Task withVersion(Long version)
```
    The version counter for the task. Every time a task experiences a change that triggers a CloudWatch event, the version counter is incremented. If you are replicating your Amazon ECS task state with CloudWatch Events, you can compare the version of a task reported by the Amazon ECS APIs with the version reported in CloudWatch Events for the task (inside the detail object) to verify that the version in your event stream is current.
    
    Parameters:
    
    version - The version counter for the task. Every time a task experiences a change that triggers a CloudWatch event, the version counter is incremented. If you are replicating your Amazon ECS task state with CloudWatch Events, you can compare the version of a task reported by the Amazon ECS APIs with the version reported in CloudWatch Events for the task (inside the detail object) to verify that the version in your event stream is current.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStoppedReason
```
public void setStoppedReason(String stoppedReason)
```
    The reason the task was stopped.
    
    Parameters:
    
    stoppedReason - The reason the task was stopped.
  - getStoppedReason
```
public String getStoppedReason()
```
    The reason the task was stopped.
    
    Returns:
    
    The reason the task was stopped.
  - withStoppedReason
```
public Task withStoppedReason(String stoppedReason)
```
    The reason the task was stopped.
    
    Parameters:
    
    stoppedReason - The reason the task was stopped.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setConnectivity
```
public void setConnectivity(String connectivity)
```
    The connectivity status of a task.
    
    Parameters:
    
    connectivity - The connectivity status of a task.
    
    See Also:
    
    Connectivity
  - getConnectivity
```
public String getConnectivity()
```
    The connectivity status of a task.
    
    Returns:
    
    The connectivity status of a task.
    
    See Also:
    
    Connectivity
  - withConnectivity
```
public Task withConnectivity(String connectivity)
```
    The connectivity status of a task.
    
    Parameters:
    
    connectivity - The connectivity status of a task.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Connectivity
  - withConnectivity
```
public Task withConnectivity(Connectivity connectivity)
```
    The connectivity status of a task.
    
    Parameters:
    
    connectivity - The connectivity status of a task.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Connectivity
  - setConnectivityAt
```
public void setConnectivityAt(Date connectivityAt)
```
    The Unix time stamp for when the task last went into CONNECTED status.
    
    Parameters:
    
    connectivityAt - The Unix time stamp for when the task last went into CONNECTED status.
  - getConnectivityAt
```
public Date getConnectivityAt()
```
    The Unix time stamp for when the task last went into CONNECTED status.
    
    Returns:
    
    The Unix time stamp for when the task last went into CONNECTED status.
  - withConnectivityAt
```
public Task withConnectivityAt(Date connectivityAt)
```
    The Unix time stamp for when the task last went into CONNECTED status.
    
    Parameters:
    
    connectivityAt - The Unix time stamp for when the task last went into CONNECTED status.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPullStartedAt
```
public void setPullStartedAt(Date pullStartedAt)
```
    The Unix time stamp for when the container image pull began.
    
    Parameters:
    
    pullStartedAt - The Unix time stamp for when the container image pull began.
  - getPullStartedAt
```
public Date getPullStartedAt()
```
    The Unix time stamp for when the container image pull began.
    
    Returns:
    
    The Unix time stamp for when the container image pull began.
  - withPullStartedAt
```
public Task withPullStartedAt(Date pullStartedAt)
```
    The Unix time stamp for when the container image pull began.
    
    Parameters:
    
    pullStartedAt - The Unix time stamp for when the container image pull began.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPullStoppedAt
```
public void setPullStoppedAt(Date pullStoppedAt)
```
    The Unix time stamp for when the container image pull completed.
    
    Parameters:
    
    pullStoppedAt - The Unix time stamp for when the container image pull completed.
  - getPullStoppedAt
```
public Date getPullStoppedAt()
```
    The Unix time stamp for when the container image pull completed.
    
    Returns:
    
    The Unix time stamp for when the container image pull completed.
  - withPullStoppedAt
```
public Task withPullStoppedAt(Date pullStoppedAt)
```
    The Unix time stamp for when the container image pull completed.
    
    Parameters:
    
    pullStoppedAt - The Unix time stamp for when the container image pull completed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setExecutionStoppedAt
```
public void setExecutionStoppedAt(Date executionStoppedAt)
```
    The Unix timestamp for when the task execution stopped.
    
    Parameters:
    
    executionStoppedAt - The Unix timestamp for when the task execution stopped.
  - getExecutionStoppedAt
```
public Date getExecutionStoppedAt()
```
    The Unix timestamp for when the task execution stopped.
    
    Returns:
    
    The Unix timestamp for when the task execution stopped.
  - withExecutionStoppedAt
```
public Task withExecutionStoppedAt(Date executionStoppedAt)
```
    The Unix timestamp for when the task execution stopped.
    
    Parameters:
    
    executionStoppedAt - The Unix timestamp for when the task execution stopped.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreatedAt
```
public void setCreatedAt(Date createdAt)
```
    The Unix time stamp for when the task was created (the task entered the PENDING state).
    
    Parameters:
    
    createdAt - The Unix time stamp for when the task was created (the task entered the PENDING state).
  - getCreatedAt
```
public Date getCreatedAt()
```
    The Unix time stamp for when the task was created (the task entered the PENDING state).
    
    Returns:
    
    The Unix time stamp for when the task was created (the task entered the PENDING state).
  - withCreatedAt
```
public Task withCreatedAt(Date createdAt)
```
    The Unix time stamp for when the task was created (the task entered the PENDING state).
    
    Parameters:
    
    createdAt - The Unix time stamp for when the task was created (the task entered the PENDING state).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStartedAt
```
public void setStartedAt(Date startedAt)
```
    The Unix time stamp for when the task started (the task transitioned from the PENDING state to the RUNNING state).
    
    Parameters:
    
    startedAt - The Unix time stamp for when the task started (the task transitioned from the PENDING state to the RUNNING state).
  - getStartedAt
```
public Date getStartedAt()
```
    The Unix time stamp for when the task started (the task transitioned from the PENDING state to the RUNNING state).
    
    Returns:
    
    The Unix time stamp for when the task started (the task transitioned from the PENDING state to the RUNNING state).
  - withStartedAt
```
public Task withStartedAt(Date startedAt)
```
    The Unix time stamp for when the task started (the task transitioned from the PENDING state to the RUNNING state).
    
    Parameters:
    
    startedAt - The Unix time stamp for when the task started (the task transitioned from the PENDING state to the RUNNING state).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStoppingAt
```
public void setStoppingAt(Date stoppingAt)
```
    The Unix time stamp for when the task will stop (the task transitioned from the RUNNING state to the STOPPED state).
    
    Parameters:
    
    stoppingAt - The Unix time stamp for when the task will stop (the task transitioned from the RUNNING state to the STOPPED state).
  - getStoppingAt
```
public Date getStoppingAt()
```
    The Unix time stamp for when the task will stop (the task transitioned from the RUNNING state to the STOPPED state).
    
    Returns:
    
    The Unix time stamp for when the task will stop (the task transitioned from the RUNNING state to the STOPPED state).
  - withStoppingAt
```
public Task withStoppingAt(Date stoppingAt)
```
    The Unix time stamp for when the task will stop (the task transitioned from the RUNNING state to the STOPPED state).
    
    Parameters:
    
    stoppingAt - The Unix time stamp for when the task will stop (the task transitioned from the RUNNING state to the STOPPED state).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStoppedAt
```
public void setStoppedAt(Date stoppedAt)
```
    The Unix time stamp for when the task was stopped (the task transitioned from the RUNNING state to the STOPPED state).
    
    Parameters:
    
    stoppedAt - The Unix time stamp for when the task was stopped (the task transitioned from the RUNNING state to the STOPPED state).
  - getStoppedAt
```
public Date getStoppedAt()
```
    The Unix time stamp for when the task was stopped (the task transitioned from the RUNNING state to the STOPPED state).
    
    Returns:
    
    The Unix time stamp for when the task was stopped (the task transitioned from the RUNNING state to the STOPPED state).
  - withStoppedAt
```
public Task withStoppedAt(Date stoppedAt)
```
    The Unix time stamp for when the task was stopped (the task transitioned from the RUNNING state to the STOPPED state).
    
    Parameters:
    
    stoppedAt - The Unix time stamp for when the task was stopped (the task transitioned from the RUNNING state to the STOPPED state).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setGroup
```
public void setGroup(String group)
```
    The name of the task group associated with the task.
    
    Parameters:
    
    group - The name of the task group associated with the task.
  - getGroup
```
public String getGroup()
```
    The name of the task group associated with the task.
    
    Returns:
    
    The name of the task group associated with the task.
  - withGroup
```
public Task withGroup(String group)
```
    The name of the task group associated with the task.
    
    Parameters:
    
    group - The name of the task group associated with the task.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLaunchType
```
public void setLaunchType(String launchType)
```
    The launch type on which your task is running.
    
    Parameters:
    
    launchType - The launch type on which your task is running.
    
    See Also:
    
    LaunchType
  - getLaunchType
```
public String getLaunchType()
```
    The launch type on which your task is running.
    
    Returns:
    
    The launch type on which your task is running.
    
    See Also:
    
    LaunchType
  - withLaunchType
```
public Task withLaunchType(String launchType)
```
    The launch type on which your task is running.
    
    Parameters:
    
    launchType - The launch type on which your task is running.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    LaunchType
  - withLaunchType
```
public Task withLaunchType(LaunchType launchType)
```
    The launch type on which your task is running.
    
    Parameters:
    
    launchType - The launch type on which your task is running.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    LaunchType
  - setPlatformVersion
```
public void setPlatformVersion(String platformVersion)
```
    The platform version on which your task is running. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.
    
    Parameters:
    
    platformVersion - The platform version on which your task is running. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.
  - getPlatformVersion
```
public String getPlatformVersion()
```
    The platform version on which your task is running. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.
    
    Returns:
    
    The platform version on which your task is running. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.
  - withPlatformVersion
```
public Task withPlatformVersion(String platformVersion)
```
    The platform version on which your task is running. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.
    
    Parameters:
    
    platformVersion - The platform version on which your task is running. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getAttachments
```
public List<Attachment> getAttachments()
```
    The Elastic Network Adapter associated with the task if the task uses the awsvpc network mode.
    
    Returns:
    
    The Elastic Network Adapter associated with the task if the task uses the awsvpc network mode.
  - setAttachments
```
public void setAttachments(Collection<Attachment> attachments)
```
    The Elastic Network Adapter associated with the task if the task uses the awsvpc network mode.
    
    Parameters:
    
    attachments - The Elastic Network Adapter associated with the task if the task uses the awsvpc network mode.
  - withAttachments
```
public Task withAttachments(Attachment... attachments)
```
    The Elastic Network Adapter associated with the task if the task uses the awsvpc network mode.
    
    NOTE: This method appends the values to the existing list (if any). Use setAttachments(java.util.Collection) or withAttachments(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    attachments - The Elastic Network Adapter associated with the task if the task uses the awsvpc network mode.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withAttachments
```
public Task withAttachments(Collection<Attachment> attachments)
```
    The Elastic Network Adapter associated with the task if the task uses the awsvpc network mode.
    
    Parameters:
    
    attachments - The Elastic Network Adapter associated with the task if the task uses the awsvpc network mode.
    
    Returns:
    
    Returns a reference to this 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()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Task clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class Task

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Task

Method Detail

setTaskArn

getTaskArn

withTaskArn

setClusterArn

getClusterArn

withClusterArn

setTaskDefinitionArn

getTaskDefinitionArn

withTaskDefinitionArn

setContainerInstanceArn

getContainerInstanceArn

withContainerInstanceArn

setOverrides

getOverrides

withOverrides

setLastStatus

getLastStatus

withLastStatus

setDesiredStatus

getDesiredStatus

withDesiredStatus

setCpu

getCpu

withCpu

setMemory

getMemory

withMemory

getContainers

setContainers

withContainers

withContainers

setStartedBy

getStartedBy

withStartedBy

setVersion

getVersion

withVersion

setStoppedReason

getStoppedReason

withStoppedReason

setConnectivity

getConnectivity

withConnectivity

withConnectivity

setConnectivityAt

getConnectivityAt

withConnectivityAt

setPullStartedAt

getPullStartedAt

withPullStartedAt

setPullStoppedAt

getPullStoppedAt

withPullStoppedAt

setExecutionStoppedAt

getExecutionStoppedAt

withExecutionStoppedAt

setCreatedAt

getCreatedAt

withCreatedAt

setStartedAt

getStartedAt

withStartedAt

setStoppingAt

getStoppingAt

withStoppingAt

setStoppedAt

getStoppedAt

withStoppedAt

setGroup

getGroup

withGroup

setLaunchType