Class: OCI::VnMonitoring::Models::PrivateIp
- Inherits:
-
Object
- Object
- OCI::VnMonitoring::Models::PrivateIp
- Defined in:
- lib/oci/vn_monitoring/models/private_ip.rb
Overview
A private IP is a conceptual term that refers to an IPv4 private IP address and related properties. The privateIp
object is the API representation of a private IP.
Note: For information about IPv6 addresses, see Ipv6.
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.
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.
PrivateIp
objects that are created for use with the Oracle Cloud VMware Solution are assigned to a VLAN and not a VNIC in a subnet. See the descriptions of the relevant attributes in the PrivateIp
object. Also see Vlan.
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.
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>
Simple key-value pair that is applied without any predefined name, type or scope.
-
#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.
-
#vlan_id ⇒ String
Applicable only if the
PrivateIp
object is being used with a VLAN as part of the Oracle Cloud VMware Solution. -
#vnic_id ⇒ String
The OCID of the VNIC the private IP is assigned to.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ 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
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 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 |
# File 'lib/oci/vn_monitoring/models/private_ip.rb', line 205 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 } self.availability_domain = attributes[:'availabilityDomain'] if attributes[:'availabilityDomain'] raise 'You cannot provide both :availabilityDomain and :availability_domain' if attributes.key?(:'availabilityDomain') && attributes.key?(:'availability_domain') self.availability_domain = attributes[:'availability_domain'] if attributes[:'availability_domain'] self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId'] raise 'You cannot provide both :compartmentId and :compartment_id' if attributes.key?(:'compartmentId') && attributes.key?(:'compartment_id') self.compartment_id = attributes[:'compartment_id'] if attributes[:'compartment_id'] self. = attributes[:'definedTags'] if attributes[:'definedTags'] raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags') self. = attributes[:'defined_tags'] if attributes[:'defined_tags'] self.display_name = attributes[:'displayName'] if attributes[:'displayName'] raise 'You cannot provide both :displayName and :display_name' if attributes.key?(:'displayName') && attributes.key?(:'display_name') self.display_name = attributes[:'display_name'] if attributes[:'display_name'] self. = attributes[:'freeformTags'] if attributes[:'freeformTags'] raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags') self. = attributes[:'freeform_tags'] if attributes[:'freeform_tags'] self.hostname_label = attributes[:'hostnameLabel'] if attributes[:'hostnameLabel'] raise 'You cannot provide both :hostnameLabel and :hostname_label' if attributes.key?(:'hostnameLabel') && attributes.key?(:'hostname_label') self.hostname_label = attributes[:'hostname_label'] if attributes[:'hostname_label'] self.id = attributes[:'id'] if attributes[:'id'] self.ip_address = attributes[:'ipAddress'] if attributes[:'ipAddress'] raise 'You cannot provide both :ipAddress and :ip_address' if attributes.key?(:'ipAddress') && attributes.key?(:'ip_address') self.ip_address = attributes[:'ip_address'] if attributes[:'ip_address'] self.is_primary = attributes[:'isPrimary'] unless attributes[:'isPrimary'].nil? raise 'You cannot provide both :isPrimary and :is_primary' if attributes.key?(:'isPrimary') && attributes.key?(:'is_primary') self.is_primary = attributes[:'is_primary'] unless attributes[:'is_primary'].nil? self.vlan_id = attributes[:'vlanId'] if attributes[:'vlanId'] raise 'You cannot provide both :vlanId and :vlan_id' if attributes.key?(:'vlanId') && attributes.key?(:'vlan_id') self.vlan_id = attributes[:'vlan_id'] if attributes[:'vlan_id'] self.subnet_id = attributes[:'subnetId'] if attributes[:'subnetId'] raise 'You cannot provide both :subnetId and :subnet_id' if attributes.key?(:'subnetId') && attributes.key?(:'subnet_id') self.subnet_id = attributes[:'subnet_id'] if attributes[:'subnet_id'] self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated'] raise 'You cannot provide both :timeCreated and :time_created' if attributes.key?(:'timeCreated') && attributes.key?(:'time_created') self.time_created = attributes[:'time_created'] if attributes[:'time_created'] self.vnic_id = attributes[:'vnicId'] if attributes[:'vnicId'] raise 'You cannot provide both :vnicId and :vnic_id' if attributes.key?(:'vnicId') && attributes.key?(:'vnic_id') self.vnic_id = attributes[:'vnic_id'] if attributes[:'vnic_id'] end |
Instance Attribute Details
#availability_domain ⇒ String
The private IP's availability domain. This attribute will be null if this is a secondary private IP assigned to a VNIC that is in a regional subnet.
Example: Uocm:PHX-AD-1
51 52 53 |
# File 'lib/oci/vn_monitoring/models/private_ip.rb', line 51 def availability_domain @availability_domain end |
#compartment_id ⇒ String
The OCID of the compartment containing the private IP.
55 56 57 |
# File 'lib/oci/vn_monitoring/models/private_ip.rb', line 55 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. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}
61 62 63 |
# File 'lib/oci/vn_monitoring/models/private_ip.rb', line 61 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.
67 68 69 |
# File 'lib/oci/vn_monitoring/models/private_ip.rb', line 67 def display_name @display_name end |
#freeform_tags ⇒ Hash<String, String>
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {\"bar-key\": \"value\"}
73 74 75 |
# File 'lib/oci/vn_monitoring/models/private_ip.rb', line 73 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, bminstance1
in FQDN bminstance1.subnet123.vcn1.oraclevcn.com
). Must be unique across all VNICs in the subnet and comply with RFC 952 and RFC 1123.
For more information, see DNS in Your Virtual Cloud Network.
Example: bminstance1
88 89 90 |
# File 'lib/oci/vn_monitoring/models/private_ip.rb', line 88 def hostname_label @hostname_label end |
#id ⇒ String
The private IP's Oracle ID (OCID).
92 93 94 |
# File 'lib/oci/vn_monitoring/models/private_ip.rb', line 92 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.
However, if the PrivateIp
object is being used with a VLAN as part of the Oracle Cloud VMware Solution, the address is from the range specified by the cidrBlock
attribute for the VLAN. See Vlan.
Example: 10.0.3.3
104 105 106 |
# File 'lib/oci/vn_monitoring/models/private_ip.rb', line 104 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
112 113 114 |
# File 'lib/oci/vn_monitoring/models/private_ip.rb', line 112 def is_primary @is_primary end |
#subnet_id ⇒ String
The OCID of the subnet the VNIC is in.
However, if the PrivateIp
object is being used with a VLAN as part of the Oracle Cloud VMware Solution, the subnetId
is null.
127 128 129 |
# File 'lib/oci/vn_monitoring/models/private_ip.rb', line 127 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
134 135 136 |
# File 'lib/oci/vn_monitoring/models/private_ip.rb', line 134 def time_created @time_created end |
#vlan_id ⇒ String
119 120 121 |
# File 'lib/oci/vn_monitoring/models/private_ip.rb', line 119 def vlan_id @vlan_id 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. However, if the PrivateIp
object is being used with a VLAN as part of the Oracle Cloud VMware Solution, the vnicId
is null.
142 143 144 |
# File 'lib/oci/vn_monitoring/models/private_ip.rb', line 142 def vnic_id @vnic_id end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 |
# File 'lib/oci/vn_monitoring/models/private_ip.rb', line 145 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'availability_domain': :'availabilityDomain', 'compartment_id': :'compartmentId', 'defined_tags': :'definedTags', 'display_name': :'displayName', 'freeform_tags': :'freeformTags', 'hostname_label': :'hostnameLabel', 'id': :'id', 'ip_address': :'ipAddress', 'is_primary': :'isPrimary', 'vlan_id': :'vlanId', 'subnet_id': :'subnetId', 'time_created': :'timeCreated', 'vnic_id': :'vnicId' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 |
# File 'lib/oci/vn_monitoring/models/private_ip.rb', line 166 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'availability_domain': :'String', 'compartment_id': :'String', 'defined_tags': :'Hash<String, Hash<String, Object>>', 'display_name': :'String', 'freeform_tags': :'Hash<String, String>', 'hostname_label': :'String', 'id': :'String', 'ip_address': :'String', 'is_primary': :'BOOLEAN', 'vlan_id': :'String', 'subnet_id': :'String', 'time_created': :'DateTime', 'vnic_id': :'String' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 |
# File 'lib/oci/vn_monitoring/models/private_ip.rb', line 293 def ==(other) return true if equal?(other) self.class == other.class && availability_domain == other.availability_domain && compartment_id == other.compartment_id && == other. && display_name == other.display_name && == other. && hostname_label == other.hostname_label && id == other.id && ip_address == other.ip_address && is_primary == other.is_primary && vlan_id == other.vlan_id && subnet_id == other.subnet_id && time_created == other.time_created && vnic_id == other.vnic_id end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 |
# File 'lib/oci/vn_monitoring/models/private_ip.rb', line 335 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) public_method("#{key}=").call( attributes[self.class.attribute_map[key]] .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) } ) end elsif !attributes[self.class.attribute_map[key]].nil? 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) ⇒ Boolean
315 316 317 |
# File 'lib/oci/vn_monitoring/models/private_ip.rb', line 315 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
324 325 326 |
# File 'lib/oci/vn_monitoring/models/private_ip.rb', line 324 def hash [availability_domain, compartment_id, , display_name, , hostname_label, id, ip_address, is_primary, vlan_id, subnet_id, time_created, vnic_id].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
368 369 370 371 372 373 374 375 376 377 |
# File 'lib/oci/vn_monitoring/models/private_ip.rb', line 368 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
362 363 364 |
# File 'lib/oci/vn_monitoring/models/private_ip.rb', line 362 def to_s to_hash.to_s end |