DatabaseBackupMetrics¶

class oci.database_management.models.DatabaseBackupMetrics(**kwargs)¶

Bases: object

The details of the backup metrics for a single database.

Attributes

`DATABASE_SUB_TYPE_ACD`	A constant which can be used with the database_sub_type property of a DatabaseBackupMetrics.
`DATABASE_SUB_TYPE_ADB`	A constant which can be used with the database_sub_type property of a DatabaseBackupMetrics.
`DATABASE_SUB_TYPE_CDB`	A constant which can be used with the database_sub_type property of a DatabaseBackupMetrics.
`DATABASE_SUB_TYPE_NON_CDB`	A constant which can be used with the database_sub_type property of a DatabaseBackupMetrics.
`DATABASE_SUB_TYPE_PDB`	A constant which can be used with the database_sub_type property of a DatabaseBackupMetrics.
`DATABASE_TYPE_CLOUD_AT_CUSTOMER`	A constant which can be used with the database_type property of a DatabaseBackupMetrics.
`DATABASE_TYPE_CLOUD_RAC`	A constant which can be used with the database_type property of a DatabaseBackupMetrics.
`DATABASE_TYPE_CLOUD_SIDB`	A constant which can be used with the database_type property of a DatabaseBackupMetrics.
`DATABASE_TYPE_DEDICATED`	A constant which can be used with the database_type property of a DatabaseBackupMetrics.
`DATABASE_TYPE_EXTERNAL_RAC`	A constant which can be used with the database_type property of a DatabaseBackupMetrics.
`DATABASE_TYPE_EXTERNAL_SIDB`	A constant which can be used with the database_type property of a DatabaseBackupMetrics.
`DATABASE_TYPE_SHARED`	A constant which can be used with the database_type property of a DatabaseBackupMetrics.
`DB_ROLE_FAR_SYNC`	A constant which can be used with the db_role property of a DatabaseBackupMetrics.
`DB_ROLE_LOGICAL_STANDBY`	A constant which can be used with the db_role property of a DatabaseBackupMetrics.
`DB_ROLE_PHYSICAL_STANDBY`	A constant which can be used with the db_role property of a DatabaseBackupMetrics.
`DB_ROLE_PRIMARY`	A constant which can be used with the db_role property of a DatabaseBackupMetrics.
`DB_ROLE_SNAPSHOT_STANDBY`	A constant which can be used with the db_role property of a DatabaseBackupMetrics.
`DEPLOYMENT_TYPE_AUTONOMOUS`	A constant which can be used with the deployment_type property of a DatabaseBackupMetrics.
`DEPLOYMENT_TYPE_BM`	A constant which can be used with the deployment_type property of a DatabaseBackupMetrics.
`DEPLOYMENT_TYPE_EXADATA`	A constant which can be used with the deployment_type property of a DatabaseBackupMetrics.
`DEPLOYMENT_TYPE_EXADATA_CC`	A constant which can be used with the deployment_type property of a DatabaseBackupMetrics.
`DEPLOYMENT_TYPE_EXADATA_XS`	A constant which can be used with the deployment_type property of a DatabaseBackupMetrics.
`DEPLOYMENT_TYPE_ONPREMISE`	A constant which can be used with the deployment_type property of a DatabaseBackupMetrics.
`DEPLOYMENT_TYPE_VM`	A constant which can be used with the deployment_type property of a DatabaseBackupMetrics.
`WORKLOAD_TYPE_AJD`	A constant which can be used with the workload_type property of a DatabaseBackupMetrics.
`WORKLOAD_TYPE_APEX`	A constant which can be used with the workload_type property of a DatabaseBackupMetrics.
`WORKLOAD_TYPE_DW`	A constant which can be used with the workload_type property of a DatabaseBackupMetrics.
`WORKLOAD_TYPE_OLTP`	A constant which can be used with the workload_type property of a DatabaseBackupMetrics.
`compartment_id`	[Required] Gets the compartment_id of this DatabaseBackupMetrics.
`database_id`	Gets the database_id of this DatabaseBackupMetrics.
`database_name`	[Required] Gets the database_name of this DatabaseBackupMetrics.
`database_sub_type`	[Required] Gets the database_sub_type of this DatabaseBackupMetrics.
`database_type`	[Required] Gets the database_type of this DatabaseBackupMetrics.
`database_version`	Gets the database_version of this DatabaseBackupMetrics.
`db_id`	[Required] Gets the db_id of this DatabaseBackupMetrics.
`db_role`	[Required] Gets the db_role of this DatabaseBackupMetrics.
`db_unique_name`	Gets the db_unique_name of this DatabaseBackupMetrics.
`deployment_type`	[Required] Gets the deployment_type of this DatabaseBackupMetrics.
`is_automatic_backup_enabled`	[Required] Gets the is_automatic_backup_enabled of this DatabaseBackupMetrics.
`is_dataguard_enabled`	[Required] Gets the is_dataguard_enabled of this DatabaseBackupMetrics.
`last_backup_summary`	[Required] Gets the last_backup_summary of this DatabaseBackupMetrics.
`metrics`	[Required] Gets the metrics of this DatabaseBackupMetrics.
`retention_period_in_days`	[Required] Gets the retention_period_in_days of this DatabaseBackupMetrics.
`time_series_metrics`	[Required] Gets the time_series_metrics of this DatabaseBackupMetrics.
`workload_type`	Gets the workload_type of this DatabaseBackupMetrics.

Methods

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

DATABASE_SUB_TYPE_ACD = 'ACD'¶: A constant which can be used with the database_sub_type property of a DatabaseBackupMetrics. This constant has a value of “ACD”

DATABASE_SUB_TYPE_ADB = 'ADB'¶: A constant which can be used with the database_sub_type property of a DatabaseBackupMetrics. This constant has a value of “ADB”

DATABASE_SUB_TYPE_CDB = 'CDB'¶: A constant which can be used with the database_sub_type property of a DatabaseBackupMetrics. This constant has a value of “CDB”

DATABASE_SUB_TYPE_NON_CDB = 'NON_CDB'¶: A constant which can be used with the database_sub_type property of a DatabaseBackupMetrics. This constant has a value of “NON_CDB”

DATABASE_SUB_TYPE_PDB = 'PDB'¶: A constant which can be used with the database_sub_type property of a DatabaseBackupMetrics. This constant has a value of “PDB”

DATABASE_TYPE_CLOUD_AT_CUSTOMER = 'CLOUD_AT_CUSTOMER'¶: A constant which can be used with the database_type property of a DatabaseBackupMetrics. This constant has a value of “CLOUD_AT_CUSTOMER”

DATABASE_TYPE_CLOUD_RAC = 'CLOUD_RAC'¶: A constant which can be used with the database_type property of a DatabaseBackupMetrics. This constant has a value of “CLOUD_RAC”

DATABASE_TYPE_CLOUD_SIDB = 'CLOUD_SIDB'¶: A constant which can be used with the database_type property of a DatabaseBackupMetrics. This constant has a value of “CLOUD_SIDB”

DATABASE_TYPE_DEDICATED = 'DEDICATED'¶: A constant which can be used with the database_type property of a DatabaseBackupMetrics. This constant has a value of “DEDICATED”

DATABASE_TYPE_EXTERNAL_RAC = 'EXTERNAL_RAC'¶: A constant which can be used with the database_type property of a DatabaseBackupMetrics. This constant has a value of “EXTERNAL_RAC”

DATABASE_TYPE_EXTERNAL_SIDB = 'EXTERNAL_SIDB'¶: A constant which can be used with the database_type property of a DatabaseBackupMetrics. This constant has a value of “EXTERNAL_SIDB”

DATABASE_TYPE_SHARED = 'SHARED'¶: A constant which can be used with the database_type property of a DatabaseBackupMetrics. This constant has a value of “SHARED”

DB_ROLE_FAR_SYNC = 'FAR_SYNC'¶: A constant which can be used with the db_role property of a DatabaseBackupMetrics. This constant has a value of “FAR_SYNC”

DB_ROLE_LOGICAL_STANDBY = 'LOGICAL_STANDBY'¶: A constant which can be used with the db_role property of a DatabaseBackupMetrics. This constant has a value of “LOGICAL_STANDBY”

DB_ROLE_PHYSICAL_STANDBY = 'PHYSICAL_STANDBY'¶: A constant which can be used with the db_role property of a DatabaseBackupMetrics. This constant has a value of “PHYSICAL_STANDBY”

DB_ROLE_PRIMARY = 'PRIMARY'¶: A constant which can be used with the db_role property of a DatabaseBackupMetrics. This constant has a value of “PRIMARY”

DB_ROLE_SNAPSHOT_STANDBY = 'SNAPSHOT_STANDBY'¶: A constant which can be used with the db_role property of a DatabaseBackupMetrics. This constant has a value of “SNAPSHOT_STANDBY”

DEPLOYMENT_TYPE_AUTONOMOUS = 'AUTONOMOUS'¶: A constant which can be used with the deployment_type property of a DatabaseBackupMetrics. This constant has a value of “AUTONOMOUS”

DEPLOYMENT_TYPE_BM = 'BM'¶: A constant which can be used with the deployment_type property of a DatabaseBackupMetrics. This constant has a value of “BM”

DEPLOYMENT_TYPE_EXADATA = 'EXADATA'¶: A constant which can be used with the deployment_type property of a DatabaseBackupMetrics. This constant has a value of “EXADATA”

DEPLOYMENT_TYPE_EXADATA_CC = 'EXADATA_CC'¶: A constant which can be used with the deployment_type property of a DatabaseBackupMetrics. This constant has a value of “EXADATA_CC”

DEPLOYMENT_TYPE_EXADATA_XS = 'EXADATA_XS'¶: A constant which can be used with the deployment_type property of a DatabaseBackupMetrics. This constant has a value of “EXADATA_XS”

DEPLOYMENT_TYPE_ONPREMISE = 'ONPREMISE'¶: A constant which can be used with the deployment_type property of a DatabaseBackupMetrics. This constant has a value of “ONPREMISE”

DEPLOYMENT_TYPE_VM = 'VM'¶: A constant which can be used with the deployment_type property of a DatabaseBackupMetrics. This constant has a value of “VM”

WORKLOAD_TYPE_AJD = 'AJD'¶: A constant which can be used with the workload_type property of a DatabaseBackupMetrics. This constant has a value of “AJD”

WORKLOAD_TYPE_APEX = 'APEX'¶: A constant which can be used with the workload_type property of a DatabaseBackupMetrics. This constant has a value of “APEX”

WORKLOAD_TYPE_DW = 'DW'¶: A constant which can be used with the workload_type property of a DatabaseBackupMetrics. This constant has a value of “DW”

WORKLOAD_TYPE_OLTP = 'OLTP'¶: A constant which can be used with the workload_type property of a DatabaseBackupMetrics. This constant has a value of “OLTP”

__init__(**kwargs)¶

Initializes a new DatabaseBackupMetrics object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

retention_period_in_days (str) – The value to assign to the retention_period_in_days property of this DatabaseBackupMetrics.
is_automatic_backup_enabled (bool) – The value to assign to the is_automatic_backup_enabled property of this DatabaseBackupMetrics.
time_series_metrics (list[oci.database_management.models.MetricsAggregationRange]) – The value to assign to the time_series_metrics property of this DatabaseBackupMetrics.
is_dataguard_enabled (bool) – The value to assign to the is_dataguard_enabled property of this DatabaseBackupMetrics.
last_backup_summary (oci.database_management.models.DatabaseBackupSummary) – The value to assign to the last_backup_summary property of this DatabaseBackupMetrics.
metrics (list[oci.database_management.models.HaMetricDefinition]) – The value to assign to the metrics property of this DatabaseBackupMetrics.
db_id (str) – The value to assign to the db_id property of this DatabaseBackupMetrics.
compartment_id (str) – The value to assign to the compartment_id property of this DatabaseBackupMetrics.
database_type (str) – The value to assign to the database_type property of this DatabaseBackupMetrics. Allowed values for this property are: “EXTERNAL_SIDB”, “EXTERNAL_RAC”, “CLOUD_SIDB”, “CLOUD_RAC”, “SHARED”, “DEDICATED”, “CLOUD_AT_CUSTOMER”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
database_sub_type (str) – The value to assign to the database_sub_type property of this DatabaseBackupMetrics. Allowed values for this property are: “CDB”, “PDB”, “NON_CDB”, “ACD”, “ADB”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
deployment_type (str) – The value to assign to the deployment_type property of this DatabaseBackupMetrics. Allowed values for this property are: “ONPREMISE”, “BM”, “VM”, “EXADATA”, “EXADATA_CC”, “AUTONOMOUS”, “EXADATA_XS”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
database_version (str) – The value to assign to the database_version property of this DatabaseBackupMetrics.
workload_type (str) – The value to assign to the workload_type property of this DatabaseBackupMetrics. Allowed values for this property are: “OLTP”, “DW”, “AJD”, “APEX”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
database_name (str) – The value to assign to the database_name property of this DatabaseBackupMetrics.
database_id (str) – The value to assign to the database_id property of this DatabaseBackupMetrics.
db_unique_name (str) – The value to assign to the db_unique_name property of this DatabaseBackupMetrics.
db_role (str) – The value to assign to the db_role property of this DatabaseBackupMetrics. Allowed values for this property are: “SNAPSHOT_STANDBY”, “LOGICAL_STANDBY”, “PHYSICAL_STANDBY”, “PRIMARY”, “FAR_SYNC”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

compartment_id¶

[Required] Gets the compartment_id of this DatabaseBackupMetrics. The OCID of the compartment where the Managed Database resides.

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

database_id¶

Gets the database_id of this DatabaseBackupMetrics. The database ID of the Managed Database. Every database had its own ID and that value is captured here.

Returns:	The database_id of this DatabaseBackupMetrics.
Return type:	str

database_name¶

[Required] Gets the database_name of this DatabaseBackupMetrics. The display name of the Managed Database.

Returns:	The database_name of this DatabaseBackupMetrics.
Return type:	str

database_sub_type¶

[Required] Gets the database_sub_type of this DatabaseBackupMetrics. The subtype of the Oracle Database. Indicates whether the database is a Container Database, Pluggable Database, Non-container Database, Autonomous Database, or Autonomous Container Database.

Allowed values for this property are: “CDB”, “PDB”, “NON_CDB”, “ACD”, “ADB”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The database_sub_type of this DatabaseBackupMetrics.
Return type:	str

database_type¶

[Required] Gets the database_type of this DatabaseBackupMetrics. The type of Oracle Database installation.

Allowed values for this property are: “EXTERNAL_SIDB”, “EXTERNAL_RAC”, “CLOUD_SIDB”, “CLOUD_RAC”, “SHARED”, “DEDICATED”, “CLOUD_AT_CUSTOMER”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The database_type of this DatabaseBackupMetrics.
Return type:	str

database_version¶

Gets the database_version of this DatabaseBackupMetrics. The Oracle Database version.

Returns:	The database_version of this DatabaseBackupMetrics.
Return type:	str

db_id¶

[Required] Gets the db_id of this DatabaseBackupMetrics. The OCID of the Managed Database.

Returns:	The db_id of this DatabaseBackupMetrics.
Return type:	str

db_role¶

[Required] Gets the db_role of this DatabaseBackupMetrics. The database role of the Managed Database.

Allowed values for this property are: “SNAPSHOT_STANDBY”, “LOGICAL_STANDBY”, “PHYSICAL_STANDBY”, “PRIMARY”, “FAR_SYNC”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The db_role of this DatabaseBackupMetrics.
Return type:	str

db_unique_name¶

Gets the db_unique_name of this DatabaseBackupMetrics. The database unique name of the Managed Database.

Returns:	The db_unique_name of this DatabaseBackupMetrics.
Return type:	str

deployment_type¶

[Required] Gets the deployment_type of this DatabaseBackupMetrics. The infrastructure used to deploy the Oracle Database.

Allowed values for this property are: “ONPREMISE”, “BM”, “VM”, “EXADATA”, “EXADATA_CC”, “AUTONOMOUS”, “EXADATA_XS”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The deployment_type of this DatabaseBackupMetrics.
Return type:	str

is_automatic_backup_enabled¶

[Required] Gets the is_automatic_backup_enabled of this DatabaseBackupMetrics. Indicates whether automatic backup is enabled or not. This is only applicable for cloud databases.

Returns:	The is_automatic_backup_enabled of this DatabaseBackupMetrics.
Return type:	bool

is_dataguard_enabled¶

[Required] Gets the is_dataguard_enabled of this DatabaseBackupMetrics. Indicates whether Data Guard is enabled for the database.

Returns:	The is_dataguard_enabled of this DatabaseBackupMetrics.
Return type:	bool

last_backup_summary¶

[Required] Gets the last_backup_summary of this DatabaseBackupMetrics.

Returns:	The last_backup_summary of this DatabaseBackupMetrics.
Return type:	oci.database_management.models.DatabaseBackupSummary

metrics¶

[Required] Gets the metrics of this DatabaseBackupMetrics. A list of database health metrics such as BackupDuration and BackupSize.

Returns:	The metrics of this DatabaseBackupMetrics.
Return type:	list[oci.database_management.models.HaMetricDefinition]

retention_period_in_days¶

[Required] Gets the retention_period_in_days of this DatabaseBackupMetrics. The retention period of the database.

Returns:	The retention_period_in_days of this DatabaseBackupMetrics.
Return type:	str

time_series_metrics¶

[Required] Gets the time_series_metrics of this DatabaseBackupMetrics. The array of metric values for different timestamps.

Returns:	The time_series_metrics of this DatabaseBackupMetrics.
Return type:	list[oci.database_management.models.MetricsAggregationRange]

workload_type¶

Gets the workload_type of this DatabaseBackupMetrics. The workload type of the Autonomous Database.

Allowed values for this property are: “OLTP”, “DW”, “AJD”, “APEX”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The workload_type of this DatabaseBackupMetrics.
Return type:	str