FileBackupSpace

class backpy.core.space.FileBackupSpace(name, unique_id, space_type, compression_algorithm, compression_level, default_include, default_exclude, remote, max_backups=-1, max_size=-1, auto_deletion=False, auto_deletion_rule='oldest')

Bases: BackupSpace

Methods Summary

create_backup([comment, include, exclude, ...])

get_info_table([verbosity_level])

load_by_name(name)

load_by_uuid(unique_id)

new(name, file_path, **kwargs)

restore_backup(unique_id, incremental[, ...])

Methods Documentation

Parameters:

  • name (str)

  • unique_id (uuid.UUID)

  • space_type (BackupSpaceType)

  • compression_algorithm (compression.CompressionAlgorithm)

  • compression_level (int)

  • default_include (list[str])

  • default_exclude (list[str])

  • remote (Remote | None)

  • max_backups (int)

  • max_size (int)

  • auto_deletion (bool)

  • auto_deletion_rule (str)

create_backup(comment='', include=None, exclude=None, lock=False, location='all', verbosity_level=1)
Parameters:

  • comment (str)

  • include (list[str] | None)

  • exclude (list[str] | None)

  • lock (bool)

  • location (str)

  • verbosity_level (int)

Return type:

Backup

get_info_table(verbosity_level=1)
Parameters:

verbosity_level (int)

Return type:

Table

classmethod load_by_name(name)
Parameters:

name (str)

Return type:

FileBackupSpace

classmethod load_by_uuid(unique_id)
Parameters:

unique_id (str)

Return type:

FileBackupSpace

classmethod new(name, file_path, **kwargs)
Parameters:

  • name (str)

  • file_path (str)

Return type:

FileBackupSpace

restore_backup(unique_id, incremental, source='local', force=False, verbosity_level=1)
Parameters:

  • unique_id (str)

  • incremental (bool)

  • source (str)

  • force (bool)

  • verbosity_level (int)

Return type:

None