com.amazonaws.services.iotjobsdataplane.model

Class StartNextPendingJobExecutionRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.iotjobsdataplane.model.StartNextPendingJobExecutionRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

Method Summary

Modifier and Type	Method and Description
StartNextPendingJobExecutionRequest	addStatusDetailsEntry(String key, String value) Add a single StatusDetails entry
StartNextPendingJobExecutionRequest	clearStatusDetailsEntries() Removes all the entries added into StatusDetails.
StartNextPendingJobExecutionRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Map<String,String>	getStatusDetails() A collection of name/value pairs that describe the status of the job execution.
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()
void	setStatusDetails(Map<String,String> statusDetails) A collection of name/value pairs that describe the status of the job execution.
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.
StartNextPendingJobExecutionRequest	withStatusDetails(Map<String,String> statusDetails) A collection of name/value pairs that describe the status of the job execution.
StartNextPendingJobExecutionRequest	withStepTimeoutInMinutes(Long stepTimeoutInMinutes) Specifies the amount of time this device has to finish execution of this job.
StartNextPendingJobExecutionRequest	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

StartNextPendingJobExecutionRequest

public StartNextPendingJobExecutionRequest()

Method Detail

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

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.

Returns:

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)

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

Parameters:

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

withStatusDetails

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

Parameters:

statusDetails - 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 StartNextPendingJobExecutionRequest addStatusDetailsEntry(String key,
                                                                 String value)

Add a single StatusDetails entry

See Also:

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

clearStatusDetailsEntries

public StartNextPendingJobExecutionRequest 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 calling UpdateJobExecution, setting the status to IN_PROGRESS and specifying a new timeout value in field stepTimeoutInMinutes) the job execution status will be automatically set to TIMED_OUT. Note that setting 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 calling UpdateJobExecution, setting the status to IN_PROGRESS and specifying a new timeout value in field stepTimeoutInMinutes) the job execution status will be automatically set to TIMED_OUT. Note that setting 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 calling UpdateJobExecution, setting the status to IN_PROGRESS and specifying a new timeout value in field stepTimeoutInMinutes) the job execution status will be automatically set to TIMED_OUT. Note that setting 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 calling UpdateJobExecution, setting the status to IN_PROGRESS and specifying a new timeout value in field stepTimeoutInMinutes) the job execution status will be automatically set to TIMED_OUT. Note that setting 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 StartNextPendingJobExecutionRequest 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 calling UpdateJobExecution, setting the status to IN_PROGRESS and specifying a new timeout value in field stepTimeoutInMinutes) the job execution status will be automatically set to TIMED_OUT. Note that setting 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 calling UpdateJobExecution, setting the status to IN_PROGRESS and specifying a new timeout value in field stepTimeoutInMinutes) the job execution status will be automatically set to TIMED_OUT. Note that setting 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.

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