AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::IoTSiteWise::Types::Property

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-iotsitewise/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.

Returns:

  • (String)


5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 5290

class Property < Struct.new(
  :id,
  :name,
  :alias,
  :notification,
  :data_type,
  :unit,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#data_typeString

The property data type.

Returns:

  • (String)


5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 5290

class Property < Struct.new(
  :id,
  :name,
  :alias,
  :notification,
  :data_type,
  :unit,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#idString

The ID of the asset property.

Returns:

  • (String)


5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 5290

class Property < Struct.new(
  :id,
  :name,
  :alias,
  :notification,
  :data_type,
  :unit,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The name of the property.

Returns:

  • (String)


5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 5290

class Property < Struct.new(
  :id,
  :name,
  :alias,
  :notification,
  :data_type,
  :unit,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#notificationTypes::PropertyNotification

The asset property's notification topic and state. For more information, see UpdateAssetProperty.



5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 5290

class Property < Struct.new(
  :id,
  :name,
  :alias,
  :notification,
  :data_type,
  :unit,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#typeTypes::PropertyType

The property type (see PropertyType). A property contains one type.

Returns:



5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 5290

class Property < Struct.new(
  :id,
  :name,
  :alias,
  :notification,
  :data_type,
  :unit,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#unitString

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

Returns:

  • (String)


5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 5290

class Property < Struct.new(
  :id,
  :name,
  :alias,
  :notification,
  :data_type,
  :unit,
  :type)
  SENSITIVE = []
  include Aws::Structure
end