oci 2.0.5 → 2.0.6

data/lib/oci/core/models/attach_boot_volume_details.rb

@@ -4,7 +4,7 @@ require 'date'
 
 module OCI
   class Core::Models::AttachBootVolumeDetails
-    # The OCID of the  boot volume.
+    # **[Required]** The OCID of the  boot volume.
     # @return [String]
     attr_accessor :boot_volume_id
 
@@ -13,13 +13,16 @@ module OCI
     # @return [String]
     attr_accessor :display_name
 
-    # The OCID of the instance.
+    # **[Required]** The OCID of the instance.
     # @return [String]
     attr_accessor :instance_id
 
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [String] :bootVolumeId The value to assign to the {#boot_volume_id} property
+    # @option attributes [String] :displayName The value to assign to the {#display_name} property
+    # @option attributes [String] :instanceId The value to assign to the {#instance_id} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

data/lib/oci/core/models/attach_i_scsi_volume_details.rb

@@ -12,6 +12,10 @@ module OCI
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [String] :displayName The value to assign to the {OCI::Core::Models::AttachVolumeDetails#display_name #display_name} proprety
+    # @option attributes [String] :instanceId The value to assign to the {OCI::Core::Models::AttachVolumeDetails#instance_id #instance_id} proprety
+    # @option attributes [String] :volumeId The value to assign to the {OCI::Core::Models::AttachVolumeDetails#volume_id #volume_id} proprety
+    # @option attributes [BOOLEAN] :useChap The value to assign to the {#use_chap} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 
@@ -22,7 +26,7 @@ module OCI
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
 
-      if attributes[:'useChap']
+      unless attributes[:'useChap'].nil?
         self.use_chap = attributes[:'useChap']
       end
 

data/lib/oci/core/models/attach_vnic_details.rb

@@ -4,7 +4,7 @@ require 'date'
 
 module OCI
   class Core::Models::AttachVnicDetails
-    # Details for creating a new VNIC.
+    # **[Required]** Details for creating a new VNIC.
     # 
     # @return [OCI::Core::Models::CreateVnicDetails]
     attr_accessor :create_vnic_details
@@ -14,7 +14,7 @@ module OCI
     # @return [String]
     attr_accessor :display_name
 
-    # The OCID of the instance.
+    # **[Required]** The OCID of the instance.
     # @return [String]
     attr_accessor :instance_id
 
@@ -30,6 +30,10 @@ module OCI
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [OCI::Core::Models::CreateVnicDetails] :createVnicDetails The value to assign to the {#create_vnic_details} property
+    # @option attributes [String] :displayName The value to assign to the {#display_name} property
+    # @option attributes [String] :instanceId The value to assign to the {#instance_id} property
+    # @option attributes [Integer] :nicIndex The value to assign to the {#nic_index} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

data/lib/oci/core/models/attach_volume_details.rb

@@ -3,21 +3,22 @@
 require 'date'
 
 module OCI
+  # This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class
   class Core::Models::AttachVolumeDetails
     # A user-friendly name. Does not have to be unique, and it cannot be changed. Avoid entering confidential information.
     # 
     # @return [String]
     attr_accessor :display_name
 
-    # The OCID of the instance.
+    # **[Required]** The OCID of the instance.
     # @return [String]
     attr_accessor :instance_id
 
-    # The type of volume. The only supported value is \"iscsi\".
+    # **[Required]** The type of volume. The only supported value is \"iscsi\".
     # @return [String]
     attr_accessor :type
 
-    # The OCID of the volume.
+    # **[Required]** The OCID of the volume.
     # @return [String]
     attr_accessor :volume_id
 
@@ -35,6 +36,10 @@ module OCI
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [String] :displayName The value to assign to the {#display_name} property
+    # @option attributes [String] :instanceId The value to assign to the {#instance_id} property
+    # @option attributes [String] :type The value to assign to the {#type} property
+    # @option attributes [String] :volumeId The value to assign to the {#volume_id} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

data/lib/oci/core/models/boot_volume.rb

@@ -3,6 +3,13 @@
 require 'date'
 
 module OCI
+  # A detachable boot volume device that contains the image used to boot an Compute instance. For more information, see
+  # [Overview of Boot Volumes](https://docs.us-phoenix-1.oraclecloud.com/Content/Block/Concepts/bootvolumes.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 Core::Models::BootVolume
 
     LIFECYCLE_STATE_ENUM = [LIFECYCLE_STATE_PROVISIONING = 'PROVISIONING',
@@ -13,14 +20,14 @@ module OCI
                 LIFECYCLE_STATE_FAULTY = 'FAULTY',
                 LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE']
 
-    # The Availability Domain of the boot volume.
+    # **[Required]** The Availability Domain of the boot volume.
     # 
     # Example: `Uocm:PHX-AD-1`
     # 
     # @return [String]
     attr_accessor :availability_domain
 
-    # The OCID of the compartment that contains the boot volume.
+    # **[Required]** The OCID of the compartment that contains the boot volume.
     # @return [String]
     attr_accessor :compartment_id
 
@@ -30,7 +37,7 @@ module OCI
     # @return [String]
     attr_accessor :display_name
 
-    # The boot volume's Oracle ID (OCID).
+    # **[Required]** The boot volume's Oracle ID (OCID).
     # @return [String]
     attr_accessor :id
 
@@ -38,7 +45,7 @@ module OCI
     # @return [String]
     attr_accessor :image_id
 
-    # The current state of a boot volume.
+    # **[Required]** The current state of a boot volume.
     # @return [String]
     attr_accessor :lifecycle_state
 
@@ -46,19 +53,28 @@ module OCI
     # @return [Integer]
     attr_accessor :size_in_gbs
 
-    # The size of the volume in MBs. The value must be a multiple of 1024.
+    # **[Required]** The size of the volume in MBs. The value must be a multiple of 1024.
     # This field is deprecated. Please use sizeInGBs.
     # 
     # @return [Integer]
     attr_accessor :size_in_mbs
 
-    # The date and time the boot volume was created. Format defined by RFC3339.
+    # **[Required]** The date and time the boot volume was created. Format defined by RFC3339.
     # @return [DateTime]
     attr_accessor :time_created
 
 
     # 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] :compartmentId The value to assign to the {#compartment_id} property
+    # @option attributes [String] :displayName The value to assign to the {#display_name} property
+    # @option attributes [String] :id The value to assign to the {#id} property
+    # @option attributes [String] :imageId The value to assign to the {#image_id} property
+    # @option attributes [String] :lifecycleState The value to assign to the {#lifecycle_state} property
+    # @option attributes [Integer] :sizeInGBs The value to assign to the {#size_in_gbs} property
+    # @option attributes [Integer] :sizeInMBs The value to assign to the {#size_in_mbs} property
+    # @option attributes [DateTime] :timeCreated The value to assign to the {#time_created} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

data/lib/oci/core/models/boot_volume_attachment.rb

@@ -3,6 +3,8 @@
 require 'date'
 
 module OCI
+  # Represents an attachment between a boot volume and an instance.
+  #
   class Core::Models::BootVolumeAttachment
 
     LIFECYCLE_STATE_ENUM = [LIFECYCLE_STATE_ATTACHING = 'ATTACHING',
@@ -11,18 +13,18 @@ module OCI
                 LIFECYCLE_STATE_DETACHED = 'DETACHED',
                 LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE']
 
-    # The Availability Domain of an instance.
+    # **[Required]** The Availability Domain of an instance.
     # 
     # Example: `Uocm:PHX-AD-1`
     # 
     # @return [String]
     attr_accessor :availability_domain
 
-    # The OCID of the boot volume.
+    # **[Required]** The OCID of the boot volume.
     # @return [String]
     attr_accessor :boot_volume_id
 
-    # The OCID of the compartment.
+    # **[Required]** The OCID of the compartment.
     # @return [String]
     attr_accessor :compartment_id
 
@@ -34,19 +36,19 @@ module OCI
     # @return [String]
     attr_accessor :display_name
 
-    # The OCID of the boot volume attachment.
+    # **[Required]** The OCID of the boot volume attachment.
     # @return [String]
     attr_accessor :id
 
-    # The OCID of the instance the boot volume is attached to.
+    # **[Required]** The OCID of the instance the boot volume is attached to.
     # @return [String]
     attr_accessor :instance_id
 
-    # The current state of the boot volume attachment.
+    # **[Required]** The current state of the boot volume attachment.
     # @return [String]
     attr_accessor :lifecycle_state
 
-    # The date and time the boot volume was created, in the format defined by RFC3339.
+    # **[Required]** The date and time the boot volume was created, in the format defined by RFC3339.
     # 
     # Example: `2016-08-25T21:10:29.600Z`
     # 
@@ -56,6 +58,14 @@ 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] :bootVolumeId The value to assign to the {#boot_volume_id} property
+    # @option attributes [String] :compartmentId The value to assign to the {#compartment_id} property
+    # @option attributes [String] :displayName The value to assign to the {#display_name} property
+    # @option attributes [String] :id The value to assign to the {#id} property
+    # @option attributes [String] :instanceId The value to assign to the {#instance_id} property
+    # @option attributes [String] :lifecycleState The value to assign to the {#lifecycle_state} property
+    # @option attributes [DateTime] :timeCreated The value to assign to the {#time_created} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

data/lib/oci/core/models/bulk_add_virtual_circuit_public_prefixes_details.rb

@@ -4,13 +4,14 @@ require 'date'
 
 module OCI
   class Core::Models::BulkAddVirtualCircuitPublicPrefixesDetails
-    # The public IP prefixes (CIDRs) to add to the public virtual circuit.
+    # **[Required]** The public IP prefixes (CIDRs) to add to the public virtual circuit.
     # @return [Array<OCI::Core::Models::CreateVirtualCircuitPublicPrefixDetails>]
     attr_accessor :public_prefixes
 
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [Array<OCI::Core::Models::CreateVirtualCircuitPublicPrefixDetails>] :publicPrefixes The value to assign to the {#public_prefixes} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

data/lib/oci/core/models/bulk_delete_virtual_circuit_public_prefixes_details.rb

@@ -4,13 +4,14 @@ require 'date'
 
 module OCI
   class Core::Models::BulkDeleteVirtualCircuitPublicPrefixesDetails
-    # The public IP prefixes (CIDRs) to remove from the public virtual circuit.
+    # **[Required]** The public IP prefixes (CIDRs) to remove from the public virtual circuit.
     # @return [Array<OCI::Core::Models::DeleteVirtualCircuitPublicPrefixDetails>]
     attr_accessor :public_prefixes
 
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [Array<OCI::Core::Models::DeleteVirtualCircuitPublicPrefixDetails>] :publicPrefixes The value to assign to the {#public_prefixes} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

data/lib/oci/core/models/capture_console_history_details.rb

@@ -26,13 +26,17 @@ module OCI
     # @return [Hash<String, String>]
     attr_accessor :freeform_tags
 
-    # The OCID of the instance to get the console history from.
+    # **[Required]** The OCID of the instance to get the console history from.
     # @return [String]
     attr_accessor :instance_id
 
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [Hash<String, Hash<String, Object>>] :definedTags The value to assign to the {#defined_tags} property
+    # @option attributes [String] :displayName The value to assign to the {#display_name} property
+    # @option attributes [Hash<String, String>] :freeformTags The value to assign to the {#freeform_tags} property
+    # @option attributes [String] :instanceId The value to assign to the {#instance_id} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

data/lib/oci/core/models/connect_local_peering_gateways_details.rb

@@ -3,14 +3,16 @@
 require 'date'
 
 module OCI
+  # Information about the other local peering gateway (LPG).
   class Core::Models::ConnectLocalPeeringGatewaysDetails
-    # The OCID of the LPG you want to peer with.
+    # **[Required]** The OCID of the LPG you want to peer with.
     # @return [String]
     attr_accessor :peer_id
 
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [String] :peerId The value to assign to the {#peer_id} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

data/lib/oci/core/models/console_history.rb

@@ -3,6 +3,10 @@
 require 'date'
 
 module OCI
+  # An instance's serial console data. It includes configuration messages that occur when the
+  # instance boots, such as kernel and BIOS messages, and is useful for checking the status of
+  # the instance or diagnosing problems. The console data is minimally formatted ASCII text.
+  #
   class Core::Models::ConsoleHistory
 
     LIFECYCLE_STATE_ENUM = [LIFECYCLE_STATE_REQUESTED = 'REQUESTED',
@@ -11,14 +15,14 @@ module OCI
                 LIFECYCLE_STATE_FAILED = 'FAILED',
                 LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE']
 
-    # The Availability Domain of an instance.
+    # **[Required]** The Availability Domain of an instance.
     # 
     # Example: `Uocm:PHX-AD-1`
     # 
     # @return [String]
     attr_accessor :availability_domain
 
-    # The OCID of the compartment.
+    # **[Required]** The OCID of the compartment.
     # @return [String]
     attr_accessor :compartment_id
 
@@ -47,19 +51,19 @@ module OCI
     # @return [Hash<String, String>]
     attr_accessor :freeform_tags
 
-    # The OCID of the console history metadata object.
+    # **[Required]** The OCID of the console history metadata object.
     # @return [String]
     attr_accessor :id
 
-    # The OCID of the instance this console history was fetched from.
+    # **[Required]** The OCID of the instance this console history was fetched from.
     # @return [String]
     attr_accessor :instance_id
 
-    # The current state of the console history.
+    # **[Required]** The current state of the console history.
     # @return [String]
     attr_accessor :lifecycle_state
 
-    # The date and time the history was created, in the format defined by RFC3339.
+    # **[Required]** The date and time the history was created, in the format defined by RFC3339.
     # Example: `2016-08-25T21:10:29.600Z`
     # 
     # @return [DateTime]
@@ -68,6 +72,15 @@ 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] :compartmentId The value to assign to the {#compartment_id} property
+    # @option attributes [Hash<String, Hash<String, Object>>] :definedTags The value to assign to the {#defined_tags} property
+    # @option attributes [String] :displayName The value to assign to the {#display_name} property
+    # @option attributes [Hash<String, String>] :freeformTags The value to assign to the {#freeform_tags} property
+    # @option attributes [String] :id The value to assign to the {#id} property
+    # @option attributes [String] :instanceId The value to assign to the {#instance_id} property
+    # @option attributes [String] :lifecycleState The value to assign to the {#lifecycle_state} property
+    # @option attributes [DateTime] :timeCreated The value to assign to the {#time_created} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

data/lib/oci/core/models/cpe.rb

@@ -3,8 +3,18 @@
 require 'date'
 
 module OCI
+  # An object you create when setting up an IPSec VPN between your on-premises network
+  # and VCN. The `Cpe` is a virtual representation of your Customer-Premises Equipment,
+  # which is the actual router on-premises at your site at your end of the IPSec VPN connection.
+  # For more information,
+  # see [Overview of the Networking Service](https://docs.us-phoenix-1.oraclecloud.com/Content/Network/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).
+  #
   class Core::Models::Cpe
-    # The OCID of the compartment containing the CPE.
+    # **[Required]** The OCID of the compartment containing the CPE.
     # @return [String]
     attr_accessor :compartment_id
 
@@ -14,11 +24,11 @@ module OCI
     # @return [String]
     attr_accessor :display_name
 
-    # The CPE's Oracle ID (OCID).
+    # **[Required]** The CPE's Oracle ID (OCID).
     # @return [String]
     attr_accessor :id
 
-    # The public IP address of the on-premises router.
+    # **[Required]** The public IP address of the on-premises router.
     # @return [String]
     attr_accessor :ip_address
 
@@ -32,6 +42,11 @@ module OCI
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [String] :compartmentId The value to assign to the {#compartment_id} property
+    # @option attributes [String] :displayName The value to assign to the {#display_name} property
+    # @option attributes [String] :id The value to assign to the {#id} property
+    # @option attributes [String] :ipAddress The value to assign to the {#ip_address} property
+    # @option attributes [DateTime] :timeCreated The value to assign to the {#time_created} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

data/lib/oci/core/models/create_cpe_details.rb

@@ -4,7 +4,7 @@ require 'date'
 
 module OCI
   class Core::Models::CreateCpeDetails
-    # The OCID of the compartment to contain the CPE.
+    # **[Required]** The OCID of the compartment to contain the CPE.
     # @return [String]
     attr_accessor :compartment_id
 
@@ -12,7 +12,7 @@ module OCI
     # @return [String]
     attr_accessor :display_name
 
-    # The public IP address of the on-premises router.
+    # **[Required]** The public IP address of the on-premises router.
     # 
     # Example: `143.19.23.16`
     # 
@@ -22,6 +22,9 @@ module OCI
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [String] :compartmentId The value to assign to the {#compartment_id} property
+    # @option attributes [String] :displayName The value to assign to the {#display_name} property
+    # @option attributes [String] :ipAddress The value to assign to the {#ip_address} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)