File Coverage

blib/lib/Paws/Kinesis/PutRecord.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::PutRecord;
3 1     1   328 use Moose;
  1         2  
  1         5  
4             has Data => (is => 'ro', isa => 'Str', required => 1);
5             has ExplicitHashKey => (is => 'ro', isa => 'Str');
6             has PartitionKey => (is => 'ro', isa => 'Str', required => 1);
7             has SequenceNumberForOrdering => (is => 'ro', isa => 'Str');
8             has StreamName => (is => 'ro', isa => 'Str', required => 1);
9              
10 1     1   5600 use MooseX::ClassAttribute;
  1         3  
  1         8  
11              
12             class_has _api_call => (isa => 'Str', is => 'ro', default => 'PutRecord');
13             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Kinesis::PutRecordOutput');
14             class_has _result_key => (isa => 'Str', is => 'ro');
15             1;
16              
17             ### main pod documentation begin ###
18              
19             =head1 NAME
20              
21             Paws::Kinesis::PutRecord - Arguments for method PutRecord on Paws::Kinesis
22              
23             =head1 DESCRIPTION
24              
25             This class represents the parameters used for calling the method PutRecord on the
26             Amazon Kinesis service. Use the attributes of this class
27             as arguments to method PutRecord.
28              
29             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to PutRecord.
30              
31             As an example:
32              
33             $service_obj->PutRecord(Att1 => $value1, Att2 => $value2, ...);
34              
35             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.
36              
37             =head1 ATTRIBUTES
38              
39              
40             =head2 B<REQUIRED> Data => Str
41              
42             The data blob to put into the record, which is base64-encoded when the
43             blob is serialized. When the data blob (the payload before
44             base64-encoding) is added to the partition key size, the total size
45             must not exceed the maximum record size (1 MB).
46              
47              
48              
49             =head2 ExplicitHashKey => Str
50              
51             The hash value used to explicitly determine the shard the data record
52             is assigned to by overriding the partition key hash.
53              
54              
55              
56             =head2 B<REQUIRED> PartitionKey => Str
57              
58             Determines which shard in the stream the data record is assigned to.
59             Partition keys are Unicode strings with a maximum length limit of 256
60             characters for each key. Amazon Kinesis uses the partition key as input
61             to a hash function that maps the partition key and associated data to a
62             specific shard. Specifically, an MD5 hash function is used to map
63             partition keys to 128-bit integer values and to map associated data
64             records to shards. As a result of this hashing mechanism, all data
65             records with the same partition key map to the same shard within the
66             stream.
67              
68              
69              
70             =head2 SequenceNumberForOrdering => Str
71              
72             Guarantees strictly increasing sequence numbers, for puts from the same
73             client and to the same partition key. Usage: set the
74             C<SequenceNumberForOrdering> of record I<n> to the sequence number of
75             record I<n-1> (as returned in the result when putting record I<n-1>).
76             If this parameter is not set, records will be coarsely ordered based on
77             arrival time.
78              
79              
80              
81             =head2 B<REQUIRED> StreamName => Str
82              
83             The name of the stream to put the data record into.
84              
85              
86              
87              
88             =head1 SEE ALSO
89              
90             This class forms part of L<Paws>, documenting arguments for method PutRecord in L<Paws::Kinesis>
91              
92             =head1 BUGS and CONTRIBUTIONS
93              
94             The source code is located here: https://github.com/pplu/aws-sdk-perl
95              
96             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
97              
98             =cut
99