Package io.camunda.zeebe.backup.api

Interface BackupDescriptor

All Known Implementing Classes:
BackupDescriptorImpl
public interface BackupDescriptor
Additional information about the backup that might be required for restoring or querying the status

  • Method Details

    • snapshotId

      Optional<String> snapshotId()
      Returns:
      id of the snapshot included in the backup

    • checkpointPosition

      long checkpointPosition()
      Returns:
      the checkpoint position of the checkpoint included in the backup

    • numberOfPartitions

      int numberOfPartitions()
      The number of partitions configured in the system at the time the backup is taken. This is useful when the system supports dynamic configuration and the system restores from a backup at a time when the number of partitions was different.
      Returns:
      number of partitions at the time backup is taken.

    • brokerVersion

      String brokerVersion()
      Describes the version of the broker that took the backup. This may be a semver version (for example '8.1.0') or an arbitrary string (for example 'dev').

      Including the version might be useful for backwards compatability, for example to restore backups of an old broker.

      Returns:
      The version of the broker that took the backup.