File Coverage

blib/lib/Paws/Kinesis/Record.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::Kinesis::Record;
2 1     1   332 use Moose;
  1         2  
  1         6  
3             has ApproximateArrivalTimestamp => (is => 'ro', isa => 'Str');
4             has Data => (is => 'ro', isa => 'Str', required => 1);
5             has EncryptionType => (is => 'ro', isa => 'Str');
6             has PartitionKey => (is => 'ro', isa => 'Str', required => 1);
7             has SequenceNumber => (is => 'ro', isa => 'Str', required => 1);
8             1;
9              
10             ### main pod documentation begin ###
11              
12             =head1 NAME
13              
14             Paws::Kinesis::Record
15              
16             =head1 USAGE
17              
18             This class represents one of two things:
19              
20             =head3 Arguments in a call to a service
21              
22             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
23             Each attribute should be used as a named argument in the calls that expect this type of object.
24              
25             As an example, if Att1 is expected to be a Paws::Kinesis::Record object:
26              
27             $service_obj->Method(Att1 => { ApproximateArrivalTimestamp => $value, ..., SequenceNumber => $value });
28              
29             =head3 Results returned from an API call
30              
31             Use accessors for each attribute. If Att1 is expected to be an Paws::Kinesis::Record object:
32              
33             $result = $service_obj->Method(...);
34             $result->Att1->ApproximateArrivalTimestamp
35              
36             =head1 DESCRIPTION
37              
38             The unit of data of the Amazon Kinesis stream, which is composed of a
39             sequence number, a partition key, and a data blob.
40              
41             =head1 ATTRIBUTES
42              
43              
44             =head2 ApproximateArrivalTimestamp => Str
45              
46             The approximate time that the record was inserted into the stream.
47              
48              
49             =head2 B<REQUIRED> Data => Str
50              
51             The data blob. The data in the blob is both opaque and immutable to the
52             Amazon Kinesis service, which does not inspect, interpret, or change
53             the data in the blob in any way. When the data blob (the payload before
54             base64-encoding) is added to the partition key size, the total size
55             must not exceed the maximum record size (1 MB).
56              
57              
58             =head2 EncryptionType => Str
59              
60             The encryption type used on the record. This parameter can be one of
61             the following values:
62              
63             =over
64              
65             =item *
66              
67             C<NONE>: Do not encrypt the records in the stream.
68              
69             =item *
70              
71             C<KMS>: Use server-side encryption on the records in the stream using a
72             customer-managed KMS key.
73              
74             =back
75              
76              
77              
78             =head2 B<REQUIRED> PartitionKey => Str
79              
80             Identifies which shard in the stream the data record is assigned to.
81              
82              
83             =head2 B<REQUIRED> SequenceNumber => Str
84              
85             The unique identifier of the record within its shard.
86              
87              
88              
89             =head1 SEE ALSO
90              
91             This class forms part of L<Paws>, describing an object used in L<Paws::Kinesis>
92              
93             =head1 BUGS and CONTRIBUTIONS
94              
95             The source code is located here: https://github.com/pplu/aws-sdk-perl
96              
97             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
98              
99             =cut
100