blib/lib/Paws/Kinesis/PutRecord.pm untested

filter: Statementstmt 0.0% 0 / 14 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 16 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::Kinesis::PutRecord;
3 use Moose;
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 use MooseX::ClassAttribute;
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 L<Paws::Kinesis>
22  
23 =head1 DESCRIPTION
24  
25 This class represents the parameters used for calling the method PutRecord on the
26 L<Amazon Kinesis|Paws::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 =head1 SYNOPSIS
32  
33 my $kinesis = Paws->service('Kinesis');
34 my $PutRecordOutput = $kinesis->PutRecord(
35 Data => 'BlobData',
36 PartitionKey => 'MyPartitionKey',
37 StreamName => 'MyStreamName',
38 ExplicitHashKey => 'MyHashKey', # OPTIONAL
39 SequenceNumberForOrdering => 'MySequenceNumber', # OPTIONAL
40 );
41  
42 # Results:
43 my $EncryptionType = $PutRecordOutput->EncryptionType;
44 my $SequenceNumber = $PutRecordOutput->SequenceNumber;
45 my $ShardId = $PutRecordOutput->ShardId;
46  
47 # Returns a L<Paws::Kinesis::PutRecordOutput> object.
48  
49 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.
50 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/kinesis/PutRecord>
51  
52 =head1 ATTRIBUTES
53  
54  
55 =head2 B<REQUIRED> Data => Str
56  
57 The data blob to put into the record, which is base64-encoded when the
58 blob is serialized. When the data blob (the payload before
59 base64-encoding) is added to the partition key size, the total size
60 must not exceed the maximum record size (1 MiB).
61  
62  
63  
64 =head2 ExplicitHashKey => Str
65  
66 The hash value used to explicitly determine the shard the data record
67 is assigned to by overriding the partition key hash.
68  
69  
70  
71 =head2 B<REQUIRED> PartitionKey => Str
72  
73 Determines which shard in the stream the data record is assigned to.
74 Partition keys are Unicode strings with a maximum length limit of 256
75 characters for each key. Amazon Kinesis Data Streams uses the partition
76 key as input to a hash function that maps the partition key and
77 associated data to a specific shard. Specifically, an MD5 hash function
78 is used to map partition keys to 128-bit integer values and to map
79 associated data records to shards. As a result of this hashing
80 mechanism, all data records with the same partition key map to the same
81 shard within the stream.
82  
83  
84  
85 =head2 SequenceNumberForOrdering => Str
86  
87 Guarantees strictly increasing sequence numbers, for puts from the same
88 client and to the same partition key. Usage: set the
89 C<SequenceNumberForOrdering> of record I<n> to the sequence number of
90 record I<n-1> (as returned in the result when putting record I<n-1>).
91 If this parameter is not set, records are coarsely ordered based on
92 arrival time.
93  
94  
95  
96 =head2 B<REQUIRED> StreamName => Str
97  
98 The name of the stream to put the data record into.
99  
100  
101  
102  
103 =head1 SEE ALSO
104  
105 This class forms part of L<Paws>, documenting arguments for method PutRecord in L<Paws::Kinesis>
106  
107 =head1 BUGS and CONTRIBUTIONS
108  
109 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
110  
111 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
112  
113 =cut
114