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](docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingpublicIPs.htm).

Constant Summary collapse

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

Instance Attribute 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):

  • :availability_domain (String) —

    The value to assign to the #availability_domain property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :display_name (String) —

    The value to assign to the #display_name 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



129
130
131
132
133
134
135
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
 
# File 'lib/oci/core/models/public_ip.rb', line 129

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[:'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[:'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

  if attributes[:'lifecycleState']
    self.lifecycle_state = attributes[:'lifecycleState']
  end

  raise 'You cannot provide both :lifecycleState and :lifecycle_state' if attributes.key?(:'lifecycleState') && attributes.key?(:'lifecycle_state')

  if attributes[:'lifecycle_state']
    self.lifecycle_state = attributes[:'lifecycle_state']
  end

  if attributes[:'lifetime']
    self.lifetime = attributes[:'lifetime']
  end

  if attributes[:'privateIpId']
    self.private_ip_id = attributes[:'privateIpId']
  end

  raise 'You cannot provide both :privateIpId and :private_ip_id' if attributes.key?(:'privateIpId') && attributes.key?(:'private_ip_id')

  if attributes[:'private_ip_id']
    self.private_ip_id = attributes[:'private_ip_id']
  end

  if attributes[:'scope']
    self.scope = attributes[:'scope']
  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

end

Instance Attribute Details

#availability_domain ⇒ String

The public IP’s Availability Domain. This property is set only for ephemeral public IPs (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) 


45
46
47
 
# File 'lib/oci/core/models/public_ip.rb', line 45

def availability_domain
  @availability_domain
end

#compartment_id ⇒ String

The OCID of the compartment containing the public IP. For an ephemeral public IP, this is the same compartment as the private IP’s. For a reserved public IP that is currently assigned, this can be a different compartment than the assigned private IP’s.

Returns:

  • (String) 


52
53
54
 
# File 'lib/oci/core/models/public_ip.rb', line 52

def compartment_id
  @compartment_id
end

#display_name ⇒ String

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

Returns:

  • (String) 


58
59
60
 
# File 'lib/oci/core/models/public_ip.rb', line 58

def display_name
  @display_name
end

#id ⇒ String

The public IP’s Oracle ID (OCID).

Returns:

  • (String) 


62
63
64
 
# File 'lib/oci/core/models/public_ip.rb', line 62

def id
  @id
end

#ip_address ⇒ String

The public IP address of the ‘publicIp` object.

Example: ‘129.146.2.1`

Returns:

  • (String) 


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

def ip_address
  @ip_address
end

#lifecycle_state ⇒ String

The public IP’s current state.

Returns:

  • (String) 


73
74
75
 
# File 'lib/oci/core/models/public_ip.rb', line 73

def lifecycle_state
  @lifecycle_state
end

#lifetime ⇒ 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 private IP. The

ephemeral public IP is automatically deleted when its private IP is deleted, when the VNIC is terminated, or when the instance is terminated. An ephemeral public IP must always be assigned to a private IP.

  • ‘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.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingpublicIPs.htm).

Returns:

  • (String) 


89
90
91
 
# File 'lib/oci/core/models/public_ip.rb', line 89

def lifetime
  @lifetime
end

#private_ip_id ⇒ String

The OCID of the private IP that the public IP is currently assigned to, or in the process of being assigned to.

Returns:

  • (String) 


95
96
97
 
# File 'lib/oci/core/models/public_ip.rb', line 95

def private_ip_id
  @private_ip_id
end

#scope ⇒ String

Whether the public IP is regional or specific to a particular Availability Domain.

  • ‘REGION`: The public IP exists within a region and can be assigned to a private IP

in any Availability Domain in the region. Reserved public IPs have ‘scope` = `REGION`.

  • ‘AVAILABILITY_DOMAIN`: The public IP exists within the Availability Domain of the private IP

it’s assigned to, which is specified by the ‘availabilityDomain` property of the public IP object. Ephemeral public IPs have `scope` = `AVAILABILITY_DOMAIN`.

Returns:

  • (String) 


107
108
109
 
# File 'lib/oci/core/models/public_ip.rb', line 107

def scope
  @scope
end

#time_created ⇒ DateTime

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

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

Returns:

  • (DateTime) 


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

def time_created
  @time_created
end

Instance Method Details

#==(other_object) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other_object (Object) —

    to be compared



251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/oci/core/models/public_ip.rb', line 251

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 &&
      display_name == other_object.display_name &&
      id == other_object.id &&
      ip_address == other_object.ip_address &&
      lifecycle_state == other_object.lifecycle_state &&
      lifetime == other_object.lifetime &&
      private_ip_id == other_object.private_ip_id &&
      scope == other_object.scope &&
      time_created == other_object.time_created
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



281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/oci/core/models/public_ip.rb', line 281

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

Parameters:

  • other_object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


268
269
270
 
# File 'lib/oci/core/models/public_ip.rb', line 268

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



274
275
276
 
# File 'lib/oci/core/models/public_ip.rb', line 274

def hash
  [availability_domain, compartment_id, display_name, id, ip_address, lifecycle_state, lifetime, private_ip_id, scope, time_created].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



306
307
308
309
310
311
312
313
314
 
# File 'lib/oci/core/models/public_ip.rb', line 306

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

Returns:

  • (String) —

    String presentation of the object



300
301
302
 
# File 'lib/oci/core/models/public_ip.rb', line 300

def to_s
  to_hash.to_s
end