Class: OCI::Mysql::Models::CreateDbSystemDetails

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

Overview

Details required to create a DB System.

Constant Summary collapse

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateDbSystemDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
412
413
414
415
416
417
418
419
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
 
# File 'lib/oci/mysql/models/create_db_system_details.rb', line 378

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.display_name = attributes[:'displayName'] if attributes[:'displayName']

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

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

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

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

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

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

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

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

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

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

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

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

  self.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?

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

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

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

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

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

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

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

  self.deletion_policy = attributes[:'deletionPolicy'] if attributes[:'deletionPolicy']

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

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

  self.crash_recovery = attributes[:'crashRecovery'] if attributes[:'crashRecovery']
  self.crash_recovery = "ENABLED" if crash_recovery.nil? && !attributes.key?(:'crashRecovery') # rubocop:disable Style/StringLiterals

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

  self.crash_recovery = attributes[:'crash_recovery'] if attributes[:'crash_recovery']
  self.crash_recovery = "ENABLED" if crash_recovery.nil? && !attributes.key?(:'crashRecovery') && !attributes.key?(:'crash_recovery') # rubocop:disable Style/StringLiterals

  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']
  self.database_mode = "READ_WRITE" if database_mode.nil? && !attributes.key?(:'databaseMode') # rubocop:disable Style/StringLiterals

  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.database_mode = "READ_WRITE" if database_mode.nil? && !attributes.key?(:'databaseMode') && !attributes.key?(:'database_mode') # rubocop:disable Style/StringLiterals

  self.access_mode = attributes[:'accessMode'] if attributes[:'accessMode']
  self.access_mode = "UNRESTRICTED" if access_mode.nil? && !attributes.key?(:'accessMode') # rubocop:disable Style/StringLiterals

  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.access_mode = "UNRESTRICTED" if access_mode.nil? && !attributes.key?(:'accessMode') && !attributes.key?(:'access_mode') # rubocop:disable Style/StringLiterals

  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

The access mode indicating if the database access will be restricted only to administrators or not: - UNRESTRICTED (default): the access to the database is not restricted; - RESTRICTED: the access will be allowed only to users with specific privileges; RESTRICTED will correspond to setting the MySQL system variable offline_mode to ON.

Returns:

  • (String) 


224
225
226
 
# File 'lib/oci/mysql/models/create_db_system_details.rb', line 224

def access_mode
  @access_mode
end

#admin_password ⇒ String

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

Returns:

  • (String) 


115
116
117
 
# File 'lib/oci/mysql/models/create_db_system_details.rb', line 115

def admin_password
  @admin_password
end

#admin_username ⇒ String

The username for the administrative user.

Returns:

  • (String) 


107
108
109
 
# File 'lib/oci/mysql/models/create_db_system_details.rb', line 107

def admin_username
  @admin_username
end

#availability_domain ⇒ String

The availability domain on which to deploy the Read/Write endpoint. This defines the preferred primary instance.

In a failover scenario, the Read/Write endpoint is redirected to one of the other availability domains and the MySQL instance in that domain is promoted to the primary instance. This redirection does not affect the IP address of the DB System in any way.

For a standalone DB System, this defines the availability domain in which the DB System is placed.

Returns:

  • (String) 


60
61
62
 
# File 'lib/oci/mysql/models/create_db_system_details.rb', line 60

def availability_domain
  @availability_domain
end

#backup_policy ⇒ OCI::Mysql::Models::CreateBackupPolicyDetails

Returns:



168
169
170
 
# File 'lib/oci/mysql/models/create_db_system_details.rb', line 168

def backup_policy
  @backup_policy
end

#compartment_id ⇒ String

[Required] The OCID of the compartment.

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/mysql/models/create_db_system_details.rb', line 32

def compartment_id
  @compartment_id
end

#configuration_id ⇒ String

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

Returns:

  • (String) 


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

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) 


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

def crash_recovery
  @crash_recovery
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:



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

def customer_contacts
  @customer_contacts
end

#data_storage ⇒ OCI::Mysql::Models::DataStorageDetails

Returns:



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

def data_storage
  @data_storage
end

#data_storage_size_in_gbs ⇒ Integer

Initial size of the data volume in GBs that will be created and attached. Keep in mind that this only specifies the size of the database data volume, the log volume for the database will be scaled appropriately with its shape.

Returns:

  • (Integer) 


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

def data_storage_size_in_gbs
  @data_storage_size_in_gbs
end

#database_console ⇒ OCI::Mysql::Models::CreateDatabaseConsoleDetails

Returns:



38
39
40
 
# File 'lib/oci/mysql/models/create_db_system_details.rb', line 38

def database_console
  @database_console
end

#database_management ⇒ String

Whether to enable monitoring via the Database Management service.

Returns:

  • (String) 


200
201
202
 
# File 'lib/oci/mysql/models/create_db_system_details.rb', line 200

def database_management
  @database_management
end

#database_mode ⇒ String

The database mode indicating the types of statements that will be allowed to run in the DB system. This mode will apply only to statements run by user connections. Replicated write statements will continue to be allowed regardless of the DatabaseMode. - READ_WRITE (default): allow running read and write statements on the DB system; - READ_ONLY: only allow running read statements on the DB system.

Returns:

  • (String) 


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

def database_mode
  @database_mode
end

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

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

Returns:

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


186
187
188
 
# File 'lib/oci/mysql/models/create_db_system_details.rb', line 186

def defined_tags
  @defined_tags
end

#deletion_policy ⇒ OCI::Mysql::Models::CreateDeletionPolicyDetails

Returns:



189
190
191
 
# File 'lib/oci/mysql/models/create_db_system_details.rb', line 189

def deletion_policy
  @deletion_policy
end

#description ⇒ String

User-provided data about the DB System.

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/mysql/models/create_db_system_details.rb', line 28

def description
  @description
end

#display_name ⇒ String

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

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/mysql/models/create_db_system_details.rb', line 24

def display_name
  @display_name
end

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

Returns:



206
207
208
 
# File 'lib/oci/mysql/models/create_db_system_details.rb', line 206

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


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

def fault_domain
  @fault_domain
end

#freeform_tags ⇒ Hash<String, String>

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

Returns:

  • (Hash<String, String>) 


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

def freeform_tags
  @freeform_tags
end

#hostname_label ⇒ String

The hostname for the primary endpoint of the DB System. Used for DNS.

The value is the hostname portion of the primary private IP's fully qualified domain name (FQDN) (for example, "dbsystem-1" in FQDN "dbsystem-1.subnet123.vcn1.oraclevcn.com").

Must be unique across all VNICs in the subnet and comply with RFC 952 and RFC 1123.

Returns:

  • (String) 


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

def hostname_label
  @hostname_label
end

#ip_address ⇒ String

The IP address the DB System is configured to listen on. A private IP address of your choice to assign to the primary endpoint of the DB System. Must be an available IP address within the subnet's CIDR. If you don't specify a value, Oracle automatically assigns a private IP address from the subnet. This should be a "dotted-quad" style IPv4 address.

Returns:

  • (String) 


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

def ip_address
  @ip_address
end

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

Returns:



156
157
158
 
# File 'lib/oci/mysql/models/create_db_system_details.rb', line 156

def ipv6_address_ipv6_subnet_cidr_pair_details
  @ipv6_address_ipv6_subnet_cidr_pair_details
end

#is_highly_available ⇒ BOOLEAN

Specifies if the DB System is highly available.

When creating a DB System with High Availability, three instances are created and placed according to your region- and subnet-type. The secondaries are placed automatically in the other two availability or fault domains. You can choose the preferred location of your primary instance, only.

Returns:

  • (BOOLEAN) 


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

def is_highly_available
  @is_highly_available
end

#is_ipv6_enabled ⇒ BOOLEAN

Whether to allocate an IPv6 address at DB system creation from an IPv6 enabled subnet. When provided you may optionally provide an IPv6 prefix (ipv6AddressIpv6SubnetCidrPairDetails) of your choice to assign the IPv6 address from. If ipv6AddressIpv6SubnetCidrPairDetails is not provided then an IPv6 prefix is chosen for you.

Returns:

  • (BOOLEAN) 


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

def is_ipv6_enabled
  @is_ipv6_enabled
end

#maintenance ⇒ OCI::Mysql::Models::CreateMaintenanceDetails

Returns:



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

def maintenance
  @maintenance
end

#mysql_version ⇒ String

The specific MySQL version identifier.

Returns:

  • (String) 


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

def mysql_version
  @mysql_version
end

#nsg_ids ⇒ Array<String>

Network Security Group OCIDs used for the VNIC attachment.

Returns:

  • (Array<String>) 


96
97
98
 
# File 'lib/oci/mysql/models/create_db_system_details.rb', line 96

def nsg_ids
  @nsg_ids
end

#port ⇒ Integer

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

Returns:

  • (Integer) 


160
161
162
 
# File 'lib/oci/mysql/models/create_db_system_details.rb', line 160

def port
  @port
end

#port_x ⇒ Integer

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

Returns:

  • (Integer) 


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

def port_x
  @port_x
end

#read_endpoint ⇒ OCI::Mysql::Models::CreateReadEndpointDetails

Returns:



234
235
236
 
# File 'lib/oci/mysql/models/create_db_system_details.rb', line 234

def read_endpoint
  @read_endpoint
end

#rest ⇒ OCI::Mysql::Models::CreateRestDetails

Returns:



35
36
37
 
# File 'lib/oci/mysql/models/create_db_system_details.rb', line 35

def rest
  @rest
end

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

Returns:



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

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


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

def security_attributes
  @security_attributes
end

#shape_name ⇒ String

[Required] The name of the shape. The shape determines the resources allocated - 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) 


83
84
85
 
# File 'lib/oci/mysql/models/create_db_system_details.rb', line 83

def shape_name
  @shape_name
end

#source ⇒ OCI::Mysql::Models::CreateDbSystemSourceDetails

Returns:



171
172
173
 
# File 'lib/oci/mysql/models/create_db_system_details.rb', line 171

def source
  @source
end

#subnet_id ⇒ String

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

Returns:

  • (String) 


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

def subnet_id
  @subnet_id
end

#telemetry_configuration ⇒ OCI::Mysql::Models::CreateTelemetryConfigurationDetails

Returns:



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

def telemetry_configuration
  @telemetry_configuration
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'description': :'description',
    'compartment_id': :'compartmentId',
    'rest': :'rest',
    'database_console': :'databaseConsole',
    'is_highly_available': :'isHighlyAvailable',
    'availability_domain': :'availabilityDomain',
    'fault_domain': :'faultDomain',
    'configuration_id': :'configurationId',
    'shape_name': :'shapeName',
    'mysql_version': :'mysqlVersion',
    'subnet_id': :'subnetId',
    'nsg_ids': :'nsgIds',
    'security_attributes': :'securityAttributes',
    'admin_username': :'adminUsername',
    'admin_password': :'adminPassword',
    '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',
    'backup_policy': :'backupPolicy',
    'source': :'source',
    'maintenance': :'maintenance',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'deletion_policy': :'deletionPolicy',
    'crash_recovery': :'crashRecovery',
    '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.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'description': :'String',
    'compartment_id': :'String',
    'rest': :'OCI::Mysql::Models::CreateRestDetails',
    'database_console': :'OCI::Mysql::Models::CreateDatabaseConsoleDetails',
    'is_highly_available': :'BOOLEAN',
    'availability_domain': :'String',
    'fault_domain': :'String',
    'configuration_id': :'String',
    'shape_name': :'String',
    'mysql_version': :'String',
    'subnet_id': :'String',
    'nsg_ids': :'Array<String>',
    'security_attributes': :'Hash<String, Hash<String, Object>>',
    'admin_username': :'String',
    'admin_password': :'String',
    'data_storage_size_in_gbs': :'Integer',
    'data_storage': :'OCI::Mysql::Models::DataStorageDetails',
    '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',
    'backup_policy': :'OCI::Mysql::Models::CreateBackupPolicyDetails',
    'source': :'OCI::Mysql::Models::CreateDbSystemSourceDetails',
    'maintenance': :'OCI::Mysql::Models::CreateMaintenanceDetails',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'deletion_policy': :'OCI::Mysql::Models::CreateDeletionPolicyDetails',
    'crash_recovery': :'String',
    '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::CreateReadEndpointDetails',
    'telemetry_configuration': :'OCI::Mysql::Models::CreateTelemetryConfigurationDetails'
    # 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



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

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

  self.class == other.class &&
    display_name == other.display_name &&
    description == other.description &&
    compartment_id == other.compartment_id &&
    rest == other.rest &&
    database_console == other.database_console &&
    is_highly_available == other.is_highly_available &&
    availability_domain == other.availability_domain &&
    fault_domain == other.fault_domain &&
    configuration_id == other.configuration_id &&
    shape_name == other.shape_name &&
    mysql_version == other.mysql_version &&
    subnet_id == other.subnet_id &&
    nsg_ids == other.nsg_ids &&
    security_attributes == other.security_attributes &&
    admin_username == other.admin_username &&
    admin_password == other.admin_password &&
    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 &&
    backup_policy == other.backup_policy &&
    source == other.source &&
    maintenance == other.maintenance &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    deletion_policy == other.deletion_policy &&
    crash_recovery == other.crash_recovery &&
    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



700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
 
# File 'lib/oci/mysql/models/create_db_system_details.rb', line 700

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


680
681
682
 
# File 'lib/oci/mysql/models/create_db_system_details.rb', line 680

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



689
690
691
 
# File 'lib/oci/mysql/models/create_db_system_details.rb', line 689

def hash
  [display_name, description, compartment_id, rest, database_console, is_highly_available, availability_domain, fault_domain, configuration_id, shape_name, mysql_version, subnet_id, nsg_ids, security_attributes, admin_username, admin_password, data_storage_size_in_gbs, data_storage, hostname_label, ip_address, is_ipv6_enabled, ipv6_address_ipv6_subnet_cidr_pair_details, port, port_x, backup_policy, source, maintenance, freeform_tags, defined_tags, deletion_policy, crash_recovery, 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



733
734
735
736
737
738
739
740
741
742
 
# File 'lib/oci/mysql/models/create_db_system_details.rb', line 733

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



727
728
729
 
# File 'lib/oci/mysql/models/create_db_system_details.rb', line 727

def to_s
  to_hash.to_s
end