apigee.backups package

Subpackages

Submodules

apigee.backups.backups module

class apigee.backups.backups.ApiProductsBackup(cfg: BackupConfig)

Bases: BaseBackup

collect()
download()
class apigee.backups.backups.ApisBackup(cfg: BackupConfig)

Bases: BaseBackup

collect()
download()
class apigee.backups.backups.AppsBackup(cfg: BackupConfig)

Bases: BaseBackup

collect()
download()
class apigee.backups.backups.Backups(cfg)

Bases: object

run()
class apigee.backups.backups.BaseBackup(cfg: BackupConfig)

Bases: object

error(e, *ctx)
http_error(e, msg)
progress(label)
save(content, subpath)
class apigee.backups.backups.CachesBackup(cfg: BackupConfig)

Bases: BaseBackup

collect()
download()
class apigee.backups.backups.DevelopersBackup(cfg: BackupConfig)

Bases: BaseBackup

collect()
download()
class apigee.backups.backups.KeyValueMapsBackup(cfg: BackupConfig)

Bases: BaseBackup

collect()
download()
class apigee.backups.backups.TargetServersBackup(cfg: BackupConfig)

Bases: BaseBackup

collect()
download()
class apigee.backups.backups.UserRolesBackup(cfg: BackupConfig)

Bases: BaseBackup

collect()
download()

apigee.backups.base module

class apigee.backups.base.BaseBackup(config)

Bases: ABC

abstract async download()
full_path(subpath: str) → Path
handle_error(error: Exception, *ctx)
handle_http_error(error: HTTPError, message: str)
progress(label: str)
async run()
abstract save_snapshot(data)
abstract async snapshot()

apigee.backups.commands module

apigee.backups.commands.validate_resources(apis)

apigee.backups.config module

class apigee.backups.config.BackupConfig(api_choices: Set[str], authentication: apigee.types.Struct, environments: List[str], org_name: str, prefix: Optional[str], working_directory: str, snapshot_data: apigee.types.Struct = <apigee.types.Struct object at 0x7f483f428c10>, progress_bar: Optional[tqdm.std.tqdm] = None, working_org_directory: Optional[pathlib.Path] = None, max_concurrency: int = 10, semaphore: Optional[asyncio.locks.Semaphore] = None)

Bases: object

api_choices: Set[str]
authentication: Struct
environments: List[str]
max_concurrency: int = 10
org_name: str
prefix: str | None
progress_bar: tqdm | None = None
semaphore: Semaphore | None = None
snapshot_data: Struct = <apigee.types.Struct object>
working_directory: str
working_org_directory: Path | None = None
apigee.backups.config.get_global_semaphore()
apigee.backups.config.set_global_semaphore(semaphore: Semaphore)

apigee.backups.registry module

apigee.backups.runner module

class apigee.backups.runner.BackupRunner(config)

Bases: object

async run()

apigee.backups.utils module

async apigee.backups.utils.run_blocking(fn, *args, semaphore=None, **kwargs)

Module contents

class apigee.backups.BackupConfig(api_choices: Set[str], authentication: apigee.types.Struct, environments: List[str], org_name: str, prefix: Optional[str], working_directory: str, snapshot_data: apigee.types.Struct = <apigee.types.Struct object at 0x7f483f428c10>, progress_bar: Optional[tqdm.std.tqdm] = None, working_org_directory: Optional[pathlib.Path] = None, max_concurrency: int = 10, semaphore: Optional[asyncio.locks.Semaphore] = None)

Bases: object

api_choices: Set[str]
authentication: Struct
environments: List[str]
max_concurrency: int = 10
org_name: str
prefix: str | None
progress_bar: tqdm | None = None
semaphore: Semaphore | None = None
snapshot_data: Struct = <apigee.types.Struct object>
working_directory: str
working_org_directory: Path | None = None
class apigee.backups.BackupRunner(config)

Bases: object

async run()
class apigee.backups.Backups(cfg)

Bases: object

run()