Class: OCI::Core::Models::PublicIp

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/core/models/public_ip.rb

Overview

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: 1. Ephemeral 2. Reserved

For more information and comparison of the two types, see Public IP Addresses.

Constant Summary collapse

ASSIGNED_ENTITY_TYPE_ENUM =
[
  ASSIGNED_ENTITY_TYPE_PRIVATE_IP = 'PRIVATE_IP'.freeze,
  ASSIGNED_ENTITY_TYPE_NAT_GATEWAY = 'NAT_GATEWAY'.freeze,
  ASSIGNED_ENTITY_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_STATE_ENUM =
[
  LIFECYCLE_STATE_PROVISIONING = 'PROVISIONING'.freeze,
  LIFECYCLE_STATE_AVAILABLE = 'AVAILABLE'.freeze,
  LIFECYCLE_STATE_ASSIGNING = 'ASSIGNING'.freeze,
  LIFECYCLE_STATE_ASSIGNED = 'ASSIGNED'.freeze,
  LIFECYCLE_STATE_UNASSIGNING = 'UNASSIGNING'.freeze,
  LIFECYCLE_STATE_UNASSIGNED = 'UNASSIGNED'.freeze,
  LIFECYCLE_STATE_TERMINATING = 'TERMINATING'.freeze,
  LIFECYCLE_STATE_TERMINATED = 'TERMINATED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFETIME_ENUM =
[
  LIFETIME_EPHEMERAL = 'EPHEMERAL'.freeze,
  LIFETIME_RESERVED = 'RESERVED'.freeze,
  LIFETIME_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
SCOPE_ENUM =
[
  SCOPE_REGION = 'REGION'.freeze,
  SCOPE_AVAILABILITY_DOMAIN = 'AVAILABILITY_DOMAIN'.freeze,
  SCOPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PublicIp

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {})

    Model attributes in the form of hash

Options Hash (attributes):

  • :assigned_entity_id (String)

    The value to assign to the #assigned_entity_id property

  • :assigned_entity_type (String)

    The value to assign to the #assigned_entity_type property

  • :availability_domain (String)

    The value to assign to the #availability_domain property

  • :compartment_id (String)

    The value to assign to the #compartment_id property

  • :defined_tags (Hash<String, Hash<String, Object>>)

    The value to assign to the #defined_tags property

  • :display_name (String)

    The value to assign to the #display_name property

  • :freeform_tags (Hash<String, String>)

    The value to assign to the #freeform_tags property

  • :id (String)

    The value to assign to the #id property

  • :ip_address (String)

    The value to assign to the #ip_address property

  • :lifecycle_state (String)

    The value to assign to the #lifecycle_state property

  • :lifetime (String)

    The value to assign to the #lifetime property

  • :private_ip_id (String)

    The value to assign to the #private_ip_id property

  • :scope (String)

    The value to assign to the #scope property

  • :time_created (DateTime)

    The value to assign to the #time_created property

  • :public_ip_pool_id (String)

    The value to assign to the #public_ip_pool_id property



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
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
# 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

Instance Attribute Details

#assigned_entity_idString

The OCID of the entity the public IP is assigned to, or in the process of being assigned to.

Returns:

  • (String)


54
55
56
# File 'lib/oci/core/models/public_ip.rb', line 54

def assigned_entity_id
  @assigned_entity_id
end

#assigned_entity_typeString

The type of entity the public IP is assigned to, or in the process of being assigned to.

Returns:

  • (String)


60
61
62
# File 'lib/oci/core/models/public_ip.rb', line 60

def assigned_entity_type
  @assigned_entity_type
end

#availability_domainString

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

Returns:

  • (String)


69
70
71
# File 'lib/oci/core/models/public_ip.rb', line 69

def availability_domain
  @availability_domain
end

#compartment_idString

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.

Returns:

  • (String)


77
78
79
# File 'lib/oci/core/models/public_ip.rb', line 77

def compartment_id
  @compartment_id
end

#defined_tagsHash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

  • (Hash<String, Hash<String, Object>>)


85
86
87
# File 'lib/oci/core/models/public_ip.rb', line 85

def defined_tags
  @defined_tags
end

#display_nameString

A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Returns:

  • (String)


91
92
93
# File 'lib/oci/core/models/public_ip.rb', line 91

def display_name
  @display_name
end

#freeform_tagsHash<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.

Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>)


99
100
101
# File 'lib/oci/core/models/public_ip.rb', line 99

def freeform_tags
  @freeform_tags
end

#idString

The public IP's Oracle ID (OCID).

Returns:

  • (String)


103
104
105
# File 'lib/oci/core/models/public_ip.rb', line 103

def id
  @id
end

#ip_addressString

The public IP address of the publicIp object.

Example: 203.0.113.2

Returns:

  • (String)


110
111
112
# File 'lib/oci/core/models/public_ip.rb', line 110

def ip_address
  @ip_address
end

#lifecycle_stateString

The public IP's current state.

Returns:

  • (String)


114
115
116
# File 'lib/oci/core/models/public_ip.rb', line 114

def lifecycle_state
  @lifecycle_state
end

#lifetimeString

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.

Returns:

  • (String)


132
133
134
# File 'lib/oci/core/models/public_ip.rb', line 132

def lifetime
  @lifetime
end

#private_ip_idString

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.

Returns:

  • (String)


143
144
145
# File 'lib/oci/core/models/public_ip.rb', line 143

def private_ip_id
  @private_ip_id
end

#public_ip_pool_idString

The OCID of the pool object created in the current tenancy.

Returns:

  • (String)


168
169
170
# File 'lib/oci/core/models/public_ip.rb', line 168

def public_ip_pool_id
  @public_ip_pool_id
end

#scopeString

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.

Returns:

  • (String)


157
158
159
# File 'lib/oci/core/models/public_ip.rb', line 157

def scope
  @scope
end

#time_createdDateTime

The date and time the public IP was created, in the format defined by RFC3339.

Example: 2016-08-25T21:10:29.600Z

Returns:

  • (DateTime)


164
165
166
# File 'lib/oci/core/models/public_ip.rb', line 164

def time_created
  @time_created
end

Class Method Details

.attribute_mapObject

Attribute mapping from ruby-style variable name to JSON key.



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
# 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

.swagger_typesObject

Attribute type mapping.



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
# 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

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object)

    the other object to be compared



381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
# 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

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash)

    Model attributes in the form of hash

Returns:

  • (Object)

    Returns the model itself



425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
# 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

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object)

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


405
406
407
# File 'lib/oci/core/models/public_ip.rb', line 405

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



414
415
416
# 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

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



458
459
460
461
462
463
464
465
466
467
# 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

#to_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



452
453
454
# File 'lib/oci/core/models/public_ip.rb', line 452

def to_s
  to_hash.to_s
end