Class: OCI::LoadBalancer::Models::CreateBackendDetails

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

Overview

The configuration details for creating a backend server in a backend set. For more information on backend server configuration, see Managing Backend Servers.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateBackendDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

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

  • :backup (BOOLEAN) —

    The value to assign to the #backup property

  • :drain (BOOLEAN) —

    The value to assign to the #drain property

  • :offline (BOOLEAN) —

    The value to assign to the #offline property



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/oci/load_balancer/models/create_backend_details.rb', line 117

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.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.backup = attributes[:'backup'] unless attributes[:'backup'].nil?
  self.backup = false if backup.nil? && !attributes.key?(:'backup') # rubocop:disable Style/StringLiterals

  self.drain = attributes[:'drain'] unless attributes[:'drain'].nil?
  self.drain = false if drain.nil? && !attributes.key?(:'drain') # 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

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) 


56
57
58
 
# File 'lib/oci/load_balancer/models/create_backend_details.rb', line 56

def backup
  @backup
end

#drain ⇒ BOOLEAN

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

Example: false

Returns:

  • (BOOLEAN) 


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

def drain
  @drain
end

#ip_address ⇒ String

[Required] The IP address of the backend server.

Example: 10.0.0.3

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/load_balancer/models/create_backend_details.rb', line 19

def ip_address
  @ip_address
end

#max_connections ⇒ Integer

The maximum number of simultaneous connections the load balancer can make to the backend. If this is not set then number of simultaneous connections the load balancer can make to the backend is unlimited.

Example: 300

Returns:

  • (Integer) 


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

def max_connections
  @max_connections
end

#offline ⇒ BOOLEAN

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

Example: false

Returns:

  • (BOOLEAN) 


72
73
74
 
# File 'lib/oci/load_balancer/models/create_backend_details.rb', line 72

def offline
  @offline
end

#port ⇒ Integer

[Required] The communication port for the backend server.

Example: 8080

Returns:

  • (Integer) 


26
27
28
 
# File 'lib/oci/load_balancer/models/create_backend_details.rb', line 26

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.

Example: 3

Returns:

  • (Integer) 


37
38
39
 
# File 'lib/oci/load_balancer/models/create_backend_details.rb', line 37

def weight
  @weight
end

Class Method Details

.attribute_map ⇒ Object

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



75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/oci/load_balancer/models/create_backend_details.rb', line 75

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

.swagger_types ⇒ Object

Attribute type mapping.



90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/oci/load_balancer/models/create_backend_details.rb', line 90

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



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

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

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



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/oci/load_balancer/models/create_backend_details.rb', line 192

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


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

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



181
182
183
 
# File 'lib/oci/load_balancer/models/create_backend_details.rb', line 181

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

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



225
226
227
228
229
230
231
232
233
234
 
# File 'lib/oci/load_balancer/models/create_backend_details.rb', line 225

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



219
220
221
 
# File 'lib/oci/load_balancer/models/create_backend_details.rb', line 219

def to_s
  to_hash.to_s
end