Class: LinodeOpenapiClient::PostNodeBalancerNode200Response

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

Overview

A NodeBalancerNode represents a single backend serving requests for a single port of a NodeBalancer. Nodes are specific to NodeBalancer Configs, and serve traffic over their private IP. If the same Linode is serving traffic for more than one port on the same NodeBalancer, one NodeBalancer Node is required for each config (port) it should serve requests on. For example, if you have four backends, and each should response to both HTTP and HTTPS requests, you will need two NodeBalancerConfigs (port 80 and port 443) and four backends each - one for each of the Linodes serving requests for that port.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PostNodeBalancerNode200Response

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/linode_openapi_client/models/post_node_balancer_node200_response.rb', line 106

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `LinodeOpenapiClient::PostNodeBalancerNode200Response` 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::PostNodeBalancerNode200Response`. 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?(:'config_id')
    self.config_id = attributes[:'config_id']
  end

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

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

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

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

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

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

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

Instance Attribute Details

#address ⇒ Object

The private IP Address where this backend can be reached. This must be a private IP address.



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

def address
  @address
end

#config_id ⇒ Object

Read-only The NodeBalancer Config ID that this Node belongs to.



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

def config_id
  @config_id
end

#id ⇒ Object

Read-only This node’s unique ID.



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

def id
  @id
end

#label ⇒ Object

The label for this node. This is for display purposes only.



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

def label
  @label
end

#mode ⇒ Object

The mode this NodeBalancer should use when sending traffic to this backend. - If set to ‘accept` this backend is accepting traffic. - If set to `reject` this backend will not receive traffic. - If set to `drain` this backend will not receive new traffic, but connections already pinned to it will continue to be routed to it. - If set to `backup`, this backend will only receive traffic if all `accept` nodes are down.



41
42
43
 
# File 'lib/linode_openapi_client/models/post_node_balancer_node200_response.rb', line 41

def mode
  @mode
end

#nodebalancer_id ⇒ Object

Read-only The NodeBalancer ID that this Node belongs to.



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

def nodebalancer_id
  @nodebalancer_id
end

#status ⇒ Object

Read-only The current status of this node, based on the configured checks of its NodeBalancer Config.



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

def status
  @status
end

#weight ⇒ Object

Used when picking a backend to serve a request and is not pinned to a single backend yet. Nodes with a higher weight will receive more traffic.



38
39
40
 
# File 'lib/linode_openapi_client/models/post_node_balancer_node200_response.rb', line 38

def weight
  @weight
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



312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/linode_openapi_client/models/post_node_balancer_node200_response.rb', line 312

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



80
81
82
 
# File 'lib/linode_openapi_client/models/post_node_balancer_node200_response.rb', line 80

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/linode_openapi_client/models/post_node_balancer_node200_response.rb', line 66

def self.attribute_map
  {
    :'config_id' => :'config_id',
    :'address' => :'address',
    :'id' => :'id',
    :'nodebalancer_id' => :'nodebalancer_id',
    :'status' => :'status',
    :'label' => :'label',
    :'weight' => :'weight',
    :'mode' => :'mode'
  }
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



288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/linode_openapi_client/models/post_node_balancer_node200_response.rb', line 288

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



99
100
101
102
 
# File 'lib/linode_openapi_client/models/post_node_balancer_node200_response.rb', line 99

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/linode_openapi_client/models/post_node_balancer_node200_response.rb', line 85

def self.openapi_types
  {
    :'config_id' => :'Integer',
    :'address' => :'String',
    :'id' => :'Integer',
    :'nodebalancer_id' => :'Integer',
    :'status' => :'String',
    :'label' => :'String',
    :'weight' => :'Integer',
    :'mode' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/linode_openapi_client/models/post_node_balancer_node200_response.rb', line 260

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      config_id == o.config_id &&
      address == o.address &&
      id == o.id &&
      nodebalancer_id == o.nodebalancer_id &&
      status == o.status &&
      label == o.label &&
      weight == o.weight &&
      mode == o.mode
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



383
384
385
386
387
388
389
390
391
392
393
394
395
 
# File 'lib/linode_openapi_client/models/post_node_balancer_node200_response.rb', line 383

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


275
276
277
 
# File 'lib/linode_openapi_client/models/post_node_balancer_node200_response.rb', line 275

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



281
282
283
 
# File 'lib/linode_openapi_client/models/post_node_balancer_node200_response.rb', line 281

def hash
  [config_id, address, id, nodebalancer_id, status, label, weight, mode].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



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/linode_openapi_client/models/post_node_balancer_node200_response.rb', line 154

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  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

  if !@weight.nil? && @weight > 255
    invalid_properties.push('invalid value for "weight", must be smaller than or equal to 255.')
  end

  if !@weight.nil? && @weight < 1
    invalid_properties.push('invalid value for "weight", must be greater than or equal to 1.')
  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



359
360
361
 
# File 'lib/linode_openapi_client/models/post_node_balancer_node200_response.rb', line 359

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



365
366
367
368
369
370
371
372
373
374
375
376
377
 
# File 'lib/linode_openapi_client/models/post_node_balancer_node200_response.rb', line 365

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



353
354
355
 
# File 'lib/linode_openapi_client/models/post_node_balancer_node200_response.rb', line 353

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



183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/linode_openapi_client/models/post_node_balancer_node200_response.rb', line 183

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  status_validator = EnumAttributeValidator.new('String', ["unknown", "UP", "DOWN"])
  return false unless status_validator.valid?(@status)
  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}/)
  return false if !@weight.nil? && @weight > 255
  return false if !@weight.nil? && @weight < 1
  mode_validator = EnumAttributeValidator.new('String', ["accept", "reject", "drain", "backup"])
  return false unless mode_validator.valid?(@mode)
  true
end