Class: Aws::IoTSiteWise::Types::AssetModelHierarchy
- Inherits:
-
Struct
- Object
- Struct
- Aws::IoTSiteWise::Types::AssetModelHierarchy
- Defined in:
- gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb
Overview
Describes an asset hierarchy that contains a hierarchy's name, ID, and child asset model ID that specifies the type of asset that can be in this hierarchy.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#child_asset_model_id ⇒ String
The ID of the asset model, in UUID format.
-
#external_id ⇒ String
The external ID (if any) provided in the [CreateAssetModel][1] or [UpdateAssetModel][2] operation.
-
#id ⇒ String
The ID of the asset model hierarchy.
-
#name ⇒ String
The name of the asset model hierarchy that you specify by using the [CreateAssetModel][1] or [UpdateAssetModel][2] API operation.
Instance Attribute Details
#child_asset_model_id ⇒ String
The ID of the asset model, in UUID format. All assets in this
hierarchy must be instances of the childAssetModelId
asset model.
IoT SiteWise will always return the actual asset model ID for this
value. However, when you are specifying this value as part of a call
to UpdateAssetModel, you may provide either the asset model ID
or else externalId:
followed by the asset model's external ID.
For more information, see Using external IDs in the IoT
SiteWise User Guide.
647 648 649 650 651 652 653 654 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 647 class AssetModelHierarchy < Struct.new( :id, :name, :child_asset_model_id, :external_id) SENSITIVE = [] include Aws::Structure end |
#external_id ⇒ String
The external ID (if any) provided in the CreateAssetModel or UpdateAssetModel operation. You can assign an external ID by specifying this value as part of a call to UpdateAssetModel. However, you can't change the external ID if one is already assigned. For more information, see Using external IDs in the IoT SiteWise User Guide.
647 648 649 650 651 652 653 654 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 647 class AssetModelHierarchy < Struct.new( :id, :name, :child_asset_model_id, :external_id) SENSITIVE = [] include Aws::Structure end |
#id ⇒ String
The ID of the asset model hierarchy. This ID is a hierarchyId
.
If you are callling UpdateAssetModel to create a new hierarchy: You can specify its ID here, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.
If you are calling UpdateAssetModel to modify an existing hierarchy: This can be either the actual ID in UUID format, or else
externalId:
followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
647 648 649 650 651 652 653 654 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 647 class AssetModelHierarchy < Struct.new( :id, :name, :child_asset_model_id, :external_id) SENSITIVE = [] include Aws::Structure end |
#name ⇒ String
The name of the asset model hierarchy that you specify by using the CreateAssetModel or UpdateAssetModel API operation.
647 648 649 650 651 652 653 654 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 647 class AssetModelHierarchy < Struct.new( :id, :name, :child_asset_model_id, :external_id) SENSITIVE = [] include Aws::Structure end |