com.amazonaws.services.iot.model

Class CancelJobExecutionRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.iot.model.CancelJobExecutionRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

Method Summary

Modifier and Type	Method and Description
CancelJobExecutionRequest	addStatusDetailsEntry(String key, String value) Add a single StatusDetails entry
CancelJobExecutionRequest	clearStatusDetailsEntries() Removes all the entries added into StatusDetails.
CancelJobExecutionRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Long	getExpectedVersion() (Optional) The expected current version of the job execution.
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.
String	getJobId() The ID of the job to be canceled.
Map<String,String>	getStatusDetails() A collection of name/value pairs that describe the status of the job execution.
String	getThingName() The name of the thing whose execution of the job will be canceled.
int	hashCode()
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(Long expectedVersion) (Optional) The expected current version of the job execution.
void	setForce(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(String jobId) The ID of the job to be canceled.
void	setStatusDetails(Map<String,String> statusDetails) A collection of name/value pairs that describe the status of the job execution.
void	setThingName(String thingName) The name of the thing whose execution of the job will be canceled.
String	toString() Returns a string representation of this object.
CancelJobExecutionRequest	withExpectedVersion(Long expectedVersion) (Optional) The expected current version of the job execution.
CancelJobExecutionRequest	withForce(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(String jobId) The ID of the job to be canceled.
CancelJobExecutionRequest	withStatusDetails(Map<String,String> statusDetails) A collection of name/value pairs that describe the status of the job execution.
CancelJobExecutionRequest	withThingName(String thingName) The name of the thing whose execution of the job will be 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

CancelJobExecutionRequest

public CancelJobExecutionRequest()

Method Detail

setJobId

public void setJobId(String jobId)

The ID of the job to be canceled.

Parameters:

jobId - The ID of the job to be canceled.

getJobId

public String getJobId()

The ID of the job to be canceled.

Returns:

The ID of the job to be canceled.

withJobId

public CancelJobExecutionRequest withJobId(String jobId)

The ID of the job to be canceled.

Parameters:

jobId - The ID of the job to be canceled.

Returns:

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

setThingName

public void setThingName(String thingName)

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

Parameters:

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

getThingName

public String getThingName()

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

Returns:

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

withThingName

public CancelJobExecutionRequest withThingName(String thingName)

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

Parameters:

thingName - The name of the thing whose execution of the job will be 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 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.

getForce

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

withForce

public CancelJobExecutionRequest withForce(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.

Returns:

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

isForce

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

setExpectedVersion

public void setExpectedVersion(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.)

getExpectedVersion

public 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.)

withExpectedVersion

public CancelJobExecutionRequest withExpectedVersion(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.)

Returns:

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

getStatusDetails

public Map<String,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(Map<String,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(Map<String,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.

Returns:

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

addStatusDetailsEntry

public CancelJobExecutionRequest addStatusDetailsEntry(String key,
                                                       String value)

Add a single StatusDetails entry

See Also:

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

clearStatusDetailsEntries

public CancelJobExecutionRequest clearStatusDetailsEntries()

Removes all the entries added into StatusDetails.

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