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

filter: Statementstmt 0.0% 0 / 7 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 8 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
CRAP 2.0
1 # Generated by default/object.tt
2 package Paws::Kinesis::Consumer;
3 use Moose;
4 has ConsumerARN => (is => 'ro', isa => 'Str', required => 1);
5 has ConsumerCreationTimestamp => (is => 'ro', isa => 'Str', required => 1);
6 has ConsumerName => (is => 'ro', isa => 'Str', required => 1);
7 has ConsumerStatus => (is => 'ro', isa => 'Str', required => 1);
8  
9 1;
10  
11 ### main pod documentation begin ###
12  
13 =head1 NAME
14  
15 Paws::Kinesis::Consumer
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::Consumer object:
27  
28 $service_obj->Method(Att1 => { ConsumerARN => $value, ..., ConsumerStatus => $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::Consumer object:
33  
34 $result = $service_obj->Method(...);
35 $result->Att1->ConsumerARN
36  
37 =head1 DESCRIPTION
38  
39 An object that represents the details of the consumer you registered.
40 This type of object is returned by RegisterStreamConsumer.
41  
42 =head1 ATTRIBUTES
43  
44  
45 =head2 B<REQUIRED> ConsumerARN => Str
46  
47 When you register a consumer, Kinesis Data Streams generates an ARN for
48 it. You need this ARN to be able to call SubscribeToShard.
49  
50 If you delete a consumer and then create a new one with the same name,
51 it won't have the same ARN. That's because consumer ARNs contain the
52 creation timestamp. This is important to keep in mind if you have IAM
53 policies that reference consumer ARNs.
54  
55  
56 =head2 B<REQUIRED> ConsumerCreationTimestamp => Str
57  
58  
59  
60  
61 =head2 B<REQUIRED> ConsumerName => Str
62  
63 The name of the consumer is something you choose when you register the
64 consumer.
65  
66  
67 =head2 B<REQUIRED> ConsumerStatus => Str
68  
69 A consumer can't read data while in the C<CREATING> or C<DELETING>
70 states.
71  
72  
73  
74 =head1 SEE ALSO
75  
76 This class forms part of L<Paws>, describing an object used in L<Paws::Kinesis>
77  
78 =head1 BUGS and CONTRIBUTIONS
79  
80 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
81  
82 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
83  
84 =cut
85