File Coverage

blib/lib/Paws/DynamoDB/QueryOutput.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              
2             package Paws::DynamoDB::QueryOutput;
3 1     1   382 use Moose;
  1         3  
  1         6  
4             has ConsumedCapacity => (is => 'ro', isa => 'Paws::DynamoDB::ConsumedCapacity');
5             has Count => (is => 'ro', isa => 'Int');
6             has Items => (is => 'ro', isa => 'ArrayRef[Paws::DynamoDB::AttributeMap]');
7             has LastEvaluatedKey => (is => 'ro', isa => 'Paws::DynamoDB::Key');
8             has ScannedCount => (is => 'ro', isa => 'Int');
9              
10             has _request_id => (is => 'ro', isa => 'Str');
11              
12             ### main pod documentation begin ###
13              
14             =head1 NAME
15              
16             Paws::DynamoDB::QueryOutput
17              
18             =head1 ATTRIBUTES
19              
20              
21             =head2 ConsumedCapacity => L<Paws::DynamoDB::ConsumedCapacity>
22              
23             The capacity units consumed by the C<Query> operation. The data
24             returned includes the total provisioned throughput consumed, along with
25             statistics for the table and any indexes involved in the operation.
26             C<ConsumedCapacity> is only returned if the C<ReturnConsumedCapacity>
27             parameter was specified For more information, see Provisioned
28             Throughput in the I<Amazon DynamoDB Developer Guide>.
29              
30              
31             =head2 Count => Int
32              
33             The number of items in the response.
34              
35             If you used a C<QueryFilter> in the request, then C<Count> is the
36             number of items returned after the filter was applied, and
37             C<ScannedCount> is the number of matching items before the filter was
38             applied.
39              
40             If you did not use a filter in the request, then C<Count> and
41             C<ScannedCount> are the same.
42              
43              
44             =head2 Items => ArrayRef[L<Paws::DynamoDB::AttributeMap>]
45              
46             An array of item attributes that match the query criteria. Each element
47             in this array consists of an attribute name and the value for that
48             attribute.
49              
50              
51             =head2 LastEvaluatedKey => L<Paws::DynamoDB::Key>
52              
53             The primary key of the item where the operation stopped, inclusive of
54             the previous result set. Use this value to start a new operation,
55             excluding this value in the new request.
56              
57             If C<LastEvaluatedKey> is empty, then the "last page" of results has
58             been processed and there is no more data to be retrieved.
59              
60             If C<LastEvaluatedKey> is not empty, it does not necessarily mean that
61             there is more data in the result set. The only way to know when you
62             have reached the end of the result set is when C<LastEvaluatedKey> is
63             empty.
64              
65              
66             =head2 ScannedCount => Int
67              
68             The number of items evaluated, before any C<QueryFilter> is applied. A
69             high C<ScannedCount> value with few, or no, C<Count> results indicates
70             an inefficient C<Query> operation. For more information, see Count and
71             ScannedCount in the I<Amazon DynamoDB Developer Guide>.
72              
73             If you did not use a filter in the request, then C<ScannedCount> is the
74             same as C<Count>.
75              
76              
77             =head2 _request_id => Str
78              
79              
80             =cut
81              
82             1;