oci 2.0.5 → 2.0.6

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

@@ -3,6 +3,14 @@
 require 'date'
 
 module OCI
+  # A collection of `RouteRule` objects, which are used to route packets
+  # based on destination IP to a particular network entity. 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::RouteTable
 
     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 route table.
+    # **[Required]** The OCID of the compartment containing the route table.
     # @return [String]
     attr_accessor :compartment_id
 
@@ -38,15 +46,15 @@ module OCI
     # @return [Hash<String, String>]
     attr_accessor :freeform_tags
 
-    # The route table's Oracle ID (OCID).
+    # **[Required]** The route table's Oracle ID (OCID).
     # @return [String]
     attr_accessor :id
 
-    # The route table's current state.
+    # **[Required]** The route table's current state.
     # @return [String]
     attr_accessor :lifecycle_state
 
-    # The collection of rules for routing destination IPs to network devices.
+    # **[Required]** The collection of rules for routing destination IPs to network devices.
     # @return [Array<OCI::Core::Models::RouteRule>]
     attr_accessor :route_rules
 
@@ -57,13 +65,22 @@ module OCI
     # @return [DateTime]
     attr_accessor :time_created
 
-    # The OCID of the VCN the route table list belongs to.
+    # **[Required]** The OCID of the VCN the route table list 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::RouteRule>] :routeRules The value to assign to the {#route_rules} 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/security_list.rb

@@ -3,6 +3,20 @@
 require 'date'
 
 module OCI
+  # A set of virtual firewall rules for your VCN. Security lists are configured at the subnet
+  # level, but the rules are applied to the ingress and egress traffic for the individual instances
+  # in the subnet. The rules can be stateful or stateless. For more information, see
+  # [Security Lists](https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/securitylists.htm).
+  #
+  # **Important:** Oracle Cloud Infrastructure Compute service images automatically include firewall rules (for example,
+  # Linux iptables, Windows firewall). If there are issues with some type of access to an instance,
+  # make sure both the security lists associated with the instance's subnet and the instance's
+  # firewall rules are set correctly.
+  #
+  # 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::SecurityList
 
     LIFECYCLE_STATE_ENUM = [LIFECYCLE_STATE_PROVISIONING = 'PROVISIONING',
@@ -11,7 +25,7 @@ module OCI
                 LIFECYCLE_STATE_TERMINATED = 'TERMINATED',
                 LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE']
 
-    # The OCID of the compartment containing the security list.
+    # **[Required]** The OCID of the compartment containing the security list.
     # @return [String]
     attr_accessor :compartment_id
 
@@ -23,13 +37,13 @@ module OCI
     # @return [Hash<String, Hash<String, Object>>]
     attr_accessor :defined_tags
 
-    # A user-friendly name. Does not have to be unique, and it's changeable.
+    # **[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
 
-    # Rules for allowing egress IP packets.
+    # **[Required]** Rules for allowing egress IP packets.
     # @return [Array<OCI::Core::Models::EgressSecurityRule>]
     attr_accessor :egress_security_rules
 
@@ -42,32 +56,42 @@ module OCI
     # @return [Hash<String, String>]
     attr_accessor :freeform_tags
 
-    # The security list's Oracle Cloud ID (OCID).
+    # **[Required]** The security list's Oracle Cloud ID (OCID).
     # @return [String]
     attr_accessor :id
 
-    # Rules for allowing ingress IP packets.
+    # **[Required]** Rules for allowing ingress IP packets.
     # @return [Array<OCI::Core::Models::IngressSecurityRule>]
     attr_accessor :ingress_security_rules
 
-    # The security list's current state.
+    # **[Required]** The security list's current state.
     # @return [String]
     attr_accessor :lifecycle_state
 
-    # The date and time the security list was created, in the format defined by RFC3339.
+    # **[Required]** The date and time the security list 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 security list belongs to.
+    # **[Required]** The OCID of the VCN the security list 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 [Array<OCI::Core::Models::EgressSecurityRule>] :egressSecurityRules The value to assign to the {#egress_security_rules} 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 [Array<OCI::Core::Models::IngressSecurityRule>] :ingressSecurityRules The value to assign to the {#ingress_security_rules} 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/shape.rb

@@ -3,8 +3,11 @@
 require 'date'
 
 module OCI
+  # A compute instance shape that can be used in {#launch_instance launch_instance}.
+  # For more information, see [Overview of the Compute Service](https://docs.us-phoenix-1.oraclecloud.com/Content/Compute/Concepts/computeoverview.htm).
+  #
   class Core::Models::Shape
-    # The name of the shape. You can enumerate all available shapes by calling
+    # **[Required]** The name of the shape. You can enumerate all available shapes by calling
     # {#list_shapes list_shapes}.
     # 
     # @return [String]
@@ -13,6 +16,7 @@ module OCI
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [String] :shape The value to assign to the {#shape} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

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

@@ -3,6 +3,16 @@
 require 'date'
 
 module OCI
+  # A logical subdivision of a VCN. Each subnet exists in a single Availability Domain and
+  # consists of a contiguous range of IP addresses that do not overlap with
+  # other subnets in the VCN. Example: 172.16.1.0/24. For more information, see
+  # [Overview of the Networking Service](https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/overview.htm) and
+  # [VCNs and Subnets](https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingVCNs.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::Subnet
 
     LIFECYCLE_STATE_ENUM = [LIFECYCLE_STATE_PROVISIONING = 'PROVISIONING',
@@ -11,21 +21,21 @@ module OCI
                 LIFECYCLE_STATE_TERMINATED = 'TERMINATED',
                 LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE']
 
-    # The subnet's Availability Domain.
+    # **[Required]** The subnet's Availability Domain.
     # 
     # Example: `Uocm:PHX-AD-1`
     # 
     # @return [String]
     attr_accessor :availability_domain
 
-    # The subnet's CIDR block.
+    # **[Required]** The subnet's CIDR block.
     # 
     # Example: `172.16.1.0/24`
     # 
     # @return [String]
     attr_accessor :cidr_block
 
-    # The OCID of the compartment containing the subnet.
+    # **[Required]** The OCID of the compartment containing the subnet.
     # @return [String]
     attr_accessor :compartment_id
 
@@ -74,11 +84,11 @@ module OCI
     # @return [Hash<String, String>]
     attr_accessor :freeform_tags
 
-    # The subnet's Oracle ID (OCID).
+    # **[Required]** The subnet's Oracle ID (OCID).
     # @return [String]
     attr_accessor :id
 
-    # The subnet's current state.
+    # **[Required]** The subnet's current state.
     # @return [String]
     attr_accessor :lifecycle_state
 
@@ -97,7 +107,7 @@ module OCI
     # @return [BOOLEAN]
     attr_accessor :prohibit_public_ip_on_vnic
 
-    # The OCID of the route table the subnet is using.
+    # **[Required]** The OCID of the route table the subnet is using.
     # @return [String]
     attr_accessor :route_table_id
 
@@ -123,18 +133,18 @@ module OCI
     # @return [DateTime]
     attr_accessor :time_created
 
-    # The OCID of the VCN the subnet is in.
+    # **[Required]** The OCID of the VCN the subnet is in.
     # @return [String]
     attr_accessor :vcn_id
 
-    # The IP address of the virtual router.
+    # **[Required]** The IP address of the virtual router.
     # 
     # Example: `10.0.14.1`
     # 
     # @return [String]
     attr_accessor :virtual_router_ip
 
-    # The MAC address of the virtual router.
+    # **[Required]** The MAC address of the virtual router.
     # 
     # Example: `00:00:17:B6:4D:DD`
     # 
@@ -144,6 +154,24 @@ 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] :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] :dhcpOptionsId The value to assign to the {#dhcp_options_id} 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
+    # @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 [BOOLEAN] :prohibitPublicIpOnVnic The value to assign to the {#prohibit_public_ip_on_vnic} property
+    # @option attributes [String] :routeTableId The value to assign to the {#route_table_id} property
+    # @option attributes [Array<String>] :securityListIds The value to assign to the {#security_list_ids} property
+    # @option attributes [String] :subnetDomainName The value to assign to the {#subnet_domain_name} 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
+    # @option attributes [String] :virtualRouterIp The value to assign to the {#virtual_router_ip} property
+    # @option attributes [String] :virtualRouterMac The value to assign to the {#virtual_router_mac} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 
@@ -190,7 +218,7 @@ module OCI
         self.lifecycle_state = attributes[:'lifecycleState']
       end
 
-      if attributes[:'prohibitPublicIpOnVnic']
+      unless attributes[:'prohibitPublicIpOnVnic'].nil?
         self.prohibit_public_ip_on_vnic = attributes[:'prohibitPublicIpOnVnic']
       end
 

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

@@ -3,6 +3,9 @@
 require 'date'
 
 module OCI
+  # Optional object to specify ports for a TCP rule. If you specify TCP as the
+  # protocol but omit this object, then all ports are allowed.
+  #
   class Core::Models::TcpOptions
     # An inclusive range of allowed destination ports. Use the same number for the min and max
     # to indicate a single port. Defaults to all ports if not specified.
@@ -19,6 +22,8 @@ module OCI
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [OCI::Core::Models::PortRange] :destinationPortRange The value to assign to the {#destination_port_range} property
+    # @option attributes [OCI::Core::Models::PortRange] :sourcePortRange The value to assign to the {#source_port_range} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

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

@@ -3,15 +3,16 @@
 require 'date'
 
 module OCI
+  # Specific connection details for an IPSec tunnel.
   class Core::Models::TunnelConfig
-    # The IP address of Oracle's VPN headend.
+    # **[Required]** The IP address of Oracle's VPN headend.
     # 
     # Example: `129.146.17.50`
     # 
     # @return [String]
     attr_accessor :ip_address
 
-    # The shared secret of the IPSec tunnel.
+    # **[Required]** The shared secret of the IPSec tunnel.
     # 
     # Example: `vFG2IF6TWq4UToUiLSRDoJEUs6j1c.p8G.dVQxiMfMO0yXMLi.lZTbYIWhGu4V8o`
     # 
@@ -28,6 +29,9 @@ module OCI
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [String] :ipAddress The value to assign to the {#ip_address} property
+    # @option attributes [String] :sharedSecret The value to assign to the {#shared_secret} 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/tunnel_status.rb

@@ -3,6 +3,8 @@
 require 'date'
 
 module OCI
+  # Specific connection details for an IPSec tunnel.
+  #
   class Core::Models::TunnelStatus
 
     LIFECYCLE_STATE_ENUM = [LIFECYCLE_STATE_UP = 'UP',
@@ -10,7 +12,7 @@ module OCI
                 LIFECYCLE_STATE_DOWN_FOR_MAINTENANCE = 'DOWN_FOR_MAINTENANCE',
                 LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE']
 
-    # The IP address of Oracle's VPN headend.
+    # **[Required]** The IP address of Oracle's VPN headend.
     # 
     # Example: `129.146.17.50`
     # 
@@ -38,6 +40,10 @@ module OCI
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [String] :ipAddress The value to assign to the {#ip_address} 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 [DateTime] :timeStateModified The value to assign to the {#time_state_modified} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

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

@@ -3,6 +3,9 @@
 require 'date'
 
 module OCI
+  # Optional object to specify ports for a UDP rule. If you specify UDP as the
+  # protocol but omit this object, then all ports are allowed.
+  #
   class Core::Models::UdpOptions
     # An inclusive range of allowed destination ports. Use the same number for the min and max
     # to indicate a single port. Defaults to all ports if not specified.
@@ -19,6 +22,8 @@ module OCI
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [OCI::Core::Models::PortRange] :destinationPortRange The value to assign to the {#destination_port_range} property
+    # @option attributes [OCI::Core::Models::PortRange] :sourcePortRange The value to assign to the {#source_port_range} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

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

@@ -13,6 +13,7 @@ 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
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

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

@@ -29,6 +29,9 @@ module OCI
 
     # 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
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

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

@@ -13,6 +13,7 @@ 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
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

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

@@ -3,6 +3,8 @@
 require 'date'
 
 module OCI
+  # Update a CrossConnect
+  #
   class Core::Models::UpdateCrossConnectDetails
     # A user-friendly name. Does not have to be unique, and it's changeable.
     # Avoid entering confidential information.
@@ -22,6 +24,8 @@ 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 [BOOLEAN] :isActive The value to assign to the {#is_active} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 
@@ -32,7 +36,7 @@ module OCI
         self.display_name = attributes[:'displayName']
       end
 
-      if attributes[:'isActive']
+      unless attributes[:'isActive'].nil?
         self.is_active = attributes[:'isActive']
       end