Skip to content

BatchBuilder

faststream.confluent.helpers.client.BatchBuilder #

BatchBuilder()

A helper class to build a batch of messages to send to Kafka.

Initializes a new BatchBuilder instance.

Source code in faststream/confluent/helpers/client.py 
459
460
461
def __init__(self) -> None:
    """Initializes a new BatchBuilder instance."""
    self._builder: list[dict[str, Any]] = []

append #

append(
    *,
    value: bytes | str | None = None,
    key: bytes | str | None = None,
    timestamp: int | None = None,
    headers: list[tuple[str, bytes]] | None = None,
) -> None

Appends a message to the batch with optional timestamp, key, value, and headers.

Source code in faststream/confluent/helpers/client.py 
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
def append(
    self,
    *,
    value: bytes | str | None = None,
    key: bytes | str | None = None,
    timestamp: int | None = None,
    headers: list[tuple[str, bytes]] | None = None,
) -> None:
    """Appends a message to the batch with optional timestamp, key, value, and headers."""
    if key is None and value is None:
        raise KafkaException(
            KafkaError(40, "Both key and value can't be None"),
        )

    self._builder.append(
        {
            "timestamp_ms": timestamp or round(time() * 1000),
            "key": key,
            "value": value,
            "headers": headers or [],
        },
    )