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

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

Overview

Note:

When making an API call, you may pass AssetModelPropertyDefinition data as a 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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#data_typeString

The data type of the property definition.

Returns:

  • (String)


377
378
379
380
381
382
383
384
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 377

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

#nameString

The name of the property definition.

Returns:

  • (String)


377
378
379
380
381
382
383
384
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 377

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

#typeTypes::PropertyType

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

Returns:



377
378
379
380
381
382
383
384
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 377

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

#unitString

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

Returns:

  • (String)


377
378
379
380
381
382
383
384
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 377

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