class Aws::IoTSiteWise::Types::Metric
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*.
[1]: docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html#metrics
@note When making an API call, you may pass Metric
data as a hash: { expression: "Expression", # required variables: [ # required { name: "VariableName", # required value: { # required property_id: "Macro", # required hierarchy_id: "Macro", }, }, ], window: { # required tumbling: { interval: "Interval", # required offset: "Offset", }, }, processing_config: { compute_location: "EDGE", # required, accepts EDGE, CLOUD }, }
@!attribute [rw] expression
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][1] in the *IoT SiteWise User Guide*. [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html @return [String]
@!attribute [rw] variables
The list of variables used in the expression. @return [Array<Types::ExpressionVariable>]
@!attribute [rw] window
The window (time interval) over which IoT SiteWise computes the metric's aggregation expression. IoT SiteWise computes one data point per `window`. @return [Types::MetricWindow]
@!attribute [rw] processing_config
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. @return [Types::MetricProcessingConfig]
Constants
- SENSITIVE