File Coverage

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