Class: OCI::LoadBalancer::Models::ReservedIP

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

Overview

ReservedIP model.

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



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

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 created with VCN.

Reserved IPs are IPs which already registered using VCN API.

Create a reserved Public IP and then while creating the load balancer pass the ocid of the reserved IP in this field reservedIp to attach the Ip to Load balancer. Load balancer will be configured to listen to traffic on this IP.

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

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

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/load_balancer/models/reserved_ip.rb', line 23

def id
  @id
end

Class Method Details

.attribute_map ⇒ Object

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



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

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

.swagger_types ⇒ Object

Attribute type mapping.



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

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



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

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



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

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


76
77
78
 
# File 'lib/oci/load_balancer/models/reserved_ip.rb', line 76

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



85
86
87
 
# File 'lib/oci/load_balancer/models/reserved_ip.rb', line 85

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



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

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



123
124
125
 
# File 'lib/oci/load_balancer/models/reserved_ip.rb', line 123

def to_s
  to_hash.to_s
end