Class Task

java.lang.Object
software.amazon.awssdk.services.ecs.model.Task
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Task.Builder,Task>
@Generated("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:

  • Method Details

    • hasAttachments

      public final boolean hasAttachments()
      For responses, this returns true if the service returned a value for the Attachments property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

    • attachments

      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.

      Returns:
      The Elastic Network Adapter that's associated with the task if the task uses the awsvpc network mode.

    • hasAttributes

      public final boolean hasAttributes()
      For responses, this returns true if the service returned a value for the Attributes property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

    • attributes

      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.

      Returns:
      The attributes of the task

    • availabilityZone

      public final String availabilityZone()

      The Availability Zone for the task.

      Returns:
      The Availability Zone for the task.

    • capacityProviderName

      public final String capacityProviderName()

      The capacity provider that's associated with the task.

      Returns:
      The capacity provider that's associated with the task.

    • clusterArn

      public final String clusterArn()

      The ARN of the cluster that hosts the task.

      Returns:
      The ARN of the cluster that hosts the task.

    • connectivity

      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().

      Returns:
      The connectivity status of a task.
      See Also:

    • connectivityAsString

      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().

      Returns:
      The connectivity status of a task.
      See Also:

    • connectivityAt

      public final Instant connectivityAt()

      The Unix timestamp for the time when the task last went into CONNECTED status.

      Returns:
      The Unix timestamp for the time when the task last went into CONNECTED status.

    • containerInstanceArn

      public final String containerInstanceArn()

      The ARN of the container instances that host the task.

      Returns:
      The ARN of the container instances that host the task.

    • hasContainers

      public final boolean hasContainers()
      For responses, this returns true if the service returned a value for the Containers property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

    • containers

      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.

      Returns:
      The containers that's associated with the task.

    • cpu

      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're using the EC2 launch type or the external launch type, this field is optional. Supported values are between 128 CPU units (0.125 vCPUs) and 196608 CPU units (192 vCPUs). If you do not specify a value, the parameter is ignored.

      This field is required for Fargate. For information about the valid values, see Task size in the Amazon Elastic Container Service Developer Guide.

      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 that indicates the CPU units when the task definition is registered.

      If you're using the EC2 launch type or the external launch type, this field is optional. Supported values are between 128 CPU units (0.125 vCPUs) and 196608 CPU units ( 192 vCPUs). If you do not specify a value, the parameter is ignored.

      This field is required for Fargate. For information about the valid values, see Task size in the Amazon Elastic Container Service Developer Guide.

    • createdAt

      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.

      Returns:
      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.

    • desiredStatus

      public final 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.

    • enableExecuteCommand

      public final Boolean enableExecuteCommand()

      Determines whether execute command functionality is turned on for this task. If true, execute command functionality is turned on all the containers in the task.

      Returns:
      Determines whether execute command functionality is turned on for this task. If true, execute command functionality is turned on all the containers in the task.

    • executionStoppedAt

      public final Instant executionStoppedAt()

      The Unix timestamp for the time when the task execution stopped.

      Returns:
      The Unix timestamp for the time when the task execution stopped.

    • group

      public final String group()

      The name of the task group that's associated with the task.

      Returns:
      The name of the task group that's associated with the task.

    • healthStatus

      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().

      Returns:
      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.

      See Also:

    • healthStatusAsString

      public 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().

      Returns:
      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.

      See Also:

    • hasInferenceAccelerators

      public final boolean hasInferenceAccelerators()
      For responses, this returns true if the service returned a value for the InferenceAccelerators property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

    • inferenceAccelerators

      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.

      Returns:
      The Elastic Inference accelerator that's associated with the task.

    • lastStatus

      public final String lastStatus()

      The last known status for the task. For more information, see Task Lifecycle.

      Returns:
      The last known status for the task. For more information, see Task Lifecycle.

    • launchType

      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().

      Returns:
      The infrastructure where your task runs on. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.
      See Also:

    • launchTypeAsString

      public 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().

      Returns:
      The infrastructure where your task runs on. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.
      See Also:

    • memory

      public 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.

      Returns:
      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.

    • overrides

      public final TaskOverride overrides()

      One or more container overrides.

      Returns:
      One or more container overrides.

    • platformVersion

      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.

      Returns:
      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.

    • platformFamily

      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.).

      Returns:
      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.).

    • pullStartedAt

      public final Instant pullStartedAt()

      The Unix timestamp for the time when the container image pull began.

      Returns:
      The Unix timestamp for the time when the container image pull began.

    • pullStoppedAt

      public final Instant pullStoppedAt()

      The Unix timestamp for the time when the container image pull completed.

      Returns:
      The Unix timestamp for the time when the container image pull completed.

    • startedAt

      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.

      Returns:
      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.

    • startedBy

      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.

      Returns:
      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.

    • stopCode

      public final TaskStopCode stopCode()

      The stop code indicating why a task was stopped. The stoppedReason might contain additional details.

      For more information about stop code, see Stopped tasks error codes in the Amazon ECS Developer Guide.

      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 might contain additional details.

      For more information about stop code, see Stopped tasks error codes in the Amazon ECS Developer Guide.

      See Also:

    • stopCodeAsString

      public final String stopCodeAsString()

      The stop code indicating why a task was stopped. The stoppedReason might contain additional details.

      For more information about stop code, see Stopped tasks error codes in the Amazon ECS Developer Guide.

      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 might contain additional details.

      For more information about stop code, see Stopped tasks error codes in the Amazon ECS Developer Guide.

      See Also:

    • stoppedAt

      public 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.

      Returns:
      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.

    • stoppedReason

      public final String stoppedReason()

      The reason that the task was stopped.

      Returns:
      The reason that the task was stopped.

    • stoppingAt

      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 STOPPING.

      Returns:
      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 STOPPING.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

    • tags

      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.

      Returns:
      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.

    • taskArn

      public final String taskArn()

      The Amazon Resource Name (ARN) of the task.

      Returns:
      The Amazon Resource Name (ARN) of the task.

    • taskDefinitionArn

      public final String taskDefinitionArn()

      The ARN of the task definition that creates the task.

      Returns:
      The ARN of the task definition that creates the task.

    • version

      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.

      Returns:
      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.

    • ephemeralStorage

      public final EphemeralStorage ephemeralStorage()

      The ephemeral storage settings for the task.

      Returns:
      The ephemeral storage settings for the task.

    • fargateEphemeralStorage

      public final TaskEphemeralStorage fargateEphemeralStorage()

      The Fargate ephemeral storage settings for the task.

      Returns:
      The Fargate ephemeral storage settings for the task.

    • toBuilder

      public Task.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<Task.Builder,Task>
      Returns:
      a builder for type T

    • builder

      public static Task.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Task.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final 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 final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.