File Coverage

blib/lib/Paws/IoT/AttributePayload.pm
Criterion Covered Total %
statement 3 3 100.0
branch n/a
condition n/a
subroutine 1 1 100.0
pod n/a
total 4 4 100.0


line stmt bran cond sub pod time code
1             package Paws::IoT::AttributePayload;
2 1     1   366 use Moose;
  1         2  
  1         6  
3             has Attributes => (is => 'ro', isa => 'Paws::IoT::Attributes', request_name => 'attributes', traits => ['NameInRequest']);
4             has Merge => (is => 'ro', isa => 'Bool', request_name => 'merge', traits => ['NameInRequest']);
5             1;
6              
7             ### main pod documentation begin ###
8              
9             =head1 NAME
10              
11             Paws::IoT::AttributePayload
12              
13             =head1 USAGE
14              
15             This class represents one of two things:
16              
17             =head3 Arguments in a call to a service
18              
19             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
20             Each attribute should be used as a named argument in the calls that expect this type of object.
21              
22             As an example, if Att1 is expected to be a Paws::IoT::AttributePayload object:
23              
24             $service_obj->Method(Att1 => { Attributes => $value, ..., Merge => $value });
25              
26             =head3 Results returned from an API call
27              
28             Use accessors for each attribute. If Att1 is expected to be an Paws::IoT::AttributePayload object:
29              
30             $result = $service_obj->Method(...);
31             $result->Att1->Attributes
32              
33             =head1 DESCRIPTION
34              
35             The attribute payload.
36              
37             =head1 ATTRIBUTES
38              
39              
40             =head2 Attributes => L<Paws::IoT::Attributes>
41              
42             A JSON string containing up to three key-value pair in JSON format. For
43             example:
44              
45             C<{\"attributes\":{\"string1\":\"string2\"}}>
46              
47              
48             =head2 Merge => Bool
49              
50             Specifies whether the list of attributes provided in the
51             C<AttributePayload> is merged with the attributes stored in the
52             registry, instead of overwriting them.
53              
54             To remove an attribute, call C<UpdateThing> with an empty attribute
55             value.
56              
57             The C<merge> attribute is only valid when calling C<UpdateThing>.
58              
59              
60              
61             =head1 SEE ALSO
62              
63             This class forms part of L<Paws>, describing an object used in L<Paws::IoT>
64              
65             =head1 BUGS and CONTRIBUTIONS
66              
67             The source code is located here: https://github.com/pplu/aws-sdk-perl
68              
69             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
70              
71             =cut
72