File Coverage

blib/lib/Paws/DynamoDB/LocalSecondaryIndex.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::DynamoDB::LocalSecondaryIndex;
2 1     1   466 use Moose;
  1         3  
  1         7  
3             has IndexName => (is => 'ro', isa => 'Str', required => 1);
4             has KeySchema => (is => 'ro', isa => 'ArrayRef[Paws::DynamoDB::KeySchemaElement]', required => 1);
5             has Projection => (is => 'ro', isa => 'Paws::DynamoDB::Projection', required => 1);
6             1;
7              
8             ### main pod documentation begin ###
9              
10             =head1 NAME
11              
12             Paws::DynamoDB::LocalSecondaryIndex
13              
14             =head1 USAGE
15              
16             This class represents one of two things:
17              
18             =head3 Arguments in a call to a service
19              
20             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
21             Each attribute should be used as a named argument in the calls that expect this type of object.
22              
23             As an example, if Att1 is expected to be a Paws::DynamoDB::LocalSecondaryIndex object:
24              
25             $service_obj->Method(Att1 => { IndexName => $value, ..., Projection => $value });
26              
27             =head3 Results returned from an API call
28              
29             Use accessors for each attribute. If Att1 is expected to be an Paws::DynamoDB::LocalSecondaryIndex object:
30              
31             $result = $service_obj->Method(...);
32             $result->Att1->IndexName
33              
34             =head1 DESCRIPTION
35              
36             Represents the properties of a local secondary index.
37              
38             =head1 ATTRIBUTES
39              
40              
41             =head2 B<REQUIRED> IndexName => Str
42              
43             The name of the local secondary index. The name must be unique among
44             all other indexes on this table.
45              
46              
47             =head2 B<REQUIRED> KeySchema => ArrayRef[L<Paws::DynamoDB::KeySchemaElement>]
48              
49             The complete key schema for the local secondary index, consisting of
50             one or more pairs of attribute names and key types:
51              
52             =over
53              
54             =item *
55              
56             C<HASH> - partition key
57              
58             =item *
59              
60             C<RANGE> - sort key
61              
62             =back
63              
64             The partition key of an item is also known as its I<hash attribute>.
65             The term "hash attribute" derives from DynamoDB' usage of an internal
66             hash function to evenly distribute data items across partitions, based
67             on their partition key values.
68              
69             The sort key of an item is also known as its I<range attribute>. The
70             term "range attribute" derives from the way DynamoDB stores items with
71             the same partition key physically close together, in sorted order by
72             the sort key value.
73              
74              
75             =head2 B<REQUIRED> Projection => L<Paws::DynamoDB::Projection>
76              
77             Represents attributes that are copied (projected) from the table into
78             the local secondary index. These are in addition to the primary key
79             attributes and index key attributes, which are automatically projected.
80              
81              
82              
83             =head1 SEE ALSO
84              
85             This class forms part of L<Paws>, describing an object used in L<Paws::DynamoDB>
86              
87             =head1 BUGS and CONTRIBUTIONS
88              
89             The source code is located here: https://github.com/pplu/aws-sdk-perl
90              
91             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
92              
93             =cut
94