Struct aws_sdk_iot::model::BehaviorCriteria
source · [−]#[non_exhaustive]pub struct BehaviorCriteria {
pub comparison_operator: Option<ComparisonOperator>,
pub value: Option<MetricValue>,
pub duration_seconds: Option<i32>,
pub consecutive_datapoints_to_alarm: Option<i32>,
pub consecutive_datapoints_to_clear: Option<i32>,
pub statistical_threshold: Option<StatisticalThreshold>,
pub ml_detection_config: Option<MachineLearningDetectionConfig>,
}
Expand description
The criteria by which the behavior is determined to be normal.
Fields (Non-exhaustive)
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.comparison_operator: 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
value: Option<MetricValue>
The value to be compared with the metric
.
duration_seconds: 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.
consecutive_datapoints_to_alarm: 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.
consecutive_datapoints_to_clear: 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.
statistical_threshold: 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.
ml_detection_config: Option<MachineLearningDetectionConfig>
The configuration of an ML Detect
Implementations
sourceimpl 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
sourceimpl BehaviorCriteria
impl BehaviorCriteria
sourcepub fn builder() -> Builder
pub fn builder() -> Builder
Creates a new builder-style object to manufacture BehaviorCriteria
Trait Implementations
sourceimpl Clone for BehaviorCriteria
impl Clone for BehaviorCriteria
sourcefn clone(&self) -> BehaviorCriteria
fn clone(&self) -> BehaviorCriteria
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for BehaviorCriteria
impl Debug for BehaviorCriteria
sourceimpl PartialEq<BehaviorCriteria> for BehaviorCriteria
impl PartialEq<BehaviorCriteria> for BehaviorCriteria
sourcefn eq(&self, other: &BehaviorCriteria) -> bool
fn eq(&self, other: &BehaviorCriteria) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &BehaviorCriteria) -> bool
fn ne(&self, other: &BehaviorCriteria) -> bool
This method tests for !=
.
impl StructuralPartialEq for BehaviorCriteria
Auto Trait Implementations
impl RefUnwindSafe for BehaviorCriteria
impl Send for BehaviorCriteria
impl Sync for BehaviorCriteria
impl Unpin for BehaviorCriteria
impl UnwindSafe for BehaviorCriteria
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more