oci 2.0.5 → 2.0.6

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

@@ -3,6 +3,15 @@
 require 'date'
 
 module OCI
+  # A connection between a DRG and CPE. This connection consists of multiple IPSec
+  # tunnels. Creating this connection is one of the steps required when setting up
+  # an IPSec VPN. 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::IPSecConnection
 
     LIFECYCLE_STATE_ENUM = [LIFECYCLE_STATE_PROVISIONING = 'PROVISIONING',
@@ -11,11 +20,11 @@ module OCI
                 LIFECYCLE_STATE_TERMINATED = 'TERMINATED',
                 LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE']
 
-    # The OCID of the compartment containing the IPSec connection.
+    # **[Required]** The OCID of the compartment containing the IPSec connection.
     # @return [String]
     attr_accessor :compartment_id
 
-    # The OCID of the CPE.
+    # **[Required]** The OCID of the CPE.
     # @return [String]
     attr_accessor :cpe_id
 
@@ -25,19 +34,19 @@ 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 IPSec connection's Oracle ID (OCID).
+    # **[Required]** The IPSec connection's Oracle ID (OCID).
     # @return [String]
     attr_accessor :id
 
-    # The IPSec connection's current state.
+    # **[Required]** The IPSec connection's current state.
     # @return [String]
     attr_accessor :lifecycle_state
 
-    # Static routes to the CPE. At least one route must be included. The CIDR must not be a
+    # **[Required]** Static routes to the CPE. At least one route must be included. The CIDR must not be a
     # multicast address or class E address.
     # 
     # Example: `10.0.1.0/24`
@@ -55,6 +64,14 @@ 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] :cpeId The value to assign to the {#cpe_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 [Array<String>] :staticRoutes The value to assign to the {#static_routes} 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/ip_sec_connection_device_config.rb

@@ -3,12 +3,13 @@
 require 'date'
 
 module OCI
+  # Information about the IPSecConnection device configuration.
   class Core::Models::IPSecConnectionDeviceConfig
-    # The OCID of the compartment containing the IPSec connection.
+    # **[Required]** The OCID of the compartment containing the IPSec connection.
     # @return [String]
     attr_accessor :compartment_id
 
-    # The IPSec connection's Oracle ID (OCID).
+    # **[Required]** The IPSec connection's Oracle ID (OCID).
     # @return [String]
     attr_accessor :id
 
@@ -23,6 +24,10 @@ 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] :id The value to assign to the {#id} property
+    # @option attributes [DateTime] :timeCreated The value to assign to the {#time_created} property
+    # @option attributes [Array<OCI::Core::Models::TunnelConfig>] :tunnels The value to assign to the {#tunnels} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

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

@@ -3,12 +3,13 @@
 require 'date'
 
 module OCI
+  # Status of the IPSec connection.
   class Core::Models::IPSecConnectionDeviceStatus
-    # The OCID of the compartment containing the IPSec connection.
+    # **[Required]** The OCID of the compartment containing the IPSec connection.
     # @return [String]
     attr_accessor :compartment_id
 
-    # The IPSec connection's Oracle ID (OCID).
+    # **[Required]** The IPSec connection's Oracle ID (OCID).
     # @return [String]
     attr_accessor :id
 
@@ -26,6 +27,10 @@ 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] :id The value to assign to the {#id} property
+    # @option attributes [DateTime] :timeCreated The value to assign to the {#time_created} property
+    # @option attributes [Array<OCI::Core::Models::TunnelStatus>] :tunnels The value to assign to the {#tunnels} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

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

@@ -3,15 +3,18 @@
 require 'date'
 
 module OCI
+  # Instance launch details.
+  # Use the `sourceDetails` parameter to specify whether a boot volume or an image should be used to launch a new instance.
+  #
   class Core::Models::LaunchInstanceDetails
-    # The Availability Domain of the instance.
+    # **[Required]** The Availability Domain of the 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
 
@@ -158,7 +161,7 @@ module OCI
     # @return [Hash<String, String>]
     attr_accessor :metadata
 
-    # The shape of an instance. The shape determines the number of CPUs, amount of memory,
+    # **[Required]** The shape of an instance. The shape determines the number of CPUs, amount of memory,
     # and other resources allocated to the instance.
     # 
     # You can enumerate all available shapes by calling {#list_shapes list_shapes}.
@@ -182,6 +185,20 @@ 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 [OCI::Core::Models::CreateVnicDetails] :createVnicDetails The value to assign to the {#create_vnic_details} 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] :hostnameLabel The value to assign to the {#hostname_label} 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 [Hash<String, String>] :metadata The value to assign to the {#metadata} 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 [String] :subnetId The value to assign to the {#subnet_id} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

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

@@ -3,6 +3,8 @@
 require 'date'
 
 module OCI
+  # Options for tuning compatibility and performance of VM shapes.
+  #
   class Core::Models::LaunchOptions
 
     BOOT_VOLUME_TYPE_ENUM = [BOOT_VOLUME_TYPE_ISCSI = 'ISCSI',
@@ -28,7 +30,7 @@ module OCI
                 REMOTE_DATA_VOLUME_TYPE_VFIO = 'VFIO',
                 REMOTE_DATA_VOLUME_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE']
 
-    # Emulation type for volume.
+    # **[Required]** Emulation type for volume.
     # * `ISCSI` - ISCSI attached block storage device. This is the default for Boot Volumes and Remote Block
     # Storage volumes on Oracle provided images.
     # * `SCSI` - Emulated SCSI disk.
@@ -39,7 +41,7 @@ module OCI
     # @return [String]
     attr_accessor :boot_volume_type
 
-    # Firmware used to boot VM.  Select the option that matches your operating system.
+    # **[Required]** Firmware used to boot VM.  Select the option that matches your operating system.
     # * `BIOS` - Boot VM using BIOS style firmware.  This is compatible with both 32 bit and 64 bit operating
     # systems that boot using MBR style bootloaders.
     # * `UEFI_64` - Boot VM using UEFI style firmware compatible with 64 bit operating systems.  This is the
@@ -48,14 +50,14 @@ module OCI
     # @return [String]
     attr_accessor :firmware
 
-    # Emulation type for NIC.
+    # **[Required]** Emulation type for NIC.
     # * `E1000` - Emulated Gigabit ethernet controller.  Compatible with Linux e1000 network driver.
     # * `VFIO` - Direct attached Virtual Function network controller.  Default for Oracle provided images.
     # 
     # @return [String]
     attr_accessor :network_type
 
-    # Emulation type for volume.
+    # **[Required]** Emulation type for volume.
     # * `ISCSI` - ISCSI attached block storage device. This is the default for Boot Volumes and Remote Block
     # Storage volumes on Oracle provided images.
     # * `SCSI` - Emulated SCSI disk.
@@ -69,6 +71,10 @@ module OCI
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [String] :bootVolumeType The value to assign to the {#boot_volume_type} property
+    # @option attributes [String] :firmware The value to assign to the {#firmware} property
+    # @option attributes [String] :networkType The value to assign to the {#network_type} property
+    # @option attributes [String] :remoteDataVolumeType The value to assign to the {#remote_data_volume_type} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

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

@@ -3,6 +3,9 @@
 require 'date'
 
 module OCI
+  # The Letter of Authority for the cross-connect. You must submit this letter when
+  # requesting cabling for the cross-connect at the FastConnect location.
+  #
   class Core::Models::LetterOfAuthority
 
     CIRCUIT_TYPE_ENUM = [CIRCUIT_TYPE_SINGLE_MODE_LC = 'Single_mode_LC',
@@ -44,6 +47,13 @@ module OCI
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [String] :authorizedEntityName The value to assign to the {#authorized_entity_name} property
+    # @option attributes [String] :circuitType The value to assign to the {#circuit_type} property
+    # @option attributes [String] :crossConnectId The value to assign to the {#cross_connect_id} property
+    # @option attributes [String] :facilityLocation The value to assign to the {#facility_location} property
+    # @option attributes [String] :portName The value to assign to the {#port_name} property
+    # @option attributes [DateTime] :timeExpires The value to assign to the {#time_expires} property
+    # @option attributes [DateTime] :timeIssued The value to assign to the {#time_issued} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

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

@@ -3,6 +3,16 @@
 require 'date'
 
 module OCI
+  # A local peering gateway (LPG) is an object on a VCN that lets that VCN peer
+  # with another VCN in the same region. *Peering* means that the two VCNs can
+  # communicate using private IP addresses, but without the traffic traversing the
+  # internet or routing through your on-premises network. For more information,
+  # see [VCN Peering](https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/VCNpeering.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::LocalPeeringGateway
 
     LIFECYCLE_STATE_ENUM = [LIFECYCLE_STATE_PROVISIONING = 'PROVISIONING',
@@ -19,28 +29,28 @@ module OCI
                 PEERING_STATUS_REVOKED = 'REVOKED',
                 PEERING_STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE']
 
-    # The OCID of the compartment containing the LPG.
+    # **[Required]** The OCID of the compartment containing the LPG.
     # @return [String]
     attr_accessor :compartment_id
 
-    # A user-friendly name. Does not have to be unique, and it's changeable. Avoid
+    # **[Required]** A user-friendly name. Does not have to be unique, and it's changeable. Avoid
     # entering confidential information.
     # 
     # @return [String]
     attr_accessor :display_name
 
-    # The LPG's Oracle ID (OCID).
+    # **[Required]** The LPG's Oracle ID (OCID).
     # @return [String]
     attr_accessor :id
 
-    # Whether the VCN at the other end of the peering is in a different tenancy.
+    # **[Required]** Whether the VCN at the other end of the peering is in a different tenancy.
     # 
     # Example: `false`
     # 
     # @return [BOOLEAN]
     attr_accessor :is_cross_tenancy_peering
 
-    # The LPG's current lifecycle state.
+    # **[Required]** The LPG's current lifecycle state.
     # @return [String]
     attr_accessor :lifecycle_state
 
@@ -54,7 +64,7 @@ module OCI
     # @return [String]
     attr_accessor :peer_advertised_cidr
 
-    # Whether the LPG is peered with another LPG. `NEW` means the LPG has not yet been
+    # **[Required]** Whether the LPG is peered with another LPG. `NEW` means the LPG has not yet been
     # peered. `PENDING` means the peering is being established. `REVOKED` means the
     # LPG at the other end of the peering has been deleted.
     # 
@@ -65,20 +75,30 @@ module OCI
     # @return [String]
     attr_accessor :peering_status_details
 
-    # The date and time the LPG was created, in the format defined by RFC3339.
+    # **[Required]** The date and time the LPG 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 LPG belongs to.
+    # **[Required]** The OCID of the VCN the LPG 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] :isCrossTenancyPeering The value to assign to the {#is_cross_tenancy_peering} property
+    # @option attributes [String] :lifecycleState The value to assign to the {#lifecycle_state} property
+    # @option attributes [String] :peerAdvertisedCidr The value to assign to the {#peer_advertised_cidr} property
+    # @option attributes [String] :peeringStatus The value to assign to the {#peering_status} property
+    # @option attributes [String] :peeringStatusDetails The value to assign to the {#peering_status_details} 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)
 
@@ -97,7 +117,7 @@ module OCI
         self.id = attributes[:'id']
       end
 
-      if attributes[:'isCrossTenancyPeering']
+      unless attributes[:'isCrossTenancyPeering'].nil?
         self.is_cross_tenancy_peering = attributes[:'isCrossTenancyPeering']
       end
 

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

@@ -4,19 +4,21 @@ require 'date'
 
 module OCI
   class Core::Models::PortRange
-    # The maximum port number. Must not be lower than the minimum port number. To specify
+    # **[Required]** The maximum port number. Must not be lower than the minimum port number. To specify
     # a single port number, set both the min and max to the same value.
     # 
     # @return [Integer]
     attr_accessor :max
 
-    # The minimum port number. Must not be greater than the maximum port number.
+    # **[Required]** The minimum port number. Must not be greater than the maximum port number.
     # @return [Integer]
     attr_accessor :min
 
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [Integer] :max The value to assign to the {#max} property
+    # @option attributes [Integer] :min The value to assign to the {#min} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

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

@@ -3,6 +3,34 @@
 require 'date'
 
 module OCI
+  # A *private IP* is a conceptual term that refers to a private IP address and related properties.
+  # The `privateIp` object is the API representation of a private IP.
+  #
+  # Each instance has a *primary private IP* that is automatically created and
+  # assigned to the primary VNIC during instance launch. If you add a secondary
+  # VNIC to the instance, it also automatically gets a primary private IP. You
+  # can't remove a primary private IP from its VNIC. The primary private IP is
+  # automatically deleted when the VNIC is terminated.
+  #
+  # You can add *secondary private IPs* to a VNIC after it's created. For more
+  # information, see the `privateIp` operations and also
+  # [IP Addresses](https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingIPaddresses.htm).
+  #
+  # **Note:** Only
+  # {#list_private_ips list_private_ips} and
+  # {#get_private_ip get_private_ip} work with
+  # *primary* private IPs. To create and update primary private IPs, you instead
+  # work with instance and VNIC operations. For example, a primary private IP's
+  # properties come from the values you specify in
+  # {CreateVnicDetails} when calling either
+  # {#launch_instance launch_instance} or
+  # {#attach_vnic attach_vnic}. To update the hostname
+  # for a primary private IP, you use {#update_vnic update_vnic}.
+  #
+  # 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::PrivateIp
     # The private IP's Availability Domain.
     # 
@@ -93,6 +121,18 @@ 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] :hostnameLabel The value to assign to the {#hostname_label} 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 [BOOLEAN] :isPrimary The value to assign to the {#is_primary} 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] :vnicId The value to assign to the {#vnic_id} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 
@@ -131,7 +171,7 @@ module OCI
         self.ip_address = attributes[:'ipAddress']
       end
 
-      if attributes[:'isPrimary']
+      unless attributes[:'isPrimary'].nil?
         self.is_primary = attributes[:'isPrimary']
       end
 

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

@@ -3,8 +3,11 @@
 require 'date'
 
 module OCI
+  # A mapping between a destination IP address range and a virtual device to route matching
+  # packets to (a target).
+  #
   class Core::Models::RouteRule
-    # A destination IP address range in CIDR notation. Matching packets will
+    # **[Required]** A destination IP address range in CIDR notation. Matching packets will
     # be routed to the indicated network entity (the target).
     # 
     # Example: `0.0.0.0/0`
@@ -12,7 +15,7 @@ module OCI
     # @return [String]
     attr_accessor :cidr_block
 
-    # The OCID for the route rule's target. For information about the type of
+    # **[Required]** The OCID for the route rule's target. For information about the type of
     # targets you can specify, see
     # [Route Tables](https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingroutetables.htm).
     # 
@@ -22,6 +25,8 @@ 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] :networkEntityId The value to assign to the {#network_entity_id} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)