Task (AWS Java SDK :: Services :: Amazon EC2 Container Service 2.4.13 API)

java.lang.Object
- software.amazon.awssdk.services.ecs.model.Task

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<Task.Builder,Task>

@Generated(value="software.amazon.awssdk:codegen")
public final class Task
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Task.Builder,Task>

Details on a task in a cluster.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Task.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Task.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<Attachment>`	`attachments()` The Elastic Network Adapter associated with the task if the task uses the `awsvpc` network mode.
`static Task.Builder`	`builder()`
`String`	`clusterArn()` The ARN of the cluster that hosts the task.
`Connectivity`	`connectivity()` The connectivity status of a task.
`String`	`connectivityAsString()` The connectivity status of a task.
`Instant`	`connectivityAt()` The Unix timestamp for when the task last went into `CONNECTED` status.
`String`	`containerInstanceArn()` The ARN of the container instances that host the task.
`List<Container>`	`containers()` The containers associated with the task.
`String`	`cpu()` The number of CPU units used by the task as expressed in a task definition.
`Instant`	`createdAt()` The Unix timestamp for when the task was created (the task entered the `PENDING` state).
`String`	`desiredStatus()` The desired status of the task.
`boolean`	`equals(Object obj)`
`Instant`	`executionStoppedAt()` The Unix timestamp for when the task execution stopped.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`String`	`group()` The name of the task group associated with the task.
`int`	`hashCode()`
`HealthStatus`	`healthStatus()` The health status for the task, which is determined by the health of the essential containers in the task.
`String`	`healthStatusAsString()` The health status for the task, which is determined by the health of the essential containers in the task.
`String`	`lastStatus()` The last known status of the task.
`LaunchType`	`launchType()` The launch type on which your task is running.
`String`	`launchTypeAsString()` The launch type on which your task is running.
`String`	`memory()` The amount of memory (in MiB) used by the task as expressed in a task definition.
`TaskOverride`	`overrides()` One or more container overrides.
`String`	`platformVersion()` The platform version on which your task is running.
`Instant`	`pullStartedAt()` The Unix timestamp for when the container image pull began.
`Instant`	`pullStoppedAt()` The Unix timestamp for when the container image pull completed.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Task.Builder>`	`serializableBuilderClass()`
`Instant`	`startedAt()` The Unix timestamp for when the task started (the task transitioned from the `PENDING` state to the `RUNNING` state).
`String`	`startedBy()` The tag specified when a task is started.
`TaskStopCode`	`stopCode()` The stop code indicating why a task was stopped.
`String`	`stopCodeAsString()` The stop code indicating why a task was stopped.
`Instant`	`stoppedAt()` The Unix timestamp for when the task was stopped (the task transitioned from the `RUNNING` state to the `STOPPED` state).
`String`	`stoppedReason()` The reason that the task was stopped.
`Instant`	`stoppingAt()` The Unix timestamp for when the task stops (transitions from the `RUNNING` state to `STOPPED`).
`List<Tag>`	`tags()` The metadata that you apply to the task to help you categorize and organize them.
`String`	`taskArn()` The Amazon Resource Name (ARN) of the task.
`String`	`taskDefinitionArn()` The ARN of the task definition that creates the task.
`Task.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`Long`	`version()` The version counter for the task.

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - taskArn
```
public String taskArn()
```
    The Amazon Resource Name (ARN) of the task.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the task.
  - clusterArn
```
public String clusterArn()
```
    The ARN of the cluster that hosts the task.
    
    Returns:
    
    The ARN of the cluster that hosts the task.
  - taskDefinitionArn
```
public String taskDefinitionArn()
```
    The ARN of the task definition that creates the task.
    
    Returns:
    
    The ARN of the task definition that creates the task.
  - containerInstanceArn
```
public String containerInstanceArn()
```
    The ARN of the container instances that host the task.
    
    Returns:
    
    The ARN of the container instances that host the task.
  - overrides
```
public TaskOverride overrides()
```
    One or more container overrides.
    
    Returns:
    
    One or more container overrides.
  - lastStatus
```
public String lastStatus()
```
    The last known status of the task. For more information, see Task Lifecycle.
    
    Returns:
    
    The last known status of the task. For more information, see Task Lifecycle.
  - desiredStatus
```
public String desiredStatus()
```
    The desired status of the task. For more information, see Task Lifecycle.
    
    Returns:
    
    The desired status of the task. For more information, see Task Lifecycle.
  - cpu
```
public String cpu()
```
    The number of CPU units used by the task as expressed in a task definition. It can be expressed as an integer using CPU units, for example 1024. It can also be expressed as a string using vCPUs, for example 1 vCPU or 1 vcpu. String values are converted to an integer indicating the CPU units when the task definition is registered.
    
    If you are using the EC2 launch type, this field is optional. Supported values are between 128 CPU units (0.125 vCPUs) and 10240 CPU units (10 vCPUs).
    
    If you are using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the memory parameter:
    - 256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
    - 512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)
    - 1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)
    - 2048 (2 vCPU) - Available memory values: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)
    - 4096 (4 vCPU) - Available memory values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
    Returns:
    The number of CPU units used by the task as expressed in a task definition. It can be expressed as an integer using CPU units, for example 1024. It can also be expressed as a string using vCPUs, for example 1 vCPU or 1 vcpu. String values are converted to an integer indicating the CPU units when the task definition is registered.
    
    If you are using the EC2 launch type, this field is optional. Supported values are between 128 CPU units (0.125 vCPUs) and 10240 CPU units (10 vCPUs).
    
    If you are using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the memory parameter:
    
    256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
    
    512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)
    
    1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)
    
    2048 (2 vCPU) - Available memory values: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)
    
    4096 (4 vCPU) - Available memory values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
  - memory
```
public String memory()
```
    The amount of memory (in MiB) used by the task as expressed in a task definition. It can be expressed as an integer using MiB, for example 1024. It can also be expressed as a string using GB, for example 1GB or 1 GB. String values are converted to an integer indicating the MiB when the task definition is registered.
    
    If you are using the EC2 launch type, this field is optional.
    
    If you are using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the cpu parameter:
    - 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU)
    - 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU)
    - 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU)
    - Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU)
    - Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU)
    Returns:
    The amount of memory (in MiB) used by the task as expressed in a task definition. It can be expressed as an integer using MiB, for example 1024. It can also be expressed as a string using GB, for example 1GB or 1 GB. String values are converted to an integer indicating the MiB when the task definition is registered.
    
    If you are using the EC2 launch type, this field is optional.
    
    If you are using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the cpu parameter:
    
    512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU)
    
    1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU)
    
    2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU)
    
    Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU)
    
    Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU)
  - containers
```
public List<Container> containers()
```
    The containers associated with the task.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    The containers associated with the task.
  - startedBy
```
public 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:
    
    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.
  - version
```
public 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 API actionss 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 API actionss 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.
  - stoppedReason
```
public String stoppedReason()
```
    The reason that the task was stopped.
    
    Returns:
    
    The reason that the task was stopped.
  - stopCode
```
public TaskStopCode stopCode()
```
    The stop code indicating why a task was stopped. The stoppedReason may contain additional details.
    
    If the service returns an enum value that is not available in the current SDK version, stopCode will return TaskStopCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stopCodeAsString().
    
    Returns:
    
    The stop code indicating why a task was stopped. The stoppedReason may contain additional details.
    
    See Also:
    
    TaskStopCode
  - stopCodeAsString
```
public String stopCodeAsString()
```
    The stop code indicating why a task was stopped. The stoppedReason may contain additional details.
    
    If the service returns an enum value that is not available in the current SDK version, stopCode will return TaskStopCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stopCodeAsString().
    
    Returns:
    
    The stop code indicating why a task was stopped. The stoppedReason may contain additional details.
    
    See Also:
    
    TaskStopCode
  - connectivity
```
public Connectivity connectivity()
```
    The connectivity status of a task.
    
    If the service returns an enum value that is not available in the current SDK version, connectivity will return Connectivity.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from connectivityAsString().
    
    Returns:
    
    The connectivity status of a task.
    
    See Also:
    
    Connectivity
  - connectivityAsString
```
public String connectivityAsString()
```
    The connectivity status of a task.
    
    If the service returns an enum value that is not available in the current SDK version, connectivity will return Connectivity.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from connectivityAsString().
    
    Returns:
    
    The connectivity status of a task.
    
    See Also:
    
    Connectivity
  - connectivityAt
```
public Instant connectivityAt()
```
    The Unix timestamp for when the task last went into CONNECTED status.
    
    Returns:
    
    The Unix timestamp for when the task last went into CONNECTED status.
  - pullStartedAt
```
public Instant pullStartedAt()
```
    The Unix timestamp for when the container image pull began.
    
    Returns:
    
    The Unix timestamp for when the container image pull began.
  - pullStoppedAt
```
public Instant pullStoppedAt()
```
    The Unix timestamp for when the container image pull completed.
    
    Returns:
    
    The Unix timestamp for when the container image pull completed.
  - executionStoppedAt
```
public Instant executionStoppedAt()
```
    The Unix timestamp for when the task execution stopped.
    
    Returns:
    
    The Unix timestamp for when the task execution stopped.
  - createdAt
```
public Instant createdAt()
```
    The Unix timestamp for when the task was created (the task entered the PENDING state).
    
    Returns:
    
    The Unix timestamp for when the task was created (the task entered the PENDING state).
  - startedAt
```
public Instant startedAt()
```
    The Unix timestamp for when the task started (the task transitioned from the PENDING state to the RUNNING state).
    
    Returns:
    
    The Unix timestamp for when the task started (the task transitioned from the PENDING state to the RUNNING state).
  - stoppingAt
```
public Instant stoppingAt()
```
    The Unix timestamp for when the task stops (transitions from the RUNNING state to STOPPED).
    
    Returns:
    
    The Unix timestamp for when the task stops (transitions from the RUNNING state to STOPPED).
  - stoppedAt
```
public Instant stoppedAt()
```
    The Unix timestamp for when the task was stopped (the task transitioned from the RUNNING state to the STOPPED state).
    
    Returns:
    
    The Unix timestamp for when the task was stopped (the task transitioned from the RUNNING state to the STOPPED state).
  - group
```
public String group()
```
    The name of the task group associated with the task.
    
    Returns:
    
    The name of the task group associated with the task.
  - launchType
```
public LaunchType launchType()
```
    The launch type on which your task is running. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
    
    If the service returns an enum value that is not available in the current SDK version, launchType will return LaunchType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from launchTypeAsString().
    
    Returns:
    
    The launch type on which your task is running. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
    
    See Also:
    
    LaunchType
  - launchTypeAsString
```
public String launchTypeAsString()
```
    The launch type on which your task is running. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
    
    If the service returns an enum value that is not available in the current SDK version, launchType will return LaunchType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from launchTypeAsString().
    
    Returns:
    
    The launch type on which your task is running. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
    
    See Also:
    
    LaunchType
  - platformVersion
```
public String platformVersion()
```
    The platform version on which your task is running. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. 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. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.
  - attachments
```
public List<Attachment> attachments()
```
    The Elastic Network Adapter associated with the task if the task uses the awsvpc network mode.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    The Elastic Network Adapter associated with the task if the task uses the awsvpc network mode.
  - healthStatus
```
public HealthStatus healthStatus()
```
    The health status for the task, which is determined by the health of the essential containers in the task. If all essential containers in the task are reporting as HEALTHY, then the task status also reports as HEALTHY. If any essential containers in the task are reporting as UNHEALTHY or UNKNOWN, then the task status also reports as UNHEALTHY or UNKNOWN, accordingly.
    
    The Amazon ECS container agent does not monitor or report on Docker health checks that are embedded in a container image (such as those specified in a parent image or from the image's Dockerfile) and not specified in the container definition. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image.
    
    If the service returns an enum value that is not available in the current SDK version, healthStatus will return HealthStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from healthStatusAsString().
    
    Returns:
    
    The health status for the task, which is determined by the health of the essential containers in the task. If all essential containers in the task are reporting as HEALTHY, then the task status also reports as HEALTHY. If any essential containers in the task are reporting as UNHEALTHY or UNKNOWN, then the task status also reports as UNHEALTHY or UNKNOWN, accordingly.
    
    The Amazon ECS container agent does not monitor or report on Docker health checks that are embedded in a container image (such as those specified in a parent image or from the image's Dockerfile) and not specified in the container definition. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image.
    
    See Also:
    
    HealthStatus
  - healthStatusAsString
```
public String healthStatusAsString()
```
    The health status for the task, which is determined by the health of the essential containers in the task. If all essential containers in the task are reporting as HEALTHY, then the task status also reports as HEALTHY. If any essential containers in the task are reporting as UNHEALTHY or UNKNOWN, then the task status also reports as UNHEALTHY or UNKNOWN, accordingly.
    
    The Amazon ECS container agent does not monitor or report on Docker health checks that are embedded in a container image (such as those specified in a parent image or from the image's Dockerfile) and not specified in the container definition. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image.
    
    If the service returns an enum value that is not available in the current SDK version, healthStatus will return HealthStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from healthStatusAsString().
    
    Returns:
    
    The health status for the task, which is determined by the health of the essential containers in the task. If all essential containers in the task are reporting as HEALTHY, then the task status also reports as HEALTHY. If any essential containers in the task are reporting as UNHEALTHY or UNKNOWN, then the task status also reports as UNHEALTHY or UNKNOWN, accordingly.
    
    The Amazon ECS container agent does not monitor or report on Docker health checks that are embedded in a container image (such as those specified in a parent image or from the image's Dockerfile) and not specified in the container definition. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image.
    
    See Also:
    
    HealthStatus
  - tags
```
public List<Tag> tags()
```
    The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
  - toBuilder
```
public Task.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Task.Builder,Task>
  - builder
```
public static Task.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Task.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class Task

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

taskArn

clusterArn

taskDefinitionArn

containerInstanceArn

overrides

lastStatus

desiredStatus

cpu

memory

containers

startedBy

version

stoppedReason

stopCode

stopCodeAsString

connectivity

connectivityAsString

connectivityAt

pullStartedAt

pullStoppedAt

executionStoppedAt

createdAt

startedAt

stoppingAt

stoppedAt

group

launchType

launchTypeAsString

platformVersion

attachments

healthStatus

healthStatusAsString

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields