Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.azure_data_explorer.AzureDataExplorer Class Reference

Public Member Functions

None __init__ (self, HomeAssistant hass, ConfigEntry entry)
 
None async_listen (self, Event event)
 
None async_send (self, _)
 
None async_start (self)
 
None async_stop (self)
 
None test_connection (self)
 

Public Attributes

 hass
 

Private Member Functions

tuple[str|None, int] _parse_event (self, datetime time_fired, State state, int dropped)
 
None _schedule_next_send (self)
 

Private Attributes

 _client
 
 _client_secret
 
 _entities_filter
 
 _entry
 
 _listener_remover
 
 _max_delay
 
 _next_send_remover
 
 _send_interval
 
 _shutdown
 

Detailed Description

A event handler class for Azure Data Explorer.

Definition at line 96 of file __init__.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.azure_data_explorer.AzureDataExplorer.__init__ (   self,
HomeAssistant  hass,
ConfigEntry  entry 
)
Initialize the listener.

Definition at line 99 of file __init__.py.

Member Function Documentation

◆ _parse_event()

tuple[str | None, int] homeassistant.components.azure_data_explorer.AzureDataExplorer._parse_event (   self,
datetime  time_fired,
State  state,
int  dropped 
)
private
Parse event by checking if it needs to be sent, and format it.

Definition at line 192 of file __init__.py.

◆ _schedule_next_send()

None homeassistant.components.azure_data_explorer.AzureDataExplorer._schedule_next_send (   self)
private
Schedule the next send.

Definition at line 146 of file __init__.py.

◆ async_listen()

None homeassistant.components.azure_data_explorer.AzureDataExplorer.async_listen (   self,
Event  event 
)
Listen for new messages on the bus and queue them for ADX.

Definition at line 155 of file __init__.py.

◆ async_send()

None homeassistant.components.azure_data_explorer.AzureDataExplorer.async_send (   self,
  _ 
)
Write preprocessed events to Azure Data Explorer.

Definition at line 160 of file __init__.py.

◆ async_start()

None homeassistant.components.azure_data_explorer.AzureDataExplorer.async_start (   self)
Start the component.

This register the listener and
schedules the first send.

Definition at line 121 of file __init__.py.

◆ async_stop()

None homeassistant.components.azure_data_explorer.AzureDataExplorer.async_stop (   self)
Shut down the ADX by queueing None, calling send, join queue.

Definition at line 133 of file __init__.py.

◆ test_connection()

None homeassistant.components.azure_data_explorer.AzureDataExplorer.test_connection (   self)
Test the connection to the Azure Data Explorer service.

Definition at line 142 of file __init__.py.

Member Data Documentation

◆ _client

homeassistant.components.azure_data_explorer.AzureDataExplorer._client
private

Definition at line 110 of file __init__.py.

◆ _client_secret

homeassistant.components.azure_data_explorer.AzureDataExplorer._client_secret
private

Definition at line 113 of file __init__.py.

◆ _entities_filter

homeassistant.components.azure_data_explorer.AzureDataExplorer._entities_filter
private

Definition at line 108 of file __init__.py.

◆ _entry

homeassistant.components.azure_data_explorer.AzureDataExplorer._entry
private

Definition at line 107 of file __init__.py.

◆ _listener_remover

homeassistant.components.azure_data_explorer.AzureDataExplorer._listener_remover
private

Definition at line 128 of file __init__.py.

◆ _max_delay

homeassistant.components.azure_data_explorer.AzureDataExplorer._max_delay
private

Definition at line 114 of file __init__.py.

◆ _next_send_remover

homeassistant.components.azure_data_explorer.AzureDataExplorer._next_send_remover
private

Definition at line 151 of file __init__.py.

◆ _send_interval

homeassistant.components.azure_data_explorer.AzureDataExplorer._send_interval
private

Definition at line 112 of file __init__.py.

◆ _shutdown

homeassistant.components.azure_data_explorer.AzureDataExplorer._shutdown
private

Definition at line 116 of file __init__.py.

◆ hass

homeassistant.components.azure_data_explorer.AzureDataExplorer.hass

Definition at line 106 of file __init__.py.


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