software.amazon.awscdk.services.iotsitewise

Interface CfnAssetModel.AssetModelPropertyProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAssetModel.AssetModelPropertyProperty.Jsii$Proxy

Enclosing class:

CfnAssetModel

@Stability(value=Stable)
public static interface CfnAssetModel.AssetModelPropertyProperty
extends software.amazon.jsii.JsiiSerializable

Contains information about an asset model property.

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.*;
 AssetModelPropertyProperty assetModelPropertyProperty = AssetModelPropertyProperty.builder()
         .dataType("dataType")
         .logicalId("logicalId")
         .name("name")
         .type(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()
                                         .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())
                 .transform(TransformProperty.builder()
                         .expression("expression")
                         .variables(List.of(ExpressionVariableProperty.builder()
                                 .name("name")
                                 .value(VariableValueProperty.builder()
                                         .propertyLogicalId("propertyLogicalId")
                                         // the properties below are optional
                                         .hierarchyLogicalId("hierarchyLogicalId")
                                         .build())
                                 .build()))
                         .build())
                 .build())
         // the properties below are optional
         .dataTypeSpec("dataTypeSpec")
         .unit("unit")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnAssetModel.AssetModelPropertyProperty.Builder	builder()
String	getDataType() The data type of the asset model property.
default String	getDataTypeSpec() The data type of the structure for this property.
String	getLogicalId() The `LogicalID` of the asset model property.
String	getName() The name of the asset model property.
Object	getType() Contains a property type, which can be one of `Attribute` , `Measurement` , `Metric` , or `Transform` .
default String	getUnit() The unit of the asset model property, such as `Newtons` or `RPM` .

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getDataType

@Stability(value=Stable)
 @NotNull
String getDataType()

The data type of the asset model property.

The value can be STRING , INTEGER , DOUBLE , BOOLEAN , or STRUCT .

getLogicalId

@Stability(value=Stable)
 @NotNull
String getLogicalId()

The `LogicalID` of the asset model property.

The maximum length is 256 characters, with the pattern [^\\ u0000-\\ u001F\\ u007F]+ .

getName

@Stability(value=Stable)
 @NotNull
String getName()

The name of the asset model property.

The maximum length is 256 characters with the pattern [^\ u0000-\ u001F\ u007F]+ .

getType

@Stability(value=Stable)
 @NotNull
Object getType()

Contains a property type, which can be one of `Attribute` , `Measurement` , `Metric` , or `Transform` .

getDataTypeSpec

@Stability(value=Stable)
 @Nullable
default String getDataTypeSpec()

The data type of the structure for this property.

This parameter exists on properties that have the STRUCT data type.

getUnit

@Stability(value=Stable)
 @Nullable
default String getUnit()

The unit of the asset model property, such as `Newtons` or `RPM` .

builder

@Stability(value=Stable)
static CfnAssetModel.AssetModelPropertyProperty.Builder builder()

Returns:

a CfnAssetModel.AssetModelPropertyProperty.Builder of CfnAssetModel.AssetModelPropertyProperty