Task (AWS SDK for Java - 2.0.0-preview-11)

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

All Implemented Interfaces:: StructuredPojo, ToCopyableBuilder<Task.Builder,Task>

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

Details on a task in a cluster.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Task.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<Attachment>`	`attachments()` The Elastic Network Adapter associated with the task if the task uses the `awsvpc` network mode.
`static Task.Builder`	`builder()`
`String`	`clusterArn()` The Amazon Resource Name (ARN) of the cluster that hosts the task.
`String`	`containerInstanceArn()` The Amazon Resource Name (ARN) of the container instances that host the task.
`List<Container>`	`containers()` The containers associated with the task.
`Instant`	`createdAt()` The Unix timestamp for when the task was created (the task entered the `PENDING` state).
`String`	`desiredStatus()` The desired status of the task.
`boolean`	`equals(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`String`	`group()` The name of the task group associated with the task.
`int`	`hashCode()`
`String`	`lastStatus()` The last known status of the task.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`TaskOverride`	`overrides()` One or more container overrides.
`static Class<? extends Task.Builder>`	`serializableBuilderClass()`
`Instant`	`startedAt()` The Unix timestamp for when the task was started (the task transitioned from the `PENDING` state to the `RUNNING` state).
`String`	`startedBy()` The tag specified when a task is started.
`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 the task was stopped.
`String`	`taskArn()` The Amazon Resource Name (ARN) of the task.
`String`	`taskDefinitionArn()` The Amazon Resource Name (ARN) of the task definition that creates the task.
`Task.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`
`Long`	`version()` The version counter for the task.

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
  - taskArn
```
public String taskArn()
```
    The Amazon Resource Name (ARN) of the task.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the task.
  - clusterArn
```
public String clusterArn()
```
    The Amazon Resource Name (ARN) of the cluster that hosts the task.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the cluster that hosts the task.
  - taskDefinitionArn
```
public String taskDefinitionArn()
```
    The Amazon Resource Name (ARN) of the task definition that creates the task.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the task definition that creates the task.
  - containerInstanceArn
```
public String containerInstanceArn()
```
    The Amazon Resource Name (ARN) of the container instances that host the task.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the container instances that host the task.
  - overrides
```
public TaskOverride overrides()
```
    One or more container overrides.
    
    Returns:
    
    One or more container overrides.
  - lastStatus
```
public String lastStatus()
```
    The last known status of the task.
    
    Returns:
    
    The last known status of the task.
  - desiredStatus
```
public String desiredStatus()
```
    The desired status of the task.
    
    Returns:
    
    The desired status of the task.
  - containers
```
public List<Container> containers()
```
    The containers associated with the task.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    The containers associated with the task.
  - startedBy
```
public String startedBy()
```
    The tag specified when a task is started. If the task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.
    
    Returns:
    
    The tag specified when a task is started. If the task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.
  - version
```
public Long version()
```
    The version counter for the task. Every time a task experiences a change that triggers a CloudWatch event, the version counter is incremented. If you are replicating your Amazon ECS task state with CloudWatch events, you can compare the version of a task reported by the Amazon ECS APIs with the version reported in CloudWatch events for the task (inside the detail object) to verify that the version in your event stream is current.
    
    Returns:
    
    The version counter for the task. Every time a task experiences a change that triggers a CloudWatch event, the version counter is incremented. If you are replicating your Amazon ECS task state with CloudWatch events, you can compare the version of a task reported by the Amazon ECS APIs with the version reported in CloudWatch events for the task (inside the detail object) to verify that the version in your event stream is current.
  - stoppedReason
```
public String stoppedReason()
```
    The reason the task was stopped.
    
    Returns:
    
    The reason the task was stopped.
  - createdAt
```
public Instant createdAt()
```
    The Unix timestamp for when the task was created (the task entered the PENDING state).
    
    Returns:
    
    The Unix timestamp for when the task was created (the task entered the PENDING state).
  - startedAt
```
public Instant startedAt()
```
    The Unix timestamp for when the task was started (the task transitioned from the PENDING state to the RUNNING state).
    
    Returns:
    
    The Unix timestamp for when the task was started (the task transitioned from the PENDING state to the RUNNING state).
  - stoppedAt
```
public Instant stoppedAt()
```
    The Unix timestamp for when the task was stopped (the task transitioned from the RUNNING state to the STOPPED state).
    
    Returns:
    
    The Unix timestamp for when the task was stopped (the task transitioned from the RUNNING state to the STOPPED state).
  - group
```
public String group()
```
    The name of the task group associated with the task.
    
    Returns:
    
    The name of the task group associated with the task.
  - attachments
```
public List<Attachment> attachments()
```
    The Elastic Network Adapter associated with the task if the task uses the awsvpc network mode.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    The Elastic Network Adapter associated with the task if the task uses the awsvpc network mode.
  - 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 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)
```
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Class Task

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

taskArn

clusterArn

taskDefinitionArn

containerInstanceArn

overrides

lastStatus

desiredStatus

containers

startedBy

version

stoppedReason

createdAt

startedAt

stoppedAt

group

attachments

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

marshall