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

#include <AbortCriteria.h>

Public Member Functions

 AbortCriteria ()
 
 AbortCriteria (Aws::Utils::Json::JsonView jsonValue)
 
AbortCriteriaoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const JobExecutionFailureTypeGetFailureType () const
 
bool FailureTypeHasBeenSet () const
 
void SetFailureType (const JobExecutionFailureType &value)
 
void SetFailureType (JobExecutionFailureType &&value)
 
AbortCriteriaWithFailureType (const JobExecutionFailureType &value)
 
AbortCriteriaWithFailureType (JobExecutionFailureType &&value)
 
const AbortActionGetAction () const
 
bool ActionHasBeenSet () const
 
void SetAction (const AbortAction &value)
 
void SetAction (AbortAction &&value)
 
AbortCriteriaWithAction (const AbortAction &value)
 
AbortCriteriaWithAction (AbortAction &&value)
 
double GetThresholdPercentage () const
 
bool ThresholdPercentageHasBeenSet () const
 
void SetThresholdPercentage (double value)
 
AbortCriteriaWithThresholdPercentage (double value)
 
int GetMinNumberOfExecutedThings () const
 
bool MinNumberOfExecutedThingsHasBeenSet () const
 
void SetMinNumberOfExecutedThings (int value)
 
AbortCriteriaWithMinNumberOfExecutedThings (int value)
 

Detailed Description

The criteria that determine when and how a job abort takes place.

See Also:

AWS API Reference

Definition at line 33 of file AbortCriteria.h.

Constructor & Destructor Documentation

◆ AbortCriteria() [1/2]

Aws::IoT::Model::AbortCriteria::AbortCriteria ( )

◆ AbortCriteria() [2/2]

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

Member Function Documentation

◆ ActionHasBeenSet()

bool Aws::IoT::Model::AbortCriteria::ActionHasBeenSet ( ) const
inline

The type of job action to take to initiate the job abort.

Definition at line 81 of file AbortCriteria.h.

◆ FailureTypeHasBeenSet()

bool Aws::IoT::Model::AbortCriteria::FailureTypeHasBeenSet ( ) const
inline

The type of job execution failures that can initiate a job abort.

Definition at line 50 of file AbortCriteria.h.

◆ GetAction()

const AbortAction& Aws::IoT::Model::AbortCriteria::GetAction ( ) const
inline

The type of job action to take to initiate the job abort.

Definition at line 76 of file AbortCriteria.h.

◆ GetFailureType()

const JobExecutionFailureType& Aws::IoT::Model::AbortCriteria::GetFailureType ( ) const
inline

The type of job execution failures that can initiate a job abort.

Definition at line 45 of file AbortCriteria.h.

◆ GetMinNumberOfExecutedThings()

int Aws::IoT::Model::AbortCriteria::GetMinNumberOfExecutedThings ( ) const
inline

The minimum number of things which must receive job execution notifications before the job can be aborted.

Definition at line 137 of file AbortCriteria.h.

◆ GetThresholdPercentage()

double Aws::IoT::Model::AbortCriteria::GetThresholdPercentage ( ) const
inline

The minimum percentage of job execution failures that must occur to initiate the job abort.

AWS IoT supports up to two digits after the decimal (for example, 10.9 and 10.99, but not 10.999).

Definition at line 109 of file AbortCriteria.h.

◆ Jsonize()

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

◆ MinNumberOfExecutedThingsHasBeenSet()

bool Aws::IoT::Model::AbortCriteria::MinNumberOfExecutedThingsHasBeenSet ( ) const
inline

The minimum number of things which must receive job execution notifications before the job can be aborted.

Definition at line 143 of file AbortCriteria.h.

◆ operator=()

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

◆ SetAction() [1/2]

void Aws::IoT::Model::AbortCriteria::SetAction ( AbortAction &&  value)
inline

The type of job action to take to initiate the job abort.

Definition at line 91 of file AbortCriteria.h.

◆ SetAction() [2/2]

void Aws::IoT::Model::AbortCriteria::SetAction ( const AbortAction value)
inline

The type of job action to take to initiate the job abort.

Definition at line 86 of file AbortCriteria.h.

◆ SetFailureType() [1/2]

void Aws::IoT::Model::AbortCriteria::SetFailureType ( const JobExecutionFailureType value)
inline

The type of job execution failures that can initiate a job abort.

Definition at line 55 of file AbortCriteria.h.

◆ SetFailureType() [2/2]

void Aws::IoT::Model::AbortCriteria::SetFailureType ( JobExecutionFailureType &&  value)
inline

The type of job execution failures that can initiate a job abort.

Definition at line 60 of file AbortCriteria.h.

◆ SetMinNumberOfExecutedThings()

void Aws::IoT::Model::AbortCriteria::SetMinNumberOfExecutedThings ( int  value)
inline

The minimum number of things which must receive job execution notifications before the job can be aborted.

Definition at line 149 of file AbortCriteria.h.

◆ SetThresholdPercentage()

void Aws::IoT::Model::AbortCriteria::SetThresholdPercentage ( double  value)
inline

The minimum percentage of job execution failures that must occur to initiate the job abort.

AWS IoT supports up to two digits after the decimal (for example, 10.9 and 10.99, but not 10.999).

Definition at line 123 of file AbortCriteria.h.

◆ ThresholdPercentageHasBeenSet()

bool Aws::IoT::Model::AbortCriteria::ThresholdPercentageHasBeenSet ( ) const
inline

The minimum percentage of job execution failures that must occur to initiate the job abort.

AWS IoT supports up to two digits after the decimal (for example, 10.9 and 10.99, but not 10.999).

Definition at line 116 of file AbortCriteria.h.

◆ WithAction() [1/2]

AbortCriteria& Aws::IoT::Model::AbortCriteria::WithAction ( AbortAction &&  value)
inline

The type of job action to take to initiate the job abort.

Definition at line 101 of file AbortCriteria.h.

◆ WithAction() [2/2]

AbortCriteria& Aws::IoT::Model::AbortCriteria::WithAction ( const AbortAction value)
inline

The type of job action to take to initiate the job abort.

Definition at line 96 of file AbortCriteria.h.

◆ WithFailureType() [1/2]

AbortCriteria& Aws::IoT::Model::AbortCriteria::WithFailureType ( const JobExecutionFailureType value)
inline

The type of job execution failures that can initiate a job abort.

Definition at line 65 of file AbortCriteria.h.

◆ WithFailureType() [2/2]

AbortCriteria& Aws::IoT::Model::AbortCriteria::WithFailureType ( JobExecutionFailureType &&  value)
inline

The type of job execution failures that can initiate a job abort.

Definition at line 70 of file AbortCriteria.h.

◆ WithMinNumberOfExecutedThings()

AbortCriteria& Aws::IoT::Model::AbortCriteria::WithMinNumberOfExecutedThings ( int  value)
inline

The minimum number of things which must receive job execution notifications before the job can be aborted.

Definition at line 155 of file AbortCriteria.h.

◆ WithThresholdPercentage()

AbortCriteria& Aws::IoT::Model::AbortCriteria::WithThresholdPercentage ( double  value)
inline

The minimum percentage of job execution failures that must occur to initiate the job abort.

AWS IoT supports up to two digits after the decimal (for example, 10.9 and 10.99, but not 10.999).

Definition at line 130 of file AbortCriteria.h.


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