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



51
52
53
54
55
56
57
58
 
# File 'lib/oci/network_load_balancer/models/reserved_ip.rb', line 51

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 public IP address created with the virtual cloud network.

Reserved public IP addresses are IP addresses that are registered using the virtual cloud network API.

Create a reserved public IP address. When you create the network load balancer, enter the OCID of the reserved public IP address in the reservedIp field to attach the IP address to the network load balancer. This task configures the network load balancer to listen to traffic on this IP address.

Reserved public IP addresses are not deleted when the network load balancer is deleted. The IP addresses become unattached from the network load balancer.

Example: "ocid1.publicip.oc1.phx.unique_ID"

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/network_load_balancer/models/reserved_ip.rb', line 24

def id
  @id
end

Class Method Details

.attribute_map ⇒ Object

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



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

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

.swagger_types ⇒ Object

Attribute type mapping.



36
37
38
39
40
41
42
 
# File 'lib/oci/network_load_balancer/models/reserved_ip.rb', line 36

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



67
68
69
70
71
72
 
# File 'lib/oci/network_load_balancer/models/reserved_ip.rb', line 67

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



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

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


77
78
79
 
# File 'lib/oci/network_load_balancer/models/reserved_ip.rb', line 77

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



86
87
88
 
# File 'lib/oci/network_load_balancer/models/reserved_ip.rb', line 86

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



130
131
132
133
134
135
136
137
138
139
 
# File 'lib/oci/network_load_balancer/models/reserved_ip.rb', line 130

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



124
125
126
 
# File 'lib/oci/network_load_balancer/models/reserved_ip.rb', line 124

def to_s
  to_hash.to_s
end