Class: Aws::IoTSiteWise::Types::AssetModelHierarchyDefinition

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-iotsitewise/types.rb

Overview

Contains an asset model hierarchy used in asset model creation. An asset model hierarchy determines the kind (or type) of asset that can belong to a hierarchy.

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#child_asset_model_id ⇒ String

The ID of an asset model for this 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*.

[1]: docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references

Returns:

  • (String) 


692
693
694
695
696
697
698
699
 
# File 'lib/aws-sdk-iotsitewise/types.rb', line 692

class AssetModelHierarchyDefinition < Struct.new(
  :id,
  :external_id,
  :name,
  :child_asset_model_id)
  SENSITIVE = []
  include Aws::Structure
end

#external_id ⇒ String

An external ID to assign to the asset model hierarchy. The external ID must be unique among asset model hierarchies within this asset model. For more information, see [Using external IDs] in the *IoT SiteWise User Guide*.

[1]: docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids

Returns:

  • (String) 


692
693
694
695
696
697
698
699
 
# File 'lib/aws-sdk-iotsitewise/types.rb', line 692

class AssetModelHierarchyDefinition < Struct.new(
  :id,
  :external_id,
  :name,
  :child_asset_model_id)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ String

The ID to assign to the asset model hierarchy, 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.

Returns:

  • (String) 


692
693
694
695
696
697
698
699
 
# File 'lib/aws-sdk-iotsitewise/types.rb', line 692

class AssetModelHierarchyDefinition < Struct.new(
  :id,
  :external_id,
  :name,
  :child_asset_model_id)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the asset model hierarchy definition (as specified in the [CreateAssetModel] or [UpdateAssetModel] API operation).

[1]: docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModel.html [2]: docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html

Returns:

  • (String) 


692
693
694
695
696
697
698
699
 
# File 'lib/aws-sdk-iotsitewise/types.rb', line 692

class AssetModelHierarchyDefinition < Struct.new(
  :id,
  :external_id,
  :name,
  :child_asset_model_id)
  SENSITIVE = []
  include Aws::Structure
end