Class: Aws::IoTSiteWise::Types::PropertyType

Inherits:

Struct

• Object
• Struct
• Aws::IoTSiteWise::Types::PropertyType

Defined in:

gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb

Overview

Note:

When making an API call, you may pass PropertyType data as a hash:

{
  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 a property type, which can be one of attribute, measurement, metric, or transform.

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #attribute ⇒ Types::Attribute

  Specifies an asset attribute property.

• #measurement ⇒ Types::Measurement

  Specifies an asset measurement property.

• #metric ⇒ Types::Metric

  Specifies an asset metric property.

• #transform ⇒ Types::Transform

  Specifies an asset transform property.

Instance Attribute Details

#attribute ⇒ Types::Attribute

Specifies an asset attribute property. An attribute generally contains static information, such as the serial number of an IIoT wind turbine.

Returns:

• (Types::Attribute)

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

class PropertyType < Struct.new(
  :attribute,
  :measurement,
  :transform,
  :metric)
  SENSITIVE = []
  include Aws::Structure
end

#measurement ⇒ Types::Measurement

Specifies an asset measurement property. A measurement represents a device's raw sensor data stream, such as timestamped temperature values or timestamped power values.

Returns:

• (Types::Measurement)

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

class PropertyType < Struct.new(
  :attribute,
  :measurement,
  :transform,
  :metric)
  SENSITIVE = []
  include Aws::Structure
end

#metric ⇒ Types::Metric

Specifies an asset metric property. A metric contains a mathematical expression that uses aggregate functions to process all input data points over a time interval and output a single data point, such as to calculate the average hourly temperature.

Returns:

• (Types::Metric)

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

class PropertyType < Struct.new(
  :attribute,
  :measurement,
  :transform,
  :metric)
  SENSITIVE = []
  include Aws::Structure
end

#transform ⇒ Types::Transform

Specifies an asset transform property. A transform contains a mathematical expression that maps a property's data points from one form to another, such as a unit conversion from Celsius to Fahrenheit.

Returns:

• (Types::Transform)

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

class PropertyType < Struct.new(
  :attribute,
  :measurement,
  :transform,
  :metric)
  SENSITIVE = []
  include Aws::Structure
end