com.amazonaws.services.iot.model

Class CancelJobRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.iot.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:

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	getComment() An optional comment string describing why the job was canceled.
Boolean	getForce() (Optional) If true job executions with status "IN_PROGRESS" and "QUEUED" are canceled, otherwise only job executions with status "QUEUED" are canceled.
String	getJobId() The unique identifier you assigned to this job when it was created.
String	getReasonCode() (Optional)A reason code string that explains why the job was canceled.
int	hashCode()
Boolean	isForce() (Optional) If true job executions with status "IN_PROGRESS" and "QUEUED" are canceled, otherwise only job executions with status "QUEUED" are canceled.
void	setComment(String comment) An optional comment string describing why the job was canceled.
void	setForce(Boolean force) (Optional) If true job executions with status "IN_PROGRESS" and "QUEUED" are canceled, otherwise only job executions with status "QUEUED" are canceled.
void	setJobId(String jobId) The unique identifier you assigned to this job when it was created.
void	setReasonCode(String reasonCode) (Optional)A reason code string that explains why the job was canceled.
String	toString() Returns a string representation of this object.
CancelJobRequest	withComment(String comment) An optional comment string describing why the job was canceled.
CancelJobRequest	withForce(Boolean force) (Optional) If true job executions with status "IN_PROGRESS" and "QUEUED" are canceled, otherwise only job executions with status "QUEUED" are canceled.
CancelJobRequest	withJobId(String jobId) The unique identifier you assigned to this job when it was created.
CancelJobRequest	withReasonCode(String reasonCode) (Optional)A reason code string that explains why the job was canceled.

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 unique identifier you assigned to this job when it was created.

Parameters:

jobId - The unique identifier you assigned to this job when it was created.

getJobId

public String getJobId()

The unique identifier you assigned to this job when it was created.

Returns:

The unique identifier you assigned to this job when it was created.

withJobId

public CancelJobRequest withJobId(String jobId)

The unique identifier you assigned to this job when it was created.

Parameters:

jobId - The unique identifier you assigned to this job when it was created.

Returns:

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

setReasonCode

public void setReasonCode(String reasonCode)

(Optional)A reason code string that explains why the job was canceled.

Parameters:

reasonCode - (Optional)A reason code string that explains why the job was canceled.

getReasonCode

public String getReasonCode()

(Optional)A reason code string that explains why the job was canceled.

Returns:

(Optional)A reason code string that explains why the job was canceled.

withReasonCode

public CancelJobRequest withReasonCode(String reasonCode)

(Optional)A reason code string that explains why the job was canceled.

Parameters:

reasonCode - (Optional)A reason code string that explains why the job was canceled.

Returns:

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

setComment

public void setComment(String comment)

An optional comment string describing why the job was canceled.

Parameters:

comment - An optional comment string describing why the job was canceled.

getComment

public String getComment()

An optional comment string describing why the job was canceled.

Returns:

An optional comment string describing why the job was canceled.

withComment

public CancelJobRequest withComment(String comment)

An optional comment string describing why the job was canceled.

Parameters:

comment - An optional comment string describing why the job was canceled.

Returns:

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

setForce

public void setForce(Boolean force)

(Optional) If true job executions with status "IN_PROGRESS" and "QUEUED" are canceled, otherwise only job executions with status "QUEUED" are canceled. The default is false.

Canceling a job which is "IN_PROGRESS", will cause a device which is executing the job to be unable to update the job execution status. Use caution and ensure that each device executing a job which is canceled is able to recover to a valid state.

Parameters:

force - (Optional) If true job executions with status "IN_PROGRESS" and "QUEUED" are canceled, otherwise only job executions with status "QUEUED" are canceled. The default is false.

Canceling a job which is "IN_PROGRESS", will cause a device which is executing the job to be unable to update the job execution status. Use caution and ensure that each device executing a job which is canceled is able to recover to a valid state.

getForce

public Boolean getForce()

(Optional) If true job executions with status "IN_PROGRESS" and "QUEUED" are canceled, otherwise only job executions with status "QUEUED" are canceled. The default is false.

Canceling a job which is "IN_PROGRESS", will cause a device which is executing the job to be unable to update the job execution status. Use caution and ensure that each device executing a job which is canceled is able to recover to a valid state.

Returns:

(Optional) If true job executions with status "IN_PROGRESS" and "QUEUED" are canceled, otherwise only job executions with status "QUEUED" are canceled. The default is false.

Canceling a job which is "IN_PROGRESS", will cause a device which is executing the job to be unable to update the job execution status. Use caution and ensure that each device executing a job which is canceled is able to recover to a valid state.

withForce

public CancelJobRequest withForce(Boolean force)

(Optional) If true job executions with status "IN_PROGRESS" and "QUEUED" are canceled, otherwise only job executions with status "QUEUED" are canceled. The default is false.

Canceling a job which is "IN_PROGRESS", will cause a device which is executing the job to be unable to update the job execution status. Use caution and ensure that each device executing a job which is canceled is able to recover to a valid state.

Parameters:

force - (Optional) If true job executions with status "IN_PROGRESS" and "QUEUED" are canceled, otherwise only job executions with status "QUEUED" are canceled. The default is false.

Canceling a job which is "IN_PROGRESS", will cause a device which is executing the job to be unable to update the job execution status. Use caution and ensure that each device executing a job which is canceled is able to recover to a valid state.

Returns:

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

isForce

public Boolean isForce()

(Optional) If true job executions with status "IN_PROGRESS" and "QUEUED" are canceled, otherwise only job executions with status "QUEUED" are canceled. The default is false.

Canceling a job which is "IN_PROGRESS", will cause a device which is executing the job to be unable to update the job execution status. Use caution and ensure that each device executing a job which is canceled is able to recover to a valid state.

Returns:

(Optional) If true job executions with status "IN_PROGRESS" and "QUEUED" are canceled, otherwise only job executions with status "QUEUED" are canceled. The default is false.

Canceling a job which is "IN_PROGRESS", will cause a device which is executing the job to be unable to update the job execution status. Use caution and ensure that each device executing a job which is canceled is able to recover to a valid state.

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