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

Class: Aws::IoTSiteWise::Types::AssetModelPropertyDefinition

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

Overview

Note:

When passing AssetModelPropertyDefinition as input to an Aws::Client method, you can use a vanilla Hash:

{
  name: "Name", # required
  data_type: "STRING", # required, accepts STRING, INTEGER, DOUBLE, BOOLEAN
  unit: "PropertyUnit",
  type: { # required
    attribute: {
      default_value: "DefaultValue",
    },
    measurement: {
    },
    transform: {
      expression: "Expression", # required
      variables: [ # required
        {
          name: "VariableName", # required
          value: { # required
            property_id: "Macro", # required
            hierarchy_id: "Macro",
          },
        },
      ],
    },
    metric: {
      expression: "Expression", # required
      variables: [ # required
        {
          name: "VariableName", # required
          value: { # required
            property_id: "Macro", # required
            hierarchy_id: "Macro",
          },
        },
      ],
      window: { # required
        tumbling: {
          interval: "Interval", # required
        },
      },
    },
  },
}

Contains an asset model property definition. This property definition is applied to all assets created from the asset model.

Instance Attribute Summary collapse

Instance Attribute Details

#data_type ⇒ String

The data type of the property definition.

Possible values:

  • STRING
  • INTEGER
  • DOUBLE
  • BOOLEAN

Returns:

  • (String) —

    The data type of the property definition.

#name ⇒ String

The name of the property definition.

Returns:

  • (String) —

    The name of the property definition.

#type ⇒ Types::PropertyType

The property definition type (see PropertyType). You can only specify one type in a property definition.

Returns:

#unit ⇒ String

The unit of the property definition, such as Newtons or RPM.

Returns:

  • (String) —

    The unit of the property definition, such as Newtons or RPM.