synology_apm.sdk.models.retirement_plan module

RetirementPlan, RetirementRetentionPolicy, and RetirementPlanCreateRequest data models.

class synology_apm.sdk.models.retirement_plan.RetirementRetentionPolicy(days, keep_latest_version)

Bases: object

Version retention policy for a Retirement Plan.

Variables:

  • days (int | None) – Number of days to retain versions. None means no day limit (keep all).

  • keep_latest_version (bool) – Always retain the most recent version, even after the day limit expires.

days: int | None
keep_latest_version: bool
class synology_apm.sdk.models.retirement_plan.RetirementPlan(plan_id, name, description='', retention=None, workload_count=None, run_schedule_by_controller_time=False)

Bases: object

Retirement plan applied to Workloads being retired.

Variables:

  • plan_id (str) – Unique plan identifier.

  • name (str) – Plan display name.

  • description (str) – Plan description.

  • retention (synology_apm.sdk.models.retirement_plan.RetirementRetentionPolicy | None) – Version retention policy after retirement.

  • workload_count (int | None) – Total number of workloads this plan is applied to.

  • run_schedule_by_controller_time (bool) – Whether schedules run on the APM controller’s clock rather than each backup server’s local clock.

plan_id: str
name: str
description: str = ''
retention: RetirementRetentionPolicy | None = None
workload_count: int | None = None
run_schedule_by_controller_time: bool = False
class synology_apm.sdk.models.retirement_plan.RetirementPlanCreateRequest(name, retention_days, description='', keep_latest_version=True, run_schedule_by_controller_time=False)

Bases: object

Parameters for creating a Retirement Plan.

Variables:

  • name (str) – Plan display name.

  • retention_days (int | None) – Days to retain versions; None keeps all versions indefinitely.

  • description (str) – Plan description.

  • keep_latest_version (bool) – Always retain the most recent version even after retention expires.

  • run_schedule_by_controller_time (bool) – Use APM controller’s clock for scheduling.

name: str
retention_days: int | None
description: str = ''
keep_latest_version: bool = True
run_schedule_by_controller_time: bool = False