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

filter: Statementstmt 0.0% 0 / 32 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 34 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::IoTSiteWise::GetAssetPropertyAggregates;
3 use Moose;
4 has AggregateTypes => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['ParamInQuery'], query_name => 'aggregateTypes', required => 1);
5 has AssetId => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'assetId');
6 has EndDate => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'endDate', required => 1);
7 has MaxResults => (is => 'ro', isa => 'Int', traits => ['ParamInQuery'], query_name => 'maxResults');
8 has NextToken => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'nextToken');
9 has PropertyAlias => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'propertyAlias');
10 has PropertyId => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'propertyId');
11 has Qualities => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['ParamInQuery'], query_name => 'qualities');
12 has Resolution => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'resolution', required => 1);
13 has StartDate => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'startDate', required => 1);
14 has TimeOrdering => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'timeOrdering');
15  
16 use MooseX::ClassAttribute;
17  
18 class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetAssetPropertyAggregates');
19 class_has _api_uri => (isa => 'Str', is => 'ro', default => '/properties/aggregates');
20 class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET');
21 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::IoTSiteWise::GetAssetPropertyAggregatesResponse');
22 1;
23  
24 ### main pod documentation begin ###
25  
26 =head1 NAME
27  
28 Paws::IoTSiteWise::GetAssetPropertyAggregates - Arguments for method GetAssetPropertyAggregates on L<Paws::IoTSiteWise>
29  
30 =head1 DESCRIPTION
31  
32 This class represents the parameters used for calling the method GetAssetPropertyAggregates on the
33 L<AWS IoT SiteWise|Paws::IoTSiteWise> service. Use the attributes of this class
34 as arguments to method GetAssetPropertyAggregates.
35  
36 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetAssetPropertyAggregates.
37  
38 =head1 SYNOPSIS
39  
40 my $iotsitewise = Paws->service('IoTSiteWise');
41 my $GetAssetPropertyAggregatesResponse =
42 $iotsitewise->GetAssetPropertyAggregates(
43 AggregateTypes => [
44 'AVERAGE',
45 ... # values: AVERAGE, COUNT, MAXIMUM, MINIMUM, SUM, STANDARD_DEVIATION
46 ],
47 EndDate => '1970-01-01T01:00:00',
48 Resolution => 'MyResolution',
49 StartDate => '1970-01-01T01:00:00',
50 AssetId => 'MyID', # OPTIONAL
51 MaxResults => 1, # OPTIONAL
52 NextToken => 'MyNextToken', # OPTIONAL
53 PropertyAlias => 'MyAssetPropertyAlias', # OPTIONAL
54 PropertyId => 'MyID', # OPTIONAL
55 Qualities => [
56 'GOOD', ... # values: GOOD, BAD, UNCERTAIN
57 ], # OPTIONAL
58 TimeOrdering => 'ASCENDING', # OPTIONAL
59 );
60  
61 # Results:
62 my $AggregatedValues =
63 $GetAssetPropertyAggregatesResponse->AggregatedValues;
64 my $NextToken = $GetAssetPropertyAggregatesResponse->NextToken;
65  
66 # Returns a L<Paws::IoTSiteWise::GetAssetPropertyAggregatesResponse> object.
67  
68 Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object.
69 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/iotsitewise/GetAssetPropertyAggregates>
70  
71 =head1 ATTRIBUTES
72  
73  
74 =head2 B<REQUIRED> AggregateTypes => ArrayRef[Str|Undef]
75  
76 The data aggregating function.
77  
78  
79  
80 =head2 AssetId => Str
81  
82 The ID of the asset.
83  
84  
85  
86 =head2 B<REQUIRED> EndDate => Str
87  
88 The inclusive end of the range from which to query historical data,
89 expressed in seconds in Unix epoch time.
90  
91  
92  
93 =head2 MaxResults => Int
94  
95 The maximum number of results to be returned per paginated request.
96  
97 Default: 100
98  
99  
100  
101 =head2 NextToken => Str
102  
103 The token to be used for the next set of paginated results.
104  
105  
106  
107 =head2 PropertyAlias => Str
108  
109 The property alias that identifies the property, such as an OPC-UA
110 server data stream path (for example,
111 C</company/windfarm/3/turbine/7/temperature>). For more information,
112 see Mapping industrial data streams to asset properties
113 (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html)
114 in the I<AWS IoT SiteWise User Guide>.
115  
116  
117  
118 =head2 PropertyId => Str
119  
120 The ID of the asset property.
121  
122  
123  
124 =head2 Qualities => ArrayRef[Str|Undef]
125  
126 The quality by which to filter asset data.
127  
128  
129  
130 =head2 B<REQUIRED> Resolution => Str
131  
132 The time interval over which to aggregate data.
133  
134  
135  
136 =head2 B<REQUIRED> StartDate => Str
137  
138 The exclusive start of the range from which to query historical data,
139 expressed in seconds in Unix epoch time.
140  
141  
142  
143 =head2 TimeOrdering => Str
144  
145 The chronological sorting order of the requested information.
146  
147 Default: C<ASCENDING>
148  
149 Valid values are: C<"ASCENDING">, C<"DESCENDING">
150  
151  
152 =head1 SEE ALSO
153  
154 This class forms part of L<Paws>, documenting arguments for method GetAssetPropertyAggregates in L<Paws::IoTSiteWise>
155  
156 =head1 BUGS and CONTRIBUTIONS
157  
158 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
159  
160 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
161  
162 =cut
163