AWS SDK for C++  1.9.67
AWS SDK for C++
Public Member Functions | List of all members
Aws::GreengrassV2::Model::IoTJobAbortCriteria Class Reference

#include <IoTJobAbortCriteria.h>

Public Member Functions

 IoTJobAbortCriteria ()
 
 IoTJobAbortCriteria (Aws::Utils::Json::JsonView jsonValue)
 
IoTJobAbortCriteriaoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const IoTJobExecutionFailureTypeGetFailureType () const
 
bool FailureTypeHasBeenSet () const
 
void SetFailureType (const IoTJobExecutionFailureType &value)
 
void SetFailureType (IoTJobExecutionFailureType &&value)
 
IoTJobAbortCriteriaWithFailureType (const IoTJobExecutionFailureType &value)
 
IoTJobAbortCriteriaWithFailureType (IoTJobExecutionFailureType &&value)
 
const IoTJobAbortActionGetAction () const
 
bool ActionHasBeenSet () const
 
void SetAction (const IoTJobAbortAction &value)
 
void SetAction (IoTJobAbortAction &&value)
 
IoTJobAbortCriteriaWithAction (const IoTJobAbortAction &value)
 
IoTJobAbortCriteriaWithAction (IoTJobAbortAction &&value)
 
double GetThresholdPercentage () const
 
bool ThresholdPercentageHasBeenSet () const
 
void SetThresholdPercentage (double value)
 
IoTJobAbortCriteriaWithThresholdPercentage (double value)
 
int GetMinNumberOfExecutedThings () const
 
bool MinNumberOfExecutedThingsHasBeenSet () const
 
void SetMinNumberOfExecutedThings (int value)
 
IoTJobAbortCriteriaWithMinNumberOfExecutedThings (int value)
 

Detailed Description

Contains criteria that define when and how to cancel a job.

The deployment stops if the following conditions are true:

  1. The number of things that receive the deployment exceeds the minNumberOfExecutedThings.

  2. The percentage of failures with type failureType exceeds the thresholdPercentage.

See Also:

AWS API Reference

Definition at line 37 of file IoTJobAbortCriteria.h.

Constructor & Destructor Documentation

◆ IoTJobAbortCriteria() [1/2]

Aws::GreengrassV2::Model::IoTJobAbortCriteria::IoTJobAbortCriteria ( )

◆ IoTJobAbortCriteria() [2/2]

Aws::GreengrassV2::Model::IoTJobAbortCriteria::IoTJobAbortCriteria ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ ActionHasBeenSet()

bool Aws::GreengrassV2::Model::IoTJobAbortCriteria::ActionHasBeenSet ( ) const
inline

The action to perform when the criteria are met.

Definition at line 85 of file IoTJobAbortCriteria.h.

◆ FailureTypeHasBeenSet()

bool Aws::GreengrassV2::Model::IoTJobAbortCriteria::FailureTypeHasBeenSet ( ) const
inline

The type of job deployment failure that can cancel a job.

Definition at line 54 of file IoTJobAbortCriteria.h.

◆ GetAction()

const IoTJobAbortAction& Aws::GreengrassV2::Model::IoTJobAbortCriteria::GetAction ( ) const
inline

The action to perform when the criteria are met.

Definition at line 80 of file IoTJobAbortCriteria.h.

◆ GetFailureType()

const IoTJobExecutionFailureType& Aws::GreengrassV2::Model::IoTJobAbortCriteria::GetFailureType ( ) const
inline

The type of job deployment failure that can cancel a job.

Definition at line 49 of file IoTJobAbortCriteria.h.

◆ GetMinNumberOfExecutedThings()

int Aws::GreengrassV2::Model::IoTJobAbortCriteria::GetMinNumberOfExecutedThings ( ) const
inline

The minimum number of things that receive the configuration before the job can cancel.

Definition at line 145 of file IoTJobAbortCriteria.h.

◆ GetThresholdPercentage()

double Aws::GreengrassV2::Model::IoTJobAbortCriteria::GetThresholdPercentage ( ) const
inline

The minimum percentage of failureType failures that occur before the job can cancel.

This parameter supports up to two digits after the decimal (for example, you can specify 10.9 or 10.99, but not 10.999).

Definition at line 114 of file IoTJobAbortCriteria.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::GreengrassV2::Model::IoTJobAbortCriteria::Jsonize ( ) const

◆ MinNumberOfExecutedThingsHasBeenSet()

bool Aws::GreengrassV2::Model::IoTJobAbortCriteria::MinNumberOfExecutedThingsHasBeenSet ( ) const
inline

The minimum number of things that receive the configuration before the job can cancel.

Definition at line 151 of file IoTJobAbortCriteria.h.

◆ operator=()

IoTJobAbortCriteria& Aws::GreengrassV2::Model::IoTJobAbortCriteria::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetAction() [1/2]

void Aws::GreengrassV2::Model::IoTJobAbortCriteria::SetAction ( const IoTJobAbortAction value)
inline

The action to perform when the criteria are met.

Definition at line 90 of file IoTJobAbortCriteria.h.

◆ SetAction() [2/2]

void Aws::GreengrassV2::Model::IoTJobAbortCriteria::SetAction ( IoTJobAbortAction &&  value)
inline

The action to perform when the criteria are met.

Definition at line 95 of file IoTJobAbortCriteria.h.

◆ SetFailureType() [1/2]

void Aws::GreengrassV2::Model::IoTJobAbortCriteria::SetFailureType ( const IoTJobExecutionFailureType value)
inline

The type of job deployment failure that can cancel a job.

Definition at line 59 of file IoTJobAbortCriteria.h.

◆ SetFailureType() [2/2]

void Aws::GreengrassV2::Model::IoTJobAbortCriteria::SetFailureType ( IoTJobExecutionFailureType &&  value)
inline

The type of job deployment failure that can cancel a job.

Definition at line 64 of file IoTJobAbortCriteria.h.

◆ SetMinNumberOfExecutedThings()

void Aws::GreengrassV2::Model::IoTJobAbortCriteria::SetMinNumberOfExecutedThings ( int  value)
inline

The minimum number of things that receive the configuration before the job can cancel.

Definition at line 157 of file IoTJobAbortCriteria.h.

◆ SetThresholdPercentage()

void Aws::GreengrassV2::Model::IoTJobAbortCriteria::SetThresholdPercentage ( double  value)
inline

The minimum percentage of failureType failures that occur before the job can cancel.

This parameter supports up to two digits after the decimal (for example, you can specify 10.9 or 10.99, but not 10.999).

Definition at line 130 of file IoTJobAbortCriteria.h.

◆ ThresholdPercentageHasBeenSet()

bool Aws::GreengrassV2::Model::IoTJobAbortCriteria::ThresholdPercentageHasBeenSet ( ) const
inline

The minimum percentage of failureType failures that occur before the job can cancel.

This parameter supports up to two digits after the decimal (for example, you can specify 10.9 or 10.99, but not 10.999).

Definition at line 122 of file IoTJobAbortCriteria.h.

◆ WithAction() [1/2]

IoTJobAbortCriteria& Aws::GreengrassV2::Model::IoTJobAbortCriteria::WithAction ( const IoTJobAbortAction value)
inline

The action to perform when the criteria are met.

Definition at line 100 of file IoTJobAbortCriteria.h.

◆ WithAction() [2/2]

IoTJobAbortCriteria& Aws::GreengrassV2::Model::IoTJobAbortCriteria::WithAction ( IoTJobAbortAction &&  value)
inline

The action to perform when the criteria are met.

Definition at line 105 of file IoTJobAbortCriteria.h.

◆ WithFailureType() [1/2]

IoTJobAbortCriteria& Aws::GreengrassV2::Model::IoTJobAbortCriteria::WithFailureType ( const IoTJobExecutionFailureType value)
inline

The type of job deployment failure that can cancel a job.

Definition at line 69 of file IoTJobAbortCriteria.h.

◆ WithFailureType() [2/2]

IoTJobAbortCriteria& Aws::GreengrassV2::Model::IoTJobAbortCriteria::WithFailureType ( IoTJobExecutionFailureType &&  value)
inline

The type of job deployment failure that can cancel a job.

Definition at line 74 of file IoTJobAbortCriteria.h.

◆ WithMinNumberOfExecutedThings()

IoTJobAbortCriteria& Aws::GreengrassV2::Model::IoTJobAbortCriteria::WithMinNumberOfExecutedThings ( int  value)
inline

The minimum number of things that receive the configuration before the job can cancel.

Definition at line 163 of file IoTJobAbortCriteria.h.

◆ WithThresholdPercentage()

IoTJobAbortCriteria& Aws::GreengrassV2::Model::IoTJobAbortCriteria::WithThresholdPercentage ( double  value)
inline

The minimum percentage of failureType failures that occur before the job can cancel.

This parameter supports up to two digits after the decimal (for example, you can specify 10.9 or 10.99, but not 10.999).

Definition at line 138 of file IoTJobAbortCriteria.h.


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