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



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
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
 
# File 'lib/oci/mysql/models/db_system.rb', line 469

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

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

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

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

  self.database_console = attributes[:'databaseConsole'] if attributes[:'databaseConsole']

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

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

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

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

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

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

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

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

  self.ipv6_address_ipv6_subnet_cidr_pair_details = attributes[:'ipv6AddressIpv6SubnetCidrPairDetails'] if attributes[:'ipv6AddressIpv6SubnetCidrPairDetails']

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

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

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

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

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

  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']

  self.telemetry_configuration = attributes[:'telemetryConfiguration'] if attributes[:'telemetryConfiguration']

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

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


282
283
284
 
# File 'lib/oci/mysql/models/db_system.rb', line 282

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) 


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

def availability_domain
  @availability_domain
end

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

Returns:



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

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:



201
202
203
 
# File 'lib/oci/mysql/models/db_system.rb', line 201

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) 


148
149
150
 
# File 'lib/oci/mysql/models/db_system.rb', line 148

def configuration_id
  @configuration_id
end

#controlled_update ⇒ OCI::Mysql::Models::ControlledUpdate

Returns:



138
139
140
 
# File 'lib/oci/mysql/models/db_system.rb', line 138

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


249
250
251
 
# File 'lib/oci/mysql/models/db_system.rb', line 249

def crash_recovery
  @crash_recovery
end

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

Returns:



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

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:



289
290
291
 
# File 'lib/oci/mysql/models/db_system.rb', line 289

def customer_contacts
  @customer_contacts
end

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

This attribute is required.

Returns:



158
159
160
 
# File 'lib/oci/mysql/models/db_system.rb', line 158

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) 


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

def data_storage_size_in_gbs
  @data_storage_size_in_gbs
end

#database_console ⇒ OCI::Mysql::Models::DatabaseConsoleDetails

Returns:



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

def database_console
  @database_console
end

#database_management ⇒ String

Whether to enable monitoring via the Database Management service.

Returns:

  • (String) 


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

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) 


272
273
274
 
# File 'lib/oci/mysql/models/db_system.rb', line 272

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


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

def defined_tags
  @defined_tags
end

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

This attribute is required.

Returns:



217
218
219
 
# File 'lib/oci/mysql/models/db_system.rb', line 217

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

#encrypt_data ⇒ OCI::Mysql::Models::EncryptDataDetails

Returns:



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

def encrypt_data
  @encrypt_data
end

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

The network endpoints available for this DB System.

Returns:



197
198
199
 
# File 'lib/oci/mysql/models/db_system.rb', line 197

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) 


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

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


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

def freeform_tags
  @freeform_tags
end

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

Returns:



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

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) 


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

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) 


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

def ip_address
  @ip_address
end

#ipv6_address_ipv6_subnet_cidr_pair_details ⇒ OCI::Mysql::Models::Ipv6AddressIpv6SubnetCidrPairDetails

Returns:



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

def ipv6_address_ipv6_subnet_cidr_pair_details
  @ipv6_address_ipv6_subnet_cidr_pair_details
end

#is_heat_wave_cluster_attached ⇒ BOOLEAN

If the DB System has a HeatWave Cluster attached.

Returns:

  • (BOOLEAN) 


97
98
99
 
# File 'lib/oci/mysql/models/db_system.rb', line 97

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) 


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

def is_highly_available
  @is_highly_available
end

#is_ipv6_enabled ⇒ BOOLEAN

Whether an IPv6 address has been allocated for the DB system when attached to an IPv6 enabled subnet. Default: False.

Returns:

  • (BOOLEAN) 


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

def is_ipv6_enabled
  @is_ipv6_enabled
end

#lifecycle_details ⇒ String

Additional information about the current lifecycleState.

Returns:

  • (String) 


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

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the DB System.

Returns:

  • (String) 


205
206
207
 
# File 'lib/oci/mysql/models/db_system.rb', line 205

def lifecycle_state
  @lifecycle_state
end

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

This attribute is required.

Returns:



213
214
215
 
# File 'lib/oci/mysql/models/db_system.rb', line 213

def maintenance
  @maintenance
end

#mysql_version ⇒ String

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

Returns:

  • (String) 


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

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:



252
253
254
 
# File 'lib/oci/mysql/models/db_system.rb', line 252

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) 


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

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) 


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

def port_x
  @port_x
end

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

Returns:



292
293
294
 
# File 'lib/oci/mysql/models/db_system.rb', line 292

def read_endpoint
  @read_endpoint
end

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

Returns:



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

def rest
  @rest
end

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

Returns:



260
261
262
 
# File 'lib/oci/mysql/models/db_system.rb', line 260

def secure_connections
  @secure_connections
end

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

Security Attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see ZPR Artifacts. Example: {\"Oracle-ZPR\": {\"MaxEgressCount\": {\"value\": \"42\", \"mode\": \"audit\"}}}

Returns:

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


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

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


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

def shape_name
  @shape_name
end

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

Returns:



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

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


243
244
245
 
# File 'lib/oci/mysql/models/db_system.rb', line 243

def system_tags
  @system_tags
end

#telemetry_configuration ⇒ OCI::Mysql::Models::TelemetryConfigurationDetails

Returns:



295
296
297
 
# File 'lib/oci/mysql/models/db_system.rb', line 295

def telemetry_configuration
  @telemetry_configuration
end

#time_created ⇒ DateTime

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

Returns:

  • (DateTime) 


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

def time_created
  @time_created
end

#time_updated ⇒ DateTime

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

Returns:

  • (DateTime) 


225
226
227
 
# File 'lib/oci/mysql/models/db_system.rb', line 225

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



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/db_system.rb', line 298

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'description': :'description',
    'compartment_id': :'compartmentId',
    'subnet_id': :'subnetId',
    'nsg_ids': :'nsgIds',
    'security_attributes': :'securityAttributes',
    'rest': :'rest',
    'database_console': :'databaseConsole',
    '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',
    'controlled_update': :'controlledUpdate',
    'backup_policy': :'backupPolicy',
    'source': :'source',
    'configuration_id': :'configurationId',
    'data_storage_size_in_gbs': :'dataStorageSizeInGBs',
    'data_storage': :'dataStorage',
    'hostname_label': :'hostnameLabel',
    'ip_address': :'ipAddress',
    'is_ipv6_enabled': :'isIpv6Enabled',
    'ipv6_address_ipv6_subnet_cidr_pair_details': :'ipv6AddressIpv6SubnetCidrPairDetails',
    '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',
    'encrypt_data': :'encryptData',
    'database_mode': :'databaseMode',
    'access_mode': :'accessMode',
    'customer_contacts': :'customerContacts',
    'read_endpoint': :'readEndpoint',
    'telemetry_configuration': :'telemetryConfiguration'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



356
357
358
359
360
361
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
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
 
# File 'lib/oci/mysql/models/db_system.rb', line 356

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>',
    'security_attributes': :'Hash<String, Hash<String, Object>>',
    'rest': :'OCI::Mysql::Models::RestDetails',
    'database_console': :'OCI::Mysql::Models::DatabaseConsoleDetails',
    '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',
    'controlled_update': :'OCI::Mysql::Models::ControlledUpdate',
    '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',
    'is_ipv6_enabled': :'BOOLEAN',
    'ipv6_address_ipv6_subnet_cidr_pair_details': :'OCI::Mysql::Models::Ipv6AddressIpv6SubnetCidrPairDetails',
    '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',
    'encrypt_data': :'OCI::Mysql::Models::EncryptDataDetails',
    'database_mode': :'String',
    'access_mode': :'String',
    'customer_contacts': :'Array<OCI::Mysql::Models::CustomerContact>',
    'read_endpoint': :'OCI::Mysql::Models::ReadEndpointDetails',
    'telemetry_configuration': :'OCI::Mysql::Models::TelemetryConfigurationDetails'
    # 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



826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
 
# File 'lib/oci/mysql/models/db_system.rb', line 826

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 &&
    security_attributes == other.security_attributes &&
    rest == other.rest &&
    database_console == other.database_console &&
    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 &&
    controlled_update == other.controlled_update &&
    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 &&
    is_ipv6_enabled == other.is_ipv6_enabled &&
    ipv6_address_ipv6_subnet_cidr_pair_details == other.ipv6_address_ipv6_subnet_cidr_pair_details &&
    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 &&
    encrypt_data == other.encrypt_data &&
    database_mode == other.database_mode &&
    access_mode == other.access_mode &&
    customer_contacts == other.customer_contacts &&
    read_endpoint == other.read_endpoint &&
    telemetry_configuration == other.telemetry_configuration
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



905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
 
# File 'lib/oci/mysql/models/db_system.rb', line 905

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


885
886
887
 
# File 'lib/oci/mysql/models/db_system.rb', line 885

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



894
895
896
 
# File 'lib/oci/mysql/models/db_system.rb', line 894

def hash
  [id, display_name, description, compartment_id, subnet_id, nsg_ids, security_attributes, rest, database_console, is_highly_available, current_placement, is_heat_wave_cluster_attached, heat_wave_cluster, availability_domain, fault_domain, shape_name, mysql_version, controlled_update, backup_policy, source, configuration_id, data_storage_size_in_gbs, data_storage, hostname_label, ip_address, is_ipv6_enabled, ipv6_address_ipv6_subnet_cidr_pair_details, 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, encrypt_data, database_mode, access_mode, customer_contacts, read_endpoint, telemetry_configuration].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



938
939
940
941
942
943
944
945
946
947
 
# File 'lib/oci/mysql/models/db_system.rb', line 938

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



932
933
934
 
# File 'lib/oci/mysql/models/db_system.rb', line 932

def to_s
  to_hash.to_s
end