Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface GetBackupByStorageQueryDescription

Package version

Describes additional filters to be applied, while listing backups, and backup storage details from where to fetch the backups.

Hierarchy

  • GetBackupByStorageQueryDescription

Index

Properties

backupEntity

backupEntity: BackupEntityUnion

Indicates the entity for which to enumerate backups.

Optional endDateTimeFilter

endDateTimeFilter: Date

Specifies the end date time in ISO8601 till which to enumerate backups. If not specified, backups are enumerated till the end.

Optional latest

latest: undefined | false | true

If specified as true, gets the most recent backup (within the specified time range) for every partition under the specified backup entity. Default value: false.

Optional startDateTimeFilter

startDateTimeFilter: Date

Specifies the start date time in ISO8601 from which to enumerate backups. If not specified, backups are enumerated from the beginning.

storage

Describes the parameters for the backup storage from where to enumerate backups. This is optional and by default backups are enumerated from the backup storage where this backup entity is currently being backed up (as specified in backup policy). This parameter is useful to be able to enumerate backups from another cluster where you may intend to restore.

Generated using TypeDoc