Class: LinodeOpenapiClient::NodeBalancer

Inherits:
Object
  • Object
show all
Defined in:
lib/linode_openapi_client/models/node_balancer.rb

Overview

Linode’s load balancing solution. Can handle multiple ports, SSL termination, and any number of backends. NodeBalancer ports are configured with NodeBalancer Configs, and each config is given one or more NodeBalancer Node that accepts traffic. The traffic should be routed to the NodeBalancer’s ip address, the NodeBalancer will handle routing individual requests to backends.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ NodeBalancer

Initializes the object

Parameters:

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

    Model attributes in the form of hash



99
100
101
102
103
104
105
106
107
108
109
110
111
112
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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/linode_openapi_client/models/node_balancer.rb', line 99

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `LinodeOpenapiClient::NodeBalancer` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `LinodeOpenapiClient::NodeBalancer`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'region')
    self.region = attributes[:'region']
  end

  if attributes.key?(:'ipv4')
    self.ipv4 = attributes[:'ipv4']
  end

  if attributes.key?(:'created')
    self.created = attributes[:'created']
  end

  if attributes.key?(:'tags')
    if (value = attributes[:'tags']).is_a?(Array)
      self.tags = value
    end
  end

  if attributes.key?(:'client_conn_throttle')
    self.client_conn_throttle = attributes[:'client_conn_throttle']
  end

  if attributes.key?(:'ipv6')
    self.ipv6 = attributes[:'ipv6']
  end

  if attributes.key?(:'transfer')
    self.transfer = attributes[:'transfer']
  end

  if attributes.key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.key?(:'updated')
    self.updated = attributes[:'updated']
  end

  if attributes.key?(:'label')
    self.label = attributes[:'label']
  end

  if attributes.key?(:'hostname')
    self.hostname = attributes[:'hostname']
  end
end

Instance Attribute Details

#client_conn_throttle ⇒ Object

Throttle connections per second. Set to 0 (zero) to disable throttling.



32
33
34
 
# File 'lib/linode_openapi_client/models/node_balancer.rb', line 32

def client_conn_throttle
  @client_conn_throttle
end

#created ⇒ Object

Read-only When this NodeBalancer was created.



26
27
28
 
# File 'lib/linode_openapi_client/models/node_balancer.rb', line 26

def created
  @created
end

#hostname ⇒ Object

Read-only This NodeBalancer’s hostname, beginning with its IP address and ending with .ip.linodeusercontent.com.



49
50
51
 
# File 'lib/linode_openapi_client/models/node_balancer.rb', line 49

def hostname
  @hostname
end

#id ⇒ Object

Read-only This NodeBalancer’s unique ID.



40
41
42
 
# File 'lib/linode_openapi_client/models/node_balancer.rb', line 40

def id
  @id
end

#ipv4 ⇒ Object

__Filterable__, Read-only This NodeBalancer’s public IPv4 address.



23
24
25
 
# File 'lib/linode_openapi_client/models/node_balancer.rb', line 23

def ipv4
  @ipv4
end

#ipv6 ⇒ Object

Read-only This NodeBalancer’s public IPv6 address.



35
36
37
 
# File 'lib/linode_openapi_client/models/node_balancer.rb', line 35

def ipv6
  @ipv6
end

#label ⇒ Object

__Filterable__ This NodeBalancer’s label. These must be unique on your Account.



46
47
48
 
# File 'lib/linode_openapi_client/models/node_balancer.rb', line 46

def label
  @label
end

#region ⇒ Object

__Filterable__, Read-only The Region where this NodeBalancer is located. NodeBalancers only support backends in the same Region.



20
21
22
 
# File 'lib/linode_openapi_client/models/node_balancer.rb', line 20

def region
  @region
end

#tags ⇒ Object

__Filterable__ An array of Tags applied to this object. Tags are for organizational purposes only.



29
30
31
 
# File 'lib/linode_openapi_client/models/node_balancer.rb', line 29

def tags
  @tags
end

#transfer ⇒ Object

Returns the value of attribute transfer.



37
38
39
 
# File 'lib/linode_openapi_client/models/node_balancer.rb', line 37

def transfer
  @transfer
end

#updated ⇒ Object

Read-only When this NodeBalancer was last updated.



43
44
45
 
# File 'lib/linode_openapi_client/models/node_balancer.rb', line 43

def updated
  @updated
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/linode_openapi_client/models/node_balancer.rb', line 298

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = LinodeOpenapiClient.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



69
70
71
 
# File 'lib/linode_openapi_client/models/node_balancer.rb', line 69

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/linode_openapi_client/models/node_balancer.rb', line 52

def self.attribute_map
  {
    :'region' => :'region',
    :'ipv4' => :'ipv4',
    :'created' => :'created',
    :'tags' => :'tags',
    :'client_conn_throttle' => :'client_conn_throttle',
    :'ipv6' => :'ipv6',
    :'transfer' => :'transfer',
    :'id' => :'id',
    :'updated' => :'updated',
    :'label' => :'label',
    :'hostname' => :'hostname'
  }
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



274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/linode_openapi_client/models/node_balancer.rb', line 274

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



91
92
93
94
95
 
# File 'lib/linode_openapi_client/models/node_balancer.rb', line 91

def self.openapi_nullable
  Set.new([
    :'ipv6',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/linode_openapi_client/models/node_balancer.rb', line 74

def self.openapi_types
  {
    :'region' => :'String',
    :'ipv4' => :'String',
    :'created' => :'Time',
    :'tags' => :'Array<String>',
    :'client_conn_throttle' => :'Integer',
    :'ipv6' => :'String',
    :'transfer' => :'NodeBalancerTransfer',
    :'id' => :'Integer',
    :'updated' => :'Time',
    :'label' => :'String',
    :'hostname' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/linode_openapi_client/models/node_balancer.rb', line 243

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      region == o.region &&
      ipv4 == o.ipv4 &&
      created == o.created &&
      tags == o.tags &&
      client_conn_throttle == o.client_conn_throttle &&
      ipv6 == o.ipv6 &&
      transfer == o.transfer &&
      id == o.id &&
      updated == o.updated &&
      label == o.label &&
      hostname == o.hostname
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



369
370
371
372
373
374
375
376
377
378
379
380
381
 
# File 'lib/linode_openapi_client/models/node_balancer.rb', line 369

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


261
262
263
 
# File 'lib/linode_openapi_client/models/node_balancer.rb', line 261

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



267
268
269
 
# File 'lib/linode_openapi_client/models/node_balancer.rb', line 267

def hash
  [region, ipv4, created, tags, client_conn_throttle, ipv6, transfer, id, updated, label, hostname].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/linode_openapi_client/models/node_balancer.rb', line 161

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if !@client_conn_throttle.nil? && @client_conn_throttle > 20
    invalid_properties.push('invalid value for "client_conn_throttle", must be smaller than or equal to 20.')
  end

  if !@client_conn_throttle.nil? && @client_conn_throttle < 0
    invalid_properties.push('invalid value for "client_conn_throttle", must be greater than or equal to 0.')
  end

  if !@label.nil? && @label.to_s.length > 32
    invalid_properties.push('invalid value for "label", the character length must be smaller than or equal to 32.')
  end

  if !@label.nil? && @label.to_s.length < 3
    invalid_properties.push('invalid value for "label", the character length must be great than or equal to 3.')
  end

  pattern = Regexp.new(/[a-zA-Z0-9-_]{3,32}/)
  if !@label.nil? && @label !~ pattern
    invalid_properties.push("invalid value for \"label\", must conform to the pattern #{pattern}.")
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



345
346
347
 
# File 'lib/linode_openapi_client/models/node_balancer.rb', line 345

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/linode_openapi_client/models/node_balancer.rb', line 351

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    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



339
340
341
 
# File 'lib/linode_openapi_client/models/node_balancer.rb', line 339

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



190
191
192
193
194
195
196
197
198
 
# File 'lib/linode_openapi_client/models/node_balancer.rb', line 190

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@client_conn_throttle.nil? && @client_conn_throttle > 20
  return false if !@client_conn_throttle.nil? && @client_conn_throttle < 0
  return false if !@label.nil? && @label.to_s.length > 32
  return false if !@label.nil? && @label.to_s.length < 3
  return false if !@label.nil? && @label !~ Regexp.new(/[a-zA-Z0-9-_]{3,32}/)
  true
end