Interface CfnAssetModel.AssetModelCompositeModelProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnAssetModel.AssetModelCompositeModelProperty.Jsii$Proxy
- Enclosing class:
CfnAssetModel
@Stability(Stable)
public static interface CfnAssetModel.AssetModelCompositeModelProperty
extends software.amazon.jsii.JsiiSerializable
Contains information about a composite model in an asset model.
This object contains the asset property definitions that you define in the composite model.
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.*; AssetModelCompositeModelProperty assetModelCompositeModelProperty = AssetModelCompositeModelProperty.builder() .name("name") .type("type") // the properties below are optional .composedAssetModelId("composedAssetModelId") .compositeModelProperties(List.of(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())) .description("description") .externalId("externalId") .id("id") .parentAssetModelCompositeModelExternalId("parentAssetModelCompositeModelExternalId") .path(List.of("path")) .build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnAssetModel.AssetModelCompositeModelProperty
static final class
An implementation forCfnAssetModel.AssetModelCompositeModelProperty
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default String
The ID of a component model which is reused to create this composite model.default Object
The asset property definitions for this composite model.default String
The description of the composite model.default String
The external ID of a composite model on this asset model.default String
getId()
The ID of the asset model composite model.getName()
The name of the composite model.default String
The external ID of the parent composite model.getPath()
The structured path to the property from the root of the asset using property names.getType()
The type of the composite model.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getName
The name of the composite model.- See Also:
-
getType
The type of the composite model.For alarm composite models, this type is
AWS/ALARM
.- See Also:
-
getComposedAssetModelId
The ID of a component model which is reused to create this composite model.- See Also:
-
getCompositeModelProperties
The asset property definitions for this composite model.- See Also:
-
getDescription
The description of the composite model.If the composite model is a
component-model-based
composite model, the description is inherited from theCOMPONENT_MODEL
asset model and cannot be changed.- See Also:
-
getExternalId
The external ID of a composite model on this asset model.For more information, see Using external IDs in the AWS IoT SiteWise User Guide .
One of
ExternalId
orPath
must be specified.- See Also:
-
getId
The ID of the asset model composite model.This is a return value and can't be set.
- See Also:
-
getParentAssetModelCompositeModelExternalId
The external ID of the parent composite model.For more information, see Using external IDs in the AWS IoT SiteWise User Guide .
- See Also:
-
getPath
The structured path to the property from the root of the asset using property names.Path is used as the ID if the asset model is a derived composite model.
One of
ExternalId
orPath
must be specified.- See Also:
-
builder
-