Package io.camunda.zeebe.gateway.admin.backup

Interface BackupApi

All Known Implementing Classes:
BackupRequestHandler
public interface BackupApi

  • Method Details

    • takeBackup

      CompletionStage<Long> takeBackup(long backupId)
      Triggers backup on all partitions. Returned future is completed successfully after all partitions have processed the request. Returned future fails if the request was not processed by at least one partition.

      TODO: check if it makes more sense to return a Future if we're always blocking on the result and never combining.

      Parameters:
      backupId - the id of the backup to be taken
      Returns:
      the backupId

    • getStatus

      CompletionStage<BackupStatus> getStatus(long backupId)
      Returns the status of the backup. The future fails if the request was not processed by at least one partition.

      TODO: check if it makes more sense to return a Future if we're always blocking on the result and never combining.

      Returns:
      the status of the backup

    • listBackups

      CompletionStage<List<BackupStatus>> listBackups()
      Returns:
      a list of available backups

    • deleteBackup

      CompletionStage<Void> deleteBackup(long backupId)
      Deletes the backup with the given id
      Parameters:
      backupId - id of the backup to delete