Class: Aws::IoTSiteWise::Types::AssetModelProperty

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 AssetModelProperty data as a hash:

{
  id: "ID",
  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 information about an asset model property.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#data_typeString

The data type of the asset model property.

Returns:

  • (String)


615
616
617
618
619
620
621
622
623
624
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 615

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

#data_type_specString

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

Returns:

  • (String)


615
616
617
618
619
620
621
622
623
624
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 615

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

#idString

The ID of the asset model property.

Returns:

  • (String)


615
616
617
618
619
620
621
622
623
624
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 615

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

#nameString

The name of the asset model property.

Returns:

  • (String)


615
616
617
618
619
620
621
622
623
624
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 615

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

#typeTypes::PropertyType

The property type (see PropertyType).

Returns:



615
616
617
618
619
620
621
622
623
624
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 615

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

#unitString

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

Returns:

  • (String)


615
616
617
618
619
620
621
622
623
624
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 615

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