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

#include <BehaviorCriteria.h>

Public Member Functions

 BehaviorCriteria ()
 
 BehaviorCriteria (Aws::Utils::Json::JsonView jsonValue)
 
BehaviorCriteriaoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const ComparisonOperatorGetComparisonOperator () const
 
bool ComparisonOperatorHasBeenSet () const
 
void SetComparisonOperator (const ComparisonOperator &value)
 
void SetComparisonOperator (ComparisonOperator &&value)
 
BehaviorCriteriaWithComparisonOperator (const ComparisonOperator &value)
 
BehaviorCriteriaWithComparisonOperator (ComparisonOperator &&value)
 
const MetricValueGetValue () const
 
bool ValueHasBeenSet () const
 
void SetValue (const MetricValue &value)
 
void SetValue (MetricValue &&value)
 
BehaviorCriteriaWithValue (const MetricValue &value)
 
BehaviorCriteriaWithValue (MetricValue &&value)
 
int GetDurationSeconds () const
 
bool DurationSecondsHasBeenSet () const
 
void SetDurationSeconds (int value)
 
BehaviorCriteriaWithDurationSeconds (int value)
 
int GetConsecutiveDatapointsToAlarm () const
 
bool ConsecutiveDatapointsToAlarmHasBeenSet () const
 
void SetConsecutiveDatapointsToAlarm (int value)
 
BehaviorCriteriaWithConsecutiveDatapointsToAlarm (int value)
 
int GetConsecutiveDatapointsToClear () const
 
bool ConsecutiveDatapointsToClearHasBeenSet () const
 
void SetConsecutiveDatapointsToClear (int value)
 
BehaviorCriteriaWithConsecutiveDatapointsToClear (int value)
 
const StatisticalThresholdGetStatisticalThreshold () const
 
bool StatisticalThresholdHasBeenSet () const
 
void SetStatisticalThreshold (const StatisticalThreshold &value)
 
void SetStatisticalThreshold (StatisticalThreshold &&value)
 
BehaviorCriteriaWithStatisticalThreshold (const StatisticalThreshold &value)
 
BehaviorCriteriaWithStatisticalThreshold (StatisticalThreshold &&value)
 
const MachineLearningDetectionConfigGetMlDetectionConfig () const
 
bool MlDetectionConfigHasBeenSet () const
 
void SetMlDetectionConfig (const MachineLearningDetectionConfig &value)
 
void SetMlDetectionConfig (MachineLearningDetectionConfig &&value)
 
BehaviorCriteriaWithMlDetectionConfig (const MachineLearningDetectionConfig &value)
 
BehaviorCriteriaWithMlDetectionConfig (MachineLearningDetectionConfig &&value)
 

Detailed Description

The criteria by which the behavior is determined to be normal.

See Also:

AWS API Reference

Definition at line 35 of file BehaviorCriteria.h.

Constructor & Destructor Documentation

◆ BehaviorCriteria() [1/2]

Aws::IoT::Model::BehaviorCriteria::BehaviorCriteria ( )

◆ BehaviorCriteria() [2/2]

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

Member Function Documentation

◆ ComparisonOperatorHasBeenSet()

bool Aws::IoT::Model::BehaviorCriteria::ComparisonOperatorHasBeenSet ( ) const
inline

The operator that relates the thing measured (metric) to the criteria (containing a value or statisticalThreshold). Valid operators include:

  • string-list: in-set and not-in-set

  • number-list: in-set and not-in-set

  • ip-address-list: in-cidr-set and not-in-cidr-set

  • number: less-than, less-than-equals, greater-than, and greater-than-equals

Definition at line 68 of file BehaviorCriteria.h.

◆ ConsecutiveDatapointsToAlarmHasBeenSet()

bool Aws::IoT::Model::BehaviorCriteria::ConsecutiveDatapointsToAlarmHasBeenSet ( ) const
inline

If a device is in violation of the behavior for the specified number of consecutive datapoints, an alarm occurs. If not specified, the default is 1.

Definition at line 213 of file BehaviorCriteria.h.

◆ ConsecutiveDatapointsToClearHasBeenSet()

bool Aws::IoT::Model::BehaviorCriteria::ConsecutiveDatapointsToClearHasBeenSet ( ) const
inline

If an alarm has occurred and the offending device is no longer in violation of the behavior for the specified number of consecutive datapoints, the alarm is cleared. If not specified, the default is 1.

Definition at line 240 of file BehaviorCriteria.h.

◆ DurationSecondsHasBeenSet()

bool Aws::IoT::Model::BehaviorCriteria::DurationSecondsHasBeenSet ( ) const
inline

Use this to specify the time duration over which the behavior is evaluated, for those criteria that have a time dimension (for example, NUM_MESSAGES_SENT). For a statisticalThreshhold metric comparison, measurements from all devices are accumulated over this time duration before being used to calculate percentiles, and later, measurements from an individual device are also accumulated over this time duration before being given a percentile rank. Cannot be used with list-based metric datatypes.

Definition at line 176 of file BehaviorCriteria.h.

◆ GetComparisonOperator()

const ComparisonOperator& Aws::IoT::Model::BehaviorCriteria::GetComparisonOperator ( ) const
inline

The operator that relates the thing measured (metric) to the criteria (containing a value or statisticalThreshold). Valid operators include:

  • string-list: in-set and not-in-set

  • number-list: in-set and not-in-set

  • ip-address-list: in-cidr-set and not-in-cidr-set

  • number: less-than, less-than-equals, greater-than, and greater-than-equals

Definition at line 55 of file BehaviorCriteria.h.

◆ GetConsecutiveDatapointsToAlarm()

int Aws::IoT::Model::BehaviorCriteria::GetConsecutiveDatapointsToAlarm ( ) const
inline

If a device is in violation of the behavior for the specified number of consecutive datapoints, an alarm occurs. If not specified, the default is 1.

Definition at line 207 of file BehaviorCriteria.h.

◆ GetConsecutiveDatapointsToClear()

int Aws::IoT::Model::BehaviorCriteria::GetConsecutiveDatapointsToClear ( ) const
inline

If an alarm has occurred and the offending device is no longer in violation of the behavior for the specified number of consecutive datapoints, the alarm is cleared. If not specified, the default is 1.

Definition at line 233 of file BehaviorCriteria.h.

◆ GetDurationSeconds()

int Aws::IoT::Model::BehaviorCriteria::GetDurationSeconds ( ) const
inline

Use this to specify the time duration over which the behavior is evaluated, for those criteria that have a time dimension (for example, NUM_MESSAGES_SENT). For a statisticalThreshhold metric comparison, measurements from all devices are accumulated over this time duration before being used to calculate percentiles, and later, measurements from an individual device are also accumulated over this time duration before being given a percentile rank. Cannot be used with list-based metric datatypes.

Definition at line 164 of file BehaviorCriteria.h.

◆ GetMlDetectionConfig()

const MachineLearningDetectionConfig& Aws::IoT::Model::BehaviorCriteria::GetMlDetectionConfig ( ) const
inline

The configuration of an ML Detect

Definition at line 297 of file BehaviorCriteria.h.

◆ GetStatisticalThreshold()

const StatisticalThreshold& Aws::IoT::Model::BehaviorCriteria::GetStatisticalThreshold ( ) const
inline

A statistical ranking (percentile)that indicates a threshold value by which a behavior is determined to be in compliance or in violation of the behavior.

Definition at line 261 of file BehaviorCriteria.h.

◆ GetValue()

const MetricValue& Aws::IoT::Model::BehaviorCriteria::GetValue ( ) const
inline

The value to be compared with the metric.

Definition at line 126 of file BehaviorCriteria.h.

◆ Jsonize()

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

◆ MlDetectionConfigHasBeenSet()

bool Aws::IoT::Model::BehaviorCriteria::MlDetectionConfigHasBeenSet ( ) const
inline

The configuration of an ML Detect

Definition at line 302 of file BehaviorCriteria.h.

◆ operator=()

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

◆ SetComparisonOperator() [1/2]

void Aws::IoT::Model::BehaviorCriteria::SetComparisonOperator ( ComparisonOperator &&  value)
inline

The operator that relates the thing measured (metric) to the criteria (containing a value or statisticalThreshold). Valid operators include:

  • string-list: in-set and not-in-set

  • number-list: in-set and not-in-set

  • ip-address-list: in-cidr-set and not-in-cidr-set

  • number: less-than, less-than-equals, greater-than, and greater-than-equals

Definition at line 94 of file BehaviorCriteria.h.

◆ SetComparisonOperator() [2/2]

void Aws::IoT::Model::BehaviorCriteria::SetComparisonOperator ( const ComparisonOperator value)
inline

The operator that relates the thing measured (metric) to the criteria (containing a value or statisticalThreshold). Valid operators include:

  • string-list: in-set and not-in-set

  • number-list: in-set and not-in-set

  • ip-address-list: in-cidr-set and not-in-cidr-set

  • number: less-than, less-than-equals, greater-than, and greater-than-equals

Definition at line 81 of file BehaviorCriteria.h.

◆ SetConsecutiveDatapointsToAlarm()

void Aws::IoT::Model::BehaviorCriteria::SetConsecutiveDatapointsToAlarm ( int  value)
inline

If a device is in violation of the behavior for the specified number of consecutive datapoints, an alarm occurs. If not specified, the default is 1.

Definition at line 219 of file BehaviorCriteria.h.

◆ SetConsecutiveDatapointsToClear()

void Aws::IoT::Model::BehaviorCriteria::SetConsecutiveDatapointsToClear ( int  value)
inline

If an alarm has occurred and the offending device is no longer in violation of the behavior for the specified number of consecutive datapoints, the alarm is cleared. If not specified, the default is 1.

Definition at line 247 of file BehaviorCriteria.h.

◆ SetDurationSeconds()

void Aws::IoT::Model::BehaviorCriteria::SetDurationSeconds ( int  value)
inline

Use this to specify the time duration over which the behavior is evaluated, for those criteria that have a time dimension (for example, NUM_MESSAGES_SENT). For a statisticalThreshhold metric comparison, measurements from all devices are accumulated over this time duration before being used to calculate percentiles, and later, measurements from an individual device are also accumulated over this time duration before being given a percentile rank. Cannot be used with list-based metric datatypes.

Definition at line 188 of file BehaviorCriteria.h.

◆ SetMlDetectionConfig() [1/2]

void Aws::IoT::Model::BehaviorCriteria::SetMlDetectionConfig ( const MachineLearningDetectionConfig value)
inline

The configuration of an ML Detect

Definition at line 307 of file BehaviorCriteria.h.

◆ SetMlDetectionConfig() [2/2]

void Aws::IoT::Model::BehaviorCriteria::SetMlDetectionConfig ( MachineLearningDetectionConfig &&  value)
inline

The configuration of an ML Detect

Definition at line 312 of file BehaviorCriteria.h.

◆ SetStatisticalThreshold() [1/2]

void Aws::IoT::Model::BehaviorCriteria::SetStatisticalThreshold ( const StatisticalThreshold value)
inline

A statistical ranking (percentile)that indicates a threshold value by which a behavior is determined to be in compliance or in violation of the behavior.

Definition at line 273 of file BehaviorCriteria.h.

◆ SetStatisticalThreshold() [2/2]

void Aws::IoT::Model::BehaviorCriteria::SetStatisticalThreshold ( StatisticalThreshold &&  value)
inline

A statistical ranking (percentile)that indicates a threshold value by which a behavior is determined to be in compliance or in violation of the behavior.

Definition at line 279 of file BehaviorCriteria.h.

◆ SetValue() [1/2]

void Aws::IoT::Model::BehaviorCriteria::SetValue ( const MetricValue value)
inline

The value to be compared with the metric.

Definition at line 136 of file BehaviorCriteria.h.

◆ SetValue() [2/2]

void Aws::IoT::Model::BehaviorCriteria::SetValue ( MetricValue &&  value)
inline

The value to be compared with the metric.

Definition at line 141 of file BehaviorCriteria.h.

◆ StatisticalThresholdHasBeenSet()

bool Aws::IoT::Model::BehaviorCriteria::StatisticalThresholdHasBeenSet ( ) const
inline

A statistical ranking (percentile)that indicates a threshold value by which a behavior is determined to be in compliance or in violation of the behavior.

Definition at line 267 of file BehaviorCriteria.h.

◆ ValueHasBeenSet()

bool Aws::IoT::Model::BehaviorCriteria::ValueHasBeenSet ( ) const
inline

The value to be compared with the metric.

Definition at line 131 of file BehaviorCriteria.h.

◆ WithComparisonOperator() [1/2]

BehaviorCriteria& Aws::IoT::Model::BehaviorCriteria::WithComparisonOperator ( ComparisonOperator &&  value)
inline

The operator that relates the thing measured (metric) to the criteria (containing a value or statisticalThreshold). Valid operators include:

  • string-list: in-set and not-in-set

  • number-list: in-set and not-in-set

  • ip-address-list: in-cidr-set and not-in-cidr-set

  • number: less-than, less-than-equals, greater-than, and greater-than-equals

Definition at line 120 of file BehaviorCriteria.h.

◆ WithComparisonOperator() [2/2]

BehaviorCriteria& Aws::IoT::Model::BehaviorCriteria::WithComparisonOperator ( const ComparisonOperator value)
inline

The operator that relates the thing measured (metric) to the criteria (containing a value or statisticalThreshold). Valid operators include:

  • string-list: in-set and not-in-set

  • number-list: in-set and not-in-set

  • ip-address-list: in-cidr-set and not-in-cidr-set

  • number: less-than, less-than-equals, greater-than, and greater-than-equals

Definition at line 107 of file BehaviorCriteria.h.

◆ WithConsecutiveDatapointsToAlarm()

BehaviorCriteria& Aws::IoT::Model::BehaviorCriteria::WithConsecutiveDatapointsToAlarm ( int  value)
inline

If a device is in violation of the behavior for the specified number of consecutive datapoints, an alarm occurs. If not specified, the default is 1.

Definition at line 225 of file BehaviorCriteria.h.

◆ WithConsecutiveDatapointsToClear()

BehaviorCriteria& Aws::IoT::Model::BehaviorCriteria::WithConsecutiveDatapointsToClear ( int  value)
inline

If an alarm has occurred and the offending device is no longer in violation of the behavior for the specified number of consecutive datapoints, the alarm is cleared. If not specified, the default is 1.

Definition at line 254 of file BehaviorCriteria.h.

◆ WithDurationSeconds()

BehaviorCriteria& Aws::IoT::Model::BehaviorCriteria::WithDurationSeconds ( int  value)
inline

Use this to specify the time duration over which the behavior is evaluated, for those criteria that have a time dimension (for example, NUM_MESSAGES_SENT). For a statisticalThreshhold metric comparison, measurements from all devices are accumulated over this time duration before being used to calculate percentiles, and later, measurements from an individual device are also accumulated over this time duration before being given a percentile rank. Cannot be used with list-based metric datatypes.

Definition at line 200 of file BehaviorCriteria.h.

◆ WithMlDetectionConfig() [1/2]

BehaviorCriteria& Aws::IoT::Model::BehaviorCriteria::WithMlDetectionConfig ( const MachineLearningDetectionConfig value)
inline

The configuration of an ML Detect

Definition at line 317 of file BehaviorCriteria.h.

◆ WithMlDetectionConfig() [2/2]

BehaviorCriteria& Aws::IoT::Model::BehaviorCriteria::WithMlDetectionConfig ( MachineLearningDetectionConfig &&  value)
inline

The configuration of an ML Detect

Definition at line 322 of file BehaviorCriteria.h.

◆ WithStatisticalThreshold() [1/2]

BehaviorCriteria& Aws::IoT::Model::BehaviorCriteria::WithStatisticalThreshold ( const StatisticalThreshold value)
inline

A statistical ranking (percentile)that indicates a threshold value by which a behavior is determined to be in compliance or in violation of the behavior.

Definition at line 285 of file BehaviorCriteria.h.

◆ WithStatisticalThreshold() [2/2]

BehaviorCriteria& Aws::IoT::Model::BehaviorCriteria::WithStatisticalThreshold ( StatisticalThreshold &&  value)
inline

A statistical ranking (percentile)that indicates a threshold value by which a behavior is determined to be in compliance or in violation of the behavior.

Definition at line 291 of file BehaviorCriteria.h.

◆ WithValue() [1/2]

BehaviorCriteria& Aws::IoT::Model::BehaviorCriteria::WithValue ( const MetricValue value)
inline

The value to be compared with the metric.

Definition at line 146 of file BehaviorCriteria.h.

◆ WithValue() [2/2]

BehaviorCriteria& Aws::IoT::Model::BehaviorCriteria::WithValue ( MetricValue &&  value)
inline

The value to be compared with the metric.

Definition at line 151 of file BehaviorCriteria.h.


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