synology_apm.sdk.models.version module

WorkloadVersion and related location models.

class synology_apm.sdk.models.version.VersionLocation(namespace, location_info, location_id, connection_id=None)

Bases: object

A single lockable version copy within a WorkloadVersion, at a specific storage location.

Each instance represents one (namespace, id) pair used for lock/unlock and download/export operations. A WorkloadVersion may have multiple VersionLocation entries when copies exist across different storage locations.

Variables:

  • namespace (str) – Backup server namespace; used for lock/unlock API requests.

  • location_info (synology_apm.sdk.models.location.LocationInfo) – Display information for the storage location (name, endpoint, vault).

  • location_id (str) – Identifier for this location copy; used for lock/unlock and download/export.

  • connection_id (str | None) – Connection identifier for download/export operations; None for appliance locations.

namespace: str
location_info: LocationInfo
location_id: str
connection_id: str | None = None
class synology_apm.sdk.models.version.WorkloadVersion(version_id, workload_id, namespace, created_at, status, execution_id, locked, changed_size_bytes, portal_version_id='', snapshot_id='', locations=<factory>, *, verify_status=None, copy_status=None, copy_reason=None)

Bases: object

A complete backup version of a Workload at a specific point in time.

Variables:

  • version_id (str) – Unique version identifier.

  • workload_id (str) – ID of the Workload this version belongs to.

  • namespace (str) – Namespace of the backup server that holds this version.

  • created_at (datetime.datetime) – Version creation time.

  • status (synology_apm.sdk.enums.VersionStatus) – Backup status of this version.

  • execution_id (str) – Identifier of the backup activity associated with this version.

  • locked (bool) – Whether the version is manually locked (prevents deletion by retention rules).

  • changed_size_bytes (int) – Amount of changed data in this version (bytes).

  • portal_version_id (str) – Version identifier for M365 export and restore operations; empty when not applicable.

  • snapshot_id (str) – Snapshot identifier for download operations; empty when not applicable.

  • verify_status (synology_apm.sdk.enums.VerifyStatus | None) – Backup verification result for this version (PS/VM only); None for PC/FS.

  • locations (list[synology_apm.sdk.models.version.VersionLocation]) – List of all physical storage locations.

  • copy_status (synology_apm.sdk.enums.VersionCopyStatus | None) – Backup copy status for this version; None when Backup Copy is not configured.

  • copy_reason (synology_apm.sdk.enums.CopyReason | None) – Detail reason when copy_status is SKIPPED, RETRY, or FAILED; None otherwise.

version_id: str
workload_id: str
namespace: str
created_at: datetime
status: VersionStatus
execution_id: str
locked: bool
changed_size_bytes: int
portal_version_id: str = ''
snapshot_id: str = ''
verify_status: VerifyStatus | None = None
locations: list[VersionLocation]
copy_status: VersionCopyStatus | None = None
copy_reason: CopyReason | None = None