com.amazonaws.services.iotjobsdataplane.model

Class UpdateJobExecutionRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.iotjobsdataplane.model.UpdateJobExecutionRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
UpdateJobExecutionRequest()

Method Summary

Modifier and Type	Method and Description
UpdateJobExecutionRequest	addStatusDetailsEntry(String key, String value)
UpdateJobExecutionRequest	clearStatusDetailsEntries() Removes all the entries added into StatusDetails.
UpdateJobExecutionRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Long	getExecutionNumber() Optional.
Long	getExpectedVersion() Optional.
Boolean	getIncludeJobDocument() Optional.
Boolean	getIncludeJobExecutionState() Optional.
String	getJobId() The unique identifier assigned to this job when it was created.
String	getStatus() The new status for the job execution (IN_PROGRESS, FAILED, SUCCESS, or REJECTED).
Map<String,String>	getStatusDetails() Optional.
Long	getStepTimeoutInMinutes() Specifies the amount of time this device has to finish execution of this job.
String	getThingName() The name of the thing associated with the device.
int	hashCode()
Boolean	isIncludeJobDocument() Optional.
Boolean	isIncludeJobExecutionState() Optional.
void	setExecutionNumber(Long executionNumber) Optional.
void	setExpectedVersion(Long expectedVersion) Optional.
void	setIncludeJobDocument(Boolean includeJobDocument) Optional.
void	setIncludeJobExecutionState(Boolean includeJobExecutionState) Optional.
void	setJobId(String jobId) The unique identifier assigned to this job when it was created.
void	setStatus(String status) The new status for the job execution (IN_PROGRESS, FAILED, SUCCESS, or REJECTED).
void	setStatusDetails(Map<String,String> statusDetails) Optional.
void	setStepTimeoutInMinutes(Long stepTimeoutInMinutes) Specifies the amount of time this device has to finish execution of this job.
void	setThingName(String thingName) The name of the thing associated with the device.
String	toString() Returns a string representation of this object.
UpdateJobExecutionRequest	withExecutionNumber(Long executionNumber) Optional.
UpdateJobExecutionRequest	withExpectedVersion(Long expectedVersion) Optional.
UpdateJobExecutionRequest	withIncludeJobDocument(Boolean includeJobDocument) Optional.
UpdateJobExecutionRequest	withIncludeJobExecutionState(Boolean includeJobExecutionState) Optional.
UpdateJobExecutionRequest	withJobId(String jobId) The unique identifier assigned to this job when it was created.
UpdateJobExecutionRequest	withStatus(JobExecutionStatus status) The new status for the job execution (IN_PROGRESS, FAILED, SUCCESS, or REJECTED).
UpdateJobExecutionRequest	withStatus(String status) The new status for the job execution (IN_PROGRESS, FAILED, SUCCESS, or REJECTED).
UpdateJobExecutionRequest	withStatusDetails(Map<String,String> statusDetails) Optional.
UpdateJobExecutionRequest	withStepTimeoutInMinutes(Long stepTimeoutInMinutes) Specifies the amount of time this device has to finish execution of this job.
UpdateJobExecutionRequest	withThingName(String thingName) The name of the thing associated with the device.

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

UpdateJobExecutionRequest

public UpdateJobExecutionRequest()

Method Detail

setJobId

public void setJobId(String jobId)

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

Parameters:

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

getJobId

public String getJobId()

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

Returns:

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

withJobId

public UpdateJobExecutionRequest withJobId(String jobId)

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

Parameters:

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

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 associated with the device.

Parameters:

thingName - The name of the thing associated with the device.

getThingName

public String getThingName()

The name of the thing associated with the device.

Returns:

The name of the thing associated with the device.

withThingName

public UpdateJobExecutionRequest withThingName(String thingName)

The name of the thing associated with the device.

Parameters:

thingName - The name of the thing associated with the device.

Returns:

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

setStatus

public void setStatus(String status)

The new status for the job execution (IN_PROGRESS, FAILED, SUCCESS, or REJECTED). This must be specified on every update.

Parameters:

status - The new status for the job execution (IN_PROGRESS, FAILED, SUCCESS, or REJECTED). This must be specified on every update.

See Also:

JobExecutionStatus

getStatus

public String getStatus()

The new status for the job execution (IN_PROGRESS, FAILED, SUCCESS, or REJECTED). This must be specified on every update.

Returns:

The new status for the job execution (IN_PROGRESS, FAILED, SUCCESS, or REJECTED). This must be specified on every update.

See Also:

JobExecutionStatus

withStatus

public UpdateJobExecutionRequest withStatus(String status)

The new status for the job execution (IN_PROGRESS, FAILED, SUCCESS, or REJECTED). This must be specified on every update.

Parameters:

status - The new status for the job execution (IN_PROGRESS, FAILED, SUCCESS, or REJECTED). This must be specified on every update.

Returns:

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

See Also:

JobExecutionStatus

withStatus

public UpdateJobExecutionRequest withStatus(JobExecutionStatus status)

The new status for the job execution (IN_PROGRESS, FAILED, SUCCESS, or REJECTED). This must be specified on every update.

Parameters:

status - The new status for the job execution (IN_PROGRESS, FAILED, SUCCESS, or REJECTED). This must be specified on every update.

Returns:

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

See Also:

JobExecutionStatus

getStatusDetails

public Map<String,String> getStatusDetails()

Optional. A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged.

Returns:

Optional. A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged.

setStatusDetails

public void setStatusDetails(Map<String,String> statusDetails)

Optional. A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged.

Parameters:

statusDetails - Optional. A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged.

withStatusDetails

public UpdateJobExecutionRequest withStatusDetails(Map<String,String> statusDetails)

Optional. A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged.

Parameters:

statusDetails - Optional. A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged.

Returns:

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

addStatusDetailsEntry

public UpdateJobExecutionRequest addStatusDetailsEntry(String key,
                                                       String value)

clearStatusDetailsEntries

public UpdateJobExecutionRequest clearStatusDetailsEntries()

Removes all the entries added into StatusDetails.

Returns:

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

setStepTimeoutInMinutes

public void setStepTimeoutInMinutes(Long stepTimeoutInMinutes)

Specifies the amount of time this device has to finish execution of this job. If the job execution status is not set to a terminal state before this timer expires, or before the timer is reset (by again calling UpdateJobExecution, setting the status to IN_PROGRESS and specifying a new timeout value in this field) the job execution status will be automatically set to TIMED_OUT. Note that setting or resetting this timeout has no effect on that job execution timeout which may have been specified when the job was created (CreateJob using field timeoutConfig).

Parameters:

stepTimeoutInMinutes - Specifies the amount of time this device has to finish execution of this job. If the job execution status is not set to a terminal state before this timer expires, or before the timer is reset (by again calling UpdateJobExecution, setting the status to IN_PROGRESS and specifying a new timeout value in this field) the job execution status will be automatically set to TIMED_OUT. Note that setting or resetting this timeout has no effect on that job execution timeout which may have been specified when the job was created (CreateJob using field timeoutConfig).

getStepTimeoutInMinutes

public Long getStepTimeoutInMinutes()

Specifies the amount of time this device has to finish execution of this job. If the job execution status is not set to a terminal state before this timer expires, or before the timer is reset (by again calling UpdateJobExecution, setting the status to IN_PROGRESS and specifying a new timeout value in this field) the job execution status will be automatically set to TIMED_OUT. Note that setting or resetting this timeout has no effect on that job execution timeout which may have been specified when the job was created (CreateJob using field timeoutConfig).

Returns:

Specifies the amount of time this device has to finish execution of this job. If the job execution status is not set to a terminal state before this timer expires, or before the timer is reset (by again calling UpdateJobExecution, setting the status to IN_PROGRESS and specifying a new timeout value in this field) the job execution status will be automatically set to TIMED_OUT . Note that setting or resetting this timeout has no effect on that job execution timeout which may have been specified when the job was created (CreateJob using field timeoutConfig).

withStepTimeoutInMinutes

public UpdateJobExecutionRequest withStepTimeoutInMinutes(Long stepTimeoutInMinutes)

Specifies the amount of time this device has to finish execution of this job. If the job execution status is not set to a terminal state before this timer expires, or before the timer is reset (by again calling UpdateJobExecution, setting the status to IN_PROGRESS and specifying a new timeout value in this field) the job execution status will be automatically set to TIMED_OUT. Note that setting or resetting this timeout has no effect on that job execution timeout which may have been specified when the job was created (CreateJob using field timeoutConfig).

Parameters:

stepTimeoutInMinutes - Specifies the amount of time this device has to finish execution of this job. If the job execution status is not set to a terminal state before this timer expires, or before the timer is reset (by again calling UpdateJobExecution, setting the status to IN_PROGRESS and specifying a new timeout value in this field) the job execution status will be automatically set to TIMED_OUT. Note that setting or resetting this timeout has no effect on that job execution timeout which may have been specified when the job was created (CreateJob using field timeoutConfig).

Returns:

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

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

setIncludeJobExecutionState

public void setIncludeJobExecutionState(Boolean includeJobExecutionState)

Optional. When included and set to true, the response contains the JobExecutionState data. The default is false.

Parameters:

includeJobExecutionState - Optional. When included and set to true, the response contains the JobExecutionState data. The default is false.

getIncludeJobExecutionState

public Boolean getIncludeJobExecutionState()

Optional. When included and set to true, the response contains the JobExecutionState data. The default is false.

Returns:

Optional. When included and set to true, the response contains the JobExecutionState data. The default is false.

withIncludeJobExecutionState

public UpdateJobExecutionRequest withIncludeJobExecutionState(Boolean includeJobExecutionState)

Optional. When included and set to true, the response contains the JobExecutionState data. The default is false.

Parameters:

includeJobExecutionState - Optional. When included and set to true, the response contains the JobExecutionState data. The default is false.

Returns:

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

isIncludeJobExecutionState

public Boolean isIncludeJobExecutionState()

Optional. When included and set to true, the response contains the JobExecutionState data. The default is false.

Returns:

Optional. When included and set to true, the response contains the JobExecutionState data. The default is false.

setIncludeJobDocument

public void setIncludeJobDocument(Boolean includeJobDocument)

Optional. When set to true, the response contains the job document. The default is false.

Parameters:

includeJobDocument - Optional. When set to true, the response contains the job document. The default is false.

getIncludeJobDocument

public Boolean getIncludeJobDocument()

Optional. When set to true, the response contains the job document. The default is false.

Returns:

Optional. When set to true, the response contains the job document. The default is false.

withIncludeJobDocument

public UpdateJobExecutionRequest withIncludeJobDocument(Boolean includeJobDocument)

Optional. When set to true, the response contains the job document. The default is false.

Parameters:

includeJobDocument - Optional. When set to true, the response contains the job document. The default is false.

Returns:

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

isIncludeJobDocument

public Boolean isIncludeJobDocument()

Optional. When set to true, the response contains the job document. The default is false.

Returns:

Optional. When set to true, the response contains the job document. The default is false.

setExecutionNumber

public void setExecutionNumber(Long executionNumber)

Optional. A number that identifies a particular job execution on a particular device.

Parameters:

executionNumber - Optional. A number that identifies a particular job execution on a particular device.

getExecutionNumber

public Long getExecutionNumber()

Optional. A number that identifies a particular job execution on a particular device.

Returns:

Optional. A number that identifies a particular job execution on a particular device.

withExecutionNumber

public UpdateJobExecutionRequest withExecutionNumber(Long executionNumber)

Optional. A number that identifies a particular job execution on a particular device.

Parameters:

executionNumber - Optional. A number that identifies a particular job execution on a particular device.

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