Skip to content

BufferingHints

Source code in docs_src/capo_firehose/types/buffering_hints.py 
12
13
14
15
16
17
18
class BufferingHints(TypedDict, closed=True):
    size_in_m_bs: NotRequired["capo_firehose.types.size_in_m_bs.SizeInMBs"]
    """<p>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 <code>IntervalInSeconds</code>, and vice versa.</p> <p>We recommend setting this parameter to a value greater than the amount of data you typically ingest into the Firehose stream in 10 seconds. For example, if you typically ingest data at 1 MiB/sec, the value should be 10 MiB or higher.</p>"""
    interval_in_seconds: NotRequired[
        "capo_firehose.types.interval_in_seconds.IntervalInSeconds"
    ]
    """<p>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 <code>SizeInMBs</code>, and vice versa.</p>"""

interval_in_seconds instance-attribute 

interval_in_seconds: NotRequired[IntervalInSeconds]

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.

size_in_m_bs instance-attribute 

size_in_m_bs: NotRequired[SizeInMBs]

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 Firehose stream in 10 seconds. For example, if you typically ingest data at 1 MiB/sec, the value should be 10 MiB or higher.