Class: OCI::DatabaseManagement::Models::ManagedMySqlDatabase

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/database_management/models/managed_my_sql_database.rb

Overview

The details of the Managed MySQL Database. MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.

Constant Summary collapse

HEAT_WAVE_MANAGEMENT_TYPE_ENUM = 
[
  HEAT_WAVE_MANAGEMENT_TYPE_BASIC = 'BASIC'.freeze,
  HEAT_WAVE_MANAGEMENT_TYPE_FULL = 'FULL'.freeze,
  HEAT_WAVE_MANAGEMENT_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
DATABASE_TYPE_ENUM = 
[
  DATABASE_TYPE_EXTERNAL = 'EXTERNAL'.freeze,
  DATABASE_TYPE_MDS = 'MDS'.freeze,
  DATABASE_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
MANAGEMENT_STATE_ENUM = 
[
  MANAGEMENT_STATE_ENABLED = 'ENABLED'.freeze,
  MANAGEMENT_STATE_DISABLED = 'DISABLED'.freeze,
  MANAGEMENT_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ManagedMySqlDatabase

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/oci/database_management/models/managed_my_sql_database.rb', line 197

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.id = attributes[:'id'] if attributes[:'id']

  self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

  raise 'You cannot provide both :compartmentId and :compartment_id' if attributes.key?(:'compartmentId') && attributes.key?(:'compartment_id')

  self.compartment_id = attributes[:'compartment_id'] if attributes[:'compartment_id']

  self.db_name = attributes[:'dbName'] if attributes[:'dbName']

  raise 'You cannot provide both :dbName and :db_name' if attributes.key?(:'dbName') && attributes.key?(:'db_name')

  self.db_name = attributes[:'db_name'] if attributes[:'db_name']

  self.db_version = attributes[:'dbVersion'] if attributes[:'dbVersion']

  raise 'You cannot provide both :dbVersion and :db_version' if attributes.key?(:'dbVersion') && attributes.key?(:'db_version')

  self.db_version = attributes[:'db_version'] if attributes[:'db_version']

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

  raise 'You cannot provide both :timeCreated and :time_created' if attributes.key?(:'timeCreated') && attributes.key?(:'time_created')

  self.time_created = attributes[:'time_created'] if attributes[:'time_created']

  self.name = attributes[:'name'] if attributes[:'name']

  self.heat_wave_management_type = attributes[:'heatWaveManagementType'] if attributes[:'heatWaveManagementType']

  raise 'You cannot provide both :heatWaveManagementType and :heat_wave_management_type' if attributes.key?(:'heatWaveManagementType') && attributes.key?(:'heat_wave_management_type')

  self.heat_wave_management_type = attributes[:'heat_wave_management_type'] if attributes[:'heat_wave_management_type']

  self.heat_wave_cluster_display_name = attributes[:'heatWaveClusterDisplayName'] if attributes[:'heatWaveClusterDisplayName']

  raise 'You cannot provide both :heatWaveClusterDisplayName and :heat_wave_cluster_display_name' if attributes.key?(:'heatWaveClusterDisplayName') && attributes.key?(:'heat_wave_cluster_display_name')

  self.heat_wave_cluster_display_name = attributes[:'heat_wave_cluster_display_name'] if attributes[:'heat_wave_cluster_display_name']

  self.is_heat_wave_enabled = attributes[:'isHeatWaveEnabled'] unless attributes[:'isHeatWaveEnabled'].nil?

  raise 'You cannot provide both :isHeatWaveEnabled and :is_heat_wave_enabled' if attributes.key?(:'isHeatWaveEnabled') && attributes.key?(:'is_heat_wave_enabled')

  self.is_heat_wave_enabled = attributes[:'is_heat_wave_enabled'] unless attributes[:'is_heat_wave_enabled'].nil?

  self.is_lakehouse_enabled = attributes[:'isLakehouseEnabled'] unless attributes[:'isLakehouseEnabled'].nil?

  raise 'You cannot provide both :isLakehouseEnabled and :is_lakehouse_enabled' if attributes.key?(:'isLakehouseEnabled') && attributes.key?(:'is_lakehouse_enabled')

  self.is_lakehouse_enabled = attributes[:'is_lakehouse_enabled'] unless attributes[:'is_lakehouse_enabled'].nil?

  self.heat_wave_node_shape = attributes[:'heatWaveNodeShape'] if attributes[:'heatWaveNodeShape']

  raise 'You cannot provide both :heatWaveNodeShape and :heat_wave_node_shape' if attributes.key?(:'heatWaveNodeShape') && attributes.key?(:'heat_wave_node_shape')

  self.heat_wave_node_shape = attributes[:'heat_wave_node_shape'] if attributes[:'heat_wave_node_shape']

  self.heat_wave_memory_size = attributes[:'heatWaveMemorySize'] if attributes[:'heatWaveMemorySize']

  raise 'You cannot provide both :heatWaveMemorySize and :heat_wave_memory_size' if attributes.key?(:'heatWaveMemorySize') && attributes.key?(:'heat_wave_memory_size')

  self.heat_wave_memory_size = attributes[:'heat_wave_memory_size'] if attributes[:'heat_wave_memory_size']

  self.heat_wave_nodes = attributes[:'heatWaveNodes'] if attributes[:'heatWaveNodes']

  raise 'You cannot provide both :heatWaveNodes and :heat_wave_nodes' if attributes.key?(:'heatWaveNodes') && attributes.key?(:'heat_wave_nodes')

  self.heat_wave_nodes = attributes[:'heat_wave_nodes'] if attributes[:'heat_wave_nodes']

  self.is_heat_wave_active = attributes[:'isHeatWaveActive'] unless attributes[:'isHeatWaveActive'].nil?

  raise 'You cannot provide both :isHeatWaveActive and :is_heat_wave_active' if attributes.key?(:'isHeatWaveActive') && attributes.key?(:'is_heat_wave_active')

  self.is_heat_wave_active = attributes[:'is_heat_wave_active'] unless attributes[:'is_heat_wave_active'].nil?

  self.time_created_heat_wave = attributes[:'timeCreatedHeatWave'] if attributes[:'timeCreatedHeatWave']

  raise 'You cannot provide both :timeCreatedHeatWave and :time_created_heat_wave' if attributes.key?(:'timeCreatedHeatWave') && attributes.key?(:'time_created_heat_wave')

  self.time_created_heat_wave = attributes[:'time_created_heat_wave'] if attributes[:'time_created_heat_wave']

  self.database_type = attributes[:'databaseType'] if attributes[:'databaseType']

  raise 'You cannot provide both :databaseType and :database_type' if attributes.key?(:'databaseType') && attributes.key?(:'database_type')

  self.database_type = attributes[:'database_type'] if attributes[:'database_type']

  self.management_state = attributes[:'managementState'] if attributes[:'managementState']

  raise 'You cannot provide both :managementState and :management_state' if attributes.key?(:'managementState') && attributes.key?(:'management_state')

  self.management_state = attributes[:'management_state'] if attributes[:'management_state']

  self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']

  raise 'You cannot provide both :lifecycleState and :lifecycle_state' if attributes.key?(:'lifecycleState') && attributes.key?(:'lifecycle_state')

  self.lifecycle_state = attributes[:'lifecycle_state'] if attributes[:'lifecycle_state']

  self.time_updated = attributes[:'timeUpdated'] if attributes[:'timeUpdated']

  raise 'You cannot provide both :timeUpdated and :time_updated' if attributes.key?(:'timeUpdated') && attributes.key?(:'time_updated')

  self.time_updated = attributes[:'time_updated'] if attributes[:'time_updated']
end

Instance Attribute Details

#compartment_id ⇒ String

[Required] The OCID of the compartment.

Returns:

  • (String) 


46
47
48
 
# File 'lib/oci/database_management/models/managed_my_sql_database.rb', line 46

def compartment_id
  @compartment_id
end

#database_type ⇒ String

The type of the MySQL Database. Indicates whether the database is external or MDS.

Returns:

  • (String) 


104
105
106
 
# File 'lib/oci/database_management/models/managed_my_sql_database.rb', line 104

def database_type
  @database_type
end

#db_name ⇒ String

[Required] The name of the MySQL Database.

Returns:

  • (String) 


50
51
52
 
# File 'lib/oci/database_management/models/managed_my_sql_database.rb', line 50

def db_name
  @db_name
end

#db_version ⇒ String

[Required] The version of the MySQL Database.

Returns:

  • (String) 


54
55
56
 
# File 'lib/oci/database_management/models/managed_my_sql_database.rb', line 54

def db_version
  @db_version
end

#heat_wave_cluster_display_name ⇒ String

The name of the HeatWave cluster.

Returns:

  • (String) 


70
71
72
 
# File 'lib/oci/database_management/models/managed_my_sql_database.rb', line 70

def heat_wave_cluster_display_name
  @heat_wave_cluster_display_name
end

#heat_wave_management_type ⇒ String

The selected management type for a HeatWave MySQL DB system.

Returns:

  • (String) 


66
67
68
 
# File 'lib/oci/database_management/models/managed_my_sql_database.rb', line 66

def heat_wave_management_type
  @heat_wave_management_type
end

#heat_wave_memory_size ⇒ Integer

The total memory belonging to the HeatWave cluster in GBs.

Returns:

  • (Integer) 


86
87
88
 
# File 'lib/oci/database_management/models/managed_my_sql_database.rb', line 86

def heat_wave_memory_size
  @heat_wave_memory_size
end

#heat_wave_node_shape ⇒ String

The shape of the nodes in the HeatWave cluster.

Returns:

  • (String) 


82
83
84
 
# File 'lib/oci/database_management/models/managed_my_sql_database.rb', line 82

def heat_wave_node_shape
  @heat_wave_node_shape
end

#heat_wave_nodes ⇒ Array<OCI::DatabaseManagement::Models::HeatWaveNode>

The information about individual HeatWave nodes in the cluster.

Returns:



90
91
92
 
# File 'lib/oci/database_management/models/managed_my_sql_database.rb', line 90

def heat_wave_nodes
  @heat_wave_nodes
end

#id ⇒ String

[Required] The OCID of the Managed MySQL Database.

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/database_management/models/managed_my_sql_database.rb', line 42

def id
  @id
end

#is_heat_wave_active ⇒ BOOLEAN

Indicates whether the HeatWave cluster is active or not.

Returns:

  • (BOOLEAN) 


94
95
96
 
# File 'lib/oci/database_management/models/managed_my_sql_database.rb', line 94

def is_heat_wave_active
  @is_heat_wave_active
end

#is_heat_wave_enabled ⇒ BOOLEAN

Indicates whether HeatWave is enabled for the MySQL Database System or not.

Returns:

  • (BOOLEAN) 


74
75
76
 
# File 'lib/oci/database_management/models/managed_my_sql_database.rb', line 74

def is_heat_wave_enabled
  @is_heat_wave_enabled
end

#is_lakehouse_enabled ⇒ BOOLEAN

Indicates whether HeatWave Lakehouse is enabled for the MySQL Database System or not.

Returns:

  • (BOOLEAN) 


78
79
80
 
# File 'lib/oci/database_management/models/managed_my_sql_database.rb', line 78

def is_lakehouse_enabled
  @is_lakehouse_enabled
end

#lifecycle_state ⇒ String

Indicates lifecycle state of the resource.

Returns:

  • (String) 


112
113
114
 
# File 'lib/oci/database_management/models/managed_my_sql_database.rb', line 112

def lifecycle_state
  @lifecycle_state
end

#management_state ⇒ String

Indicates database management status.

Returns:

  • (String) 


108
109
110
 
# File 'lib/oci/database_management/models/managed_my_sql_database.rb', line 108

def management_state
  @management_state
end

#name ⇒ String

[Required] The name of the Managed MySQL Database.

Returns:

  • (String) 


62
63
64
 
# File 'lib/oci/database_management/models/managed_my_sql_database.rb', line 62

def name
  @name
end

#time_created ⇒ DateTime

[Required] The date and time the Managed MySQL Database was created.

Returns:

  • (DateTime) 


58
59
60
 
# File 'lib/oci/database_management/models/managed_my_sql_database.rb', line 58

def time_created
  @time_created
end

#time_created_heat_wave ⇒ DateTime

The date and time the Managed MySQL Database was created.

Returns:

  • (DateTime) 


98
99
100
 
# File 'lib/oci/database_management/models/managed_my_sql_database.rb', line 98

def time_created_heat_wave
  @time_created_heat_wave
end

#time_updated ⇒ DateTime

The date and time the Managed MySQL Database was updated.

Returns:

  • (DateTime) 


116
117
118
 
# File 'lib/oci/database_management/models/managed_my_sql_database.rb', line 116

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/oci/database_management/models/managed_my_sql_database.rb', line 119

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'db_name': :'dbName',
    'db_version': :'dbVersion',
    'time_created': :'timeCreated',
    'name': :'name',
    'heat_wave_management_type': :'heatWaveManagementType',
    'heat_wave_cluster_display_name': :'heatWaveClusterDisplayName',
    'is_heat_wave_enabled': :'isHeatWaveEnabled',
    'is_lakehouse_enabled': :'isLakehouseEnabled',
    'heat_wave_node_shape': :'heatWaveNodeShape',
    'heat_wave_memory_size': :'heatWaveMemorySize',
    'heat_wave_nodes': :'heatWaveNodes',
    'is_heat_wave_active': :'isHeatWaveActive',
    'time_created_heat_wave': :'timeCreatedHeatWave',
    'database_type': :'databaseType',
    'management_state': :'managementState',
    'lifecycle_state': :'lifecycleState',
    'time_updated': :'timeUpdated'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/oci/database_management/models/managed_my_sql_database.rb', line 146

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'db_name': :'String',
    'db_version': :'String',
    'time_created': :'DateTime',
    'name': :'String',
    'heat_wave_management_type': :'String',
    'heat_wave_cluster_display_name': :'String',
    'is_heat_wave_enabled': :'BOOLEAN',
    'is_lakehouse_enabled': :'BOOLEAN',
    'heat_wave_node_shape': :'String',
    'heat_wave_memory_size': :'Integer',
    'heat_wave_nodes': :'Array<OCI::DatabaseManagement::Models::HeatWaveNode>',
    'is_heat_wave_active': :'BOOLEAN',
    'time_created_heat_wave': :'DateTime',
    'database_type': :'String',
    'management_state': :'String',
    'lifecycle_state': :'String',
    'time_updated': :'DateTime'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
 
# File 'lib/oci/database_management/models/managed_my_sql_database.rb', line 369

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    db_name == other.db_name &&
    db_version == other.db_version &&
    time_created == other.time_created &&
    name == other.name &&
    heat_wave_management_type == other.heat_wave_management_type &&
    heat_wave_cluster_display_name == other.heat_wave_cluster_display_name &&
    is_heat_wave_enabled == other.is_heat_wave_enabled &&
    is_lakehouse_enabled == other.is_lakehouse_enabled &&
    heat_wave_node_shape == other.heat_wave_node_shape &&
    heat_wave_memory_size == other.heat_wave_memory_size &&
    heat_wave_nodes == other.heat_wave_nodes &&
    is_heat_wave_active == other.is_heat_wave_active &&
    time_created_heat_wave == other.time_created_heat_wave &&
    database_type == other.database_type &&
    management_state == other.management_state &&
    lifecycle_state == other.lifecycle_state &&
    time_updated == other.time_updated
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
 
# File 'lib/oci/database_management/models/managed_my_sql_database.rb', line 417

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


397
398
399
 
# File 'lib/oci/database_management/models/managed_my_sql_database.rb', line 397

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



406
407
408
 
# File 'lib/oci/database_management/models/managed_my_sql_database.rb', line 406

def hash
  [id, compartment_id, db_name, db_version, time_created, name, heat_wave_management_type, heat_wave_cluster_display_name, is_heat_wave_enabled, is_lakehouse_enabled, heat_wave_node_shape, heat_wave_memory_size, heat_wave_nodes, is_heat_wave_active, time_created_heat_wave, database_type, management_state, lifecycle_state, time_updated].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



450
451
452
453
454
455
456
457
458
459
 
# File 'lib/oci/database_management/models/managed_my_sql_database.rb', line 450

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



444
445
446
 
# File 'lib/oci/database_management/models/managed_my_sql_database.rb', line 444

def to_s
  to_hash.to_s
end