File Coverage

blib/lib/Paws/Kinesis/GetRecords.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              
2             package Paws::Kinesis::GetRecords;
3 1     1   363 use Moose;
  1         2  
  1         6  
4             has Limit => (is => 'ro', isa => 'Int');
5             has ShardIterator => (is => 'ro', isa => 'Str', required => 1);
6              
7 1     1   5651 use MooseX::ClassAttribute;
  1         3  
  1         7  
8              
9             class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetRecords');
10             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Kinesis::GetRecordsOutput');
11             class_has _result_key => (isa => 'Str', is => 'ro');
12             1;
13              
14             ### main pod documentation begin ###
15              
16             =head1 NAME
17              
18             Paws::Kinesis::GetRecords - Arguments for method GetRecords on Paws::Kinesis
19              
20             =head1 DESCRIPTION
21              
22             This class represents the parameters used for calling the method GetRecords on the
23             Amazon Kinesis service. Use the attributes of this class
24             as arguments to method GetRecords.
25              
26             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetRecords.
27              
28             As an example:
29              
30             $service_obj->GetRecords(Att1 => $value1, Att2 => $value2, ...);
31              
32             Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object.
33              
34             =head1 ATTRIBUTES
35              
36              
37             =head2 Limit => Int
38              
39             The maximum number of records to return. Specify a value of up to
40             10,000. If you specify a value that is greater than 10,000, GetRecords
41             throws C<InvalidArgumentException>.
42              
43              
44              
45             =head2 B<REQUIRED> ShardIterator => Str
46              
47             The position in the shard from which you want to start sequentially
48             reading data records. A shard iterator specifies this position using
49             the sequence number of a data record in the shard.
50              
51              
52              
53              
54             =head1 SEE ALSO
55              
56             This class forms part of L<Paws>, documenting arguments for method GetRecords in L<Paws::Kinesis>
57              
58             =head1 BUGS and CONTRIBUTIONS
59              
60             The source code is located here: https://github.com/pplu/aws-sdk-perl
61              
62             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
63              
64             =cut
65