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

Container for the parameters to the StopTask operation.

Stops a running task.

When StopTask is called on a task, the equivalent of docker stop is issued to the containers running in the task. This results in a SIGTERM and a 30-second timeout, after which SIGKILL is sent and the containers are forcibly stopped. If the container handles the SIGTERM gracefully and exits within 30 seconds from receiving it, no SIGKILL is sent.

See Also:

AmazonECS.stopTask(StopTaskRequest), 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()
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	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	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	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, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

StopTaskRequest

public StopTaskRequest()

Method Detail

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

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

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

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

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:

A reference to this updated object so that method calls can be chained together.

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.

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.

withTask

public StopTaskRequest withTask(String task)

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

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

Parameters:

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

Returns:

A reference to this updated 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()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public StopTaskRequest clone()

Overrides:

clone in class AmazonWebServiceRequest