Package software.amazon.awscdk.services.iotsitewise

Interface CfnAssetModel.PropertyTypeProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAssetModel.PropertyTypeProperty.Jsii$Proxy

Enclosing class:

CfnAssetModel

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

Contains a property type, which can be one of attribute , measurement , metric , or transform .

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.*;
 PropertyTypeProperty propertyTypeProperty = PropertyTypeProperty.builder()
         .typeName("typeName")
         // the properties below are optional
         .attribute(AttributeProperty.builder()
                 .defaultValue("defaultValue")
                 .build())
         .metric(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())
         .transform(TransformProperty.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()))
                 .build())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnAssetModel.PropertyTypeProperty.Builder	builder()
default Object	getAttribute()	Specifies an asset attribute property.
default Object	getMetric()	Specifies an asset metric property.
default Object	getTransform()	Specifies an asset transform property.
String	getTypeName()	The type of property type, which can be one of Attribute , Measurement , Metric , or Transform .

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getTypeName

@Stability(Stable)
@NotNull
String getTypeName()

The type of property type, which can be one of Attribute , Measurement , Metric , or Transform .

See Also:

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

getAttribute

@Stability(Stable)
@Nullable
default Object getAttribute()

Specifies an asset attribute property.

An attribute generally contains static information, such as the serial number of an IIoT wind turbine.

See Also:

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

getMetric

@Stability(Stable)
@Nullable
default Object getMetric()

Specifies an asset metric property.

A metric contains a mathematical expression that uses aggregate functions to process all input data points over a time interval and output a single data point, such as to calculate the average hourly temperature.

See Also:

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

getTransform

@Stability(Stable)
@Nullable
default Object getTransform()

Specifies an asset transform property.

A transform contains a mathematical expression that maps a property's data points from one form to another, such as a unit conversion from Celsius to Fahrenheit.

See Also:

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

builder

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

Returns:

a CfnAssetModel.PropertyTypeProperty.Builder of CfnAssetModel.PropertyTypeProperty