Class: OCI::Mysql::Models::DbSystemSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/mysql/models/db_system_summary.rb

Overview

A summary of a DB System.

Constant Summary collapse

CRASH_RECOVERY_ENUM = 
[
  CRASH_RECOVERY_ENABLED = 'ENABLED'.freeze,
  CRASH_RECOVERY_DISABLED = 'DISABLED'.freeze,
  CRASH_RECOVERY_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
DATABASE_MANAGEMENT_ENUM = 
[
  DATABASE_MANAGEMENT_ENABLED = 'ENABLED'.freeze,
  DATABASE_MANAGEMENT_DISABLED = 'DISABLED'.freeze,
  DATABASE_MANAGEMENT_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DbSystemSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/oci/mysql/models/db_system_summary.rb', line 226

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.display_name = attributes[:'displayName'] if attributes[:'displayName']

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

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

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

  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.is_highly_available = attributes[:'isHighlyAvailable'] unless attributes[:'isHighlyAvailable'].nil?
  self.is_highly_available = true if is_highly_available.nil? && !attributes.key?(:'isHighlyAvailable') # rubocop:disable Style/StringLiterals

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

  self.is_highly_available = attributes[:'is_highly_available'] unless attributes[:'is_highly_available'].nil?
  self.is_highly_available = true if is_highly_available.nil? && !attributes.key?(:'isHighlyAvailable') && !attributes.key?(:'is_highly_available') # rubocop:disable Style/StringLiterals

  self.current_placement = attributes[:'currentPlacement'] if attributes[:'currentPlacement']

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

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

  self.is_heat_wave_cluster_attached = attributes[:'isHeatWaveClusterAttached'] unless attributes[:'isHeatWaveClusterAttached'].nil?
  self.is_heat_wave_cluster_attached = false if is_heat_wave_cluster_attached.nil? && !attributes.key?(:'isHeatWaveClusterAttached') # rubocop:disable Style/StringLiterals

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

  self.is_heat_wave_cluster_attached = attributes[:'is_heat_wave_cluster_attached'] unless attributes[:'is_heat_wave_cluster_attached'].nil?
  self.is_heat_wave_cluster_attached = false if is_heat_wave_cluster_attached.nil? && !attributes.key?(:'isHeatWaveClusterAttached') && !attributes.key?(:'is_heat_wave_cluster_attached') # rubocop:disable Style/StringLiterals

  self.heat_wave_cluster = attributes[:'heatWaveCluster'] if attributes[:'heatWaveCluster']

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

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

  self.availability_domain = attributes[:'availabilityDomain'] if attributes[:'availabilityDomain']

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

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

  self.fault_domain = attributes[:'faultDomain'] if attributes[:'faultDomain']

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

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

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

  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.mysql_version = attributes[:'mysqlVersion'] if attributes[:'mysqlVersion']

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

  self.mysql_version = attributes[:'mysql_version'] if attributes[:'mysql_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.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']

  self.deletion_policy = attributes[:'deletionPolicy'] if attributes[:'deletionPolicy']

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

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

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

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

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

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

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

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

  self.backup_policy = attributes[:'backupPolicy'] if attributes[:'backupPolicy']

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

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

  self.shape_name = attributes[:'shapeName'] if attributes[:'shapeName']

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

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

  self.crash_recovery = attributes[:'crashRecovery'] if attributes[:'crashRecovery']
  self.crash_recovery = "ENABLED" if crash_recovery.nil? && !attributes.key?(:'crashRecovery') # rubocop:disable Style/StringLiterals

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

  self.crash_recovery = attributes[:'crash_recovery'] if attributes[:'crash_recovery']
  self.crash_recovery = "ENABLED" if crash_recovery.nil? && !attributes.key?(:'crashRecovery') && !attributes.key?(:'crash_recovery') # rubocop:disable Style/StringLiterals

  self.database_management = attributes[:'databaseManagement'] if attributes[:'databaseManagement']
  self.database_management = "ENABLED" if database_management.nil? && !attributes.key?(:'databaseManagement') # rubocop:disable Style/StringLiterals

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

  self.database_management = attributes[:'database_management'] if attributes[:'database_management']
  self.database_management = "ENABLED" if database_management.nil? && !attributes.key?(:'databaseManagement') && !attributes.key?(:'database_management') # rubocop:disable Style/StringLiterals
end

Instance Attribute Details

#availability_domain ⇒ String

The availability domain on which to deploy the Read/Write endpoint. This defines the preferred primary instance.

In a failover scenario, the Read/Write endpoint is redirected to one of the other availability domains and the MySQL instance in that domain is promoted to the primary instance. This redirection does not affect the IP address of the DB System in any way.

For a standalone DB System, this defines the availability domain in which the DB System is placed.

Returns:

  • (String) 


66
67
68
 
# File 'lib/oci/mysql/models/db_system_summary.rb', line 66

def availability_domain
  @availability_domain
end

#backup_policy ⇒ OCI::Mysql::Models::BackupPolicy

Returns:



116
117
118
 
# File 'lib/oci/mysql/models/db_system_summary.rb', line 116

def backup_policy
  @backup_policy
end

#compartment_id ⇒ String

The OCID of the compartment the DB System belongs in.

Returns:

  • (String) 


39
40
41
 
# File 'lib/oci/mysql/models/db_system_summary.rb', line 39

def compartment_id
  @compartment_id
end

#crash_recovery ⇒ String

Whether to run the DB System with InnoDB Redo Logs and the Double Write Buffer enabled or disabled, and whether to enable or disable syncing of the Binary Logs.

Returns:

  • (String) 


131
132
133
 
# File 'lib/oci/mysql/models/db_system_summary.rb', line 131

def crash_recovery
  @crash_recovery
end

#current_placement ⇒ OCI::Mysql::Models::DbSystemPlacement

Returns:



47
48
49
 
# File 'lib/oci/mysql/models/db_system_summary.rb', line 47

def current_placement
  @current_placement
end

#database_management ⇒ String

Whether to enable monitoring via the Database Management service.

Returns:

  • (String) 


136
137
138
 
# File 'lib/oci/mysql/models/db_system_summary.rb', line 136

def database_management
  @database_management
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


113
114
115
 
# File 'lib/oci/mysql/models/db_system_summary.rb', line 113

def defined_tags
  @defined_tags
end

#deletion_policy ⇒ OCI::Mysql::Models::DeletionPolicyDetails

Returns:



101
102
103
 
# File 'lib/oci/mysql/models/db_system_summary.rb', line 101

def deletion_policy
  @deletion_policy
end

#description ⇒ String

User-provided data about the DB System.

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/mysql/models/db_system_summary.rb', line 35

def description
  @description
end

#display_name ⇒ String

[Required] The user-friendly name for the DB System. It does not have to be unique.

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/mysql/models/db_system_summary.rb', line 31

def display_name
  @display_name
end

#endpoints ⇒ Array<OCI::Mysql::Models::DbSystemEndpoint>

The network endpoints available for this DB System.

Returns:



82
83
84
 
# File 'lib/oci/mysql/models/db_system_summary.rb', line 82

def endpoints
  @endpoints
end

#fault_domain ⇒ String

The fault domain on which to deploy the Read/Write endpoint. This defines the preferred primary instance.

In a failover scenario, the Read/Write endpoint is redirected to one of the other fault domains and the MySQL instance in that domain is promoted to the primary instance. This redirection does not affect the IP address of the DB System in any way.

For a standalone DB System, this defines the fault domain in which the DB System is placed.

Returns:

  • (String) 


77
78
79
 
# File 'lib/oci/mysql/models/db_system_summary.rb', line 77

def fault_domain
  @fault_domain
end

#freeform_tags ⇒ Hash<String, String>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>) 


107
108
109
 
# File 'lib/oci/mysql/models/db_system_summary.rb', line 107

def freeform_tags
  @freeform_tags
end

#heat_wave_cluster ⇒ OCI::Mysql::Models::HeatWaveClusterSummary

Returns:



55
56
57
 
# File 'lib/oci/mysql/models/db_system_summary.rb', line 55

def heat_wave_cluster
  @heat_wave_cluster
end

#id ⇒ String

[Required] The OCID of the DB System.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/mysql/models/db_system_summary.rb', line 27

def id
  @id
end

#is_heat_wave_cluster_attached ⇒ BOOLEAN

If the DB System has a HeatWave Cluster attached.

Returns:

  • (BOOLEAN) 


52
53
54
 
# File 'lib/oci/mysql/models/db_system_summary.rb', line 52

def is_heat_wave_cluster_attached
  @is_heat_wave_cluster_attached
end

#is_highly_available ⇒ BOOLEAN

Specifies if the DB System is highly available.

Returns:

  • (BOOLEAN) 


44
45
46
 
# File 'lib/oci/mysql/models/db_system_summary.rb', line 44

def is_highly_available
  @is_highly_available
end

#lifecycle_state ⇒ String

[Required] The current state of the DB System.

Returns:

  • (String) 


86
87
88
 
# File 'lib/oci/mysql/models/db_system_summary.rb', line 86

def lifecycle_state
  @lifecycle_state
end

#mysql_version ⇒ String

[Required] Name of the MySQL Version in use for the DB System.

Returns:

  • (String) 


90
91
92
 
# File 'lib/oci/mysql/models/db_system_summary.rb', line 90

def mysql_version
  @mysql_version
end

#shape_name ⇒ String

The shape of the primary instances of the DB System. The shape determines resources allocated to a DB System - CPU cores and memory for VM shapes; CPU cores, memory and storage for non-VM (or bare metal) shapes. To get a list of shapes, use (the list_shapes operation.

Returns:

  • (String) 


125
126
127
 
# File 'lib/oci/mysql/models/db_system_summary.rb', line 125

def shape_name
  @shape_name
end

#time_created ⇒ DateTime

[Required] The date and time the DB System was created.

Returns:

  • (DateTime) 


94
95
96
 
# File 'lib/oci/mysql/models/db_system_summary.rb', line 94

def time_created
  @time_created
end

#time_updated ⇒ DateTime

[Required] The time the DB System was last updated.

Returns:

  • (DateTime) 


98
99
100
 
# File 'lib/oci/mysql/models/db_system_summary.rb', line 98

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/oci/mysql/models/db_system_summary.rb', line 139

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'description': :'description',
    'compartment_id': :'compartmentId',
    'is_highly_available': :'isHighlyAvailable',
    'current_placement': :'currentPlacement',
    'is_heat_wave_cluster_attached': :'isHeatWaveClusterAttached',
    'heat_wave_cluster': :'heatWaveCluster',
    'availability_domain': :'availabilityDomain',
    'fault_domain': :'faultDomain',
    'endpoints': :'endpoints',
    'lifecycle_state': :'lifecycleState',
    'mysql_version': :'mysqlVersion',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'deletion_policy': :'deletionPolicy',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'backup_policy': :'backupPolicy',
    'shape_name': :'shapeName',
    'crash_recovery': :'crashRecovery',
    'database_management': :'databaseManagement'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/oci/mysql/models/db_system_summary.rb', line 169

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'description': :'String',
    'compartment_id': :'String',
    'is_highly_available': :'BOOLEAN',
    'current_placement': :'OCI::Mysql::Models::DbSystemPlacement',
    'is_heat_wave_cluster_attached': :'BOOLEAN',
    'heat_wave_cluster': :'OCI::Mysql::Models::HeatWaveClusterSummary',
    'availability_domain': :'String',
    'fault_domain': :'String',
    'endpoints': :'Array<OCI::Mysql::Models::DbSystemEndpoint>',
    'lifecycle_state': :'String',
    'mysql_version': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'deletion_policy': :'OCI::Mysql::Models::DeletionPolicyDetails',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'backup_policy': :'OCI::Mysql::Models::BackupPolicy',
    'shape_name': :'String',
    'crash_recovery': :'String',
    'database_management': :'String'
    # 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



394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
 
# File 'lib/oci/mysql/models/db_system_summary.rb', line 394

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    description == other.description &&
    compartment_id == other.compartment_id &&
    is_highly_available == other.is_highly_available &&
    current_placement == other.current_placement &&
    is_heat_wave_cluster_attached == other.is_heat_wave_cluster_attached &&
    heat_wave_cluster == other.heat_wave_cluster &&
    availability_domain == other.availability_domain &&
    fault_domain == other.fault_domain &&
    endpoints == other.endpoints &&
    lifecycle_state == other.lifecycle_state &&
    mysql_version == other.mysql_version &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    deletion_policy == other.deletion_policy &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    backup_policy == other.backup_policy &&
    shape_name == other.shape_name &&
    crash_recovery == other.crash_recovery &&
    database_management == other.database_management
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



445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
 
# File 'lib/oci/mysql/models/db_system_summary.rb', line 445

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


425
426
427
 
# File 'lib/oci/mysql/models/db_system_summary.rb', line 425

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



434
435
436
 
# File 'lib/oci/mysql/models/db_system_summary.rb', line 434

def hash
  [id, display_name, description, compartment_id, is_highly_available, current_placement, is_heat_wave_cluster_attached, heat_wave_cluster, availability_domain, fault_domain, endpoints, lifecycle_state, mysql_version, time_created, time_updated, deletion_policy, freeform_tags, defined_tags, backup_policy, shape_name, crash_recovery, database_management].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



478
479
480
481
482
483
484
485
486
487
 
# File 'lib/oci/mysql/models/db_system_summary.rb', line 478

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



472
473
474
 
# File 'lib/oci/mysql/models/db_system_summary.rb', line 472

def to_s
  to_hash.to_s
end