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

  • :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



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
# File 'lib/oci/load_balancer/models/backend.rb', line 113

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

#backupBOOLEAN

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


60
61
62
# File 'lib/oci/load_balancer/models/backend.rb', line 60

def backup
  @backup
end

#drainBOOLEAN

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

Example: false

Returns:

  • (BOOLEAN)


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

def drain
  @drain
end

#ip_addressString

[Required] The IP address of the backend server.

Example: 10.0.0.3

Returns:

  • (String)


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

def ip_address
  @ip_address
end

#nameString

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


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

def name
  @name
end

#offlineBOOLEAN

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

Example: false

Returns:

  • (BOOLEAN)


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

def offline
  @offline
end

#portInteger

[Required] The communication port for the backend server.

Example: 8080

Returns:

  • (Integer)


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

def port
  @port
end

#weightInteger

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


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

def weight
  @weight
end

Class Method Details

.attribute_mapObject

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



71
72
73
74
75
76
77
78
79
80
81
82
83
# File 'lib/oci/load_balancer/models/backend.rb', line 71

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

.swagger_typesObject

Attribute type mapping.



86
87
88
89
90
91
92
93
94
95
96
97
98
# File 'lib/oci/load_balancer/models/backend.rb', line 86

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



148
149
150
151
152
153
154
155
156
157
158
159
# File 'lib/oci/load_balancer/models/backend.rb', line 148

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 &&
    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



184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
# File 'lib/oci/load_balancer/models/backend.rb', line 184

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


164
165
166
# File 'lib/oci/load_balancer/models/backend.rb', line 164

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



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

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

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



217
218
219
220
221
222
223
224
225
226
# File 'lib/oci/load_balancer/models/backend.rb', line 217

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



211
212
213
# File 'lib/oci/load_balancer/models/backend.rb', line 211

def to_s
  to_hash.to_s
end