MySqlDatabaseUsageMetrics

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

Bases: object

The list of aggregated metrics for Managed MySQL Databases in the fleet. MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.

Attributes:

DATABASE_STATUS_DOWN

A constant which can be used with the database_status property of a MySqlDatabaseUsageMetrics.

DATABASE_STATUS_UNKNOWN

A constant which can be used with the database_status property of a MySqlDatabaseUsageMetrics.

DATABASE_STATUS_UP

A constant which can be used with the database_status property of a MySqlDatabaseUsageMetrics.

compartment_id

[Required] Gets the compartment_id of this MySqlDatabaseUsageMetrics.

database_name

[Required] Gets the database_name of this MySqlDatabaseUsageMetrics.

database_status

[Required] Gets the database_status of this MySqlDatabaseUsageMetrics.

database_type

[Required] Gets the database_type of this MySqlDatabaseUsageMetrics.

database_version

[Required] Gets the database_version of this MySqlDatabaseUsageMetrics.

db_id

[Required] Gets the db_id of this MySqlDatabaseUsageMetrics.

heat_wave_cluster_display_name

Gets the heat_wave_cluster_display_name of this MySqlDatabaseUsageMetrics.

heat_wave_management_type

Gets the heat_wave_management_type of this MySqlDatabaseUsageMetrics.

heat_wave_node_count

Gets the heat_wave_node_count of this MySqlDatabaseUsageMetrics.

is_heat_wave_enabled

Gets the is_heat_wave_enabled of this MySqlDatabaseUsageMetrics.

mds_deployment_type

[Required] Gets the mds_deployment_type of this MySqlDatabaseUsageMetrics.

mdslifecycle_state

[Required] Gets the mdslifecycle_state of this MySqlDatabaseUsageMetrics.

metrics

[Required] Gets the metrics of this MySqlDatabaseUsageMetrics.

Methods:

__init__(**kwargs)

Initializes a new MySqlDatabaseUsageMetrics object with values from keyword arguments.

DATABASE_STATUS_DOWN = 'DOWN'

A constant which can be used with the database_status property of a MySqlDatabaseUsageMetrics. This constant has a value of “DOWN”

DATABASE_STATUS_UNKNOWN = 'UNKNOWN'

A constant which can be used with the database_status property of a MySqlDatabaseUsageMetrics. This constant has a value of “UNKNOWN”

DATABASE_STATUS_UP = 'UP'

A constant which can be used with the database_status property of a MySqlDatabaseUsageMetrics. This constant has a value of “UP”

__init__(**kwargs)

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

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

  • database_name (str) – The value to assign to the database_name property of this MySqlDatabaseUsageMetrics.

  • database_type (str) – The value to assign to the database_type property of this MySqlDatabaseUsageMetrics.

  • mds_deployment_type (str) – The value to assign to the mds_deployment_type property of this MySqlDatabaseUsageMetrics.

  • mdslifecycle_state (str) – The value to assign to the mdslifecycle_state property of this MySqlDatabaseUsageMetrics.

  • database_version (str) – The value to assign to the database_version property of this MySqlDatabaseUsageMetrics.

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

  • database_status (str) – The value to assign to the database_status property of this MySqlDatabaseUsageMetrics. Allowed values for this property are: “UP”, “DOWN”, “UNKNOWN”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • heat_wave_management_type (str) – The value to assign to the heat_wave_management_type property of this MySqlDatabaseUsageMetrics.

  • is_heat_wave_enabled (bool) – The value to assign to the is_heat_wave_enabled property of this MySqlDatabaseUsageMetrics.

  • heat_wave_cluster_display_name (str) – The value to assign to the heat_wave_cluster_display_name property of this MySqlDatabaseUsageMetrics.

  • heat_wave_node_count (int) – The value to assign to the heat_wave_node_count property of this MySqlDatabaseUsageMetrics.

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

property compartment_id

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

Returns

The compartment_id of this MySqlDatabaseUsageMetrics.

Return type

str

property database_name

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

Returns

The database_name of this MySqlDatabaseUsageMetrics.

Return type

str

property database_status

[Required] Gets the database_status of this MySqlDatabaseUsageMetrics. The status of the MySQL Database. Indicates whether the status of the database is UP, DOWN, or UNKNOWN at the current time.

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

Returns

The database_status of this MySqlDatabaseUsageMetrics.

Return type

str

property database_type

[Required] Gets the database_type of this MySqlDatabaseUsageMetrics. Indicates MySQL Database type, ONPREMISE or MySQL Database System.

Returns

The database_type of this MySqlDatabaseUsageMetrics.

Return type

str

property database_version

[Required] Gets the database_version of this MySqlDatabaseUsageMetrics. The version of the MySQL Database.

Returns

The database_version of this MySqlDatabaseUsageMetrics.

Return type

str

property db_id

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

Returns

The db_id of this MySqlDatabaseUsageMetrics.

Return type

str

property heat_wave_cluster_display_name

Gets the heat_wave_cluster_display_name of this MySqlDatabaseUsageMetrics. The name of the HeatWave cluster.

Returns

The heat_wave_cluster_display_name of this MySqlDatabaseUsageMetrics.

Return type

str

property heat_wave_management_type

Gets the heat_wave_management_type of this MySqlDatabaseUsageMetrics. The selected management type for a HeatWave MySQL DB system.

Returns

The heat_wave_management_type of this MySqlDatabaseUsageMetrics.

Return type

str

property heat_wave_node_count

Gets the heat_wave_node_count of this MySqlDatabaseUsageMetrics. The number of nodes in the HeatWave cluster.

Returns

The heat_wave_node_count of this MySqlDatabaseUsageMetrics.

Return type

int

property is_heat_wave_enabled

Gets the is_heat_wave_enabled of this MySqlDatabaseUsageMetrics. Indicates whether HeatWave is enabled for the MySQL Database System or not.

Returns

The is_heat_wave_enabled of this MySqlDatabaseUsageMetrics.

Return type

bool

property mds_deployment_type

[Required] Gets the mds_deployment_type of this MySqlDatabaseUsageMetrics. The type of MySQL Database System.

Returns

The mds_deployment_type of this MySqlDatabaseUsageMetrics.

Return type

str

property mdslifecycle_state

[Required] Gets the mdslifecycle_state of this MySqlDatabaseUsageMetrics. The lifecycle state of the MySQL Database System.

Returns

The mdslifecycle_state of this MySqlDatabaseUsageMetrics.

Return type

str

property metrics

[Required] Gets the metrics of this MySqlDatabaseUsageMetrics. A list of the database health metrics like CPU, Storage, and Memory.

Returns

The metrics of this MySqlDatabaseUsageMetrics.

Return type

list[oci.database_management.models.MySqlFleetMetricDefinition]