com.amazonaws.services.ecs.model

Class StopTaskRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ecs.model.StopTaskRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class StopTaskRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
StopTaskRequest()

Method Summary

Methods

Modifier and Type	Method and Description
StopTaskRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getCluster() The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task to stop.
String	getReason() An optional message specified when a task is stopped.
String	getTask() The task ID or full Amazon Resource Name (ARN) entry of the task to stop.
int	hashCode()
void	setCluster(String cluster) The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task to stop.
void	setReason(String reason) An optional message specified when a task is stopped.
void	setTask(String task) The task ID or full Amazon Resource Name (ARN) entry of the task to stop.
String	toString() Returns a string representation of this object; useful for testing and debugging.
StopTaskRequest	withCluster(String cluster) The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task to stop.
StopTaskRequest	withReason(String reason) An optional message specified when a task is stopped.
StopTaskRequest	withTask(String task) The task ID or full Amazon Resource Name (ARN) entry of the task to stop.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

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

Constructor Detail

StopTaskRequest

public StopTaskRequest()

Method Detail

setCluster

public void setCluster(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..

getCluster

public String getCluster()

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

withCluster

public StopTaskRequest withCluster(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.

setTask

public void setTask(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.

getTask

public String getTask()

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.

withTask

public StopTaskRequest withTask(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.

setReason

public void setReason(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.

getReason

public String getReason()

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.

withReason

public StopTaskRequest withReason(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.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public StopTaskRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()