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](docs.us-phoenix-1.oraclecloud.com/Content/Balance/Tasks/managingbackendservers.htm).

Instance Attribute 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):

  • :backup (BOOLEAN) —

    The value to assign to the #backup property

  • :drain (BOOLEAN) —

    The value to assign to the #drain property

  • :ip_address (String) —

    The value to assign to the #ip_address property

  • :name (String) —

    The value to assign to the #name property

  • :offline (BOOLEAN) —

    The value to assign to the #offline property

  • :port (Integer) —

    The value to assign to the #port property

  • :weight (Integer) —

    The value to assign to the #weight property



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/oci/load_balancer/models/backend.rb', line 76

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}

  unless attributes[:'backup'].nil?
    self.backup = attributes[:'backup']
  else
    self.backup = false
  end

  unless attributes[:'drain'].nil?
    self.drain = attributes[:'drain']
  else
    self.drain = false
  end

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

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

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

  if attributes[:'name']
    self.name = attributes[:'name']
  end

  unless attributes[:'offline'].nil?
    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

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

Example: ‘true`

Returns:

  • (BOOLEAN) 


16
17
18
 
# File 'lib/oci/load_balancer/models/backend.rb', line 16

def backup
  @backup
end

#drain ⇒ BOOLEAN

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

Example: ‘true`

Returns:

  • (BOOLEAN) 


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

def drain
  @drain
end

#ip_address ⇒ String

[Required] The IP address of the backend server.

Example: ‘10.10.10.4`

Returns:

  • (String) 


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

def ip_address
  @ip_address
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.10.10.4:8080`

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/load_balancer/models/backend.rb', line 38

def name
  @name
end

#offline ⇒ BOOLEAN

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

Example: ‘true`

Returns:

  • (BOOLEAN) 


46
47
48
 
# File 'lib/oci/load_balancer/models/backend.rb', line 46

def offline
  @offline
end

#port ⇒ Integer

[Required] The communication port for the backend server.

Example: ‘8080`

Returns:

  • (Integer) 


53
54
55
 
# File 'lib/oci/load_balancer/models/backend.rb', line 53

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](docs.us-phoenix-1.oraclecloud.com/Content/Balance/Reference/lbpolicies.htm).

Example: ‘3`

Returns:

  • (Integer) 


64
65
66
 
# File 'lib/oci/load_balancer/models/backend.rb', line 64

def weight
  @weight
end

Instance Method Details

#==(other_object) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other_object (Object) —

    to be compared



126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/oci/load_balancer/models/backend.rb', line 126

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 &&
      name == other_object.name &&
      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



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/oci/load_balancer/models/backend.rb', line 153

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

Parameters:

  • other_object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


140
141
142
 
# File 'lib/oci/load_balancer/models/backend.rb', line 140

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



146
147
148
 
# File 'lib/oci/load_balancer/models/backend.rb', line 146

def hash
  [backup, drain, ip_address, name, 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



178
179
180
181
182
183
184
185
186
 
# File 'lib/oci/load_balancer/models/backend.rb', line 178

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



172
173
174
 
# File 'lib/oci/load_balancer/models/backend.rb', line 172

def to_s
  to_hash.to_s
end