HeatWaveCluster¶

class oci.mysql.models.HeatWaveCluster(**kwargs)¶

Bases: object

A HeatWave cluster is a database accelerator for a DB System.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a HeatWaveCluster.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a HeatWaveCluster.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a HeatWaveCluster.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a HeatWaveCluster.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a HeatWaveCluster.
`LIFECYCLE_STATE_INACTIVE`	A constant which can be used with the lifecycle_state property of a HeatWaveCluster.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a HeatWaveCluster.
`cluster_nodes`	[Required] Gets the cluster_nodes of this HeatWaveCluster.
`cluster_size`	[Required] Gets the cluster_size of this HeatWaveCluster.
`db_system_id`	[Required] Gets the db_system_id of this HeatWaveCluster.
`is_lakehouse_enabled`	Gets the is_lakehouse_enabled of this HeatWaveCluster.
`lifecycle_details`	Gets the lifecycle_details of this HeatWaveCluster.
`lifecycle_state`	[Required] Gets the lifecycle_state of this HeatWaveCluster.
`shape_name`	[Required] Gets the shape_name of this HeatWaveCluster.
`time_created`	[Required] Gets the time_created of this HeatWaveCluster.
`time_updated`	[Required] Gets the time_updated of this HeatWaveCluster.

Methods

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

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a HeatWaveCluster. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a HeatWaveCluster. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a HeatWaveCluster. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a HeatWaveCluster. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a HeatWaveCluster. This constant has a value of “FAILED”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶: A constant which can be used with the lifecycle_state property of a HeatWaveCluster. This constant has a value of “INACTIVE”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a HeatWaveCluster. This constant has a value of “UPDATING”

__init__(**kwargs)¶

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

Parameters:

db_system_id (str) – The value to assign to the db_system_id property of this HeatWaveCluster.
shape_name (str) – The value to assign to the shape_name property of this HeatWaveCluster.
cluster_size (int) – The value to assign to the cluster_size property of this HeatWaveCluster.
is_lakehouse_enabled (bool) – The value to assign to the is_lakehouse_enabled property of this HeatWaveCluster.
cluster_nodes (list[oci.mysql.models.HeatWaveNode]) – The value to assign to the cluster_nodes property of this HeatWaveCluster.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this HeatWaveCluster. Allowed values for this property are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this HeatWaveCluster.
time_created (datetime) – The value to assign to the time_created property of this HeatWaveCluster.
time_updated (datetime) – The value to assign to the time_updated property of this HeatWaveCluster.

cluster_nodes¶

[Required] Gets the cluster_nodes of this HeatWaveCluster. A HeatWave node is a compute host that is part of a HeatWave cluster.

Returns:	The cluster_nodes of this HeatWaveCluster.
Return type:	list[oci.mysql.models.HeatWaveNode]

cluster_size¶

[Required] Gets the cluster_size of this HeatWaveCluster. The number of analytics-processing compute instances, of the specified shape, in the HeatWave cluster.

Returns:	The cluster_size of this HeatWaveCluster.
Return type:	int

db_system_id¶

[Required] Gets the db_system_id of this HeatWaveCluster. The OCID of the parent DB System this HeatWave cluster is attached to.

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

is_lakehouse_enabled¶

Gets the is_lakehouse_enabled of this HeatWaveCluster. Lakehouse enabled status for the HeatWave cluster.

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

lifecycle_details¶

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

Returns:	The lifecycle_details of this HeatWaveCluster.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this HeatWaveCluster. The current state of the HeatWave cluster.

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

Returns:	The lifecycle_state of this HeatWaveCluster.
Return type:	str

shape_name¶

[Required] Gets the shape_name of this HeatWaveCluster. The shape determines resources to allocate to the HeatWave nodes - CPU cores, memory.

Returns:	The shape_name of this HeatWaveCluster.
Return type:	str

time_created¶

[Required] Gets the time_created of this HeatWaveCluster. The date and time the HeatWave cluster was created, as described by RFC 3339.

Returns:	The time_created of this HeatWaveCluster.
Return type:	datetime

time_updated¶

[Required] Gets the time_updated of this HeatWaveCluster. The time the HeatWave cluster was last updated, as described by RFC 3339.

Returns:	The time_updated of this HeatWaveCluster.
Return type:	datetime