BackupSummary

class oci.database.models.BackupSummary(**kwargs)

Bases: object

A database backup. 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.

Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Attributes

DATABASE_EDITION_ENTERPRISE_EDITION A constant which can be used with the database_edition property of a BackupSummary.
DATABASE_EDITION_ENTERPRISE_EDITION_EXTREME_PERFORMANCE A constant which can be used with the database_edition property of a BackupSummary.
DATABASE_EDITION_ENTERPRISE_EDITION_HIGH_PERFORMANCE A constant which can be used with the database_edition property of a BackupSummary.
DATABASE_EDITION_STANDARD_EDITION A constant which can be used with the database_edition property of a BackupSummary.
LIFECYCLE_STATE_ACTIVE A constant which can be used with the lifecycle_state property of a BackupSummary.
LIFECYCLE_STATE_CREATING A constant which can be used with the lifecycle_state property of a BackupSummary.
LIFECYCLE_STATE_DELETED A constant which can be used with the lifecycle_state property of a BackupSummary.
LIFECYCLE_STATE_DELETING A constant which can be used with the lifecycle_state property of a BackupSummary.
LIFECYCLE_STATE_FAILED A constant which can be used with the lifecycle_state property of a BackupSummary.
LIFECYCLE_STATE_RESTORING A constant which can be used with the lifecycle_state property of a BackupSummary.
TYPE_FULL A constant which can be used with the type property of a BackupSummary.
TYPE_INCREMENTAL A constant which can be used with the type property of a BackupSummary.
TYPE_VIRTUAL_FULL A constant which can be used with the type property of a BackupSummary.
availability_domain Gets the availability_domain of this BackupSummary.
compartment_id Gets the compartment_id of this BackupSummary.
database_edition Gets the database_edition of this BackupSummary.
database_id Gets the database_id of this BackupSummary.
database_size_in_gbs Gets the database_size_in_gbs of this BackupSummary.
display_name Gets the display_name of this BackupSummary.
id Gets the id of this BackupSummary.
lifecycle_details Gets the lifecycle_details of this BackupSummary.
lifecycle_state Gets the lifecycle_state of this BackupSummary.
time_ended Gets the time_ended of this BackupSummary.
time_started Gets the time_started of this BackupSummary.
type Gets the type of this BackupSummary.

Methods

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

A constant which can be used with the database_edition property of a BackupSummary. This constant has a value of “ENTERPRISE_EDITION”

DATABASE_EDITION_ENTERPRISE_EDITION_EXTREME_PERFORMANCE = 'ENTERPRISE_EDITION_EXTREME_PERFORMANCE'

A constant which can be used with the database_edition property of a BackupSummary. This constant has a value of “ENTERPRISE_EDITION_EXTREME_PERFORMANCE”

DATABASE_EDITION_ENTERPRISE_EDITION_HIGH_PERFORMANCE = 'ENTERPRISE_EDITION_HIGH_PERFORMANCE'

A constant which can be used with the database_edition property of a BackupSummary. This constant has a value of “ENTERPRISE_EDITION_HIGH_PERFORMANCE”

DATABASE_EDITION_STANDARD_EDITION = 'STANDARD_EDITION'

A constant which can be used with the database_edition property of a BackupSummary. This constant has a value of “STANDARD_EDITION”

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the lifecycle_state property of a BackupSummary. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'

A constant which can be used with the lifecycle_state property of a BackupSummary. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'

A constant which can be used with the lifecycle_state property of a BackupSummary. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'

A constant which can be used with the lifecycle_state property of a BackupSummary. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'

A constant which can be used with the lifecycle_state property of a BackupSummary. This constant has a value of “FAILED”

LIFECYCLE_STATE_RESTORING = 'RESTORING'

A constant which can be used with the lifecycle_state property of a BackupSummary. This constant has a value of “RESTORING”

TYPE_FULL = 'FULL'

A constant which can be used with the type property of a BackupSummary. This constant has a value of “FULL”

TYPE_INCREMENTAL = 'INCREMENTAL'

A constant which can be used with the type property of a BackupSummary. This constant has a value of “INCREMENTAL”

TYPE_VIRTUAL_FULL = 'VIRTUAL_FULL'

A constant which can be used with the type property of a BackupSummary. This constant has a value of “VIRTUAL_FULL”

__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.
  • compartment_id (str) – The value to assign to the compartment_id property of this BackupSummary.
  • database_id (str) – The value to assign to the database_id property of this BackupSummary.
  • display_name (str) – The value to assign to the display_name property of this BackupSummary.
  • type (str) – The value to assign to the type property of this BackupSummary. Allowed values for this property are: “INCREMENTAL”, “FULL”, “VIRTUAL_FULL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
  • time_started (datetime) – The value to assign to the time_started property of this BackupSummary.
  • time_ended (datetime) – The value to assign to the time_ended property of this BackupSummary.
  • lifecycle_details (str) – The value to assign to the lifecycle_details property of this BackupSummary.
  • availability_domain (str) – The value to assign to the availability_domain property of this BackupSummary.
  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this BackupSummary. Allowed values for this property are: “CREATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, “RESTORING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
  • database_edition (str) – The value to assign to the database_edition property of this BackupSummary. Allowed values for this property are: “STANDARD_EDITION”, “ENTERPRISE_EDITION”, “ENTERPRISE_EDITION_HIGH_PERFORMANCE”, “ENTERPRISE_EDITION_EXTREME_PERFORMANCE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
  • database_size_in_gbs (float) – The value to assign to the database_size_in_gbs property of this BackupSummary.
availability_domain

Gets the availability_domain of this BackupSummary. The name of the availability domain where the database backup is stored.

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

Gets the compartment_id of this BackupSummary. The OCID of the compartment.

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

Gets the database_edition of this BackupSummary. The Oracle Database edition of the DB system from which the database backup was taken.

Allowed values for this property are: “STANDARD_EDITION”, “ENTERPRISE_EDITION”, “ENTERPRISE_EDITION_HIGH_PERFORMANCE”, “ENTERPRISE_EDITION_EXTREME_PERFORMANCE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:The database_edition of this BackupSummary.
Return type:str
database_id

Gets the database_id of this BackupSummary. The OCID of the database.

Returns:The database_id of this BackupSummary.
Return type:str
database_size_in_gbs

Gets the database_size_in_gbs of this BackupSummary. The size of the database in gigabytes at the time the backup was taken.

Returns:The database_size_in_gbs of this BackupSummary.
Return type:float
display_name

Gets the display_name of this BackupSummary. The user-friendly name for the backup. The name does not have to be unique.

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

Gets the id of this BackupSummary. The OCID of the backup.

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

Gets the lifecycle_details of this BackupSummary. Additional information about the current lifecycleState.

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

Gets the lifecycle_state of this BackupSummary. The current state of the backup.

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

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

Gets the time_ended of this BackupSummary. The date and time the backup was completed.

Returns:The time_ended of this BackupSummary.
Return type:datetime
time_started

Gets the time_started of this BackupSummary. The date and time the backup started.

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

Gets the type of this BackupSummary. The type of backup.

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

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