@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.
| Modifier and Type | Class and Description |
|---|---|
static interface |
Task.Builder |
| Modifier and Type | Method and Description |
|---|---|
List<Attachment> |
attachments()
The Elastic Network Adapter that's associated with the task if the task uses the
awsvpc network
mode. |
List<Attribute> |
attributes()
The attributes of the task
|
String |
availabilityZone()
The Availability Zone for the task.
|
static Task.Builder |
builder() |
String |
capacityProviderName()
The capacity provider that's associated with the task.
|
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 the time 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 that's 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 the time when the task was created.
|
String |
desiredStatus()
The desired status of the task.
|
Boolean |
enableExecuteCommand()
Determines whether execute command functionality is enabled for this task.
|
EphemeralStorage |
ephemeralStorage()
The ephemeral storage settings for the task.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
Instant |
executionStoppedAt()
The Unix timestamp for the time when the task execution stopped.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
String |
group()
The name of the task group that's associated with the task.
|
boolean |
hasAttachments()
For responses, this returns true if the service returned a value for the Attachments property.
|
boolean |
hasAttributes()
For responses, this returns true if the service returned a value for the Attributes property.
|
boolean |
hasContainers()
For responses, this returns true if the service returned a value for the Containers property.
|
int |
hashCode() |
boolean |
hasInferenceAccelerators()
For responses, this returns true if the service returned a value for the InferenceAccelerators property.
|
boolean |
hasTags()
For responses, this returns true if the service returned a value for the Tags property.
|
HealthStatus |
healthStatus()
The health status for the task.
|
String |
healthStatusAsString()
The health status for the task.
|
List<InferenceAccelerator> |
inferenceAccelerators()
The Elastic Inference accelerator that's associated with the task.
|
String |
lastStatus()
The last known status for the task.
|
LaunchType |
launchType()
The infrastructure where your task runs on.
|
String |
launchTypeAsString()
The infrastructure where your task runs on.
|
String |
memory()
The amount of memory (in MiB) that the task uses as expressed in a task definition.
|
TaskOverride |
overrides()
One or more container overrides.
|
String |
platformFamily()
The operating system that your tasks are running on.
|
String |
platformVersion()
The platform version where your task runs on.
|
Instant |
pullStartedAt()
The Unix timestamp for the time when the container image pull began.
|
Instant |
pullStoppedAt()
The Unix timestamp for the time when the container image pull completed.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends Task.Builder> |
serializableBuilderClass() |
Instant |
startedAt()
The Unix timestamp for the time when the task started.
|
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 the time when the task was stopped.
|
String |
stoppedReason()
The reason that the task was stopped.
|
Instant |
stoppingAt()
The Unix timestamp for the time when the task stops.
|
List<Tag> |
tags()
The metadata that you apply to the task to help you categorize and organize the task.
|
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.
|
clone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final boolean hasAttachments()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final List<Attachment> attachments()
The Elastic Network Adapter that's 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.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasAttachments() method.
awsvpc
network mode.public final boolean hasAttributes()
isEmpty() method on the property). This is
useful because the SDK will never return a null collection or map, but you may need to differentiate between the
service returning nothing (or null) and the service returning an empty collection or map. For requests, this
returns true if a value for the property was specified in the request builder, and false if a value was not
specified.public final List<Attribute> attributes()
The attributes of the task
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasAttributes() method.
public final String availabilityZone()
The Availability Zone for the task.
public final String capacityProviderName()
The capacity provider that's associated with the task.
public final String clusterArn()
The ARN of the cluster that hosts the task.
public final 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().
Connectivitypublic final 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().
Connectivitypublic final Instant connectivityAt()
The Unix timestamp for the time when the task last went into CONNECTED status.
CONNECTED status.public final String containerInstanceArn()
The ARN of the container instances that host the task.
public final boolean hasContainers()
isEmpty() method on the property). This is
useful because the SDK will never return a null collection or map, but you may need to differentiate between the
service returning nothing (or null) and the service returning an empty collection or map. For requests, this
returns true if a value for the property was specified in the request builder, and false if a value was not
specified.public final List<Container> containers()
The containers that's associated with the task.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasContainers() method.
public final 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 that indicates the CPU
units when the task definition is registered.
If you use 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 use the Fargate launch type, this field is required. You must use one of the following values. These
values determine the range of supported values for the memory parameter:
The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.
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: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)
4096 (4 vCPU) - Available memory values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
8192 (8 vCPU) - Available memory values: 16 GB and 60 GB in 4 GB increments
This option requires Linux platform 1.4.0 or later.
16384 (16vCPU) - Available memory values: 32GB and 120 GB in 8 GB increments
This option requires Linux platform 1.4.0 or later.
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 that indicates the CPU units when the task definition is registered.
If you use 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 use the Fargate launch type, this field is required. You must use one of the following values.
These values determine the range of supported values for the memory parameter:
The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.
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: 4096 (4 GB) and 16384 (16 GB) in increments of 1024
(1 GB)
4096 (4 vCPU) - Available memory values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024
(1 GB)
8192 (8 vCPU) - Available memory values: 16 GB and 60 GB in 4 GB increments
This option requires Linux platform 1.4.0 or later.
16384 (16vCPU) - Available memory values: 32GB and 120 GB in 8 GB increments
This option requires Linux platform 1.4.0 or later.
public final Instant createdAt()
The Unix timestamp for the time when the task was created. More specifically, it's for the time when the task
entered the PENDING state.
PENDING state.public final String desiredStatus()
The desired status of the task. For more information, see Task Lifecycle.
public final Boolean enableExecuteCommand()
Determines whether execute command functionality is enabled for this task. If true, execute command
functionality is enabled on all the containers in the task.
true, execute
command functionality is enabled on all the containers in the task.public final Instant executionStoppedAt()
The Unix timestamp for the time when the task execution stopped.
public final String group()
The name of the task group that's associated with the task.
public final HealthStatus healthStatus()
The health status for the task. It's determined by the health of the essential containers in the task. If all
essential containers in the task are reporting as HEALTHY, the task status also reports as
HEALTHY. If any essential containers in the task are reporting as UNHEALTHY or
UNKNOWN, the task status also reports as UNHEALTHY or UNKNOWN.
The Amazon ECS container agent doesn't monitor or report on Docker health checks that are embedded in a container image and not specified in the container definition. For example, this includes those specified in a parent image or from the image's Dockerfile. Health check parameters that are specified in a container definition override any Docker health checks that are found 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().
HEALTHY, the task status also reports
as HEALTHY. If any essential containers in the task are reporting as UNHEALTHY
or UNKNOWN, the task status also reports as UNHEALTHY or UNKNOWN
. The Amazon ECS container agent doesn't monitor or report on Docker health checks that are embedded in a container image and not specified in the container definition. For example, this includes those specified in a parent image or from the image's Dockerfile. Health check parameters that are specified in a container definition override any Docker health checks that are found in the container image.
HealthStatuspublic final String healthStatusAsString()
The health status for the task. It's determined by the health of the essential containers in the task. If all
essential containers in the task are reporting as HEALTHY, the task status also reports as
HEALTHY. If any essential containers in the task are reporting as UNHEALTHY or
UNKNOWN, the task status also reports as UNHEALTHY or UNKNOWN.
The Amazon ECS container agent doesn't monitor or report on Docker health checks that are embedded in a container image and not specified in the container definition. For example, this includes those specified in a parent image or from the image's Dockerfile. Health check parameters that are specified in a container definition override any Docker health checks that are found 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().
HEALTHY, the task status also reports
as HEALTHY. If any essential containers in the task are reporting as UNHEALTHY
or UNKNOWN, the task status also reports as UNHEALTHY or UNKNOWN
. The Amazon ECS container agent doesn't monitor or report on Docker health checks that are embedded in a container image and not specified in the container definition. For example, this includes those specified in a parent image or from the image's Dockerfile. Health check parameters that are specified in a container definition override any Docker health checks that are found in the container image.
HealthStatuspublic final boolean hasInferenceAccelerators()
isEmpty() method on the
property). This is useful because the SDK will never return a null collection or map, but you may need to
differentiate between the service returning nothing (or null) and the service returning an empty collection or
map. For requests, this returns true if a value for the property was specified in the request builder, and false
if a value was not specified.public final List<InferenceAccelerator> inferenceAccelerators()
The Elastic Inference accelerator that's associated with the task.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasInferenceAccelerators() method.
public final String lastStatus()
The last known status for the task. For more information, see Task Lifecycle.
public final LaunchType launchType()
The infrastructure where your task runs on. 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().
LaunchTypepublic final String launchTypeAsString()
The infrastructure where your task runs on. 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().
LaunchTypepublic final String memory()
The amount of memory (in MiB) that the task uses as expressed in a task definition. It can be expressed as an
integer using MiB (for example, 1024). If it's expressed as a string using GB (for example,
1GB or 1 GB), it's converted to an integer indicating the MiB when the task definition
is registered.
If you use the EC2 launch type, this field is optional.
If you use the Fargate launch type, this field is required. You must use one of the following values. The value
that you choose determines the 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)
Between 16 GB and 60 GB in 4 GB increments - Available cpu values: 8192 (8 vCPU)
This option requires Linux platform 1.4.0 or later.
Between 32GB and 120 GB in 8 GB increments - Available cpu values: 16384 (16 vCPU)
This option requires Linux platform 1.4.0 or later.
1024). If it's expressed as a string using GB (for
example, 1GB or 1 GB), it's converted to an integer indicating the MiB when the
task definition is registered.
If you use the EC2 launch type, this field is optional.
If you use the Fargate launch type, this field is required. You must use one of the following values. The
value that you choose determines the 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)
Between 16 GB and 60 GB in 4 GB increments - Available cpu values: 8192 (8 vCPU)
This option requires Linux platform 1.4.0 or later.
Between 32GB and 120 GB in 8 GB increments - Available cpu values: 16384 (16 vCPU)
This option requires Linux platform 1.4.0 or later.
public final TaskOverride overrides()
One or more container overrides.
public final String platformVersion()
The platform version where your task runs on. A platform version is only specified for tasks that use the Fargate
launch type. If you didn't specify one, the LATEST platform version is used. For more information,
see Fargate Platform
Versions in the Amazon Elastic Container Service Developer Guide.
LATEST platform version is used. For
more information, see Fargate
Platform Versions in the Amazon Elastic Container Service Developer Guide.public final String platformFamily()
The operating system that your tasks are running on. A platform family is specified only for tasks that use the Fargate launch type.
All tasks that run as part of this service must use the same platformFamily value as the service
(for example, LINUX.).
All tasks that run as part of this service must use the same platformFamily value as the
service (for example, LINUX.).
public final Instant pullStartedAt()
The Unix timestamp for the time when the container image pull began.
public final Instant pullStoppedAt()
The Unix timestamp for the time when the container image pull completed.
public final Instant startedAt()
The Unix timestamp for the time when the task started. More specifically, it's for the time when the task
transitioned from the PENDING state to the RUNNING state.
PENDING state to the RUNNING state.public final String startedBy()
The tag specified when a task is started. If an Amazon ECS service started the task, the startedBy
parameter contains the deployment ID of that service.
startedBy parameter contains the deployment ID of that service.public final TaskStopCode stopCode()
The stop code indicating why a task was stopped. The stoppedReason might contain additional details.
The following are valid values:
TaskFailedToStart
EssentialContainerExited
UserInitiated
TerminationNotice
ServiceSchedulerInitiated
SpotInterruption
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().
stoppedReason might contain additional
details.
The following are valid values:
TaskFailedToStart
EssentialContainerExited
UserInitiated
TerminationNotice
ServiceSchedulerInitiated
SpotInterruption
TaskStopCodepublic final String stopCodeAsString()
The stop code indicating why a task was stopped. The stoppedReason might contain additional details.
The following are valid values:
TaskFailedToStart
EssentialContainerExited
UserInitiated
TerminationNotice
ServiceSchedulerInitiated
SpotInterruption
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().
stoppedReason might contain additional
details.
The following are valid values:
TaskFailedToStart
EssentialContainerExited
UserInitiated
TerminationNotice
ServiceSchedulerInitiated
SpotInterruption
TaskStopCodepublic final Instant stoppedAt()
The Unix timestamp for the time when the task was stopped. More specifically, it's for the time when the task
transitioned from the RUNNING state to the STOPPED state.
RUNNING state to the STOPPED state.public final String stoppedReason()
The reason that the task was stopped.
public final Instant stoppingAt()
The Unix timestamp for the time when the task stops. More specifically, it's for the time when the task
transitions from the RUNNING state to STOPPED.
RUNNING state to STOPPED.public final boolean hasTags()
isEmpty() method on the property). This is useful
because the SDK will never return a null collection or map, but you may need to differentiate between the service
returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true
if a value for the property was specified in the request builder, and false if a value was not specified.public final List<Tag> tags()
The metadata that you apply to the task to help you categorize and organize the task. Each tag consists of a key and an optional value. You define both the key and value.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for
either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values
with this prefix. Tags with this prefix do not count against your tags per resource limit.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasTags() method.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws:, AWS:, or any upper or lowercase combination of such as a
prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete
tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource
limit.
public final String taskArn()
The Amazon Resource Name (ARN) of the task.
public final String taskDefinitionArn()
The ARN of the task definition that creates the task.
public final Long version()
The version counter for the task. Every time a task experiences a change that starts a CloudWatch event, the
version counter is incremented. If you replicate your Amazon ECS task state with CloudWatch Events, you can
compare the version of a task reported by the Amazon ECS API actions 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.
detail object) to verify that the version in your
event stream is current.public final EphemeralStorage ephemeralStorage()
The ephemeral storage settings for the task.
public Task.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<Task.Builder,Task>public static Task.Builder builder()
public static Class<? extends Task.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
Copyright © 2023. All rights reserved.