Class: KatapultAPI::LoadBalancerRuleArguments

Inherits:
Object
  • Object
show all
Defined in:
lib/katapult-ruby/models/load_balancer_rule_arguments.rb

Overview

All ‘properties[]’ params are mutually exclusive, only one can be provided.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LoadBalancerRuleArguments

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
158
159
160
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
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/katapult-ruby/models/load_balancer_rule_arguments.rb', line 130

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#algorithm ⇒ Object

Returns the value of attribute algorithm.



19
20
21
 
# File 'lib/katapult-ruby/models/load_balancer_rule_arguments.rb', line 19

def algorithm
  @algorithm
end

#backend_ssl ⇒ Object

Returns the value of attribute backend_ssl.



29
30
31
 
# File 'lib/katapult-ruby/models/load_balancer_rule_arguments.rb', line 29

def backend_ssl
  @backend_ssl
end

#certificates ⇒ Object

Returns the value of attribute certificates.



33
34
35
 
# File 'lib/katapult-ruby/models/load_balancer_rule_arguments.rb', line 33

def certificates
  @certificates
end

#check_enabled ⇒ Object

Returns the value of attribute check_enabled.



35
36
37
 
# File 'lib/katapult-ruby/models/load_balancer_rule_arguments.rb', line 35

def check_enabled
  @check_enabled
end

#check_fall ⇒ Object

Returns the value of attribute check_fall.



37
38
39
 
# File 'lib/katapult-ruby/models/load_balancer_rule_arguments.rb', line 37

def check_fall
  @check_fall
end

#check_http_statuses ⇒ Object

Returns the value of attribute check_http_statuses.



49
50
51
 
# File 'lib/katapult-ruby/models/load_balancer_rule_arguments.rb', line 49

def check_http_statuses
  @check_http_statuses
end

#check_interval ⇒ Object

Returns the value of attribute check_interval.



39
40
41
 
# File 'lib/katapult-ruby/models/load_balancer_rule_arguments.rb', line 39

def check_interval
  @check_interval
end

#check_path ⇒ Object

Returns the value of attribute check_path.



41
42
43
 
# File 'lib/katapult-ruby/models/load_balancer_rule_arguments.rb', line 41

def check_path
  @check_path
end

#check_protocol ⇒ Object

Returns the value of attribute check_protocol.



43
44
45
 
# File 'lib/katapult-ruby/models/load_balancer_rule_arguments.rb', line 43

def check_protocol
  @check_protocol
end

#check_rise ⇒ Object

Returns the value of attribute check_rise.



45
46
47
 
# File 'lib/katapult-ruby/models/load_balancer_rule_arguments.rb', line 45

def check_rise
  @check_rise
end

#check_timeout ⇒ Object

Returns the value of attribute check_timeout.



47
48
49
 
# File 'lib/katapult-ruby/models/load_balancer_rule_arguments.rb', line 47

def check_timeout
  @check_timeout
end

#destination_port ⇒ Object

Returns the value of attribute destination_port.



21
22
23
 
# File 'lib/katapult-ruby/models/load_balancer_rule_arguments.rb', line 21

def destination_port
  @destination_port
end

#listen_port ⇒ Object

Returns the value of attribute listen_port.



23
24
25
 
# File 'lib/katapult-ruby/models/load_balancer_rule_arguments.rb', line 23

def listen_port
  @listen_port
end

#passthrough_ssl ⇒ Object

Returns the value of attribute passthrough_ssl.



31
32
33
 
# File 'lib/katapult-ruby/models/load_balancer_rule_arguments.rb', line 31

def passthrough_ssl
  @passthrough_ssl
end

#protocol ⇒ Object

Returns the value of attribute protocol.



25
26
27
 
# File 'lib/katapult-ruby/models/load_balancer_rule_arguments.rb', line 25

def protocol
  @protocol
end

#proxy_protocol ⇒ Object

Returns the value of attribute proxy_protocol.



27
28
29
 
# File 'lib/katapult-ruby/models/load_balancer_rule_arguments.rb', line 27

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



287
288
289
290
291
292
293
294
295
296
297
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
 
# File 'lib/katapult-ruby/models/load_balancer_rule_arguments.rb', line 287

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



96
97
98
 
# File 'lib/katapult-ruby/models/load_balancer_rule_arguments.rb', line 96

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/katapult-ruby/models/load_balancer_rule_arguments.rb', line 74

def self.attribute_map
  {
    :'algorithm' => :'algorithm',
    :'destination_port' => :'destination_port',
    :'listen_port' => :'listen_port',
    :'protocol' => :'protocol',
    :'proxy_protocol' => :'proxy_protocol',
    :'backend_ssl' => :'backend_ssl',
    :'passthrough_ssl' => :'passthrough_ssl',
    :'certificates' => :'certificates',
    :'check_enabled' => :'check_enabled',
    :'check_fall' => :'check_fall',
    :'check_interval' => :'check_interval',
    :'check_path' => :'check_path',
    :'check_protocol' => :'check_protocol',
    :'check_rise' => :'check_rise',
    :'check_timeout' => :'check_timeout',
    :'check_http_statuses' => :'check_http_statuses'
  }
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



263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/katapult-ruby/models/load_balancer_rule_arguments.rb', line 263

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



123
124
125
126
 
# File 'lib/katapult-ruby/models/load_balancer_rule_arguments.rb', line 123

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

.openapi_types ⇒ Object

Attribute type mapping.



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/katapult-ruby/models/load_balancer_rule_arguments.rb', line 101

def self.openapi_types
  {
    :'algorithm' => :'LoadBalancerRuleAlgorithmEnum',
    :'destination_port' => :'Integer',
    :'listen_port' => :'Integer',
    :'protocol' => :'LoadBalancerRuleProtocolEnum',
    :'proxy_protocol' => :'Boolean',
    :'backend_ssl' => :'Boolean',
    :'passthrough_ssl' => :'Boolean',
    :'certificates' => :'Array<CertificateLookup>',
    :'check_enabled' => :'Boolean',
    :'check_fall' => :'Integer',
    :'check_interval' => :'Integer',
    :'check_path' => :'String',
    :'check_protocol' => :'LoadBalancerRuleCheckProtocolEnum',
    :'check_rise' => :'Integer',
    :'check_timeout' => :'Integer',
    :'check_http_statuses' => :'LoadBalancerRuleHTTPStatusesEnum'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/katapult-ruby/models/load_balancer_rule_arguments.rb', line 227

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      algorithm == o.algorithm &&
      destination_port == o.destination_port &&
      listen_port == o.listen_port &&
      protocol == o.protocol &&
      proxy_protocol == o.proxy_protocol &&
      backend_ssl == o.backend_ssl &&
      passthrough_ssl == o.passthrough_ssl &&
      certificates == o.certificates &&
      check_enabled == o.check_enabled &&
      check_fall == o.check_fall &&
      check_interval == o.check_interval &&
      check_path == o.check_path &&
      check_protocol == o.check_protocol &&
      check_rise == o.check_rise &&
      check_timeout == o.check_timeout &&
      check_http_statuses == o.check_http_statuses
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



358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'lib/katapult-ruby/models/load_balancer_rule_arguments.rb', line 358

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


250
251
252
 
# File 'lib/katapult-ruby/models/load_balancer_rule_arguments.rb', line 250

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



256
257
258
 
# File 'lib/katapult-ruby/models/load_balancer_rule_arguments.rb', line 256

def hash
  [algorithm, destination_port, listen_port, protocol, proxy_protocol, backend_ssl, passthrough_ssl, certificates, check_enabled, check_fall, check_interval, check_path, check_protocol, check_rise, check_timeout, check_http_statuses].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



212
213
214
215
216
 
# File 'lib/katapult-ruby/models/load_balancer_rule_arguments.rb', line 212

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



334
335
336
 
# File 'lib/katapult-ruby/models/load_balancer_rule_arguments.rb', line 334

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



340
341
342
343
344
345
346
347
348
349
350
351
352
 
# File 'lib/katapult-ruby/models/load_balancer_rule_arguments.rb', line 340

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



328
329
330
 
# File 'lib/katapult-ruby/models/load_balancer_rule_arguments.rb', line 328

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



220
221
222
223
 
# File 'lib/katapult-ruby/models/load_balancer_rule_arguments.rb', line 220

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end