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

Inherits:

Struct

• Object
• Struct
• Aws::IoTSiteWise::Types::AssetModelPropertyDefinition

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, STRUCT
  data_type_spec: "Name",
  unit: "PropertyUnit",
  type: { # required
    attribute: {
      default_value: "DefaultValue",
    },
    measurement: {
      processing_config: {
        forwarding_config: { # required
          state: "DISABLED", # required, accepts DISABLED, ENABLED
        },
      },
    },
    transform: {
      expression: "Expression", # required
      variables: [ # required
        {
          name: "VariableName", # required
          value: { # required
            property_id: "Macro", # required
            hierarchy_id: "Macro",
          },
        },
      ],
      processing_config: {
        compute_location: "EDGE", # required, accepts EDGE, CLOUD
        forwarding_config: {
          state: "DISABLED", # required, accepts DISABLED, ENABLED
        },
      },
    },
    metric: {
      expression: "Expression", # required
      variables: [ # required
        {
          name: "VariableName", # required
          value: { # required
            property_id: "Macro", # required
            hierarchy_id: "Macro",
          },
        },
      ],
      window: { # required
        tumbling: {
          interval: "Interval", # required
          offset: "Offset",
        },
      },
      processing_config: {
        compute_location: "EDGE", # required, accepts EDGE, CLOUD
      },
    },
  },
}

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

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #data_type ⇒ String

  The data type of the property definition.

• #data_type_spec ⇒ String

  The data type of the structure for this property.

• #name ⇒ String

  The name of the property definition.

• #type ⇒ Types::PropertyType

  The property definition type (see PropertyType).

• #unit ⇒ String

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

Instance Attribute Details

#data_type ⇒ String

The data type of the property definition.

If you specify STRUCT, you must also specify dataTypeSpec to identify the type of the structure for this property.

Returns:

• (String)

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

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

#data_type_spec ⇒ String

The data type of the structure for this property. This parameter is required on properties that have the STRUCT data type.

The options for this parameter depend on the type of the composite model in which you define this property. Use AWS/ALARM_STATE for alarm state in alarm composite models.

Returns:

• (String)

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

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

#name ⇒ String

The name of the property definition.

Returns:

• (String)

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

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

#type ⇒ Types::PropertyType

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

Returns:

• (Types::PropertyType)

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

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

#unit ⇒ String

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

Returns:

• (String)

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

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