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

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

Overview

Contains a summary of a property associated with a model.

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#asset_model_composite_model_id ⇒ String

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

Returns:

  • (String) 


911
912
913
914
915
916
917
918
919
920
921
922
923
 
# File 'lib/aws-sdk-iotsitewise/types.rb', line 911

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

#data_type ⇒ String

The data type of the property.

Returns:

  • (String) 


911
912
913
914
915
916
917
918
919
920
921
922
923
 
# File 'lib/aws-sdk-iotsitewise/types.rb', line 911

class AssetModelPropertySummary < Struct.new(
  :id,
  :external_id,
  :name,
  :data_type,
  :data_type_spec,
  :unit,
  :type,
  :asset_model_composite_model_id,
  :path)
  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) 


911
912
913
914
915
916
917
918
919
920
921
922
923
 
# File 'lib/aws-sdk-iotsitewise/types.rb', line 911

class AssetModelPropertySummary < Struct.new(
  :id,
  :external_id,
  :name,
  :data_type,
  :data_type_spec,
  :unit,
  :type,
  :asset_model_composite_model_id,
  :path)
  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*.

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

Returns:

  • (String) 


911
912
913
914
915
916
917
918
919
920
921
922
923
 
# File 'lib/aws-sdk-iotsitewise/types.rb', line 911

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

#id ⇒ String

The ID of the property.

Returns:

  • (String) 


911
912
913
914
915
916
917
918
919
920
921
922
923
 
# File 'lib/aws-sdk-iotsitewise/types.rb', line 911

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

#name ⇒ String

The name of the property.

Returns:

  • (String) 


911
912
913
914
915
916
917
918
919
920
921
922
923
 
# File 'lib/aws-sdk-iotsitewise/types.rb', line 911

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

#path ⇒ Array<Types::AssetModelPropertyPathSegment>

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

Returns:



911
912
913
914
915
916
917
918
919
920
921
922
923
 
# File 'lib/aws-sdk-iotsitewise/types.rb', line 911

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

#type ⇒ Types::PropertyType

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

Returns:



911
912
913
914
915
916
917
918
919
920
921
922
923
 
# File 'lib/aws-sdk-iotsitewise/types.rb', line 911

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

#unit ⇒ String

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

Returns:

  • (String) 


911
912
913
914
915
916
917
918
919
920
921
922
923
 
# File 'lib/aws-sdk-iotsitewise/types.rb', line 911

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