BackupProgressInfo

  • Article

Describes the progress of a partition's backup.

Properties

Name Type Required
BackupState string (enum) No
TimeStampUtc string (date-time) No
BackupId string (uuid) No
BackupLocation string No
EpochOfLastBackupRecord Epoch No
LsnOfLastBackupRecord string No
FailureError FabricErrorError No

BackupState

Type: string (enum)
Required: No

Represents the current state of the partition backup operation.

Possible values are:

  • Invalid - Indicates an invalid backup state. All Service Fabric enumerations have the invalid type.
  • Accepted - Operation has been validated and accepted. Backup is yet to be triggered.
  • BackupInProgress - Backup operation has been triggered and is under process.
  • Success - Operation completed with success.
  • Failure - Operation completed with failure.
  • Timeout - Operation timed out.

TimeStampUtc

Type: string (date-time)
Required: No

TimeStamp in UTC when operation succeeded or failed.

BackupId

Type: string (uuid)
Required: No

Unique ID of the newly created backup.

BackupLocation

Type: string
Required: No

Location, relative to the backup store, of the newly created backup.

EpochOfLastBackupRecord

Type: Epoch
Required: No

Specifies the epoch of the last record included in backup.

LsnOfLastBackupRecord

Type: string
Required: No

The LSN of last record included in backup.

FailureError

Type: FabricErrorError
Required: No

Denotes the failure encountered in performing backup operation.