Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.apache_kafka Namespace Reference

Classes

class  DateTimeJSONEncoder
 
class  KafkaManager
 

Functions

bool async_setup (HomeAssistant hass, ConfigType config)
 

Variables

string CONF_FILTER = "filter"
 
string CONF_SECURITY_PROTOCOL = "security_protocol"
 
string CONF_TOPIC = "topic"
 
 CONFIG_SCHEMA
 
string DOMAIN = "apache_kafka"
 

Detailed Description

Support for Apache Kafka.

Function Documentation

◆ async_setup()

bool homeassistant.components.apache_kafka.async_setup ( HomeAssistant  hass,
ConfigType  config 
)
Activate the Apache Kafka integration.

Definition at line 52 of file __init__.py.

Variable Documentation

◆ CONF_FILTER

string homeassistant.components.apache_kafka.CONF_FILTER = "filter"

Definition at line 28 of file __init__.py.

◆ CONF_SECURITY_PROTOCOL

string homeassistant.components.apache_kafka.CONF_SECURITY_PROTOCOL = "security_protocol"

Definition at line 30 of file __init__.py.

◆ CONF_TOPIC

string homeassistant.components.apache_kafka.CONF_TOPIC = "topic"

Definition at line 29 of file __init__.py.

◆ CONFIG_SCHEMA

homeassistant.components.apache_kafka.CONFIG_SCHEMA
Initial value:
1 = vol.Schema(
2  {
3  DOMAIN: vol.Schema(
4  {
5  vol.Required(CONF_IP_ADDRESS): cv.string,
6  vol.Required(CONF_PORT): cv.port,
7  vol.Required(CONF_TOPIC): cv.string,
8  vol.Optional(CONF_FILTER, default={}): FILTER_SCHEMA,
9  vol.Optional(CONF_SECURITY_PROTOCOL, default="PLAINTEXT"): vol.In(
10  ["PLAINTEXT", "SSL", "SASL_SSL"]
11  ),
12  vol.Optional(CONF_USERNAME): cv.string,
13  vol.Optional(CONF_PASSWORD): cv.string,
14  }
15  )
16  },
17  extra=vol.ALLOW_EXTRA,
18 )

Definition at line 32 of file __init__.py.

◆ DOMAIN

string homeassistant.components.apache_kafka.DOMAIN = "apache_kafka"

Definition at line 26 of file __init__.py.