Class Backup


  • @Generated(value="OracleSDKGenerator",
               comments="API Version: 20160918")
    public final class Backup
    extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

    Note: Objects should always be created or deserialized using the Backup.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 Backup.Builder, which maintain a set of all explicitly set fields called Backup.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

      • builder

        public static Backup.Builder builder()
        Create a new builder.
      • getId

        public String getId()
        The OCID of the backup.
        Returns:
        the value
      • getCompartmentId

        public String getCompartmentId()
        The OCID of the compartment.
        Returns:
        the value
      • getDatabaseId

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

        public String getDisplayName()
        The user-friendly name for the backup.

        The name does not have to be unique.

        Returns:
        the value
      • getType

        public Backup.Type getType()
        The type of backup.
        Returns:
        the value
      • getTimeStarted

        public Date getTimeStarted()
        The date and time the backup started.
        Returns:
        the value
      • getTimeEnded

        public Date getTimeEnded()
        The date and time the backup was completed.
        Returns:
        the value
      • getLifecycleDetails

        public String getLifecycleDetails()
        Additional information about the current lifecycle state.
        Returns:
        the value
      • getAvailabilityDomain

        public String getAvailabilityDomain()
        The name of the availability domain where the database backup is stored.
        Returns:
        the value
      • getLifecycleState

        public Backup.LifecycleState getLifecycleState()
        The current state of the backup.
        Returns:
        the value
      • getDatabaseEdition

        public Backup.DatabaseEdition getDatabaseEdition()
        The Oracle Database edition of the DB system from which the database backup was taken.
        Returns:
        the value
      • getDatabaseSizeInGBs

        public Double getDatabaseSizeInGBs()
        The size of the database in gigabytes at the time the backup was taken.
        Returns:
        the value
      • getShape

        public String getShape()
        Shape of the backup’s source database.
        Returns:
        the value
      • getVersion

        public String getVersion()
        Version of the backup’s source database
        Returns:
        the value
      • getKmsKeyId

        public String getKmsKeyId()
        The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
        Returns:
        the value
      • getKmsKeyVersionId

        public String getKmsKeyVersionId()
        The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions.

        If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.

        Returns:
        the value
      • getVaultId

        public String getVaultId()
        The OCID of the Oracle Cloud Infrastructure vault.

        This parameter and secretId are required for Customer Managed Keys.

        Returns:
        the value
      • getKeyStoreId

        public String getKeyStoreId()
        The OCID of the key store of Oracle Vault.
        Returns:
        the value
      • getKeyStoreWalletName

        public String getKeyStoreWalletName()
        The wallet name for Oracle Key Vault.
        Returns:
        the value
      • getSecondaryKmsKeyIds

        public List<String> getSecondaryKmsKeyIds()
        List of OCIDs of the key containers used as the secondary encryption key in database transparent data encryption (TDE) operations.
        Returns:
        the value
      • getRetentionPeriodInDays

        public Integer getRetentionPeriodInDays()
        The retention period of the long term backup in days.
        Returns:
        the value
      • getRetentionPeriodInYears

        public Integer getRetentionPeriodInYears()
        The retention period of the long term backup in years.
        Returns:
        the value
      • getTimeExpiryScheduled

        public Date getTimeExpiryScheduled()
        Expiration time of the long term database backup.
        Returns:
        the value
      • getIsUsingOracleManagedKeys

        public Boolean getIsUsingOracleManagedKeys()
        True if Oracle Managed Keys is required for restore of the backup.
        Returns:
        the value
      • getBackupDestinationType

        public Backup.BackupDestinationType getBackupDestinationType()
        Type of the backup destination.
        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