blib/lib/Paws/DynamoDB/KeySchemaElement.pm

filter: Statementstmt 100% 6 / 6 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 100% 1 / 1 Podpod n/a totaltotal 100% 7 / 7 CC 1 SCAR 0.0
CC
1
Cov
100%
BEGIN
1.0
CRAP 1.0
« blib/lib/Paws/DynamoDB/Key.pm ↑ Summary blib/lib/Paws/DynamoDB/KeysAndAttributes.pm »
1 # Generated by default/object.tt
2 package Paws::DynamoDB::KeySchemaElement;
3 1 ▶ use Moose;
Subroutine BEGIN: called CC=1 SCAR=0.0
4 1 has AttributeName => (is => 'ro', isa => 'Str', required => 1);
5 1 has KeyType => (is => 'ro', isa => 'Str', required => 1);
6  
7 1 1;
8  
9 ### main pod documentation begin ###
10  
11 =head1 NAME
12  
13 Paws::DynamoDB::KeySchemaElement
14  
15 =head1 USAGE
16  
17 This class represents one of two things:
18  
19 =head3 Arguments in a call to a service
20  
21 Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
22 Each attribute should be used as a named argument in the calls that expect this type of object.
23  
24 As an example, if Att1 is expected to be a Paws::DynamoDB::KeySchemaElement object:
25  
26 $service_obj->Method(Att1 => { AttributeName => $value, ..., KeyType => $value });
27  
28 =head3 Results returned from an API call
29  
30 Use accessors for each attribute. If Att1 is expected to be an Paws::DynamoDB::KeySchemaElement object:
31  
32 $result = $service_obj->Method(...);
33 $result->Att1->AttributeName
34  
35 =head1 DESCRIPTION
36  
37 Represents I<a single element> of a key schema. A key schema specifies
38 the attributes that make up the primary key of a table, or the key
39 attributes of an index.
40  
41 A C<KeySchemaElement> represents exactly one attribute of the primary
42 key. For example, a simple primary key would be represented by one
43 C<KeySchemaElement> (for the partition key). A composite primary key
44 would require one C<KeySchemaElement> for the partition key, and
45 another C<KeySchemaElement> for the sort key.
46  
47 A C<KeySchemaElement> must be a scalar, top-level attribute (not a
48 nested attribute). The data type must be one of String, Number, or
49 Binary. The attribute cannot be nested within a List or a Map.
50  
51 =head1 ATTRIBUTES
52  
53  
54 =head2 B<REQUIRED> AttributeName => Str
55  
56 The name of a key attribute.
57  
58  
59 =head2 B<REQUIRED> KeyType => Str
60  
61 The role that this key attribute will assume:
62  
63 =over
64  
65 =item *
66  
67 C<HASH> - partition key
68  
69 =item *
70  
71 C<RANGE> - sort key
72  
73 =back
74  
75 The partition key of an item is also known as its I<hash attribute>.
76 The term "hash attribute" derives from DynamoDB's usage of an internal
77 hash function to evenly distribute data items across partitions, based
78 on their partition key values.
79  
80 The sort key of an item is also known as its I<range attribute>. The
81 term "range attribute" derives from the way DynamoDB stores items with
82 the same partition key physically close together, in sorted order by
83 the sort key value.
84  
85  
86  
87 =head1 SEE ALSO
88  
89 This class forms part of L<Paws>, describing an object used in L<Paws::DynamoDB>
90  
91 =head1 BUGS and CONTRIBUTIONS
92  
93 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
94  
95 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
96  
97 =cut
98  
« blib/lib/Paws/DynamoDB/Key.pm ↑ Summary blib/lib/Paws/DynamoDB/KeysAndAttributes.pm »