File Coverage

blib/lib/Paws/DynamoDB/Projection.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::Projection;
2 1     1   509 use Moose;
  1         2  
  1         9  
3             has NonKeyAttributes => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
4             has ProjectionType => (is => 'ro', isa => 'Str');
5             1;
6              
7             ### main pod documentation begin ###
8              
9             =head1 NAME
10              
11             Paws::DynamoDB::Projection
12              
13             =head1 USAGE
14              
15             This class represents one of two things:
16              
17             =head3 Arguments in a call to a service
18              
19             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
20             Each attribute should be used as a named argument in the calls that expect this type of object.
21              
22             As an example, if Att1 is expected to be a Paws::DynamoDB::Projection object:
23              
24             $service_obj->Method(Att1 => { NonKeyAttributes => $value, ..., ProjectionType => $value });
25              
26             =head3 Results returned from an API call
27              
28             Use accessors for each attribute. If Att1 is expected to be an Paws::DynamoDB::Projection object:
29              
30             $result = $service_obj->Method(...);
31             $result->Att1->NonKeyAttributes
32              
33             =head1 DESCRIPTION
34              
35             Represents attributes that are copied (projected) from the table into
36             an index. These are in addition to the primary key attributes and index
37             key attributes, which are automatically projected.
38              
39             =head1 ATTRIBUTES
40              
41              
42             =head2 NonKeyAttributes => ArrayRef[Str|Undef]
43              
44             Represents the non-key attribute names which will be projected into the
45             index.
46              
47             For local secondary indexes, the total count of C<NonKeyAttributes>
48             summed across all of the local secondary indexes, must not exceed 20.
49             If you project the same attribute into two different indexes, this
50             counts as two distinct attributes when determining the total.
51              
52              
53             =head2 ProjectionType => Str
54              
55             The set of attributes that are projected into the index:
56              
57             =over
58              
59             =item *
60              
61             C<KEYS_ONLY> - Only the index and primary keys are projected into the
62             index.
63              
64             =item *
65              
66             C<INCLUDE> - Only the specified table attributes are projected into the
67             index. The list of projected attributes are in C<NonKeyAttributes>.
68              
69             =item *
70              
71             C<ALL> - All of the table attributes are projected into the index.
72              
73             =back
74              
75              
76              
77              
78             =head1 SEE ALSO
79              
80             This class forms part of L<Paws>, describing an object used in L<Paws::DynamoDB>
81              
82             =head1 BUGS and CONTRIBUTIONS
83              
84             The source code is located here: https://github.com/pplu/aws-sdk-perl
85              
86             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
87              
88             =cut
89