com.amazonaws.services.batch.model

Class TerminateJobRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.batch.model.TerminateJobRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

Contains the parameters for TerminateJob.

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
TerminateJobRequest()

Method Summary

Modifier and Type	Method and Description
TerminateJobRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getJobId() The Batch job ID of the job to terminate.
String	getReason() A message to attach to the job that explains the reason for canceling it.
int	hashCode()
void	setJobId(String jobId) The Batch job ID of the job to terminate.
void	setReason(String reason) A message to attach to the job that explains the reason for canceling it.
String	toString() Returns a string representation of this object.
TerminateJobRequest	withJobId(String jobId) The Batch job ID of the job to terminate.
TerminateJobRequest	withReason(String reason) A message to attach to the job that explains the reason for canceling 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

TerminateJobRequest

public TerminateJobRequest()

Method Detail

setJobId

public void setJobId(String jobId)

The Batch job ID of the job to terminate.

Parameters:

jobId - The Batch job ID of the job to terminate.

getJobId

public String getJobId()

The Batch job ID of the job to terminate.

Returns:

The Batch job ID of the job to terminate.

withJobId

public TerminateJobRequest withJobId(String jobId)

The Batch job ID of the job to terminate.

Parameters:

jobId - The Batch job ID of the job to terminate.

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 canceling it. This message is returned by future DescribeJobs operations on the job. This message is also recorded in the Batch activity logs.

Parameters:

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

getReason

public String getReason()

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

Returns:

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

withReason

public TerminateJobRequest withReason(String reason)

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

Parameters:

reason - A message to attach to the job that explains the reason for canceling it. This message is returned by future DescribeJobs operations on the job. This message is also recorded in the 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. 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 TerminateJobRequest 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()