AutonomousDatabaseBackup¶
- class oci.database.models.AutonomousDatabaseBackup(**kwargs)¶
Bases:
objectAn Autonomous AI Database backup.
Attributes:
A constant which can be used with the infrastructure_type property of a AutonomousDatabaseBackup.
A constant which can be used with the infrastructure_type property of a AutonomousDatabaseBackup.
A constant which can be used with the lifecycle_state property of a AutonomousDatabaseBackup.
A constant which can be used with the lifecycle_state property of a AutonomousDatabaseBackup.
A constant which can be used with the lifecycle_state property of a AutonomousDatabaseBackup.
A constant which can be used with the lifecycle_state property of a AutonomousDatabaseBackup.
A constant which can be used with the lifecycle_state property of a AutonomousDatabaseBackup.
A constant which can be used with the lifecycle_state property of a AutonomousDatabaseBackup.
A constant which can be used with the type property of a AutonomousDatabaseBackup.
A constant which can be used with the type property of a AutonomousDatabaseBackup.
A constant which can be used with the type property of a AutonomousDatabaseBackup.
A constant which can be used with the type property of a AutonomousDatabaseBackup.
A constant which can be used with the type property of a AutonomousDatabaseBackup.
A constant which can be used with the type property of a AutonomousDatabaseBackup.
[Required] Gets the autonomous_database_id of this AutonomousDatabaseBackup.
Gets the backup_destination_details of this AutonomousDatabaseBackup.
[Required] Gets the compartment_id of this AutonomousDatabaseBackup.
Gets the database_size_in_tbs of this AutonomousDatabaseBackup.
Gets the db_version of this AutonomousDatabaseBackup.
[Required] Gets the display_name of this AutonomousDatabaseBackup.
[Required] Gets the id of this AutonomousDatabaseBackup.
Gets the infrastructure_type of this AutonomousDatabaseBackup.
[Required] Gets the is_automatic of this AutonomousDatabaseBackup.
Gets the is_restorable of this AutonomousDatabaseBackup.
Gets the key_store_id of this AutonomousDatabaseBackup.
Gets the key_store_wallet_name of this AutonomousDatabaseBackup.
Gets the kms_key_id of this AutonomousDatabaseBackup.
Gets the kms_key_version_id of this AutonomousDatabaseBackup.
Gets the lifecycle_details of this AutonomousDatabaseBackup.
[Required] Gets the lifecycle_state of this AutonomousDatabaseBackup.
Gets the region of this AutonomousDatabaseBackup.
Gets the retention_period_in_days of this AutonomousDatabaseBackup.
Gets the size_in_tbs of this AutonomousDatabaseBackup.
Gets the source_database_details of this AutonomousDatabaseBackup.
Gets the time_available_till of this AutonomousDatabaseBackup.
Gets the time_ended of this AutonomousDatabaseBackup.
Gets the time_started of this AutonomousDatabaseBackup.
[Required] Gets the type of this AutonomousDatabaseBackup.
Gets the vault_id of this AutonomousDatabaseBackup.
Methods:
__init__(**kwargs)Initializes a new AutonomousDatabaseBackup object with values from keyword arguments.
- INFRASTRUCTURE_TYPE_CLOUD = 'CLOUD'¶
A constant which can be used with the infrastructure_type property of a AutonomousDatabaseBackup. This constant has a value of “CLOUD”
- INFRASTRUCTURE_TYPE_CLOUD_AT_CUSTOMER = 'CLOUD_AT_CUSTOMER'¶
A constant which can be used with the infrastructure_type property of a AutonomousDatabaseBackup. This constant has a value of “CLOUD_AT_CUSTOMER”
- LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶
A constant which can be used with the lifecycle_state property of a AutonomousDatabaseBackup. This constant has a value of “ACTIVE”
- LIFECYCLE_STATE_CREATING = 'CREATING'¶
A constant which can be used with the lifecycle_state property of a AutonomousDatabaseBackup. This constant has a value of “CREATING”
- LIFECYCLE_STATE_DELETED = 'DELETED'¶
A constant which can be used with the lifecycle_state property of a AutonomousDatabaseBackup. This constant has a value of “DELETED”
- LIFECYCLE_STATE_DELETING = 'DELETING'¶
A constant which can be used with the lifecycle_state property of a AutonomousDatabaseBackup. This constant has a value of “DELETING”
- LIFECYCLE_STATE_FAILED = 'FAILED'¶
A constant which can be used with the lifecycle_state property of a AutonomousDatabaseBackup. This constant has a value of “FAILED”
- LIFECYCLE_STATE_UPDATING = 'UPDATING'¶
A constant which can be used with the lifecycle_state property of a AutonomousDatabaseBackup. This constant has a value of “UPDATING”
- TYPE_CUMULATIVE_INCREMENTAL = 'CUMULATIVE_INCREMENTAL'¶
A constant which can be used with the type property of a AutonomousDatabaseBackup. This constant has a value of “CUMULATIVE_INCREMENTAL”
- TYPE_FULL = 'FULL'¶
A constant which can be used with the type property of a AutonomousDatabaseBackup. This constant has a value of “FULL”
- TYPE_INCREMENTAL = 'INCREMENTAL'¶
A constant which can be used with the type property of a AutonomousDatabaseBackup. This constant has a value of “INCREMENTAL”
- TYPE_LONGTERM = 'LONGTERM'¶
A constant which can be used with the type property of a AutonomousDatabaseBackup. This constant has a value of “LONGTERM”
- TYPE_ROLL_FORWARD_IMAGE_COPY = 'ROLL_FORWARD_IMAGE_COPY'¶
A constant which can be used with the type property of a AutonomousDatabaseBackup. This constant has a value of “ROLL_FORWARD_IMAGE_COPY”
- TYPE_VIRTUAL_FULL = 'VIRTUAL_FULL'¶
A constant which can be used with the type property of a AutonomousDatabaseBackup. This constant has a value of “VIRTUAL_FULL”
- __init__(**kwargs)¶
Initializes a new AutonomousDatabaseBackup object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):
- Parameters
id (str) – The value to assign to the id property of this AutonomousDatabaseBackup.
compartment_id (str) – The value to assign to the compartment_id property of this AutonomousDatabaseBackup.
autonomous_database_id (str) – The value to assign to the autonomous_database_id property of this AutonomousDatabaseBackup.
display_name (str) – The value to assign to the display_name property of this AutonomousDatabaseBackup.
type (str) – The value to assign to the type property of this AutonomousDatabaseBackup. Allowed values for this property are: “INCREMENTAL”, “FULL”, “LONGTERM”, “VIRTUAL_FULL”, “CUMULATIVE_INCREMENTAL”, “ROLL_FORWARD_IMAGE_COPY”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
is_automatic (bool) – The value to assign to the is_automatic property of this AutonomousDatabaseBackup.
time_started (datetime) – The value to assign to the time_started property of this AutonomousDatabaseBackup.
time_ended (datetime) – The value to assign to the time_ended property of this AutonomousDatabaseBackup.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this AutonomousDatabaseBackup.
database_size_in_tbs (float) – The value to assign to the database_size_in_tbs property of this AutonomousDatabaseBackup.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this AutonomousDatabaseBackup. Allowed values for this property are: “CREATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, “UPDATING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
is_restorable (bool) – The value to assign to the is_restorable property of this AutonomousDatabaseBackup.
key_store_id (str) – The value to assign to the key_store_id property of this AutonomousDatabaseBackup.
key_store_wallet_name (str) – The value to assign to the key_store_wallet_name property of this AutonomousDatabaseBackup.
kms_key_id (str) – The value to assign to the kms_key_id property of this AutonomousDatabaseBackup.
vault_id (str) – The value to assign to the vault_id property of this AutonomousDatabaseBackup.
kms_key_version_id (str) – The value to assign to the kms_key_version_id property of this AutonomousDatabaseBackup.
retention_period_in_days (int) – The value to assign to the retention_period_in_days property of this AutonomousDatabaseBackup.
time_available_till (datetime) – The value to assign to the time_available_till property of this AutonomousDatabaseBackup.
db_version (str) – The value to assign to the db_version property of this AutonomousDatabaseBackup.
size_in_tbs (float) – The value to assign to the size_in_tbs property of this AutonomousDatabaseBackup.
backup_destination_details (oci.database.models.BackupDestinationDetails) – The value to assign to the backup_destination_details property of this AutonomousDatabaseBackup.
infrastructure_type (str) – The value to assign to the infrastructure_type property of this AutonomousDatabaseBackup. Allowed values for this property are: “CLOUD”, “CLOUD_AT_CUSTOMER”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
region (str) – The value to assign to the region property of this AutonomousDatabaseBackup.
source_database_details (oci.database.models.SourceDatabaseDetails) – The value to assign to the source_database_details property of this AutonomousDatabaseBackup.
- property autonomous_database_id¶
[Required] Gets the autonomous_database_id of this AutonomousDatabaseBackup. The OCID of the Autonomous AI Database.
- Returns
The autonomous_database_id of this AutonomousDatabaseBackup.
- Return type
str
- property backup_destination_details¶
Gets the backup_destination_details of this AutonomousDatabaseBackup.
- Returns
The backup_destination_details of this AutonomousDatabaseBackup.
- Return type
- property compartment_id¶
[Required] Gets the compartment_id of this AutonomousDatabaseBackup. The OCID of the compartment.
- Returns
The compartment_id of this AutonomousDatabaseBackup.
- Return type
str
- property database_size_in_tbs¶
Gets the database_size_in_tbs of this AutonomousDatabaseBackup. The size of the database in terabytes at the time the backup was taken.
- Returns
The database_size_in_tbs of this AutonomousDatabaseBackup.
- Return type
float
- property db_version¶
Gets the db_version of this AutonomousDatabaseBackup. A valid Oracle AI Database version for Autonomous AI Database. When you specify 23ai for dbversion, the system will provision a 23ai database, but the UI will display it as 26ai. When you specify 26ai for dbversion, the system will provision and display a 26ai database as expected. For new databases, it is recommended to use either 19c or 26ai.
The default database version is the Oracle-recommended version. You can retrieve the default DB version by calling the
list_autonomous_db_versions()operation.Note Starting December 2026, 23ai will not be supported as a valid value for this parameter.
- Returns
The db_version of this AutonomousDatabaseBackup.
- Return type
str
- property display_name¶
[Required] Gets the display_name of this AutonomousDatabaseBackup. The user-friendly name for the backup. The name does not have to be unique.
- Returns
The display_name of this AutonomousDatabaseBackup.
- Return type
str
- property id¶
[Required] Gets the id of this AutonomousDatabaseBackup. The OCID of the Autonomous AI Database backup.
- Returns
The id of this AutonomousDatabaseBackup.
- Return type
str
- property infrastructure_type¶
Gets the infrastructure_type of this AutonomousDatabaseBackup. The infrastructure type this resource belongs to.
Allowed values for this property are: “CLOUD”, “CLOUD_AT_CUSTOMER”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The infrastructure_type of this AutonomousDatabaseBackup.
- Return type
str
- property is_automatic¶
[Required] Gets the is_automatic of this AutonomousDatabaseBackup. Indicates whether the backup is user-initiated or automatic.
- Returns
The is_automatic of this AutonomousDatabaseBackup.
- Return type
bool
- property is_restorable¶
Gets the is_restorable of this AutonomousDatabaseBackup. Indicates whether the backup can be used to restore the associated Autonomous AI Database.
- Returns
The is_restorable of this AutonomousDatabaseBackup.
- Return type
bool
- property key_store_id¶
Gets the key_store_id of this AutonomousDatabaseBackup. The OCID of the key store of Oracle Vault.
- Returns
The key_store_id of this AutonomousDatabaseBackup.
- Return type
str
- property key_store_wallet_name¶
Gets the key_store_wallet_name of this AutonomousDatabaseBackup. The wallet name for Oracle Key Vault.
- Returns
The key_store_wallet_name of this AutonomousDatabaseBackup.
- Return type
str
- property kms_key_id¶
Gets the kms_key_id of this AutonomousDatabaseBackup. The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- Returns
The kms_key_id of this AutonomousDatabaseBackup.
- Return type
str
- property kms_key_version_id¶
Gets the kms_key_version_id of this AutonomousDatabaseBackup. 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.
- Returns
The kms_key_version_id of this AutonomousDatabaseBackup.
- Return type
str
- property lifecycle_details¶
Gets the lifecycle_details of this AutonomousDatabaseBackup. Additional information about the current lifecycle state.
- Returns
The lifecycle_details of this AutonomousDatabaseBackup.
- Return type
str
- property lifecycle_state¶
[Required] Gets the lifecycle_state of this AutonomousDatabaseBackup. The current state of the backup.
Allowed values for this property are: “CREATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, “UPDATING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The lifecycle_state of this AutonomousDatabaseBackup.
- Return type
str
- property region¶
Gets the region of this AutonomousDatabaseBackup. Name of the region in which backup is taken in.
- Returns
The region of this AutonomousDatabaseBackup.
- Return type
str
- property retention_period_in_days¶
Gets the retention_period_in_days of this AutonomousDatabaseBackup. Retention period, in days, for long-term backups
- Returns
The retention_period_in_days of this AutonomousDatabaseBackup.
- Return type
int
- property size_in_tbs¶
Gets the size_in_tbs of this AutonomousDatabaseBackup. The backup size in terrabytes (TB).
- Returns
The size_in_tbs of this AutonomousDatabaseBackup.
- Return type
float
- property source_database_details¶
Gets the source_database_details of this AutonomousDatabaseBackup.
- Returns
The source_database_details of this AutonomousDatabaseBackup.
- Return type
- property time_available_till¶
Gets the time_available_till of this AutonomousDatabaseBackup. Timestamp until when the backup will be available
- Returns
The time_available_till of this AutonomousDatabaseBackup.
- Return type
datetime
- property time_ended¶
Gets the time_ended of this AutonomousDatabaseBackup. The date and time the backup completed.
- Returns
The time_ended of this AutonomousDatabaseBackup.
- Return type
datetime
- property time_started¶
Gets the time_started of this AutonomousDatabaseBackup. The date and time the backup started.
- Returns
The time_started of this AutonomousDatabaseBackup.
- Return type
datetime
- property type¶
[Required] Gets the type of this AutonomousDatabaseBackup. The type of backup.
Allowed values for this property are: “INCREMENTAL”, “FULL”, “LONGTERM”, “VIRTUAL_FULL”, “CUMULATIVE_INCREMENTAL”, “ROLL_FORWARD_IMAGE_COPY”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The type of this AutonomousDatabaseBackup.
- Return type
str