homeassistant.components.backup.manager.BackupManager Class Reference

Inheritance diagram for homeassistant.components.backup.manager.BackupManager:

Collaboration diagram for homeassistant.components.backup.manager.BackupManager:

Public Member Functions
None	__init__ (self, HomeAssistant hass)
Backup	async_create_backup (self, **Any kwargs)
Backup|None	async_get_backup (self, *str slug, **Any kwargs)
dict[str, Backup]	async_get_backups (self, **Any kwargs)
None	async_receive_backup (self, *aiohttp.BodyPartReader contents, **Any kwargs)
None	async_remove_backup (self, *str slug, **Any kwargs)
None	async_restore_backup (self, str slug, **Any kwargs)
None	load_backups (self)
Public Member Functions inherited from homeassistant.components.backup.manager.BaseBackupManager
None	async_post_backup_actions (self, **Any kwargs)
None	async_pre_backup_actions (self, **Any kwargs)
None	load_platforms (self)

Public Attributes
	backing_up
	backup_dir
	backups
	loaded_backups
Public Attributes inherited from homeassistant.components.backup.manager.BaseBackupManager
	backing_up
	hass
	loaded_platforms

Private Member Functions
int	_mkdir_and_generate_backup_contents (self, Path tar_file_path, dict[str, Any] backup_data)
dict[str, Backup]	_read_backups (self)

Detailed Description

Backup manager for the Backup integration.

Definition at line 164 of file manager.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.backup.manager.BackupManager.__init__	(		self,
		HomeAssistant	hass
	)

Backup manager for the Backup integration.

Initialize the backup manager.

Reimplemented from homeassistant.components.backup.manager.BaseBackupManager.

Definition at line 167 of file manager.py.

Member Function Documentation

_mkdir_and_generate_backup_contents()

int homeassistant.components.backup.manager.BackupManager._mkdir_and_generate_backup_contents (   self, Path  tar_file_path, dict[str, Any]  backup_data  )

private

Generate backup contents and return the size.

Definition at line 337 of file manager.py.

_read_backups()

dict[str, Backup] homeassistant.components.backup.manager.BackupManager._read_backups (   self )

private

Read backups from disk.

Definition at line 180 of file manager.py.

async_create_backup()

Backup homeassistant.components.backup.manager.BackupManager.async_create_backup	(		self,
		**Any	kwargs
	)

Generate a backup.

Reimplemented from homeassistant.components.backup.manager.BaseBackupManager.

Definition at line 295 of file manager.py.

async_get_backup()

Backup | None homeassistant.components.backup.manager.BackupManager.async_get_backup	(		self,
		*str	slug,
		**Any	kwargs
	)

Return a backup.

Reimplemented from homeassistant.components.backup.manager.BaseBackupManager.

Definition at line 207 of file manager.py.

async_get_backups()

dict[str, Backup] homeassistant.components.backup.manager.BackupManager.async_get_backups	(		self,
		**Any	kwargs
	)

Return backups.

Reimplemented from homeassistant.components.backup.manager.BaseBackupManager.

Definition at line 200 of file manager.py.

async_receive_backup()

None homeassistant.components.backup.manager.BackupManager.async_receive_backup	(		self,
		*aiohttp.BodyPartReader	contents,
		**Any	kwargs
	)

Receive and store a backup file from upload.

Reimplemented from homeassistant.components.backup.manager.BaseBackupManager.

Definition at line 238 of file manager.py.

async_remove_backup()

None homeassistant.components.backup.manager.BackupManager.async_remove_backup	(		self,
		*str	slug,
		**Any	kwargs
	)

Remove a backup.

Reimplemented from homeassistant.components.backup.manager.BaseBackupManager.

Definition at line 229 of file manager.py.

async_restore_backup()

None homeassistant.components.backup.manager.BackupManager.async_restore_backup	(		self,
		str	slug,
		**Any	kwargs
	)

Restore a backup.

This will write the restore information to .HA_RESTORE which
will be handled during startup by the restore_backup module.

Reimplemented from homeassistant.components.backup.manager.BaseBackupManager.

Definition at line 369 of file manager.py.

load_backups()

None homeassistant.components.backup.manager.BackupManager.load_backups

(

self

)

Load data of stored backup files.

Definition at line 173 of file manager.py.

Member Data Documentation

backing_up

homeassistant.components.backup.manager.BackupManager.backing_up

Definition at line 301 of file manager.py.

backup_dir

homeassistant.components.backup.manager.BackupManager.backup_dir

Definition at line 170 of file manager.py.

backups

homeassistant.components.backup.manager.BackupManager.backups

Definition at line 177 of file manager.py.

loaded_backups

homeassistant.components.backup.manager.BackupManager.loaded_backups

Definition at line 171 of file manager.py.

---

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

• core/homeassistant/components/backup/manager.py