Class: Aws::IoTSiteWise::Types::AssetPropertySummary

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

Overview

Contains a summary of a property associated with an asset.

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#alias ⇒ String

The alias that identifies the property, such as an OPC-UA server data stream path (for example, ‘/company/windfarm/3/turbine/7/temperature`). For more information, see [Mapping industrial data streams to asset properties] in the *IoT SiteWise User Guide*.

[1]: docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html

Returns:

  • (String) 


1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
 
# File 'lib/aws-sdk-iotsitewise/types.rb', line 1163

class AssetPropertySummary < Struct.new(
  :id,
  :alias,
  :unit,
  :notification,
  :asset_composite_model_id,
  :path,
  :external_id)
  SENSITIVE = []
  include Aws::Structure
end

#asset_composite_model_id ⇒ String

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

Returns:

  • (String) 


1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
 
# File 'lib/aws-sdk-iotsitewise/types.rb', line 1163

class AssetPropertySummary < Struct.new(
  :id,
  :alias,
  :unit,
  :notification,
  :asset_composite_model_id,
  :path,
  :external_id)
  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) 


1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
 
# File 'lib/aws-sdk-iotsitewise/types.rb', line 1163

class AssetPropertySummary < Struct.new(
  :id,
  :alias,
  :unit,
  :notification,
  :asset_composite_model_id,
  :path,
  :external_id)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ String

The ID of the property.

Returns:

  • (String) 


1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
 
# File 'lib/aws-sdk-iotsitewise/types.rb', line 1163

class AssetPropertySummary < Struct.new(
  :id,
  :alias,
  :unit,
  :notification,
  :asset_composite_model_id,
  :path,
  :external_id)
  SENSITIVE = []
  include Aws::Structure
end

#notification ⇒ Types::PropertyNotification

Contains asset property value notification information. When the notification state is enabled, IoT SiteWise publishes property value updates to a unique MQTT topic. For more information, see

Interacting with other services][1

in the *IoT SiteWise User

Guide*.

[1]: docs.aws.amazon.com/iot-sitewise/latest/userguide/interact-with-other-services.html

Returns:



1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
 
# File 'lib/aws-sdk-iotsitewise/types.rb', line 1163

class AssetPropertySummary < Struct.new(
  :id,
  :alias,
  :unit,
  :notification,
  :asset_composite_model_id,
  :path,
  :external_id)
  SENSITIVE = []
  include Aws::Structure
end

#path ⇒ Array<Types::AssetPropertyPathSegment>

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

Returns:



1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
 
# File 'lib/aws-sdk-iotsitewise/types.rb', line 1163

class AssetPropertySummary < Struct.new(
  :id,
  :alias,
  :unit,
  :notification,
  :asset_composite_model_id,
  :path,
  :external_id)
  SENSITIVE = []
  include Aws::Structure
end

#unit ⇒ String

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

Returns:

  • (String) 


1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
 
# File 'lib/aws-sdk-iotsitewise/types.rb', line 1163

class AssetPropertySummary < Struct.new(
  :id,
  :alias,
  :unit,
  :notification,
  :asset_composite_model_id,
  :path,
  :external_id)
  SENSITIVE = []
  include Aws::Structure
end