TaskSet (AWS SDK for Java

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

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<TaskSet.Builder,TaskSet>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class TaskSet
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<TaskSet.Builder,TaskSet>
```
Information about a set of Amazon ECS tasks in an AWS CodeDeploy deployment. An Amazon ECS task set includes details such as the desired number of tasks, how many tasks are running, and whether the task set serves production traffic.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface TaskSet.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static TaskSet.Builder`	`builder()`
`Integer`	`computedDesiredCount()` The computed desired count for the task set.
`Instant`	`createdAt()` The Unix timestamp for when the task set was created.
`boolean`	`equals(Object obj)`
`String`	`externalId()` The deployment ID of the AWS CodeDeploy deployment.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`id()` The ID of the task set.
`LaunchType`	`launchType()` The launch type the tasks in the task set are using.
`String`	`launchTypeAsString()` The launch type the tasks in the task set are using.
`List<LoadBalancer>`	`loadBalancers()` Details on a load balancer that is used with a task set.
`NetworkConfiguration`	`networkConfiguration()` The network configuration for the task set.
`Integer`	`pendingCount()` The number of tasks in the task set that are in the `PENDING` status during a deployment.
`String`	`platformVersion()` The platform version on which the tasks in the task set are running.
`Integer`	`runningCount()` The number of tasks in the task set that are in the `RUNNING` status during a deployment.
`Scale`	`scale()` A floating-point percentage of the desired number of tasks to place and keep running in the service.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends TaskSet.Builder>`	`serializableBuilderClass()`
`StabilityStatus`	`stabilityStatus()` The stability status, which indicates whether the task set has reached a steady state.
`String`	`stabilityStatusAsString()` The stability status, which indicates whether the task set has reached a steady state.
`Instant`	`stabilityStatusAt()` The Unix timestamp for when the task set stability status was retrieved.
`String`	`startedBy()` The tag specified when a task set is started.
`String`	`status()` The status of the task set.
`String`	`taskDefinition()` The task definition the task set is using.
`String`	`taskSetArn()` The Amazon Resource Name (ARN) of the task set.
`TaskSet.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`
`Instant`	`updatedAt()` The Unix timestamp for when the task set was last updated.

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

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

- Method Detail
  - id
```
public String id()
```
    The ID of the task set.
    
    Returns:
    
    The ID of the task set.
  - taskSetArn
```
public String taskSetArn()
```
    The Amazon Resource Name (ARN) of the task set.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the task set.
  - startedBy
```
public String startedBy()
```
    The tag specified when a task set is started. If the task is started by an AWS CodeDeploy deployment, then the startedBy parameter is CODE_DEPLOY.
    
    Returns:
    
    The tag specified when a task set is started. If the task is started by an AWS CodeDeploy deployment, then the startedBy parameter is CODE_DEPLOY.
  - externalId
```
public String externalId()
```
    The deployment ID of the AWS CodeDeploy deployment.
    
    Returns:
    
    The deployment ID of the AWS CodeDeploy deployment.
  - status
```
public String status()
```
    The status of the task set. The following describes each state:
    
    PRIMARY
    
    The task set is serving production traffic.
    
    ACTIVE
    
    The task set is not serving production traffic.
    
    DRAINING
    
    The tasks in the task set are being stopped and their corresponding targets are being deregistered from their target group.
    
    Returns:
    
    The status of the task set. The following describes each state:
    
    PRIMARY
    
    The task set is serving production traffic.
    
    ACTIVE
    
    The task set is not serving production traffic.
    
    DRAINING
    
    The tasks in the task set are being stopped and their corresponding targets are being deregistered from their target group.
  - taskDefinition
```
public String taskDefinition()
```
    The task definition the task set is using.
    
    Returns:
    
    The task definition the task set is using.
  - computedDesiredCount
```
public Integer computedDesiredCount()
```
    The computed desired count for the task set. This is calculated by multiplying the service's desiredCount by the task set's scale percentage.
    
    Returns:
    
    The computed desired count for the task set. This is calculated by multiplying the service's desiredCount by the task set's scale percentage.
  - pendingCount
```
public Integer pendingCount()
```
    The number of tasks in the task set that are in the PENDING status during a deployment. A task in the PENDING state is preparing to enter the RUNNING state. A task set enters the PENDING status when it launches for the first time, or when it is restarted after being in the STOPPED state.
    
    Returns:
    
    The number of tasks in the task set that are in the PENDING status during a deployment. A task in the PENDING state is preparing to enter the RUNNING state. A task set enters the PENDING status when it launches for the first time, or when it is restarted after being in the STOPPED state.
  - runningCount
```
public Integer runningCount()
```
    The number of tasks in the task set that are in the RUNNING status during a deployment. A task in the RUNNING state is running and ready for use.
    
    Returns:
    
    The number of tasks in the task set that are in the RUNNING status during a deployment. A task in the RUNNING state is running and ready for use.
  - createdAt
```
public Instant createdAt()
```
    The Unix timestamp for when the task set was created.
    
    Returns:
    
    The Unix timestamp for when the task set was created.
  - updatedAt
```
public Instant updatedAt()
```
    The Unix timestamp for when the task set was last updated.
    
    Returns:
    
    The Unix timestamp for when the task set was last updated.
  - launchType
```
public LaunchType launchType()
```
    The launch type the tasks in the task set are using. 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 the tasks in the task set are using. 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 the tasks in the task set are using. 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 the tasks in the task set are using. 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 the tasks in the task set are 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 the tasks in the task set are 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.
  - networkConfiguration
```
public NetworkConfiguration networkConfiguration()
```
    The network configuration for the task set.
    
    Returns:
    
    The network configuration for the task set.
  - loadBalancers
```
public List<LoadBalancer> loadBalancers()
```
    Details on a load balancer that is used with a task set.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    Details on a load balancer that is used with a task set.
  - scale
```
public Scale scale()
```
    A floating-point percentage of the desired number of tasks to place and keep running in the service.
    
    Returns:
    
    A floating-point percentage of the desired number of tasks to place and keep running in the service.
  - stabilityStatus
```
public StabilityStatus stabilityStatus()
```
    The stability status, which indicates whether the task set has reached a steady state. If the following conditions are met, the task set will be in STEADY_STATE:
    - The task runningCount is equal to the computedDesiredCount.
    - The pendingCount is 0.
    - There are no tasks running on container instances in the DRAINING status.
    - All tasks are reporting a healthy status from the load balancers, service discovery, and container health checks.
    If any of those conditions are not met, the stability status returns STABILIZING.
    
    If the service returns an enum value that is not available in the current SDK version, stabilityStatus will return StabilityStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stabilityStatusAsString().
    Returns:
    The stability status, which indicates whether the task set has reached a steady state. If the following conditions are met, the task set will be in STEADY_STATE:
    
    The task runningCount is equal to the computedDesiredCount.
    
    The pendingCount is 0.
    
    There are no tasks running on container instances in the DRAINING status.
    
    All tasks are reporting a healthy status from the load balancers, service discovery, and container health checks.
    
    If any of those conditions are not met, the stability status returns STABILIZING.
    See Also:
    
    StabilityStatus
  - stabilityStatusAsString
```
public String stabilityStatusAsString()
```
    The stability status, which indicates whether the task set has reached a steady state. If the following conditions are met, the task set will be in STEADY_STATE:
    - The task runningCount is equal to the computedDesiredCount.
    - The pendingCount is 0.
    - There are no tasks running on container instances in the DRAINING status.
    - All tasks are reporting a healthy status from the load balancers, service discovery, and container health checks.
    If any of those conditions are not met, the stability status returns STABILIZING.
    
    If the service returns an enum value that is not available in the current SDK version, stabilityStatus will return StabilityStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stabilityStatusAsString().
    Returns:
    The stability status, which indicates whether the task set has reached a steady state. If the following conditions are met, the task set will be in STEADY_STATE:
    
    The task runningCount is equal to the computedDesiredCount.
    
    The pendingCount is 0.
    
    There are no tasks running on container instances in the DRAINING status.
    
    All tasks are reporting a healthy status from the load balancers, service discovery, and container health checks.
    
    If any of those conditions are not met, the stability status returns STABILIZING.
    See Also:
    
    StabilityStatus
  - stabilityStatusAt
```
public Instant stabilityStatusAt()
```
    The Unix timestamp for when the task set stability status was retrieved.
    
    Returns:
    
    The Unix timestamp for when the task set stability status was retrieved.
  - toBuilder
```
public TaskSet.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<TaskSet.Builder,TaskSet>
    
    Returns:
    
    a builder for type T
  - builder
```
public static TaskSet.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends TaskSet.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()
```
    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
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

Class TaskSet

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

id

taskSetArn

startedBy

externalId

status

taskDefinition

computedDesiredCount

pendingCount

runningCount

createdAt

updatedAt

launchType

launchTypeAsString

platformVersion

networkConfiguration

loadBalancers

scale

stabilityStatus

stabilityStatusAsString

stabilityStatusAt

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields