HeatWaveClusterUsageMetrics¶

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

Bases: object

The list of aggregated metrics for a HeatWave cluster in the fleet.

Attributes

`STATUS_DOWN`	A constant which can be used with the status property of a HeatWaveClusterUsageMetrics.
`STATUS_UNKNOWN`	A constant which can be used with the status property of a HeatWaveClusterUsageMetrics.
`STATUS_UP`	A constant which can be used with the status property of a HeatWaveClusterUsageMetrics.
`db_system_id`	[Required] Gets the db_system_id of this HeatWaveClusterUsageMetrics.
`db_system_name`	[Required] Gets the db_system_name of this HeatWaveClusterUsageMetrics.
`heat_wave_cluster_display_name`	[Required] Gets the heat_wave_cluster_display_name of this HeatWaveClusterUsageMetrics.
`heat_wave_node_shape`	[Required] Gets the heat_wave_node_shape of this HeatWaveClusterUsageMetrics.
`is_lakehouse_enabled`	[Required] Gets the is_lakehouse_enabled of this HeatWaveClusterUsageMetrics.
`memory_size`	[Required] Gets the memory_size of this HeatWaveClusterUsageMetrics.
`metrics`	[Required] Gets the metrics of this HeatWaveClusterUsageMetrics.
`node_count`	[Required] Gets the node_count of this HeatWaveClusterUsageMetrics.
`status`	[Required] Gets the status of this HeatWaveClusterUsageMetrics.

Methods

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

STATUS_DOWN = 'DOWN'¶: A constant which can be used with the status property of a HeatWaveClusterUsageMetrics. This constant has a value of “DOWN”

STATUS_UNKNOWN = 'UNKNOWN'¶: A constant which can be used with the status property of a HeatWaveClusterUsageMetrics. This constant has a value of “UNKNOWN”

STATUS_UP = 'UP'¶: A constant which can be used with the status property of a HeatWaveClusterUsageMetrics. This constant has a value of “UP”

__init__(**kwargs)¶

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

Parameters:

status (str) – The value to assign to the status property of this HeatWaveClusterUsageMetrics. 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’.
db_system_id (str) – The value to assign to the db_system_id property of this HeatWaveClusterUsageMetrics.
db_system_name (str) – The value to assign to the db_system_name property of this HeatWaveClusterUsageMetrics.
heat_wave_cluster_display_name (str) – The value to assign to the heat_wave_cluster_display_name property of this HeatWaveClusterUsageMetrics.
node_count (int) – The value to assign to the node_count property of this HeatWaveClusterUsageMetrics.
is_lakehouse_enabled (bool) – The value to assign to the is_lakehouse_enabled property of this HeatWaveClusterUsageMetrics.
heat_wave_node_shape (str) – The value to assign to the heat_wave_node_shape property of this HeatWaveClusterUsageMetrics.
memory_size (int) – The value to assign to the memory_size property of this HeatWaveClusterUsageMetrics.
metrics (list[oci.database_management.models.HeatWaveFleetMetricDefinition]) – The value to assign to the metrics property of this HeatWaveClusterUsageMetrics.

db_system_id¶

[Required] Gets the db_system_id of this HeatWaveClusterUsageMetrics. The OCID of the MySQL Database System associated with the HeatWave cluster.

Returns:	The db_system_id of this HeatWaveClusterUsageMetrics.
Return type:	str

db_system_name¶

[Required] Gets the db_system_name of this HeatWaveClusterUsageMetrics. The name of the MySQL Database System associated with the HeatWave cluster.

Returns:	The db_system_name of this HeatWaveClusterUsageMetrics.
Return type:	str

heat_wave_cluster_display_name¶

[Required] Gets the heat_wave_cluster_display_name of this HeatWaveClusterUsageMetrics. The name of the HeatWave cluster.

Returns:	The heat_wave_cluster_display_name of this HeatWaveClusterUsageMetrics.
Return type:	str

heat_wave_node_shape¶

[Required] Gets the heat_wave_node_shape of this HeatWaveClusterUsageMetrics. The shape of the nodes in the HeatWave cluster.

Returns:	The heat_wave_node_shape of this HeatWaveClusterUsageMetrics.
Return type:	str

is_lakehouse_enabled¶

[Required] Gets the is_lakehouse_enabled of this HeatWaveClusterUsageMetrics. Indicates whether Lakehouse is enabled for the HeatWave cluster or not.

Returns:	The is_lakehouse_enabled of this HeatWaveClusterUsageMetrics.
Return type:	bool

memory_size¶

[Required] Gets the memory_size of this HeatWaveClusterUsageMetrics. The total memory belonging to the HeatWave cluster in GBs.

Returns:	The memory_size of this HeatWaveClusterUsageMetrics.
Return type:	int

metrics¶

[Required] Gets the metrics of this HeatWaveClusterUsageMetrics. A list of the HeatWave cluster health metrics like CPU and Memory.

Returns:	The metrics of this HeatWaveClusterUsageMetrics.
Return type:	list[oci.database_management.models.HeatWaveFleetMetricDefinition]

node_count¶

[Required] Gets the node_count of this HeatWaveClusterUsageMetrics. The number of nodes in the HeatWave cluster.

Returns:	The node_count of this HeatWaveClusterUsageMetrics.
Return type:	int

status¶

[Required] Gets the status of this HeatWaveClusterUsageMetrics. The status of the HeatWave cluster. Indicates whether the status of the cluster 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 status of this HeatWaveClusterUsageMetrics.
Return type:	str