Class: OCI::Mysql::Models::Replica

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

Overview

A DB System read replica.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'.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 = {}) ⇒ Replica

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
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
 
# File 'lib/oci/mysql/models/replica.rb', line 220

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

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

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

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

  self.db_system_id = attributes[:'dbSystemId'] if attributes[:'dbSystemId']

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

  self.db_system_id = attributes[:'db_system_id'] if attributes[:'db_system_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.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.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.lifecycle_details = attributes[:'lifecycleDetails'] if attributes[:'lifecycleDetails']

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#availability_domain ⇒ String

The name of the Availability Domain the read replica is located in.

Returns:

  • (String) 


71
72
73
 
# File 'lib/oci/mysql/models/replica.rb', line 71

def availability_domain
  @availability_domain
end

#compartment_id ⇒ String

[Required] The OCID of the compartment that contains the read replica.

Returns:

  • (String) 


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

def compartment_id
  @compartment_id
end

#configuration_id ⇒ String

The OCID of the Configuration currently in use by the read replica.

Returns:

  • (String) 


124
125
126
 
# File 'lib/oci/mysql/models/replica.rb', line 124

def configuration_id
  @configuration_id
end

#db_system_id ⇒ String

[Required] The OCID of the DB System the read replica is associated with.

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/mysql/models/replica.rb', line 33

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


105
106
107
 
# File 'lib/oci/mysql/models/replica.rb', line 105

def defined_tags
  @defined_tags
end

#description ⇒ String

User provided description of the read replica.

Returns:

  • (String) 


45
46
47
 
# File 'lib/oci/mysql/models/replica.rb', line 45

def description
  @description
end

#display_name ⇒ String

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

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/mysql/models/replica.rb', line 41

def display_name
  @display_name
end

#fault_domain ⇒ String

The name of the Fault Domain the read replica is located in.

Returns:

  • (String) 


75
76
77
 
# File 'lib/oci/mysql/models/replica.rb', line 75

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


99
100
101
 
# File 'lib/oci/mysql/models/replica.rb', line 99

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the read replica.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/mysql/models/replica.rb', line 29

def id
  @id
end

#ip_address ⇒ String

[Required] The IP address the read replica is configured to listen on.

Returns:

  • (String) 


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

def ip_address
  @ip_address
end

#is_delete_protected ⇒ BOOLEAN

Specifies whether the read replica can be deleted. Set to true to prevent deletion, false (default) to allow. Note that if a read replica is delete protected it also prevents the entire DB System from being deleted. If the DB System is delete protected, read replicas can still be deleted individually if they are not delete protected themselves.

Returns:

  • (BOOLEAN) 


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

def is_delete_protected
  @is_delete_protected
end

#lifecycle_details ⇒ String

A message describing the state of the read replica.

Returns:

  • (String) 


53
54
55
 
# File 'lib/oci/mysql/models/replica.rb', line 53

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The state of the read replica.

Returns:

  • (String) 


49
50
51
 
# File 'lib/oci/mysql/models/replica.rb', line 49

def lifecycle_state
  @lifecycle_state
end

#mysql_version ⇒ String

[Required] The MySQL version currently in use by the read replica.

Returns:

  • (String) 


67
68
69
 
# File 'lib/oci/mysql/models/replica.rb', line 67

def mysql_version
  @mysql_version
end

#nsg_ids ⇒ Array<String>

Network Security Group OCIDs used for the VNIC attachment.

Returns:

  • (Array<String>) 


79
80
81
 
# File 'lib/oci/mysql/models/replica.rb', line 79

def nsg_ids
  @nsg_ids
end

#port ⇒ Integer

[Required] The port the read replica is configured to listen on.

Returns:

  • (Integer) 


88
89
90
 
# File 'lib/oci/mysql/models/replica.rb', line 88

def port
  @port
end

#port_x ⇒ Integer

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

Returns:

  • (Integer) 


93
94
95
 
# File 'lib/oci/mysql/models/replica.rb', line 93

def port_x
  @port_x
end

#replica_overrides ⇒ OCI::Mysql::Models::ReplicaOverrides

Returns:



127
128
129
 
# File 'lib/oci/mysql/models/replica.rb', line 127

def replica_overrides
  @replica_overrides
end

#secure_connections ⇒ OCI::Mysql::Models::SecureConnectionDetails

Returns:



25
26
27
 
# File 'lib/oci/mysql/models/replica.rb', line 25

def secure_connections
  @secure_connections
end

#shape_name ⇒ String

The shape currently in use by the read replica. The shape determines the resources allocated: CPU cores and memory for VM shapes, CPU cores, memory and storage for non-VM (bare metal) shapes. To get a list of shapes, use the list_shapes operation.

Returns:

  • (String) 


120
121
122
 
# File 'lib/oci/mysql/models/replica.rb', line 120

def shape_name
  @shape_name
end

#time_created ⇒ DateTime

[Required] The date and time the read replica was created, as described by RFC 3339.

Returns:

  • (DateTime) 


58
59
60
 
# File 'lib/oci/mysql/models/replica.rb', line 58

def time_created
  @time_created
end

#time_updated ⇒ DateTime

The time the read replica was last updated, as described by RFC 3339.

Returns:

  • (DateTime) 


63
64
65
 
# File 'lib/oci/mysql/models/replica.rb', line 63

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/oci/mysql/models/replica.rb', line 130

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'secure_connections': :'secureConnections',
    'id': :'id',
    'db_system_id': :'dbSystemId',
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'description': :'description',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'mysql_version': :'mysqlVersion',
    'availability_domain': :'availabilityDomain',
    'fault_domain': :'faultDomain',
    'nsg_ids': :'nsgIds',
    'ip_address': :'ipAddress',
    'port': :'port',
    'port_x': :'portX',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'is_delete_protected': :'isDeleteProtected',
    'shape_name': :'shapeName',
    'configuration_id': :'configurationId',
    'replica_overrides': :'replicaOverrides'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
186
187
188
189
 
# File 'lib/oci/mysql/models/replica.rb', line 161

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'secure_connections': :'OCI::Mysql::Models::SecureConnectionDetails',
    'id': :'String',
    'db_system_id': :'String',
    'compartment_id': :'String',
    'display_name': :'String',
    'description': :'String',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'mysql_version': :'String',
    'availability_domain': :'String',
    'fault_domain': :'String',
    'nsg_ids': :'Array<String>',
    'ip_address': :'String',
    'port': :'Integer',
    'port_x': :'Integer',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'is_delete_protected': :'BOOLEAN',
    'shape_name': :'String',
    'configuration_id': :'String',
    'replica_overrides': :'OCI::Mysql::Models::ReplicaOverrides'
    # 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



375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
 
# File 'lib/oci/mysql/models/replica.rb', line 375

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

  self.class == other.class &&
    secure_connections == other.secure_connections &&
    id == other.id &&
    db_system_id == other.db_system_id &&
    compartment_id == other.compartment_id &&
    display_name == other.display_name &&
    description == other.description &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    mysql_version == other.mysql_version &&
    availability_domain == other.availability_domain &&
    fault_domain == other.fault_domain &&
    nsg_ids == other.nsg_ids &&
    ip_address == other.ip_address &&
    port == other.port &&
    port_x == other.port_x &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    is_delete_protected == other.is_delete_protected &&
    shape_name == other.shape_name &&
    configuration_id == other.configuration_id &&
    replica_overrides == other.replica_overrides
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



427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
 
# File 'lib/oci/mysql/models/replica.rb', line 427

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


407
408
409
 
# File 'lib/oci/mysql/models/replica.rb', line 407

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



416
417
418
 
# File 'lib/oci/mysql/models/replica.rb', line 416

def hash
  [secure_connections, id, db_system_id, compartment_id, display_name, description, lifecycle_state, lifecycle_details, time_created, time_updated, mysql_version, availability_domain, fault_domain, nsg_ids, ip_address, port, port_x, freeform_tags, defined_tags, is_delete_protected, shape_name, configuration_id, replica_overrides].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



460
461
462
463
464
465
466
467
468
469
 
# File 'lib/oci/mysql/models/replica.rb', line 460

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



454
455
456
 
# File 'lib/oci/mysql/models/replica.rb', line 454

def to_s
  to_hash.to_s
end