com.amazonaws.services.iot.model

Class CancelJobRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.iot.model.CancelJobRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class CancelJobRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

Cancels a job.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CancelJobRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getComment() An optional comment string describing why the job was canceled.
java.lang.Boolean	getForce() (Optional) If true job executions with status "IN_PROGRESS" and "QUEUED" are canceled, otherwise only job executions with status "QUEUED" are canceled.
java.lang.String	getJobId() The unique identifier you assigned to this job when it was created.
java.lang.String	getReasonCode() (Optional)A reason code string that explains why the job was canceled.
int	hashCode()
java.lang.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(java.lang.String comment) An optional comment string describing why the job was canceled.
void	setForce(java.lang.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(java.lang.String jobId) The unique identifier you assigned to this job when it was created.
void	setReasonCode(java.lang.String reasonCode) (Optional)A reason code string that explains why the job was canceled.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
CancelJobRequest	withComment(java.lang.String comment) An optional comment string describing why the job was canceled.
CancelJobRequest	withForce(java.lang.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(java.lang.String jobId) The unique identifier you assigned to this job when it was created.
CancelJobRequest	withReasonCode(java.lang.String reasonCode) (Optional)A reason code string that explains why the job was canceled.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CancelJobRequest

public CancelJobRequest()

Method Detail

getJobId

public java.lang.String getJobId()

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

Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_-]+

Returns:

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

setJobId

public void setJobId(java.lang.String jobId)

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

Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_-]+

Parameters:

jobId -

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

withJobId

public CancelJobRequest withJobId(java.lang.String jobId)

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

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

Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_-]+

Parameters:

jobId -

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

Returns:

A reference to this updated object so that method calls can be chained together.

getReasonCode

public java.lang.String getReasonCode()

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

Constraints:
Length: - 128
Pattern: [\p{Upper}\p{Digit}_]+

Returns:

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

setReasonCode

public void setReasonCode(java.lang.String reasonCode)

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

Constraints:
Length: - 128
Pattern: [\p{Upper}\p{Digit}_]+

Parameters:

reasonCode -

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

withReasonCode

public CancelJobRequest withReasonCode(java.lang.String reasonCode)

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

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

Constraints:
Length: - 128
Pattern: [\p{Upper}\p{Digit}_]+

Parameters:

reasonCode -

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

Returns:

A reference to this updated object so that method calls can be chained together.

getComment

public java.lang.String getComment()

An optional comment string describing why the job was canceled.

Constraints:
Length: - 2028
Pattern: [^\p{C}]+

Returns:

An optional comment string describing why the job was canceled.

setComment

public void setComment(java.lang.String comment)

An optional comment string describing why the job was canceled.

Constraints:
Length: - 2028
Pattern: [^\p{C}]+

Parameters:

comment -

An optional comment string describing why the job was canceled.

withComment

public CancelJobRequest withComment(java.lang.String comment)

An optional comment string describing why the job was canceled.

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

Constraints:
Length: - 2028
Pattern: [^\p{C}]+

Parameters:

comment -

An optional comment string describing why the job was canceled.

Returns:

A reference to this updated object so that method calls can be chained together.

isForce

public java.lang.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.

getForce

public java.lang.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.

setForce

public void setForce(java.lang.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.

withForce

public CancelJobRequest withForce(java.lang.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.

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

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:

A reference to this updated object so that method calls can be chained together.

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object