BackupSummary¶
- class oci.database.models.BackupSummary(**kwargs)¶
Bases:
objectA 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.
Attributes:
A constant which can be used with the backup_destination_type property of a BackupSummary.
A constant which can be used with the backup_destination_type property of a BackupSummary.
A constant which can be used with the backup_destination_type property of a BackupSummary.
A constant which can be used with the backup_destination_type property of a BackupSummary.
A constant which can be used with the backup_destination_type property of a BackupSummary.
A constant which can be used with the database_edition property of a BackupSummary.
A constant which can be used with the database_edition property of a BackupSummary.
A constant which can be used with the database_edition property of a BackupSummary.
A constant which can be used with the database_edition property of a BackupSummary.
A constant which can be used with the database_edition property of a BackupSummary.
A constant which can be used with the lifecycle_state property of a BackupSummary.
A constant which can be used with the lifecycle_state property of a BackupSummary.
A constant which can be used with the lifecycle_state property of a BackupSummary.
A constant which can be used with the lifecycle_state property of a BackupSummary.
A constant which can be used with the lifecycle_state property of a BackupSummary.
A constant which can be used with the lifecycle_state property of a BackupSummary.
A constant which can be used with the lifecycle_state property of a BackupSummary.
A constant which can be used with the lifecycle_state property of a BackupSummary.
A constant which can be used with the lifecycle_state property of a BackupSummary.
A constant which can be used with the type property of a BackupSummary.
A constant which can be used with the type property of a BackupSummary.
A constant which can be used with the type property of a BackupSummary.
Gets the availability_domain of this BackupSummary.
Gets the backup_destination_type of this BackupSummary.
Gets the compartment_id of this BackupSummary.
Gets the database_edition of this BackupSummary.
Gets the database_id of this BackupSummary.
Gets the database_size_in_gbs of this BackupSummary.
Gets the display_name of this BackupSummary.
Gets the encryption_key_location_details of this BackupSummary.
Gets the id of this BackupSummary.
Gets the is_using_oracle_managed_keys of this BackupSummary.
Gets the key_store_id of this BackupSummary.
Gets the key_store_wallet_name of this BackupSummary.
Gets the kms_key_id of this BackupSummary.
Gets the kms_key_version_id of this BackupSummary.
Gets the lifecycle_details of this BackupSummary.
Gets the lifecycle_state of this BackupSummary.
Gets the retention_period_in_days of this BackupSummary.
Gets the retention_period_in_years of this BackupSummary.
Gets the secondary_kms_key_ids of this BackupSummary.
Gets the shape of this BackupSummary.
Gets the time_ended of this BackupSummary.
Gets the time_expiry_scheduled of this BackupSummary.
Gets the time_started of this BackupSummary.
Gets the type of this BackupSummary.
Gets the vault_id of this BackupSummary.
Gets the version of this BackupSummary.
Methods:
__init__(**kwargs)Initializes a new BackupSummary object with values from keyword arguments.
- BACKUP_DESTINATION_TYPE_AWS_S3 = 'AWS_S3'¶
A constant which can be used with the backup_destination_type property of a BackupSummary. This constant has a value of “AWS_S3”
- BACKUP_DESTINATION_TYPE_DBRS = 'DBRS'¶
A constant which can be used with the backup_destination_type property of a BackupSummary. This constant has a value of “DBRS”
- BACKUP_DESTINATION_TYPE_NFS = 'NFS'¶
A constant which can be used with the backup_destination_type property of a BackupSummary. This constant has a value of “NFS”
- BACKUP_DESTINATION_TYPE_OBJECT_STORE = 'OBJECT_STORE'¶
A constant which can be used with the backup_destination_type property of a BackupSummary. This constant has a value of “OBJECT_STORE”
- BACKUP_DESTINATION_TYPE_RECOVERY_APPLIANCE = 'RECOVERY_APPLIANCE'¶
A constant which can be used with the backup_destination_type property of a BackupSummary. This constant has a value of “RECOVERY_APPLIANCE”
- DATABASE_EDITION_ENTERPRISE_EDITION = 'ENTERPRISE_EDITION'¶
A constant which can be used with the database_edition property of a BackupSummary. This constant has a value of “ENTERPRISE_EDITION”
- DATABASE_EDITION_ENTERPRISE_EDITION_DEVELOPER = 'ENTERPRISE_EDITION_DEVELOPER'¶
A constant which can be used with the database_edition property of a BackupSummary. This constant has a value of “ENTERPRISE_EDITION_DEVELOPER”
- DATABASE_EDITION_ENTERPRISE_EDITION_EXTREME_PERFORMANCE = 'ENTERPRISE_EDITION_EXTREME_PERFORMANCE'¶
A constant which can be used with the database_edition property of a BackupSummary. This constant has a value of “ENTERPRISE_EDITION_EXTREME_PERFORMANCE”
- DATABASE_EDITION_ENTERPRISE_EDITION_HIGH_PERFORMANCE = 'ENTERPRISE_EDITION_HIGH_PERFORMANCE'¶
A constant which can be used with the database_edition property of a BackupSummary. This constant has a value of “ENTERPRISE_EDITION_HIGH_PERFORMANCE”
- DATABASE_EDITION_STANDARD_EDITION = 'STANDARD_EDITION'¶
A constant which can be used with the database_edition property of a BackupSummary. This constant has a value of “STANDARD_EDITION”
- LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶
A constant which can be used with the lifecycle_state property of a BackupSummary. This constant has a value of “ACTIVE”
- LIFECYCLE_STATE_CANCELED = 'CANCELED'¶
A constant which can be used with the lifecycle_state property of a BackupSummary. This constant has a value of “CANCELED”
- LIFECYCLE_STATE_CANCELING = 'CANCELING'¶
A constant which can be used with the lifecycle_state property of a BackupSummary. This constant has a value of “CANCELING”
- LIFECYCLE_STATE_CREATING = 'CREATING'¶
A constant which can be used with the lifecycle_state property of a BackupSummary. This constant has a value of “CREATING”
- LIFECYCLE_STATE_DELETED = 'DELETED'¶
A constant which can be used with the lifecycle_state property of a BackupSummary. This constant has a value of “DELETED”
- LIFECYCLE_STATE_DELETING = 'DELETING'¶
A constant which can be used with the lifecycle_state property of a BackupSummary. This constant has a value of “DELETING”
- LIFECYCLE_STATE_FAILED = 'FAILED'¶
A constant which can be used with the lifecycle_state property of a BackupSummary. This constant has a value of “FAILED”
- LIFECYCLE_STATE_RESTORING = 'RESTORING'¶
A constant which can be used with the lifecycle_state property of a BackupSummary. This constant has a value of “RESTORING”
- LIFECYCLE_STATE_UPDATING = 'UPDATING'¶
A constant which can be used with the lifecycle_state property of a BackupSummary. This constant has a value of “UPDATING”
- TYPE_FULL = 'FULL'¶
A constant which can be used with the type property of a BackupSummary. This constant has a value of “FULL”
- TYPE_INCREMENTAL = 'INCREMENTAL'¶
A constant which can be used with the type property of a BackupSummary. This constant has a value of “INCREMENTAL”
- TYPE_VIRTUAL_FULL = 'VIRTUAL_FULL'¶
A constant which can be used with the type property of a BackupSummary. This constant has a value of “VIRTUAL_FULL”
- __init__(**kwargs)¶
Initializes a new BackupSummary 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 BackupSummary.
compartment_id (str) – The value to assign to the compartment_id property of this BackupSummary.
database_id (str) – The value to assign to the database_id property of this BackupSummary.
display_name (str) – The value to assign to the display_name property of this BackupSummary.
type (str) – The value to assign to the type property of this BackupSummary. Allowed values for this property are: “INCREMENTAL”, “FULL”, “VIRTUAL_FULL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
time_started (datetime) – The value to assign to the time_started property of this BackupSummary.
time_ended (datetime) – The value to assign to the time_ended property of this BackupSummary.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this BackupSummary.
availability_domain (str) – The value to assign to the availability_domain property of this BackupSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this BackupSummary. Allowed values for this property are: “CREATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, “RESTORING”, “UPDATING”, “CANCELING”, “CANCELED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
database_edition (str) – The value to assign to the database_edition property of this BackupSummary. Allowed values for this property are: “STANDARD_EDITION”, “ENTERPRISE_EDITION”, “ENTERPRISE_EDITION_HIGH_PERFORMANCE”, “ENTERPRISE_EDITION_EXTREME_PERFORMANCE”, “ENTERPRISE_EDITION_DEVELOPER”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
database_size_in_gbs (float) – The value to assign to the database_size_in_gbs property of this BackupSummary.
shape (str) – The value to assign to the shape property of this BackupSummary.
version (str) – The value to assign to the version property of this BackupSummary.
kms_key_id (str) – The value to assign to the kms_key_id property of this BackupSummary.
kms_key_version_id (str) – The value to assign to the kms_key_version_id property of this BackupSummary.
vault_id (str) – The value to assign to the vault_id property of this BackupSummary.
key_store_id (str) – The value to assign to the key_store_id property of this BackupSummary.
key_store_wallet_name (str) – The value to assign to the key_store_wallet_name property of this BackupSummary.
secondary_kms_key_ids (list[str]) – The value to assign to the secondary_kms_key_ids property of this BackupSummary.
retention_period_in_days (int) – The value to assign to the retention_period_in_days property of this BackupSummary.
retention_period_in_years (int) – The value to assign to the retention_period_in_years property of this BackupSummary.
time_expiry_scheduled (datetime) – The value to assign to the time_expiry_scheduled property of this BackupSummary.
is_using_oracle_managed_keys (bool) – The value to assign to the is_using_oracle_managed_keys property of this BackupSummary.
backup_destination_type (str) – The value to assign to the backup_destination_type property of this BackupSummary. Allowed values for this property are: “OBJECT_STORE”, “DBRS”, “AWS_S3”, “NFS”, “RECOVERY_APPLIANCE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
encryption_key_location_details (oci.database.models.EncryptionKeyLocationDetails) – The value to assign to the encryption_key_location_details property of this BackupSummary.
- property availability_domain¶
Gets the availability_domain of this BackupSummary. The name of the availability domain where the database backup is stored.
- Returns
The availability_domain of this BackupSummary.
- Return type
str
- property backup_destination_type¶
Gets the backup_destination_type of this BackupSummary. Type of the backup destination.
Allowed values for this property are: “OBJECT_STORE”, “DBRS”, “AWS_S3”, “NFS”, “RECOVERY_APPLIANCE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The backup_destination_type of this BackupSummary.
- Return type
str
- property compartment_id¶
Gets the compartment_id of this BackupSummary. The OCID of the compartment.
- Returns
The compartment_id of this BackupSummary.
- Return type
str
- property database_edition¶
Gets the database_edition of this BackupSummary. 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.
Allowed values for this property are: “STANDARD_EDITION”, “ENTERPRISE_EDITION”, “ENTERPRISE_EDITION_HIGH_PERFORMANCE”, “ENTERPRISE_EDITION_EXTREME_PERFORMANCE”, “ENTERPRISE_EDITION_DEVELOPER”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The database_edition of this BackupSummary.
- Return type
str
- property database_id¶
Gets the database_id of this BackupSummary. The OCID of the database.
- Returns
The database_id of this BackupSummary.
- Return type
str
- property database_size_in_gbs¶
Gets the database_size_in_gbs of this BackupSummary. The size of the database in gigabytes at the time the backup was taken.
- Returns
The database_size_in_gbs of this BackupSummary.
- Return type
float
- property display_name¶
Gets the display_name of this BackupSummary. The user-friendly name for the backup. The name does not have to be unique.
- Returns
The display_name of this BackupSummary.
- Return type
str
- property encryption_key_location_details¶
Gets the encryption_key_location_details of this BackupSummary.
- Returns
The encryption_key_location_details of this BackupSummary.
- Return type
- property id¶
Gets the id of this BackupSummary. The OCID of the backup.
- Returns
The id of this BackupSummary.
- Return type
str
- property is_using_oracle_managed_keys¶
Gets the is_using_oracle_managed_keys of this BackupSummary. True if Oracle Managed Keys is required for restore of the backup.
- Returns
The is_using_oracle_managed_keys of this BackupSummary.
- Return type
bool
- property key_store_id¶
Gets the key_store_id of this BackupSummary. The OCID of the key store of Oracle Vault.
- Returns
The key_store_id of this BackupSummary.
- Return type
str
- property key_store_wallet_name¶
Gets the key_store_wallet_name of this BackupSummary. The wallet name for Oracle Key Vault.
- Returns
The key_store_wallet_name of this BackupSummary.
- Return type
str
- property kms_key_id¶
Gets the kms_key_id of this BackupSummary. 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 BackupSummary.
- Return type
str
- property kms_key_version_id¶
Gets the kms_key_version_id of this BackupSummary. 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 BackupSummary.
- Return type
str
- property lifecycle_details¶
Gets the lifecycle_details of this BackupSummary. Additional information about the current lifecycle state.
- Returns
The lifecycle_details of this BackupSummary.
- Return type
str
- property lifecycle_state¶
Gets the lifecycle_state of this BackupSummary. The current state of the backup.
Allowed values for this property are: “CREATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, “RESTORING”, “UPDATING”, “CANCELING”, “CANCELED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The lifecycle_state of this BackupSummary.
- Return type
str
- property retention_period_in_days¶
Gets the retention_period_in_days of this BackupSummary. The retention period of the long term backup in days.
- Returns
The retention_period_in_days of this BackupSummary.
- Return type
int
- property retention_period_in_years¶
Gets the retention_period_in_years of this BackupSummary. The retention period of the long term backup in years.
- Returns
The retention_period_in_years of this BackupSummary.
- Return type
int
- property secondary_kms_key_ids¶
Gets the secondary_kms_key_ids of this BackupSummary. List of OCIDs of the key containers used as the secondary encryption key in database transparent data encryption (TDE) operations.
- Returns
The secondary_kms_key_ids of this BackupSummary.
- Return type
list[str]
- property shape¶
Gets the shape of this BackupSummary. Shape of the backup’s source database.
- Returns
The shape of this BackupSummary.
- Return type
str
- property time_ended¶
Gets the time_ended of this BackupSummary. The date and time the backup was completed.
- Returns
The time_ended of this BackupSummary.
- Return type
datetime
- property time_expiry_scheduled¶
Gets the time_expiry_scheduled of this BackupSummary. Expiration time of the long term database backup.
- Returns
The time_expiry_scheduled of this BackupSummary.
- Return type
datetime
- property time_started¶
Gets the time_started of this BackupSummary. The date and time the backup started.
- Returns
The time_started of this BackupSummary.
- Return type
datetime
- property type¶
Gets the type of this BackupSummary. The type of backup.
Allowed values for this property are: “INCREMENTAL”, “FULL”, “VIRTUAL_FULL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The type of this BackupSummary.
- Return type
str
- property vault_id¶
Gets the vault_id of this BackupSummary. The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretId are required for Customer Managed Keys.
- Returns
The vault_id of this BackupSummary.
- Return type
str
- property version¶
Gets the version of this BackupSummary. Version of the backup’s source database
- Returns
The version of this BackupSummary.
- Return type
str