LongTermBackupSummary¶
- class oci.recovery.models.LongTermBackupSummary(**kwargs)¶
Bases:
objectGenerate an on-demand backup and retain it long-term as per the LTR backup retention period specified.
Methods:
__init__(**kwargs)Initializes a new LongTermBackupSummary object with values from keyword arguments.
Attributes:
[Required] Gets the compartment_id of this LongTermBackupSummary.
Gets the database_identifier of this LongTermBackupSummary.
Gets the database_size_in_gbs of this LongTermBackupSummary.
Gets the defined_tags of this LongTermBackupSummary.
Gets the display_name of this LongTermBackupSummary.
Gets the freeform_tags of this LongTermBackupSummary.
[Required] Gets the id of this LongTermBackupSummary.
Gets the lifecycle_details of this LongTermBackupSummary.
[Required] Gets the lifecycle_state of this LongTermBackupSummary.
Gets the lifecycle_substate of this LongTermBackupSummary.
[Required] Gets the protected_database_id of this LongTermBackupSummary.
[Required] Gets the retention_period of this LongTermBackupSummary.
Gets the retention_point_in_time of this LongTermBackupSummary.
Gets the retention_scn of this LongTermBackupSummary.
[Required] Gets the retention_until_date_time of this LongTermBackupSummary.
Gets the rman_tag of this LongTermBackupSummary.
Gets the system_tags of this LongTermBackupSummary.
Gets the time_backup_completed of this LongTermBackupSummary.
Gets the time_backup_initiated of this LongTermBackupSummary.
Gets the time_created of this LongTermBackupSummary.
Gets the time_updated of this LongTermBackupSummary.
- __init__(**kwargs)¶
Initializes a new LongTermBackupSummary 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 LongTermBackupSummary.
display_name (str) – The value to assign to the display_name property of this LongTermBackupSummary.
compartment_id (str) – The value to assign to the compartment_id property of this LongTermBackupSummary.
protected_database_id (str) – The value to assign to the protected_database_id property of this LongTermBackupSummary.
retention_scn (int) – The value to assign to the retention_scn property of this LongTermBackupSummary.
retention_point_in_time (datetime) – The value to assign to the retention_point_in_time property of this LongTermBackupSummary.
time_backup_initiated (datetime) – The value to assign to the time_backup_initiated property of this LongTermBackupSummary.
time_backup_completed (datetime) – The value to assign to the time_backup_completed property of this LongTermBackupSummary.
retention_period (list[oci.recovery.models.RetentionPeriodValue]) – The value to assign to the retention_period property of this LongTermBackupSummary.
retention_until_date_time (datetime) – The value to assign to the retention_until_date_time property of this LongTermBackupSummary.
database_identifier (str) – The value to assign to the database_identifier property of this LongTermBackupSummary.
database_size_in_gbs (int) – The value to assign to the database_size_in_gbs property of this LongTermBackupSummary.
time_created (datetime) – The value to assign to the time_created property of this LongTermBackupSummary.
time_updated (datetime) – The value to assign to the time_updated property of this LongTermBackupSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this LongTermBackupSummary.
lifecycle_substate (str) – The value to assign to the lifecycle_substate property of this LongTermBackupSummary.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this LongTermBackupSummary.
rman_tag (str) – The value to assign to the rman_tag property of this LongTermBackupSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this LongTermBackupSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this LongTermBackupSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this LongTermBackupSummary.
- property compartment_id¶
[Required] Gets the compartment_id of this LongTermBackupSummary. The OCID of the compartment that contains the long term backup.
- Returns
The compartment_id of this LongTermBackupSummary.
- Return type
str
- property database_identifier¶
Gets the database_identifier of this LongTermBackupSummary. The Oracle Database ID, which identifies an Oracle Database located outside of Oracle Cloud.
- Returns
The database_identifier of this LongTermBackupSummary.
- Return type
str
- property database_size_in_gbs¶
Gets the database_size_in_gbs of this LongTermBackupSummary. Database size
- Returns
The database_size_in_gbs of this LongTermBackupSummary.
- Return type
int
- property defined_tags¶
Gets the defined_tags of this LongTermBackupSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}. For more information, see Resource Tags
- Returns
The defined_tags of this LongTermBackupSummary.
- Return type
dict(str, dict(str, object))
- property display_name¶
Gets the display_name of this LongTermBackupSummary. The long term backup name. You can change the displayName. Avoid entering confidential information.
- Returns
The display_name of this LongTermBackupSummary.
- Return type
str
- property freeform_tags¶
Gets the freeform_tags of this LongTermBackupSummary. 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 LongTermBackupSummary.
- Return type
dict(str, str)
- property id¶
[Required] Gets the id of this LongTermBackupSummary. The Long Term Backup OCID.
- Returns
The id of this LongTermBackupSummary.
- Return type
str
- property lifecycle_details¶
Gets the lifecycle_details of this LongTermBackupSummary. Detailed description about the current lifecycle state of the long term backup. For example, it can be used to provide actionable information for a resource in a Failed state.
- Returns
The lifecycle_details of this LongTermBackupSummary.
- Return type
str
- property lifecycle_state¶
[Required] Gets the lifecycle_state of this LongTermBackupSummary. The current state of the long term backup.
- Returns
The lifecycle_state of this LongTermBackupSummary.
- Return type
str
- property lifecycle_substate¶
Gets the lifecycle_substate of this LongTermBackupSummary. More details on the state of the backup when it is in Creating lifecycleState.
- Returns
The lifecycle_substate of this LongTermBackupSummary.
- Return type
str
- property protected_database_id¶
[Required] Gets the protected_database_id of this LongTermBackupSummary. The protected database ocid.
- Returns
The protected_database_id of this LongTermBackupSummary.
- Return type
str
- property retention_period¶
[Required] Gets the retention_period of this LongTermBackupSummary. Retain the long-term backup as per the backup retention period specified
- Returns
The retention_period of this LongTermBackupSummary.
- Return type
- property retention_point_in_time¶
Gets the retention_point_in_time of this LongTermBackupSummary. An RFC3339 formatted datetime string that indicates the time for a long term backup to be initiated.
- Returns
The retention_point_in_time of this LongTermBackupSummary.
- Return type
datetime
- property retention_scn¶
Gets the retention_scn of this LongTermBackupSummary. System Change Number (SCN) to which backup is consistent.
- Returns
The retention_scn of this LongTermBackupSummary.
- Return type
int
- property retention_until_date_time¶
[Required] Gets the retention_until_date_time of this LongTermBackupSummary. An RFC3339 formatted datetime string that indicates the time after which the long term backup will be deleted. For example ‘2020-05-22T21:10:29.600Z’. This timestamp has to be 95 days-10 years from the current timestamp
- Returns
The retention_until_date_time of this LongTermBackupSummary.
- Return type
datetime
- property rman_tag¶
Gets the rman_tag of this LongTermBackupSummary. Recovery Manager (RMAN) assigned unique identifier for the long-term backup.
- Returns
The rman_tag of this LongTermBackupSummary.
- Return type
str
- property system_tags¶
Gets the system_tags of this LongTermBackupSummary. Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}. For more information, see Resource Tags
- Returns
The system_tags of this LongTermBackupSummary.
- Return type
dict(str, dict(str, object))
- property time_backup_completed¶
Gets the time_backup_completed of this LongTermBackupSummary. An RFC3339 formatted datetime string that indicates the time when the backup was actually completed. For example ‘2020-05-22T21:10:29.600Z’
- Returns
The time_backup_completed of this LongTermBackupSummary.
- Return type
datetime
- property time_backup_initiated¶
Gets the time_backup_initiated of this LongTermBackupSummary. An RFC3339 formatted datetime string that indicates the time when the backup was actually taken. For example ‘2020-05-22T21:10:29.600Z’
- Returns
The time_backup_initiated of this LongTermBackupSummary.
- Return type
datetime
- property time_created¶
Gets the time_created of this LongTermBackupSummary. An RFC3339 formatted datetime string that indicates the created time for the long term backup. For example: ‘2020-05-22T21:10:29.600Z’.
- Returns
The time_created of this LongTermBackupSummary.
- Return type
datetime
- property time_updated¶
Gets the time_updated of this LongTermBackupSummary. An RFC3339 formatted datetime string that indicates the updated time for the long term backup. For example: ‘2020-05-22T21:10:29.600Z’.
- Returns
The time_updated of this LongTermBackupSummary.
- Return type
datetime