oci 2.0.5 → 2.0.6

data/lib/oci/database/models/db_system_shape_summary.rb

@@ -3,12 +3,18 @@
 require 'date'
 
 module OCI
+  # The shape of the DB System. The shape determines resources to allocate to the DB system - CPU cores and memory for VM shapes; CPU cores, memory and storage for non-VM (or bare metal) shapes.
+  # For a description of shapes, see [DB System Launch Options](https://docs.us-phoenix-1.oraclecloud.com/Content/Database/References/launchoptions.htm).
+  # To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator.
+  # If you're an administrator who needs to write policies to give users access,
+  # see [Getting Started with Policies](https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm).
+  #
   class Database::Models::DbSystemShapeSummary
-    # The maximum number of CPU cores that can be enabled on the DB System.
+    # **[Required]** The maximum number of CPU cores that can be enabled on the DB System.
     # @return [Integer]
     attr_accessor :available_core_count
 
-    # The name of the shape used for the DB System.
+    # **[Required]** The name of the shape used for the DB System.
     # @return [String]
     attr_accessor :name
 
@@ -19,6 +25,9 @@ module OCI
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [Integer] :availableCoreCount The value to assign to the {#available_core_count} property
+    # @option attributes [String] :name The value to assign to the {#name} property
+    # @option attributes [String] :shape The value to assign to the {#shape} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

data/lib/oci/database/models/db_system_summary.rb

@@ -3,6 +3,22 @@
 require 'date'
 
 module OCI
+  # The Database Service supports several types of DB Systems, ranging in size, price, and performance. For details about each type of system, see:
+  #
+  # - [Exadata DB Systems](https://docs.us-phoenix-1.oraclecloud.com/Content/Database/Concepts/exaoverview.htm)
+  # - [Bare Metal or VM DB Systems](https://docs.us-phoenix-1.oraclecloud.com/Content/Database/Concepts/overview.htm)
+  #
+  # To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see [Getting Started with Policies](https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm).
+  #
+  # For information about access control and compartments, see
+  # [Overview of the Identity Service](https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/overview.htm).
+  #
+  # For information about Availability Domains, see
+  # [Regions and Availability Domains](https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm).
+  #
+  # To get a list of Availability Domains, use the `ListAvailabilityDomains` operation
+  # in the Identity Service API.
+  #
   class Database::Models::DbSystemSummary
 
     DATABASE_EDITION_ENUM = [DATABASE_EDITION_STANDARD_EDITION = 'STANDARD_EDITION',
@@ -30,7 +46,7 @@ module OCI
                 LIFECYCLE_STATE_FAILED = 'FAILED',
                 LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE']
 
-    # The name of the Availability Domain that the DB System is located in.
+    # **[Required]** The name of the Availability Domain that the DB System is located in.
     # @return [String]
     attr_accessor :availability_domain
 
@@ -47,11 +63,11 @@ module OCI
     # @return [String]
     attr_accessor :cluster_name
 
-    # The OCID of the compartment.
+    # **[Required]** The OCID of the compartment.
     # @return [String]
     attr_accessor :compartment_id
 
-    # The number of CPU cores enabled on the DB System.
+    # **[Required]** The number of CPU cores enabled on the DB System.
     # @return [Integer]
     attr_accessor :cpu_core_count
 
@@ -66,7 +82,7 @@ module OCI
     # @return [Integer]
     attr_accessor :data_storage_size_in_gbs
 
-    # The Oracle Database Edition that applies to all the databases on the DB System.
+    # **[Required]** The Oracle Database Edition that applies to all the databases on the DB System.
     # 
     # @return [String]
     attr_accessor :database_edition
@@ -78,19 +94,19 @@ module OCI
     # @return [String]
     attr_accessor :disk_redundancy
 
-    # The user-friendly name for the DB System. It does not have to be unique.
+    # **[Required]** The user-friendly name for the DB System. It does not have to be unique.
     # @return [String]
     attr_accessor :display_name
 
-    # The domain name for the DB System.
+    # **[Required]** The domain name for the DB System.
     # @return [String]
     attr_accessor :domain
 
-    # The host name for the DB Node.
+    # **[Required]** The host name for the DB Node.
     # @return [String]
     attr_accessor :hostname
 
-    # The OCID of the DB System.
+    # **[Required]** The OCID of the DB System.
     # @return [String]
     attr_accessor :id
 
@@ -107,7 +123,7 @@ module OCI
     # @return [String]
     attr_accessor :lifecycle_details
 
-    # The current state of the DB System.
+    # **[Required]** The current state of the DB System.
     # @return [String]
     attr_accessor :lifecycle_state
 
@@ -139,15 +155,15 @@ module OCI
     # @return [Array<String>]
     attr_accessor :scan_ip_ids
 
-    # The shape of the DB System. The shape determines resources to allocate to the DB system - CPU cores and memory for VM shapes; CPU cores, memory and storage for non-VM (or bare metal) shapes.
+    # **[Required]** The shape of the DB System. The shape determines resources to allocate to the DB system - CPU cores and memory for VM shapes; CPU cores, memory and storage for non-VM (or bare metal) shapes.
     # @return [String]
     attr_accessor :shape
 
-    # The public key portion of one or more key pairs used for SSH access to the DB System.
+    # **[Required]** The public key portion of one or more key pairs used for SSH access to the DB System.
     # @return [Array<String>]
     attr_accessor :ssh_public_keys
 
-    # The OCID of the subnet the DB System is associated with.
+    # **[Required]** The OCID of the subnet the DB System is associated with.
     # 
     # **Subnet Restrictions:**
     # - For single node and 2-node (RAC) DB Systems, do not use a subnet that overlaps with 192.168.16.16/28
@@ -180,6 +196,34 @@ module OCI
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [String] :availabilityDomain The value to assign to the {#availability_domain} property
+    # @option attributes [String] :backupSubnetId The value to assign to the {#backup_subnet_id} property
+    # @option attributes [String] :clusterName The value to assign to the {#cluster_name} property
+    # @option attributes [String] :compartmentId The value to assign to the {#compartment_id} property
+    # @option attributes [Integer] :cpuCoreCount The value to assign to the {#cpu_core_count} property
+    # @option attributes [Integer] :dataStoragePercentage The value to assign to the {#data_storage_percentage} property
+    # @option attributes [Integer] :dataStorageSizeInGBs The value to assign to the {#data_storage_size_in_gbs} property
+    # @option attributes [String] :databaseEdition The value to assign to the {#database_edition} property
+    # @option attributes [String] :diskRedundancy The value to assign to the {#disk_redundancy} property
+    # @option attributes [String] :displayName The value to assign to the {#display_name} property
+    # @option attributes [String] :domain The value to assign to the {#domain} property
+    # @option attributes [String] :hostname The value to assign to the {#hostname} property
+    # @option attributes [String] :id The value to assign to the {#id} property
+    # @option attributes [String] :lastPatchHistoryEntryId The value to assign to the {#last_patch_history_entry_id} property
+    # @option attributes [String] :licenseModel The value to assign to the {#license_model} property
+    # @option attributes [String] :lifecycleDetails The value to assign to the {#lifecycle_details} property
+    # @option attributes [String] :lifecycleState The value to assign to the {#lifecycle_state} property
+    # @option attributes [Integer] :listenerPort The value to assign to the {#listener_port} property
+    # @option attributes [Integer] :nodeCount The value to assign to the {#node_count} property
+    # @option attributes [Integer] :recoStorageSizeInGB The value to assign to the {#reco_storage_size_in_gb} property
+    # @option attributes [String] :scanDnsRecordId The value to assign to the {#scan_dns_record_id} property
+    # @option attributes [Array<String>] :scanIpIds The value to assign to the {#scan_ip_ids} property
+    # @option attributes [String] :shape The value to assign to the {#shape} property
+    # @option attributes [Array<String>] :sshPublicKeys The value to assign to the {#ssh_public_keys} property
+    # @option attributes [String] :subnetId The value to assign to the {#subnet_id} property
+    # @option attributes [DateTime] :timeCreated The value to assign to the {#time_created} property
+    # @option attributes [String] :version The value to assign to the {#version} property
+    # @option attributes [Array<String>] :vipIds The value to assign to the {#vip_ids} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

data/lib/oci/database/models/db_version_summary.rb

@@ -3,25 +3,31 @@
 require 'date'
 
 module OCI
+  # The Oracle database software version.
+  #
+  # To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see [Getting Started with Policies](https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm).
+  #
   class Database::Models::DbVersionSummary
     # True if this version of the Oracle database software supports pluggable dbs.
     # @return [BOOLEAN]
     attr_accessor :supports_pdb
 
-    # A valid Oracle database version.
+    # **[Required]** A valid Oracle database version.
     # @return [String]
     attr_accessor :version
 
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [BOOLEAN] :supportsPdb The value to assign to the {#supports_pdb} property
+    # @option attributes [String] :version The value to assign to the {#version} property
     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}
 
-      if attributes[:'supportsPdb']
+      unless attributes[:'supportsPdb'].nil?
         self.supports_pdb = attributes[:'supportsPdb']
       end
 

data/lib/oci/database/models/failover_data_guard_association_details.rb

@@ -3,14 +3,17 @@
 require 'date'
 
 module OCI
+  # The Data Guard association failover parameters.
+  #
   class Database::Models::FailoverDataGuardAssociationDetails
-    # The DB System administrator password.
+    # **[Required]** The DB System administrator password.
     # @return [String]
     attr_accessor :database_admin_password
 
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [String] :databaseAdminPassword The value to assign to the {#database_admin_password} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

data/lib/oci/database/models/launch_db_system_details.rb

@@ -18,7 +18,7 @@ module OCI
     LICENSE_MODEL_ENUM = [LICENSE_MODEL_LICENSE_INCLUDED = 'LICENSE_INCLUDED',
                 LICENSE_MODEL_BRING_YOUR_OWN_LICENSE = 'BRING_YOUR_OWN_LICENSE']
 
-    # The Availability Domain where the DB System is located.
+    # **[Required]** The Availability Domain where the DB System is located.
     # @return [String]
     attr_accessor :availability_domain
 
@@ -34,11 +34,11 @@ module OCI
     # @return [String]
     attr_accessor :cluster_name
 
-    # The Oracle Cloud ID (OCID) of the compartment the DB System  belongs in.
+    # **[Required]** The Oracle Cloud ID (OCID) of the compartment the DB System  belongs in.
     # @return [String]
     attr_accessor :compartment_id
 
-    # The number of CPU cores to enable. The valid values depend on the specified shape:
+    # **[Required]** The number of CPU cores to enable. The valid values depend on the specified shape:
     # 
     # - BM.DenseIO1.36 and BM.HighIO1.36 - Specify a multiple of 2, from 2 to 36.
     # - BM.RACLocalStorage1.72 - Specify a multiple of 4, from 4 to 72.
@@ -58,13 +58,14 @@ module OCI
     # @return [Integer]
     attr_accessor :data_storage_percentage
 
-    # The Oracle Database Edition that applies to all the databases on the DB System.
+    # **[Required]** The Oracle Database Edition that applies to all the databases on the DB System.
     # 
     # Exadata DB Systems and 2-node RAC DB Systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE.
     # 
     # @return [String]
     attr_accessor :database_edition
 
+    # This attribute is required.
     # @return [OCI::Database::Models::CreateDbHomeDetails]
     attr_accessor :db_home
 
@@ -86,7 +87,7 @@ module OCI
     # @return [String]
     attr_accessor :domain
 
-    # The host name for the DB System. The host name must begin with an alphabetic character and
+    # **[Required]** The host name for the DB System. The host name must begin with an alphabetic character and
     # can contain a maximum of 30 alphanumeric characters, including hyphens (-).
     # 
     # The maximum length of the combined hostname and domain is 63 characters.
@@ -112,15 +113,15 @@ module OCI
     # @return [Integer]
     attr_accessor :node_count
 
-    # The shape of the DB System. The shape determines resources allocated to the 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_db_system_shapes list_db_system_shapes} operation.
+    # **[Required]** The shape of the DB System. The shape determines resources allocated to the 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_db_system_shapes list_db_system_shapes} operation.
     # @return [String]
     attr_accessor :shape
 
-    # The public key portion of the key pair to use for SSH access to the DB System. Multiple public keys can be provided. The length of the combined keys cannot exceed 10,000 characters.
+    # **[Required]** The public key portion of the key pair to use for SSH access to the DB System. Multiple public keys can be provided. The length of the combined keys cannot exceed 10,000 characters.
     # @return [Array<String>]
     attr_accessor :ssh_public_keys
 
-    # The OCID of the subnet the DB System is associated with.
+    # **[Required]** The OCID of the subnet the DB System is associated with.
     # 
     # **Subnet Restrictions:**
     # - For single node and 2-node (RAC) DB Systems, do not use a subnet that overlaps with 192.168.16.16/28
@@ -136,6 +137,24 @@ module OCI
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [String] :availabilityDomain The value to assign to the {#availability_domain} property
+    # @option attributes [String] :backupSubnetId The value to assign to the {#backup_subnet_id} property
+    # @option attributes [String] :clusterName The value to assign to the {#cluster_name} property
+    # @option attributes [String] :compartmentId The value to assign to the {#compartment_id} property
+    # @option attributes [Integer] :cpuCoreCount The value to assign to the {#cpu_core_count} property
+    # @option attributes [Integer] :dataStoragePercentage The value to assign to the {#data_storage_percentage} property
+    # @option attributes [String] :databaseEdition The value to assign to the {#database_edition} property
+    # @option attributes [OCI::Database::Models::CreateDbHomeDetails] :dbHome The value to assign to the {#db_home} property
+    # @option attributes [String] :diskRedundancy The value to assign to the {#disk_redundancy} property
+    # @option attributes [String] :displayName The value to assign to the {#display_name} property
+    # @option attributes [String] :domain The value to assign to the {#domain} property
+    # @option attributes [String] :hostname The value to assign to the {#hostname} property
+    # @option attributes [Integer] :initialDataStorageSizeInGB The value to assign to the {#initial_data_storage_size_in_gb} property
+    # @option attributes [String] :licenseModel The value to assign to the {#license_model} property
+    # @option attributes [Integer] :nodeCount The value to assign to the {#node_count} property
+    # @option attributes [String] :shape The value to assign to the {#shape} property
+    # @option attributes [Array<String>] :sshPublicKeys The value to assign to the {#ssh_public_keys} property
+    # @option attributes [String] :subnetId The value to assign to the {#subnet_id} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

data/lib/oci/database/models/patch.rb

@@ -3,6 +3,12 @@
 require 'date'
 
 module OCI
+  # A Patch for a DB System or DB Home.
+  #
+  # To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized,
+  # talk to an administrator. If you're an administrator who needs to write policies to give users access,
+  # see [Getting Started with Policies](https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm).
+  #
   class Database::Models::Patch
 
     AVAILABLE_ACTIONS_ENUM = [AVAILABLE_ACTIONS_APPLY = 'APPLY',
@@ -25,11 +31,11 @@ module OCI
     # @return [Array<String>]
     attr_accessor :available_actions
 
-    # The text describing this patch package.
+    # **[Required]** The text describing this patch package.
     # @return [String]
     attr_accessor :description
 
-    # The OCID of the patch.
+    # **[Required]** The OCID of the patch.
     # @return [String]
     attr_accessor :id
 
@@ -47,17 +53,25 @@ module OCI
     # @return [String]
     attr_accessor :lifecycle_state
 
-    # The date and time that the patch was released.
+    # **[Required]** The date and time that the patch was released.
     # @return [DateTime]
     attr_accessor :time_released
 
-    # The version of this patch package.
+    # **[Required]** The version of this patch package.
     # @return [String]
     attr_accessor :version
 
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [Array<String>] :availableActions The value to assign to the {#available_actions} property
+    # @option attributes [String] :description The value to assign to the {#description} property
+    # @option attributes [String] :id The value to assign to the {#id} property
+    # @option attributes [String] :lastAction The value to assign to the {#last_action} property
+    # @option attributes [String] :lifecycleDetails The value to assign to the {#lifecycle_details} property
+    # @option attributes [String] :lifecycleState The value to assign to the {#lifecycle_state} property
+    # @option attributes [DateTime] :timeReleased The value to assign to the {#time_released} property
+    # @option attributes [String] :version The value to assign to the {#version} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

data/lib/oci/database/models/patch_details.rb

@@ -3,6 +3,10 @@
 require 'date'
 
 module OCI
+  # The details about what actions to perform and using what patch to the specified target.
+  # This is part of an update request that is applied to a version field on the target such
+  # as DB System, database home, etc.
+  #
   class Database::Models::PatchDetails
 
     ACTION_ENUM = [ACTION_APPLY = 'APPLY',
@@ -19,6 +23,8 @@ module OCI
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [String] :action The value to assign to the {#action} property
+    # @option attributes [String] :patchId The value to assign to the {#patch_id} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

data/lib/oci/database/models/patch_history_entry.rb

@@ -3,6 +3,7 @@
 require 'date'
 
 module OCI
+  # The record of a patch action on a specified target.
   class Database::Models::PatchHistoryEntry
 
     ACTION_ENUM = [ACTION_APPLY = 'APPLY',
@@ -19,7 +20,7 @@ module OCI
     # @return [String]
     attr_accessor :action
 
-    # The OCID of the patch history entry.
+    # **[Required]** The OCID of the patch history entry.
     # @return [String]
     attr_accessor :id
 
@@ -29,11 +30,11 @@ module OCI
     # @return [String]
     attr_accessor :lifecycle_details
 
-    # The current state of the action.
+    # **[Required]** The current state of the action.
     # @return [String]
     attr_accessor :lifecycle_state
 
-    # The OCID of the patch.
+    # **[Required]** The OCID of the patch.
     # @return [String]
     attr_accessor :patch_id
 
@@ -41,13 +42,20 @@ module OCI
     # @return [DateTime]
     attr_accessor :time_ended
 
-    # The date and time when the patch action started.
+    # **[Required]** The date and time when the patch action started.
     # @return [DateTime]
     attr_accessor :time_started
 
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [String] :action The value to assign to the {#action} property
+    # @option attributes [String] :id The value to assign to the {#id} property
+    # @option attributes [String] :lifecycleDetails The value to assign to the {#lifecycle_details} property
+    # @option attributes [String] :lifecycleState The value to assign to the {#lifecycle_state} property
+    # @option attributes [String] :patchId The value to assign to the {#patch_id} property
+    # @option attributes [DateTime] :timeEnded The value to assign to the {#time_ended} property
+    # @option attributes [DateTime] :timeStarted The value to assign to the {#time_started} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

data/lib/oci/database/models/patch_history_entry_summary.rb

@@ -3,6 +3,7 @@
 require 'date'
 
 module OCI
+  # The record of a patch action on a specified target.
   class Database::Models::PatchHistoryEntrySummary
 
     ACTION_ENUM = [ACTION_APPLY = 'APPLY',
@@ -19,7 +20,7 @@ module OCI
     # @return [String]
     attr_accessor :action
 
-    # The OCID of the patch history entry.
+    # **[Required]** The OCID of the patch history entry.
     # @return [String]
     attr_accessor :id
 
@@ -29,11 +30,11 @@ module OCI
     # @return [String]
     attr_accessor :lifecycle_details
 
-    # The current state of the action.
+    # **[Required]** The current state of the action.
     # @return [String]
     attr_accessor :lifecycle_state
 
-    # The OCID of the patch.
+    # **[Required]** The OCID of the patch.
     # @return [String]
     attr_accessor :patch_id
 
@@ -41,13 +42,20 @@ module OCI
     # @return [DateTime]
     attr_accessor :time_ended
 
-    # The date and time when the patch action started.
+    # **[Required]** The date and time when the patch action started.
     # @return [DateTime]
     attr_accessor :time_started
 
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [String] :action The value to assign to the {#action} property
+    # @option attributes [String] :id The value to assign to the {#id} property
+    # @option attributes [String] :lifecycleDetails The value to assign to the {#lifecycle_details} property
+    # @option attributes [String] :lifecycleState The value to assign to the {#lifecycle_state} property
+    # @option attributes [String] :patchId The value to assign to the {#patch_id} property
+    # @option attributes [DateTime] :timeEnded The value to assign to the {#time_ended} property
+    # @option attributes [DateTime] :timeStarted The value to assign to the {#time_started} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)