« blib/lib/Paws/DynamoDB/PointInTimeRecoverySpecification.pm
↑ Summary
blib/lib/Paws/DynamoDB/ProvisionedThroughput.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::DynamoDB::Projection; | ||
| 3 | use Moose; | ||
| 4 | has NonKeyAttributes => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 5 | has ProjectionType => (is => 'ro', isa => 'Str'); | ||
| 6 | |||
| 7 | 1; | ||
| 8 | |||
| 9 | ### main pod documentation begin ### | ||
| 10 | |||
| 11 | =head1 NAME | ||
| 12 | |||
| 13 | Paws::DynamoDB::Projection | ||
| 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::Projection object: | ||
| 25 | |||
| 26 | $service_obj->Method(Att1 => { NonKeyAttributes => $value, ..., ProjectionType => $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::Projection object: | ||
| 31 | |||
| 32 | $result = $service_obj->Method(...); | ||
| 33 | $result->Att1->NonKeyAttributes | ||
| 34 | |||
| 35 | =head1 DESCRIPTION | ||
| 36 | |||
| 37 | Represents attributes that are copied (projected) from the table into | ||
| 38 | an index. These are in addition to the primary key attributes and index | ||
| 39 | key attributes, which are automatically projected. | ||
| 40 | |||
| 41 | =head1 ATTRIBUTES | ||
| 42 | |||
| 43 | |||
| 44 | =head2 NonKeyAttributes => ArrayRef[Str|Undef] | ||
| 45 | |||
| 46 | Represents the non-key attribute names which will be projected into the | ||
| 47 | index. | ||
| 48 | |||
| 49 | For local secondary indexes, the total count of C<NonKeyAttributes> | ||
| 50 | summed across all of the local secondary indexes, must not exceed 20. | ||
| 51 | If you project the same attribute into two different indexes, this | ||
| 52 | counts as two distinct attributes when determining the total. | ||
| 53 | |||
| 54 | |||
| 55 | =head2 ProjectionType => Str | ||
| 56 | |||
| 57 | The set of attributes that are projected into the index: | ||
| 58 | |||
| 59 | =over | ||
| 60 | |||
| 61 | =item * | ||
| 62 | |||
| 63 | C<KEYS_ONLY> - Only the index and primary keys are projected into the | ||
| 64 | index. | ||
| 65 | |||
| 66 | =item * | ||
| 67 | |||
| 68 | C<INCLUDE> - In addition to the attributes described in C<KEYS_ONLY>, | ||
| 69 | the secondary index will include other non-key attributes that you | ||
| 70 | specify. | ||
| 71 | |||
| 72 | =item * | ||
| 73 | |||
| 74 | C<ALL> - All of the table attributes are projected into the index. | ||
| 75 | |||
| 76 | =back | ||
| 77 | |||
| 78 | |||
| 79 | |||
| 80 | |||
| 81 | =head1 SEE ALSO | ||
| 82 | |||
| 83 | This class forms part of L<Paws>, describing an object used in L<Paws::DynamoDB> | ||
| 84 | |||
| 85 | =head1 BUGS and CONTRIBUTIONS | ||
| 86 | |||
| 87 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 88 | |||
| 89 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 90 | |||
| 91 | =cut | ||
| 92 |