software.amazon.awssdk.services.ecs.model

Interface StopTaskRequest.Builder

All Superinterfaces:

AwsRequest.Builder, CopyableBuilder<StopTaskRequest.Builder,StopTaskRequest>, EcsRequest.Builder, SdkBuilder<StopTaskRequest.Builder,StopTaskRequest>, SdkRequest.Builder

Enclosing class:

StopTaskRequest

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

Method Summary

Modifier and Type	Method and 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	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
StopTaskRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
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.services.ecs.model.EcsRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

copy

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

applyMutation, 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.

overrideConfiguration

StopTaskRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

StopTaskRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.