Package com.oracle.bmc.recovery.model

Class ProtectedDatabase

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20210216")
public final class ProtectedDatabase
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    A protected database is an Oracle Cloud Database whose backups are managed by Oracle Database Autonomous Recovery Service.

    Each protected database requires a recovery service subnet and a protection policy to use Recovery Service as the backup destination for centralized backup and recovery
    Note: Objects should always be created or deserialized using the ProtectedDatabase.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 ProtectedDatabase.Builder, which maintain a set of all explicitly set fields called ProtectedDatabase.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

      • getId

        public String getId()
        The OCID of the protected database.
        Returns:
        the value

      • getDisplayName

        public String getDisplayName()
        The protected database name.

        You can change the displayName. Avoid entering confidential information.

        Returns:
        the value

      • getCompartmentId

        public String getCompartmentId()
        The OCID of the compartment that contains the protected database.
        Returns:
        the value

      • getDbUniqueName

        public String getDbUniqueName()
        The dbUniqueName for the protected database in Recovery Service.

        You cannot change the unique name.

        Returns:
        the value

      • getVpcUserName

        public String getVpcUserName()
        The virtual private catalog (VPC) user credentials that authenticates the protected database to access Recovery Service.
        Returns:
        the value

      • getDatabaseSize

        public DatabaseSizes getDatabaseSize()
        The size of the protected database.

        XS - Less than 5GB, S - 5GB to 50GB, M - 50GB to 500GB, L

        • 500GB to 1TB, XL - 1TB to 5TB, XXL - Greater than 5TB.
        Returns:
        the value

      • getProtectionPolicyId

        public String getProtectionPolicyId()
        The OCID of the protection policy associated with the protected database.
        Returns:
        the value

      • getPolicyLockedDateTime

        public String getPolicyLockedDateTime()
        An RFC3339 formatted datetime string that specifies the exact date and time for the retention lock to take effect and permanently lock the retention period defined in the policy.

        The retention lock feature controls whether Recovery Service strictly preserves backups for the duration defined in a policy. Retention lock is useful to enforce recovery window compliance and to prevent unintentional modifications to protected database backups. Recovery Service enforces a 14-day delay before the retention lock set for a policy can take effect.

        Returns:
        the value

      • getRecoveryServiceSubnets

        public List<RecoveryServiceSubnetDetails> getRecoveryServiceSubnets()
        List of recovery service subnet resources associated with the protected database.
        Returns:
        the value

      • getDatabaseId

        public String getDatabaseId()
        The OCID of the protected database.
        Returns:
        the value

      • getDatabaseSizeInGBs

        public Integer getDatabaseSizeInGBs()
        The size of the database in GBs, in gigabytes.
        Returns:
        the value

      • getChangeRate

        public Double getChangeRate()
        The percentage of data changes that exist in the database between successive incremental backups.
        Returns:
        the value

      • getCompressionRatio

        public Double getCompressionRatio()
        The compression ratio of the protected database.

        The compression ratio represents the ratio of compressed block size to expanded block size.

        Returns:
        the value

      • getIsRedoLogsShipped

        public Boolean getIsRedoLogsShipped()
        The value TRUE indicates that the protected database is configured to use Real-time data protection, and redo-data is sent from the protected database to Recovery Service.

        Real-time data protection substantially reduces the window of potential data loss that exists between successive archived redo log backups. For this to be effective, additional configuration is needed on client side.

        Returns:
        the value

      • getTimeCreated

        public Date getTimeCreated()
        An RFC3339 formatted datetime string that indicates the created time for a protected database.

        For example: ‘2020-05-22T21:10:29.600Z’

        Returns:
        the value

      • getTimeUpdated

        public Date getTimeUpdated()
        An RFC3339 formatted datetime string that indicates the last updated time for a protected database.

        For example: ‘2020-05-22T21:10:29.600Z’

        Returns:
        the value

      • getLifecycleState

        public LifecycleState getLifecycleState()
        The current state of the Protected Database.
        Returns:
        the value

      • getHealth

        public Health getHealth()
        Indicates the protection status of the database.

        A 'PROTECTED' status indicates that Recovery Service can ensure database recovery to any point in time within the entire recovery window. The potential data loss exposure since the last backup is: - Less than 10 seconds, if Real-time data protection is enabled - Less than 70 minutes if Real-time data protection is disabled

        A 'WARNING' status indicates that Recovery Service can ensure database recovery within the current recovery window - 1 day. The potential data loss exposure since the last backup is: - Greater than 10 seconds, if Real-time data protection is enabled - Greater than 60 minutes, if if Real-time data protection is disabled

        An 'ALERT' status indicates that Recovery Service cannot recover the database within the current recovery window.

        Returns:
        the value

      • getIsReadOnlyResource

        public Boolean getIsReadOnlyResource()
        Indicates whether the protected database is created by Recovery Service or created manually.

        Set to TRUE for a service-defined protected database. When you enable the OCI-managed automatic backups option for a database and set Recovery Service as the backup destination, then Recovery Service creates the associated protected database resource. Set to FALSE for a user-defined protected database.

        Returns:
        the value

      • getLifecycleDetails

        public String getLifecycleDetails()
        Detailed description about the current lifecycle state of the protected database.

        For example, it can be used to provide actionable information for a resource in a Failed state.

        Returns:
        the value

      • getHealthDetails

        public String getHealthDetails()
        A message describing the current health of the protected database.
        Returns:
        the value

      • getMetrics

        public Metrics getMetrics()

      • getSubscriptionId

        public String getSubscriptionId()
        The OCID of the cloud service subscription to which the protected database is linked.
        Returns:
        the value

      • getFreeformTags

        public Map<String,​String> getFreeformTags()
        Simple key-value pair that is applied without any predefined name, type or scope.

        Exists for cross-compatibility only. Example: {“bar-key”: “value”}

        Returns:
        the value

      • getDefinedTags

        public Map<String,​Map<String,​Object>> getDefinedTags()
        Defined tags for this resource.

        Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}. For more information, see Resource Tags

        Returns:
        the value

      • getSystemTags

        public Map<String,​Map<String,​Object>> getSystemTags()
        Usage of system tag keys.

        These predefined keys are scoped to namespaces. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}. For more information, see Resource Tags

        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