Class: Aws::IoTSiteWise::Types::Metric

Inherits:

Struct

• Object
• Struct
• Aws::IoTSiteWise::Types::Metric

Includes:

Structure

Defined in:

lib/aws-sdk-iotsitewise/types.rb

Overview

Contains an asset metric property. With metrics, you can calculate aggregate functions, such as an average, maximum, or minimum, as specified through an expression. A metric maps several values to a single value (such as a sum).

The maximum number of dependent/cascading variables used in any one metric calculation is 10. Therefore, a root metric can have up to 10 cascading metrics in its computational dependency tree. Additionally, a metric can only have a data type of ‘DOUBLE` and consume properties with data types of `INTEGER` or `DOUBLE`.

For more information, see [Metrics] in the *IoT SiteWise User Guide*.

[1]: docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html#metrics

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #expression ⇒ String

  The mathematical expression that defines the metric aggregation function.

• #processing_config ⇒ Types::MetricProcessingConfig

  The processing configuration for the given metric property.

• #variables ⇒ Array<Types::ExpressionVariable>

  The list of variables used in the expression.

• #window ⇒ Types::MetricWindow

  The window (time interval) over which IoT SiteWise computes the metric’s aggregation expression.

Instance Attribute Details

#expression ⇒ String

The mathematical expression that defines the metric aggregation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression.

For more information, see [Quotas] in the *IoT SiteWise User Guide*.

[1]: docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html

Returns:

• (String)

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

class Metric < Struct.new(
  :expression,
  :variables,
  :window,
  :processing_config)
  SENSITIVE = []
  include Aws::Structure
end

#processing_config ⇒ Types::MetricProcessingConfig

The processing configuration for the given metric property. You can configure metrics to be computed at the edge or in the Amazon Web Services Cloud. By default, metrics are forwarded to the cloud.

Returns:

• (Types::MetricProcessingConfig)

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

class Metric < Struct.new(
  :expression,
  :variables,
  :window,
  :processing_config)
  SENSITIVE = []
  include Aws::Structure
end

#variables ⇒ Array<Types::ExpressionVariable>

The list of variables used in the expression.

Returns:

• (Array<Types::ExpressionVariable>)

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

class Metric < Struct.new(
  :expression,
  :variables,
  :window,
  :processing_config)
  SENSITIVE = []
  include Aws::Structure
end

#window ⇒ Types::MetricWindow

The window (time interval) over which IoT SiteWise computes the metric’s aggregation expression. IoT SiteWise computes one data point per ‘window`.

Returns:

• (Types::MetricWindow)

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

class Metric < Struct.new(
  :expression,
  :variables,
  :window,
  :processing_config)
  SENSITIVE = []
  include Aws::Structure
end