com.amazonaws.services.iot.model

Class TimeoutConfig

java.lang.Object

com.amazonaws.services.iot.model.TimeoutConfig

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

Specifies the amount of time each device has to finish its execution of the job. A timer is started when the job execution status is set to IN_PROGRESS. If the job execution status is not set to another terminal state before the timer expires, it will be automatically set to TIMED_OUT.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TimeoutConfig()

Method Summary

Modifier and Type	Method and Description
TimeoutConfig	clone()
boolean	equals(Object obj)
Long	getInProgressTimeoutInMinutes() Specifies the amount of time, in minutes, this device has to finish execution of this job.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setInProgressTimeoutInMinutes(Long inProgressTimeoutInMinutes) Specifies the amount of time, in minutes, this device has to finish execution of this job.
String	toString() Returns a string representation of this object; useful for testing and debugging.
TimeoutConfig	withInProgressTimeoutInMinutes(Long inProgressTimeoutInMinutes) Specifies the amount of time, in minutes, this device has to finish execution of this job.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TimeoutConfig

public TimeoutConfig()

Method Detail

setInProgressTimeoutInMinutes

public void setInProgressTimeoutInMinutes(Long inProgressTimeoutInMinutes)

Specifies the amount of time, in minutes, this device has to finish execution of this job. A timer is started, or restarted, whenever this job's execution status is specified as IN_PROGRESS with this field populated. If the job execution status is not set to a terminal state before the timer expires, or before another job execution status update is sent with this field populated, the status will be automatically set to TIMED_OUT. Note that setting/resetting this timer has no effect on the job execution timeout timer which may have been specified when the job was created (CreateJobExecution using the field timeoutConfig).

Parameters:

inProgressTimeoutInMinutes - Specifies the amount of time, in minutes, this device has to finish execution of this job. A timer is started, or restarted, whenever this job's execution status is specified as IN_PROGRESS with this field populated. If the job execution status is not set to a terminal state before the timer expires, or before another job execution status update is sent with this field populated, the status will be automatically set to TIMED_OUT. Note that setting/resetting this timer has no effect on the job execution timeout timer which may have been specified when the job was created ( CreateJobExecution using the field timeoutConfig).

getInProgressTimeoutInMinutes

public Long getInProgressTimeoutInMinutes()

Specifies the amount of time, in minutes, this device has to finish execution of this job. A timer is started, or restarted, whenever this job's execution status is specified as IN_PROGRESS with this field populated. If the job execution status is not set to a terminal state before the timer expires, or before another job execution status update is sent with this field populated, the status will be automatically set to TIMED_OUT. Note that setting/resetting this timer has no effect on the job execution timeout timer which may have been specified when the job was created (CreateJobExecution using the field timeoutConfig).

Returns:

Specifies the amount of time, in minutes, this device has to finish execution of this job. A timer is started, or restarted, whenever this job's execution status is specified as IN_PROGRESS with this field populated. If the job execution status is not set to a terminal state before the timer expires, or before another job execution status update is sent with this field populated, the status will be automatically set to TIMED_OUT. Note that setting/resetting this timer has no effect on the job execution timeout timer which may have been specified when the job was created ( CreateJobExecution using the field timeoutConfig).

withInProgressTimeoutInMinutes

public TimeoutConfig withInProgressTimeoutInMinutes(Long inProgressTimeoutInMinutes)

Specifies the amount of time, in minutes, this device has to finish execution of this job. A timer is started, or restarted, whenever this job's execution status is specified as IN_PROGRESS with this field populated. If the job execution status is not set to a terminal state before the timer expires, or before another job execution status update is sent with this field populated, the status will be automatically set to TIMED_OUT. Note that setting/resetting this timer has no effect on the job execution timeout timer which may have been specified when the job was created (CreateJobExecution using the field timeoutConfig).

Parameters:

inProgressTimeoutInMinutes - Specifies the amount of time, in minutes, this device has to finish execution of this job. A timer is started, or restarted, whenever this job's execution status is specified as IN_PROGRESS with this field populated. If the job execution status is not set to a terminal state before the timer expires, or before another job execution status update is sent with this field populated, the status will be automatically set to TIMED_OUT. Note that setting/resetting this timer has no effect on the job execution timeout timer which may have been specified when the job was created ( CreateJobExecution using the 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; useful for testing and debugging.

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 TimeoutConfig clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.