@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 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 of the task.
|
static Task.Builder |
builder() |
String |
capacityProviderName()
The capacity provider 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 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 |
enableExecuteCommand()
Whether or not execute command functionality is enabled for this task.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(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.
|
boolean |
hasAttachments()
Returns true if the Attachments property was specified by the sender (it may be empty), or false if the sender
did not specify the value (it will be empty).
|
boolean |
hasAttributes()
Returns true if the Attributes property was specified by the sender (it may be empty), or false if the sender did
not specify the value (it will be empty).
|
boolean |
hasContainers()
Returns true if the Containers property was specified by the sender (it may be empty), or false if the sender did
not specify the value (it will be empty).
|
int |
hashCode() |
boolean |
hasInferenceAccelerators()
Returns true if the InferenceAccelerators property was specified by the sender (it may be empty), or false if the
sender did not specify the value (it will be empty).
|
boolean |
hasTags()
Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not
specify the value (it will be empty).
|
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.
|
List<InferenceAccelerator> |
inferenceAccelerators()
The Elastic Inference accelerator associated with 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.
|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public final boolean hasAttachments()
public final 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.
You can use hasAttachments()
to see if a value was sent in this field.
awsvpc
network
mode.public final boolean hasAttributes()
public final List<Attribute> attributes()
The attributes of the task
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasAttributes()
to see if a value was sent in this field.
public final String availabilityZone()
The availability zone of the task.
public final String capacityProviderName()
The capacity provider 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()
.
Connectivity
public 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()
.
Connectivity
public final Instant connectivityAt()
The Unix timestamp for 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()
public final List<Container> containers()
The containers associated with the task.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasContainers()
to see if a value was sent in this field.
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 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)
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)
public final Instant createdAt()
The Unix timestamp for when the task was created (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()
Whether or not execute command functionality is enabled for this task. If true
, this enables execute
command functionality on all containers in the task.
true
, this enables
execute command functionality on all containers in the task.public final Instant executionStoppedAt()
The Unix timestamp for when the task execution stopped.
public final String group()
The name of the task group associated with the task.
public final 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()
.
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.
HealthStatus
public final 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()
.
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.
HealthStatus
public final boolean hasInferenceAccelerators()
public final List<InferenceAccelerator> inferenceAccelerators()
The Elastic Inference accelerator associated with the task.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasInferenceAccelerators()
to see if a value was sent in this field.
public final String lastStatus()
The last known status of the task. For more information, see Task Lifecycle.
public final 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()
.
LaunchType
public final 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()
.
LaunchType
public final 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)
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)
public final TaskOverride overrides()
One or more container overrides.
public final 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.
LATEST
platform version is used by
default. For more information, see AWS Fargate
Platform Versions in the Amazon Elastic Container Service Developer Guide.public final Instant pullStartedAt()
The Unix timestamp for when the container image pull began.
public final Instant pullStoppedAt()
The Unix timestamp for when the container image pull completed.
public final Instant startedAt()
The Unix timestamp for when the task started (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 the task is started by an Amazon ECS service, then the
startedBy
parameter contains the deployment ID of the service that starts it.
startedBy
parameter contains the deployment ID of the service that starts it.public final 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()
.
stoppedReason
may contain additional
details.TaskStopCode
public final 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()
.
stoppedReason
may contain additional
details.TaskStopCode
public final Instant stoppedAt()
The Unix timestamp for when the task was stopped (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 when the task stops (transitions from the RUNNING
state to
STOPPED
).
RUNNING
state to
STOPPED
).public final boolean hasTags()
public final 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.
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 AWS 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.
You can use hasTags()
to see if a value was sent in this field.
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 AWS 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 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 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 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 SdkPojo
public final String toString()
Copyright © 2021. All rights reserved.