Backup

class oci.psql.models.Backup(**kwargs)

Bases: object

Database system backup information.

Attributes:

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.

SOURCE_TYPE_COPIED

A constant which can be used with the source_type property of a Backup.

SOURCE_TYPE_MANUAL

A constant which can be used with the source_type property of a Backup.

SOURCE_TYPE_PITR

A constant which can be used with the source_type property of a Backup.

SOURCE_TYPE_SCHEDULED

A constant which can be used with the source_type property of a Backup.

backup_size

Gets the backup_size of this Backup.

compartment_id

[Required] Gets the compartment_id of this Backup.

copy_status

Gets the copy_status of this Backup.

db_system_details

[Required] Gets the db_system_details of this Backup.

db_system_id

Gets the db_system_id of this Backup.

defined_tags

[Required] Gets the defined_tags of this Backup.

description

Gets the description of this Backup.

display_name

[Required] Gets the display_name of this Backup.

freeform_tags

[Required] Gets the freeform_tags of this Backup.

id

[Required] Gets the id of this Backup.

kms_key_id

Gets the kms_key_id of this Backup.

last_accepted_request_token

Gets the last_accepted_request_token of this Backup.

last_completed_request_token

Gets the last_completed_request_token of this Backup.

lifecycle_details

Gets the lifecycle_details of this Backup.

lifecycle_state

[Required] Gets the lifecycle_state of this Backup.

retention_period

Gets the retention_period of this Backup.

source_backup_details

Gets the source_backup_details of this Backup.

source_type

Gets the source_type of this Backup.

system_tags

Gets the system_tags of this Backup.

time_created

[Required] Gets the time_created of this Backup.

time_created_precise

Gets the time_created_precise of this Backup.

time_updated

Gets the time_updated of this Backup.

Methods:

__init__(**kwargs)

Initializes a new Backup object with values from keyword arguments.

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”

SOURCE_TYPE_COPIED = 'COPIED'

A constant which can be used with the source_type property of a Backup. This constant has a value of “COPIED”

SOURCE_TYPE_MANUAL = 'MANUAL'

A constant which can be used with the source_type property of a Backup. This constant has a value of “MANUAL”

SOURCE_TYPE_PITR = 'PITR'

A constant which can be used with the source_type property of a Backup. This constant has a value of “PITR”

SOURCE_TYPE_SCHEDULED = 'SCHEDULED'

A constant which can be used with the source_type property of a Backup. This constant has a value of “SCHEDULED”

__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.

  • source_type (str) – The value to assign to the source_type property of this Backup. Allowed values for this property are: “SCHEDULED”, “MANUAL”, “PITR”, “COPIED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • time_created (datetime) – The value to assign to the time_created property of this Backup.

  • time_created_precise (datetime) – The value to assign to the time_created_precise 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”, “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.

  • retention_period (int) – The value to assign to the retention_period property of this Backup.

  • backup_size (int) – The value to assign to the backup_size property of this Backup.

  • db_system_id (str) – The value to assign to the db_system_id property of this Backup.

  • db_system_details (oci.psql.models.DbSystemDetails) – The value to assign to the db_system_details property of this Backup.

  • source_backup_details (oci.psql.models.SourceBackupDetails) – The value to assign to the source_backup_details property of this Backup.

  • last_accepted_request_token (str) – The value to assign to the last_accepted_request_token property of this Backup.

  • last_completed_request_token (str) – The value to assign to the last_completed_request_token property of this Backup.

  • copy_status (list[oci.psql.models.BackupCopyStatusDetails]) – The value to assign to the copy_status property of this Backup.

  • kms_key_id (str) – The value to assign to the kms_key_id 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.

  • system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this Backup.

property backup_size

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

Returns

The backup_size of this Backup.

Return type

int

property compartment_id

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

Returns

The compartment_id of this Backup.

Return type

str

property copy_status

Gets the copy_status of this Backup. List of status for Backup Copy

Returns

The copy_status of this Backup.

Return type

list[oci.psql.models.BackupCopyStatusDetails]

property db_system_details

[Required] Gets the db_system_details of this Backup.

Returns

The db_system_details of this Backup.

Return type

oci.psql.models.DbSystemDetails

property db_system_id

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

Returns

The db_system_id of this Backup.

Return type

str

property defined_tags

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

property description

Gets the description of this Backup. A description for the backup.

Returns

The description of this Backup.

Return type

str

property display_name

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

Returns

The display_name of this Backup.

Return type

str

property freeform_tags

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

property id

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

Returns

The id of this Backup.

Return type

str

property kms_key_id

Gets the kms_key_id of this Backup. The OCID of the master encryption key for the backup.

Returns

The kms_key_id of this Backup.

Return type

str

property last_accepted_request_token

Gets the last_accepted_request_token of this Backup. lastAcceptedRequestToken from MP.

Returns

The last_accepted_request_token of this Backup.

Return type

str

property last_completed_request_token

Gets the last_completed_request_token of this Backup. lastCompletedRequestToken from MP.

Returns

The last_completed_request_token of this Backup.

Return type

str

property lifecycle_details

Gets the lifecycle_details of this Backup. 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 Backup.

Return type

str

property lifecycle_state

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

Allowed values for this property are: “CREATING”, “ACTIVE”, “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

property retention_period

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

Returns

The retention_period of this Backup.

Return type

int

property source_backup_details

Gets the source_backup_details of this Backup.

Returns

The source_backup_details of this Backup.

Return type

oci.psql.models.SourceBackupDetails

property source_type

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

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

Returns

The source_type of this Backup.

Return type

str

property system_tags

Gets the system_tags of this Backup. 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 Backup.

Return type

dict(str, dict(str, object))

property time_created

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

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

Returns

The time_created of this Backup.

Return type

datetime

property time_created_precise

Gets the time_created_precise of this Backup. The date and time the backup was created. This is the time the actual point-in-time data snapshot was taken, expressed in RFC 3339 timestamp format.

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

Returns

The time_created_precise of this Backup.

Return type

datetime

property time_updated

Gets the time_updated of this Backup. 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 Backup.

Return type

datetime