Class: OCI::Mysql::Models::UpdateDbSystemDetails

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

Overview

Details required to update a DB System.

Constant Summary collapse

CRASH_RECOVERY_ENUM = 
[
  CRASH_RECOVERY_ENABLED = 'ENABLED'.freeze,
  CRASH_RECOVERY_DISABLED = 'DISABLED'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateDbSystemDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
 
# File 'lib/oci/mysql/models/update_db_system_details.rb', line 245

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

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

  self.subnet_id = attributes[:'subnet_id'] if attributes[:'subnet_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.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.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.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.configuration_id = attributes[:'configurationId'] if attributes[:'configurationId']

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

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

  self.admin_username = attributes[:'adminUsername'] if attributes[:'adminUsername']

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

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

  self.admin_password = attributes[:'adminPassword'] if attributes[:'adminPassword']

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

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

  self.data_storage_size_in_gbs = attributes[:'dataStorageSizeInGBs'] if attributes[:'dataStorageSizeInGBs']

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

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

  self.hostname_label = attributes[:'hostnameLabel'] if attributes[:'hostnameLabel']

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

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

  self.ip_address = attributes[:'ipAddress'] if attributes[:'ipAddress']

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

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

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

  self.port_x = attributes[:'portX'] if attributes[:'portX']

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

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

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

  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.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.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
end

Instance Attribute Details

#admin_password ⇒ String

The password for the administrative user. The password must be between 8 and 32 characters long, and must contain at least 1 numeric character, 1 lowercase character, 1 uppercase character, and 1 special (nonalphanumeric) character.

Returns:

  • (String) 


92
93
94
 
# File 'lib/oci/mysql/models/update_db_system_details.rb', line 92

def admin_password
  @admin_password
end

#admin_username ⇒ String

The username for the administrative user for the MySQL Instance.

Returns:

  • (String) 


84
85
86
 
# File 'lib/oci/mysql/models/update_db_system_details.rb', line 84

def admin_username
  @admin_username
end

#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) 


48
49
50
 
# File 'lib/oci/mysql/models/update_db_system_details.rb', line 48

def availability_domain
  @availability_domain
end

#backup_policy ⇒ OCI::Mysql::Models::UpdateBackupPolicyDetails

Returns:



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

def backup_policy
  @backup_policy
end

#configuration_id ⇒ String

The OCID of the Configuration to be used for Instances in this DB System.

Returns:

  • (String) 


80
81
82
 
# File 'lib/oci/mysql/models/update_db_system_details.rb', line 80

def configuration_id
  @configuration_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) 


155
156
157
 
# File 'lib/oci/mysql/models/update_db_system_details.rb', line 155

def crash_recovery
  @crash_recovery
end

#data_storage_size_in_gbs ⇒ Integer

Expands the DB System's storage to the specified value. Only supports values larger than the current DB System's storage size.

DB Systems with initial storage of 400 GB or less can be expanded up to 32 TB. DB Systems with initial storage larger than 400 GB can be expanded up to 64 TB.

It is not possible to decrease data storage size.

Returns:

  • (Integer) 


103
104
105
 
# File 'lib/oci/mysql/models/update_db_system_details.rb', line 103

def data_storage_size_in_gbs
  @data_storage_size_in_gbs
end

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

Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{"bar-key": "value"}`

Returns:

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


146
147
148
 
# File 'lib/oci/mysql/models/update_db_system_details.rb', line 146

def defined_tags
  @defined_tags
end

#deletion_policy ⇒ OCI::Mysql::Models::UpdateDeletionPolicyDetails

Returns:



149
150
151
 
# File 'lib/oci/mysql/models/update_db_system_details.rb', line 149

def deletion_policy
  @deletion_policy
end

#description ⇒ String

User-provided data about the DB System.

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/mysql/models/update_db_system_details.rb', line 22

def description
  @description
end

#display_name ⇒ String

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

Returns:

  • (String) 


18
19
20
 
# File 'lib/oci/mysql/models/update_db_system_details.rb', line 18

def display_name
  @display_name
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) 


59
60
61
 
# File 'lib/oci/mysql/models/update_db_system_details.rb', line 59

def fault_domain
  @fault_domain
end

#freeform_tags ⇒ Hash<String, String>

Simple key-value pair applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `"value"`

Returns:

  • (Hash<String, String>) 


140
141
142
 
# File 'lib/oci/mysql/models/update_db_system_details.rb', line 140

def freeform_tags
  @freeform_tags
end

#hostname_label ⇒ String

The hostname for the primary endpoint of the DB System. Used for DNS. The value is the hostname portion of the primary private IP's fully qualified domain name (FQDN) (for example, "dbsystem-1" in FQDN "dbsystem-1.subnet123.vcn1.oraclevcn.com"). Must be unique across all VNICs in the subnet and comply with RFC 952 and RFC 1123.

Returns:

  • (String) 


111
112
113
 
# File 'lib/oci/mysql/models/update_db_system_details.rb', line 111

def hostname_label
  @hostname_label
end

#ip_address ⇒ String

The IP address the DB System should be configured to listen on the provided subnet. It must be a free private IP address within the subnet's CIDR. If you don't specify a value, Oracle automatically assigns a private IP address from the subnet. This should be a "dotted-quad" style IPv4 address.

Returns:

  • (String) 


119
120
121
 
# File 'lib/oci/mysql/models/update_db_system_details.rb', line 119

def ip_address
  @ip_address
end

#is_highly_available ⇒ BOOLEAN

Specifies if the DB System is highly available.

Set to true to enable high availability. Two secondary MySQL instances are created and placed in the unused availability or fault domains, depending on your region and subnet type. Set to false to disable high availability. The secondary MySQL instances are removed and the MySQL instance in the preferred location is used.

Returns:

  • (BOOLEAN) 


37
38
39
 
# File 'lib/oci/mysql/models/update_db_system_details.rb', line 37

def is_highly_available
  @is_highly_available
end

#maintenance ⇒ OCI::Mysql::Models::UpdateMaintenanceDetails

Returns:



134
135
136
 
# File 'lib/oci/mysql/models/update_db_system_details.rb', line 134

def maintenance
  @maintenance
end

#mysql_version ⇒ String

The specific MySQL version identifier.

Returns:

  • (String) 


76
77
78
 
# File 'lib/oci/mysql/models/update_db_system_details.rb', line 76

def mysql_version
  @mysql_version
end

#port ⇒ Integer

The port for primary endpoint of the DB System to listen on.

Returns:

  • (Integer) 


123
124
125
 
# File 'lib/oci/mysql/models/update_db_system_details.rb', line 123

def port
  @port
end

#port_x ⇒ Integer

The TCP network port on which X Plugin listens for connections. This is the X Plugin equivalent of port.

Returns:

  • (Integer) 


128
129
130
 
# File 'lib/oci/mysql/models/update_db_system_details.rb', line 128

def port_x
  @port_x
end

#shape_name ⇒ String

The shape of the DB System. The shape determines resources allocated to the 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.

Changes in Shape will result in a downtime as the MySQL DB System is migrated to the new Compute instance.

Returns:

  • (String) 


72
73
74
 
# File 'lib/oci/mysql/models/update_db_system_details.rb', line 72

def shape_name
  @shape_name
end

#subnet_id ⇒ String

The OCID of the subnet the DB System is associated with.

Returns:

  • (String) 


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

def subnet_id
  @subnet_id
end

Class Method Details

.attribute_map ⇒ Object

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



158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/oci/mysql/models/update_db_system_details.rb', line 158

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'description': :'description',
    'subnet_id': :'subnetId',
    'is_highly_available': :'isHighlyAvailable',
    'availability_domain': :'availabilityDomain',
    'fault_domain': :'faultDomain',
    'shape_name': :'shapeName',
    'mysql_version': :'mysqlVersion',
    'configuration_id': :'configurationId',
    'admin_username': :'adminUsername',
    'admin_password': :'adminPassword',
    'data_storage_size_in_gbs': :'dataStorageSizeInGBs',
    'hostname_label': :'hostnameLabel',
    'ip_address': :'ipAddress',
    'port': :'port',
    'port_x': :'portX',
    'backup_policy': :'backupPolicy',
    'maintenance': :'maintenance',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'deletion_policy': :'deletionPolicy',
    'crash_recovery': :'crashRecovery'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/oci/mysql/models/update_db_system_details.rb', line 188

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'description': :'String',
    'subnet_id': :'String',
    'is_highly_available': :'BOOLEAN',
    'availability_domain': :'String',
    'fault_domain': :'String',
    'shape_name': :'String',
    'mysql_version': :'String',
    'configuration_id': :'String',
    'admin_username': :'String',
    'admin_password': :'String',
    'data_storage_size_in_gbs': :'Integer',
    'hostname_label': :'String',
    'ip_address': :'String',
    'port': :'Integer',
    'port_x': :'Integer',
    'backup_policy': :'OCI::Mysql::Models::UpdateBackupPolicyDetails',
    'maintenance': :'OCI::Mysql::Models::UpdateMaintenanceDetails',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'deletion_policy': :'OCI::Mysql::Models::UpdateDeletionPolicyDetails',
    'crash_recovery': :'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



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

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

  self.class == other.class &&
    display_name == other.display_name &&
    description == other.description &&
    subnet_id == other.subnet_id &&
    is_highly_available == other.is_highly_available &&
    availability_domain == other.availability_domain &&
    fault_domain == other.fault_domain &&
    shape_name == other.shape_name &&
    mysql_version == other.mysql_version &&
    configuration_id == other.configuration_id &&
    admin_username == other.admin_username &&
    admin_password == other.admin_password &&
    data_storage_size_in_gbs == other.data_storage_size_in_gbs &&
    hostname_label == other.hostname_label &&
    ip_address == other.ip_address &&
    port == other.port &&
    port_x == other.port_x &&
    backup_policy == other.backup_policy &&
    maintenance == other.maintenance &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    deletion_policy == other.deletion_policy &&
    crash_recovery == other.crash_recovery
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



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

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


422
423
424
 
# File 'lib/oci/mysql/models/update_db_system_details.rb', line 422

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



431
432
433
 
# File 'lib/oci/mysql/models/update_db_system_details.rb', line 431

def hash
  [display_name, description, subnet_id, is_highly_available, availability_domain, fault_domain, shape_name, mysql_version, configuration_id, admin_username, admin_password, data_storage_size_in_gbs, hostname_label, ip_address, port, port_x, backup_policy, maintenance, freeform_tags, defined_tags, deletion_policy, crash_recovery].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



475
476
477
478
479
480
481
482
483
484
 
# File 'lib/oci/mysql/models/update_db_system_details.rb', line 475

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



469
470
471
 
# File 'lib/oci/mysql/models/update_db_system_details.rb', line 469

def to_s
  to_hash.to_s
end