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

Interface StopTaskRequest.Builder

All Superinterfaces:

CopyableBuilder<StopTaskRequest.Builder,StopTaskRequest>, SdkBuilder<StopTaskRequest.Builder,StopTaskRequest>

Enclosing class:

StopTaskRequest

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

Method Summary

Modifier and Type	Method	Description
StopTaskRequest.Builder	cluster(String cluster)	The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task to stop.
StopTaskRequest.Builder	reason(String reason)	An optional message specified when a task is stopped.
StopTaskRequest.Builder	task(String task)	The task ID or full Amazon Resource Name (ARN) entry of the task to stop.

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

cluster

StopTaskRequest.Builder cluster(String cluster)

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task to stop. If you do not specify a cluster, the default cluster is assumed.

Parameters:

cluster - The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task to stop. If you do not specify a cluster, the default cluster is assumed.

Returns:

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

task

StopTaskRequest.Builder task(String task)

The task ID or full Amazon Resource Name (ARN) entry of the task to stop.

Parameters:

task - The task ID or full Amazon Resource Name (ARN) entry of the task to stop.

Returns:

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

reason

StopTaskRequest.Builder reason(String reason)

An optional message specified when a task is stopped. For example, if you are using a custom scheduler, you can use this parameter to specify the reason for stopping the task here, and the message will appear in subsequent DescribeTasks API operations on this task. Up to 255 characters are allowed in this message.

Parameters:

reason - An optional message specified when a task is stopped. For example, if you are using a custom scheduler, you can use this parameter to specify the reason for stopping the task here, and the message will appear in subsequent DescribeTasks API operations on this task. Up to 255 characters are allowed in this message.

Returns:

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