oci 2.0.5 → 2.0.6

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

@@ -3,6 +3,22 @@
 require 'date'
 
 module OCI
+  # A set of DHCP options. Used by the VCN to automatically provide configuration
+  # information to the instances when they boot up. There are two options you can set:
+  #
+  # - {DhcpDnsOption}: Lets you specify how DNS (hostname resolution) is
+  # handled in the subnets in your VCN.
+  #
+  # - {DhcpSearchDomainOption}: Lets you specify
+  # a search domain name to use for DNS queries.
+  #
+  # For more information, see  [DNS in Your Virtual Cloud Network](https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/dns.htm)
+  # and [DHCP Options](https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingDHCP.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::DhcpOptions
 
     LIFECYCLE_STATE_ENUM = [LIFECYCLE_STATE_PROVISIONING = 'PROVISIONING',
@@ -11,7 +27,7 @@ module OCI
                 LIFECYCLE_STATE_TERMINATED = 'TERMINATED',
                 LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE']
 
-    # The OCID of the compartment containing the set of DHCP options.
+    # **[Required]** The OCID of the compartment containing the set of DHCP options.
     # @return [String]
     attr_accessor :compartment_id
 
@@ -38,32 +54,41 @@ module OCI
     # @return [Hash<String, String>]
     attr_accessor :freeform_tags
 
-    # Oracle ID (OCID) for the set of DHCP options.
+    # **[Required]** Oracle ID (OCID) for the set of DHCP options.
     # @return [String]
     attr_accessor :id
 
-    # The current state of the set of DHCP options.
+    # **[Required]** The current state of the set of DHCP options.
     # @return [String]
     attr_accessor :lifecycle_state
 
-    # The collection of individual DHCP options.
+    # **[Required]** The collection of individual DHCP options.
     # @return [Array<OCI::Core::Models::DhcpOption>]
     attr_accessor :options
 
-    # Date and time the set of DHCP options was created, in the format defined by RFC3339.
+    # **[Required]** Date and time the set of DHCP options was created, in the format defined by RFC3339.
     # 
     # Example: `2016-08-25T21:10:29.600Z`
     # 
     # @return [DateTime]
     attr_accessor :time_created
 
-    # The OCID of the VCN the set of DHCP options belongs to.
+    # **[Required]** The OCID of the VCN the set of DHCP options 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 [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] :lifecycleState The value to assign to the {#lifecycle_state} property
+    # @option attributes [Array<OCI::Core::Models::DhcpOption>] :options The value to assign to the {#options} 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)
 

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

@@ -4,8 +4,11 @@ require 'date'
 require_relative 'dhcp_option'
 
 module OCI
+  # DHCP option for specifying a search domain name for DNS queries. For more information, see
+  # [DNS in Your Virtual Cloud Network](https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/dns.htm).
+  #
   class Core::Models::DhcpSearchDomainOption < Core::Models::DhcpOption
-    # A single search domain name according to [RFC 952](https://tools.ietf.org/html/rfc952)
+    # **[Required]** A single search domain name according to [RFC 952](https://tools.ietf.org/html/rfc952)
     # and [RFC 1123](https://tools.ietf.org/html/rfc1123). During a DNS query,
     # the OS will append this search domain name to the value being queried.
     # 
@@ -25,6 +28,7 @@ module OCI
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [Array<String>] :searchDomainNames The value to assign to the {#search_domain_names} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

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

@@ -3,6 +3,16 @@
 require 'date'
 
 module OCI
+  # A Dynamic Routing Gateway (DRG), which is a virtual router that provides a path for private
+  # network traffic between your VCN and your existing network. You use it with other Networking
+  # Service components to create an IPSec VPN or a connection that uses
+  # Oracle Cloud Infrastructure FastConnect. 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::Drg
 
     LIFECYCLE_STATE_ENUM = [LIFECYCLE_STATE_PROVISIONING = 'PROVISIONING',
@@ -11,7 +21,7 @@ module OCI
                 LIFECYCLE_STATE_TERMINATED = 'TERMINATED',
                 LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE']
 
-    # The OCID of the compartment containing the DRG.
+    # **[Required]** The OCID of the compartment containing the DRG.
     # @return [String]
     attr_accessor :compartment_id
 
@@ -21,11 +31,11 @@ module OCI
     # @return [String]
     attr_accessor :display_name
 
-    # The DRG's Oracle ID (OCID).
+    # **[Required]** The DRG's Oracle ID (OCID).
     # @return [String]
     attr_accessor :id
 
-    # The DRG's current state.
+    # **[Required]** The DRG's current state.
     # @return [String]
     attr_accessor :lifecycle_state
 
@@ -39,6 +49,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] :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/drg_attachment.rb

@@ -3,6 +3,9 @@
 require 'date'
 
 module OCI
+  # A link between a DRG and VCN. For more information, see
+  # [Overview of the Networking Service](https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/overview.htm).
+  #
   class Core::Models::DrgAttachment
 
     LIFECYCLE_STATE_ENUM = [LIFECYCLE_STATE_ATTACHING = 'ATTACHING',
@@ -11,7 +14,7 @@ module OCI
                 LIFECYCLE_STATE_DETACHED = 'DETACHED',
                 LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE']
 
-    # The OCID of the compartment containing the DRG attachment.
+    # **[Required]** The OCID of the compartment containing the DRG attachment.
     # @return [String]
     attr_accessor :compartment_id
 
@@ -21,15 +24,15 @@ module OCI
     # @return [String]
     attr_accessor :display_name
 
-    # The OCID of the DRG.
+    # **[Required]** The OCID of the DRG.
     # @return [String]
     attr_accessor :drg_id
 
-    # The DRG attachment's Oracle ID (OCID).
+    # **[Required]** The DRG attachment's Oracle ID (OCID).
     # @return [String]
     attr_accessor :id
 
-    # The DRG attachment's current state.
+    # **[Required]** The DRG attachment's current state.
     # @return [String]
     attr_accessor :lifecycle_state
 
@@ -40,13 +43,20 @@ module OCI
     # @return [DateTime]
     attr_accessor :time_created
 
-    # The OCID of the VCN.
+    # **[Required]** The OCID of the VCN.
     # @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] :drgId The value to assign to the {#drg_id} property
+    # @option attributes [String] :id The value to assign to the {#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
+    # @option attributes [String] :vcnId The value to assign to the {#vcn_id} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

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

@@ -3,8 +3,9 @@
 require 'date'
 
 module OCI
+  # A rule for allowing outbound IP packets.
   class Core::Models::EgressSecurityRule
-    # The destination CIDR block for the egress rule. This is the range of IP addresses that a
+    # **[Required]** The destination CIDR block for the egress rule. This is the range of IP addresses that a
     # packet originating from the instance can go to.
     # 
     # @return [String]
@@ -31,7 +32,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\").
@@ -54,6 +55,12 @@ module OCI
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [String] :destination The value to assign to the {#destination} property
+    # @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 [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)
 
@@ -68,7 +75,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/export_image_details.rb

@@ -3,8 +3,19 @@
 require 'date'
 
 module OCI
+  # The destination details for the image export.
+  #
+  # Set `destinationType` to `objectStorageTuple`
+  # and use {#export_image_via_object_storage_tuple_details export_image_via_object_storage_tuple_details}
+  # when specifying the namespace, bucket name, and object name.
+  #
+  # Set `destinationType` to `objectStorageUri` and
+  # use {#export_image_via_object_storage_uri_details export_image_via_object_storage_uri_details}
+  # when specifying the Object Storage URL.
+  #
+  # 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::ExportImageDetails
-    # The destination type. Use `objectStorageTuple` when specifying the namespace, bucket name, and object name.
+    # **[Required]** The destination type. Use `objectStorageTuple` when specifying the namespace, bucket name, and object name.
     # Use `objectStorageUri` when specifying the Object Storage URL.
     # 
     # @return [String]
@@ -25,6 +36,7 @@ module OCI
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [String] :destinationType The value to assign to the {#destination_type} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

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

@@ -20,6 +20,9 @@ module OCI
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @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/export_image_via_object_storage_uri_details.rb

@@ -5,7 +5,7 @@ require_relative 'export_image_details'
 
 module OCI
   class Core::Models::ExportImageViaObjectStorageUriDetails < Core::Models::ExportImageDetails
-    # The Object Storage URL to export the image to. See [Object Storage URLs](https://docs.us-phoenix-1.oraclecloud.com/Content/Compute/Tasks/imageimportexport.htm#URLs)
+    # **[Required]** The Object Storage URL to export the image to. See [Object Storage URLs](https://docs.us-phoenix-1.oraclecloud.com/Content/Compute/Tasks/imageimportexport.htm#URLs)
     # and [pre-authenticated requests](https://docs.us-phoenix-1.oraclecloud.com/Content/Object/Tasks/managingaccess.htm#pre-auth) for constructing URLs for image import/export.
     # 
     # @return [String]
@@ -14,6 +14,7 @@ module OCI
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [String] :destinationUri The value to assign to the {#destination_uri} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

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

@@ -3,6 +3,9 @@
 require 'date'
 
 module OCI
+  # A service offering from a supported provider. For more information,
+  # see [FastConnect Overview](https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/fastconnect.htm).
+  #
   class Core::Models::FastConnectProviderService
 
     PRIVATE_PEERING_BGP_MANAGEMENT_ENUM = [PRIVATE_PEERING_BGP_MANAGEMENT_CUSTOMER_MANAGED = 'CUSTOMER_MANAGED',
@@ -31,27 +34,27 @@ module OCI
     # @return [String]
     attr_accessor :description
 
-    # The OCID of the service offered by the provider.
+    # **[Required]** The OCID of the service offered by the provider.
     # 
     # @return [String]
     attr_accessor :id
 
-    # Private peering BGP management.
+    # **[Required]** Private peering BGP management.
     # 
     # @return [String]
     attr_accessor :private_peering_bgp_management
 
-    # The name of the provider.
+    # **[Required]** The name of the provider.
     # 
     # @return [String]
     attr_accessor :provider_name
 
-    # The name of the service offered by the provider.
+    # **[Required]** The name of the service offered by the provider.
     # 
     # @return [String]
     attr_accessor :provider_service_name
 
-    # Public peering BGP management.
+    # **[Required]** Public peering BGP management.
     # 
     # @return [String]
     attr_accessor :public_peering_bgp_management
@@ -61,7 +64,7 @@ module OCI
     # @return [Array<String>]
     attr_accessor :supported_virtual_circuit_types
 
-    # Provider service type.
+    # **[Required]** Provider service type.
     # 
     # @return [String]
     attr_accessor :type
@@ -69,6 +72,14 @@ module OCI
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @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] :privatePeeringBgpManagement The value to assign to the {#private_peering_bgp_management} property
+    # @option attributes [String] :providerName The value to assign to the {#provider_name} property
+    # @option attributes [String] :providerServiceName The value to assign to the {#provider_service_name} property
+    # @option attributes [String] :publicPeeringBgpManagement The value to assign to the {#public_peering_bgp_management} property
+    # @option attributes [Array<String>] :supportedVirtualCircuitTypes The value to assign to the {#supported_virtual_circuit_types} property
+    # @option attributes [String] :type The value to assign to the {#type} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

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

@@ -4,6 +4,7 @@ require 'date'
 require_relative 'volume_attachment'
 
 module OCI
+  # An ISCSI volume attachment.
   class Core::Models::IScsiVolumeAttachment < Core::Models::VolumeAttachment
     # The Challenge-Handshake-Authentication-Protocol (CHAP) secret valid for the associated CHAP user name.
     # (Also called the \"CHAP password\".)
@@ -20,21 +21,21 @@ module OCI
     # @return [String]
     attr_accessor :chap_username
 
-    # The volume's iSCSI IP address.
+    # **[Required]** The volume's iSCSI IP address.
     # 
     # Example: `169.254.0.2`
     # 
     # @return [String]
     attr_accessor :ipv4
 
-    # The target volume's iSCSI Qualified Name in the format defined by RFC 3720.
+    # **[Required]** The target volume's iSCSI Qualified Name in the format defined by RFC 3720.
     # 
     # Example: `iqn.2015-12.us.oracle.com:456b0391-17b8-4122-bbf1-f85fc0bb97d9`
     # 
     # @return [String]
     attr_accessor :iqn
 
-    # The volume's iSCSI port.
+    # **[Required]** The volume's iSCSI port.
     # 
     # Example: `3260`
     # 
@@ -44,6 +45,19 @@ 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 {OCI::Core::Models::VolumeAttachment#availability_domain #availability_domain} proprety
+    # @option attributes [String] :compartmentId The value to assign to the {OCI::Core::Models::VolumeAttachment#compartment_id #compartment_id} proprety
+    # @option attributes [String] :displayName The value to assign to the {OCI::Core::Models::VolumeAttachment#display_name #display_name} proprety
+    # @option attributes [String] :id The value to assign to the {OCI::Core::Models::VolumeAttachment#id #id} proprety
+    # @option attributes [String] :instanceId The value to assign to the {OCI::Core::Models::VolumeAttachment#instance_id #instance_id} proprety
+    # @option attributes [String] :lifecycleState The value to assign to the {OCI::Core::Models::VolumeAttachment#lifecycle_state #lifecycle_state} proprety
+    # @option attributes [DateTime] :timeCreated The value to assign to the {OCI::Core::Models::VolumeAttachment#time_created #time_created} proprety
+    # @option attributes [String] :volumeId The value to assign to the {OCI::Core::Models::VolumeAttachment#volume_id #volume_id} proprety
+    # @option attributes [String] :chapSecret The value to assign to the {#chap_secret} property
+    # @option attributes [String] :chapUsername The value to assign to the {#chap_username} property
+    # @option attributes [String] :ipv4 The value to assign to the {#ipv4} property
+    # @option attributes [String] :iqn The value to assign to the {#iqn} property
+    # @option attributes [Integer] :port The value to assign to the {#port} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

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

@@ -3,18 +3,28 @@
 require 'date'
 
 module OCI
+  # Optional object to specify a particular ICMP type and code. If you specify ICMP as the protocol
+  # but do not provide this object, then all ICMP types and codes are allowed. If you do provide
+  # this object, the type is required and the code is optional.
+  # See [ICMP Parameters](http://www.iana.org/assignments/icmp-parameters/icmp-parameters.xhtml)
+  # for allowed values. To enable MTU negotiation for ingress internet traffic, make sure to allow
+  # type 3 (\"Destination Unreachable\") code 4 (\"Fragmentation Needed and Don't Fragment was Set\").
+  # If you need to specify multiple codes for a single type, create a separate security list rule for each.
+  #
   class Core::Models::IcmpOptions
     # The ICMP code (optional).
     # @return [Integer]
     attr_accessor :code
 
-    # The ICMP type.
+    # **[Required]** The ICMP type.
     # @return [Integer]
     attr_accessor :type
 
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [Integer] :code The value to assign to the {#code} property
+    # @option attributes [Integer] :type The value to assign to the {#type} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)