Package io.camunda.zeebe.backup.api

Interface BackupStore

public interface BackupStore

A store where the backup is stored *

Method Summary

Modifier and Type	Method	Description
CompletableFuture<Void>	closeAsync()
CompletableFuture<Void>	delete(BackupIdentifier id)	Delete all state related to the backup from the storage.
CompletableFuture<BackupStatus>	getStatus(BackupIdentifier id)	Returns the status of the backup
CompletableFuture<Collection<BackupStatus>>	list(BackupIdentifierWildcard wildcard)	Uses the given wildcard to list all backups matching this wildcard.
CompletableFuture<BackupStatusCode>	markFailed(BackupIdentifier id, String failureReason)	Marks the backup as failed.
CompletableFuture<Backup>	restore(BackupIdentifier id, Path targetFolder)	Restores the backup
CompletableFuture<Void>	save(Backup backup)	Saves the backup to the backup storage.

Method Details

save

CompletableFuture<Void> save(Backup backup)

Saves the backup to the backup storage.

getStatus

CompletableFuture<BackupStatus> getStatus(BackupIdentifier id)

Returns the status of the backup

list

CompletableFuture<Collection<BackupStatus>> list(BackupIdentifierWildcard wildcard)

Uses the given wildcard to list all backups matching this wildcard.

delete

CompletableFuture<Void> delete(BackupIdentifier id)

Delete all state related to the backup from the storage. Backups with statusBackupStatusCode.IN_PROGRESS is not deleted. The caller of this method must first mark it as failed.

restore

CompletableFuture<Backup> restore(BackupIdentifier id,
 Path targetFolder)

Restores the backup

markFailed

CompletableFuture<BackupStatusCode> markFailed(BackupIdentifier id,
 String failureReason)

Marks the backup as failed. If saving a backup failed, the backups store must mark it as failed. This method can be used if we want to explicitly mark a partial backup as failed.

closeAsync

CompletableFuture<Void> closeAsync()