software.amazon.awscdk.services.iotsitewise

Interface CfnAssetModel.MetricProperty

All Known Implementing Classes:

CfnAssetModel.MetricProperty.Jsii$Proxy

Enclosing class:

CfnAssetModel

public static interface CfnAssetModel.MetricProperty

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 .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.iotsitewise.*;
 MetricProperty metricProperty = MetricProperty.builder()
         .expression("expression")
         .variables(List.of(ExpressionVariableProperty.builder()
                 .name("name")
                 .value(VariableValueProperty.builder()
                         .propertyLogicalId("propertyLogicalId")
                         // the properties below are optional
                         .hierarchyLogicalId("hierarchyLogicalId")
                         .build())
                 .build()))
         .window(MetricWindowProperty.builder()
                 .tumbling(TumblingWindowProperty.builder()
                         .interval("interval")
                         // the properties below are optional
                         .offset("offset")
                         .build())
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnAssetModel.MetricProperty.Builder A builder for CfnAssetModel.MetricProperty
static class	CfnAssetModel.MetricProperty.Jsii$Proxy An implementation for CfnAssetModel.MetricProperty

Method Summary

Modifier and Type	Method and Description
static CfnAssetModel.MetricProperty.Builder	builder()
java.lang.String	getExpression() The mathematical expression that defines the metric aggregation function.
java.lang.Object	getVariables() The list of variables used in the expression.
java.lang.Object	getWindow() The window (time interval) over which AWS IoT SiteWise computes the metric's aggregation expression.

Method Detail

getExpression

java.lang.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

java.lang.Object getVariables()

The list of variables used in the expression.

getWindow

java.lang.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

static CfnAssetModel.MetricProperty.Builder builder()

Returns:

a CfnAssetModel.MetricProperty.Builder of CfnAssetModel.MetricProperty