oci 2.0.5 → 2.0.6

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

@@ -3,6 +3,13 @@
 require 'date'
 
 module OCI
+  # A boot disk image for launching an instance. For more information, see
+  # [Overview of the Compute Service](https://docs.us-phoenix-1.oraclecloud.com/Content/Compute/Concepts/computeoverview.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::Image
 
     LAUNCH_MODE_ENUM = [LAUNCH_MODE_NATIVE = 'NATIVE',
@@ -23,12 +30,12 @@ module OCI
     # @return [String]
     attr_accessor :base_image_id
 
-    # The OCID of the compartment containing the instance you want to use as the basis for the image.
+    # **[Required]** The OCID of the compartment containing the instance you want to use as the basis for the image.
     # 
     # @return [String]
     attr_accessor :compartment_id
 
-    # Whether instances launched with this image can be used to create new images.
+    # **[Required]** Whether instances launched with this image can be used to create new images.
     # For example, you cannot create an image of an Oracle Database instance.
     # Example: `true`
     # 
@@ -61,7 +68,7 @@ module OCI
     # @return [Hash<String, String>]
     attr_accessor :freeform_tags
 
-    # The OCID of the image.
+    # **[Required]** The OCID of the image.
     # @return [String]
     attr_accessor :id
 
@@ -76,24 +83,25 @@ module OCI
     # @return [OCI::Core::Models::LaunchOptions]
     attr_accessor :launch_options
 
+    # This attribute is required.
     # @return [String]
     attr_accessor :lifecycle_state
 
-    # The image's operating system.
+    # **[Required]** The image's operating system.
     # 
     # Example: `Oracle Linux`
     # 
     # @return [String]
     attr_accessor :operating_system
 
-    # The image's operating system version.
+    # **[Required]** The image's operating system version.
     # 
     # Example: `7.2`
     # 
     # @return [String]
     attr_accessor :operating_system_version
 
-    # The date and time the image was created, in the format defined by RFC3339.
+    # **[Required]** The date and time the image was created, in the format defined by RFC3339.
     # 
     # Example: `2016-08-25T21:10:29.600Z`
     # 
@@ -103,6 +111,19 @@ module OCI
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [String] :baseImageId The value to assign to the {#base_image_id} property
+    # @option attributes [String] :compartmentId The value to assign to the {#compartment_id} property
+    # @option attributes [BOOLEAN] :createImageAllowed The value to assign to the {#create_image_allowed} 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] :launchMode The value to assign to the {#launch_mode} property
+    # @option attributes [OCI::Core::Models::LaunchOptions] :launchOptions The value to assign to the {#launch_options} property
+    # @option attributes [String] :lifecycleState The value to assign to the {#lifecycle_state} property
+    # @option attributes [String] :operatingSystem The value to assign to the {#operating_system} property
+    # @option attributes [String] :operatingSystemVersion The value to assign to the {#operating_system_version} property
+    # @option attributes [DateTime] :timeCreated The value to assign to the {#time_created} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 
@@ -117,7 +138,7 @@ module OCI
         self.compartment_id = attributes[:'compartmentId']
       end
 
-      if attributes[:'createImageAllowed']
+      unless attributes[:'createImageAllowed'].nil?
         self.create_image_allowed = attributes[:'createImageAllowed']
       end
 

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

@@ -3,6 +3,7 @@
 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::ImageSourceDetails
 
     SOURCE_IMAGE_TYPE_ENUM = [SOURCE_IMAGE_TYPE_QCOW2 = 'QCOW2',
@@ -14,7 +15,7 @@ module OCI
     # @return [String]
     attr_accessor :source_image_type
 
-    # The source type for the image. Use `objectStorageTuple` when specifying the namespace,
+    # **[Required]** The source type for the image. Use `objectStorageTuple` when specifying the namespace,
     # bucket name, and object name. Use `objectStorageUri` when specifying the Object Storage URL.
     # 
     # @return [String]
@@ -35,6 +36,8 @@ module OCI
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [String] :sourceImageType The value to assign to the {#source_image_type} property
+    # @option attributes [String] :sourceType The value to assign to the {#source_type} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

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

@@ -5,21 +5,25 @@ require_relative 'image_source_details'
 
 module OCI
   class Core::Models::ImageSourceViaObjectStorageTupleDetails < Core::Models::ImageSourceDetails
-    # The Object Storage bucket for the image.
+    # **[Required]** The Object Storage bucket for the image.
     # @return [String]
     attr_accessor :bucket_name
 
-    # The Object Storage namespace for the image.
+    # **[Required]** The Object Storage namespace for the image.
     # @return [String]
     attr_accessor :namespace_name
 
-    # The Object Storage name for the image.
+    # **[Required]** The Object Storage name for the image.
     # @return [String]
     attr_accessor :object_name
 
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [String] :sourceImageType The value to assign to the {OCI::Core::Models::ImageSourceDetails#source_image_type #source_image_type} proprety
+    # @option attributes [String] :bucketName The value to assign to the {#bucket_name} property
+    # @option attributes [String] :namespaceName The value to assign to the {#namespace_name} property
+    # @option attributes [String] :objectName The value to assign to the {#object_name} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

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

@@ -5,13 +5,15 @@ require_relative 'image_source_details'
 
 module OCI
   class Core::Models::ImageSourceViaObjectStorageUriDetails < Core::Models::ImageSourceDetails
-    # The Object Storage URL for the image.
+    # **[Required]** The Object Storage URL for the image.
     # @return [String]
     attr_accessor :source_uri
 
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [String] :sourceImageType The value to assign to the {OCI::Core::Models::ImageSourceDetails#source_image_type #source_image_type} proprety
+    # @option attributes [String] :sourceUri The value to assign to the {#source_uri} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

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

@@ -3,6 +3,7 @@
 require 'date'
 
 module OCI
+  # A rule for allowing inbound IP packets.
   class Core::Models::IngressSecurityRule
     # Optional and valid only for ICMP. Use to specify a particular ICMP type and code
     # as defined in
@@ -25,7 +26,7 @@ module OCI
     # @return [BOOLEAN]
     attr_accessor :is_stateless
 
-    # The transport protocol. Specify either `all` or an IPv4 protocol number as
+    # **[Required]** The transport protocol. Specify either `all` or an IPv4 protocol number as
     # defined in
     # [Protocol Numbers](http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml).
     # Options are supported only for ICMP (\"1\"), TCP (\"6\"), and UDP (\"17\").
@@ -33,7 +34,7 @@ module OCI
     # @return [String]
     attr_accessor :protocol
 
-    # The source CIDR block for the ingress rule. This is the range of IP addresses that a
+    # **[Required]** The source CIDR block for the ingress rule. This is the range of IP addresses that a
     # packet coming into the instance can come from.
     # 
     # @return [String]
@@ -54,6 +55,12 @@ module OCI
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [OCI::Core::Models::IcmpOptions] :icmpOptions The value to assign to the {#icmp_options} property
+    # @option attributes [BOOLEAN] :isStateless The value to assign to the {#is_stateless} property
+    # @option attributes [String] :protocol The value to assign to the {#protocol} property
+    # @option attributes [String] :source The value to assign to the {#source} property
+    # @option attributes [OCI::Core::Models::TcpOptions] :tcpOptions The value to assign to the {#tcp_options} property
+    # @option attributes [OCI::Core::Models::UdpOptions] :udpOptions The value to assign to the {#udp_options} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 
@@ -64,7 +71,7 @@ module OCI
         self.icmp_options = attributes[:'icmpOptions']
       end
 
-      if attributes[:'isStateless']
+      unless attributes[:'isStateless'].nil?
         self.is_stateless = attributes[:'isStateless']
       end
 

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

@@ -3,6 +3,15 @@
 require 'date'
 
 module OCI
+  # A compute host. The image used to launch the instance determines its operating system and other
+  # software. The shape specified during the launch process determines the number of CPUs and memory
+  # allocated to the instance. For more information, see
+  # [Overview of the Compute Service](https://docs.us-phoenix-1.oraclecloud.com/Content/Compute/Concepts/computeoverview.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::Instance
 
     LAUNCH_MODE_ENUM = [LAUNCH_MODE_NATIVE = 'NATIVE',
@@ -21,14 +30,14 @@ module OCI
                 LIFECYCLE_STATE_TERMINATED = 'TERMINATED',
                 LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE']
 
-    # The Availability Domain the instance is running in.
+    # **[Required]** The Availability Domain the instance is running in.
     # 
     # Example: `Uocm:PHX-AD-1`
     # 
     # @return [String]
     attr_accessor :availability_domain
 
-    # The OCID of the compartment that contains the instance.
+    # **[Required]** The OCID of the compartment that contains the instance.
     # @return [String]
     attr_accessor :compartment_id
 
@@ -66,7 +75,7 @@ module OCI
     # @return [Hash<String, String>]
     attr_accessor :freeform_tags
 
-    # The OCID of the instance.
+    # **[Required]** The OCID of the instance.
     # @return [String]
     attr_accessor :id
 
@@ -112,7 +121,7 @@ module OCI
     # @return [OCI::Core::Models::LaunchOptions]
     attr_accessor :launch_options
 
-    # The current state of the instance.
+    # **[Required]** The current state of the instance.
     # @return [String]
     attr_accessor :lifecycle_state
 
@@ -120,14 +129,14 @@ module OCI
     # @return [Hash<String, String>]
     attr_accessor :metadata
 
-    # The region that contains the Availability Domain the instance is running in.
+    # **[Required]** The region that contains the Availability Domain the instance is running in.
     # 
     # Example: `phx`
     # 
     # @return [String]
     attr_accessor :region
 
-    # The shape of the instance. The shape determines the number of CPUs and the amount of memory
+    # **[Required]** The shape of the instance. The shape determines the number of CPUs and the amount of memory
     # allocated to the instance. You can enumerate all available shapes by calling
     # {#list_shapes list_shapes}.
     # 
@@ -138,7 +147,7 @@ module OCI
     # @return [OCI::Core::Models::InstanceSourceDetails]
     attr_accessor :source_details
 
-    # The date and time the instance was created, in the format defined by RFC3339.
+    # **[Required]** The date and time the instance was created, in the format defined by RFC3339.
     # 
     # Example: `2016-08-25T21:10:29.600Z`
     # 
@@ -148,6 +157,23 @@ 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, Object>] :extendedMetadata The value to assign to the {#extended_metadata} 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] :imageId The value to assign to the {#image_id} property
+    # @option attributes [String] :ipxeScript The value to assign to the {#ipxe_script} property
+    # @option attributes [String] :launchMode The value to assign to the {#launch_mode} property
+    # @option attributes [OCI::Core::Models::LaunchOptions] :launchOptions The value to assign to the {#launch_options} property
+    # @option attributes [String] :lifecycleState The value to assign to the {#lifecycle_state} property
+    # @option attributes [Hash<String, String>] :metadata The value to assign to the {#metadata} property
+    # @option attributes [String] :region The value to assign to the {#region} property
+    # @option attributes [String] :shape The value to assign to the {#shape} property
+    # @option attributes [OCI::Core::Models::InstanceSourceDetails] :sourceDetails The value to assign to the {#source_details} 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/instance_console_connection.rb

@@ -3,6 +3,12 @@
 require 'date'
 
 module OCI
+  # The `InstanceConsoleConnection` API provides you with console access to virtual machine (VM) instances,
+  # enabling you to troubleshoot malfunctioning instances remotely.
+  #
+  # For more information about console access, see
+  # [Accessing the Console](https://docs.us-phoenix-1.oraclecloud.com/Content/Compute/References/serialconsole.htm).
+  #
   class Core::Models::InstanceConsoleConnection
 
     LIFECYCLE_STATE_ENUM = [LIFECYCLE_STATE_ACTIVE = 'ACTIVE',
@@ -62,6 +68,15 @@ 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] :connectionString The value to assign to the {#connection_string} property
+    # @option attributes [Hash<String, Hash<String, Object>>] :definedTags The value to assign to the {#defined_tags} property
+    # @option attributes [String] :fingerprint The value to assign to the {#fingerprint} 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 [String] :vncConnectionString The value to assign to the {#vnc_connection_string} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

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

@@ -3,18 +3,21 @@
 require 'date'
 
 module OCI
+  # The credentials for a particular instance.
   class Core::Models::InstanceCredentials
-    # The password for the username.
+    # **[Required]** The password for the username.
     # @return [String]
     attr_accessor :password
 
-    # The username.
+    # **[Required]** The username.
     # @return [String]
     attr_accessor :username
 
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [String] :password The value to assign to the {#password} property
+    # @option attributes [String] :username The value to assign to the {#username} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

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

@@ -3,8 +3,9 @@
 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::InstanceSourceDetails
-    # The source type for the instance.
+    # **[Required]** The source type for the instance.
     # Use `image` when specifying the image OCID. Use `bootVolume` when specifying
     # the boot volume OCID.
     # 
@@ -26,6 +27,7 @@ module OCI
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [String] :sourceType The value to assign to the {#source_type} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

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

@@ -5,13 +5,14 @@ require_relative 'instance_source_details'
 
 module OCI
   class Core::Models::InstanceSourceViaBootVolumeDetails < Core::Models::InstanceSourceDetails
-    # The OCID of the boot volume used to boot the instance.
+    # **[Required]** The OCID of the boot volume used to boot the instance.
     # @return [String]
     attr_accessor :boot_volume_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
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

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

@@ -5,13 +5,14 @@ require_relative 'instance_source_details'
 
 module OCI
   class Core::Models::InstanceSourceViaImageDetails < Core::Models::InstanceSourceDetails
-    # The OCID of the image used to boot the instance.
+    # **[Required]** The OCID of the image used to boot the instance.
     # @return [String]
     attr_accessor :image_id
 
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [String] :imageId The value to assign to the {#image_id} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

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

@@ -3,6 +3,14 @@
 require 'date'
 
 module OCI
+  # Represents a router that connects the edge of a VCN with the Internet. For an example scenario
+  # that uses an Internet Gateway, see
+  # [Typical Networking Service Scenarios](https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/overview.htm#scenarios).
+  #
+  # 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::InternetGateway
 
     LIFECYCLE_STATE_ENUM = [LIFECYCLE_STATE_PROVISIONING = 'PROVISIONING',
@@ -11,7 +19,7 @@ module OCI
                 LIFECYCLE_STATE_TERMINATED = 'TERMINATED',
                 LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE']
 
-    # The OCID of the compartment containing the Internet Gateway.
+    # **[Required]** The OCID of the compartment containing the Internet Gateway.
     # @return [String]
     attr_accessor :compartment_id
 
@@ -21,7 +29,7 @@ module OCI
     # @return [String]
     attr_accessor :display_name
 
-    # The Internet Gateway's Oracle ID (OCID).
+    # **[Required]** The Internet Gateway's Oracle ID (OCID).
     # @return [String]
     attr_accessor :id
 
@@ -31,7 +39,7 @@ module OCI
     # @return [BOOLEAN]
     attr_accessor :is_enabled
 
-    # The Internet Gateway's current state.
+    # **[Required]** The Internet Gateway's current state.
     # @return [String]
     attr_accessor :lifecycle_state
 
@@ -42,13 +50,20 @@ module OCI
     # @return [DateTime]
     attr_accessor :time_created
 
-    # The OCID of the VCN the Internet Gateway belongs to.
+    # **[Required]** The OCID of the VCN the Internet Gateway belongs to.
     # @return [String]
     attr_accessor :vcn_id
 
 
     # 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 [BOOLEAN] :isEnabled The value to assign to the {#is_enabled} 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
+    # @option attributes [String] :vcnId The value to assign to the {#vcn_id} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 
@@ -67,7 +82,7 @@ module OCI
         self.id = attributes[:'id']
       end
 
-      if attributes[:'isEnabled']
+      unless attributes[:'isEnabled'].nil?
         self.is_enabled = attributes[:'isEnabled']
       end