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::Metric

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

{
  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 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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#expressionString

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.

Returns:

  • (String)


5009
5010
5011
5012
5013
5014
5015
5016
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 5009

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

#processing_configTypes::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.



5009
5010
5011
5012
5013
5014
5015
5016
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 5009

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

#variablesArray<Types::ExpressionVariable>

The list of variables used in the expression.

Returns:



5009
5010
5011
5012
5013
5014
5015
5016
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 5009

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

#windowTypes::MetricWindow

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

Returns:



5009
5010
5011
5012
5013
5014
5015
5016
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 5009

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