class OCI::Core::Models::PublicIp
A *public IP* is a conceptual term that refers to a public IP address and related properties. The `publicIp` object is the API representation of a public IP.
There are two types of public IPs:
-
Ephemeral
-
Reserved
For more information and comparison of the two types, see [Public IP Addresses](docs.cloud.oracle.com/iaas/Content/Network/Tasks/managingpublicIPs.htm).
Constants
- ASSIGNED_ENTITY_TYPE_ENUM
- LIFECYCLE_STATE_ENUM
- LIFETIME_ENUM
- SCOPE_ENUM
Attributes
The OCID of the entity the public IP is assigned to, or in the process of being assigned to.
@return [String]
The type of entity the public IP is assigned to, or in the process of being assigned to.
@return [String]
The public IP's availability domain. This property is set only for ephemeral public IPs that are assigned to a private IP (that is, when the `scope` of the public IP is set to AVAILABILITY_DOMAIN). The value is the availability domain of the assigned private IP.
Example: `Uocm:PHX-AD-1`
@return [String]
The OCID of the compartment containing the public IP. For an ephemeral public IP, this is the compartment of its assigned entity (which can be a private IP or a regional entity such as a NAT gateway). For a reserved public IP that is currently assigned, its compartment can be different from the assigned private IP's.
@return [String]
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
@return [String]
The public IP's Oracle ID (OCID). @return [String]
The public IP address of the `publicIp` object.
Example: `203.0.113.2`
@return [String]
The public IP's current state. @return [String]
Defines when the public IP is deleted and released back to Oracle's public IP pool.
-
`EPHEMERAL`: The lifetime is tied to the lifetime of its assigned entity. An ephemeral
public IP must always be assigned to an entity. If the assigned entity is a private IP, the ephemeral public IP is automatically deleted when the private IP is deleted, when the VNIC is terminated, or when the instance is terminated. If the assigned entity is a {NatGateway}, the ephemeral public IP is automatically deleted when the NAT gateway is terminated.
-
`RESERVED`: You control the public IP's lifetime. You can delete a reserved public IP
whenever you like. It does not need to be assigned to a private IP at all times.
For more information and comparison of the two types, see [Public IP Addresses](docs.cloud.oracle.com/iaas/Content/Network/Tasks/managingpublicIPs.htm).
@return [String]
Deprecated. Use `assignedEntityId` instead.
The OCID of the private IP that the public IP is currently assigned to, or in the process of being assigned to.
Note: This is `null` if the public IP is not assigned to a private IP, or is in the process of being assigned to one.
@return [String]
The [OCID](docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the pool object created in the current tenancy. @return [String]
Whether the public IP is regional or specific to a particular availability domain.
-
`REGION`: The public IP exists within a region and is assigned to a regional entity
(such as a {NatGateway}), or can be assigned to a private IP in any availability domain in the region. Reserved public IPs and ephemeral public IPs assigned to a regional entity have `scope` = `REGION`.
-
`AVAILABILITY_DOMAIN`: The public IP exists within the availability domain of the entity
it's assigned to, which is specified by the `availabilityDomain` property of the public IP object. Ephemeral public IPs that are assigned to private IPs have `scope` = `AVAILABILITY_DOMAIN`.
@return [String]
The date and time the public IP was created, in the format defined by [RFC3339](tools.ietf.org/html/rfc3339).
Example: `2016-08-25T21:10:29.600Z`
@return [DateTime]
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/oci/core/models/public_ip.rb, line 171 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'assigned_entity_id': :'assignedEntityId', 'assigned_entity_type': :'assignedEntityType', 'availability_domain': :'availabilityDomain', 'compartment_id': :'compartmentId', 'defined_tags': :'definedTags', 'display_name': :'displayName', 'freeform_tags': :'freeformTags', 'id': :'id', 'ip_address': :'ipAddress', 'lifecycle_state': :'lifecycleState', 'lifetime': :'lifetime', 'private_ip_id': :'privateIpId', 'scope': :'scope', 'time_created': :'timeCreated', 'public_ip_pool_id': :'publicIpPoolId' # rubocop:enable Style/SymbolLiteral } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :assigned_entity_id The value to assign to the {#assigned_entity_id} property @option attributes [String] :assigned_entity_type The value to assign to the {#assigned_entity_type} property @option attributes [String] :availability_domain The value to assign to the {#availability_domain} property @option attributes [String] :compartment_id The value to assign to the {#compartment_id} property @option attributes [Hash<String, Hash<String, Object>>] :defined_tags The value to assign to the {#defined_tags} property @option attributes [String] :display_name The value to assign to the {#display_name} property @option attributes [Hash<String, String>] :freeform_tags The value to assign to the {#freeform_tags} property @option attributes [String] :id The value to assign to the {#id} property @option attributes [String] :ip_address The value to assign to the {#ip_address} property @option attributes [String] :lifecycle_state The value to assign to the {#lifecycle_state} property @option attributes [String] :lifetime The value to assign to the {#lifetime} property @option attributes [String] :private_ip_id The value to assign to the {#private_ip_id} property @option attributes [String] :scope The value to assign to the {#scope} property @option attributes [DateTime] :time_created The value to assign to the {#time_created} property @option attributes [String] :public_ip_pool_id The value to assign to the {#public_ip_pool_id} property
# File lib/oci/core/models/public_ip.rb, line 237 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.assigned_entity_id = attributes[:'assignedEntityId'] if attributes[:'assignedEntityId'] raise 'You cannot provide both :assignedEntityId and :assigned_entity_id' if attributes.key?(:'assignedEntityId') && attributes.key?(:'assigned_entity_id') self.assigned_entity_id = attributes[:'assigned_entity_id'] if attributes[:'assigned_entity_id'] self.assigned_entity_type = attributes[:'assignedEntityType'] if attributes[:'assignedEntityType'] raise 'You cannot provide both :assignedEntityType and :assigned_entity_type' if attributes.key?(:'assignedEntityType') && attributes.key?(:'assigned_entity_type') self.assigned_entity_type = attributes[:'assigned_entity_type'] if attributes[:'assigned_entity_type'] 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.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags'] raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags') self.defined_tags = 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.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags'] raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags') self.freeform_tags = attributes[:'freeform_tags'] if attributes[:'freeform_tags'] 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.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState'] raise 'You cannot provide both :lifecycleState and :lifecycle_state' if attributes.key?(:'lifecycleState') && attributes.key?(:'lifecycle_state') self.lifecycle_state = attributes[:'lifecycle_state'] if attributes[:'lifecycle_state'] self.lifetime = attributes[:'lifetime'] if attributes[:'lifetime'] self.private_ip_id = attributes[:'privateIpId'] if attributes[:'privateIpId'] raise 'You cannot provide both :privateIpId and :private_ip_id' if attributes.key?(:'privateIpId') && attributes.key?(:'private_ip_id') self.private_ip_id = attributes[:'private_ip_id'] if attributes[:'private_ip_id'] self.scope = attributes[:'scope'] if attributes[:'scope'] 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.public_ip_pool_id = attributes[:'publicIpPoolId'] if attributes[:'publicIpPoolId'] raise 'You cannot provide both :publicIpPoolId and :public_ip_pool_id' if attributes.key?(:'publicIpPoolId') && attributes.key?(:'public_ip_pool_id') self.public_ip_pool_id = attributes[:'public_ip_pool_id'] if attributes[:'public_ip_pool_id'] end
Attribute type mapping.
# File lib/oci/core/models/public_ip.rb, line 194 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'assigned_entity_id': :'String', 'assigned_entity_type': :'String', 'availability_domain': :'String', 'compartment_id': :'String', 'defined_tags': :'Hash<String, Hash<String, Object>>', 'display_name': :'String', 'freeform_tags': :'Hash<String, String>', 'id': :'String', 'ip_address': :'String', 'lifecycle_state': :'String', 'lifetime': :'String', 'private_ip_id': :'String', 'scope': :'String', 'time_created': :'DateTime', 'public_ip_pool_id': :'String' # rubocop:enable Style/SymbolLiteral } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] other the other object to be compared
# File lib/oci/core/models/public_ip.rb, line 381 def ==(other) return true if equal?(other) self.class == other.class && assigned_entity_id == other.assigned_entity_id && assigned_entity_type == other.assigned_entity_type && availability_domain == other.availability_domain && compartment_id == other.compartment_id && defined_tags == other.defined_tags && display_name == other.display_name && freeform_tags == other.freeform_tags && id == other.id && ip_address == other.ip_address && lifecycle_state == other.lifecycle_state && lifetime == other.lifetime && private_ip_id == other.private_ip_id && scope == other.scope && time_created == other.time_created && public_ip_pool_id == other.public_ip_pool_id end
Custom attribute writer method checking allowed values (enum). @param [Object] assigned_entity_type
Object
to be assigned
# File lib/oci/core/models/public_ip.rb, line 326 def assigned_entity_type=(assigned_entity_type) # rubocop:disable Style/ConditionalAssignment if assigned_entity_type && !ASSIGNED_ENTITY_TYPE_ENUM.include?(assigned_entity_type) OCI.logger.debug("Unknown value for 'assigned_entity_type' [" + assigned_entity_type + "]. Mapping to 'ASSIGNED_ENTITY_TYPE_UNKNOWN_ENUM_VALUE'") if OCI.logger @assigned_entity_type = ASSIGNED_ENTITY_TYPE_UNKNOWN_ENUM_VALUE else @assigned_entity_type = assigned_entity_type end # rubocop:enable Style/ConditionalAssignment end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/oci/core/models/public_ip.rb, line 425 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
@see the `==` method @param [Object] other the other object to be compared
# File lib/oci/core/models/public_ip.rb, line 405 def eql?(other) self == other end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/oci/core/models/public_ip.rb, line 414 def hash [assigned_entity_id, assigned_entity_type, availability_domain, compartment_id, defined_tags, display_name, freeform_tags, id, ip_address, lifecycle_state, lifetime, private_ip_id, scope, time_created, public_ip_pool_id].hash end
Custom attribute writer method checking allowed values (enum). @param [Object] lifecycle_state
Object
to be assigned
# File lib/oci/core/models/public_ip.rb, line 339 def lifecycle_state=(lifecycle_state) # rubocop:disable Style/ConditionalAssignment if lifecycle_state && !LIFECYCLE_STATE_ENUM.include?(lifecycle_state) OCI.logger.debug("Unknown value for 'lifecycle_state' [" + lifecycle_state + "]. Mapping to 'LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE'") if OCI.logger @lifecycle_state = LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE else @lifecycle_state = lifecycle_state end # rubocop:enable Style/ConditionalAssignment end
Custom attribute writer method checking allowed values (enum). @param [Object] lifetime Object
to be assigned
# File lib/oci/core/models/public_ip.rb, line 352 def lifetime=(lifetime) # rubocop:disable Style/ConditionalAssignment if lifetime && !LIFETIME_ENUM.include?(lifetime) OCI.logger.debug("Unknown value for 'lifetime' [" + lifetime + "]. Mapping to 'LIFETIME_UNKNOWN_ENUM_VALUE'") if OCI.logger @lifetime = LIFETIME_UNKNOWN_ENUM_VALUE else @lifetime = lifetime end # rubocop:enable Style/ConditionalAssignment end
Custom attribute writer method checking allowed values (enum). @param [Object] scope Object
to be assigned
# File lib/oci/core/models/public_ip.rb, line 365 def scope=(scope) # rubocop:disable Style/ConditionalAssignment if scope && !SCOPE_ENUM.include?(scope) OCI.logger.debug("Unknown value for 'scope' [" + scope + "]. Mapping to 'SCOPE_UNKNOWN_ENUM_VALUE'") if OCI.logger @scope = SCOPE_UNKNOWN_ENUM_VALUE else @scope = scope end # rubocop:enable Style/ConditionalAssignment end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/oci/core/models/public_ip.rb, line 458 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/oci/core/models/public_ip.rb, line 452 def to_s to_hash.to_s end
Private Instance Methods
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# File lib/oci/core/models/public_ip.rb, line 475 def _to_hash(value) if value.is_a?(Array) value.compact.map { |v| _to_hash(v) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v) } end elsif value.respond_to? :to_hash value.to_hash else value end end