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