oci 2.0.5 → 2.0.6

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

@@ -4,14 +4,14 @@ require 'date'
 
 module OCI
   class Core::Models::CreateVcnDetails
-    # The CIDR IP address block of the VCN.
+    # **[Required]** The CIDR IP address block of the VCN.
     # 
     # Example: `172.16.0.0/16`
     # 
     # @return [String]
     attr_accessor :cidr_block
 
-    # The OCID of the compartment to contain the VCN.
+    # **[Required]** The OCID of the compartment to contain the VCN.
     # @return [String]
     attr_accessor :compartment_id
 
@@ -58,6 +58,12 @@ module OCI
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [String] :cidrBlock The value to assign to the {#cidr_block} 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 [String] :dnsLabel The value to assign to the {#dns_label} property
+    # @option attributes [Hash<String, String>] :freeformTags The value to assign to the {#freeform_tags} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

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

@@ -17,7 +17,7 @@ module OCI
     # @return [String]
     attr_accessor :bandwidth_shape_name
 
-    # The OCID of the compartment to contain the virtual circuit.
+    # **[Required]** The OCID of the compartment to contain the virtual circuit.
     # 
     # @return [String]
     attr_accessor :compartment_id
@@ -80,7 +80,7 @@ module OCI
     # @return [String]
     attr_accessor :region
 
-    # The type of IP addresses used in this virtual circuit. PRIVATE
+    # **[Required]** The type of IP addresses used in this virtual circuit. PRIVATE
     # means [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses
     # (10.0.0.0/8, 172.16/12, and 192.168/16). Only PRIVATE is supported.
     # 
@@ -90,6 +90,18 @@ module OCI
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [String] :bandwidthShapeName The value to assign to the {#bandwidth_shape_name} property
+    # @option attributes [String] :compartmentId The value to assign to the {#compartment_id} property
+    # @option attributes [Array<OCI::Core::Models::CrossConnectMapping>] :crossConnectMappings The value to assign to the {#cross_connect_mappings} property
+    # @option attributes [Integer] :customerBgpAsn The value to assign to the {#customer_bgp_asn} property
+    # @option attributes [String] :displayName The value to assign to the {#display_name} property
+    # @option attributes [String] :gatewayId The value to assign to the {#gateway_id} property
+    # @option attributes [String] :providerName The value to assign to the {#provider_name} property
+    # @option attributes [String] :providerServiceId The value to assign to the {#provider_service_id} property
+    # @option attributes [String] :providerServiceName The value to assign to the {#provider_service_name} property
+    # @option attributes [Array<OCI::Core::Models::CreateVirtualCircuitPublicPrefixDetails>] :publicPrefixes The value to assign to the {#public_prefixes} property
+    # @option attributes [String] :region The value to assign to the {#region} 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/create_virtual_circuit_public_prefix_details.rb

@@ -4,7 +4,7 @@ require 'date'
 
 module OCI
   class Core::Models::CreateVirtualCircuitPublicPrefixDetails
-    # An individual public IP prefix (CIDR) to add to the public virtual circuit.
+    # **[Required]** An individual public IP prefix (CIDR) to add to the public virtual circuit.
     # Must be /24 or less specific.
     # 
     # @return [String]
@@ -13,6 +13,7 @@ module OCI
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [String] :cidrBlock The value to assign to the {#cidr_block} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

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

@@ -3,6 +3,11 @@
 require 'date'
 
 module OCI
+  # Contains properties for a VNIC. You use this object when creating the
+  # primary VNIC during instance launch or when creating a secondary VNIC.
+  # For more information about VNICs, see
+  # [Virtual Network Interface Cards (VNICs)](https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingVNICs.htm).
+  #
   class Core::Models::CreateVnicDetails
     # Whether the VNIC should be assigned a public IP address. Defaults to whether
     # the subnet is public or private. If not set and the VNIC is being created
@@ -76,7 +81,7 @@ module OCI
     # @return [BOOLEAN]
     attr_accessor :skip_source_dest_check
 
-    # The OCID of the subnet to create the VNIC in. When launching an instance,
+    # **[Required]** The OCID of the subnet to create the VNIC in. When launching an instance,
     # use this `subnetId` instead of the deprecated `subnetId` in
     # {#launch_instance_details launch_instance_details}.
     # At least one of them is required; if you provide both, the values must match.
@@ -87,13 +92,19 @@ module OCI
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [BOOLEAN] :assignPublicIp The value to assign to the {#assign_public_ip} property
+    # @option attributes [String] :displayName The value to assign to the {#display_name} property
+    # @option attributes [String] :hostnameLabel The value to assign to the {#hostname_label} property
+    # @option attributes [String] :privateIp The value to assign to the {#private_ip} property
+    # @option attributes [BOOLEAN] :skipSourceDestCheck The value to assign to the {#skip_source_dest_check} property
+    # @option attributes [String] :subnetId The value to assign to the {#subnet_id} 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[:'assignPublicIp']
+      unless attributes[:'assignPublicIp'].nil?
         self.assign_public_ip = attributes[:'assignPublicIp']
       end
 
@@ -109,7 +120,7 @@ module OCI
         self.private_ip = attributes[:'privateIp']
       end
 
-      if attributes[:'skipSourceDestCheck']
+      unless attributes[:'skipSourceDestCheck'].nil?
         self.skip_source_dest_check = attributes[:'skipSourceDestCheck']
       end
 

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

@@ -27,13 +27,17 @@ module OCI
     # @return [Hash<String, String>]
     attr_accessor :freeform_tags
 
-    # The OCID of the volume that needs to be backed up.
+    # **[Required]** The OCID of the volume that needs to be backed up.
     # @return [String]
     attr_accessor :volume_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] :volumeId The value to assign to the {#volume_id} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

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

@@ -4,14 +4,14 @@ require 'date'
 
 module OCI
   class Core::Models::CreateVolumeDetails
-    # The Availability Domain of the volume.
+    # **[Required]** The Availability Domain of the volume.
     # 
     # Example: `Uocm:PHX-AD-1`
     # 
     # @return [String]
     attr_accessor :availability_domain
 
-    # The OCID of the compartment that contains the volume.
+    # **[Required]** The OCID of the compartment that contains the volume.
     # @return [String]
     attr_accessor :compartment_id
 
@@ -65,6 +65,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 [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 [OCI::Core::Models::VolumeSourceDetails] :sourceDetails The value to assign to the {#source_details} property
+    # @option attributes [String] :volumeBackupId The value to assign to the {#volume_backup_id} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

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

@@ -3,6 +3,23 @@
 require 'date'
 
 module OCI
+  # For use with Oracle Cloud Infrastructure FastConnect. A cross-connect represents a
+  # physical connection between an existing network and Oracle. Customers who are colocated
+  # with Oracle in a FastConnect location create and use cross-connects. For more
+  # information, see [FastConnect Overview](https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/fastconnect.htm).
+  #
+  # Oracle recommends you create each cross-connect in a
+  # {CrossConnectGroup} so you can use link aggregation
+  # with the connection.
+  #
+  # **Note:** If you're a provider who is setting up a physical connection to Oracle so customers
+  # can use FastConnect over the connection, be aware that your connection is modeled the
+  # same way as a colocated customer's (with `CrossConnect` and `CrossConnectGroup` objects, and so on).
+  #
+  # 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::CrossConnect
 
     LIFECYCLE_STATE_ENUM = [LIFECYCLE_STATE_PENDING_CUSTOMER = 'PENDING_CUSTOMER',
@@ -60,6 +77,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] :crossConnectGroupId The value to assign to the {#cross_connect_group_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 [String] :locationName The value to assign to the {#location_name} property
+    # @option attributes [String] :portName The value to assign to the {#port_name} property
+    # @option attributes [String] :portSpeedShapeName The value to assign to the {#port_speed_shape_name} 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/cross_connect_group.rb

@@ -3,6 +3,20 @@
 require 'date'
 
 module OCI
+  # For use with Oracle Cloud Infrastructure FastConnect. A cross-connect group
+  # is a link aggregation group (LAG), which can contain one or more
+  # {CrossConnect}. Customers who are colocated with
+  # Oracle in a FastConnect location create and use cross-connect groups. For more
+  # information, see [FastConnect Overview](https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/fastconnect.htm).
+  #
+  # **Note:** If you're a provider who is setting up a physical connection to Oracle so customers
+  # can use FastConnect over the connection, be aware that your connection is modeled the
+  # same way as a colocated customer's (with `CrossConnect` and `CrossConnectGroup` objects, and so on).
+  #
+  # 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::CrossConnectGroup
 
     LIFECYCLE_STATE_ENUM = [LIFECYCLE_STATE_PROVISIONING = 'PROVISIONING',
@@ -40,6 +54,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/cross_connect_location.rb

@@ -3,12 +3,13 @@
 require 'date'
 
 module OCI
+  # An individual FastConnect location.
   class Core::Models::CrossConnectLocation
-    # A description of the location.
+    # **[Required]** A description of the location.
     # @return [String]
     attr_accessor :description
 
-    # The name of the location.
+    # **[Required]** The name of the location.
     # 
     # Example: `CyrusOne, Chandler, AZ`
     # 
@@ -18,6 +19,8 @@ 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] :name The value to assign to the {#name} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

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

@@ -3,6 +3,32 @@
 require 'date'
 
 module OCI
+  # For use with Oracle Cloud Infrastructure FastConnect. Each
+  # {VirtualCircuit} runs on one or
+  # more cross-connects or cross-connect groups. A `CrossConnectMapping`
+  # contains the properties for an individual cross-connect or cross-connect group
+  # associated with a given virtual circuit.
+  #
+  # The mapping includes information about the cross-connect or
+  # cross-connect group, the VLAN, and the BGP peering session.
+  #
+  # If you're a customer who is colocated with Oracle, that means you own both
+  # the virtual circuit and the physical connection it runs on (cross-connect or
+  # cross-connect group), so you specify all the information in the mapping. There's
+  # one exception: for a public virtual circuit, Oracle specifies the BGP IP
+  # addresses.
+  #
+  # If you're a provider, then you own the physical connection that the customer's
+  # virtual circuit runs on, so you contribute information about the cross-connect
+  # or cross-connect group and VLAN.
+  #
+  # Who specifies the BGP peering information in the case of customer connection via
+  # provider? If the BGP session goes from Oracle to the provider's edge router, then
+  # the provider also specifies the BGP peering information. If the BGP session instead
+  # goes from Oracle to the customer's edge router, then the customer specifies the BGP
+  # peering information. There's one exception: for a public virtual circuit, Oracle
+  # specifies the BGP IP addresses.
+  #
   class Core::Models::CrossConnectMapping
     # The key for BGP MD5 authentication. Only applicable if your system
     # requires MD5 authentication. If empty or not set (null), that
@@ -57,6 +83,11 @@ module OCI
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [String] :bgpMd5AuthKey The value to assign to the {#bgp_md5_auth_key} property
+    # @option attributes [String] :crossConnectOrCrossConnectGroupId The value to assign to the {#cross_connect_or_cross_connect_group_id} property
+    # @option attributes [String] :customerBgpPeeringIp The value to assign to the {#customer_bgp_peering_ip} property
+    # @option attributes [String] :oracleBgpPeeringIp The value to assign to the {#oracle_bgp_peering_ip} property
+    # @option attributes [Integer] :vlan The value to assign to the {#vlan} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

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

@@ -3,15 +3,17 @@
 require 'date'
 
 module OCI
+  # An individual port speed level for cross-connects.
+  #
   class Core::Models::CrossConnectPortSpeedShape
-    # The name of the port speed shape.
+    # **[Required]** The name of the port speed shape.
     # 
     # Example: `10 Gbps`
     # 
     # @return [String]
     attr_accessor :name
 
-    # The port speed in Gbps.
+    # **[Required]** The port speed in Gbps.
     # 
     # Example: `10`
     # 
@@ -21,6 +23,8 @@ module OCI
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [String] :name The value to assign to the {#name} property
+    # @option attributes [Integer] :portSpeedInGbps The value to assign to the {#port_speed_in_gbps} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

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

@@ -3,6 +3,7 @@
 require 'date'
 
 module OCI
+  # The status of the cross-connect.
   class Core::Models::CrossConnectStatus
 
     INTERFACE_STATE_ENUM = [INTERFACE_STATE_UP = 'UP',
@@ -17,7 +18,7 @@ module OCI
                 LIGHT_LEVEL_INDICATOR_GOOD = 'GOOD',
                 LIGHT_LEVEL_INDICATOR_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE']
 
-    # The OCID of the cross-connect.
+    # **[Required]** The OCID of the cross-connect.
     # @return [String]
     attr_accessor :cross_connect_id
 
@@ -50,6 +51,10 @@ module OCI
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [String] :crossConnectId The value to assign to the {#cross_connect_id} property
+    # @option attributes [String] :interfaceState The value to assign to the {#interface_state} property
+    # @option attributes [Float] :lightLevelIndBm The value to assign to the {#light_level_ind_bm} property
+    # @option attributes [String] :lightLevelIndicator The value to assign to the {#light_level_indicator} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

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

@@ -4,13 +4,14 @@ require 'date'
 
 module OCI
   class Core::Models::DeleteVirtualCircuitPublicPrefixDetails
-    # An individual public IP prefix (CIDR) to remove from the public virtual circuit.
+    # **[Required]** An individual public IP prefix (CIDR) to remove from the public virtual circuit.
     # @return [String]
     attr_accessor :cidr_block
 
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [String] :cidrBlock The value to assign to the {#cidr_block} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

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

@@ -4,6 +4,10 @@ require 'date'
 require_relative 'dhcp_option'
 
 module OCI
+  # DHCP option for specifying how DNS (hostname resolution) is handled in the subnets in the VCN.
+  # 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::DhcpDnsOption < Core::Models::DhcpOption
 
     SERVER_TYPE_ENUM = [SERVER_TYPE_VCN_LOCAL = 'VcnLocal',
@@ -17,7 +21,7 @@ module OCI
     # @return [Array<String>]
     attr_accessor :custom_dns_servers
 
-    # - **VcnLocal:** Reserved for future use.
+    # **[Required]** - **VcnLocal:** Reserved for future use.
     # 
     # - **VcnLocalPlusInternet:** Also referred to as \"Internet and VCN Resolver\".
     # Instances can resolve internet hostnames (no Internet Gateway is required),
@@ -38,6 +42,8 @@ module OCI
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [Array<String>] :customDnsServers The value to assign to the {#custom_dns_servers} property
+    # @option attributes [String] :serverType The value to assign to the {#server_type} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

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

@@ -3,8 +3,15 @@
 require 'date'
 
 module OCI
+  # A single DHCP option according to [RFC 1533](https://tools.ietf.org/html/rfc1533).
+  # The two options available to use are {DhcpDnsOption}
+  # and {DhcpSearchDomainOption}. 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).
+  #
+  # 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::DhcpOption
-    # The specific DHCP option. Either `DomainNameServer`
+    # **[Required]** The specific DHCP option. Either `DomainNameServer`
     # (for {DhcpDnsOption}) or
     # `SearchDomain` (for {DhcpSearchDomainOption}).
     # 
@@ -26,6 +33,7 @@ module OCI
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [String] :type The value to assign to the {#type} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)