All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class StopTaskRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable 

See Also:

AWS API Documentation, Serialized Form

• Field Summary

  • Fields inherited from class com.amazonaws.AmazonWebServiceRequest

    NOOP

• Constructor Summary

  Constructors

  Constructor and Description
  StopTaskRequest ()

• Method Summary

  All Methods

  Modifier and Type	Method and Description
  StopTaskRequest	clone () Creates a shallow clone of this object for all fields except the handler context.
  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 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 of the task to stop.
  String	toString () Returns a string representation of this object.
  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 of the task to stop.

  • Methods inherited from class com.amazonaws.AmazonWebServiceRequest

    addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

  • Methods inherited from class java.lang.Object

    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 of the task to stop.

    Parameters:

    task - The task ID of the task to stop.

  • getTask

    public String getTask()

    The task ID of the task to stop.

    Returns:

    The task ID of the task to stop.

  • withTask

    public StopTaskRequest withTask(String task)

    The task ID of the task to stop.

    Parameters:

    task - The task ID 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'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.

    Parameters:

    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.

  • getReason

    public String getReason()

    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.

    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.

  • withReason

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

    Parameters:

    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.

    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. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

    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 object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

    Overrides:

    clone in class AmazonWebServiceRequest

    See Also:

    Object.clone()