blib/lib/Paws/IoTEvents/IotSiteWiseAction.pm untested

filter: Statementstmt 0.0% 0 / 13 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 14 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
CRAP 2.0
1 # Generated by default/object.tt
2 package Paws::IoTEvents::IotSiteWiseAction;
3 use Moose;
4 has AssetId => (is => 'ro', isa => 'Str', request_name => 'assetId', traits => ['NameInRequest']);
5 has EntryId => (is => 'ro', isa => 'Str', request_name => 'entryId', traits => ['NameInRequest']);
6 has PropertyAlias => (is => 'ro', isa => 'Str', request_name => 'propertyAlias', traits => ['NameInRequest']);
7 has PropertyId => (is => 'ro', isa => 'Str', request_name => 'propertyId', traits => ['NameInRequest']);
8 has PropertyValue => (is => 'ro', isa => 'Paws::IoTEvents::AssetPropertyValue', request_name => 'propertyValue', traits => ['NameInRequest']);
9  
10 1;
11  
12 ### main pod documentation begin ###
13  
14 =head1 NAME
15  
16 Paws::IoTEvents::IotSiteWiseAction
17  
18 =head1 USAGE
19  
20 This class represents one of two things:
21  
22 =head3 Arguments in a call to a service
23  
24 Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
25 Each attribute should be used as a named argument in the calls that expect this type of object.
26  
27 As an example, if Att1 is expected to be a Paws::IoTEvents::IotSiteWiseAction object:
28  
29 $service_obj->Method(Att1 => { AssetId => $value, ..., PropertyValue => $value });
30  
31 =head3 Results returned from an API call
32  
33 Use accessors for each attribute. If Att1 is expected to be an Paws::IoTEvents::IotSiteWiseAction object:
34  
35 $result = $service_obj->Method(...);
36 $result->Att1->AssetId
37  
38 =head1 DESCRIPTION
39  
40 Sends information about the detector model instance and the event that
41 triggered the action to a specified asset property in AWS IoT SiteWise.
42  
43 You must use expressions for all parameters in C<IotSiteWiseAction>.
44 The expressions accept literals, operators, functions, references, and
45 substitutions templates.
46  
47 B<Examples>
48  
49 =over
50  
51 =item *
52  
53 For literal values, the expressions must contain single quotes. For
54 example, the value for the C<propertyAlias> parameter can be
55 C<'/company/windfarm/3/turbine/7/temperature'>.
56  
57 =item *
58  
59 For references, you must specify either variables or input values. For
60 example, the value for the C<assetId> parameter can be
61 C<$input.TurbineInput.assetId1>.
62  
63 =item *
64  
65 For a substitution template, you must use C<${}>, and the template must
66 be in single quotes. A substitution template can also contain a
67 combination of literals, operators, functions, references, and
68 substitution templates.
69  
70 In the following example, the value for the C<propertyAlias> parameter
71 uses a substitution template.
72  
73 C<'company/windfarm/${$input.TemperatureInput.sensorData.windfarmID}/turbine/
74 ${$input.TemperatureInput.sensorData.turbineID}/temperature'>
75  
76 =back
77  
78 You must specify either C<propertyAlias> or both C<assetId> and
79 C<propertyId> to identify the target asset property in AWS IoT
80 SiteWise.
81  
82 For more information, see Expressions
83 (https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html)
84 in the I<AWS IoT Events Developer Guide>.
85  
86 =head1 ATTRIBUTES
87  
88  
89 =head2 AssetId => Str
90  
91 The ID of the asset that has the specified property.
92  
93  
94 =head2 EntryId => Str
95  
96 A unique identifier for this entry. You can use the entry ID to track
97 which data entry causes an error in case of failure. The default is a
98 new unique identifier.
99  
100  
101 =head2 PropertyAlias => Str
102  
103 The alias of the asset property.
104  
105  
106 =head2 PropertyId => Str
107  
108 The ID of the asset property.
109  
110  
111 =head2 PropertyValue => L<Paws::IoTEvents::AssetPropertyValue>
112  
113 The value to send to the asset property. This value contains timestamp,
114 quality, and value (TQV) information.
115  
116  
117  
118 =head1 SEE ALSO
119  
120 This class forms part of L<Paws>, describing an object used in L<Paws::IoTEvents>
121  
122 =head1 BUGS and CONTRIBUTIONS
123  
124 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
125  
126 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
127  
128 =cut
129