apigee.backups package
Submodules
apigee.backups.backups module
- class apigee.backups.backups.ApiHandler(cfg: BackupConfig, fm: FileManager, progress: ProgressTracker)
Bases:
object- download()
- snapshot()
- class apigee.backups.backups.ApiProductHandler(cfg: BackupConfig, fm: FileManager, progress: ProgressTracker)
Bases:
object- download()
- snapshot()
- class apigee.backups.backups.AppHandler(cfg: BackupConfig, fm: FileManager, progress: ProgressTracker)
Bases:
object- download()
- snapshot(expand: bool = False, count: int = 1000, startkey: str = '')
- class apigee.backups.backups.BackupConfig(api_choices: Set[str], authentication: apigee.types.Struct, environments: List[str] = <factory>, org_name: str = '', prefix: Optional[str] = None, working_directory: str = '', progress_bar: Any = None, snapshot_data: apigee.types.Struct = <factory>, snapshot_size: int = 0, working_org_directory: Optional[pathlib.Path] = None)
Bases:
object- api_choices: Set[str]
- environments: List[str]
- org_name: str = ''
- prefix: str | None = None
- progress_bar: Any = None
- snapshot_size: int = 0
- working_directory: str = ''
- working_org_directory: Path | None = None
- class apigee.backups.backups.BackupCoordinator(config: BackupConfig)
Bases:
objectCoordinates snapshot generation and downloads. Mirrors the original class behavior but with clearer structure and names.
- close_progress_bar()
- fetch_and_generate_snapshots()
Generate in-memory snapshots for each selected API choice.
- generate_snapshot_files()
Download and write each resource’s full configuration data to disk.
- generate_snapshot_files_and_download_data()
Original combined orchestration: create listings, snapshot files, then download configs.
- class apigee.backups.backups.Backups(config: BackupConfig)
Bases:
objectBackwards-compatible adapter that preserves the original class name. Internally delegates to BackupCoordinator with the same behavior.
- property backupConfig: BackupConfig
- close_progress_bar()
- fetch_and_generate_snapshots()
- generate_snapshot_files()
- generate_snapshot_files_and_download_data()
- class apigee.backups.backups.CacheHandler(cfg: BackupConfig, fm: FileManager, progress: ProgressTracker)
Bases:
object- download()
- snapshot()
- class apigee.backups.backups.DeveloperHandler(cfg: BackupConfig, fm: FileManager, progress: ProgressTracker)
Bases:
object- download()
- snapshot()
- class apigee.backups.backups.ErrorHandler
Bases:
object- static generic(exception: Exception, *args)
- static http(error: HTTPError, append_message: str)
- class apigee.backups.backups.FileManager
Bases:
object- static resolve(base_path: Path, subpath: str) Path
- static write(content: Any, base_path: Path, subpath: str, indentation: int = 2)
- class apigee.backups.backups.KeyValueMapHandler(cfg: BackupConfig, fm: FileManager, progress: ProgressTracker)
Bases:
object- download()
- snapshot()
- class apigee.backups.backups.ProgressTracker(config: BackupConfig)
Bases:
object- close()
- update(description: str = '')
- class apigee.backups.backups.TargetServerHandler(cfg: BackupConfig, fm: FileManager, progress: ProgressTracker)
Bases:
object- download()
- snapshot()
- class apigee.backups.backups.UserRoleHandler(cfg: BackupConfig, fm: FileManager, progress: ProgressTracker)
Bases:
object- download()
- snapshot()