BasicKafkaConsumer¶
- class BasicKafkaConsumer.BasicKafkaConsumer(config, key_deserializer, value_deserializer)¶
Bases:
confluent_kafka.deserializing_consumer.DeserializingConsumerThis is the base class for all Kafka consumers. It expands the confluent-kafka Python DeserializingConsumer class by adding some utility methods.
- config¶
stores dict that stores configuration properties for the confluent-kafka Python DeserializingConsumer
- Type
dict
- key_deserializer¶
deserializer used for message keys
- Type
Deserializer
- value_deserializer¶
decode function used to deserialize message values
- Type
func
- consume(num_messages=1, timeout=- 1)¶
Consume up to the number of messages specified with a timeout for each request
- Parameters
num_messages (int) – The maximum number of messages to wait for.
timeout (float) – Maximum time to block waiting for message(Seconds).
- Returns
Messageor None on timeout- Raises
KeyDeserializationError – If an error occurs during key deserialization.
ValueDeserializationError – If an error occurs during value deserialization.
RuntimeError – if the number of messages is less than 1
- ensure_assignment()¶
Ensures that the consumer is assigned,
- Returns
a list of TopicPartitions that the consumer has been assigned to
- Return type
list(TopicPartitions)