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

Inherits:

Struct

• Object
• Struct
• Aws::IoTSiteWise::Types::Property

Includes:

Structure

Defined in:

lib/aws-sdk-iotsitewise/types.rb

Overview

Contains asset property information.

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #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`).

• #data_type ⇒ String

  The property data type.

• #external_id ⇒ String

  The external ID of the asset property.

• #id ⇒ String

  The ID of the asset property.

• #name ⇒ String

  The name of the property.

• #notification ⇒ Types::PropertyNotification

  The asset property’s notification topic and state.

• #path ⇒ Array<Types::AssetPropertyPathSegment>

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

• #type ⇒ Types::PropertyType

  The property type (see ‘PropertyType`).

• #unit ⇒ String

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

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)

# File 'lib/aws-sdk-iotsitewise/types.rb', line 8027

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

#data_type ⇒ String

The property data type.

Returns:

• (String)

# File 'lib/aws-sdk-iotsitewise/types.rb', line 8027

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

#external_id ⇒ String

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)

# File 'lib/aws-sdk-iotsitewise/types.rb', line 8027

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

#id ⇒ String

The ID of the asset property.

Returns:

• (String)

# File 'lib/aws-sdk-iotsitewise/types.rb', line 8027

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

#name ⇒ String

The name of the property.

Returns:

• (String)

# File 'lib/aws-sdk-iotsitewise/types.rb', line 8027

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

#notification ⇒ Types::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

Returns:

• (Types::PropertyNotification)

# File 'lib/aws-sdk-iotsitewise/types.rb', line 8027

class Property < Struct.new(
  :id,
  :name,
  :alias,
  :notification,
  :data_type,
  :unit,
  :type,
  :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:

• (Array<Types::AssetPropertyPathSegment>)

# File 'lib/aws-sdk-iotsitewise/types.rb', line 8027

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

#type ⇒ Types::PropertyType

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

Returns:

• (Types::PropertyType)

# File 'lib/aws-sdk-iotsitewise/types.rb', line 8027

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

#unit ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-iotsitewise/types.rb', line 8027

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