File Coverage

blib/lib/Paws/DynamoDB/GlobalSecondaryIndexDescription.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	sub	time	code
1				package Paws::DynamoDB::GlobalSecondaryIndexDescription;
2	1	1	543	use Moose;
	1	1	3
	1		8
	1		502
	1		5
	1		7
3				has Backfilling => (is => 'ro', isa => 'Bool');
4				has IndexArn => (is => 'ro', isa => 'Str');
5				has IndexName => (is => 'ro', isa => 'Str');
6				has IndexSizeBytes => (is => 'ro', isa => 'Int');
7				has IndexStatus => (is => 'ro', isa => 'Str');
8				has ItemCount => (is => 'ro', isa => 'Int');
9				has KeySchema => (is => 'ro', isa => 'ArrayRef[Paws::DynamoDB::KeySchemaElement]');
10				has Projection => (is => 'ro', isa => 'Paws::DynamoDB::Projection');
11				has ProvisionedThroughput => (is => 'ro', isa => 'Paws::DynamoDB::ProvisionedThroughputDescription');
12				1;
13
14				### main pod documentation begin ###
15
16				=head1 NAME
17
18				Paws::DynamoDB::GlobalSecondaryIndexDescription
19
20				=head1 USAGE
21
22				This class represents one of two things:
23
24				=head3 Arguments in a call to a service
25
26				Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
27				Each attribute should be used as a named argument in the calls that expect this type of object.
28
29				As an example, if Att1 is expected to be a Paws::DynamoDB::GlobalSecondaryIndexDescription object:
30
31				$service_obj->Method(Att1 => { Backfilling => $value, ..., ProvisionedThroughput => $value });
32
33				=head3 Results returned from an API call
34
35				Use accessors for each attribute. If Att1 is expected to be an Paws::DynamoDB::GlobalSecondaryIndexDescription object:
36
37				$result = $service_obj->Method(...);
38				$result->Att1->Backfilling
39
40				=head1 DESCRIPTION
41
42				Represents the properties of a global secondary index.
43
44				=head1 ATTRIBUTES
45
46
47				=head2 Backfilling => Bool
48
49				Indicates whether the index is currently backfilling. I<Backfilling> is
50				the process of reading items from the table and determining whether
51				they can be added to the index. (Not all items will qualify: For
52				example, a partition key cannot have any duplicate values.) If an item
53				can be added to the index, DynamoDB will do so. After all items have
54				been processed, the backfilling operation is complete and
55				C<Backfilling> is false.
56
57				For indexes that were created during a C<CreateTable> operation, the
58				C<Backfilling> attribute does not appear in the C<DescribeTable>
59				output.
60
61
62				=head2 IndexArn => Str
63
64				The Amazon Resource Name (ARN) that uniquely identifies the index.
65
66
67				=head2 IndexName => Str
68
69				The name of the global secondary index.
70
71
72				=head2 IndexSizeBytes => Int
73
74				The total size of the specified index, in bytes. DynamoDB updates this
75				value approximately every six hours. Recent changes might not be
76				reflected in this value.
77
78
79				=head2 IndexStatus => Str
80
81				The current state of the global secondary index:
82
83				=over
84
85				=item *
86
87				C<CREATING> - The index is being created.
88
89				=item *
90
91				C<UPDATING> - The index is being updated.
92
93				=item *
94
95				C<DELETING> - The index is being deleted.
96
97				=item *
98
99				C<ACTIVE> - The index is ready for use.
100
101				=back
102
103
104
105				=head2 ItemCount => Int
106
107				The number of items in the specified index. DynamoDB updates this value
108				approximately every six hours. Recent changes might not be reflected in
109				this value.
110
111
112				=head2 KeySchema => ArrayRef[L<Paws::DynamoDB::KeySchemaElement>]
113
114				The complete key schema for a global secondary index, which consists of
115				one or more pairs of attribute names and key types:
116
117				=over
118
119				=item *
120
121				C<HASH> - partition key
122
123				=item *
124
125				C<RANGE> - sort key
126
127				=back
128
129				The partition key of an item is also known as its I<hash attribute>.
130				The term "hash attribute" derives from DynamoDB' usage of an internal
131				hash function to evenly distribute data items across partitions, based
132				on their partition key values.
133
134				The sort key of an item is also known as its I<range attribute>. The
135				term "range attribute" derives from the way DynamoDB stores items with
136				the same partition key physically close together, in sorted order by
137				the sort key value.
138
139
140				=head2 Projection => L<Paws::DynamoDB::Projection>
141
142				Represents attributes that are copied (projected) from the table into
143				the global secondary index. These are in addition to the primary key
144				attributes and index key attributes, which are automatically projected.
145
146
147				=head2 ProvisionedThroughput => L<Paws::DynamoDB::ProvisionedThroughputDescription>
148
149				Represents the provisioned throughput settings for the specified global
150				secondary index.
151
152				For current minimum and maximum provisioned throughput values, see
153				Limits in the I<Amazon DynamoDB Developer Guide>.
154
155
156
157				=head1 SEE ALSO
158
159				This class forms part of L<Paws>, describing an object used in L<Paws::DynamoDB>
160
161				=head1 BUGS and CONTRIBUTIONS
162
163				The source code is located here: https://github.com/pplu/aws-sdk-perl
164
165				Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
166
167				=cut
168