apigee.backups package
Submodules
apigee.backups.backups module
- class apigee.backups.backups.BackupConfig(api_choices: Set[str], authentication: apigee.types.Struct, environments: List[str], org_name: str, prefix: Optional[str], working_directory: str, progress_bar: Any = None, snapshot_data: apigee.types.Struct = <apigee.types.Struct object at 0x7fb9bcb71330>, 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
- progress_bar: Any = None
- snapshot_size: int = 0
- working_directory: str
- working_org_directory: Path | None = None
- class apigee.backups.backups.Backups(config: BackupConfig)
Bases:
object- calculate_total_snapshot_size()
- close_progress_bar()
- create_apiproducts_snapshot()
- create_apis_snapshot()
- create_apps_snapshot(expand=False, count=1000, startkey='')
- create_caches_snapshot()
- create_developers_snapshot()
- create_keyvaluemaps_snapshot()
- create_snapshot(api_choice)
- create_targetservers_snapshot()
- create_userroles_snapshot()
- download_and_save_apiproducts()
- download_and_save_apis()
- download_and_save_apps()
- download_and_save_caches()
- download_and_save_developers()
- download_and_save_keyvaluemaps()
- download_and_save_targetservers()
- download_and_save_userroles()
- download_resource_permissions(role_name)
- download_users_for_a_role(role_name)
- export_and_extract_api(api, revision, output_file, work_dir)
- fetch_and_generate_snapshots()
- filter_empty_values(apps)
- filter_userroles(userroles)
- generate_snapshot_files()
- generate_snapshot_files_and_download_data()
- get_api_details(api_proxies)
- get_apiproduct_content(apiproduct)
- get_apiproduct_path(apiproduct)
- get_app_path(developer, app)
- get_cache_information(environment, cache)
- get_cache_path(environment, cache)
- get_developer_app_details(developer, app)
- get_developer_details(developer)
- get_developer_path(developer)
- get_full_path(working_org_directory, subpath)
- get_keyvaluemap_content(environment, kvm)
- get_keyvaluemap_path(environment, kvm)
- get_output_file_path(api, revision)
- get_resource_permissions_content(role_name)
- get_targetserver_content(environment, targetserver)
- get_targetserver_path(environment, targetserver)
- get_users_for_a_role_content(role_name)
- handle_api_export_error(error, api, revision)
- handle_apiproduct_download_error(error, apiproduct)
- handle_app_download_error(error, app)
- handle_cache_download_error(error, cache)
- handle_developer_download_error(error, developer)
- handle_general_exception(error, *args)
- handle_keyvaluemap_download_error(error, kvm)
- handle_targetserver_download_error(error, targetserver)
- increment_progress_bar(backupConfig)
- initialize_progress_bar(backupConfig)
- list_all_developers(expand=False, count=1000, startkey='')
- list_api_products()
- list_api_proxies()
- list_apps_for_developers(developers)
- list_caches_in_environment(environment)
- list_keyvaluemaps_in_environment(environment)
- list_targetservers_in_environment(environment)
- list_user_roles()
- retrieve_listing(api_choice)
- save_apiproducts_snapshot()
- save_apis_snapshot()
- save_apps_snapshot()
- save_caches_snapshot(environment)
- save_content_to_file(content, subpath)
- save_keyvaluemaps_snapshot(environment)
- save_targetservers_snapshot(environment)
- save_userroles_snapshot()
- set_progress_bar_description(backupConfig, description)
- update_progress_bar(description='')