Class: Aws::IoTSiteWise::Types::AssetCompositeModelSummary

Inherits:

Struct

• Object
• Struct
• Aws::IoTSiteWise::Types::AssetCompositeModelSummary

Includes:

Structure

Defined in:

lib/aws-sdk-iotsitewise/types.rb

Overview

Contains a summary of the composite model for a specific asset.

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #description ⇒ String

  A description of the composite model that this summary describes.

• #external_id ⇒ String

  An external ID to assign to the asset model.

• #id ⇒ String

  The ID of the composite model that this summary describes.

• #name ⇒ String

  The name of the composite model that this summary describes.

• #path ⇒ Array<Types::AssetCompositeModelPathSegment>

  The path that includes all the components of the asset model for the asset.

• #type ⇒ String

  The type of asset model.

Instance Attribute Details

#description ⇒ String

A description of the composite model that this summary describes.

Returns:

• (String)

# File 'lib/aws-sdk-iotsitewise/types.rb', line 325

class AssetCompositeModelSummary < Struct.new(
  :id,
  :external_id,
  :name,
  :type,
  :description,
  :path)
  SENSITIVE = []
  include Aws::Structure
end

#external_id ⇒ String

An external ID to assign to the asset model.

If the composite model is a derived composite model, or one nested inside a component model, you can only set the external ID using ‘UpdateAssetModelCompositeModel` and specifying the derived ID of the model or property from the created model it’s a part of.

Returns:

• (String)

# File 'lib/aws-sdk-iotsitewise/types.rb', line 325

class AssetCompositeModelSummary < Struct.new(
  :id,
  :external_id,
  :name,
  :type,
  :description,
  :path)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ String

The ID of the composite model that this summary describes.

Returns:

• (String)

# File 'lib/aws-sdk-iotsitewise/types.rb', line 325

class AssetCompositeModelSummary < Struct.new(
  :id,
  :external_id,
  :name,
  :type,
  :description,
  :path)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the composite model that this summary describes.

Returns:

• (String)

# File 'lib/aws-sdk-iotsitewise/types.rb', line 325

class AssetCompositeModelSummary < Struct.new(
  :id,
  :external_id,
  :name,
  :type,
  :description,
  :path)
  SENSITIVE = []
  include Aws::Structure
end

#path ⇒ Array<Types::AssetCompositeModelPathSegment>

The path that includes all the components of the asset model for the asset.

Returns:

• (Array<Types::AssetCompositeModelPathSegment>)

# File 'lib/aws-sdk-iotsitewise/types.rb', line 325

class AssetCompositeModelSummary < Struct.new(
  :id,
  :external_id,
  :name,
  :type,
  :description,
  :path)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

The type of asset model.

• ASSET_MODEL – (default) An asset model that you can use to create assets. Can’t be included as a component in another asset model.

• COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can’t create assets directly from this type of asset model.

Returns:

• (String)

# File 'lib/aws-sdk-iotsitewise/types.rb', line 325

class AssetCompositeModelSummary < Struct.new(
  :id,
  :external_id,
  :name,
  :type,
  :description,
  :path)
  SENSITIVE = []
  include Aws::Structure
end