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

Type Alias: BackupInfo

type BackupInfo = object;

Backup Info

Detailed status of a runtime backup. The aggregated state is computed from the backup state of each partition as:

  • If the backup of all partitions is 'COMPLETED', the overall state is 'COMPLETED'.
  • If one partition is 'FAILED', the overall state is 'FAILED'.
  • Otherwise, if one partition is 'DOES_NOT_EXIST', the overall state is 'INCOMPLETE'.
  • Otherwise, if one partition is 'IN_PROGRESS', the overall state is 'IN_PROGRESS'.

Properties​

backupId​

backupId: BackupId;

The id of the backup.

details​

readonly details: PartitionBackupInfo[];

Detailed status of the backup per partition. Always contains every partition of the physical tenant.

failureReason​

failureReason: string | null;

Reason for failure if the state is 'FAILED'.

state​

state: StateCode;

The aggregated state of the backup.