Class: OCI::Core::Models::CreatePublicIpDetails

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

Constant Summary collapse

LIFETIME_ENUM = 
[LIFETIME_EPHEMERAL = 'EPHEMERAL',
LIFETIME_RESERVED = 'RESERVED']

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreatePublicIpDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :display_name (String) —

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



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/oci/core/models/create_public_ip_details.rb', line 49

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

end

Instance Attribute Details

#compartment_id ⇒ String

[Required] The OCID of the compartment to contain the public IP. For ephemeral public IPs, you must set this to the private IP’s compartment OCID.

Returns:

  • (String) 


15
16
17
 
# File 'lib/oci/core/models/create_public_ip_details.rb', line 15

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) 


21
22
23
 
# File 'lib/oci/core/models/create_public_ip_details.rb', line 21

def display_name
  @display_name
end

#lifetime ⇒ String

[Required] Defines when the public IP is deleted and released back to the Oracle Cloud Infrastructure public IP pool. For more information, see [Public IP Addresses](docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingpublicIPs.htm).

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/core/models/create_public_ip_details.rb', line 28

def lifetime
  @lifetime
end

#private_ip_id ⇒ String

The OCID of the private IP to assign the public IP to.

Required for an ephemeral public IP because it must always be assigned to a private IP (specifically a primary private IP).

Optional for a reserved public IP. If you don’t provide it, the public IP is created but not assigned to a private IP. You can later assign the public IP with update_public_ip.

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/core/models/create_public_ip_details.rb', line 40

def private_ip_id
  @private_ip_id
end

Instance Method Details

#==(other_object) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other_object (Object) —

    to be compared



103
104
105
106
107
108
109
110
 
# File 'lib/oci/core/models/create_public_ip_details.rb', line 103

def ==(other_object)
  return true if self.equal?(other_object)
  self.class == other_object.class &&
      compartment_id == other_object.compartment_id &&
      display_name == other_object.display_name &&
      lifetime == other_object.lifetime &&
      private_ip_id == other_object.private_ip_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



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/oci/core/models/create_public_ip_details.rb', line 127

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


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

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



120
121
122
 
# File 'lib/oci/core/models/create_public_ip_details.rb', line 120

def hash
  [compartment_id, display_name, lifetime, private_ip_id].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



152
153
154
155
156
157
158
159
160
 
# File 'lib/oci/core/models/create_public_ip_details.rb', line 152

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



146
147
148
 
# File 'lib/oci/core/models/create_public_ip_details.rb', line 146

def to_s
  to_hash.to_s
end