com.amazonaws.services.iot.model

Class CancelJobExecutionRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.iot.model.CancelJobExecutionRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class CancelJobExecutionRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

Cancels the execution of a job for a given thing.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CancelJobExecutionRequest()

Method Summary

Modifier and Type	Method and Description
CancelJobExecutionRequest	addstatusDetailsEntry(java.lang.String key, java.lang.String value) A collection of name/value pairs that describe the status of the job execution.
CancelJobExecutionRequest	clearstatusDetailsEntries() Removes all the entries added into statusDetails.
boolean	equals(java.lang.Object obj)
java.lang.Long	getExpectedVersion() (Optional) The expected current version of the job execution.
java.lang.Boolean	getForce() (Optional) If true the job execution will be canceled if it has status IN_PROGRESS or QUEUED, otherwise the job execution will be canceled only if it has status QUEUED.
java.lang.String	getJobId() The ID of the job to be canceled.
java.util.Map<java.lang.String,java.lang.String>	getStatusDetails() A collection of name/value pairs that describe the status of the job execution.
java.lang.String	getThingName() The name of the thing whose execution of the job will be canceled.
int	hashCode()
java.lang.Boolean	isForce() (Optional) If true the job execution will be canceled if it has status IN_PROGRESS or QUEUED, otherwise the job execution will be canceled only if it has status QUEUED.
void	setExpectedVersion(java.lang.Long expectedVersion) (Optional) The expected current version of the job execution.
void	setForce(java.lang.Boolean force) (Optional) If true the job execution will be canceled if it has status IN_PROGRESS or QUEUED, otherwise the job execution will be canceled only if it has status QUEUED.
void	setJobId(java.lang.String jobId) The ID of the job to be canceled.
void	setStatusDetails(java.util.Map<java.lang.String,java.lang.String> statusDetails) A collection of name/value pairs that describe the status of the job execution.
void	setThingName(java.lang.String thingName) The name of the thing whose execution of the job will be canceled.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
CancelJobExecutionRequest	withExpectedVersion(java.lang.Long expectedVersion) (Optional) The expected current version of the job execution.
CancelJobExecutionRequest	withForce(java.lang.Boolean force) (Optional) If true the job execution will be canceled if it has status IN_PROGRESS or QUEUED, otherwise the job execution will be canceled only if it has status QUEUED.
CancelJobExecutionRequest	withJobId(java.lang.String jobId) The ID of the job to be canceled.
CancelJobExecutionRequest	withStatusDetails(java.util.Map<java.lang.String,java.lang.String> statusDetails) A collection of name/value pairs that describe the status of the job execution.
CancelJobExecutionRequest	withThingName(java.lang.String thingName) The name of the thing whose execution of the job will be 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

CancelJobExecutionRequest

public CancelJobExecutionRequest()

Method Detail

getJobId

public java.lang.String getJobId()

The ID of the job to be canceled.

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

Returns:

The ID of the job to be canceled.

setJobId

public void setJobId(java.lang.String jobId)

The ID of the job to be canceled.

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

Parameters:

jobId -

The ID of the job to be canceled.

withJobId

public CancelJobExecutionRequest withJobId(java.lang.String jobId)

The ID of the job to be canceled.

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 ID of the job to be canceled.

Returns:

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

getThingName

public java.lang.String getThingName()

The name of the thing whose execution of the job will be canceled.

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

Returns:

The name of the thing whose execution of the job will be canceled.

setThingName

public void setThingName(java.lang.String thingName)

The name of the thing whose execution of the job will be canceled.

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

Parameters:

thingName -

The name of the thing whose execution of the job will be canceled.

withThingName

public CancelJobExecutionRequest withThingName(java.lang.String thingName)

The name of the thing whose execution of the job will be canceled.

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

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

Parameters:

thingName -

The name of the thing whose execution of the job will be 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 the job execution will be canceled if it has status IN_PROGRESS or QUEUED, otherwise the job execution will be canceled only if it has status QUEUED. If you attempt to cancel a job execution that is IN_PROGRESS, and you do not set force to true, then an InvalidStateTransitionException will be thrown. The default is false.

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

Returns:

(Optional) If true the job execution will be canceled if it has status IN_PROGRESS or QUEUED, otherwise the job execution will be canceled only if it has status QUEUED. If you attempt to cancel a job execution that is IN_PROGRESS, and you do not set force to true, then an InvalidStateTransitionException will be thrown. The default is false.

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

getForce

public java.lang.Boolean getForce()

(Optional) If true the job execution will be canceled if it has status IN_PROGRESS or QUEUED, otherwise the job execution will be canceled only if it has status QUEUED. If you attempt to cancel a job execution that is IN_PROGRESS, and you do not set force to true, then an InvalidStateTransitionException will be thrown. The default is false.

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

Returns:

(Optional) If true the job execution will be canceled if it has status IN_PROGRESS or QUEUED, otherwise the job execution will be canceled only if it has status QUEUED. If you attempt to cancel a job execution that is IN_PROGRESS, and you do not set force to true, then an InvalidStateTransitionException will be thrown. The default is false.

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

setForce

public void setForce(java.lang.Boolean force)

(Optional) If true the job execution will be canceled if it has status IN_PROGRESS or QUEUED, otherwise the job execution will be canceled only if it has status QUEUED. If you attempt to cancel a job execution that is IN_PROGRESS, and you do not set force to true, then an InvalidStateTransitionException will be thrown. The default is false.

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

Parameters:

force -

(Optional) If true the job execution will be canceled if it has status IN_PROGRESS or QUEUED, otherwise the job execution will be canceled only if it has status QUEUED. If you attempt to cancel a job execution that is IN_PROGRESS, and you do not set force to true, then an InvalidStateTransitionException will be thrown. The default is false.

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

withForce

public CancelJobExecutionRequest withForce(java.lang.Boolean force)

(Optional) If true the job execution will be canceled if it has status IN_PROGRESS or QUEUED, otherwise the job execution will be canceled only if it has status QUEUED. If you attempt to cancel a job execution that is IN_PROGRESS, and you do not set force to true, then an InvalidStateTransitionException will be thrown. The default is false.

Canceling a job execution which is "IN_PROGRESS", will cause the device to be unable to update the job execution status. Use caution and ensure that the device 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 the job execution will be canceled if it has status IN_PROGRESS or QUEUED, otherwise the job execution will be canceled only if it has status QUEUED. If you attempt to cancel a job execution that is IN_PROGRESS, and you do not set force to true, then an InvalidStateTransitionException will be thrown. The default is false.

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

Returns:

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

getExpectedVersion

public java.lang.Long getExpectedVersion()

(Optional) The expected current version of the job execution. Each time you update the job execution, its version is incremented. If the version of the job execution stored in Jobs does not match, the update is rejected with a VersionMismatch error, and an ErrorResponse that contains the current job execution status data is returned. (This makes it unnecessary to perform a separate DescribeJobExecution request in order to obtain the job execution status data.)

Returns:

(Optional) The expected current version of the job execution. Each time you update the job execution, its version is incremented. If the version of the job execution stored in Jobs does not match, the update is rejected with a VersionMismatch error, and an ErrorResponse that contains the current job execution status data is returned. (This makes it unnecessary to perform a separate DescribeJobExecution request in order to obtain the job execution status data.)

setExpectedVersion

public void setExpectedVersion(java.lang.Long expectedVersion)

(Optional) The expected current version of the job execution. Each time you update the job execution, its version is incremented. If the version of the job execution stored in Jobs does not match, the update is rejected with a VersionMismatch error, and an ErrorResponse that contains the current job execution status data is returned. (This makes it unnecessary to perform a separate DescribeJobExecution request in order to obtain the job execution status data.)

Parameters:

expectedVersion -

(Optional) The expected current version of the job execution. Each time you update the job execution, its version is incremented. If the version of the job execution stored in Jobs does not match, the update is rejected with a VersionMismatch error, and an ErrorResponse that contains the current job execution status data is returned. (This makes it unnecessary to perform a separate DescribeJobExecution request in order to obtain the job execution status data.)

withExpectedVersion

public CancelJobExecutionRequest withExpectedVersion(java.lang.Long expectedVersion)

(Optional) The expected current version of the job execution. Each time you update the job execution, its version is incremented. If the version of the job execution stored in Jobs does not match, the update is rejected with a VersionMismatch error, and an ErrorResponse that contains the current job execution status data is returned. (This makes it unnecessary to perform a separate DescribeJobExecution request in order to obtain the job execution status data.)

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

Parameters:

expectedVersion -

(Optional) The expected current version of the job execution. Each time you update the job execution, its version is incremented. If the version of the job execution stored in Jobs does not match, the update is rejected with a VersionMismatch error, and an ErrorResponse that contains the current job execution status data is returned. (This makes it unnecessary to perform a separate DescribeJobExecution request in order to obtain the job execution status data.)

Returns:

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

getStatusDetails

public java.util.Map<java.lang.String,java.lang.String> getStatusDetails()

A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged. You can specify at most 10 name/value pairs.

Returns:

A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged. You can specify at most 10 name/value pairs.

setStatusDetails

public void setStatusDetails(java.util.Map<java.lang.String,java.lang.String> statusDetails)

A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged. You can specify at most 10 name/value pairs.

Parameters:

statusDetails -

A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged. You can specify at most 10 name/value pairs.

withStatusDetails

public CancelJobExecutionRequest withStatusDetails(java.util.Map<java.lang.String,java.lang.String> statusDetails)

A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged. You can specify at most 10 name/value pairs.

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

Parameters:

statusDetails -

A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged. You can specify at most 10 name/value pairs.

Returns:

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

addstatusDetailsEntry

public CancelJobExecutionRequest addstatusDetailsEntry(java.lang.String key,
                                                       java.lang.String value)

A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged. You can specify at most 10 name/value pairs.

The method adds a new key-value pair into statusDetails parameter, and returns a reference to this object so that method calls can be chained together.

Parameters:

key - The key of the entry to be added into statusDetails.

value - The corresponding value of the entry to be added into statusDetails.

Returns:

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

clearstatusDetailsEntries

public CancelJobExecutionRequest clearstatusDetailsEntries()

Removes all the entries added into statusDetails.

Returns a reference to this 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