Struct aws_sdk_iotsitewise::types::Metric

#[non_exhaustive]
pub struct Metric {
    pub expression: String,
    pub variables: Vec<ExpressionVariable>,
    pub window: Option<MetricWindow>,
    pub processing_config: Option<MetricProcessingConfig>,
}

Contains an asset metric property. With metrics, you can calculate aggregate functions, such as an average, maximum, or minimum, as specified through an expression. A metric maps several values to a single value (such as a sum).

The maximum number of dependent/cascading variables used in any one metric calculation is 10. Therefore, a root metric can have up to 10 cascading metrics in its computational dependency tree. Additionally, a metric can only have a data type of DOUBLE and consume properties with data types of INTEGER or DOUBLE.

For more information, see Metrics in the IoT SiteWise User Guide.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

expression: String

The mathematical expression that defines the metric aggregation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression.

For more information, see Quotas in the IoT SiteWise User Guide.

variables: Vec<ExpressionVariable>

The list of variables used in the expression.

window: Option<MetricWindow>

The window (time interval) over which IoT SiteWise computes the metric's aggregation expression. IoT SiteWise computes one data point per window.

processing_config: Option<MetricProcessingConfig>

The processing configuration for the given metric property. You can configure metrics to be computed at the edge or in the Amazon Web Services Cloud. By default, metrics are forwarded to the cloud.

Implementations

impl Metric

pub fn expression(&self) -> &str

The mathematical expression that defines the metric aggregation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression.

For more information, see Quotas in the IoT SiteWise User Guide.

pub fn variables(&self) -> &[ExpressionVariable]

The list of variables used in the expression.

pub fn window(&self) -> Option<&MetricWindow>

The window (time interval) over which IoT SiteWise computes the metric's aggregation expression. IoT SiteWise computes one data point per window.

pub fn processing_config(&self) -> Option<&MetricProcessingConfig>

The processing configuration for the given metric property. You can configure metrics to be computed at the edge or in the Amazon Web Services Cloud. By default, metrics are forwarded to the cloud.

impl Metric

pub fn builder() -> MetricBuilder

Creates a new builder-style object to manufacture Metric.

Trait Implementations

impl Clone for Metric

fn clone(&self) -> Metric

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Metric

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for Metric

fn eq(&self, other: &Metric) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Metric