blib/lib/Paws/IoTSiteWise/Metric.pm untested

filter: Statementstmt 0.0% 0 / 9 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 10 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
CRAP 2.0
1 # Generated by default/object.tt
2 package Paws::IoTSiteWise::Metric;
3 use Moose;
4 has Expression => (is => 'ro', isa => 'Str', request_name => 'expression', traits => ['NameInRequest'], required => 1);
5 has Variables => (is => 'ro', isa => 'ArrayRef[Paws::IoTSiteWise::ExpressionVariable]', request_name => 'variables', traits => ['NameInRequest'], required => 1);
6 has Window => (is => 'ro', isa => 'Paws::IoTSiteWise::MetricWindow', request_name => 'window', traits => ['NameInRequest'], required => 1);
7  
8 1;
9  
10 ### main pod documentation begin ###
11  
12 =head1 NAME
13  
14 Paws::IoTSiteWise::Metric
15  
16 =head1 USAGE
17  
18 This class represents one of two things:
19  
20 =head3 Arguments in a call to a service
21  
22 Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
23 Each attribute should be used as a named argument in the calls that expect this type of object.
24  
25 As an example, if Att1 is expected to be a Paws::IoTSiteWise::Metric object:
26  
27 $service_obj->Method(Att1 => { Expression => $value, ..., Window => $value });
28  
29 =head3 Results returned from an API call
30  
31 Use accessors for each attribute. If Att1 is expected to be an Paws::IoTSiteWise::Metric object:
32  
33 $result = $service_obj->Method(...);
34 $result->Att1->Expression
35  
36 =head1 DESCRIPTION
37  
38 Contains an asset metric property. With metrics, you can calculate
39 aggregate functions, such as an average, maximum, or minimum, as
40 specified through an expression. A metric maps several values to a
41 single value (such as a sum).
42  
43 The maximum number of dependent/cascading variables used in any one
44 metric calculation is 10. Therefore, a I<root> metric can have up to 10
45 cascading metrics in its computational dependency tree. Additionally, a
46 metric can only have a data type of C<DOUBLE> and consume properties
47 with data types of C<INTEGER> or C<DOUBLE>.
48  
49 For more information, see Metrics
50 (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html#metrics)
51 in the I<AWS IoT SiteWise User Guide>.
52  
53 =head1 ATTRIBUTES
54  
55  
56 =head2 B<REQUIRED> Expression => Str
57  
58 The mathematical expression that defines the metric aggregation
59 function. You can specify up to 10 variables per expression. You can
60 specify up to 10 functions per expression.
61  
62 For more information, see Quotas
63 (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html)
64 in the I<AWS IoT SiteWise User Guide>.
65  
66  
67 =head2 B<REQUIRED> Variables => ArrayRef[L<Paws::IoTSiteWise::ExpressionVariable>]
68  
69 The list of variables used in the expression.
70  
71  
72 =head2 B<REQUIRED> Window => L<Paws::IoTSiteWise::MetricWindow>
73  
74 The window (time interval) over which AWS IoT SiteWise computes the
75 metric's aggregation expression. AWS IoT SiteWise computes one data
76 point per C<window>.
77  
78  
79  
80 =head1 SEE ALSO
81  
82 This class forms part of L<Paws>, describing an object used in L<Paws::IoTSiteWise>
83  
84 =head1 BUGS and CONTRIBUTIONS
85  
86 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
87  
88 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
89  
90 =cut
91