Schedule

class backpy.core.backup.Schedule(unique_id, backup_space, location, include, exclude, time_pattern, description)

Bases: object

Methods Summary

activate()

create_from_backup_space(backup_space, ...)

deactivate()

delete([verbosity_level])

get_backup_space()

get_command()

get_config()

get_description()

get_exclude()

get_include()

get_info_table([include_command])

get_location()

get_schedules([active])

get_time_pattern()

get_uuid()

is_active()

load_by_backup_space(backup_space[, active])

load_by_uuid(unique_id)

update_config()

Methods Documentation

Parameters:

  • unique_id (uuid.UUID)

  • backup_space (BackupSpace)

  • location (str)

  • include (list[str])

  • exclude (list[str])

  • time_pattern (str)

  • description (str)

activate()
Return type:

None

classmethod create_from_backup_space(backup_space, time_pattern, description, exclude, include, location, verbosity_level=1)
Parameters:

  • backup_space (BackupSpace)

  • time_pattern (str)

  • description (str)

  • exclude (list[str])

  • include (list[str])

  • location (str)

  • verbosity_level (int)

deactivate()
delete(verbosity_level=1)
Parameters:

verbosity_level (int)

get_backup_space()
Return type:

BackupSpace

get_command()
Return type:

str

get_config()
Return type:

TOMLConfiguration

get_description()
Return type:

str

get_exclude()
Return type:

list[str]

get_include()
Return type:

list[str]

get_info_table(include_command=False)
Parameters:

include_command (bool)

Return type:

Table

get_location()
Return type:

str

classmethod get_schedules(active=False)
Parameters:

active (bool)

Return type:

list[Schedule]

get_time_pattern()
Return type:

str

get_uuid()
Return type:

UUID

is_active()
Return type:

bool

classmethod load_by_backup_space(backup_space, active=False)
Parameters:
Return type:

list[‘Schedule’]

classmethod load_by_uuid(unique_id)
Parameters:

unique_id (str)

Return type:

Schedule

update_config()