LongTermBackup¶

class oci.recovery.models.LongTermBackup(**kwargs)¶

Bases: object

The details of a Long Term Backup.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a LongTermBackup.
`LIFECYCLE_STATE_CANCELED`	A constant which can be used with the lifecycle_state property of a LongTermBackup.
`LIFECYCLE_STATE_CANCELING`	A constant which can be used with the lifecycle_state property of a LongTermBackup.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a LongTermBackup.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a LongTermBackup.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a LongTermBackup.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a LongTermBackup.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a LongTermBackup.
`LIFECYCLE_SUBSTATE_ARCHIVAL_IN_PROGRESS`	A constant which can be used with the lifecycle_substate property of a LongTermBackup.
`LIFECYCLE_SUBSTATE_SCHEDULED_FOR_ARCHIVAL`	A constant which can be used with the lifecycle_substate property of a LongTermBackup.
`LIFECYCLE_SUBSTATE_WAITING_FOR_BACKUP_FROM_DB`	A constant which can be used with the lifecycle_substate property of a LongTermBackup.
`compartment_id`	[Required] Gets the compartment_id of this LongTermBackup.
`database_identifier`	Gets the database_identifier of this LongTermBackup.
`database_size_in_gbs`	Gets the database_size_in_gbs of this LongTermBackup.
`defined_tags`	Gets the defined_tags of this LongTermBackup.
`display_name`	Gets the display_name of this LongTermBackup.
`freeform_tags`	Gets the freeform_tags of this LongTermBackup.
`id`	[Required] Gets the id of this LongTermBackup.
`lifecycle_details`	Gets the lifecycle_details of this LongTermBackup.
`lifecycle_state`	[Required] Gets the lifecycle_state of this LongTermBackup.
`lifecycle_substate`	Gets the lifecycle_substate of this LongTermBackup.
`protected_database_id`	[Required] Gets the protected_database_id of this LongTermBackup.
`retention_period`	[Required] Gets the retention_period of this LongTermBackup.
`retention_point_in_time`	Gets the retention_point_in_time of this LongTermBackup.
`retention_scn`	Gets the retention_scn of this LongTermBackup.
`retention_until_date_time`	[Required] Gets the retention_until_date_time of this LongTermBackup.
`rman_tag`	Gets the rman_tag of this LongTermBackup.
`system_tags`	Gets the system_tags of this LongTermBackup.
`time_backup_completed`	Gets the time_backup_completed of this LongTermBackup.
`time_backup_initiated`	Gets the time_backup_initiated of this LongTermBackup.
`time_created`	Gets the time_created of this LongTermBackup.
`time_updated`	Gets the time_updated of this LongTermBackup.

Methods

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

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a LongTermBackup. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CANCELED = 'CANCELED'¶: A constant which can be used with the lifecycle_state property of a LongTermBackup. This constant has a value of “CANCELED”

LIFECYCLE_STATE_CANCELING = 'CANCELING'¶: A constant which can be used with the lifecycle_state property of a LongTermBackup. This constant has a value of “CANCELING”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a LongTermBackup. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a LongTermBackup. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a LongTermBackup. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a LongTermBackup. This constant has a value of “FAILED”

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

LIFECYCLE_SUBSTATE_ARCHIVAL_IN_PROGRESS = 'ARCHIVAL_IN_PROGRESS'¶: A constant which can be used with the lifecycle_substate property of a LongTermBackup. This constant has a value of “ARCHIVAL_IN_PROGRESS”

LIFECYCLE_SUBSTATE_SCHEDULED_FOR_ARCHIVAL = 'SCHEDULED_FOR_ARCHIVAL'¶: A constant which can be used with the lifecycle_substate property of a LongTermBackup. This constant has a value of “SCHEDULED_FOR_ARCHIVAL”

LIFECYCLE_SUBSTATE_WAITING_FOR_BACKUP_FROM_DB = 'WAITING_FOR_BACKUP_FROM_DB'¶: A constant which can be used with the lifecycle_substate property of a LongTermBackup. This constant has a value of “WAITING_FOR_BACKUP_FROM_DB”

__init__(**kwargs)¶

Initializes a new LongTermBackup 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 LongTermBackup.
display_name (str) – The value to assign to the display_name property of this LongTermBackup.
compartment_id (str) – The value to assign to the compartment_id property of this LongTermBackup.
protected_database_id (str) – The value to assign to the protected_database_id property of this LongTermBackup.
retention_scn (int) – The value to assign to the retention_scn property of this LongTermBackup.
retention_point_in_time (datetime) – The value to assign to the retention_point_in_time property of this LongTermBackup.
time_backup_initiated (datetime) – The value to assign to the time_backup_initiated property of this LongTermBackup.
time_backup_completed (datetime) – The value to assign to the time_backup_completed property of this LongTermBackup.
retention_period (list[oci.recovery.models.RetentionPeriodValue]) – The value to assign to the retention_period property of this LongTermBackup.
retention_until_date_time (datetime) – The value to assign to the retention_until_date_time property of this LongTermBackup.
database_identifier (str) – The value to assign to the database_identifier property of this LongTermBackup.
database_size_in_gbs (int) – The value to assign to the database_size_in_gbs property of this LongTermBackup.
time_created (datetime) – The value to assign to the time_created property of this LongTermBackup.
time_updated (datetime) – The value to assign to the time_updated property of this LongTermBackup.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this LongTermBackup. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, “CANCELING”, “CANCELED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_substate (str) – The value to assign to the lifecycle_substate property of this LongTermBackup. Allowed values for this property are: “WAITING_FOR_BACKUP_FROM_DB”, “SCHEDULED_FOR_ARCHIVAL”, “ARCHIVAL_IN_PROGRESS”, ‘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 LongTermBackup.
rman_tag (str) – The value to assign to the rman_tag property of this LongTermBackup.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this LongTermBackup.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this LongTermBackup.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this LongTermBackup.

compartment_id¶

[Required] Gets the compartment_id of this LongTermBackup. The OCID of the compartment containing the long-term backup.

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

database_identifier¶

Gets the database_identifier of this LongTermBackup. The Oracle Database ID, which identifies an Oracle Database located outside of Oracle Cloud.

Returns:	The database_identifier of this LongTermBackup.
Return type:	str

database_size_in_gbs¶

Gets the database_size_in_gbs of this LongTermBackup. The size of the database, in gigabytes.

Returns:	The database_size_in_gbs of this LongTermBackup.
Return type:	int

defined_tags¶

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

display_name¶

Gets the display_name of this LongTermBackup. The user-provided name for the long-term backup. You can change the displayName. Avoid entering confidential information.

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

freeform_tags¶

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

id¶

[Required] Gets the id of this LongTermBackup. The OCID of the long-term backup.

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

lifecycle_details¶

Gets the lifecycle_details of this LongTermBackup. A detailed message 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 LongTermBackup.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this LongTermBackup. The current state of the long term backup.

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

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

lifecycle_substate¶

Gets the lifecycle_substate of this LongTermBackup. More details on the state of the backup when it is in Creating lifecycleState.

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

Returns:	The lifecycle_substate of this LongTermBackup.
Return type:	str

protected_database_id¶

[Required] Gets the protected_database_id of this LongTermBackup. The OCID of the protected database associated with the long-term backup.

Returns:	The protected_database_id of this LongTermBackup.
Return type:	str

retention_period¶

[Required] Gets the retention_period of this LongTermBackup. The maximum number of DAYS or YEARS to store the long-term backup. You can retain a long-term backup for a period ranging from 90-3650 days or 1-10 years.

Returns:	The retention_period of this LongTermBackup.
Return type:	list[oci.recovery.models.RetentionPeriodValue]

retention_point_in_time¶

Gets the retention_point_in_time of this LongTermBackup. An RFC3339 formatted datetime string that indicates the target point in time until which the long-term backup is consistent. For example, ‘2020-05-22T21:10:29.600Z’.

Returns:	The retention_point_in_time of this LongTermBackup.
Return type:	datetime

retention_scn¶

Gets the retention_scn of this LongTermBackup. The unique system change number (SCN) or the target point in the database until which the long-term backup is consistent.

Returns:	The retention_scn of this LongTermBackup.
Return type:	int

retention_until_date_time¶

[Required] Gets the retention_until_date_time of this LongTermBackup. Indicates that Recovery Service must retain the backup for the specified long-term retention period.

Returns:	The retention_until_date_time of this LongTermBackup.
Return type:	datetime

rman_tag¶

Gets the rman_tag of this LongTermBackup. Recovery Manager (RMAN) assigned unique identifier for the long-term backup.

Returns:	The rman_tag of this LongTermBackup.
Return type:	str

system_tags¶

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

time_backup_completed¶

Gets the time_backup_completed of this LongTermBackup. An RFC3339 formatted datetime string that indicates the time when the long-term backup completed. For example, ‘2020-05-22T21:10:29.600Z’.

Returns:	The time_backup_completed of this LongTermBackup.
Return type:	datetime

time_backup_initiated¶

Gets the time_backup_initiated of this LongTermBackup. An RFC3339 formatted datetime string that indicates the time when the long-term backup was created. For example, ‘2020-05-22T21:10:29.600Z’.

Returns:	The time_backup_initiated of this LongTermBackup.
Return type:	datetime

time_created¶

Gets the time_created of this LongTermBackup. An RFC3339 formatted datetime string that indicates the time when the long-term backup was created. For example: ‘2020-05-22T21:10:29.600Z’.

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

time_updated¶

Gets the time_updated of this LongTermBackup. An RFC3339 formatted datetime string that indicates the time when the long term backup was last updated. For example: ‘2020-05-22T21:10:29.600Z’.

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