File Coverage

blib/lib/Paws/Firehose/ElasticsearchDestinationDescription.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::Firehose::ElasticsearchDestinationDescription;
2 1     1   558 use Moose;
  1         3  
  1         8  
3             has BufferingHints => (is => 'ro', isa => 'Paws::Firehose::ElasticsearchBufferingHints');
4             has CloudWatchLoggingOptions => (is => 'ro', isa => 'Paws::Firehose::CloudWatchLoggingOptions');
5             has DomainARN => (is => 'ro', isa => 'Str');
6             has IndexName => (is => 'ro', isa => 'Str');
7             has IndexRotationPeriod => (is => 'ro', isa => 'Str');
8             has ProcessingConfiguration => (is => 'ro', isa => 'Paws::Firehose::ProcessingConfiguration');
9             has RetryOptions => (is => 'ro', isa => 'Paws::Firehose::ElasticsearchRetryOptions');
10             has RoleARN => (is => 'ro', isa => 'Str');
11             has S3BackupMode => (is => 'ro', isa => 'Str');
12             has S3DestinationDescription => (is => 'ro', isa => 'Paws::Firehose::S3DestinationDescription');
13             has TypeName => (is => 'ro', isa => 'Str');
14             1;
15              
16             ### main pod documentation begin ###
17              
18             =head1 NAME
19              
20             Paws::Firehose::ElasticsearchDestinationDescription
21              
22             =head1 USAGE
23              
24             This class represents one of two things:
25              
26             =head3 Arguments in a call to a service
27              
28             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
29             Each attribute should be used as a named argument in the calls that expect this type of object.
30              
31             As an example, if Att1 is expected to be a Paws::Firehose::ElasticsearchDestinationDescription object:
32              
33             $service_obj->Method(Att1 => { BufferingHints => $value, ..., TypeName => $value });
34              
35             =head3 Results returned from an API call
36              
37             Use accessors for each attribute. If Att1 is expected to be an Paws::Firehose::ElasticsearchDestinationDescription object:
38              
39             $result = $service_obj->Method(...);
40             $result->Att1->BufferingHints
41              
42             =head1 DESCRIPTION
43              
44             The destination description in Amazon ES.
45              
46             =head1 ATTRIBUTES
47              
48              
49             =head2 BufferingHints => L<Paws::Firehose::ElasticsearchBufferingHints>
50              
51             The buffering options.
52              
53              
54             =head2 CloudWatchLoggingOptions => L<Paws::Firehose::CloudWatchLoggingOptions>
55              
56             The CloudWatch logging options.
57              
58              
59             =head2 DomainARN => Str
60              
61             The ARN of the Amazon ES domain.
62              
63              
64             =head2 IndexName => Str
65              
66             The Elasticsearch index name.
67              
68              
69             =head2 IndexRotationPeriod => Str
70              
71             The Elasticsearch index rotation period
72              
73              
74             =head2 ProcessingConfiguration => L<Paws::Firehose::ProcessingConfiguration>
75              
76             The data processing configuration.
77              
78              
79             =head2 RetryOptions => L<Paws::Firehose::ElasticsearchRetryOptions>
80              
81             The Amazon ES retry options.
82              
83              
84             =head2 RoleARN => Str
85              
86             The ARN of the AWS credentials.
87              
88              
89             =head2 S3BackupMode => Str
90              
91             The Amazon S3 backup mode.
92              
93              
94             =head2 S3DestinationDescription => L<Paws::Firehose::S3DestinationDescription>
95              
96             The Amazon S3 destination.
97              
98              
99             =head2 TypeName => Str
100              
101             The Elasticsearch type name.
102              
103              
104              
105             =head1 SEE ALSO
106              
107             This class forms part of L<Paws>, describing an object used in L<Paws::Firehose>
108              
109             =head1 BUGS and CONTRIBUTIONS
110              
111             The source code is located here: https://github.com/pplu/aws-sdk-perl
112              
113             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
114              
115             =cut
116