Backup

class oci.database.models.Backup(**kwargs)

Bases: object

Backup model.

Attributes

DATABASE_EDITION_ENTERPRISE_EDITION A constant which can be used with the database_edition property of a Backup.
DATABASE_EDITION_ENTERPRISE_EDITION_EXTREME_PERFORMANCE A constant which can be used with the database_edition property of a Backup.
DATABASE_EDITION_ENTERPRISE_EDITION_HIGH_PERFORMANCE A constant which can be used with the database_edition property of a Backup.
DATABASE_EDITION_STANDARD_EDITION A constant which can be used with the database_edition property of a Backup.
LIFECYCLE_STATE_ACTIVE A constant which can be used with the lifecycle_state property of a Backup.
LIFECYCLE_STATE_CREATING A constant which can be used with the lifecycle_state property of a Backup.
LIFECYCLE_STATE_DELETED A constant which can be used with the lifecycle_state property of a Backup.
LIFECYCLE_STATE_DELETING A constant which can be used with the lifecycle_state property of a Backup.
LIFECYCLE_STATE_FAILED A constant which can be used with the lifecycle_state property of a Backup.
LIFECYCLE_STATE_RESTORING A constant which can be used with the lifecycle_state property of a Backup.
TYPE_FULL A constant which can be used with the type property of a Backup.
TYPE_INCREMENTAL A constant which can be used with the type property of a Backup.
TYPE_VIRTUAL_FULL A constant which can be used with the type property of a Backup.
availability_domain Gets the availability_domain of this Backup.
compartment_id Gets the compartment_id of this Backup.
database_edition Gets the database_edition of this Backup.
database_id Gets the database_id of this Backup.
database_size_in_gbs Gets the database_size_in_gbs of this Backup.
display_name Gets the display_name of this Backup.
id Gets the id of this Backup.
kms_key_id Gets the kms_key_id of this Backup.
kms_key_version_id Gets the kms_key_version_id of this Backup.
lifecycle_details Gets the lifecycle_details of this Backup.
lifecycle_state Gets the lifecycle_state of this Backup.
shape Gets the shape of this Backup.
time_ended Gets the time_ended of this Backup.
time_started Gets the time_started of this Backup.
type Gets the type of this Backup.
vault_id Gets the vault_id of this Backup.
version Gets the version of this Backup.

Methods

__init__(**kwargs) Initializes a new Backup object with values from keyword arguments.
DATABASE_EDITION_ENTERPRISE_EDITION = 'ENTERPRISE_EDITION'

A constant which can be used with the database_edition property of a Backup. This constant has a value of “ENTERPRISE_EDITION”

DATABASE_EDITION_ENTERPRISE_EDITION_EXTREME_PERFORMANCE = 'ENTERPRISE_EDITION_EXTREME_PERFORMANCE'

A constant which can be used with the database_edition property of a Backup. 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 Backup. 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 Backup. 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 Backup. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'

A constant which can be used with the lifecycle_state property of a Backup. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'

A constant which can be used with the lifecycle_state property of a Backup. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'

A constant which can be used with the lifecycle_state property of a Backup. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'

A constant which can be used with the lifecycle_state property of a Backup. This constant has a value of “FAILED”

LIFECYCLE_STATE_RESTORING = 'RESTORING'

A constant which can be used with the lifecycle_state property of a Backup. This constant has a value of “RESTORING”

TYPE_FULL = 'FULL'

A constant which can be used with the type property of a Backup. This constant has a value of “FULL”

TYPE_INCREMENTAL = 'INCREMENTAL'

A constant which can be used with the type property of a Backup. This constant has a value of “INCREMENTAL”

TYPE_VIRTUAL_FULL = 'VIRTUAL_FULL'

A constant which can be used with the type property of a Backup. This constant has a value of “VIRTUAL_FULL”

__init__(**kwargs)

Initializes a new Backup 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 Backup.
  • compartment_id (str) – The value to assign to the compartment_id property of this Backup.
  • database_id (str) – The value to assign to the database_id property of this Backup.
  • display_name (str) – The value to assign to the display_name property of this Backup.
  • type (str) – The value to assign to the type property of this 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’.
  • time_started (datetime) – The value to assign to the time_started property of this Backup.
  • time_ended (datetime) – The value to assign to the time_ended property of this Backup.
  • lifecycle_details (str) – The value to assign to the lifecycle_details property of this Backup.
  • availability_domain (str) – The value to assign to the availability_domain property of this Backup.
  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this Backup. Allowed values for this property are: “CREATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, “RESTORING”, ‘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 Backup. Allowed values for this property are: “STANDARD_EDITION”, “ENTERPRISE_EDITION”, “ENTERPRISE_EDITION_HIGH_PERFORMANCE”, “ENTERPRISE_EDITION_EXTREME_PERFORMANCE”, ‘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 Backup.
  • shape (str) – The value to assign to the shape property of this Backup.
  • version (str) – The value to assign to the version property of this Backup.
  • kms_key_id (str) – The value to assign to the kms_key_id property of this Backup.
  • kms_key_version_id (str) – The value to assign to the kms_key_version_id property of this Backup.
  • vault_id (str) – The value to assign to the vault_id property of this Backup.
availability_domain

Gets the availability_domain of this Backup. The name of the availability domain where the database backup is stored.

Returns:The availability_domain of this Backup.
Return type:str
compartment_id

Gets the compartment_id of this Backup. The OCID of the compartment.

Returns:The compartment_id of this Backup.
Return type:str
database_edition

Gets the database_edition of this Backup. The Oracle Database edition of the DB system from which the database backup was taken.

Allowed values for this property are: “STANDARD_EDITION”, “ENTERPRISE_EDITION”, “ENTERPRISE_EDITION_HIGH_PERFORMANCE”, “ENTERPRISE_EDITION_EXTREME_PERFORMANCE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:The database_edition of this Backup.
Return type:str
database_id

Gets the database_id of this Backup. The OCID of the database.

Returns:The database_id of this Backup.
Return type:str
database_size_in_gbs

Gets the database_size_in_gbs of this Backup. The size of the database in gigabytes at the time the backup was taken.

Returns:The database_size_in_gbs of this Backup.
Return type:float
display_name

Gets the display_name of this Backup. The user-friendly name for the backup. The name does not have to be unique.

Returns:The display_name of this Backup.
Return type:str
id

Gets the id of this Backup. The OCID of the backup.

Returns:The id of this Backup.
Return type:str
kms_key_id

Gets the kms_key_id of this Backup. 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 Backup.
Return type:str
kms_key_version_id

Gets the kms_key_version_id of this Backup. 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.

Returns:The kms_key_version_id of this Backup.
Return type:str
lifecycle_details

Gets the lifecycle_details of this Backup. Additional information about the current lifecycle state.

Returns:The lifecycle_details of this Backup.
Return type:str
lifecycle_state

Gets the lifecycle_state of this Backup. The current state of the backup.

Allowed values for this property are: “CREATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, “RESTORING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:The lifecycle_state of this Backup.
Return type:str
shape

Gets the shape of this Backup. Shape of the backup’s source database.

Returns:The shape of this Backup.
Return type:str
time_ended

Gets the time_ended of this Backup. The date and time the backup was completed.

Returns:The time_ended of this Backup.
Return type:datetime
time_started

Gets the time_started of this Backup. The date and time the backup started.

Returns:The time_started of this Backup.
Return type:datetime
type

Gets the type of this Backup. 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 Backup.
Return type:str
vault_id

Gets the vault_id of this Backup. The OCID of the Oracle Cloud Infrastructure vault.

Returns:The vault_id of this Backup.
Return type:str
version

Gets the version of this Backup. Version of the backup’s source database

Returns:The version of this Backup.
Return type:str