Interface CfnAssetModel.MetricProperty

All Superinterfaces:
All Known Implementing Classes:
Enclosing class:

@Stability(Stable) public static interface CfnAssetModel.MetricProperty extends
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 Defining data properties in the AWS IoT SiteWise User Guide .


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 MetricProperty metricProperty = MetricProperty.builder()
                         // the properties below are optional
                         // the properties below are optional
  • Method Details

    • getExpression

      @Stability(Stable) @NotNull String getExpression()
      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 .

    • getVariables

      @Stability(Stable) @NotNull Object getVariables()
      The list of variables used in the expression.
    • getWindow

      @Stability(Stable) @NotNull Object getWindow()
      The window (time interval) over which AWS IoT SiteWise computes the metric's aggregation expression.

      AWS IoT SiteWise computes one data point per window .

    • builder

      @Stability(Stable) static CfnAssetModel.MetricProperty.Builder builder()
      a CfnAssetModel.MetricProperty.Builder of CfnAssetModel.MetricProperty