Class: Aws::IoTSiteWise::Types::AssetModelCompositeModelSummary

Inherits:

Struct

• Object
• Struct
• Aws::IoTSiteWise::Types::AssetModelCompositeModelSummary

Includes:

Structure

Defined in:

lib/aws-sdk-iotsitewise/types.rb

Overview

Contains a summary of the composite model.

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #description ⇒ String

  The description of the composite model that this summary describes..

• #external_id ⇒ String

  The external ID of a composite model on this 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::AssetModelCompositeModelPathSegment>

  The path that includes all the pieces that make up the composite model.

• #type ⇒ String

  The composite model type.

Instance Attribute Details

#description ⇒ String

The description of the composite model that this summary describes..

Returns:

• (String)

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

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

#external_id ⇒ String

The external ID of a composite model on 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)

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

class AssetModelCompositeModelSummary < 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 561

class AssetModelCompositeModelSummary < 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 561

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

#path ⇒ Array<Types::AssetModelCompositeModelPathSegment>

The path that includes all the pieces that make up the composite model.

Returns:

• (Array<Types::AssetModelCompositeModelPathSegment>)

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

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

#type ⇒ String

The composite model type. Valid values are ‘AWS/ALARM`, `CUSTOM`, or ` AWS/L4E_ANOMALY`.

Returns:

• (String)

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

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