AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::IoTSiteWise::Types::AssetModelCompositeModel

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

{
  name: "Name", # required
  description: "Description",
  type: "Name", # required
  properties: [
    {
      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 a composite model in an asset model. This object contains the asset property definitions that you define in the composite model.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

The description of the composite model.

Returns:

  • (String)


346
347
348
349
350
351
352
353
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 346

class AssetModelCompositeModel < Struct.new(
  :name,
  :description,
  :type,
  :properties)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The name of the composite model.

Returns:

  • (String)


346
347
348
349
350
351
352
353
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 346

class AssetModelCompositeModel < Struct.new(
  :name,
  :description,
  :type,
  :properties)
  SENSITIVE = []
  include Aws::Structure
end

#propertiesArray<Types::AssetModelProperty>

The asset property definitions for this composite model.

Returns:



346
347
348
349
350
351
352
353
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 346

class AssetModelCompositeModel < Struct.new(
  :name,
  :description,
  :type,
  :properties)
  SENSITIVE = []
  include Aws::Structure
end

#typeString

The type of the composite model. For alarm composite models, this type is AWS/ALARM.

Returns:

  • (String)


346
347
348
349
350
351
352
353
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 346

class AssetModelCompositeModel < Struct.new(
  :name,
  :description,
  :type,
  :properties)
  SENSITIVE = []
  include Aws::Structure
end