Class: OracleBMC::LoadBalancer::Models::BackendDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oraclebmc/load_balancer/models/backend_details.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BackendDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
90
91
92
93
94
95
96
 
# File 'lib/oraclebmc/load_balancer/models/backend_details.rb', line 59

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[:'backup']
    self.backup = attributes[:'backup']
  else
    self.backup = false
  end
  
  if attributes[:'drain']
    self.drain = attributes[:'drain']
  else
    self.drain = false
  end
  
  if attributes[:'ipAddress']
    self.ip_address = attributes[:'ipAddress']
  end
  
  if attributes[:'offline']
    self.offline = attributes[:'offline']
  else
    self.offline = false
  end
  
  if attributes[:'port']
    self.port = attributes[:'port']
  end
  
  if attributes[:'weight']
    self.weight = attributes[:'weight']
  end
  
end

Instance Attribute Details

#backup ⇒ BOOLEAN

Whether the load balancer should treat this server as a backup unit. If ‘true`, the load balancer forwards no ingress traffic to this backend server unless all other backend servers not marked as "backup" fail the health check policy.

Example: ‘true`

Returns:

  • (BOOLEAN) 


13
14
15
 
# File 'lib/oraclebmc/load_balancer/models/backend_details.rb', line 13

def backup
  @backup
end

#drain ⇒ BOOLEAN

Whether the load balancer should drain this server. Servers marked "drain" receive no new incoming traffic.

Example: ‘true`

Returns:

  • (BOOLEAN) 


21
22
23
 
# File 'lib/oraclebmc/load_balancer/models/backend_details.rb', line 21

def drain
  @drain
end

#ip_address ⇒ String

The IP address of the backend server.

Example: ‘10.10.10.4`

Returns:

  • (String) 


28
29
30
 
# File 'lib/oraclebmc/load_balancer/models/backend_details.rb', line 28

def ip_address
  @ip_address
end

#offline ⇒ BOOLEAN

Whether the load balancer should treat this server as offline. Offline servers receive no incoming traffic.

Example: ‘true`

Returns:

  • (BOOLEAN) 


36
37
38
 
# File 'lib/oraclebmc/load_balancer/models/backend_details.rb', line 36

def offline
  @offline
end

#port ⇒ Integer

The communication port for the backend server.

Example: ‘8080`

Returns:

  • (Integer) 


43
44
45
 
# File 'lib/oraclebmc/load_balancer/models/backend_details.rb', line 43

def port
  @port
end

#weight ⇒ Integer

The load balancing policy weight assigned to the server. Backend servers with a higher weight receive a larger proportion of incoming traffic. For example, a server weighted ‘3’ receives 3 times the number of new connections as a server weighted ‘1’. For more information on load balancing policies, see [How Load Balancing Policies Work](docs.us-phoenix-1.oraclecloud.com/Content/Balance/Reference/lbpolicies.htm).

Example: ‘3`

Returns:

  • (Integer) 


54
55
56
 
# File 'lib/oraclebmc/load_balancer/models/backend_details.rb', line 54

def weight
  @weight
end

Instance Method Details

#==(other_object) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other_object (Object) —

    to be compared



100
101
102
103
104
105
106
107
108
109
 
# File 'lib/oraclebmc/load_balancer/models/backend_details.rb', line 100

def ==(other_object)
  return true if self.equal?(other_object)
  self.class == other_object.class &&
      backup == other_object.backup &&
      drain == other_object.drain &&
      ip_address == other_object.ip_address &&
      offline == other_object.offline &&
      port == other_object.port &&
      weight == other_object.weight
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



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/oraclebmc/load_balancer/models/backend_details.rb', line 126

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.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| OracleBMC::Internal::Util.convert_to_type($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", OracleBMC::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


113
114
115
 
# File 'lib/oraclebmc/load_balancer/models/backend_details.rb', line 113

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



119
120
121
 
# File 'lib/oraclebmc/load_balancer/models/backend_details.rb', line 119

def hash
  [backup, drain, ip_address, offline, port, weight].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



151
152
153
154
155
156
157
158
159
 
# File 'lib/oraclebmc/load_balancer/models/backend_details.rb', line 151

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



145
146
147
 
# File 'lib/oraclebmc/load_balancer/models/backend_details.rb', line 145

def to_s
  to_hash.to_s
end