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

filter: Statementstmt 0.0% 0 / 8 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 9 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::ConsumerDescription;
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 has StreamARN => (is => 'ro', isa => 'Str', required => 1);
9  
10 1;
11  
12 ### main pod documentation begin ###
13  
14 =head1 NAME
15  
16 Paws::Kinesis::ConsumerDescription
17  
18 =head1 USAGE
19  
20 This class represents one of two things:
21  
22 =head3 Arguments in a call to a service
23  
24 Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
25 Each attribute should be used as a named argument in the calls that expect this type of object.
26  
27 As an example, if Att1 is expected to be a Paws::Kinesis::ConsumerDescription object:
28  
29 $service_obj->Method(Att1 => { ConsumerARN => $value, ..., StreamARN => $value });
30  
31 =head3 Results returned from an API call
32  
33 Use accessors for each attribute. If Att1 is expected to be an Paws::Kinesis::ConsumerDescription object:
34  
35 $result = $service_obj->Method(...);
36 $result->Att1->ConsumerARN
37  
38 =head1 DESCRIPTION
39  
40 An object that represents the details of a registered consumer. This
41 type of object is returned by DescribeStreamConsumer.
42  
43 =head1 ATTRIBUTES
44  
45  
46 =head2 B<REQUIRED> ConsumerARN => Str
47  
48 When you register a consumer, Kinesis Data Streams generates an ARN for
49 it. You need this ARN to be able to call SubscribeToShard.
50  
51 If you delete a consumer and then create a new one with the same name,
52 it won't have the same ARN. That's because consumer ARNs contain the
53 creation timestamp. This is important to keep in mind if you have IAM
54 policies that reference consumer ARNs.
55  
56  
57 =head2 B<REQUIRED> ConsumerCreationTimestamp => Str
58  
59  
60  
61  
62 =head2 B<REQUIRED> ConsumerName => Str
63  
64 The name of the consumer is something you choose when you register the
65 consumer.
66  
67  
68 =head2 B<REQUIRED> ConsumerStatus => Str
69  
70 A consumer can't read data while in the C<CREATING> or C<DELETING>
71 states.
72  
73  
74 =head2 B<REQUIRED> StreamARN => Str
75  
76 The ARN of the stream with which you registered the consumer.
77  
78  
79  
80 =head1 SEE ALSO
81  
82 This class forms part of L<Paws>, describing an object used in L<Paws::Kinesis>
83  
84 =head1 BUGS and CONTRIBUTIONS
85  
86 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
87  
88 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
89  
90 =cut
91