Class: OCI::Mysql::Models::DbSystem

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

Overview

A DB System is the core logical unit of MySQL Database Service.

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_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
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
DATABASE_MODE_ENUM = 
[
  DATABASE_MODE_READ_WRITE = 'READ_WRITE'.freeze,
  DATABASE_MODE_READ_ONLY = 'READ_ONLY'.freeze,
  DATABASE_MODE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
ACCESS_MODE_ENUM = 
[
  ACCESS_MODE_UNRESTRICTED = 'UNRESTRICTED'.freeze,
  ACCESS_MODE_RESTRICTED = 'RESTRICTED'.freeze,
  ACCESS_MODE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DbSystem

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
 
# File 'lib/oci/mysql/models/db_system.rb', line 420

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  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

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

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

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

  self.access_mode = attributes[:'accessMode'] if attributes[:'accessMode']

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

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

  self.customer_contacts = attributes[:'customerContacts'] if attributes[:'customerContacts']

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

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

  self.read_endpoint = attributes[:'readEndpoint'] if attributes[:'readEndpoint']

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

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

Instance Attribute Details

#access_mode ⇒ String

[Required] The access mode indicating if the database access is unrestricted (to all MySQL user accounts), or restricted (to only certain users with specific privileges): - UNRESTRICTED: the access to the database is not restricted; - RESTRICTED: access allowed only to users with specific privileges; RESTRICTED will correspond to setting the MySQL system variable offline_mode to ON.

Returns:

  • (String) 


257
258
259
 
# File 'lib/oci/mysql/models/db_system.rb', line 257

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


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

def availability_domain
  @availability_domain
end

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

Returns:



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

def backup_policy
  @backup_policy
end

#channels ⇒ Array<OCI::Mysql::Models::ChannelSummary>

A list with a summary of all the Channels attached to the DB System.

Returns:



179
180
181
 
# File 'lib/oci/mysql/models/db_system.rb', line 179

def channels
  @channels
end

#compartment_id ⇒ String

[Required] The OCID of the compartment the DB System belongs in.

Returns:

  • (String) 


62
63
64
 
# File 'lib/oci/mysql/models/db_system.rb', line 62

def compartment_id
  @compartment_id
end

#configuration_id ⇒ String

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

Returns:

  • (String) 


135
136
137
 
# File 'lib/oci/mysql/models/db_system.rb', line 135

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) 


227
228
229
 
# File 'lib/oci/mysql/models/db_system.rb', line 227

def crash_recovery
  @crash_recovery
end

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

Returns:



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

def current_placement
  @current_placement
end

#customer_contacts ⇒ Array<OCI::Mysql::Models::CustomerContact>

The list of customer email addresses that receive information from Oracle about the specified OCI DB System resource. Oracle uses these email addresses to send notifications about planned and unplanned software maintenance updates, information about system hardware, and other information needed by administrators. Up to 10 email addresses can be added to the customer contacts for a DB System.

Returns:



264
265
266
 
# File 'lib/oci/mysql/models/db_system.rb', line 264

def customer_contacts
  @customer_contacts
end

#data_storage ⇒ OCI::Mysql::Models::DataStorage

This attribute is required.

Returns:



145
146
147
 
# File 'lib/oci/mysql/models/db_system.rb', line 145

def data_storage
  @data_storage
end

#data_storage_size_in_gbs ⇒ Integer

[Required] DEPRECATED: User specified size of the data volume. May be less than current allocatedStorageSizeInGBs. Replaced by dataStorage.dataStorageSizeInGBs.

Returns:

  • (Integer) 


141
142
143
 
# File 'lib/oci/mysql/models/db_system.rb', line 141

def data_storage_size_in_gbs
  @data_storage_size_in_gbs
end

#database_management ⇒ String

Whether to enable monitoring via the Database Management service.

Returns:

  • (String) 


235
236
237
 
# File 'lib/oci/mysql/models/db_system.rb', line 235

def database_management
  @database_management
end

#database_mode ⇒ String

[Required] The database mode indicating the types of statements that are allowed to run in the the DB system. This mode applies only to statements run by user connections. Replicated write statements continue to be allowed regardless of the DatabaseMode. - READ_WRITE: allow running read and write statements on the DB system; - READ_ONLY: only allow running read statements on the DB system.

Returns:

  • (String) 


247
248
249
 
# File 'lib/oci/mysql/models/db_system.rb', line 247

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


215
216
217
 
# File 'lib/oci/mysql/models/db_system.rb', line 215

def defined_tags
  @defined_tags
end

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

This attribute is required.

Returns:



195
196
197
 
# File 'lib/oci/mysql/models/db_system.rb', line 195

def deletion_policy
  @deletion_policy
end

#description ⇒ String

User-provided data about the DB System.

Returns:

  • (String) 


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

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) 


54
55
56
 
# File 'lib/oci/mysql/models/db_system.rb', line 54

def display_name
  @display_name
end

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

The network endpoints available for this DB System.

Returns:



175
176
177
 
# File 'lib/oci/mysql/models/db_system.rb', line 175

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) 


112
113
114
 
# File 'lib/oci/mysql/models/db_system.rb', line 112

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


209
210
211
 
# File 'lib/oci/mysql/models/db_system.rb', line 209

def freeform_tags
  @freeform_tags
end

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

Returns:



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

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


153
154
155
 
# File 'lib/oci/mysql/models/db_system.rb', line 153

def hostname_label
  @hostname_label
end

#id ⇒ String

[Required] The OCID of the DB System.

Returns:

  • (String) 


50
51
52
 
# File 'lib/oci/mysql/models/db_system.rb', line 50

def id
  @id
end

#ip_address ⇒ String

The IP address the DB System is configured to listen on. A private IP address of the primary endpoint of the DB System. Must be an available IP address within the subnet's CIDR. This will be a "dotted-quad" style IPv4 address.

Returns:

  • (String) 


161
162
163
 
# File 'lib/oci/mysql/models/db_system.rb', line 161

def ip_address
  @ip_address
end

#is_heat_wave_cluster_attached ⇒ BOOLEAN

If the DB System has a HeatWave Cluster attached.

Returns:

  • (BOOLEAN) 


87
88
89
 
# File 'lib/oci/mysql/models/db_system.rb', line 87

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) 


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

def is_highly_available
  @is_highly_available
end

#lifecycle_details ⇒ String

Additional information about the current lifecycleState.

Returns:

  • (String) 


187
188
189
 
# File 'lib/oci/mysql/models/db_system.rb', line 187

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the DB System.

Returns:

  • (String) 


183
184
185
 
# File 'lib/oci/mysql/models/db_system.rb', line 183

def lifecycle_state
  @lifecycle_state
end

#maintenance ⇒ OCI::Mysql::Models::MaintenanceDetails

This attribute is required.

Returns:



191
192
193
 
# File 'lib/oci/mysql/models/db_system.rb', line 191

def maintenance
  @maintenance
end

#mysql_version ⇒ String

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

Returns:

  • (String) 


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

def mysql_version
  @mysql_version
end

#nsg_ids ⇒ Array<String>

Network Security Group OCIDs used for the VNIC attachment.

Returns:

  • (Array<String>) 


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

def nsg_ids
  @nsg_ids
end

#point_in_time_recovery_details ⇒ OCI::Mysql::Models::PointInTimeRecoveryDetails

Returns:



230
231
232
 
# File 'lib/oci/mysql/models/db_system.rb', line 230

def point_in_time_recovery_details
  @point_in_time_recovery_details
end

#port ⇒ Integer

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

Returns:

  • (Integer) 


165
166
167
 
# File 'lib/oci/mysql/models/db_system.rb', line 165

def port
  @port
end

#port_x ⇒ Integer

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

Returns:

  • (Integer) 


170
171
172
 
# File 'lib/oci/mysql/models/db_system.rb', line 170

def port_x
  @port_x
end

#read_endpoint ⇒ OCI::Mysql::Models::ReadEndpointDetails

Returns:



267
268
269
 
# File 'lib/oci/mysql/models/db_system.rb', line 267

def read_endpoint
  @read_endpoint
end

#rest ⇒ OCI::Mysql::Models::RestDetails

Returns:



74
75
76
 
# File 'lib/oci/mysql/models/db_system.rb', line 74

def rest
  @rest
end

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

Returns:



238
239
240
 
# File 'lib/oci/mysql/models/db_system.rb', line 238

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


121
122
123
 
# File 'lib/oci/mysql/models/db_system.rb', line 121

def shape_name
  @shape_name
end

#source ⇒ OCI::Mysql::Models::DbSystemSource

Returns:



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

def source
  @source
end

#subnet_id ⇒ String

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

Returns:

  • (String) 


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

def subnet_id
  @subnet_id
end

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

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

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


221
222
223
 
# File 'lib/oci/mysql/models/db_system.rb', line 221

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

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

Returns:

  • (DateTime) 


199
200
201
 
# File 'lib/oci/mysql/models/db_system.rb', line 199

def time_created
  @time_created
end

#time_updated ⇒ DateTime

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

Returns:

  • (DateTime) 


203
204
205
 
# File 'lib/oci/mysql/models/db_system.rb', line 203

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'description': :'description',
    'compartment_id': :'compartmentId',
    'subnet_id': :'subnetId',
    'nsg_ids': :'nsgIds',
    'rest': :'rest',
    'is_highly_available': :'isHighlyAvailable',
    'current_placement': :'currentPlacement',
    'is_heat_wave_cluster_attached': :'isHeatWaveClusterAttached',
    'heat_wave_cluster': :'heatWaveCluster',
    'availability_domain': :'availabilityDomain',
    'fault_domain': :'faultDomain',
    'shape_name': :'shapeName',
    'mysql_version': :'mysqlVersion',
    'backup_policy': :'backupPolicy',
    'source': :'source',
    'configuration_id': :'configurationId',
    'data_storage_size_in_gbs': :'dataStorageSizeInGBs',
    'data_storage': :'dataStorage',
    'hostname_label': :'hostnameLabel',
    'ip_address': :'ipAddress',
    'port': :'port',
    'port_x': :'portX',
    'endpoints': :'endpoints',
    'channels': :'channels',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'maintenance': :'maintenance',
    'deletion_policy': :'deletionPolicy',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags',
    'crash_recovery': :'crashRecovery',
    'point_in_time_recovery_details': :'pointInTimeRecoveryDetails',
    'database_management': :'databaseManagement',
    'secure_connections': :'secureConnections',
    'database_mode': :'databaseMode',
    'access_mode': :'accessMode',
    'customer_contacts': :'customerContacts',
    'read_endpoint': :'readEndpoint'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'description': :'String',
    'compartment_id': :'String',
    'subnet_id': :'String',
    'nsg_ids': :'Array<String>',
    'rest': :'OCI::Mysql::Models::RestDetails',
    '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',
    'shape_name': :'String',
    'mysql_version': :'String',
    'backup_policy': :'OCI::Mysql::Models::BackupPolicy',
    'source': :'OCI::Mysql::Models::DbSystemSource',
    'configuration_id': :'String',
    'data_storage_size_in_gbs': :'Integer',
    'data_storage': :'OCI::Mysql::Models::DataStorage',
    'hostname_label': :'String',
    'ip_address': :'String',
    'port': :'Integer',
    'port_x': :'Integer',
    'endpoints': :'Array<OCI::Mysql::Models::DbSystemEndpoint>',
    'channels': :'Array<OCI::Mysql::Models::ChannelSummary>',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'maintenance': :'OCI::Mysql::Models::MaintenanceDetails',
    'deletion_policy': :'OCI::Mysql::Models::DeletionPolicyDetails',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'Hash<String, Hash<String, Object>>',
    'crash_recovery': :'String',
    'point_in_time_recovery_details': :'OCI::Mysql::Models::PointInTimeRecoveryDetails',
    'database_management': :'String',
    'secure_connections': :'OCI::Mysql::Models::SecureConnectionDetails',
    'database_mode': :'String',
    'access_mode': :'String',
    'customer_contacts': :'Array<OCI::Mysql::Models::CustomerContact>',
    'read_endpoint': :'OCI::Mysql::Models::ReadEndpointDetails'
    # 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



733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
 
# File 'lib/oci/mysql/models/db_system.rb', line 733

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 &&
    subnet_id == other.subnet_id &&
    nsg_ids == other.nsg_ids &&
    rest == other.rest &&
    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 &&
    shape_name == other.shape_name &&
    mysql_version == other.mysql_version &&
    backup_policy == other.backup_policy &&
    source == other.source &&
    configuration_id == other.configuration_id &&
    data_storage_size_in_gbs == other.data_storage_size_in_gbs &&
    data_storage == other.data_storage &&
    hostname_label == other.hostname_label &&
    ip_address == other.ip_address &&
    port == other.port &&
    port_x == other.port_x &&
    endpoints == other.endpoints &&
    channels == other.channels &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    maintenance == other.maintenance &&
    deletion_policy == other.deletion_policy &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags &&
    crash_recovery == other.crash_recovery &&
    point_in_time_recovery_details == other.point_in_time_recovery_details &&
    database_management == other.database_management &&
    secure_connections == other.secure_connections &&
    database_mode == other.database_mode &&
    access_mode == other.access_mode &&
    customer_contacts == other.customer_contacts &&
    read_endpoint == other.read_endpoint
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



805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
 
# File 'lib/oci/mysql/models/db_system.rb', line 805

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


785
786
787
 
# File 'lib/oci/mysql/models/db_system.rb', line 785

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



794
795
796
 
# File 'lib/oci/mysql/models/db_system.rb', line 794

def hash
  [id, display_name, description, compartment_id, subnet_id, nsg_ids, rest, is_highly_available, current_placement, is_heat_wave_cluster_attached, heat_wave_cluster, availability_domain, fault_domain, shape_name, mysql_version, backup_policy, source, configuration_id, data_storage_size_in_gbs, data_storage, hostname_label, ip_address, port, port_x, endpoints, channels, lifecycle_state, lifecycle_details, maintenance, deletion_policy, time_created, time_updated, freeform_tags, defined_tags, system_tags, crash_recovery, point_in_time_recovery_details, database_management, secure_connections, database_mode, access_mode, customer_contacts, read_endpoint].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



838
839
840
841
842
843
844
845
846
847
 
# File 'lib/oci/mysql/models/db_system.rb', line 838

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



832
833
834
 
# File 'lib/oci/mysql/models/db_system.rb', line 832

def to_s
  to_hash.to_s
end