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

Class StopTaskRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.ecs.model.EcsRequest

software.amazon.awssdk.services.ecs.model.StopTaskRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<StopTaskRequest.Builder,StopTaskRequest>

@Generated("software.amazon.awssdk:codegen")
public final class StopTaskRequest
extends EcsRequest
implements ToCopyableBuilder<StopTaskRequest.Builder,StopTaskRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StopTaskRequest.Builder

Method Summary

Modifier and Type	Method	Description
static StopTaskRequest.Builder	builder()
String	cluster()	The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task to stop.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	reason()	An optional message specified when a task is stopped.
List<SdkField<?>>	sdkFields()
static Class<? extends StopTaskRequest.Builder>	serializableBuilderClass()
String	task()	The task ID of the task to stop.
StopTaskRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

cluster

public final 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.

Returns:

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.

task

public final String task()

The task ID of the task to stop.

Returns:

The task ID of the task to stop.

reason

public final String reason()

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

Returns:

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

toBuilder

public StopTaskRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StopTaskRequest.Builder,StopTaskRequest>

Specified by:

toBuilder in class EcsRequest

builder

public static StopTaskRequest.Builder builder()

serializableBuilderClass

public static Class<? extends StopTaskRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo