Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.IoTSiteWise.Types.Metric

Description

Synopsis

data Metric = Metric' {
- processingConfig :: Maybe MetricProcessingConfig
- expression :: Text
- variables :: [ExpressionVariable]
- window :: MetricWindow
}
newMetric :: Text -> MetricWindow -> Metric
metric_processingConfig :: Lens' Metric (Maybe MetricProcessingConfig)
metric_expression :: Lens' Metric Text
metric_variables :: Lens' Metric [ExpressionVariable]
metric_window :: Lens' Metric MetricWindow

Documentation

data Metric Source #

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.

See: newMetric smart constructor.

Constructors

Metric'

Fields

processingConfig :: Maybe 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.
expression :: Text
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.
variables :: [ExpressionVariable]
The list of variables used in the expression.
window :: MetricWindow
The window (time interval) over which IoT SiteWise computes the metric's aggregation expression. IoT SiteWise computes one data point per window.

Instances

Instances details

Eq Metric Source #
Instance details Defined in Amazonka.IoTSiteWise.Types.Metric Methods (==) :: Metric -> Metric -> Bool # (/=) :: Metric -> Metric -> Bool #
Read Metric Source #
Instance details Defined in Amazonka.IoTSiteWise.Types.Metric Methods readsPrec :: Int -> ReadS Metric # readList :: ReadS [Metric] # readPrec :: ReadPrec Metric # readListPrec :: ReadPrec [Metric] #
Show Metric Source #
Instance details Defined in Amazonka.IoTSiteWise.Types.Metric Methods showsPrec :: Int -> Metric -> ShowS # show :: Metric -> String # showList :: [Metric] -> ShowS #
Generic Metric Source #
Instance details Defined in Amazonka.IoTSiteWise.Types.Metric Associated Types type Rep Metric :: Type -> Type # Methods from :: Metric -> Rep Metric x # to :: Rep Metric x -> Metric #
NFData Metric Source #
Instance details Defined in Amazonka.IoTSiteWise.Types.Metric Methods rnf :: Metric -> () #
Hashable Metric Source #
Instance details Defined in Amazonka.IoTSiteWise.Types.Metric Methods hashWithSalt :: Int -> Metric -> Int # hash :: Metric -> Int #
ToJSON Metric Source #
Instance details Defined in Amazonka.IoTSiteWise.Types.Metric Methods toJSON :: Metric -> Value # toEncoding :: Metric -> Encoding # toJSONList :: [Metric] -> Value # toEncodingList :: [Metric] -> Encoding #
FromJSON Metric Source #
Instance details Defined in Amazonka.IoTSiteWise.Types.Metric Methods parseJSON :: Value -> Parser Metric # parseJSONList :: Value -> Parser [Metric] #
type Rep Metric Source #
Instance details Defined in Amazonka.IoTSiteWise.Types.Metric type Rep Metric = D1 ('MetaData "Metric" "Amazonka.IoTSiteWise.Types.Metric" "libZSservicesZSamazonka-iotsitewiseZSamazonka-iotsitewise" 'False) (C1 ('MetaCons "Metric'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "processingConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MetricProcessingConfig)) :: S1 ('MetaSel ('Just "expression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "variables") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [ExpressionVariable]) :*: S1 ('MetaSel ('Just "window") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 MetricWindow))))

newMetric Source #

Arguments

:: Text	`$sel:expression:Metric'`
-> MetricWindow	`$sel:window:Metric'`
-> Metric

Create a value of Metric with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:processingConfig:Metric', metric_processingConfig - 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.

$sel:expression:Metric', metric_expression - 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.

$sel:variables:Metric', metric_variables - The list of variables used in the expression.

$sel:window:Metric', metric_window - The window (time interval) over which IoT SiteWise computes the metric's aggregation expression. IoT SiteWise computes one data point per window.

metric_processingConfig :: Lens' Metric (Maybe MetricProcessingConfig) Source #

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.

metric_expression :: Lens' Metric Text Source #

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.

metric_variables :: Lens' Metric [ExpressionVariable] Source #

The list of variables used in the expression.

metric_window :: Lens' Metric MetricWindow Source #

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