homeassistant.components.apache_kafka.KafkaManager Class Reference

Public Member Functions
None	__init__ (self, HomeAssistant hass, str ip_address, int port, str topic, EntityFilter entities_filter, Literal["PLAINTEXT", "SSL", "SASL_SSL"] security_protocol, str|None username, str|None password)
None	shutdown (self, Event _)
None	start (self)
None	write (self, Event[EventStateChangedData] event)

Private Member Functions
bytes|None	_encode_event (self, Event[EventStateChangedData] event)

Private Attributes
	_encoder
	_entities_filter
	_hass
	_producer
	_topic

Detailed Description

Define a manager to buffer events to Kafka.

Definition at line 87 of file __init__.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.apache_kafka.KafkaManager.__init__	(		self,
		HomeAssistant	hass,
		str	ip_address,
		int	port,
		str	topic,
		EntityFilter	entities_filter,
		Literal["PLAINTEXT", "SSL", "SASL_SSL"]	security_protocol,
		str | None	username,
		str | None	password
	)

Initialize.

Definition at line 90 of file __init__.py.

Member Function Documentation

_encode_event()

bytes | None homeassistant.components.apache_kafka.KafkaManager._encode_event (   self, Event[EventStateChangedData]  event  )

private

Translate events into a binary JSON payload.

Definition at line 117 of file __init__.py.

shutdown()

None homeassistant.components.apache_kafka.KafkaManager.shutdown	(		self,
		Event	_
	)

Shut the manager down.

Definition at line 136 of file __init__.py.

start()

None homeassistant.components.apache_kafka.KafkaManager.start

(

self

)

Start the Kafka manager.

Definition at line 131 of file __init__.py.

write()

None homeassistant.components.apache_kafka.KafkaManager.write	(		self,
		Event[EventStateChangedData]	event
	)

Write a binary payload to Kafka.

Definition at line 140 of file __init__.py.

Member Data Documentation

_encoder

homeassistant.components.apache_kafka.KafkaManager._encoder

private

Definition at line 102 of file __init__.py.

_entities_filter

homeassistant.components.apache_kafka.KafkaManager._entities_filter

private

Definition at line 103 of file __init__.py.

_hass

homeassistant.components.apache_kafka.KafkaManager._hass

private

Definition at line 104 of file __init__.py.

_producer

homeassistant.components.apache_kafka.KafkaManager._producer

private

Definition at line 106 of file __init__.py.

_topic

homeassistant.components.apache_kafka.KafkaManager._topic

private

Definition at line 115 of file __init__.py.

---

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

• core/homeassistant/components/apache_kafka/__init__.py