Class: Aws::IoTSiteWise::Types::AssetProperty

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

Overview

Contains asset property information.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#aliasString

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)


1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
# File 'lib/aws-sdk-iotsitewise/types.rb', line 1077

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

#data_typeString

The data type of the asset property.

Returns:

  • (String)


1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
# File 'lib/aws-sdk-iotsitewise/types.rb', line 1077

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

#data_type_specString

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

Returns:

  • (String)


1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
# File 'lib/aws-sdk-iotsitewise/types.rb', line 1077

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

#external_idString

The external ID of the asset property. For more information, see

Using external IDs][1

in the *IoT SiteWise User Guide*.

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

Returns:

  • (String)


1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
# File 'lib/aws-sdk-iotsitewise/types.rb', line 1077

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

#idString

The ID of the asset property.

Returns:

  • (String)


1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
# File 'lib/aws-sdk-iotsitewise/types.rb', line 1077

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

#nameString

The name of the property.

Returns:

  • (String)


1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
# File 'lib/aws-sdk-iotsitewise/types.rb', line 1077

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

#notificationTypes::PropertyNotification

The asset property’s notification topic and state. For more information, see [UpdateAssetProperty].

[1]: docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html



1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
# File 'lib/aws-sdk-iotsitewise/types.rb', line 1077

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

#pathArray<Types::AssetPropertyPathSegment>

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



1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
# File 'lib/aws-sdk-iotsitewise/types.rb', line 1077

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

#unitString

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

Returns:

  • (String)


1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
# File 'lib/aws-sdk-iotsitewise/types.rb', line 1077

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