« blib/lib/Paws/Kinesis/StartStreamEncryption.pm
↑ Summary
blib/lib/Paws/Kinesis/StopStreamEncryption.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Kinesis::StartingPosition; | ||
| 3 | use Moose; | ||
| 4 | has SequenceNumber => (is => 'ro', isa => 'Str'); | ||
| 5 | has Timestamp => (is => 'ro', isa => 'Str'); | ||
| 6 | has Type => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | |||
| 8 | 1; | ||
| 9 | |||
| 10 | ### main pod documentation begin ### | ||
| 11 | |||
| 12 | =head1 NAME | ||
| 13 | |||
| 14 | Paws::Kinesis::StartingPosition | ||
| 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::StartingPosition object: | ||
| 26 | |||
| 27 | $service_obj->Method(Att1 => { SequenceNumber => $value, ..., Type => $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::StartingPosition object: | ||
| 32 | |||
| 33 | $result = $service_obj->Method(...); | ||
| 34 | $result->Att1->SequenceNumber | ||
| 35 | |||
| 36 | =head1 DESCRIPTION | ||
| 37 | |||
| 38 | This class has no description | ||
| 39 | |||
| 40 | =head1 ATTRIBUTES | ||
| 41 | |||
| 42 | |||
| 43 | =head2 SequenceNumber => Str | ||
| 44 | |||
| 45 | The sequence number of the data record in the shard from which to start | ||
| 46 | streaming. To specify a sequence number, set C<StartingPosition> to | ||
| 47 | C<AT_SEQUENCE_NUMBER> or C<AFTER_SEQUENCE_NUMBER>. | ||
| 48 | |||
| 49 | |||
| 50 | =head2 Timestamp => Str | ||
| 51 | |||
| 52 | The time stamp of the data record from which to start reading. To | ||
| 53 | specify a time stamp, set C<StartingPosition> to C<Type AT_TIMESTAMP>. | ||
| 54 | A time stamp is the Unix epoch date with precision in milliseconds. For | ||
| 55 | example, C<2016-04-04T19:58:46.480-00:00> or C<1459799926.480>. If a | ||
| 56 | record with this exact time stamp does not exist, records will be | ||
| 57 | streamed from the next (later) record. If the time stamp is older than | ||
| 58 | the current trim horizon, records will be streamed from the oldest | ||
| 59 | untrimmed data record (C<TRIM_HORIZON>). | ||
| 60 | |||
| 61 | |||
| 62 | =head2 B<REQUIRED> Type => Str | ||
| 63 | |||
| 64 | You can set the starting position to one of the following values: | ||
| 65 | |||
| 66 | C<AT_SEQUENCE_NUMBER>: Start streaming from the position denoted by the | ||
| 67 | sequence number specified in the C<SequenceNumber> field. | ||
| 68 | |||
| 69 | C<AFTER_SEQUENCE_NUMBER>: Start streaming right after the position | ||
| 70 | denoted by the sequence number specified in the C<SequenceNumber> | ||
| 71 | field. | ||
| 72 | |||
| 73 | C<AT_TIMESTAMP>: Start streaming from the position denoted by the time | ||
| 74 | stamp specified in the C<Timestamp> field. | ||
| 75 | |||
| 76 | C<TRIM_HORIZON>: Start streaming at the last untrimmed record in the | ||
| 77 | shard, which is the oldest data record in the shard. | ||
| 78 | |||
| 79 | C<LATEST>: Start streaming just after the most recent record in the | ||
| 80 | shard, so that you always read the most recent data in the shard. | ||
| 81 | |||
| 82 | |||
| 83 | |||
| 84 | =head1 SEE ALSO | ||
| 85 | |||
| 86 | This class forms part of L<Paws>, describing an object used in L<Paws::Kinesis> | ||
| 87 | |||
| 88 | =head1 BUGS and CONTRIBUTIONS | ||
| 89 | |||
| 90 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 91 | |||
| 92 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 93 | |||
| 94 | =cut | ||
| 95 |