Package com.oracle.bmc.distributeddatabase.model

Class DistributedDbBackupConfig

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20250101")
public final class DistributedDbBackupConfig
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    Backup Options To use any of the API operations, you must be authorized in an IAM policy.

    If you’re not authorized, talk to an administrator. If you’re an administrator who needs to write policies to give users access, see Getting Started with Policies.
    Note: Objects should always be created or deserialized using the DistributedDbBackupConfig.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the DistributedDbBackupConfig.Builder, which maintain a set of all explicitly set fields called DistributedDbBackupConfig.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

    • Method Detail

      • getIsAutoBackupEnabled

        public Boolean getIsAutoBackupEnabled()
        If set to true, configures automatic backups.

        If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.

        Returns:
        the value

      • getRecoveryWindowInDays

        public Integer getRecoveryWindowInDays()
        Number of days between the current and the earliest point of recoverability covered by automatic backups.

        This value applies to automatic backups only. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups.

        Returns:
        the value

      • getAutoBackupWindow

        public DistributedDbBackupConfig.AutoBackupWindow getAutoBackupWindow()
        Time window selected for initiating automatic backup for the database system.

        There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO

        Returns:
        the value

      • getAutoFullBackupWindow

        public DistributedDbBackupConfig.AutoFullBackupWindow getAutoFullBackupWindow()
        Time window selected for initiating full backup for the database system.

        There are twelve available two-hour time windows. If no option is selected, the value is null and a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO

        Returns:
        the value

      • getAutoFullBackupDay

        public DistributedDbBackupConfig.AutoFullBackupDay getAutoFullBackupDay()
        Day of the week the full backup should be applied on the database system.

        If no option is selected, the value is null and we will default to Sunday.

        Returns:
        the value

      • getCanRunImmediateFullBackup

        public Boolean getCanRunImmediateFullBackup()
        If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately.
        Returns:
        the value

      • getIsRemoteBackupEnabled

        public Boolean getIsRemoteBackupEnabled()
        If set to true, configures automatic incremental backups in the local region (the region of the DB system) and the remote region with a default frequency of 1 hour.

        If you previously used RMAN or dbcli to configure backups, using the Console or the API for manged backups creates a new backup configuration for your database. The new configuration replaces the configuration created with RMAN or dbcli. This means that you can no longer rely on your previously configured unmanaged backups to work.

        Returns:
        the value

      • getRemoteRegion

        public String getRemoteRegion()
        The name of the remote region where the remote automatic incremental backups will be stored.

        For information about valid region names, see Regions and Availability Domains.

        Returns:
        the value

      • getBackupDeletionPolicy

        public DistributedDbBackupConfig.BackupDeletionPolicy getBackupDeletionPolicy()
        This defines when the backups will be deleted.
        • IMMEDIATE option keep the backup for predefined time i.e 72 hours and then delete permanently… - RETAIN will keep the backups as per the policy defined for database backups.
        Returns:
        the value

      • toString

        public String toString()
        Overrides:
        toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • toString

        public String toString​(boolean includeByteArrayContents)
        Return a string representation of the object.
        Parameters:
        includeByteArrayContents - true to include the full contents of byte arrays
        Returns:
        string representation

      • equals

        public boolean equals​(Object o)
        Overrides:
        equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel