Class BackupSchedule


  • public class BackupSchedule
    extends Object
    Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy.
    • Constructor Detail

      • BackupSchedule

        public BackupSchedule()
    • Method Detail

      • frequencyInterval

        public int frequencyInterval()
        Get how often the backup should be executed (e.g. for weekly backup, this should be set to 7 and FrequencyUnit should be set to Day).
        Returns:
        the frequencyInterval value
      • withFrequencyInterval

        public BackupSchedule withFrequencyInterval​(int frequencyInterval)
        Set how often the backup should be executed (e.g. for weekly backup, this should be set to 7 and FrequencyUnit should be set to Day).
        Parameters:
        frequencyInterval - the frequencyInterval value to set
        Returns:
        the BackupSchedule object itself.
      • frequencyUnit

        public FrequencyUnit frequencyUnit()
        Get the unit of time for how often the backup should be executed (e.g. for weekly backup, this should be set to Day and FrequencyInterval should be set to 7). Possible values include: 'Day', 'Hour'.
        Returns:
        the frequencyUnit value
      • withFrequencyUnit

        public BackupSchedule withFrequencyUnit​(FrequencyUnit frequencyUnit)
        Set the unit of time for how often the backup should be executed (e.g. for weekly backup, this should be set to Day and FrequencyInterval should be set to 7). Possible values include: 'Day', 'Hour'.
        Parameters:
        frequencyUnit - the frequencyUnit value to set
        Returns:
        the BackupSchedule object itself.
      • keepAtLeastOneBackup

        public boolean keepAtLeastOneBackup()
        Get true if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise.
        Returns:
        the keepAtLeastOneBackup value
      • withKeepAtLeastOneBackup

        public BackupSchedule withKeepAtLeastOneBackup​(boolean keepAtLeastOneBackup)
        Set true if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise.
        Parameters:
        keepAtLeastOneBackup - the keepAtLeastOneBackup value to set
        Returns:
        the BackupSchedule object itself.
      • retentionPeriodInDays

        public int retentionPeriodInDays()
        Get after how many days backups should be deleted.
        Returns:
        the retentionPeriodInDays value
      • withRetentionPeriodInDays

        public BackupSchedule withRetentionPeriodInDays​(int retentionPeriodInDays)
        Set after how many days backups should be deleted.
        Parameters:
        retentionPeriodInDays - the retentionPeriodInDays value to set
        Returns:
        the BackupSchedule object itself.
      • startTime

        public org.joda.time.DateTime startTime()
        Get when the schedule should start working.
        Returns:
        the startTime value
      • withStartTime

        public BackupSchedule withStartTime​(org.joda.time.DateTime startTime)
        Set when the schedule should start working.
        Parameters:
        startTime - the startTime value to set
        Returns:
        the BackupSchedule object itself.
      • lastExecutionTime

        public org.joda.time.DateTime lastExecutionTime()
        Get last time when this schedule was triggered.
        Returns:
        the lastExecutionTime value