synology_apm_repo.sdk.units.device_handles module

Node.handle types of the VM/PC/PS device axis. units/device.py (VM), units/device_pcps.py (PC/PS listing) and units/device_disk_fs.py (the “(filesystem)” sibling axis) each build nodes carrying one, and DeviceProvider’s children()/unit() dispatch on its class.

class synology_apm_repo.sdk.units.device_handles.DeviceRoot

Bases: object

A VM version’s “Devices” root.

class synology_apm_repo.sdk.units.device_handles.PcpsRoot

Bases: object

A PC/PS version’s “Disks” root.

class synology_apm_repo.sdk.units.device_handles.Device(config_device_id)

Bases: object

One VM device, listing its objects.

config_device_id: int
class synology_apm_repo.sdk.units.device_handles.VmObject(object_id, data_format, file_path, src_file_path, dedup_object, unsupported)

Bases: object

One VM object: a dedup disk image (dedup_object) or a plain sidecar file under the version’s copy_meta_file directory.

object_id: int
data_format: int | None
file_path: str
src_file_path: str
dedup_object: bool
unsupported: bool

A dedup object in a data format this SDK refuses (a CBT chain).

class synology_apm_repo.sdk.units.device_handles.PcpsFragment(fid, src_file_path, file_size)

Bases: object

One registered fragment of a PC/PS disk; file_size is None when file_meta.file_size is NULL.

fid: int
src_file_path: str
file_size: int | None
class synology_apm_repo.sdk.units.device_handles.PcpsDisk(disk_uuid, disk_index, fragments)

Bases: object

One PC/PS disk, assembled from its fragments when opened.

disk_uuid: str
disk_index: str
fragments: tuple[PcpsFragment, ...]
class synology_apm_repo.sdk.units.device_handles.PcpsDiagnostic(missing_fids)

Bases: object

The placeholder for registered fragments missing from file_meta.

missing_fids: tuple[int, ...]
synology_apm_repo.sdk.units.device_handles.DiskKey = tuple[str, int] | tuple[str, str, str]

Identifies one disk for its filesystem cache — ("object", object_id) for a VM disk, ("pcps", disk_uuid, disk_index) for a PC/PS one.

class synology_apm_repo.sdk.units.device_handles.DiskFsRoot(disk_key, source_node)

Bases: object

A disk image’s “(filesystem)” sibling. source_node is the disk image’s own node, opened through DeviceProvider.unit to parse it; every node below carries it forward, so a canonical ref resolved in a fresh provider can still reach the disk.

disk_key: DiskKey
source_node: Node
class synology_apm_repo.sdk.units.device_handles.DiskFsEntry(disk_key, source_node, partition_addr, path)

Bases: object

A partition, directory or file inside a disk image’s filesystem.

disk_key: DiskKey
source_node: Node
partition_addr: int
path: str
class synology_apm_repo.sdk.units.device_handles.DiskFsDiagnostic(raw_reason)

Bases: object

The placeholder for a disk on which no filesystem was recognized. raw_reason is the underlying error (possibly an internal path), kept out of user-facing text.

raw_reason: str | None