public static interface Task.Builder extends CopyableBuilder<Task.Builder,Task>
Modifier and Type | Method and Description |
---|---|
Task.Builder |
attachments(Attachment... attachments)
The Elastic Network Adapter associated with the task if the task uses the
awsvpc network mode. |
Task.Builder |
attachments(Collection<Attachment> attachments)
The Elastic Network Adapter associated with the task if the task uses the
awsvpc network mode. |
Task.Builder |
clusterArn(String clusterArn)
The Amazon Resource Name (ARN) of the cluster that hosts the task.
|
Task.Builder |
containerInstanceArn(String containerInstanceArn)
The Amazon Resource Name (ARN) of the container instances that host the task.
|
Task.Builder |
containers(Collection<Container> containers)
The containers associated with the task.
|
Task.Builder |
containers(Container... containers)
The containers associated with the task.
|
Task.Builder |
createdAt(Instant createdAt)
The Unix timestamp for when the task was created (the task entered the
PENDING state). |
Task.Builder |
desiredStatus(String desiredStatus)
The desired status of the task.
|
Task.Builder |
group(String group)
The name of the task group associated with the task.
|
Task.Builder |
lastStatus(String lastStatus)
The last known status of the task.
|
default Task.Builder |
overrides(Consumer<TaskOverride.Builder> overrides)
One or more container overrides.
|
Task.Builder |
overrides(TaskOverride overrides)
One or more container overrides.
|
Task.Builder |
startedAt(Instant startedAt)
The Unix timestamp for when the task was started (the task transitioned from the
PENDING state
to the RUNNING state). |
Task.Builder |
startedBy(String startedBy)
The tag specified when a task is started.
|
Task.Builder |
stoppedAt(Instant stoppedAt)
The Unix timestamp for when the task was stopped (the task transitioned from the
RUNNING state
to the STOPPED state). |
Task.Builder |
stoppedReason(String stoppedReason)
The reason the task was stopped.
|
Task.Builder |
taskArn(String taskArn)
The Amazon Resource Name (ARN) of the task.
|
Task.Builder |
taskDefinitionArn(String taskDefinitionArn)
The Amazon Resource Name (ARN) of the task definition that creates the task.
|
Task.Builder |
version(Long version)
The version counter for the task.
|
copy
apply, build
Task.Builder taskArn(String taskArn)
The Amazon Resource Name (ARN) of the task.
taskArn
- The Amazon Resource Name (ARN) of the task.Task.Builder clusterArn(String clusterArn)
The Amazon Resource Name (ARN) of the cluster that hosts the task.
clusterArn
- The Amazon Resource Name (ARN) of the cluster that hosts the task.Task.Builder taskDefinitionArn(String taskDefinitionArn)
The Amazon Resource Name (ARN) of the task definition that creates the task.
taskDefinitionArn
- The Amazon Resource Name (ARN) of the task definition that creates the task.Task.Builder containerInstanceArn(String containerInstanceArn)
The Amazon Resource Name (ARN) of the container instances that host the task.
containerInstanceArn
- The Amazon Resource Name (ARN) of the container instances that host the task.Task.Builder overrides(TaskOverride overrides)
One or more container overrides.
overrides
- One or more container overrides.default Task.Builder overrides(Consumer<TaskOverride.Builder> overrides)
One or more container overrides.
This is a convenience that creates an instance of theTaskOverride.Builder
avoiding the need to
create one manually via TaskOverride.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and its
result is passed to overrides(TaskOverride)
.overrides
- a consumer that will call methods on TaskOverride.Builder
overrides(TaskOverride)
Task.Builder lastStatus(String lastStatus)
The last known status of the task.
lastStatus
- The last known status of the task.Task.Builder desiredStatus(String desiredStatus)
The desired status of the task.
desiredStatus
- The desired status of the task.Task.Builder containers(Collection<Container> containers)
The containers associated with the task.
containers
- The containers associated with the task.Task.Builder containers(Container... containers)
The containers associated with the task.
containers
- The containers associated with the task.Task.Builder startedBy(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
- 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.Task.Builder version(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.
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.Task.Builder stoppedReason(String stoppedReason)
The reason the task was stopped.
stoppedReason
- The reason the task was stopped.Task.Builder createdAt(Instant createdAt)
The Unix timestamp for when the task was created (the task entered the PENDING
state).
createdAt
- The Unix timestamp for when the task was created (the task entered the PENDING
state).Task.Builder startedAt(Instant startedAt)
The Unix timestamp for when the task was started (the task transitioned from the PENDING
state
to the RUNNING
state).
startedAt
- The Unix timestamp for when the task was started (the task transitioned from the PENDING
state to the RUNNING
state).Task.Builder stoppedAt(Instant stoppedAt)
The Unix timestamp for when the task was stopped (the task transitioned from the RUNNING
state
to the STOPPED
state).
stoppedAt
- The Unix timestamp for when the task was stopped (the task transitioned from the RUNNING
state to the STOPPED
state).Task.Builder group(String group)
The name of the task group associated with the task.
group
- The name of the task group associated with the task.Task.Builder attachments(Collection<Attachment> attachments)
The Elastic Network Adapter associated with the task if the task uses the awsvpc
network mode.
attachments
- The Elastic Network Adapter associated with the task if the task uses the awsvpc
network
mode.Task.Builder attachments(Attachment... attachments)
The Elastic Network Adapter associated with the task if the task uses the awsvpc
network mode.
attachments
- The Elastic Network Adapter associated with the task if the task uses the awsvpc
network
mode.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.