Backup¶

class oci.mysql.models.Backup(**kwargs)¶

Bases: object

A full or incremental copy of a DB System which can be used to create a new DB System or recover a DB System.

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.

Attributes

`BACKUP_TYPE_FULL`	A constant which can be used with the backup_type property of a Backup.
`BACKUP_TYPE_INCREMENTAL`	A constant which can be used with the backup_type property of a Backup.
`CREATION_TYPE_AUTOMATIC`	A constant which can be used with the creation_type property of a Backup.
`CREATION_TYPE_MANUAL`	A constant which can be used with the creation_type property of a Backup.
`CREATION_TYPE_OPERATOR`	A constant which can be used with the creation_type 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_INACTIVE`	A constant which can be used with the lifecycle_state property of a Backup.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a Backup.
`backup_size_in_gbs`	Gets the backup_size_in_gbs of this Backup.
`backup_type`	[Required] Gets the backup_type of this Backup.
`compartment_id`	[Required] Gets the compartment_id of this Backup.
`creation_type`	[Required] Gets the creation_type of this Backup.
`data_storage_size_in_gbs`	Gets the data_storage_size_in_gbs of this Backup.
`db_system_id`	[Required] Gets the db_system_id of this Backup.
`db_system_snapshot`	Gets the db_system_snapshot of this Backup.
`defined_tags`	Gets the defined_tags of this Backup.
`description`	Gets the description of this Backup.
`display_name`	Gets the display_name of this Backup.
`freeform_tags`	Gets the freeform_tags of this Backup.
`id`	[Required] Gets the id of this Backup.
`immediate_source_backup_id`	Gets the immediate_source_backup_id of this Backup.
`lifecycle_details`	[Required] Gets the lifecycle_details of this Backup.
`lifecycle_state`	[Required] Gets the lifecycle_state of this Backup.
`mysql_version`	Gets the mysql_version of this Backup.
`original_source_backup_id`	Gets the original_source_backup_id of this Backup.
`retention_in_days`	Gets the retention_in_days of this Backup.
`shape_name`	Gets the shape_name of this Backup.
`time_copy_created`	Gets the time_copy_created of this Backup.
`time_created`	[Required] Gets the time_created of this Backup.
`time_updated`	[Required] Gets the time_updated of this Backup.

Methods

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

BACKUP_TYPE_FULL = 'FULL'¶: A constant which can be used with the backup_type property of a Backup. This constant has a value of “FULL”

BACKUP_TYPE_INCREMENTAL = 'INCREMENTAL'¶: A constant which can be used with the backup_type property of a Backup. This constant has a value of “INCREMENTAL”

CREATION_TYPE_AUTOMATIC = 'AUTOMATIC'¶: A constant which can be used with the creation_type property of a Backup. This constant has a value of “AUTOMATIC”

CREATION_TYPE_MANUAL = 'MANUAL'¶: A constant which can be used with the creation_type property of a Backup. This constant has a value of “MANUAL”

CREATION_TYPE_OPERATOR = 'OPERATOR'¶: A constant which can be used with the creation_type property of a Backup. This constant has a value of “OPERATOR”

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_INACTIVE = 'INACTIVE'¶: A constant which can be used with the lifecycle_state property of a Backup. This constant has a value of “INACTIVE”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a Backup. This constant has a value of “UPDATING”

__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.
display_name (str) – The value to assign to the display_name property of this Backup.
description (str) – The value to assign to the description property of this Backup.
compartment_id (str) – The value to assign to the compartment_id property of this Backup.
time_created (datetime) – The value to assign to the time_created property of this Backup.
time_updated (datetime) – The value to assign to the time_updated 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”, “INACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this Backup.
backup_type (str) – The value to assign to the backup_type property of this Backup. Allowed values for this property are: “FULL”, “INCREMENTAL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
creation_type (str) – The value to assign to the creation_type property of this Backup. Allowed values for this property are: “MANUAL”, “AUTOMATIC”, “OPERATOR”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
db_system_id (str) – The value to assign to the db_system_id property of this Backup.
db_system_snapshot (oci.mysql.models.DbSystemSnapshot) – The value to assign to the db_system_snapshot property of this Backup.
backup_size_in_gbs (int) – The value to assign to the backup_size_in_gbs property of this Backup.
retention_in_days (int) – The value to assign to the retention_in_days property of this Backup.
data_storage_size_in_gbs (int) – The value to assign to the data_storage_size_in_gbs property of this Backup.
mysql_version (str) – The value to assign to the mysql_version property of this Backup.
shape_name (str) – The value to assign to the shape_name property of this Backup.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this Backup.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this Backup.
immediate_source_backup_id (str) – The value to assign to the immediate_source_backup_id property of this Backup.
original_source_backup_id (str) – The value to assign to the original_source_backup_id property of this Backup.
time_copy_created (datetime) – The value to assign to the time_copy_created property of this Backup.

backup_size_in_gbs¶

Gets the backup_size_in_gbs of this Backup. The size of the backup in base-2 (IEC) gibibytes. (GiB).

Returns:	The backup_size_in_gbs of this Backup.
Return type:	int

backup_type¶

[Required] Gets the backup_type of this Backup. The type of backup.

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

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

compartment_id¶

[Required] Gets the compartment_id of this Backup. The OCID of the compartment.

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

creation_type¶

[Required] Gets the creation_type of this Backup. Indicates how the backup was created: manually, automatic, or by an Operator.

Allowed values for this property are: “MANUAL”, “AUTOMATIC”, “OPERATOR”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

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

data_storage_size_in_gbs¶

Gets the data_storage_size_in_gbs of this Backup. Initial size of the data volume in GiBs.

Returns:	The data_storage_size_in_gbs of this Backup.
Return type:	int

db_system_id¶

[Required] Gets the db_system_id of this Backup. The OCID of the DB System the backup is associated with.

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

db_system_snapshot¶

Gets the db_system_snapshot of this Backup.

Returns:	The db_system_snapshot of this Backup.
Return type:	oci.mysql.models.DbSystemSnapshot

defined_tags¶

Gets the defined_tags of this Backup. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns:	The defined_tags of this Backup.
Return type:	dict(str, dict(str, object))

description¶

Gets the description of this Backup. A user-supplied description for the backup.

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

display_name¶

Gets the display_name of this Backup. A user-supplied display name for the backup.

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

freeform_tags¶

Gets the freeform_tags of this Backup. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}

Returns:	The freeform_tags of this Backup.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this Backup. OCID of the backup itself

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

immediate_source_backup_id¶

Gets the immediate_source_backup_id of this Backup. The OCID of the immediate source DB system backup from which this DB system backup was copied.

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

lifecycle_details¶

[Required] Gets the lifecycle_details of this Backup. Additional information about the current lifecycleState.

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

lifecycle_state¶

[Required] Gets the lifecycle_state of this Backup. The state of the backup.

Allowed values for this property are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, ‘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

mysql_version¶

Gets the mysql_version of this Backup. The MySQL server version of the DB System used for backup.

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

original_source_backup_id¶

Gets the original_source_backup_id of this Backup. The OCID of the original source DB system backup from which this DB system backup was copied.

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

retention_in_days¶

Gets the retention_in_days of this Backup. Number of days to retain this backup.

Returns:	The retention_in_days of this Backup.
Return type:	int

shape_name¶

Gets the shape_name of this Backup. The shape of the DB System used for backup.

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

time_copy_created¶

Gets the time_copy_created of this Backup. The date and time the DB system backup copy was created, as described by RFC 3339.

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

time_created¶

[Required] Gets the time_created of this Backup. The time the backup record was created.

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

time_updated¶

[Required] Gets the time_updated of this Backup. The time at which the backup was updated.

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