homeassistant.components.backup.manager.BaseBackupManager Class Reference

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

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

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_post_backup_actions (self, **Any kwargs)
None	async_pre_backup_actions (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_platforms (self)

Public Attributes
	backing_up
	hass
	loaded_platforms

Private Member Functions
None	_add_platform (self, HomeAssistant hass, str integration_domain, BackupPlatformProtocol platform)

Detailed Description

Define the format that backup managers can have.

Definition at line 62 of file manager.py.

Constructor & Destructor Documentation

__init__()

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

Define the format that backup managers can have.

Initialize the backup manager.

Reimplemented in homeassistant.components.backup.manager.BackupManager.

Definition at line 65 of file manager.py.

Member Function Documentation

_add_platform()

None homeassistant.components.backup.manager.BaseBackupManager._add_platform (   self, HomeAssistant  hass, str  integration_domain, BackupPlatformProtocol  platform  )

private

Add a platform to the backup manager.

Definition at line 74 of file manager.py.

async_create_backup()

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

Generate a backup.

Reimplemented in homeassistant.components.backup.manager.BackupManager.

Definition at line 136 of file manager.py.

async_get_backup()

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

Get a backup.

Reimplemented in homeassistant.components.backup.manager.BackupManager.

Definition at line 147 of file manager.py.

async_get_backups()

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

Get backups.

Return a dictionary of Backup instances keyed by their slug.

Reimplemented in homeassistant.components.backup.manager.BackupManager.

Definition at line 140 of file manager.py.

async_post_backup_actions()

None homeassistant.components.backup.manager.BaseBackupManager.async_post_backup_actions	(		self,
		**Any	kwargs
	)

Perform post backup actions.

Definition at line 107 of file manager.py.

async_pre_backup_actions()

None homeassistant.components.backup.manager.BaseBackupManager.async_pre_backup_actions	(		self,
		**Any	kwargs
	)

Perform pre backup actions.

Definition at line 91 of file manager.py.

async_receive_backup()

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

Receive and store a backup file from upload.

Reimplemented in homeassistant.components.backup.manager.BackupManager.

Definition at line 155 of file manager.py.

async_remove_backup()

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

Remove a backup.

Reimplemented in homeassistant.components.backup.manager.BackupManager.

Definition at line 151 of file manager.py.

async_restore_backup()

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

Restore a backup.

Reimplemented in homeassistant.components.backup.manager.BackupManager.

Definition at line 132 of file manager.py.

load_platforms()

None homeassistant.components.backup.manager.BaseBackupManager.load_platforms

(

self

)

Load backup platforms.

Definition at line 123 of file manager.py.

Member Data Documentation

backing_up

homeassistant.components.backup.manager.BaseBackupManager.backing_up

Definition at line 68 of file manager.py.

hass

homeassistant.components.backup.manager.BaseBackupManager.hass

Initialize the backup manager.

Definition at line 67 of file manager.py.

loaded_platforms

homeassistant.components.backup.manager.BaseBackupManager.loaded_platforms

Load backup platforms.

Definition at line 70 of file manager.py.

---

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

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