Skip to main content

ITenantBackupService

Namespace: Meshmakers.Octo.Runtime.Contracts.Blueprints

Service for creating and restoring tenant backups before blueprint updates

public interface ITenantBackupService

Methods​

CreateBackupAsync(String, String, CancellationToken)​

Creates a backup of a tenant's current state

Task<BackupInfo> CreateBackupAsync(string tenantId, string reason, CancellationToken cancellationToken)

Parameters​

tenantId String
Tenant identifier

reason String
Reason for the backup (e.g., "Before update to MyBlueprint-2.0.0")

cancellationToken CancellationToken
Cancellation token

Returns​

Task<BackupInfo>
Backup information including the backup ID

RestoreBackupAsync(String, String, CancellationToken)​

Restores a tenant from a backup

Task<BackupRestoreResult> RestoreBackupAsync(string tenantId, string backupId, CancellationToken cancellationToken)

Parameters​

tenantId String
Tenant identifier

backupId String
Backup identifier to restore from

cancellationToken CancellationToken
Cancellation token

Returns​

Task<BackupRestoreResult>
Result of the restore operation

ListBackupsAsync(String, CancellationToken)​

Lists all available backups for a tenant

Task<IReadOnlyList<BackupInfo>> ListBackupsAsync(string tenantId, CancellationToken cancellationToken)

Parameters​

tenantId String
Tenant identifier

cancellationToken CancellationToken
Cancellation token

Returns​

Task<IReadOnlyList<BackupInfo>>
List of available backups

GetBackupAsync(String, String, CancellationToken)​

Gets a specific backup by ID

Task<BackupInfo> GetBackupAsync(string tenantId, string backupId, CancellationToken cancellationToken)

Parameters​

tenantId String
Tenant identifier

backupId String
Backup identifier

cancellationToken CancellationToken
Cancellation token

Returns​

Task<BackupInfo>
Backup information, or null if not found

DeleteBackupAsync(String, String, CancellationToken)​

Deletes a backup

Task<bool> DeleteBackupAsync(string tenantId, string backupId, CancellationToken cancellationToken)

Parameters​

tenantId String
Tenant identifier

backupId String
Backup identifier

cancellationToken CancellationToken
Cancellation token

Returns​

Task<Boolean>
True if the backup was deleted, false if not found