Struct aws_sdk_iot::model::BehaviorCriteria
source · #[non_exhaustive]pub struct BehaviorCriteria { /* private fields */ }
Expand description
The criteria by which the behavior is determined to be normal.
Implementations§
source§impl BehaviorCriteria
impl BehaviorCriteria
sourcepub fn comparison_operator(&self) -> Option<&ComparisonOperator>
pub fn comparison_operator(&self) -> Option<&ComparisonOperator>
The operator that relates the thing measured (metric
) to the criteria (containing a value
or statisticalThreshold
). Valid operators include:
-
string-list
:in-set
andnot-in-set
-
number-list
:in-set
andnot-in-set
-
ip-address-list
:in-cidr-set
andnot-in-cidr-set
-
number
:less-than
,less-than-equals
,greater-than
, andgreater-than-equals
sourcepub fn value(&self) -> Option<&MetricValue>
pub fn value(&self) -> Option<&MetricValue>
The value to be compared with the metric
.
sourcepub fn duration_seconds(&self) -> Option<i32>
pub fn duration_seconds(&self) -> Option<i32>
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.
sourcepub fn consecutive_datapoints_to_alarm(&self) -> Option<i32>
pub fn consecutive_datapoints_to_alarm(&self) -> Option<i32>
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.
sourcepub fn consecutive_datapoints_to_clear(&self) -> Option<i32>
pub fn consecutive_datapoints_to_clear(&self) -> Option<i32>
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.
sourcepub fn statistical_threshold(&self) -> Option<&StatisticalThreshold>
pub fn statistical_threshold(&self) -> Option<&StatisticalThreshold>
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.
sourcepub fn ml_detection_config(&self) -> Option<&MachineLearningDetectionConfig>
pub fn ml_detection_config(&self) -> Option<&MachineLearningDetectionConfig>
The configuration of an ML Detect
source§impl BehaviorCriteria
impl BehaviorCriteria
sourcepub fn builder() -> Builder
pub fn builder() -> Builder
Creates a new builder-style object to manufacture BehaviorCriteria
.
Trait Implementations§
source§impl Clone for BehaviorCriteria
impl Clone for BehaviorCriteria
source§fn clone(&self) -> BehaviorCriteria
fn clone(&self) -> BehaviorCriteria
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for BehaviorCriteria
impl Debug for BehaviorCriteria
source§impl PartialEq<BehaviorCriteria> for BehaviorCriteria
impl PartialEq<BehaviorCriteria> for BehaviorCriteria
source§fn eq(&self, other: &BehaviorCriteria) -> bool
fn eq(&self, other: &BehaviorCriteria) -> bool
self
and other
values to be equal, and is used
by ==
.