« blib/lib/Paws/Kinesis/PutRecordsOutput.pm
↑ Summary
blib/lib/Paws/Kinesis/PutRecordsResultEntry.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Kinesis::PutRecordsRequestEntry; | ||
| 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 | |||
| 8 | 1; | ||
| 9 | |||
| 10 | ### main pod documentation begin ### | ||
| 11 | |||
| 12 | =head1 NAME | ||
| 13 | |||
| 14 | Paws::Kinesis::PutRecordsRequestEntry | ||
| 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::PutRecordsRequestEntry object: | ||
| 26 | |||
| 27 | $service_obj->Method(Att1 => { Data => $value, ..., PartitionKey => $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::PutRecordsRequestEntry object: | ||
| 32 | |||
| 33 | $result = $service_obj->Method(...); | ||
| 34 | $result->Att1->Data | ||
| 35 | |||
| 36 | =head1 DESCRIPTION | ||
| 37 | |||
| 38 | Represents the output for C<PutRecords>. | ||
| 39 | |||
| 40 | =head1 ATTRIBUTES | ||
| 41 | |||
| 42 | |||
| 43 | =head2 B<REQUIRED> Data => Str | ||
| 44 | |||
| 45 | The data blob to put into the record, which is base64-encoded when the | ||
| 46 | blob is serialized. When the data blob (the payload before | ||
| 47 | base64-encoding) is added to the partition key size, the total size | ||
| 48 | must not exceed the maximum record size (1 MiB). | ||
| 49 | |||
| 50 | |||
| 51 | =head2 ExplicitHashKey => Str | ||
| 52 | |||
| 53 | The hash value used to determine explicitly the shard that the data | ||
| 54 | record is assigned to by overriding the partition key hash. | ||
| 55 | |||
| 56 | |||
| 57 | =head2 B<REQUIRED> PartitionKey => Str | ||
| 58 | |||
| 59 | Determines which shard in the stream the data record is assigned to. | ||
| 60 | Partition keys are Unicode strings with a maximum length limit of 256 | ||
| 61 | characters for each key. Amazon Kinesis Data Streams uses the partition | ||
| 62 | key as input to a hash function that maps the partition key and | ||
| 63 | associated data to a specific shard. Specifically, an MD5 hash function | ||
| 64 | is used to map partition keys to 128-bit integer values and to map | ||
| 65 | associated data records to shards. As a result of this hashing | ||
| 66 | mechanism, all data records with the same partition key map to the same | ||
| 67 | shard within the stream. | ||
| 68 | |||
| 69 | |||
| 70 | |||
| 71 | =head1 SEE ALSO | ||
| 72 | |||
| 73 | This class forms part of L<Paws>, describing an object used in L<Paws::Kinesis> | ||
| 74 | |||
| 75 | =head1 BUGS and CONTRIBUTIONS | ||
| 76 | |||
| 77 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 78 | |||
| 79 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 80 | |||
| 81 | =cut | ||
| 82 |