Class: OCI::Database::Models::AutonomousDatabaseSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/database/models/autonomous_database_summary.rb

Overview

An Oracle Autonomous Database.

Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Constant Summary collapse

LIFECYCLE_STATE_ENUM =
[
  LIFECYCLE_STATE_PROVISIONING = 'PROVISIONING'.freeze,
  LIFECYCLE_STATE_AVAILABLE = 'AVAILABLE'.freeze,
  LIFECYCLE_STATE_STOPPING = 'STOPPING'.freeze,
  LIFECYCLE_STATE_STOPPED = 'STOPPED'.freeze,
  LIFECYCLE_STATE_STARTING = 'STARTING'.freeze,
  LIFECYCLE_STATE_TERMINATING = 'TERMINATING'.freeze,
  LIFECYCLE_STATE_TERMINATED = 'TERMINATED'.freeze,
  LIFECYCLE_STATE_UNAVAILABLE = 'UNAVAILABLE'.freeze,
  LIFECYCLE_STATE_RESTORE_IN_PROGRESS = 'RESTORE_IN_PROGRESS'.freeze,
  LIFECYCLE_STATE_RESTORE_FAILED = 'RESTORE_FAILED'.freeze,
  LIFECYCLE_STATE_BACKUP_IN_PROGRESS = 'BACKUP_IN_PROGRESS'.freeze,
  LIFECYCLE_STATE_SCALE_IN_PROGRESS = 'SCALE_IN_PROGRESS'.freeze,
  LIFECYCLE_STATE_AVAILABLE_NEEDS_ATTENTION = 'AVAILABLE_NEEDS_ATTENTION'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_MAINTENANCE_IN_PROGRESS = 'MAINTENANCE_IN_PROGRESS'.freeze,
  LIFECYCLE_STATE_RESTARTING = 'RESTARTING'.freeze,
  LIFECYCLE_STATE_UPGRADING = 'UPGRADING'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LICENSE_MODEL_ENUM =
[
  LICENSE_MODEL_LICENSE_INCLUDED = 'LICENSE_INCLUDED'.freeze,
  LICENSE_MODEL_BRING_YOUR_OWN_LICENSE = 'BRING_YOUR_OWN_LICENSE'.freeze,
  LICENSE_MODEL_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
DB_WORKLOAD_ENUM =
[
  DB_WORKLOAD_OLTP = 'OLTP'.freeze,
  DB_WORKLOAD_DW = 'DW'.freeze,
  DB_WORKLOAD_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
DATA_SAFE_STATUS_ENUM =
[
  DATA_SAFE_STATUS_REGISTERING = 'REGISTERING'.freeze,
  DATA_SAFE_STATUS_REGISTERED = 'REGISTERED'.freeze,
  DATA_SAFE_STATUS_DEREGISTERING = 'DEREGISTERING'.freeze,
  DATA_SAFE_STATUS_NOT_REGISTERED = 'NOT_REGISTERED'.freeze,
  DATA_SAFE_STATUS_FAILED = 'FAILED'.freeze,
  DATA_SAFE_STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AutonomousDatabaseSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
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
# File 'lib/oci/database/models/autonomous_database_summary.rb', line 366

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

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

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

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

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

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

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

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

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

  self.time_deletion_of_free_autonomous_database = attributes[:'timeDeletionOfFreeAutonomousDatabase'] if attributes[:'timeDeletionOfFreeAutonomousDatabase']

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

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

  self.cpu_core_count = attributes[:'cpuCoreCount'] if attributes[:'cpuCoreCount']

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

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

  self.data_storage_size_in_tbs = attributes[:'dataStorageSizeInTBs'] if attributes[:'dataStorageSizeInTBs']

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

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

  self.is_dedicated = attributes[:'isDedicated'] unless attributes[:'isDedicated'].nil?

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

  self.is_dedicated = attributes[:'is_dedicated'] unless attributes[:'is_dedicated'].nil?

  self.autonomous_container_database_id = attributes[:'autonomousContainerDatabaseId'] if attributes[:'autonomousContainerDatabaseId']

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

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

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

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

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

  self.connection_strings = attributes[:'connectionStrings'] if attributes[:'connectionStrings']

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

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

  self.connection_urls = attributes[:'connectionUrls'] if attributes[:'connectionUrls']

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

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

  self.license_model = attributes[:'licenseModel'] if attributes[:'licenseModel']

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

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

  self.used_data_storage_size_in_tbs = attributes[:'usedDataStorageSizeInTBs'] if attributes[:'usedDataStorageSizeInTBs']

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

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

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

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

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

  self.private_endpoint_label = attributes[:'privateEndpointLabel'] if attributes[:'privateEndpointLabel']

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

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

  self.private_endpoint_ip = attributes[:'privateEndpointIp'] if attributes[:'privateEndpointIp']

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

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

  self.db_version = attributes[:'dbVersion'] if attributes[:'dbVersion']

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

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

  self.is_preview = attributes[:'isPreview'] unless attributes[:'isPreview'].nil?

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

  self.is_preview = attributes[:'is_preview'] unless attributes[:'is_preview'].nil?

  self.db_workload = attributes[:'dbWorkload'] if attributes[:'dbWorkload']

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

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

  self.whitelisted_ips = attributes[:'whitelistedIps'] if attributes[:'whitelistedIps']

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

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

  self.is_auto_scaling_enabled = attributes[:'isAutoScalingEnabled'] unless attributes[:'isAutoScalingEnabled'].nil?

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

  self.is_auto_scaling_enabled = attributes[:'is_auto_scaling_enabled'] unless attributes[:'is_auto_scaling_enabled'].nil?

  self.data_safe_status = attributes[:'dataSafeStatus'] if attributes[:'dataSafeStatus']

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

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

  self.time_maintenance_begin = attributes[:'timeMaintenanceBegin'] if attributes[:'timeMaintenanceBegin']

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

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

  self.time_maintenance_end = attributes[:'timeMaintenanceEnd'] if attributes[:'timeMaintenanceEnd']

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

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

  self.available_upgrade_versions = attributes[:'availableUpgradeVersions'] if attributes[:'availableUpgradeVersions']

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

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

Instance Attribute Details

#autonomous_container_database_idString

The Autonomous Container Database OCID.

Returns:

  • (String)


112
113
114
# File 'lib/oci/database/models/autonomous_database_summary.rb', line 112

def autonomous_container_database_id
  @autonomous_container_database_id
end

#available_upgrade_versionsArray<String>

List of Oracle Database versions available for a database upgrade. If there are no version upgrades available, this list is empty.

Returns:

  • (Array<String>)


234
235
236
# File 'lib/oci/database/models/autonomous_database_summary.rb', line 234

def available_upgrade_versions
  @available_upgrade_versions
end

#compartment_idString

[Required] The OCID of the compartment.

Returns:

  • (String)


62
63
64
# File 'lib/oci/database/models/autonomous_database_summary.rb', line 62

def compartment_id
  @compartment_id
end

#connection_stringsOCI::Database::Models::AutonomousDatabaseConnectionStrings

The connection string used to connect to the Autonomous Database. The username for the Service Console is ADMIN. Use the password you entered when creating the Autonomous Database for the password value.



128
129
130
# File 'lib/oci/database/models/autonomous_database_summary.rb', line 128

def connection_strings
  @connection_strings
end

#connection_urlsOCI::Database::Models::AutonomousDatabaseConnectionUrls



131
132
133
# File 'lib/oci/database/models/autonomous_database_summary.rb', line 131

def connection_urls
  @connection_urls
end

#cpu_core_countInteger

[Required] The number of OCPU cores to be made available to the database.

Returns:

  • (Integer)


99
100
101
# File 'lib/oci/database/models/autonomous_database_summary.rb', line 99

def cpu_core_count
  @cpu_core_count
end

#data_safe_statusString

Status of the Data Safe registration for this Autonomous Database.

Returns:

  • (String)


222
223
224
# File 'lib/oci/database/models/autonomous_database_summary.rb', line 222

def data_safe_status
  @data_safe_status
end

#data_storage_size_in_tbsInteger

[Required] The quantity of data in the database, in terabytes.

Returns:

  • (Integer)


103
104
105
# File 'lib/oci/database/models/autonomous_database_summary.rb', line 103

def data_storage_size_in_tbs
  @data_storage_size_in_tbs
end

#db_nameString

[Required] The database name.

Returns:

  • (String)


74
75
76
# File 'lib/oci/database/models/autonomous_database_summary.rb', line 74

def db_name
  @db_name
end

#db_versionString

A valid Oracle Database version for Autonomous Database.

Returns:

  • (String)


192
193
194
# File 'lib/oci/database/models/autonomous_database_summary.rb', line 192

def db_version
  @db_version
end

#db_workloadString

The Autonomous Database workload type. The following values are valid:

  • OLTP - indicates an Autonomous Transaction Processing database

  • DW - indicates an Autonomous Data Warehouse database

Returns:

  • (String)


204
205
206
# File 'lib/oci/database/models/autonomous_database_summary.rb', line 204

def db_workload
  @db_workload
end

#defined_tagsHash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Returns:

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


155
156
157
# File 'lib/oci/database/models/autonomous_database_summary.rb', line 155

def defined_tags
  @defined_tags
end

#display_nameString

The user-friendly name for the Autonomous Database. The name does not have to be unique.

Returns:

  • (String)


120
121
122
# File 'lib/oci/database/models/autonomous_database_summary.rb', line 120

def display_name
  @display_name
end

#freeform_tagsHash<String, String>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>)


149
150
151
# File 'lib/oci/database/models/autonomous_database_summary.rb', line 149

def freeform_tags
  @freeform_tags
end

#idString

[Required] The OCID of the Autonomous Database.

Returns:

  • (String)


58
59
60
# File 'lib/oci/database/models/autonomous_database_summary.rb', line 58

def id
  @id
end

#is_auto_scaling_enabledBOOLEAN

Indicates if auto scaling is enabled for the Autonomous Database CPU core count. Note that auto scaling is available for databases on shared Exadata infrastructure only.

Returns:

  • (BOOLEAN)


218
219
220
# File 'lib/oci/database/models/autonomous_database_summary.rb', line 218

def is_auto_scaling_enabled
  @is_auto_scaling_enabled
end

#is_dedicatedBOOLEAN

True if the database uses dedicated Exadata infrastructure.

Returns:

  • (BOOLEAN)


108
109
110
# File 'lib/oci/database/models/autonomous_database_summary.rb', line 108

def is_dedicated
  @is_dedicated
end

#is_free_tierBOOLEAN

Indicates if this is an Always Free resource. The default value is false. Note that Always Free Autonomous Databases have 1 CPU and 20GB of memory. For Always Free databases, memory and CPU cannot be scaled.

Returns:

  • (BOOLEAN)


79
80
81
# File 'lib/oci/database/models/autonomous_database_summary.rb', line 79

def is_free_tier
  @is_free_tier
end

#is_previewBOOLEAN

Indicates if the Autonomous Database version is a preview version.

Returns:

  • (BOOLEAN)


196
197
198
# File 'lib/oci/database/models/autonomous_database_summary.rb', line 196

def is_preview
  @is_preview
end

#license_modelString

The Oracle license model that applies to the Oracle Autonomous Database. Note that when provisioning an Autonomous Database on dedicated Exadata infrastructure, this attribute must be null because the attribute is already set at the Autonomous Exadata Infrastructure level. When using shared Exadata infrastructure, if a value is not specified, the system will supply the value of BRING_YOUR_OWN_LICENSE.

Returns:

  • (String)


137
138
139
# File 'lib/oci/database/models/autonomous_database_summary.rb', line 137

def license_model
  @license_model
end

#lifecycle_detailsString

Information about the current lifecycle state.

Returns:

  • (String)


70
71
72
# File 'lib/oci/database/models/autonomous_database_summary.rb', line 70

def lifecycle_details
  @lifecycle_details
end

#lifecycle_stateString

[Required] The current state of the Autonomous Database.

Returns:

  • (String)


66
67
68
# File 'lib/oci/database/models/autonomous_database_summary.rb', line 66

def lifecycle_state
  @lifecycle_state
end

#nsg_idsArray<String>

A list of the OCIDs of the network security groups (NSGs) that this resource belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see Security Rules. NsgIds restrictions: - Autonomous Databases with private access require at least 1 Network Security Group (NSG). The nsgIds array cannot be empty.

Returns:

  • (Array<String>)


176
177
178
# File 'lib/oci/database/models/autonomous_database_summary.rb', line 176

def nsg_ids
  @nsg_ids
end

#private_endpointString

The private endpoint for the resource.

Returns:

  • (String)


180
181
182
# File 'lib/oci/database/models/autonomous_database_summary.rb', line 180

def private_endpoint
  @private_endpoint
end

#private_endpoint_ipString

The private endpoint Ip address for the resource.

Returns:

  • (String)


188
189
190
# File 'lib/oci/database/models/autonomous_database_summary.rb', line 188

def private_endpoint_ip
  @private_endpoint_ip
end

#private_endpoint_labelString

The private endpoint label for the resource.

Returns:

  • (String)


184
185
186
# File 'lib/oci/database/models/autonomous_database_summary.rb', line 184

def private_endpoint_label
  @private_endpoint_label
end

#service_console_urlString

The URL of the Service Console for the Autonomous Database.

Returns:

  • (String)


124
125
126
# File 'lib/oci/database/models/autonomous_database_summary.rb', line 124

def service_console_url
  @service_console_url
end

#subnet_idString

The OCID of the subnet the resource is associated with.

Subnet Restrictions: - For bare metal DB systems and for single node virtual machine DB systems, do not use a subnet that overlaps with 192.168.16.16/28. - For Exadata and virtual machine 2-node RAC DB systems, do not use a subnet that overlaps with 192.168.128.0/20. - For Autonomous Database, setting this will disable public secure access to the database.

These subnets are used by the Oracle Clusterware private interconnect on the database instance. Specifying an overlapping subnet will cause the private interconnect to malfunction. This restriction applies to both the client subnet and the backup subnet.

Returns:

  • (String)


169
170
171
# File 'lib/oci/database/models/autonomous_database_summary.rb', line 169

def subnet_id
  @subnet_id
end

#system_tagsHash<String, Hash<String, Object>>

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Returns:

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


85
86
87
# File 'lib/oci/database/models/autonomous_database_summary.rb', line 85

def system_tags
  @system_tags
end

#time_createdDateTime

The date and time the Autonomous Database was created.

Returns:

  • (DateTime)


116
117
118
# File 'lib/oci/database/models/autonomous_database_summary.rb', line 116

def time_created
  @time_created
end

#time_deletion_of_free_autonomous_databaseDateTime

The date and time the Always Free database will be automatically deleted because of inactivity. If the database is in the STOPPED state and without activity until this time, it will be deleted.

Returns:

  • (DateTime)


95
96
97
# File 'lib/oci/database/models/autonomous_database_summary.rb', line 95

def time_deletion_of_free_autonomous_database
  @time_deletion_of_free_autonomous_database
end

#time_maintenance_beginDateTime

The date and time when maintenance will begin.

Returns:

  • (DateTime)


226
227
228
# File 'lib/oci/database/models/autonomous_database_summary.rb', line 226

def time_maintenance_begin
  @time_maintenance_begin
end

#time_maintenance_endDateTime

The date and time when maintenance will end.

Returns:

  • (DateTime)


230
231
232
# File 'lib/oci/database/models/autonomous_database_summary.rb', line 230

def time_maintenance_end
  @time_maintenance_end
end

#time_reclamation_of_free_autonomous_databaseDateTime

The date and time the Always Free database will be stopped because of inactivity. If this time is reached without any database activity, the database will automatically be put into the STOPPED state.

Returns:

  • (DateTime)


90
91
92
# File 'lib/oci/database/models/autonomous_database_summary.rb', line 90

def time_reclamation_of_free_autonomous_database
  @time_reclamation_of_free_autonomous_database
end

#used_data_storage_size_in_tbsInteger

The amount of storage that has been used, in terabytes.

Returns:

  • (Integer)


141
142
143
# File 'lib/oci/database/models/autonomous_database_summary.rb', line 141

def used_data_storage_size_in_tbs
  @used_data_storage_size_in_tbs
end

#whitelisted_ipsArray<String>

The client IP access control list (ACL). This feature is available for databases on shared Exadata infrastructure only. Only clients connecting from an IP address included in the ACL may access the Autonomous Database instance. This is an array of CIDR (Classless Inter-Domain Routing) notations for a subnet or VCN OCID.

To add the whitelist VCN specific subnet or IP, use a semicoln ';' as a deliminator to add the VCN specific subnets or IPs. Example: [\"1.1.1.1\",\"1.1.1.0/24\",\"ocid1.vcn.oc1.sea.aaaaaaaard2hfx2nn3e5xeo6j6o62jga44xjizkw\",\"ocid1.vcn.oc1.sea.aaaaaaaard2hfx2nn3e5xeo6j6o62jga44xjizkw;1.1.1.1\",\"ocid1.vcn.oc1.sea.aaaaaaaard2hfx2nn3e5xeo6j6o62jga44xjizkw;1.1.0.0/16\"]

Returns:

  • (Array<String>)


213
214
215
# File 'lib/oci/database/models/autonomous_database_summary.rb', line 213

def whitelisted_ips
  @whitelisted_ips
end

Class Method Details

.attribute_mapObject

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



237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
# File 'lib/oci/database/models/autonomous_database_summary.rb', line 237

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'db_name': :'dbName',
    'is_free_tier': :'isFreeTier',
    'system_tags': :'systemTags',
    'time_reclamation_of_free_autonomous_database': :'timeReclamationOfFreeAutonomousDatabase',
    'time_deletion_of_free_autonomous_database': :'timeDeletionOfFreeAutonomousDatabase',
    'cpu_core_count': :'cpuCoreCount',
    'data_storage_size_in_tbs': :'dataStorageSizeInTBs',
    'is_dedicated': :'isDedicated',
    'autonomous_container_database_id': :'autonomousContainerDatabaseId',
    'time_created': :'timeCreated',
    'display_name': :'displayName',
    'service_console_url': :'serviceConsoleUrl',
    'connection_strings': :'connectionStrings',
    'connection_urls': :'connectionUrls',
    'license_model': :'licenseModel',
    'used_data_storage_size_in_tbs': :'usedDataStorageSizeInTBs',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'subnet_id': :'subnetId',
    'nsg_ids': :'nsgIds',
    'private_endpoint': :'privateEndpoint',
    'private_endpoint_label': :'privateEndpointLabel',
    'private_endpoint_ip': :'privateEndpointIp',
    'db_version': :'dbVersion',
    'is_preview': :'isPreview',
    'db_workload': :'dbWorkload',
    'whitelisted_ips': :'whitelistedIps',
    'is_auto_scaling_enabled': :'isAutoScalingEnabled',
    'data_safe_status': :'dataSafeStatus',
    'time_maintenance_begin': :'timeMaintenanceBegin',
    'time_maintenance_end': :'timeMaintenanceEnd',
    'available_upgrade_versions': :'availableUpgradeVersions'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
# File 'lib/oci/database/models/autonomous_database_summary.rb', line 281

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'db_name': :'String',
    'is_free_tier': :'BOOLEAN',
    'system_tags': :'Hash<String, Hash<String, Object>>',
    'time_reclamation_of_free_autonomous_database': :'DateTime',
    'time_deletion_of_free_autonomous_database': :'DateTime',
    'cpu_core_count': :'Integer',
    'data_storage_size_in_tbs': :'Integer',
    'is_dedicated': :'BOOLEAN',
    'autonomous_container_database_id': :'String',
    'time_created': :'DateTime',
    'display_name': :'String',
    'service_console_url': :'String',
    'connection_strings': :'OCI::Database::Models::AutonomousDatabaseConnectionStrings',
    'connection_urls': :'OCI::Database::Models::AutonomousDatabaseConnectionUrls',
    'license_model': :'String',
    'used_data_storage_size_in_tbs': :'Integer',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'subnet_id': :'String',
    'nsg_ids': :'Array<String>',
    'private_endpoint': :'String',
    'private_endpoint_label': :'String',
    'private_endpoint_ip': :'String',
    'db_version': :'String',
    'is_preview': :'BOOLEAN',
    'db_workload': :'String',
    'whitelisted_ips': :'Array<String>',
    'is_auto_scaling_enabled': :'BOOLEAN',
    'data_safe_status': :'String',
    'time_maintenance_begin': :'DateTime',
    'time_maintenance_end': :'DateTime',
    'available_upgrade_versions': :'Array<String>'
    # 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



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
# File 'lib/oci/database/models/autonomous_database_summary.rb', line 646

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

  self.class == other.class &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    db_name == other.db_name &&
    is_free_tier == other.is_free_tier &&
    system_tags == other.system_tags &&
    time_reclamation_of_free_autonomous_database == other.time_reclamation_of_free_autonomous_database &&
    time_deletion_of_free_autonomous_database == other.time_deletion_of_free_autonomous_database &&
    cpu_core_count == other.cpu_core_count &&
    data_storage_size_in_tbs == other.data_storage_size_in_tbs &&
    is_dedicated == other.is_dedicated &&
    autonomous_container_database_id == other.autonomous_container_database_id &&
    time_created == other.time_created &&
    display_name == other.display_name &&
    service_console_url == other.service_console_url &&
    connection_strings == other.connection_strings &&
    connection_urls == other.connection_urls &&
    license_model == other.license_model &&
    used_data_storage_size_in_tbs == other.used_data_storage_size_in_tbs &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    subnet_id == other.subnet_id &&
    nsg_ids == other.nsg_ids &&
    private_endpoint == other.private_endpoint &&
    private_endpoint_label == other.private_endpoint_label &&
    private_endpoint_ip == other.private_endpoint_ip &&
    db_version == other.db_version &&
    is_preview == other.is_preview &&
    db_workload == other.db_workload &&
    whitelisted_ips == other.whitelisted_ips &&
    is_auto_scaling_enabled == other.is_auto_scaling_enabled &&
    data_safe_status == other.data_safe_status &&
    time_maintenance_begin == other.time_maintenance_begin &&
    time_maintenance_end == other.time_maintenance_end &&
    available_upgrade_versions == other.available_upgrade_versions
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



711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
# File 'lib/oci/database/models/autonomous_database_summary.rb', line 711

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


691
692
693
# File 'lib/oci/database/models/autonomous_database_summary.rb', line 691

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



700
701
702
# File 'lib/oci/database/models/autonomous_database_summary.rb', line 700

def hash
  [id, compartment_id, lifecycle_state, lifecycle_details, db_name, is_free_tier, system_tags, time_reclamation_of_free_autonomous_database, time_deletion_of_free_autonomous_database, cpu_core_count, data_storage_size_in_tbs, is_dedicated, autonomous_container_database_id, time_created, display_name, service_console_url, connection_strings, connection_urls, license_model, used_data_storage_size_in_tbs, freeform_tags, defined_tags, subnet_id, nsg_ids, private_endpoint, private_endpoint_label, private_endpoint_ip, db_version, is_preview, db_workload, whitelisted_ips, is_auto_scaling_enabled, data_safe_status, time_maintenance_begin, time_maintenance_end, available_upgrade_versions].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



744
745
746
747
748
749
750
751
752
753
# File 'lib/oci/database/models/autonomous_database_summary.rb', line 744

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



738
739
740
# File 'lib/oci/database/models/autonomous_database_summary.rb', line 738

def to_s
  to_hash.to_s
end