Class: Aws::IoTSiteWise::Types::AssetModelPropertySummary

Inherits:

Struct

• Object
• Struct
• Aws::IoTSiteWise::Types::AssetModelPropertySummary

Includes:

Structure

Defined in:

lib/aws-sdk-iotsitewise/types.rb

Overview

Contains a summary of a property associated with a model. This includes information about which interfaces the property belongs to, if any.

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #asset_model_composite_model_id ⇒ String

  The ID of the composite model that contains the asset model property.

• #data_type ⇒ String

  The data type of the property.

• #data_type_spec ⇒ String

  The data type of the structure for this property.

• #external_id ⇒ String

  The external ID of the property.

• #id ⇒ String

  The ID of the property.

• #interface_summaries ⇒ Array<Types::InterfaceSummary>

  A list of interface summaries that describe which interfaces this property belongs to, including the interface asset model ID and the corresponding property ID in the interface.

• #name ⇒ String

  The name of the property.

• #path ⇒ Array<Types::AssetModelPropertyPathSegment>

  The structured path to the property from the root of the asset model.

• #type ⇒ Types::PropertyType

  Contains a property type, which can be one of attribute, measurement, metric, or transform.

• #unit ⇒ String

  The unit (such as Newtons or RPM) of the property.

Instance Attribute Details

#asset_model_composite_model_id ⇒ String

The ID of the composite model that contains the asset model property.

Returns:

• (String)

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

class AssetModelPropertySummary < Struct.new(
  :id,
  :external_id,
  :name,
  :data_type,
  :data_type_spec,
  :unit,
  :type,
  :asset_model_composite_model_id,
  :path,
  :interface_summaries)
  SENSITIVE = []
  include Aws::Structure
end

#data_type ⇒ String

The data type of the property.

Returns:

• (String)

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

class AssetModelPropertySummary < Struct.new(
  :id,
  :external_id,
  :name,
  :data_type,
  :data_type_spec,
  :unit,
  :type,
  :asset_model_composite_model_id,
  :path,
  :interface_summaries)
  SENSITIVE = []
  include Aws::Structure
end

#data_type_spec ⇒ String

The data type of the structure for this property. This parameter exists on properties that have the STRUCT data type.

Returns:

• (String)

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

class AssetModelPropertySummary < Struct.new(
  :id,
  :external_id,
  :name,
  :data_type,
  :data_type_spec,
  :unit,
  :type,
  :asset_model_composite_model_id,
  :path,
  :interface_summaries)
  SENSITIVE = []
  include Aws::Structure
end

#external_id ⇒ String

The external ID of the property. For more information, see Using external IDs in the IoT SiteWise User Guide.

Returns:

• (String)

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

class AssetModelPropertySummary < Struct.new(
  :id,
  :external_id,
  :name,
  :data_type,
  :data_type_spec,
  :unit,
  :type,
  :asset_model_composite_model_id,
  :path,
  :interface_summaries)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ String

The ID of the property.

Returns:

• (String)

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

class AssetModelPropertySummary < Struct.new(
  :id,
  :external_id,
  :name,
  :data_type,
  :data_type_spec,
  :unit,
  :type,
  :asset_model_composite_model_id,
  :path,
  :interface_summaries)
  SENSITIVE = []
  include Aws::Structure
end

#interface_summaries ⇒ Array<Types::InterfaceSummary>

A list of interface summaries that describe which interfaces this property belongs to, including the interface asset model ID and the corresponding property ID in the interface.

Returns:

• (Array<Types::InterfaceSummary>)

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

class AssetModelPropertySummary < Struct.new(
  :id,
  :external_id,
  :name,
  :data_type,
  :data_type_spec,
  :unit,
  :type,
  :asset_model_composite_model_id,
  :path,
  :interface_summaries)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the property.

Returns:

• (String)

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

class AssetModelPropertySummary < Struct.new(
  :id,
  :external_id,
  :name,
  :data_type,
  :data_type_spec,
  :unit,
  :type,
  :asset_model_composite_model_id,
  :path,
  :interface_summaries)
  SENSITIVE = []
  include Aws::Structure
end

#path ⇒ Array<Types::AssetModelPropertyPathSegment>

The structured path to the property from the root of the asset model.

Returns:

• (Array<Types::AssetModelPropertyPathSegment>)

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

class AssetModelPropertySummary < Struct.new(
  :id,
  :external_id,
  :name,
  :data_type,
  :data_type_spec,
  :unit,
  :type,
  :asset_model_composite_model_id,
  :path,
  :interface_summaries)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ Types::PropertyType

Contains a property type, which can be one of attribute, measurement, metric, or transform.

Returns:

• (Types::PropertyType)

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

class AssetModelPropertySummary < Struct.new(
  :id,
  :external_id,
  :name,
  :data_type,
  :data_type_spec,
  :unit,
  :type,
  :asset_model_composite_model_id,
  :path,
  :interface_summaries)
  SENSITIVE = []
  include Aws::Structure
end

#unit ⇒ String

The unit (such as Newtons or RPM) of the property.

Returns:

• (String)

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

class AssetModelPropertySummary < Struct.new(
  :id,
  :external_id,
  :name,
  :data_type,
  :data_type_spec,
  :unit,
  :type,
  :asset_model_composite_model_id,
  :path,
  :interface_summaries)
  SENSITIVE = []
  include Aws::Structure
end