You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Contains asset property information.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#alias ⇒ String

The property 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 AWS IoT SiteWise User Guide.

Returns:

  • (String) —

    The property alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature).

#data_type ⇒ String

The property data type.

Possible values:

  • STRING
  • INTEGER
  • DOUBLE
  • BOOLEAN

Returns:

  • (String) —

    The property data type.

#id ⇒ String

The ID of the asset property.

Returns:

  • (String) —

    The ID of the asset property.

#name ⇒ String

The name of the property.

Returns:

  • (String) —

    The name of the property.

#notification ⇒ Types::PropertyNotification

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

Returns:

#type ⇒ Types::PropertyType

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

Returns:

#unit ⇒ String

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

Returns:

  • (String) —

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