Package com.oracle.bmc.database.model

Class Backup.Builder

  • Enclosing class:
    Backup
    public static class Backup.Builder
extends Object

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • id

        public Backup.Builder id​(String id)
        The OCID of the backup.
        Parameters:
        id - the value to set
        Returns:
        this builder

      • compartmentId

        public Backup.Builder compartmentId​(String compartmentId)
        The OCID of the compartment.
        Parameters:
        compartmentId - the value to set
        Returns:
        this builder

      • databaseId

        public Backup.Builder databaseId​(String databaseId)
        The OCID of the database.
        Parameters:
        databaseId - the value to set
        Returns:
        this builder

      • displayName

        public Backup.Builder displayName​(String displayName)
        The user-friendly name for the backup.

        The name does not have to be unique.

        Parameters:
        displayName - the value to set
        Returns:
        this builder

      • type

        public Backup.Builder type​(Backup.Type type)
        The type of backup.
        Parameters:
        type - the value to set
        Returns:
        this builder

      • timeStarted

        public Backup.Builder timeStarted​(Date timeStarted)
        The date and time the backup started.
        Parameters:
        timeStarted - the value to set
        Returns:
        this builder

      • timeEnded

        public Backup.Builder timeEnded​(Date timeEnded)
        The date and time the backup was completed.
        Parameters:
        timeEnded - the value to set
        Returns:
        this builder

      • lifecycleDetails

        public Backup.Builder lifecycleDetails​(String lifecycleDetails)
        Additional information about the current lifecycle state.
        Parameters:
        lifecycleDetails - the value to set
        Returns:
        this builder

      • availabilityDomain

        public Backup.Builder availabilityDomain​(String availabilityDomain)
        The name of the availability domain where the database backup is stored.
        Parameters:
        availabilityDomain - the value to set
        Returns:
        this builder

      • lifecycleState

        public Backup.Builder lifecycleState​(Backup.LifecycleState lifecycleState)
        The current state of the backup.
        Parameters:
        lifecycleState - the value to set
        Returns:
        this builder

      • databaseEdition

        public Backup.Builder databaseEdition​(Backup.DatabaseEdition databaseEdition)
        The Oracle Database edition of the DB system from which the database backup was taken.
        Parameters:
        databaseEdition - the value to set
        Returns:
        this builder

      • databaseSizeInGBs

        public Backup.Builder databaseSizeInGBs​(Double databaseSizeInGBs)
        The size of the database in gigabytes at the time the backup was taken.
        Parameters:
        databaseSizeInGBs - the value to set
        Returns:
        this builder

      • shape

        public Backup.Builder shape​(String shape)
        Shape of the backup’s source database.
        Parameters:
        shape - the value to set
        Returns:
        this builder

      • version

        public Backup.Builder version​(String version)
        Version of the backup’s source database
        Parameters:
        version - the value to set
        Returns:
        this builder

      • kmsKeyId

        public Backup.Builder kmsKeyId​(String kmsKeyId)
        The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
        Parameters:
        kmsKeyId - the value to set
        Returns:
        this builder

      • kmsKeyVersionId

        public Backup.Builder kmsKeyVersionId​(String kmsKeyVersionId)
        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.

        Parameters:
        kmsKeyVersionId - the value to set
        Returns:
        this builder

      • vaultId

        public Backup.Builder vaultId​(String vaultId)
        The OCID of the Oracle Cloud Infrastructure vault.

        This parameter and secretId are required for Customer Managed Keys.

        Parameters:
        vaultId - the value to set
        Returns:
        this builder

      • keyStoreId

        public Backup.Builder keyStoreId​(String keyStoreId)
        The OCID of the key store of Oracle Vault.
        Parameters:
        keyStoreId - the value to set
        Returns:
        this builder

      • keyStoreWalletName

        public Backup.Builder keyStoreWalletName​(String keyStoreWalletName)
        The wallet name for Oracle Key Vault.
        Parameters:
        keyStoreWalletName - the value to set
        Returns:
        this builder

      • secondaryKmsKeyIds

        public Backup.Builder secondaryKmsKeyIds​(List<String> secondaryKmsKeyIds)
        List of OCIDs of the key containers used as the secondary encryption key in database transparent data encryption (TDE) operations.
        Parameters:
        secondaryKmsKeyIds - the value to set
        Returns:
        this builder

      • retentionPeriodInDays

        public Backup.Builder retentionPeriodInDays​(Integer retentionPeriodInDays)
        The retention period of the long term backup in days.
        Parameters:
        retentionPeriodInDays - the value to set
        Returns:
        this builder

      • retentionPeriodInYears

        public Backup.Builder retentionPeriodInYears​(Integer retentionPeriodInYears)
        The retention period of the long term backup in years.
        Parameters:
        retentionPeriodInYears - the value to set
        Returns:
        this builder

      • timeExpiryScheduled

        public Backup.Builder timeExpiryScheduled​(Date timeExpiryScheduled)
        Expiration time of the long term database backup.
        Parameters:
        timeExpiryScheduled - the value to set
        Returns:
        this builder

      • isUsingOracleManagedKeys

        public Backup.Builder isUsingOracleManagedKeys​(Boolean isUsingOracleManagedKeys)
        True if Oracle Managed Keys is required for restore of the backup.
        Parameters:
        isUsingOracleManagedKeys - the value to set
        Returns:
        this builder

      • backupDestinationType

        public Backup.Builder backupDestinationType​(Backup.BackupDestinationType backupDestinationType)
        Type of the backup destination.
        Parameters:
        backupDestinationType - the value to set
        Returns:
        this builder

      • build

        public Backup build()