File Coverage

blib/lib/Paws/DynamoDB/AttributeValue.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1             package Paws::DynamoDB::AttributeValue;
2 1     1   449 use Moose;
  1     2   5  
  1         10  
  2         981  
  2         4  
  2         15  
3             has B => (is => 'ro', isa => 'Str');
4             has BOOL => (is => 'ro', isa => 'Bool');
5             has BS => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
6             has L => (is => 'ro', isa => 'ArrayRef[Paws::DynamoDB::AttributeValue]');
7             has M => (is => 'ro', isa => 'Paws::DynamoDB::MapAttributeValue');
8             has N => (is => 'ro', isa => 'Str');
9             has NS => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
10             has NULL => (is => 'ro', isa => 'Bool');
11             has S => (is => 'ro', isa => 'Str');
12             has SS => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
13             1;
14              
15             ### main pod documentation begin ###
16              
17             =head1 NAME
18              
19             Paws::DynamoDB::AttributeValue
20              
21             =head1 USAGE
22              
23             This class represents one of two things:
24              
25             =head3 Arguments in a call to a service
26              
27             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
28             Each attribute should be used as a named argument in the calls that expect this type of object.
29              
30             As an example, if Att1 is expected to be a Paws::DynamoDB::AttributeValue object:
31              
32             $service_obj->Method(Att1 => { B => $value, ..., SS => $value });
33              
34             =head3 Results returned from an API call
35              
36             Use accessors for each attribute. If Att1 is expected to be an Paws::DynamoDB::AttributeValue object:
37              
38             $result = $service_obj->Method(...);
39             $result->Att1->B
40              
41             =head1 DESCRIPTION
42              
43             Represents the data for an attribute.
44              
45             Each attribute value is described as a name-value pair. The name is the
46             data type, and the value is the data itself.
47              
48             For more information, see Data Types in the I<Amazon DynamoDB Developer
49             Guide>.
50              
51             =head1 ATTRIBUTES
52              
53              
54             =head2 B => Str
55              
56             An attribute of type Binary. For example:
57              
58             C<"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk">
59              
60              
61             =head2 BOOL => Bool
62              
63             An attribute of type Boolean. For example:
64              
65             C<"BOOL": true>
66              
67              
68             =head2 BS => ArrayRef[Str|Undef]
69              
70             An attribute of type Binary Set. For example:
71              
72             C<"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]>
73              
74              
75             =head2 L => ArrayRef[L<Paws::DynamoDB::AttributeValue>]
76              
77             An attribute of type List. For example:
78              
79             C<"L": ["Cookies", "Coffee", 3.14159]>
80              
81              
82             =head2 M => L<Paws::DynamoDB::MapAttributeValue>
83              
84             An attribute of type Map. For example:
85              
86             C<"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}>
87              
88              
89             =head2 N => Str
90              
91             An attribute of type Number. For example:
92              
93             C<"N": "123.45">
94              
95             Numbers are sent across the network to DynamoDB as strings, to maximize
96             compatibility across languages and libraries. However, DynamoDB treats
97             them as number type attributes for mathematical operations.
98              
99              
100             =head2 NS => ArrayRef[Str|Undef]
101              
102             An attribute of type Number Set. For example:
103              
104             C<"NS": ["42.2", "-19", "7.5", "3.14"]>
105              
106             Numbers are sent across the network to DynamoDB as strings, to maximize
107             compatibility across languages and libraries. However, DynamoDB treats
108             them as number type attributes for mathematical operations.
109              
110              
111             =head2 NULL => Bool
112              
113             An attribute of type Null. For example:
114              
115             C<"NULL": true>
116              
117              
118             =head2 S => Str
119              
120             An attribute of type String. For example:
121              
122             C<"S": "Hello">
123              
124              
125             =head2 SS => ArrayRef[Str|Undef]
126              
127             An attribute of type String Set. For example:
128              
129             C<"SS": ["Giraffe", "Hippo" ,"Zebra"]>
130              
131              
132              
133             =head1 SEE ALSO
134              
135             This class forms part of L<Paws>, describing an object used in L<Paws::DynamoDB>
136              
137             =head1 BUGS and CONTRIBUTIONS
138              
139             The source code is located here: https://github.com/pplu/aws-sdk-perl
140              
141             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
142              
143             =cut
144