Class: OCI::Core::Models::PrivateIp
- Inherits:
-
Object
- Object
- OCI::Core::Models::PrivateIp
- Defined in:
- lib/oci/core/models/private_ip.rb
Overview
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](docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingIPaddresses.htm).
Note: Only list_private_ips and 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 or attach_vnic. To update the hostname for a primary private IP, you use 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](docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm).
Instance Attribute Summary collapse
-
#availability_domain ⇒ String
The private IP’s Availability Domain.
-
#compartment_id ⇒ String
The OCID of the compartment containing the private IP.
-
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource.
-
#display_name ⇒ String
A user-friendly name.
-
#freeform_tags ⇒ Hash<String, String>
Free-form tags for this resource.
-
#hostname_label ⇒ String
The hostname for the private IP.
-
#id ⇒ String
The private IP’s Oracle ID (OCID).
-
#ip_address ⇒ String
The private IP address of the ‘privateIp` object.
-
#is_primary ⇒ BOOLEAN
Whether this private IP is the primary one on the VNIC.
-
#subnet_id ⇒ String
The OCID of the subnet the VNIC is in.
-
#time_created ⇒ DateTime
The date and time the private IP was created, in the format defined by RFC3339.
-
#vnic_id ⇒ String
The OCID of the VNIC the private IP is assigned to.
Instance Method Summary collapse
-
#==(other_object) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other_object) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ PrivateIp
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ PrivateIp
Initializes the object
136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 |
# File 'lib/oci/core/models/private_ip.rb', line 136 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[:'availabilityDomain'] self.availability_domain = attributes[:'availabilityDomain'] end raise 'You cannot provide both :availabilityDomain and :availability_domain' if attributes.key?(:'availabilityDomain') && attributes.key?(:'availability_domain') if attributes[:'availability_domain'] self.availability_domain = attributes[:'availability_domain'] end if attributes[:'compartmentId'] self.compartment_id = attributes[:'compartmentId'] end raise 'You cannot provide both :compartmentId and :compartment_id' if attributes.key?(:'compartmentId') && attributes.key?(:'compartment_id') if attributes[:'compartment_id'] self.compartment_id = attributes[:'compartment_id'] end if attributes[:'definedTags'] self. = attributes[:'definedTags'] end raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags') if attributes[:'defined_tags'] self. = attributes[:'defined_tags'] end if attributes[:'displayName'] self.display_name = attributes[:'displayName'] end raise 'You cannot provide both :displayName and :display_name' if attributes.key?(:'displayName') && attributes.key?(:'display_name') if attributes[:'display_name'] self.display_name = attributes[:'display_name'] end if attributes[:'freeformTags'] self. = attributes[:'freeformTags'] end raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags') if attributes[:'freeform_tags'] self. = attributes[:'freeform_tags'] end if attributes[:'hostnameLabel'] self.hostname_label = attributes[:'hostnameLabel'] end raise 'You cannot provide both :hostnameLabel and :hostname_label' if attributes.key?(:'hostnameLabel') && attributes.key?(:'hostname_label') if attributes[:'hostname_label'] self.hostname_label = attributes[:'hostname_label'] end if attributes[:'id'] self.id = attributes[:'id'] end if attributes[:'ipAddress'] self.ip_address = attributes[:'ipAddress'] end raise 'You cannot provide both :ipAddress and :ip_address' if attributes.key?(:'ipAddress') && attributes.key?(:'ip_address') if attributes[:'ip_address'] self.ip_address = attributes[:'ip_address'] end unless attributes[:'isPrimary'].nil? self.is_primary = attributes[:'isPrimary'] end raise 'You cannot provide both :isPrimary and :is_primary' if attributes.key?(:'isPrimary') && attributes.key?(:'is_primary') unless attributes[:'is_primary'].nil? self.is_primary = attributes[:'is_primary'] end if attributes[:'subnetId'] self.subnet_id = attributes[:'subnetId'] end raise 'You cannot provide both :subnetId and :subnet_id' if attributes.key?(:'subnetId') && attributes.key?(:'subnet_id') if attributes[:'subnet_id'] self.subnet_id = attributes[:'subnet_id'] end if attributes[:'timeCreated'] self.time_created = attributes[:'timeCreated'] end raise 'You cannot provide both :timeCreated and :time_created' if attributes.key?(:'timeCreated') && attributes.key?(:'time_created') if attributes[:'time_created'] self.time_created = attributes[:'time_created'] end if attributes[:'vnicId'] self.vnic_id = attributes[:'vnicId'] end raise 'You cannot provide both :vnicId and :vnic_id' if attributes.key?(:'vnicId') && attributes.key?(:'vnic_id') if attributes[:'vnic_id'] self.vnic_id = attributes[:'vnic_id'] end end |
Instance Attribute Details
#availability_domain ⇒ String
The private IP’s Availability Domain.
Example: ‘Uocm:PHX-AD-1`
40 41 42 |
# File 'lib/oci/core/models/private_ip.rb', line 40 def availability_domain @availability_domain end |
#compartment_id ⇒ String
The OCID of the compartment containing the private IP.
44 45 46 |
# File 'lib/oci/core/models/private_ip.rb', line 44 def compartment_id @compartment_id end |
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
Example: ‘{"CostCenter": "42"}`
52 53 54 |
# File 'lib/oci/core/models/private_ip.rb', line 52 def @defined_tags end |
#display_name ⇒ String
A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
58 59 60 |
# File 'lib/oci/core/models/private_ip.rb', line 58 def display_name @display_name end |
#freeform_tags ⇒ Hash<String, String>
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
Example: ‘"Finance"`
67 68 69 |
# File 'lib/oci/core/models/private_ip.rb', line 67 def @freeform_tags end |
#hostname_label ⇒ String
The hostname for the private IP. Used for DNS. The value is the hostname portion of the 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](tools.ietf.org/html/rfc952) and [RFC 1123](tools.ietf.org/html/rfc1123).
For more information, see [DNS in Your Virtual Cloud Network](docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/dns.htm).
Example: ‘bminstance-1`
82 83 84 |
# File 'lib/oci/core/models/private_ip.rb', line 82 def hostname_label @hostname_label end |
#id ⇒ String
The private IP’s Oracle ID (OCID).
86 87 88 |
# File 'lib/oci/core/models/private_ip.rb', line 86 def id @id end |
#ip_address ⇒ String
The private IP address of the ‘privateIp` object. The address is within the CIDR of the VNIC’s subnet.
Example: ‘10.0.3.3`
94 95 96 |
# File 'lib/oci/core/models/private_ip.rb', line 94 def ip_address @ip_address end |
#is_primary ⇒ BOOLEAN
Whether this private IP is the primary one on the VNIC. Primary private IPs are unassigned and deleted automatically when the VNIC is terminated.
Example: ‘true`
102 103 104 |
# File 'lib/oci/core/models/private_ip.rb', line 102 def is_primary @is_primary end |
#subnet_id ⇒ String
The OCID of the subnet the VNIC is in.
106 107 108 |
# File 'lib/oci/core/models/private_ip.rb', line 106 def subnet_id @subnet_id end |
#time_created ⇒ DateTime
The date and time the private IP was created, in the format defined by RFC3339.
Example: ‘2016-08-25T21:10:29.600Z`
113 114 115 |
# File 'lib/oci/core/models/private_ip.rb', line 113 def time_created @time_created end |
#vnic_id ⇒ String
The OCID of the VNIC the private IP is assigned to. The VNIC and private IP must be in the same subnet.
119 120 121 |
# File 'lib/oci/core/models/private_ip.rb', line 119 def vnic_id @vnic_id end |
Instance Method Details
#==(other_object) ⇒ Object
Checks equality by comparing each attribute.
260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 |
# File 'lib/oci/core/models/private_ip.rb', line 260 def ==(other_object) return true if self.equal?(other_object) self.class == other_object.class && availability_domain == other_object.availability_domain && compartment_id == other_object.compartment_id && == other_object. && display_name == other_object.display_name && == other_object. && hostname_label == other_object.hostname_label && id == other_object.id && ip_address == other_object.ip_address && is_primary == other_object.is_primary && subnet_id == other_object.subnet_id && time_created == other_object.time_created && vnic_id == other_object.vnic_id end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 |
# File 'lib/oci/core/models/private_ip.rb', line 292 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.swagger_types.each_pair do |key, type| if type =~ /^Array<(.*)>/i # check to ensure the input is an array given that the the attribute # is documented as an array but the input is not if attributes[self.class.attribute_map[key]].is_a?(Array) self.public_method("#{key}=").call(attributes[self.class.attribute_map[key]].map{ |v| OCI::Internal::Util.convert_to_type($1, v) } ) end elsif !attributes[self.class.attribute_map[key]].nil? self.public_method("#{key}=").call(OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])) end # or else data not found in attributes(hash), not an issue as the data can be optional end self end |
#eql?(other_object) ⇒ Boolean
279 280 281 |
# File 'lib/oci/core/models/private_ip.rb', line 279 def eql?(other_object) self == other_object end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
285 286 287 |
# File 'lib/oci/core/models/private_ip.rb', line 285 def hash [availability_domain, compartment_id, , display_name, , hostname_label, id, ip_address, is_primary, subnet_id, time_created, vnic_id].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
317 318 319 320 321 322 323 324 325 |
# File 'lib/oci/core/models/private_ip.rb', line 317 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = public_method(attr).call next if value.nil? && !instance_variable_defined?("@#{attr}") hash[param] = _to_hash(value) end hash end |
#to_s ⇒ String
Returns the string representation of the object
311 312 313 |
# File 'lib/oci/core/models/private_ip.rb', line 311 def to_s to_hash.to_s end |