Package software.amazon.awssdk.services.ecs.model

Interface Task.Builder

All Superinterfaces:

CopyableBuilder<Task.Builder,Task>, SdkBuilder<Task.Builder,Task>

Enclosing class:

Task

public static interface Task.Builder
extends CopyableBuilder<Task.Builder,Task>

Method Summary

Modifier and Type	Method	Description
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(Date 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.
Task.Builder	overrides(TaskOverride overrides)	One or more container overrides.
Task.Builder	startedAt(Date 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(Date 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.

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

copy

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

apply, build

Method Detail

taskArn

Task.Builder taskArn(String taskArn)

The Amazon Resource Name (ARN) of the task.

Parameters:

taskArn - The Amazon Resource Name (ARN) of the task.

Returns:

Returns a reference to this object so that method calls can be chained together.

clusterArn

Task.Builder clusterArn(String clusterArn)

The Amazon Resource Name (ARN) of the cluster that hosts the task.

Parameters:

clusterArn - The Amazon Resource Name (ARN) of the cluster that hosts the task.

Returns:

Returns a reference to this object so that method calls can be chained together.

taskDefinitionArn

Task.Builder taskDefinitionArn(String taskDefinitionArn)

The Amazon Resource Name (ARN) of the task definition that creates the task.

Parameters:

taskDefinitionArn - The Amazon Resource Name (ARN) of the task definition that creates the task.

Returns:

Returns a reference to this object so that method calls can be chained together.

containerInstanceArn

Task.Builder containerInstanceArn(String containerInstanceArn)

The Amazon Resource Name (ARN) of the container instances that host the task.

Parameters:

containerInstanceArn - The Amazon Resource Name (ARN) of the container instances that host the task.

Returns:

Returns a reference to this object so that method calls can be chained together.

overrides

Task.Builder overrides(TaskOverride overrides)

One or more container overrides.

Parameters:

overrides - One or more container overrides.

Returns:

Returns a reference to this object so that method calls can be chained together.

lastStatus

Task.Builder lastStatus(String lastStatus)

The last known status of the task.

Parameters:

lastStatus - The last known status of the task.

Returns:

Returns a reference to this object so that method calls can be chained together.

desiredStatus

Task.Builder desiredStatus(String desiredStatus)

The desired status of the task.

Parameters:

desiredStatus - The desired status of the task.

Returns:

Returns a reference to this object so that method calls can be chained together.

containers

Task.Builder containers(Collection<Container> containers)

The containers associated with the task.

Parameters:

containers - The containers associated with the task.

Returns:

Returns a reference to this object so that method calls can be chained together.

containers

Task.Builder containers(Container... containers)

The containers associated with the task.

NOTE: This method appends the values to the existing list (if any). Use #setContainers(java.util.Collection) or #withContainers(java.util.Collection) if you want to override the existing values.

Parameters:

containers - The containers associated with the task.

Returns:

Returns a reference to this object so that method calls can be chained together.

startedBy

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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

version

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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

stoppedReason

Task.Builder stoppedReason(String stoppedReason)

The reason the task was stopped.

Parameters:

stoppedReason - The reason the task was stopped.

Returns:

Returns a reference to this object so that method calls can be chained together.

createdAt

Task.Builder createdAt(Date createdAt)

The Unix timestamp for when the task was created (the task entered the PENDING state).

Parameters:

createdAt - The Unix timestamp for when the task was created (the task entered the PENDING state).

Returns:

Returns a reference to this object so that method calls can be chained together.

startedAt

Task.Builder startedAt(Date startedAt)

The Unix timestamp for when the task was started (the task transitioned from the PENDING state to the RUNNING state).

Parameters:

startedAt - The Unix timestamp for when the task was started (the task transitioned from the PENDING state to the RUNNING state).

Returns:

Returns a reference to this object so that method calls can be chained together.

stoppedAt

Task.Builder stoppedAt(Date stoppedAt)

The Unix timestamp for when the task was stopped (the task transitioned from the RUNNING state to the STOPPED state).

Parameters:

stoppedAt - The Unix timestamp for when the task was stopped (the task transitioned from the RUNNING state to the STOPPED state).

Returns:

Returns a reference to this object so that method calls can be chained together.

group

Task.Builder group(String group)

The name of the task group associated with the task.

Parameters:

group - The name of the task group associated with the task.

Returns:

Returns a reference to this object so that method calls can be chained together.