blib/lib/Paws/DynamoDB/KeysAndAttributes.pm

filter: Statementstmt 100% 9 / 9 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 100% 1 / 1 Podpod n/a totaltotal 100% 10 / 10 CC 1 SCAR 0.0
CC
1
Cov
100%
BEGIN
1.0
CRAP 1.0
« blib/lib/Paws/DynamoDB/KeySchemaElement.pm ↑ Summary blib/lib/Paws/DynamoDB/ListTables.pm »
1 # Generated by default/object.tt
2 package Paws::DynamoDB::KeysAndAttributes;
3 2 ▶ use Moose;
Subroutine BEGIN: called CC=1 SCAR=0.0
4 2 has AttributesToGet => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
5 2 has ConsistentRead => (is => 'ro', isa => 'Bool');
6 2 has ExpressionAttributeNames => (is => 'ro', isa => 'Paws::DynamoDB::ExpressionAttributeNameMap');
7 2 has Keys => (is => 'ro', isa => 'ArrayRef[Paws::DynamoDB::Key]', required => 1);
8 2 has ProjectionExpression => (is => 'ro', isa => 'Str');
9  
10 2 1;
11  
12 ### main pod documentation begin ###
13  
14 =head1 NAME
15  
16 Paws::DynamoDB::KeysAndAttributes
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::DynamoDB::KeysAndAttributes object:
28  
29 $service_obj->Method(Att1 => { AttributesToGet => $value, ..., ProjectionExpression => $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::DynamoDB::KeysAndAttributes object:
34  
35 $result = $service_obj->Method(...);
36 $result->Att1->AttributesToGet
37  
38 =head1 DESCRIPTION
39  
40 Represents a set of primary keys and, for each key, the attributes to
41 retrieve from the table.
42  
43 For each primary key, you must provide I<all> of the key attributes.
44 For example, with a simple primary key, you only need to provide the
45 partition key. For a composite primary key, you must provide I<both>
46 the partition key and the sort key.
47  
48 =head1 ATTRIBUTES
49  
50  
51 =head2 AttributesToGet => ArrayRef[Str|Undef]
52  
53 This is a legacy parameter. Use C<ProjectionExpression> instead. For
54 more information, see Legacy Conditional Parameters
55 (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.html)
56 in the I<Amazon DynamoDB Developer Guide>.
57  
58  
59 =head2 ConsistentRead => Bool
60  
61 The consistency of a read operation. If set to C<true>, then a strongly
62 consistent read is used; otherwise, an eventually consistent read is
63 used.
64  
65  
66 =head2 ExpressionAttributeNames => L<Paws::DynamoDB::ExpressionAttributeNameMap>
67  
68 One or more substitution tokens for attribute names in an expression.
69 The following are some use cases for using C<ExpressionAttributeNames>:
70  
71 =over
72  
73 =item *
74  
75 To access an attribute whose name conflicts with a DynamoDB reserved
76 word.
77  
78 =item *
79  
80 To create a placeholder for repeating occurrences of an attribute name
81 in an expression.
82  
83 =item *
84  
85 To prevent special characters in an attribute name from being
86 misinterpreted in an expression.
87  
88 =back
89  
90 Use the B<#> character in an expression to dereference an attribute
91 name. For example, consider the following attribute name:
92  
93 =over
94  
95 =item *
96  
97 C<Percentile>
98  
99 =back
100  
101 The name of this attribute conflicts with a reserved word, so it cannot
102 be used directly in an expression. (For the complete list of reserved
103 words, see Reserved Words
104 (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html)
105 in the I<Amazon DynamoDB Developer Guide>). To work around this, you
106 could specify the following for C<ExpressionAttributeNames>:
107  
108 =over
109  
110 =item *
111  
112 C<{"#P":"Percentile"}>
113  
114 =back
115  
116 You could then use this substitution in an expression, as in this
117 example:
118  
119 =over
120  
121 =item *
122  
123 C<#P = :val>
124  
125 =back
126  
127 Tokens that begin with the B<:> character are I<expression attribute
128 values>, which are placeholders for the actual value at runtime.
129  
130 For more information on expression attribute names, see Accessing Item
131 Attributes
132 (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html)
133 in the I<Amazon DynamoDB Developer Guide>.
134  
135  
136 =head2 B<REQUIRED> Keys => ArrayRef[L<Paws::DynamoDB::Key>]
137  
138 The primary key attribute values that define the items and the
139 attributes associated with the items.
140  
141  
142 =head2 ProjectionExpression => Str
143  
144 A string that identifies one or more attributes to retrieve from the
145 table. These attributes can include scalars, sets, or elements of a
146 JSON document. The attributes in the C<ProjectionExpression> must be
147 separated by commas.
148  
149 If no attribute names are specified, then all attributes will be
150 returned. If any of the requested attributes are not found, they will
151 not appear in the result.
152  
153 For more information, see Accessing Item Attributes
154 (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html)
155 in the I<Amazon DynamoDB Developer Guide>.
156  
157  
158  
159 =head1 SEE ALSO
160  
161 This class forms part of L<Paws>, describing an object used in L<Paws::DynamoDB>
162  
163 =head1 BUGS and CONTRIBUTIONS
164  
165 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
166  
167 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
168  
169 =cut
170  
« blib/lib/Paws/DynamoDB/KeySchemaElement.pm ↑ Summary blib/lib/Paws/DynamoDB/ListTables.pm »