Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace AutonomousDatabaseBackupSummary

An Autonomous Database backup. 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.

*Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Properties

autonomousDatabaseId

autonomousDatabaseId: string

The OCID of the Autonomous Database.

Optional backupDestinationDetails

backupDestinationDetails: model.BackupDestinationDetails

compartmentId

compartmentId: string

The OCID of the compartment.

Optional databaseSizeInTBs

databaseSizeInTBs: undefined | number

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

Optional dbVersion

dbVersion: undefined | string

A valid Oracle Database version for Autonomous Database.

displayName

displayName: string

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

id

id: string

The OCID of the Autonomous Database backup.

isAutomatic

isAutomatic: boolean

Indicates whether the backup is user-initiated or automatic.

Optional isRestorable

isRestorable: undefined | false | true

Indicates whether the backup can be used to restore the associated Autonomous Database.

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.

lifecycleState

lifecycleState: LifecycleState

The current state of the backup.

Optional retentionPeriodInDays

retentionPeriodInDays: undefined | number

Retention period, in days, for long-term backups Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional sizeInTBs

sizeInTBs: undefined | number

The backup size in terrabytes (TB). Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional timeAvailableTill

timeAvailableTill: Date

Timestamp until when the backup will be available

Optional timeEnded

timeEnded: Date

The date and time the backup completed.

Optional timeStarted

timeStarted: Date

The date and time the backup started.

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.

Functions

getDeserializedJsonObj

getJsonObj