synology_apm.sdk.models.gws_auto_backup_rule module

Models for GWS auto-backup rules (User Services and Collaboration Services).

class synology_apm.sdk.models.gws_auto_backup_rule.GWSAutoBackupRule(uid, namespace, domain, plan_id, mail_group_ids, calendar_group_ids, contact_group_ids, drive_group_ids)

Bases: object

A User Services auto-backup rule for a GWS domain.

User Services rules automatically add Mail, Calendar, Contact, and/or Drive members of specified Google Groups to backup protection under a given plan and server. Each service type is bound to its own group list.

Variables:

  • uid (str) – Rule identifier.

  • namespace (str) – Backup server namespace this rule targets.

  • domain (str) – Google Workspace domain this rule belongs to.

  • plan_id (str) – Protection plan ID applied to matched workloads.

  • mail_group_ids (tuple[str, ...]) – Google Group IDs whose Mail members are auto-protected.

  • calendar_group_ids (tuple[str, ...]) – Google Group IDs whose Calendar members are auto-protected.

  • contact_group_ids (tuple[str, ...]) – Google Group IDs whose Contact members are auto-protected.

  • drive_group_ids (tuple[str, ...]) – Google Group IDs whose Drive members are auto-protected.

uid: str
namespace: str
domain: str
plan_id: str
mail_group_ids: tuple[str, ...]
calendar_group_ids: tuple[str, ...]
contact_group_ids: tuple[str, ...]
drive_group_ids: tuple[str, ...]
to_dict()

Return a JSON-safe dict representation.

class synology_apm.sdk.models.gws_auto_backup_rule.GWSSharedDriveSetting(plan_id, namespace, backup_user_id)

Bases: object

Auto-backup setting for the Shared Drive Collaboration Service (enabled when plan_id is non-empty).

Shared Drives are domain-wide — all shared drives are automatically included when enabled.

Variables:

  • plan_id (str) – Protection plan ID applied to matched workloads; empty string = disabled.

  • namespace (str) – Backup server namespace; empty string when disabled.

  • backup_user_id (str) – Google user ID used to back up shared drives; empty string when auto-selected.

plan_id: str
namespace: str
backup_user_id: str
property enabled: bool

True when the Shared Drive collaboration service has an assigned backup plan.

to_dict()

Return a JSON-safe dict representation.

class synology_apm.sdk.models.gws_auto_backup_rule.GWSAutoBackupRuleListResult(rules, shared_drive_setting, include_unlicensed_accounts, include_archived_accounts)

Bases: object

Full auto-backup configuration for one GWS domain.

Variables:
rules: tuple[GWSAutoBackupRule, ...]
shared_drive_setting: GWSSharedDriveSetting | None
include_unlicensed_accounts: bool
include_archived_accounts: bool
to_dict()

Return a JSON-safe dict representation.