File Coverage

blib/lib/Paws/Firehose/ElasticsearchBufferingHints.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::ElasticsearchBufferingHints;
2 1     1   302 use Moose;
  1         2  
  1         6  
3             has IntervalInSeconds => (is => 'ro', isa => 'Int');
4             has SizeInMBs => (is => 'ro', isa => 'Int');
5             1;
6              
7             ### main pod documentation begin ###
8              
9             =head1 NAME
10              
11             Paws::Firehose::ElasticsearchBufferingHints
12              
13             =head1 USAGE
14              
15             This class represents one of two things:
16              
17             =head3 Arguments in a call to a service
18              
19             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
20             Each attribute should be used as a named argument in the calls that expect this type of object.
21              
22             As an example, if Att1 is expected to be a Paws::Firehose::ElasticsearchBufferingHints object:
23              
24             $service_obj->Method(Att1 => { IntervalInSeconds => $value, ..., SizeInMBs => $value });
25              
26             =head3 Results returned from an API call
27              
28             Use accessors for each attribute. If Att1 is expected to be an Paws::Firehose::ElasticsearchBufferingHints object:
29              
30             $result = $service_obj->Method(...);
31             $result->Att1->IntervalInSeconds
32              
33             =head1 DESCRIPTION
34              
35             Describes the buffering to perform before delivering data to the Amazon
36             ES destination.
37              
38             =head1 ATTRIBUTES
39              
40              
41             =head2 IntervalInSeconds => Int
42              
43             Buffer incoming data for the specified period of time, in seconds,
44             before delivering it to the destination. The default value is 300 (5
45             minutes).
46              
47              
48             =head2 SizeInMBs => Int
49              
50             Buffer incoming data to the specified size, in MBs, before delivering
51             it to the destination. The default value is 5.
52              
53             We recommend setting this parameter to a value greater than the amount
54             of data you typically ingest into the delivery stream in 10 seconds.
55             For example, if you typically ingest data at 1 MB/sec, the value should
56             be 10 MB or higher.
57              
58              
59              
60             =head1 SEE ALSO
61              
62             This class forms part of L<Paws>, describing an object used in L<Paws::Firehose>
63              
64             =head1 BUGS and CONTRIBUTIONS
65              
66             The source code is located here: https://github.com/pplu/aws-sdk-perl
67              
68             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
69              
70             =cut
71