Package 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(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")
         .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()
                                         .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())
         // the properties below are optional
         .dataTypeSpec("dataTypeSpec")
         .externalId("externalId")
         .id("id")
         .logicalId("logicalId")
         .unit("unit")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	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.
default String	getExternalId()	The external ID of the asset property.
default String	getId()	The ID of the property.
default 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 Details

getDataType

@Stability(Stable)
@NotNull
String getDataType()

The data type of the asset model property.

If you specify STRUCT , you must also specify dataTypeSpec to identify the type of the structure for this property.

See Also:

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

getName

@Stability(Stable)
@NotNull
String getName()

The name of the asset model property.

See Also:

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

getType

@Stability(Stable)
@NotNull
Object getType()

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

Returns union: either IResolvable or CfnAssetModel.PropertyTypeProperty

See Also:

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

getDataTypeSpec

@Stability(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.

See Also:

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

getExternalId

@Stability(Stable)
@Nullable
default String getExternalId()

The external ID of the asset property.

For more information, see Using external IDs in the AWS IoT SiteWise User Guide .

One of ExternalId or LogicalId must be specified.

See Also:

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

getId

@Stability(Stable)
@Nullable
default String getId()

The ID of the property.

This is a return value and can't be set.

See Also:

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

getLogicalId

@Stability(Stable)
@Nullable
default String getLogicalId()

The LogicalID of the asset model property.

One of ExternalId or LogicalId must be specified.

See Also:

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

getUnit

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

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

See Also:

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

builder

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

Returns:

a CfnAssetModel.AssetModelPropertyProperty.Builder of CfnAssetModel.AssetModelPropertyProperty