/** * Database Service API * The API for the Database Service. Use this API to manage resources such as databases and DB Systems. For more information, see [Overview of the Database Service](https://docs.oracle.com/iaas/Content/Database/Concepts/databaseoverview.htm). * OpenAPI spec version: 20160918 * Contact: sic_dbaas_cp_us_grp@oracle.com * * NOTE: This class is auto generated by OracleSDKGenerator. * Do not edit the class manually. * * Copyright (c) 2020, 2026, Oracle and/or its affiliates. All rights reserved. * This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. */ import * as model from "../model"; /** * A 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](https://docs.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm). *

**Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. * */ export interface BackupSummary { /** * The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the backup. */ "id"?: string; /** * The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ "compartmentId"?: string; /** * The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the database. */ "databaseId"?: string; /** * The user-friendly name for the backup. The name does not have to be unique. */ "displayName"?: string; /** * The type of backup. */ "type"?: BackupSummary.Type; /** * The date and time the backup started. */ "timeStarted"?: Date; /** * The date and time the backup was completed. */ "timeEnded"?: Date; /** * Additional information about the current lifecycle state. */ "lifecycleDetails"?: string; /** * The name of the availability domain where the database backup is stored. */ "availabilityDomain"?: string; /** * The current state of the backup. */ "lifecycleState"?: BackupSummary.LifecycleState; /** * 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. * */ "databaseEdition"?: BackupSummary.DatabaseEdition; /** * 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. */ "databaseSizeInGBs"?: number; /** * Shape of the backup's source database. */ "shape"?: string; /** * Version of the backup's source database */ "version"?: string; /** * The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. */ "kmsKeyId"?: 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 AI Database Serverless does not use key versions, hence is not applicable for Autonomous AI Database Serverless instances. * */ "kmsKeyVersionId"?: string; /** * The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [vault](https://docs.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm#concepts). This parameter and {@code secretId} are required for Customer Managed Keys. */ "vaultId"?: string; /** * The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the key store of Oracle Vault. */ "keyStoreId"?: string; /** * The wallet name for Oracle Key Vault. */ "keyStoreWalletName"?: string; /** * List of OCIDs of the key containers used as the secondary encryption key in database transparent data encryption (TDE) operations. */ "secondaryKmsKeyIds"?: Array; /** * The retention period of the long term backup in days. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues. */ "retentionPeriodInDays"?: number; /** * The retention period of the long term backup in years. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues. */ "retentionPeriodInYears"?: number; /** * Expiration time of the long term database backup. */ "timeExpiryScheduled"?: Date; /** * True if Oracle Managed Keys is required for restore of the backup. */ "isUsingOracleManagedKeys"?: boolean; /** * Type of the backup destination. */ "backupDestinationType"?: BackupSummary.BackupDestinationType; "encryptionKeyLocationDetails"?: model.ExternalHsmEncryptionDetails | model.GoogleCloudProviderEncryptionKeyDetails | model.AzureEncryptionKeyDetails | model.AwsEncryptionKeyDetails; } export declare namespace BackupSummary { enum Type { Incremental = "INCREMENTAL", Full = "FULL", VirtualFull = "VIRTUAL_FULL", /** * This value is used if a service returns a value for this enum that is not recognized by this * version of the SDK. */ UnknownValue = "UNKNOWN_VALUE" } enum LifecycleState { Creating = "CREATING", Active = "ACTIVE", Deleting = "DELETING", Deleted = "DELETED", Failed = "FAILED", Restoring = "RESTORING", Updating = "UPDATING", Canceling = "CANCELING", Canceled = "CANCELED", /** * This value is used if a service returns a value for this enum that is not recognized by this * version of the SDK. */ UnknownValue = "UNKNOWN_VALUE" } enum DatabaseEdition { StandardEdition = "STANDARD_EDITION", EnterpriseEdition = "ENTERPRISE_EDITION", EnterpriseEditionHighPerformance = "ENTERPRISE_EDITION_HIGH_PERFORMANCE", EnterpriseEditionExtremePerformance = "ENTERPRISE_EDITION_EXTREME_PERFORMANCE", EnterpriseEditionDeveloper = "ENTERPRISE_EDITION_DEVELOPER", /** * This value is used if a service returns a value for this enum that is not recognized by this * version of the SDK. */ UnknownValue = "UNKNOWN_VALUE" } enum BackupDestinationType { ObjectStore = "OBJECT_STORE", Dbrs = "DBRS", AwsS3 = "AWS_S3", /** * This value is used if a service returns a value for this enum that is not recognized by this * version of the SDK. */ UnknownValue = "UNKNOWN_VALUE" } function getJsonObj(obj: BackupSummary): object; function getDeserializedJsonObj(obj: BackupSummary): object; }