oraclebmc 1.2.3 → 1.2.4

data/lib/oraclebmc/core/models/create_security_list_details.rb

@@ -8,7 +8,7 @@ module OracleBMC
     # @return [String]
     attr_accessor :compartment_id
 
-    # A user-friendly name. Does not have to be unique, and it's changeable.
+    # A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
     # @return [String]
     attr_accessor :display_name
 
@@ -33,27 +33,26 @@ module OracleBMC
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
 
-      
       if attributes[:'compartmentId']
         self.compartment_id = attributes[:'compartmentId']
       end
-      
+
       if attributes[:'displayName']
         self.display_name = attributes[:'displayName']
       end
-      
+
       if attributes[:'egressSecurityRules']
         self.egress_security_rules = attributes[:'egressSecurityRules']
       end
-      
+
       if attributes[:'ingressSecurityRules']
         self.ingress_security_rules = attributes[:'ingressSecurityRules']
       end
-      
+
       if attributes[:'vcnId']
         self.vcn_id = attributes[:'vcnId']
       end
-      
+
     end
 
     # Checks equality by comparing each attribute.

data/lib/oraclebmc/core/models/create_subnet_details.rb

@@ -28,7 +28,7 @@ module OracleBMC
     # @return [String]
     attr_accessor :dhcp_options_id
 
-    # A user-friendly name. Does not have to be unique, and it's changeable.
+    # A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
     # @return [String]
     attr_accessor :display_name
 
@@ -50,11 +50,11 @@ module OracleBMC
     # @return [String]
     attr_accessor :dns_label
 
-    # Whether VNICs within this subnet can have public IP addresses. 
+    # Whether VNICs within this subnet can have public IP addresses.
     # Defaults to false, which means VNICs created in this subnet will
     # automatically be assigned public IP addresses unless specified
-    # otherwise during instance launch (with the `assignPublicIp` flag in
-    # {CreateVnicDetails}).
+    # otherwise during instance launch or VNIC creation (with the
+    # `assignPublicIp` flag in {CreateVnicDetails}).
     # If `prohibitPublicIpOnVnic` is set to true, VNICs created in this
     # subnet cannot have public IP addresses (i.e., it's a private
     # subnet).
@@ -91,47 +91,46 @@ module OracleBMC
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
 
-      
       if attributes[:'availabilityDomain']
         self.availability_domain = attributes[:'availabilityDomain']
       end
-      
+
       if attributes[:'cidrBlock']
         self.cidr_block = attributes[:'cidrBlock']
       end
-      
+
       if attributes[:'compartmentId']
         self.compartment_id = attributes[:'compartmentId']
       end
-      
+
       if attributes[:'dhcpOptionsId']
         self.dhcp_options_id = attributes[:'dhcpOptionsId']
       end
-      
+
       if attributes[:'displayName']
         self.display_name = attributes[:'displayName']
       end
-      
+
       if attributes[:'dnsLabel']
         self.dns_label = attributes[:'dnsLabel']
       end
-      
+
       if attributes[:'prohibitPublicIpOnVnic']
         self.prohibit_public_ip_on_vnic = attributes[:'prohibitPublicIpOnVnic']
       end
-      
+
       if attributes[:'routeTableId']
         self.route_table_id = attributes[:'routeTableId']
       end
-      
+
       if attributes[:'securityListIds']
         self.security_list_ids = attributes[:'securityListIds']
       end
-      
+
       if attributes[:'vcnId']
         self.vcn_id = attributes[:'vcnId']
       end
-      
+
     end
 
     # Checks equality by comparing each attribute.

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

@@ -15,7 +15,7 @@ module OracleBMC
     # @return [String]
     attr_accessor :compartment_id
 
-    # A user-friendly name. Does not have to be unique, and it's changeable.
+    # A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
     # @return [String]
     attr_accessor :display_name
 
@@ -23,8 +23,7 @@ module OracleBMC
     # subnet's DNS label to form a fully qualified domain name (FQDN) for each VNIC
     # within this subnet (e.g., `bminstance-1.subnet123.vcn1.oraclevcn.com`).
     # Not required to be unique, but it's a best practice to set unique DNS labels
-    # for VCNs in your tenancy.
-    # Must be an alphanumeric string that begins with a letter.
+    # for VCNs in your tenancy. Must be an alphanumeric string that begins with a letter.
     # The value cannot be changed.
     # 
     # You must set this value if you want instances to be able to use hostnames to
@@ -48,23 +47,22 @@ module OracleBMC
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
 
-      
       if attributes[:'cidrBlock']
         self.cidr_block = attributes[:'cidrBlock']
       end
-      
+
       if attributes[:'compartmentId']
         self.compartment_id = attributes[:'compartmentId']
       end
-      
+
       if attributes[:'displayName']
         self.display_name = attributes[:'displayName']
       end
-      
+
       if attributes[:'dnsLabel']
         self.dns_label = attributes[:'dnsLabel']
       end
-      
+
     end
 
     # Checks equality by comparing each attribute.

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

@@ -35,7 +35,7 @@ module OracleBMC
     # @return [Integer]
     attr_accessor :customer_bgp_asn
 
-    # A user-friendly name. Does not have to be unique, and it's changeable.
+    # A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
     # 
     # @return [String]
     attr_accessor :display_name
@@ -84,47 +84,46 @@ module OracleBMC
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
 
-      
       if attributes[:'bandwidthShapeName']
         self.bandwidth_shape_name = attributes[:'bandwidthShapeName']
       end
-      
+
       if attributes[:'compartmentId']
         self.compartment_id = attributes[:'compartmentId']
       end
-      
+
       if attributes[:'crossConnectMappings']
         self.cross_connect_mappings = attributes[:'crossConnectMappings']
       end
-      
+
       if attributes[:'customerBgpAsn']
         self.customer_bgp_asn = attributes[:'customerBgpAsn']
       end
-      
+
       if attributes[:'displayName']
         self.display_name = attributes[:'displayName']
       end
-      
+
       if attributes[:'gatewayId']
         self.gateway_id = attributes[:'gatewayId']
       end
-      
+
       if attributes[:'providerName']
         self.provider_name = attributes[:'providerName']
       end
-      
+
       if attributes[:'providerServiceName']
         self.provider_service_name = attributes[:'providerServiceName']
       end
-      
+
       if attributes[:'region']
         self.region = attributes[:'region']
       end
-      
+
       if attributes[:'type']
         self.type = attributes[:'type']
       end
-      
+
     end
 
     # Custom attribute writer method checking allowed values (enum).

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

@@ -6,11 +6,16 @@ module OracleBMC
   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
-    # in a private subnet (i.e., where `prohibitPublicIpOnVnic`=true in the
+    # in a private subnet (i.e., where `prohibitPublicIpOnVnic` = true in the
     # {Subnet}), then no public IP address is assigned.
-    # If not set and the subnet is public (`prohibitPublicIpOnVnic`=false), then
-    # a public IP address is assigned. If set to true and 
-    # `prohibitPublicIpOnVnic`=true, an error is returned.
+    # If not set and the subnet is public (`prohibitPublicIpOnVnic` = false), then
+    # a public IP address is assigned. If set to true and
+    # `prohibitPublicIpOnVnic` = true, an error is returned.
+    # 
+    # **Note:** This public IP address is associated with the primary private IP
+    # on the VNIC. Secondary private IPs cannot have public IP
+    # addresses associated with them. For more information, see
+    # [Managing IP Addresses](https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingIPaddresses.htm).
     # 
     # Example: `false`
     # 
@@ -18,45 +23,53 @@ module OracleBMC
     attr_accessor :assign_public_ip
 
     # A user-friendly name for the VNIC. Does not have to be unique.
+    # Avoid entering confidential information.
+    # 
     # @return [String]
     attr_accessor :display_name
 
-    # The hostname for the VNIC that is created during instance launch.
-    # Used for DNS. The value is the hostname portion of the instance's
-    # fully qualified domain name (FQDN) (e.g., `bminstance-1` in FQDN
-    # `bminstance-1.subnet123.vcn1.oraclevcn.com`).
+    # The hostname for the VNIC's primary private IP. Used for DNS. The value is the hostname
+    # portion of the primary private IP's fully qualified domain name (FQDN)
+    # (for example, `bminstance-1` in FQDN `bminstance-1.subnet123.vcn1.oraclevcn.com`).
     # Must be unique across all VNICs in the subnet and comply with
     # [RFC 952](https://tools.ietf.org/html/rfc952) and
     # [RFC 1123](https://tools.ietf.org/html/rfc1123).
-    # The value cannot be changed, and it can be retrieved from the
-    # {Vnic}.
-    #     
+    # The value appears in the {Vnic} object and also the
+    # {PrivateIp} object returned by
+    # {#list_private_ips list_private_ips} and
+    # {#get_private_ip get_private_ip}.
+    # 
     # For more information, see
     # [DNS in Your Virtual Cloud Network](https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/dns.htm).
     # 
-    # Use this `hostnameLabel` instead
-    # of the deprecated `hostnameLabel` in 
+    # When launching an instance, use this `hostnameLabel` instead
+    # of the deprecated `hostnameLabel` in
     # {#launch_instance_details launch_instance_details}.
-    # If you provide both, the values must match. 
+    # If you provide both, the values must match.
     # 
     # Example: `bminstance-1`
     # 
     # @return [String]
     attr_accessor :hostname_label
 
-    # A private IP address of your choice to assign to the VNIC. Must be an 
-    # available IP address within the subnet's CIDR. If no value is specified,
-    # a private IP address from the subnet will be automatically assigned. 
+    # A private IP address of your choice to assign to the VNIC. Must be an
+    # available IP address within the subnet's CIDR. If you don't specify a
+    # value, Oracle automatically assigns a private IP address from the subnet.
+    # This is the VNIC's *primary* private IP address. The value appears in
+    # the {Vnic} object and also the
+    # {PrivateIp} object returned by
+    # {#list_private_ips list_private_ips} and
+    # {#get_private_ip get_private_ip}.
     # 
-    # Example: `10.0.3.1`
+    # Example: `10.0.3.3`
     # 
     # @return [String]
     attr_accessor :private_ip
 
-    # The OCID of the subnet to create the VNIC in. Use this `subnetId` instead
-    # of the deprecated `subnetId` in 
+    # 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.          
+    # At least one of them is required; if you provide both, the values must match.
     # 
     # @return [String]
     attr_accessor :subnet_id
@@ -70,27 +83,26 @@ module OracleBMC
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
 
-      
       if attributes[:'assignPublicIp']
         self.assign_public_ip = attributes[:'assignPublicIp']
       end
-      
+
       if attributes[:'displayName']
         self.display_name = attributes[:'displayName']
       end
-      
+
       if attributes[:'hostnameLabel']
         self.hostname_label = attributes[:'hostnameLabel']
       end
-      
+
       if attributes[:'privateIp']
         self.private_ip = attributes[:'privateIp']
       end
-      
+
       if attributes[:'subnetId']
         self.subnet_id = attributes[:'subnetId']
       end
-      
+
     end
 
     # Checks equality by comparing each attribute.

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

@@ -5,6 +5,8 @@ require 'date'
 module OracleBMC
   class Core::Models::CreateVolumeBackupDetails
     # A user-friendly name for the volume backup. Does not have to be unique and it's changeable.
+    # Avoid entering confidential information.
+    # 
     # @return [String]
     attr_accessor :display_name
 
@@ -21,15 +23,14 @@ module OracleBMC
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
 
-      
       if attributes[:'displayName']
         self.display_name = attributes[:'displayName']
       end
-      
+
       if attributes[:'volumeId']
         self.volume_id = attributes[:'volumeId']
       end
-      
+
     end
 
     # Checks equality by comparing each attribute.

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

@@ -16,6 +16,7 @@ module OracleBMC
     attr_accessor :compartment_id
 
     # A user-friendly name. Does not have to be unique, and it's changeable.
+    # Avoid entering confidential information.
     # 
     # @return [String]
     attr_accessor :display_name
@@ -38,27 +39,26 @@ module OracleBMC
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
 
-      
       if attributes[:'availabilityDomain']
         self.availability_domain = attributes[:'availabilityDomain']
       end
-      
+
       if attributes[:'compartmentId']
         self.compartment_id = attributes[:'compartmentId']
       end
-      
+
       if attributes[:'displayName']
         self.display_name = attributes[:'displayName']
       end
-      
+
       if attributes[:'sizeInMBs']
         self.size_in_m_bs = attributes[:'sizeInMBs']
       end
-      
+
       if attributes[:'volumeBackupId']
         self.volume_backup_id = attributes[:'volumeBackupId']
       end
-      
+
     end
 
     # Checks equality by comparing each attribute.

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

@@ -22,6 +22,8 @@ module OracleBMC
     attr_accessor :cross_connect_group_id
 
     # A user-friendly name. Does not have to be unique, and it's changeable.
+    # Avoid entering confidential information.
+    # 
     # @return [String]
     attr_accessor :display_name
 
@@ -64,43 +66,42 @@ module OracleBMC
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
 
-      
       if attributes[:'compartmentId']
         self.compartment_id = attributes[:'compartmentId']
       end
-      
+
       if attributes[:'crossConnectGroupId']
         self.cross_connect_group_id = attributes[:'crossConnectGroupId']
       end
-      
+
       if attributes[:'displayName']
         self.display_name = attributes[:'displayName']
       end
-      
+
       if attributes[:'id']
         self.id = attributes[:'id']
       end
-      
+
       if attributes[:'lifecycleState']
         self.lifecycle_state = attributes[:'lifecycleState']
       end
-      
+
       if attributes[:'locationName']
         self.location_name = attributes[:'locationName']
       end
-      
+
       if attributes[:'portName']
         self.port_name = attributes[:'portName']
       end
-      
+
       if attributes[:'portSpeedShapeName']
         self.port_speed_shape_name = attributes[:'portSpeedShapeName']
       end
-      
+
       if attributes[:'timeCreated']
         self.time_created = attributes[:'timeCreated']
       end
-      
+
     end
 
     # Custom attribute writer method checking allowed values (enum).