« blib/lib/Paws/Kinesis/SubscribeToShard.pm
↑ Summary
blib/lib/Paws/Kinesis/SubscribeToShardEventStream.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Kinesis::SubscribeToShardEvent; | ||
| 3 | use Moose; | ||
| 4 | has ChildShards => (is => 'ro', isa => 'ArrayRef[Paws::Kinesis::ChildShard]'); | ||
| 5 | has ContinuationSequenceNumber => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has MillisBehindLatest => (is => 'ro', isa => 'Int', required => 1); | ||
| 7 | has Records => (is => 'ro', isa => 'ArrayRef[Paws::Kinesis::Record]', required => 1); | ||
| 8 | |||
| 9 | 1; | ||
| 10 | |||
| 11 | ### main pod documentation begin ### | ||
| 12 | |||
| 13 | =head1 NAME | ||
| 14 | |||
| 15 | Paws::Kinesis::SubscribeToShardEvent | ||
| 16 | |||
| 17 | =head1 USAGE | ||
| 18 | |||
| 19 | This class represents one of two things: | ||
| 20 | |||
| 21 | =head3 Arguments in a call to a service | ||
| 22 | |||
| 23 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 24 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 25 | |||
| 26 | As an example, if Att1 is expected to be a Paws::Kinesis::SubscribeToShardEvent object: | ||
| 27 | |||
| 28 | $service_obj->Method(Att1 => { ChildShards => $value, ..., Records => $value }); | ||
| 29 | |||
| 30 | =head3 Results returned from an API call | ||
| 31 | |||
| 32 | Use accessors for each attribute. If Att1 is expected to be an Paws::Kinesis::SubscribeToShardEvent object: | ||
| 33 | |||
| 34 | $result = $service_obj->Method(...); | ||
| 35 | $result->Att1->ChildShards | ||
| 36 | |||
| 37 | =head1 DESCRIPTION | ||
| 38 | |||
| 39 | After you call SubscribeToShard, Kinesis Data Streams sends events of | ||
| 40 | this type over an HTTP/2 connection to your consumer. | ||
| 41 | |||
| 42 | =head1 ATTRIBUTES | ||
| 43 | |||
| 44 | |||
| 45 | =head2 ChildShards => ArrayRef[L<Paws::Kinesis::ChildShard>] | ||
| 46 | |||
| 47 | |||
| 48 | |||
| 49 | |||
| 50 | =head2 B<REQUIRED> ContinuationSequenceNumber => Str | ||
| 51 | |||
| 52 | Use this as C<SequenceNumber> in the next call to SubscribeToShard, | ||
| 53 | with C<StartingPosition> set to C<AT_SEQUENCE_NUMBER> or | ||
| 54 | C<AFTER_SEQUENCE_NUMBER>. Use C<ContinuationSequenceNumber> for | ||
| 55 | checkpointing because it captures your shard progress even when no data | ||
| 56 | is written to the shard. | ||
| 57 | |||
| 58 | |||
| 59 | =head2 B<REQUIRED> MillisBehindLatest => Int | ||
| 60 | |||
| 61 | The number of milliseconds the read records are from the tip of the | ||
| 62 | stream, indicating how far behind current time the consumer is. A value | ||
| 63 | of zero indicates that record processing is caught up, and there are no | ||
| 64 | new records to process at this moment. | ||
| 65 | |||
| 66 | |||
| 67 | =head2 B<REQUIRED> Records => ArrayRef[L<Paws::Kinesis::Record>] | ||
| 68 | |||
| 69 | |||
| 70 | |||
| 71 | |||
| 72 | |||
| 73 | =head1 SEE ALSO | ||
| 74 | |||
| 75 | This class forms part of L<Paws>, describing an object used in L<Paws::Kinesis> | ||
| 76 | |||
| 77 | =head1 BUGS and CONTRIBUTIONS | ||
| 78 | |||
| 79 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 80 | |||
| 81 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 82 | |||
| 83 | =cut | ||
| 84 |