You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::IoTSiteWise::Types::Metric

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing Metric as input to an Aws::Client method, you can use a vanilla Hash:

{
  expression: "Expression", # required
  variables: [ # required
    {
      name: "VariableName", # required
      value: { # required
        property_id: "Macro", # required
        hierarchy_id: "Macro",
      },
    },
  ],
  window: { # required
    tumbling: {
      interval: "Interval", # required
    },
  },
}

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 AWS IoT SiteWise User Guide.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#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 AWS IoT SiteWise User Guide.

Returns:

  • (String) —

    The mathematical expression that defines the metric aggregation function.

#variables ⇒ Array<Types::ExpressionVariable>

The list of variables used in the expression.

Returns:

#window ⇒ Types::MetricWindow

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

Returns:

  • (Types::MetricWindow) —

    The window (time interval) over which AWS IoT SiteWise computes the metric\'s aggregation expression.