BackupSummary¶

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

Bases: object

Summary information for a backup.

Methods

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

Attributes

`backup_size`	Gets the backup_size of this BackupSummary.
`compartment_id`	[Required] Gets the compartment_id of this BackupSummary.
`db_system_id`	Gets the db_system_id of this BackupSummary.
`defined_tags`	[Required] Gets the defined_tags of this BackupSummary.
`display_name`	[Required] Gets the display_name of this BackupSummary.
`freeform_tags`	[Required] Gets the freeform_tags of this BackupSummary.
`id`	[Required] Gets the id of this BackupSummary.
`lifecycle_details`	Gets the lifecycle_details of this BackupSummary.
`lifecycle_state`	[Required] Gets the lifecycle_state of this BackupSummary.
`retention_period`	Gets the retention_period of this BackupSummary.
`source_type`	Gets the source_type of this BackupSummary.
`system_tags`	Gets the system_tags of this BackupSummary.
`time_created`	[Required] Gets the time_created of this BackupSummary.
`time_updated`	Gets the time_updated 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.
compartment_id (str) – The value to assign to the compartment_id property of this BackupSummary.
time_created (datetime) – The value to assign to the time_created property of this BackupSummary.
time_updated (datetime) – The value to assign to the time_updated property of this BackupSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this BackupSummary.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this BackupSummary.
source_type (str) – The value to assign to the source_type property of this BackupSummary.
backup_size (int) – The value to assign to the backup_size property of this BackupSummary.
db_system_id (str) – The value to assign to the db_system_id property of this BackupSummary.
retention_period (int) – The value to assign to the retention_period 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.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this BackupSummary.

backup_size¶

Gets the backup_size of this BackupSummary. The size of the backup, in gigabytes.

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

compartment_id¶

[Required] Gets the compartment_id of this BackupSummary. The OCID of the compartment that contains the backup.

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

db_system_id¶

Gets the db_system_id of this BackupSummary. The backup’s source database system’s OCID.

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

defined_tags¶

[Required] 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))

display_name¶

[Required] Gets the display_name of this BackupSummary. A user-friendly display name for the backup. Avoid entering confidential information.

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

freeform_tags¶

[Required] 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. A unique identifier for the backup. Immutable on creation.

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

lifecycle_details¶

Gets the lifecycle_details of this BackupSummary. A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

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

lifecycle_state¶

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

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

retention_period¶

Gets the retention_period of this BackupSummary. Backup retention period in days.

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

source_type¶

Gets the source_type of this BackupSummary. Specifies whether the backup was created manually, taken on schedule defined in the a backup policy, or copied from the remote location.

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

system_tags¶

Gets the system_tags of this BackupSummary. System tags for this resource. Each key is predefined and scoped to a namespace. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns:	The system_tags of this BackupSummary.
Return type:	dict(str, dict(str, object))

time_created¶

[Required] Gets the time_created of this BackupSummary. The date and time the backup was created, expressed in RFC 3339 timestamp format.

Example: 2016-08-25T21:10:29.600Z

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

time_updated¶

Gets the time_updated of this BackupSummary. The date and time the backup was updated, expressed in RFC 3339 timestamp format.

Example: 2016-08-25T21:10:29.600Z

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