Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace Backup

Properties

Optional availabilityDomain

availabilityDomain: undefined | string

The name of the availability domain where the database backup is stored.

Optional backupDestinationType

backupDestinationType: BackupDestinationType

Type of the backup destination.

Optional compartmentId

compartmentId: undefined | string

The OCID of the compartment.

Optional databaseEdition

databaseEdition: DatabaseEdition

The Oracle Database Edition that applies to all the databases on the DB system. Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE.

Optional databaseId

databaseId: undefined | string

The OCID of the database.

Optional databaseSizeInGBs

databaseSizeInGBs: undefined | number

The size of the database in gigabytes at the time the backup was taken. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional displayName

displayName: undefined | string

The user-friendly name for the backup. The name does not have to be unique.

Optional encryptionKeyLocationDetails

Optional id

id: undefined | string

The OCID of the backup.

Optional isUsingOracleManagedKeys

isUsingOracleManagedKeys: undefined | false | true

True if Oracle Managed Keys is required for restore of the backup.

Optional keyStoreId

keyStoreId: undefined | string

The OCID of the key store of Oracle Vault.

Optional keyStoreWalletName

keyStoreWalletName: undefined | string

The wallet name for Oracle Key Vault.

Optional kmsKeyId

kmsKeyId: undefined | string

The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.

Optional kmsKeyVersionId

kmsKeyVersionId: undefined | string

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.

Optional lifecycleDetails

lifecycleDetails: undefined | string

Additional information about the current lifecycle state.

Optional lifecycleState

lifecycleState: LifecycleState

The current state of the backup.

Optional retentionPeriodInDays

retentionPeriodInDays: undefined | number

The retention period of the long term backup in days. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional retentionPeriodInYears

retentionPeriodInYears: undefined | number

The retention period of the long term backup in years. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional secondaryKmsKeyIds

secondaryKmsKeyIds: Array<string>

List of OCIDs of the key containers used as the secondary encryption key in database transparent data encryption (TDE) operations.

Optional shape

shape: undefined | string

Shape of the backup's source database.

Optional timeEnded

timeEnded: Date

The date and time the backup was completed.

Optional timeExpiryScheduled

timeExpiryScheduled: Date

Expiration time of the long term database backup.

Optional timeStarted

timeStarted: Date

The date and time the backup started.

Optional type

type: Type

The type of backup.

Optional vaultId

vaultId: undefined | string

The OCID of the Oracle Cloud Infrastructure vault. This parameter and {@code secretId} are required for Customer Managed Keys.

Optional version

version: undefined | string

Version of the backup's source database

Functions

getDeserializedJsonObj

  • getDeserializedJsonObj(obj: Backup): object

getJsonObj

  • getJsonObj(obj: Backup): object