Class: OCI::Mysql::Models::Replica
- Inherits:
-
Object
- Object
- OCI::Mysql::Models::Replica
- 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
-
#availability_domain ⇒ String
The name of the Availability Domain the read replica is located in.
-
#compartment_id ⇒ String
[Required] The OCID of the compartment that contains the read replica.
-
#configuration_id ⇒ String
The OCID of the Configuration currently in use by the read replica.
-
#db_system_id ⇒ String
[Required] The OCID of the DB System the read replica is associated with.
-
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource.
-
#description ⇒ String
User provided description of the read replica.
-
#display_name ⇒ String
[Required] The user-friendly name for the read replica.
-
#fault_domain ⇒ String
The name of the Fault Domain the read replica is located in.
-
#freeform_tags ⇒ Hash<String, String>
Simple key-value pair that is applied without any predefined name, type or scope.
-
#id ⇒ String
[Required] The OCID of the read replica.
-
#ip_address ⇒ String
[Required] The IP address the read replica is configured to listen on.
-
#is_delete_protected ⇒ BOOLEAN
Specifies whether the read replica can be deleted.
-
#lifecycle_details ⇒ String
A message describing the state of the read replica.
-
#lifecycle_state ⇒ String
[Required] The state of the read replica.
-
#mysql_version ⇒ String
[Required] The MySQL version currently in use by the read replica.
-
#port ⇒ Integer
[Required] The port the read replica is configured to listen on.
-
#port_x ⇒ Integer
[Required] The TCP network port on which X Plugin listens for connections.
- #replica_overrides ⇒ OCI::Mysql::Models::ReplicaOverrides
- #secure_connections ⇒ OCI::Mysql::Models::SecureConnectionDetails
-
#shape_name ⇒ String
The shape currently in use by the read replica.
-
#time_created ⇒ DateTime
[Required] The date and time the read replica was created, as described by RFC 3339.
-
#time_updated ⇒ DateTime
The time the read replica was last updated, as described by RFC 3339.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ Replica
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ Replica
Initializes the object
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 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 |
# File 'lib/oci/mysql/models/replica.rb', line 213 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.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. = attributes[:'freeformTags'] if attributes[:'freeformTags'] raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags') self. = attributes[:'freeform_tags'] if attributes[:'freeform_tags'] self. = attributes[:'definedTags'] if attributes[:'definedTags'] raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags') self. = 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.
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.
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.
120 121 122 |
# File 'lib/oci/mysql/models/replica.rb', line 120 def configuration_id @configuration_id end |
#db_system_id ⇒ String
[Required] The OCID of the DB System the read replica is associated with.
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\"}}
101 102 103 |
# File 'lib/oci/mysql/models/replica.rb', line 101 def @defined_tags end |
#description ⇒ String
User provided description of the read replica.
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.
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.
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\"}
95 96 97 |
# File 'lib/oci/mysql/models/replica.rb', line 95 def @freeform_tags end |
#id ⇒ String
[Required] The OCID of the read replica.
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.
80 81 82 |
# File 'lib/oci/mysql/models/replica.rb', line 80 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.
109 110 111 |
# File 'lib/oci/mysql/models/replica.rb', line 109 def is_delete_protected @is_delete_protected end |
#lifecycle_details ⇒ String
A message describing the state of the read replica.
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.
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.
67 68 69 |
# File 'lib/oci/mysql/models/replica.rb', line 67 def mysql_version @mysql_version end |
#port ⇒ Integer
[Required] The port the read replica is configured to listen on.
84 85 86 |
# File 'lib/oci/mysql/models/replica.rb', line 84 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.
89 90 91 |
# File 'lib/oci/mysql/models/replica.rb', line 89 def port_x @port_x end |
#replica_overrides ⇒ OCI::Mysql::Models::ReplicaOverrides
123 124 125 |
# File 'lib/oci/mysql/models/replica.rb', line 123 def replica_overrides @replica_overrides end |
#secure_connections ⇒ OCI::Mysql::Models::SecureConnectionDetails
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.
116 117 118 |
# File 'lib/oci/mysql/models/replica.rb', line 116 def shape_name @shape_name end |
#time_created ⇒ DateTime
[Required] The date and time the read replica was created, as described by RFC 3339.
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.
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.
126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 |
# File 'lib/oci/mysql/models/replica.rb', line 126 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', '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.
156 157 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 |
# File 'lib/oci/mysql/models/replica.rb', line 156 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', '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.
362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 |
# File 'lib/oci/mysql/models/replica.rb', line 362 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 && ip_address == other.ip_address && port == other.port && port_x == other.port_x && == other. && == other. && 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
413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 |
# File 'lib/oci/mysql/models/replica.rb', line 413 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
393 394 395 |
# File 'lib/oci/mysql/models/replica.rb', line 393 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
402 403 404 |
# File 'lib/oci/mysql/models/replica.rb', line 402 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, ip_address, port, port_x, , , is_delete_protected, shape_name, configuration_id, replica_overrides].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
446 447 448 449 450 451 452 453 454 455 |
# File 'lib/oci/mysql/models/replica.rb', line 446 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
440 441 442 |
# File 'lib/oci/mysql/models/replica.rb', line 440 def to_s to_hash.to_s end |