com.amazonaws.services.batch.model

Class CancelJobRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.batch.model.CancelJobRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CancelJobRequest
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
CancelJobRequest()

Method Summary

Modifier and Type	Method and Description
CancelJobRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getJobId() The AWS Batch job ID of the job to cancel.
String	getReason() A message to attach to the job that explains the reason for cancelling it.
int	hashCode()
void	setJobId(String jobId) The AWS Batch job ID of the job to cancel.
void	setReason(String reason) A message to attach to the job that explains the reason for cancelling it.
String	toString() Returns a string representation of this object; useful for testing and debugging.
CancelJobRequest	withJobId(String jobId) The AWS Batch job ID of the job to cancel.
CancelJobRequest	withReason(String reason) A message to attach to the job that explains the reason for cancelling it.

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

CancelJobRequest

public CancelJobRequest()

Method Detail

setJobId

public void setJobId(String jobId)

The AWS Batch job ID of the job to cancel.

Parameters:

jobId - The AWS Batch job ID of the job to cancel.

getJobId

public String getJobId()

The AWS Batch job ID of the job to cancel.

Returns:

The AWS Batch job ID of the job to cancel.

withJobId

public CancelJobRequest withJobId(String jobId)

The AWS Batch job ID of the job to cancel.

Parameters:

jobId - The AWS Batch job ID of the job to cancel.

Returns:

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

setReason

public void setReason(String reason)

A message to attach to the job that explains the reason for cancelling it. This message is returned by future DescribeJobs operations on the job. This message is also recorded in the AWS Batch activity logs.

Parameters:

reason - A message to attach to the job that explains the reason for cancelling it. This message is returned by future DescribeJobs operations on the job. This message is also recorded in the AWS Batch activity logs.

getReason

public String getReason()

A message to attach to the job that explains the reason for cancelling it. This message is returned by future DescribeJobs operations on the job. This message is also recorded in the AWS Batch activity logs.

Returns:

A message to attach to the job that explains the reason for cancelling it. This message is returned by future DescribeJobs operations on the job. This message is also recorded in the AWS Batch activity logs.

withReason

public CancelJobRequest withReason(String reason)

A message to attach to the job that explains the reason for cancelling it. This message is returned by future DescribeJobs operations on the job. This message is also recorded in the AWS Batch activity logs.

Parameters:

reason - A message to attach to the job that explains the reason for cancelling it. This message is returned by future DescribeJobs operations on the job. This message is also recorded in the AWS Batch activity logs.

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 CancelJobRequest 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()