For the complete documentation index, see llms.txt.
Skip to main content
Version: 8.10 (unreleased)

Type Alias: ClusterRuntimeBackupTakeResult

type ClusterRuntimeBackupTakeResult = object;

Whether one physical tenant's runtime backup was triggered, and under which id it can be monitored and deleted.

Properties​

backupId​

backupId: BackupId | null;

The id to monitor or delete this physical tenant's backup by: the id it is running under when TRIGGERED — the requested one, or the one the tenant generated when ids are generated — and the requested id to check when UNKNOWN. Null when the tenant is known to be running no backup, and also when an UNKNOWN tenant generates its own ids, because the id it may be running under was never reported; list that tenant's backups to find it.

outcome​

outcome: ClusterRuntimeBackupTakeOutcome;

What this physical tenant did with the trigger.

physicalTenantId​

physicalTenantId: string;

The id of the physical tenant.

reason​

reason: string | null;

Why this physical tenant reported no triggered backup. Null when it was triggered.