AWS SDK for C++  1.9.106
AWS SDK for C++
Public Member Functions | List of all members
Aws::IoT::Model::TimeoutConfig Class Reference

#include <TimeoutConfig.h>

Public Member Functions

 TimeoutConfig ()
 
 TimeoutConfig (Aws::Utils::Json::JsonView jsonValue)
 
TimeoutConfigoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
long long GetInProgressTimeoutInMinutes () const
 
bool InProgressTimeoutInMinutesHasBeenSet () const
 
void SetInProgressTimeoutInMinutes (long long value)
 
TimeoutConfigWithInProgressTimeoutInMinutes (long long value)
 

Detailed Description

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:

AWS API Reference

Definition at line 33 of file TimeoutConfig.h.

Constructor & Destructor Documentation

◆ TimeoutConfig() [1/2]

Aws::IoT::Model::TimeoutConfig::TimeoutConfig ( )

◆ TimeoutConfig() [2/2]

Aws::IoT::Model::TimeoutConfig::TimeoutConfig ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ GetInProgressTimeoutInMinutes()

long long Aws::IoT::Model::TimeoutConfig::GetInProgressTimeoutInMinutes ( ) const
inline

Specifies the amount of time, in minutes, this device has to finish execution of this job. The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080 minutes). The in progress timer can't be updated and will apply to all job executions for the job. Whenever a job execution remains in the IN_PROGRESS status for longer than this interval, the job execution will fail and switch to the terminal TIMED_OUT status.

Definition at line 50 of file TimeoutConfig.h.

◆ InProgressTimeoutInMinutesHasBeenSet()

bool Aws::IoT::Model::TimeoutConfig::InProgressTimeoutInMinutesHasBeenSet ( ) const
inline

Specifies the amount of time, in minutes, this device has to finish execution of this job. The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080 minutes). The in progress timer can't be updated and will apply to all job executions for the job. Whenever a job execution remains in the IN_PROGRESS status for longer than this interval, the job execution will fail and switch to the terminal TIMED_OUT status.

Definition at line 60 of file TimeoutConfig.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::IoT::Model::TimeoutConfig::Jsonize ( ) const

◆ operator=()

TimeoutConfig& Aws::IoT::Model::TimeoutConfig::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetInProgressTimeoutInMinutes()

void Aws::IoT::Model::TimeoutConfig::SetInProgressTimeoutInMinutes ( long long  value)
inline

Specifies the amount of time, in minutes, this device has to finish execution of this job. The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080 minutes). The in progress timer can't be updated and will apply to all job executions for the job. Whenever a job execution remains in the IN_PROGRESS status for longer than this interval, the job execution will fail and switch to the terminal TIMED_OUT status.

Definition at line 70 of file TimeoutConfig.h.

◆ WithInProgressTimeoutInMinutes()

TimeoutConfig& Aws::IoT::Model::TimeoutConfig::WithInProgressTimeoutInMinutes ( long long  value)
inline

Specifies the amount of time, in minutes, this device has to finish execution of this job. The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080 minutes). The in progress timer can't be updated and will apply to all job executions for the job. Whenever a job execution remains in the IN_PROGRESS status for longer than this interval, the job execution will fail and switch to the terminal TIMED_OUT status.

Definition at line 80 of file TimeoutConfig.h.


The documentation for this class was generated from the following file: