File Coverage

blib/lib/Paws/Kinesis/Shard.pm
Criterion Covered Total %
statement 3 3 100.0
branch n/a
condition n/a
subroutine 1 1 100.0
pod n/a
total 4 4 100.0


line stmt bran cond sub pod time code
1             package Paws::Kinesis::Shard;
2 1     1   582 use Moose;
  1         2  
  1         7  
3             has AdjacentParentShardId => (is => 'ro', isa => 'Str');
4             has HashKeyRange => (is => 'ro', isa => 'Paws::Kinesis::HashKeyRange', required => 1);
5             has ParentShardId => (is => 'ro', isa => 'Str');
6             has SequenceNumberRange => (is => 'ro', isa => 'Paws::Kinesis::SequenceNumberRange', required => 1);
7             has ShardId => (is => 'ro', isa => 'Str', required => 1);
8             1;
9              
10             ### main pod documentation begin ###
11              
12             =head1 NAME
13              
14             Paws::Kinesis::Shard
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::Shard object:
26              
27             $service_obj->Method(Att1 => { AdjacentParentShardId => $value, ..., ShardId => $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::Shard object:
32              
33             $result = $service_obj->Method(...);
34             $result->Att1->AdjacentParentShardId
35              
36             =head1 DESCRIPTION
37              
38             A uniquely identified group of data records in an Amazon Kinesis
39             stream.
40              
41             =head1 ATTRIBUTES
42              
43              
44             =head2 AdjacentParentShardId => Str
45              
46             The shard ID of the shard adjacent to the shard's parent.
47              
48              
49             =head2 B<REQUIRED> HashKeyRange => L<Paws::Kinesis::HashKeyRange>
50              
51             The range of possible hash key values for the shard, which is a set of
52             ordered contiguous positive integers.
53              
54              
55             =head2 ParentShardId => Str
56              
57             The shard ID of the shard's parent.
58              
59              
60             =head2 B<REQUIRED> SequenceNumberRange => L<Paws::Kinesis::SequenceNumberRange>
61              
62             The range of possible sequence numbers for the shard.
63              
64              
65             =head2 B<REQUIRED> ShardId => Str
66              
67             The unique identifier of the 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: https://github.com/pplu/aws-sdk-perl
78              
79             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
80              
81             =cut
82