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

Class StopTaskRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

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

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<StopTaskRequest.Builder,StopTaskRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StopTaskRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

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)
int	hashCode()
String	reason()	An optional message specified when a task is stopped.
static Class<? extends StopTaskRequest.Builder>	serializableBuilderClass()
String	task()	The task ID or full Amazon Resource Name (ARN) entry of the task to stop.
StopTaskRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

cluster

public 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 String task()

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

Returns:

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

reason

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

Returns:

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.

toBuilder

public StopTaskRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<StopTaskRequest.Builder,StopTaskRequest>

Returns:

a builder for type T

builder

public static StopTaskRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object