setBackupSchedule method

Future<void> setBackupSchedule({
  1. required String cloudCapsuleId,
  2. BackupFrequency? frequency,
  3. int? day,
  4. int? hour,
  5. Duration? retention,
})

Sets the automated backup schedule for the capsule's database.

Passing a null frequency disables automated backups.

Throws ProcurementDeniedException if frequency is not null and the capsule's plan does not include the backup feature. Throws NotFoundException if the database is not found. Throws InvalidValueException if the schedule parameters are invalid for the given frequency (e.g. a weekly/monthly schedule without a day, or a schedule without an hour), or if the provider rejects a value such as a retention period that exceeds the maximum allowed.

Implementation

_ida.Future<void> setBackupSchedule({
  required String cloudCapsuleId,
  _igzjl4y6.BackupFrequency? frequency,
  int? day,
  int? hour,
  Duration? retention,
}) => caller.callServerEndpoint<void>('database', 'setBackupSchedule', {
  'cloudCapsuleId': cloudCapsuleId,
  'frequency': frequency,
  'day': day,
  'hour': hour,
  'retention': retention,
});