Class StopTaskRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
Creates a shallow clone of this request.boolean
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task to stop.An optional message specified when a task is stopped.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
An optional message specified when a task is stopped.void
The task ID or full Amazon Resource Name (ARN) entry of the task to stop.toString()
Returns a string representation of this object; useful for testing and debugging.withCluster
(String cluster) The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task to stop.withReason
(String reason) An optional message specified when a task is stopped.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, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
Constructor Details
-
StopTaskRequest
public StopTaskRequest()
-
-
Method Details
-
setCluster
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
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
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
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
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
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
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
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
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
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
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 classAmazonWebServiceRequest
- See Also:
-