DatabaseUsageMetrics

class oci.database_management.models.DatabaseUsageMetrics(**kwargs)

Bases: object

The list of aggregated metrics for Managed Databases in the fleet.

Attributes:

DATABASE_SUB_TYPE_ACD	A constant which can be used with the database_sub_type property of a DatabaseUsageMetrics.
DATABASE_SUB_TYPE_ADB	A constant which can be used with the database_sub_type property of a DatabaseUsageMetrics.
DATABASE_SUB_TYPE_CDB	A constant which can be used with the database_sub_type property of a DatabaseUsageMetrics.
DATABASE_SUB_TYPE_NON_CDB	A constant which can be used with the database_sub_type property of a DatabaseUsageMetrics.
DATABASE_SUB_TYPE_PDB	A constant which can be used with the database_sub_type property of a DatabaseUsageMetrics.
DATABASE_TYPE_CLOUD_AT_CUSTOMER	A constant which can be used with the database_type property of a DatabaseUsageMetrics.
DATABASE_TYPE_CLOUD_RAC	A constant which can be used with the database_type property of a DatabaseUsageMetrics.
DATABASE_TYPE_CLOUD_SIDB	A constant which can be used with the database_type property of a DatabaseUsageMetrics.
DATABASE_TYPE_DEDICATED	A constant which can be used with the database_type property of a DatabaseUsageMetrics.
DATABASE_TYPE_EXTERNAL_RAC	A constant which can be used with the database_type property of a DatabaseUsageMetrics.
DATABASE_TYPE_EXTERNAL_SIDB	A constant which can be used with the database_type property of a DatabaseUsageMetrics.
DATABASE_TYPE_SHARED	A constant which can be used with the database_type property of a DatabaseUsageMetrics.
DB_ROLE_FAR_SYNC	A constant which can be used with the db_role property of a DatabaseUsageMetrics.
DB_ROLE_LOGICAL_STANDBY	A constant which can be used with the db_role property of a DatabaseUsageMetrics.
DB_ROLE_PHYSICAL_STANDBY	A constant which can be used with the db_role property of a DatabaseUsageMetrics.
DB_ROLE_PRIMARY	A constant which can be used with the db_role property of a DatabaseUsageMetrics.
DB_ROLE_SNAPSHOT_STANDBY	A constant which can be used with the db_role property of a DatabaseUsageMetrics.
DEPLOYMENT_TYPE_AUTONOMOUS	A constant which can be used with the deployment_type property of a DatabaseUsageMetrics.
DEPLOYMENT_TYPE_BM	A constant which can be used with the deployment_type property of a DatabaseUsageMetrics.
DEPLOYMENT_TYPE_EXADATA	A constant which can be used with the deployment_type property of a DatabaseUsageMetrics.
DEPLOYMENT_TYPE_EXADATA_CC	A constant which can be used with the deployment_type property of a DatabaseUsageMetrics.
DEPLOYMENT_TYPE_EXADATA_XS	A constant which can be used with the deployment_type property of a DatabaseUsageMetrics.
DEPLOYMENT_TYPE_ONPREMISE	A constant which can be used with the deployment_type property of a DatabaseUsageMetrics.
DEPLOYMENT_TYPE_VM	A constant which can be used with the deployment_type property of a DatabaseUsageMetrics.
WORKLOAD_TYPE_AJD	A constant which can be used with the workload_type property of a DatabaseUsageMetrics.
WORKLOAD_TYPE_APEX	A constant which can be used with the workload_type property of a DatabaseUsageMetrics.
WORKLOAD_TYPE_DW	A constant which can be used with the workload_type property of a DatabaseUsageMetrics.
WORKLOAD_TYPE_OLTP	A constant which can be used with the workload_type property of a DatabaseUsageMetrics.
compartment_id	Gets the compartment_id of this DatabaseUsageMetrics.
database_container_id	Gets the database_container_id of this DatabaseUsageMetrics.
database_id	Gets the database_id of this DatabaseUsageMetrics.
database_name	Gets the database_name of this DatabaseUsageMetrics.
database_sub_type	Gets the database_sub_type of this DatabaseUsageMetrics.
database_type	Gets the database_type of this DatabaseUsageMetrics.
database_version	Gets the database_version of this DatabaseUsageMetrics.
db_id	Gets the db_id of this DatabaseUsageMetrics.
db_role	Gets the db_role of this DatabaseUsageMetrics.
db_unique_name	Gets the db_unique_name of this DatabaseUsageMetrics.
deployment_type	Gets the deployment_type of this DatabaseUsageMetrics.
metrics	Gets the metrics of this DatabaseUsageMetrics.
primary_db_id	Gets the primary_db_id of this DatabaseUsageMetrics.
primary_db_unique_name	Gets the primary_db_unique_name of this DatabaseUsageMetrics.
workload_type	Gets the workload_type of this DatabaseUsageMetrics.

Methods:

__init__(**kwargs)

Initializes a new DatabaseUsageMetrics 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 DatabaseUsageMetrics. 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 DatabaseUsageMetrics. 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 DatabaseUsageMetrics. 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 DatabaseUsageMetrics. 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 DatabaseUsageMetrics. 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 DatabaseUsageMetrics. 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 DatabaseUsageMetrics. 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 DatabaseUsageMetrics. 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 DatabaseUsageMetrics. 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 DatabaseUsageMetrics. 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 DatabaseUsageMetrics. 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 DatabaseUsageMetrics. 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 DatabaseUsageMetrics. 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 DatabaseUsageMetrics. 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 DatabaseUsageMetrics. 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 DatabaseUsageMetrics. 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 DatabaseUsageMetrics. 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 DatabaseUsageMetrics. This constant has a value of “AUTONOMOUS”

DEPLOYMENT_TYPE_BM = 'BM'

A constant which can be used with the deployment_type property of a DatabaseUsageMetrics. This constant has a value of “BM”

DEPLOYMENT_TYPE_EXADATA = 'EXADATA'

A constant which can be used with the deployment_type property of a DatabaseUsageMetrics. 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 DatabaseUsageMetrics. 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 DatabaseUsageMetrics. 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 DatabaseUsageMetrics. This constant has a value of “ONPREMISE”

DEPLOYMENT_TYPE_VM = 'VM'

A constant which can be used with the deployment_type property of a DatabaseUsageMetrics. This constant has a value of “VM”

WORKLOAD_TYPE_AJD = 'AJD'

A constant which can be used with the workload_type property of a DatabaseUsageMetrics. This constant has a value of “AJD”

WORKLOAD_TYPE_APEX = 'APEX'

A constant which can be used with the workload_type property of a DatabaseUsageMetrics. This constant has a value of “APEX”

WORKLOAD_TYPE_DW = 'DW'

A constant which can be used with the workload_type property of a DatabaseUsageMetrics. This constant has a value of “DW”

WORKLOAD_TYPE_OLTP = 'OLTP'

A constant which can be used with the workload_type property of a DatabaseUsageMetrics. This constant has a value of “OLTP”

__init__(**kwargs)

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

Parameters

• db_id (str) – The value to assign to the db_id property of this DatabaseUsageMetrics.

• compartment_id (str) – The value to assign to the compartment_id property of this DatabaseUsageMetrics.

• database_type (str) – The value to assign to the database_type property of this DatabaseUsageMetrics. 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 DatabaseUsageMetrics. 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 DatabaseUsageMetrics. 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 DatabaseUsageMetrics.

• workload_type (str) – The value to assign to the workload_type property of this DatabaseUsageMetrics. 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 DatabaseUsageMetrics.

• database_container_id (str) – The value to assign to the database_container_id property of this DatabaseUsageMetrics.

• database_id (str) – The value to assign to the database_id property of this DatabaseUsageMetrics.

• primary_db_id (str) – The value to assign to the primary_db_id property of this DatabaseUsageMetrics.

• primary_db_unique_name (str) – The value to assign to the primary_db_unique_name property of this DatabaseUsageMetrics.

• db_unique_name (str) – The value to assign to the db_unique_name property of this DatabaseUsageMetrics.

• db_role (str) – The value to assign to the db_role property of this DatabaseUsageMetrics. 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’.

• metrics (list[oci.database_management.models.FleetMetricDefinition]) – The value to assign to the metrics property of this DatabaseUsageMetrics.

property compartment_id

Gets the compartment_id of this DatabaseUsageMetrics. The OCID of the compartment where the Managed Database resides.

Returns

The compartment_id of this DatabaseUsageMetrics.

Return type

str

property database_container_id

Gets the database_container_id of this DatabaseUsageMetrics. The OCID of the parent Container Database, in the case of a Pluggable Database.

Returns

The database_container_id of this DatabaseUsageMetrics.

Return type

str

property database_id

Gets the database_id of this DatabaseUsageMetrics. 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 DatabaseUsageMetrics.

Return type

str

property database_name

Gets the database_name of this DatabaseUsageMetrics. The display name of the Managed Database.

Returns

The database_name of this DatabaseUsageMetrics.

Return type

str

property database_sub_type

Gets the database_sub_type of this DatabaseUsageMetrics. 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 DatabaseUsageMetrics.

Return type

str

property database_type

Gets the database_type of this DatabaseUsageMetrics. 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 DatabaseUsageMetrics.

Return type

str

property database_version

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

Returns

The database_version of this DatabaseUsageMetrics.

Return type

str

property db_id

Gets the db_id of this DatabaseUsageMetrics. The OCID of the Managed Database.

Returns

The db_id of this DatabaseUsageMetrics.

Return type

str

property db_role

Gets the db_role of this DatabaseUsageMetrics. 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 DatabaseUsageMetrics.

Return type

str

property db_unique_name

Gets the db_unique_name of this DatabaseUsageMetrics. The Database unique name of the Managed Database.

Returns

The db_unique_name of this DatabaseUsageMetrics.

Return type

str

property deployment_type

Gets the deployment_type of this DatabaseUsageMetrics. 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 DatabaseUsageMetrics.

Return type

str

property metrics

Gets the metrics of this DatabaseUsageMetrics. A list of the database health metrics like CPU, Storage, and Memory.

Returns

The metrics of this DatabaseUsageMetrics.

Return type

list[oci.database_management.models.FleetMetricDefinition]

property primary_db_id

Gets the primary_db_id of this DatabaseUsageMetrics. The Primary Database id of the Managed Database.

Returns

The primary_db_id of this DatabaseUsageMetrics.

Return type

str

property primary_db_unique_name

Gets the primary_db_unique_name of this DatabaseUsageMetrics. The Primary Database unique name of the Managed Database.

Returns

The primary_db_unique_name of this DatabaseUsageMetrics.

Return type

str

property workload_type

Gets the workload_type of this DatabaseUsageMetrics. 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 DatabaseUsageMetrics.

Return type

str