HeatWaveCluster¶
- class oci.mysql.models.HeatWaveCluster(**kwargs)¶
Bases:
objectA HeatWave cluster is a database accelerator for a DB System.
Attributes:
A constant which can be used with the lifecycle_state property of a HeatWaveCluster.
A constant which can be used with the lifecycle_state property of a HeatWaveCluster.
A constant which can be used with the lifecycle_state property of a HeatWaveCluster.
A constant which can be used with the lifecycle_state property of a HeatWaveCluster.
A constant which can be used with the lifecycle_state property of a HeatWaveCluster.
A constant which can be used with the lifecycle_state property of a HeatWaveCluster.
A constant which can be used with the lifecycle_state property of a HeatWaveCluster.
[Required] Gets the cluster_nodes of this HeatWaveCluster.
[Required] Gets the cluster_size of this HeatWaveCluster.
[Required] Gets the db_system_id of this HeatWaveCluster.
Gets the is_lakehouse_enabled of this HeatWaveCluster.
Gets the lifecycle_details of this HeatWaveCluster.
[Required] Gets the lifecycle_state of this HeatWaveCluster.
[Required] Gets the shape_name of this HeatWaveCluster.
[Required] Gets the time_created of this HeatWaveCluster.
[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.
- property 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
- property 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
- property 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
- property 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
- property 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
- property 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
- property 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