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, STRUCT
  data_type_spec: "Name",
  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_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) 


612
613
614
615
616
617
618
619
620
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 612

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) 


612
613
614
615
616
617
618
619
620
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 612

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) 


612
613
614
615
616
617
618
619
620
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 612

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:



612
613
614
615
616
617
618
619
620
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 612

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) 


612
613
614
615
616
617
618
619
620
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 612

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