BackupSummary¶

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

Bases: object

Details of Backups such as OCID, description, backupType, and so on.

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.

Methods

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

Attributes

`backup_size_in_gbs`	Gets the backup_size_in_gbs of this BackupSummary.
`backup_type`	[Required] Gets the backup_type of this BackupSummary.
`compartment_id`	[Required] Gets the compartment_id of this BackupSummary.
`creation_type`	[Required] Gets the creation_type of this BackupSummary.
`data_storage_size_in_gbs`	Gets the data_storage_size_in_gbs of this BackupSummary.
`db_system_id`	[Required] Gets the db_system_id of this BackupSummary.
`db_system_snapshot_summary`	Gets the db_system_snapshot_summary of this BackupSummary.
`defined_tags`	Gets the defined_tags of this BackupSummary.
`description`	Gets the description of this BackupSummary.
`display_name`	Gets the display_name of this BackupSummary.
`freeform_tags`	Gets the freeform_tags of this BackupSummary.
`id`	[Required] Gets the id of this BackupSummary.
`immediate_source_backup_id`	Gets the immediate_source_backup_id of this BackupSummary.
`lifecycle_state`	[Required] Gets the lifecycle_state of this BackupSummary.
`mysql_version`	Gets the mysql_version of this BackupSummary.
`original_source_backup_id`	Gets the original_source_backup_id of this BackupSummary.
`retention_in_days`	Gets the retention_in_days of this BackupSummary.
`shape_name`	Gets the shape_name of this BackupSummary.
`time_copy_created`	Gets the time_copy_created of this BackupSummary.
`time_created`	[Required] Gets the time_created of this BackupSummary.

__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.
display_name (str) – The value to assign to the display_name property of this BackupSummary.
description (str) – The value to assign to the description property of this BackupSummary.
time_created (datetime) – The value to assign to the time_created property of this BackupSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this BackupSummary.
backup_type (str) – The value to assign to the backup_type property of this BackupSummary.
creation_type (str) – The value to assign to the creation_type property of this BackupSummary.
db_system_id (str) – The value to assign to the db_system_id property of this BackupSummary.
compartment_id (str) – The value to assign to the compartment_id property of this BackupSummary.
data_storage_size_in_gbs (int) – The value to assign to the data_storage_size_in_gbs property of this BackupSummary.
backup_size_in_gbs (int) – The value to assign to the backup_size_in_gbs property of this BackupSummary.
retention_in_days (int) – The value to assign to the retention_in_days property of this BackupSummary.
mysql_version (str) – The value to assign to the mysql_version property of this BackupSummary.
shape_name (str) – The value to assign to the shape_name property of this BackupSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this BackupSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this BackupSummary.
immediate_source_backup_id (str) – The value to assign to the immediate_source_backup_id property of this BackupSummary.
original_source_backup_id (str) – The value to assign to the original_source_backup_id property of this BackupSummary.
time_copy_created (datetime) – The value to assign to the time_copy_created property of this BackupSummary.
db_system_snapshot_summary (oci.mysql.models.DbSystemSnapshotSummary) – The value to assign to the db_system_snapshot_summary property of this BackupSummary.

backup_size_in_gbs¶

Gets the backup_size_in_gbs of this BackupSummary. The size of the backup in GiBs.

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

backup_type¶

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

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

compartment_id¶

[Required] Gets the compartment_id of this BackupSummary. The OCID of the compartment the backup exists in.

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

creation_type¶

[Required] Gets the creation_type of this BackupSummary. If the backup was created automatically, or by a manual request.

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

data_storage_size_in_gbs¶

Gets the data_storage_size_in_gbs of this BackupSummary. Size of the data volume in GiBs.

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

db_system_id¶

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

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

db_system_snapshot_summary¶

Gets the db_system_snapshot_summary of this BackupSummary.

Returns:	The db_system_snapshot_summary of this BackupSummary.
Return type:	oci.mysql.models.DbSystemSnapshotSummary

defined_tags¶

Gets the defined_tags of this BackupSummary. 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 BackupSummary.
Return type:	dict(str, dict(str, object))

description¶

Gets the description of this BackupSummary. A user-supplied description of the backup.

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

display_name¶

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

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

freeform_tags¶

Gets the freeform_tags of this BackupSummary. 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 BackupSummary.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this BackupSummary. OCID of the backup.

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

immediate_source_backup_id¶

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

lifecycle_state¶

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

Returns:	The lifecycle_state of this BackupSummary.
Return type:	str

mysql_version¶

Gets the mysql_version of this BackupSummary. The version of the DB System used for backup.

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

original_source_backup_id¶

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

retention_in_days¶

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

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

shape_name¶

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

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

time_copy_created¶

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

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

time_created¶

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

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