Class: OCI::LoadBalancer::Models::Backend

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

Overview

The configuration of a backend server that is a member of a load balancer backend set. For more information, see Managing Backend Servers.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Backend

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :name (String) —

    The value to assign to the #name property

  • :ip_address (String) —

    The value to assign to the #ip_address property

  • :port (Integer) —

    The value to assign to the #port property

  • :weight (Integer) —

    The value to assign to the #weight property

  • :max_connections (Integer) —

    The value to assign to the #max_connections property

  • :drain (BOOLEAN) —

    The value to assign to the #drain property

  • :backup (BOOLEAN) —

    The value to assign to the #backup property

  • :offline (BOOLEAN) —

    The value to assign to the #offline property



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/oci/load_balancer/models/backend.rb', line 124

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

  self.ip_address = attributes[:'ipAddress'] if attributes[:'ipAddress']

  raise 'You cannot provide both :ipAddress and :ip_address' if attributes.key?(:'ipAddress') && attributes.key?(:'ip_address')

  self.ip_address = attributes[:'ip_address'] if attributes[:'ip_address']

  self.port = attributes[:'port'] if attributes[:'port']

  self.weight = attributes[:'weight'] if attributes[:'weight']

  self.max_connections = attributes[:'maxConnections'] if attributes[:'maxConnections']

  raise 'You cannot provide both :maxConnections and :max_connections' if attributes.key?(:'maxConnections') && attributes.key?(:'max_connections')

  self.max_connections = attributes[:'max_connections'] if attributes[:'max_connections']

  self.drain = attributes[:'drain'] unless attributes[:'drain'].nil?
  self.drain = false if drain.nil? && !attributes.key?(:'drain') # rubocop:disable Style/StringLiterals

  self.backup = attributes[:'backup'] unless attributes[:'backup'].nil?
  self.backup = false if backup.nil? && !attributes.key?(:'backup') # rubocop:disable Style/StringLiterals

  self.offline = attributes[:'offline'] unless attributes[:'offline'].nil?
  self.offline = false if offline.nil? && !attributes.key?(:'offline') # rubocop:disable Style/StringLiterals
end

Instance Attribute Details

#backup ⇒ BOOLEAN

[Required] 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.

Note: You cannot add a backend server marked as backup to a backend set that uses the IP Hash policy.

Example: false

Returns:

  • (BOOLEAN) 


68
69
70
 
# File 'lib/oci/load_balancer/models/backend.rb', line 68

def backup
  @backup
end

#drain ⇒ BOOLEAN

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

Example: false

Returns:

  • (BOOLEAN) 


58
59
60
 
# File 'lib/oci/load_balancer/models/backend.rb', line 58

def drain
  @drain
end

#ip_address ⇒ String

[Required] The IP address of the backend server.

Example: 10.0.0.3

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/load_balancer/models/backend.rb', line 25

def ip_address
  @ip_address
end

#max_connections ⇒ Integer

The maximum number of simultaneous connections the load balancer can make to the backend.

Example: 300

Returns:

  • (Integer) 


50
51
52
 
# File 'lib/oci/load_balancer/models/backend.rb', line 50

def max_connections
  @max_connections
end

#name ⇒ String

[Required] A read-only field showing the IP address and port that uniquely identify this backend server in the backend set.

Example: 10.0.0.3:8080

Returns:

  • (String) 


18
19
20
 
# File 'lib/oci/load_balancer/models/backend.rb', line 18

def name
  @name
end

#offline ⇒ BOOLEAN

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

Example: false

Returns:

  • (BOOLEAN) 


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

def offline
  @offline
end

#port ⇒ Integer

[Required] The communication port for the backend server.

Example: 8080

Returns:

  • (Integer) 


32
33
34
 
# File 'lib/oci/load_balancer/models/backend.rb', line 32

def port
  @port
end

#weight ⇒ Integer

[Required] 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.

Example: 3

Returns:

  • (Integer) 


43
44
45
 
# File 'lib/oci/load_balancer/models/backend.rb', line 43

def weight
  @weight
end

Class Method Details

.attribute_map ⇒ Object

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



79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/oci/load_balancer/models/backend.rb', line 79

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'ip_address': :'ipAddress',
    'port': :'port',
    'weight': :'weight',
    'max_connections': :'maxConnections',
    'drain': :'drain',
    'backup': :'backup',
    'offline': :'offline'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/oci/load_balancer/models/backend.rb', line 95

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    'ip_address': :'String',
    'port': :'Integer',
    'weight': :'Integer',
    'max_connections': :'Integer',
    'drain': :'BOOLEAN',
    'backup': :'BOOLEAN',
    'offline': :'BOOLEAN'
    # 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



165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/oci/load_balancer/models/backend.rb', line 165

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

  self.class == other.class &&
    name == other.name &&
    ip_address == other.ip_address &&
    port == other.port &&
    weight == other.weight &&
    max_connections == other.max_connections &&
    drain == other.drain &&
    backup == other.backup &&
    offline == other.offline
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



202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/oci/load_balancer/models/backend.rb', line 202

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


182
183
184
 
# File 'lib/oci/load_balancer/models/backend.rb', line 182

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



191
192
193
 
# File 'lib/oci/load_balancer/models/backend.rb', line 191

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

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



235
236
237
238
239
240
241
242
243
244
 
# File 'lib/oci/load_balancer/models/backend.rb', line 235

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



229
230
231
 
# File 'lib/oci/load_balancer/models/backend.rb', line 229

def to_s
  to_hash.to_s
end