AWS SDK for C++  1.8.94
AWS SDK for C++
Public Member Functions | List of all members
Aws::Firehose::Model::BufferingHints Class Reference

#include <BufferingHints.h>

Public Member Functions

 BufferingHints ()
 
 BufferingHints (Aws::Utils::Json::JsonView jsonValue)
 
BufferingHintsoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
int GetSizeInMBs () const
 
bool SizeInMBsHasBeenSet () const
 
void SetSizeInMBs (int value)
 
BufferingHintsWithSizeInMBs (int value)
 
int GetIntervalInSeconds () const
 
bool IntervalInSecondsHasBeenSet () const
 
void SetIntervalInSeconds (int value)
 
BufferingHintsWithIntervalInSeconds (int value)
 

Detailed Description

Describes hints for the buffering to perform before delivering data to the destination. These options are treated as hints, and therefore Kinesis Data Firehose might choose to use different values when it is optimal. The SizeInMBs and IntervalInSeconds parameters are optional. However, if specify a value for one of them, you must also provide a value for the other.

See Also:

AWS API Reference

Definition at line 34 of file BufferingHints.h.

Constructor & Destructor Documentation

◆ BufferingHints() [1/2]

Aws::Firehose::Model::BufferingHints::BufferingHints ( )

◆ BufferingHints() [2/2]

Aws::Firehose::Model::BufferingHints::BufferingHints ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ GetIntervalInSeconds()

int Aws::Firehose::Model::BufferingHints::GetIntervalInSeconds ( ) const
inline

Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300. This parameter is optional but if you specify a value for it, you must also specify a value for SizeInMBs, and vice versa.

Definition at line 94 of file BufferingHints.h.

◆ GetSizeInMBs()

int Aws::Firehose::Model::BufferingHints::GetSizeInMBs ( ) const
inline

Buffer incoming data to the specified size, in MiBs, before delivering it to the destination. The default value is 5. This parameter is optional but if you specify a value for it, you must also specify a value for IntervalInSeconds, and vice versa.

We recommend setting this parameter to a value greater than the amount of data you typically ingest into the delivery stream in 10 seconds. For example, if you typically ingest data at 1 MiB/sec, the value should be 10 MiB or higher.

Definition at line 52 of file BufferingHints.h.

◆ IntervalInSecondsHasBeenSet()

bool Aws::Firehose::Model::BufferingHints::IntervalInSecondsHasBeenSet ( ) const
inline

Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300. This parameter is optional but if you specify a value for it, you must also specify a value for SizeInMBs, and vice versa.

Definition at line 102 of file BufferingHints.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::Firehose::Model::BufferingHints::Jsonize ( ) const

◆ operator=()

BufferingHints& Aws::Firehose::Model::BufferingHints::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetIntervalInSeconds()

void Aws::Firehose::Model::BufferingHints::SetIntervalInSeconds ( int  value)
inline

Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300. This parameter is optional but if you specify a value for it, you must also specify a value for SizeInMBs, and vice versa.

Definition at line 110 of file BufferingHints.h.

◆ SetSizeInMBs()

void Aws::Firehose::Model::BufferingHints::SetSizeInMBs ( int  value)
inline

Buffer incoming data to the specified size, in MiBs, before delivering it to the destination. The default value is 5. This parameter is optional but if you specify a value for it, you must also specify a value for IntervalInSeconds, and vice versa.

We recommend setting this parameter to a value greater than the amount of data you typically ingest into the delivery stream in 10 seconds. For example, if you typically ingest data at 1 MiB/sec, the value should be 10 MiB or higher.

Definition at line 74 of file BufferingHints.h.

◆ SizeInMBsHasBeenSet()

bool Aws::Firehose::Model::BufferingHints::SizeInMBsHasBeenSet ( ) const
inline

Buffer incoming data to the specified size, in MiBs, before delivering it to the destination. The default value is 5. This parameter is optional but if you specify a value for it, you must also specify a value for IntervalInSeconds, and vice versa.

We recommend setting this parameter to a value greater than the amount of data you typically ingest into the delivery stream in 10 seconds. For example, if you typically ingest data at 1 MiB/sec, the value should be 10 MiB or higher.

Definition at line 63 of file BufferingHints.h.

◆ WithIntervalInSeconds()

BufferingHints& Aws::Firehose::Model::BufferingHints::WithIntervalInSeconds ( int  value)
inline

Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300. This parameter is optional but if you specify a value for it, you must also specify a value for SizeInMBs, and vice versa.

Definition at line 118 of file BufferingHints.h.

◆ WithSizeInMBs()

BufferingHints& Aws::Firehose::Model::BufferingHints::WithSizeInMBs ( int  value)
inline

Buffer incoming data to the specified size, in MiBs, before delivering it to the destination. The default value is 5. This parameter is optional but if you specify a value for it, you must also specify a value for IntervalInSeconds, and vice versa.

We recommend setting this parameter to a value greater than the amount of data you typically ingest into the delivery stream in 10 seconds. For example, if you typically ingest data at 1 MiB/sec, the value should be 10 MiB or higher.

Definition at line 85 of file BufferingHints.h.


The documentation for this class was generated from the following file: