Class: OCI::NetworkLoadBalancer::Models::ReservedIP

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/network_load_balancer/models/reserved_ip.rb

Overview

An object representing a reserved IP address to be attached or that is already attached to a network load balancer.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ReservedIP

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String) —

    The value to assign to the #id property



55
56
57
58
59
60
61
62
 
# File 'lib/oci/network_load_balancer/models/reserved_ip.rb', line 55

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

Instance Attribute Details

#id ⇒ String

Ocid of the Reserved IP (Public IP, Private IP or IPv6) created with VCN.

Reserved IPs are IPs which are already registered using VCN API.

For public Network load balancers, customer can create a reserved Public IP and/or reserved private IP and/or reserved IPv6 and pass the OCID's in the reservedIps array field to attach the IP addresses to the network load balancer during create For private Network load balancers, customer can create a reserved Private IP and/or reserved IPv6 and pass the OCID's in the reservedIps array field to attach the IP addresses to the network load balancer during create

Reserved IPs will not be deleted when the Network Load balancer is deleted. They will be detached from the Network Load balancer.

Public IP Example: "ocid1.publicip.oc1.phx.unique_ID" Private IP Example: "ocid1.privateip.oc1.phx.unique_ID" IPV6 example: "ocid1.ipv6.oc1.phx.unique_ID"

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/network_load_balancer/models/reserved_ip.rb', line 28

def id
  @id
end

Class Method Details

.attribute_map ⇒ Object

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



31
32
33
34
35
36
37
 
# File 'lib/oci/network_load_balancer/models/reserved_ip.rb', line 31

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



40
41
42
43
44
45
46
 
# File 'lib/oci/network_load_balancer/models/reserved_ip.rb', line 40

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    '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



71
72
73
74
75
76
 
# File 'lib/oci/network_load_balancer/models/reserved_ip.rb', line 71

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    id == other.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



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/oci/network_load_balancer/models/reserved_ip.rb', line 101

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


81
82
83
 
# File 'lib/oci/network_load_balancer/models/reserved_ip.rb', line 81

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



90
91
92
 
# File 'lib/oci/network_load_balancer/models/reserved_ip.rb', line 90

def hash
  [id].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



134
135
136
137
138
139
140
141
142
143
 
# File 'lib/oci/network_load_balancer/models/reserved_ip.rb', line 134

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



128
129
130
 
# File 'lib/oci/network_load_balancer/models/reserved_ip.rb', line 128

def to_s
  to_hash.to_s
end