Package software.amazon.awscdk.services.iotsitewise

Interface CfnAssetModel.MetricProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAssetModel.MetricProperty.Jsii$Proxy

Enclosing class:

CfnAssetModel

@Stability(Stable)
public static interface CfnAssetModel.MetricProperty
extends software.amazon.jsii.JsiiSerializable

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 .

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()
                         .hierarchyExternalId("hierarchyExternalId")
                         .hierarchyId("hierarchyId")
                         .hierarchyLogicalId("hierarchyLogicalId")
                         .propertyExternalId("propertyExternalId")
                         .propertyId("propertyId")
                         .propertyLogicalId("propertyLogicalId")
                         .propertyPath(List.of(PropertyPathDefinitionProperty.builder()
                                 .name("name")
                                 .build()))
                         .build())
                 .build()))
         .window(MetricWindowProperty.builder()
                 .tumbling(TumblingWindowProperty.builder()
                         .interval("interval")
                         // the properties below are optional
                         .offset("offset")
                         .build())
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-metric.html

Nested Class Summary

Nested Classes

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

Method Summary

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-metric.html#cfn-iotsitewise-assetmodel-metric-expression

getVariables

@Stability(Stable)
@NotNull
Object getVariables()

The list of variables used in the expression.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-metric.html#cfn-iotsitewise-assetmodel-metric-variables

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-metric.html#cfn-iotsitewise-assetmodel-metric-window

builder

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

Returns:

a CfnAssetModel.MetricProperty.Builder of CfnAssetModel.MetricProperty