Class: Fastly::Pool

Inherits:
Object
  • Object
show all
Defined in:
lib/fastly/models/pool.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Pool

Initializes the object

Parameters:

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

    Model attributes in the form of hash



190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/fastly/models/pool.rb', line 190

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

  if attributes.key?(:'tls_client_cert')
    self.tls_client_cert = attributes[:'tls_client_cert']
  else
    self.tls_client_cert = 'null'
  end

  if attributes.key?(:'tls_client_key')
    self.tls_client_key = attributes[:'tls_client_key']
  else
    self.tls_client_key = 'null'
  end

  if attributes.key?(:'tls_cert_hostname')
    self.tls_cert_hostname = attributes[:'tls_cert_hostname']
  else
    self.tls_cert_hostname = 'null'
  end

  if attributes.key?(:'use_tls')
    self.use_tls = attributes[:'use_tls']
  else
    self.use_tls = USE_TLS::no_tls
  end

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

  if attributes.key?(:'shield')
    self.shield = attributes[:'shield']
  else
    self.shield = 'null'
  end

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

  if attributes.key?(:'max_conn_default')
    self.max_conn_default = attributes[:'max_conn_default']
  else
    self.max_conn_default = 200
  end

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

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

  if attributes.key?(:'quorum')
    self.quorum = attributes[:'quorum']
  else
    self.quorum = 75
  end

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

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

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

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

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

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

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

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

  if attributes.key?(:'override_host')
    self.override_host = attributes[:'override_host']
  else
    self.override_host = 'null'
  end
end

Instance Attribute Details

#comment ⇒ Object

A freeform descriptive note.



71
72
73
 
# File 'lib/fastly/models/pool.rb', line 71

def comment
  @comment
end

#connect_timeout ⇒ Object

How long to wait for a timeout in milliseconds. Optional.



44
45
46
 
# File 'lib/fastly/models/pool.rb', line 44

def connect_timeout
  @connect_timeout
end

#first_byte_timeout ⇒ Object

How long to wait for the first byte in milliseconds. Optional.



47
48
49
 
# File 'lib/fastly/models/pool.rb', line 47

def first_byte_timeout
  @first_byte_timeout
end

#healthcheck ⇒ Object

Name of the healthcheck to use with this pool. Can be empty and could be reused across multiple backend and pools.



68
69
70
 
# File 'lib/fastly/models/pool.rb', line 68

def healthcheck
  @healthcheck
end

#max_conn_default ⇒ Object

Maximum number of connections. Optional.



41
42
43
 
# File 'lib/fastly/models/pool.rb', line 41

def max_conn_default
  @max_conn_default
end

#max_tls_version ⇒ Object

Maximum allowed TLS version on connections to this server. Optional.



65
66
67
 
# File 'lib/fastly/models/pool.rb', line 65

def max_tls_version
  @max_tls_version
end

#min_tls_version ⇒ Object

Minimum allowed TLS version on connections to this server. Optional.



62
63
64
 
# File 'lib/fastly/models/pool.rb', line 62

def min_tls_version
  @min_tls_version
end

#name ⇒ Object

Name for the Pool.



32
33
34
 
# File 'lib/fastly/models/pool.rb', line 32

def name
  @name
end

#override_host ⇒ Object

The hostname to [override the Host header](docs.fastly.com/en/guides/specifying-an-override-host). Defaults to ‘null` meaning no override of the Host header will occur. This setting can also be added to a Server definition. If the field is set on a Server definition it will override the Pool setting.



77
78
79
 
# File 'lib/fastly/models/pool.rb', line 77

def override_host
  @override_host
end

#quorum ⇒ Object

Percentage of capacity (‘0-100`) that needs to be operationally available for a pool to be considered up.



50
51
52
 
# File 'lib/fastly/models/pool.rb', line 50

def quorum
  @quorum
end

#request_condition ⇒ Object

Condition which, if met, will select this configuration during a request. Optional.



38
39
40
 
# File 'lib/fastly/models/pool.rb', line 38

def request_condition
  @request_condition
end

#shield ⇒ Object

Selected POP to serve as a shield for the servers. Defaults to ‘null` meaning no origin shielding if not set. Refer to the [POPs API endpoint](/reference/api/utils/pops/) to get a list of available POPs used for shielding.



35
36
37
 
# File 'lib/fastly/models/pool.rb', line 35

def shield
  @shield
end

#tls_ca_cert ⇒ Object

A secure certificate to authenticate a server with. Must be in PEM format.



17
18
19
 
# File 'lib/fastly/models/pool.rb', line 17

def tls_ca_cert
  @tls_ca_cert
end

#tls_cert_hostname ⇒ Object

The hostname used to verify a server’s certificate. It can either be the Common Name (CN) or a Subject Alternative Name (SAN).



26
27
28
 
# File 'lib/fastly/models/pool.rb', line 26

def tls_cert_hostname
  @tls_cert_hostname
end

#tls_check_cert ⇒ Object

Be strict on checking TLS certs. Optional.



59
60
61
 
# File 'lib/fastly/models/pool.rb', line 59

def tls_check_cert
  @tls_check_cert
end

#tls_ciphers ⇒ Object

List of OpenSSL ciphers (see the [openssl.org manpages](www.openssl.org/docs/man1.1.1/man1/ciphers.html) for details). Optional.



53
54
55
 
# File 'lib/fastly/models/pool.rb', line 53

def tls_ciphers
  @tls_ciphers
end

#tls_client_cert ⇒ Object

The client certificate used to make authenticated requests. Must be in PEM format.



20
21
22
 
# File 'lib/fastly/models/pool.rb', line 20

def tls_client_cert
  @tls_client_cert
end

#tls_client_key ⇒ Object

The client private key used to make authenticated requests. Must be in PEM format.



23
24
25
 
# File 'lib/fastly/models/pool.rb', line 23

def tls_client_key
  @tls_client_key
end

#tls_sni_hostname ⇒ Object

SNI hostname. Optional.



56
57
58
 
# File 'lib/fastly/models/pool.rb', line 56

def tls_sni_hostname
  @tls_sni_hostname
end

#type ⇒ Object

What type of load balance group to use.



74
75
76
 
# File 'lib/fastly/models/pool.rb', line 74

def type
  @type
end

#use_tls ⇒ Object

Whether to use TLS.



29
30
31
 
# File 'lib/fastly/models/pool.rb', line 29

def use_tls
  @use_tls
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



129
130
131
 
# File 'lib/fastly/models/pool.rb', line 129

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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
 
# File 'lib/fastly/models/pool.rb', line 102

def self.attribute_map
  {
    :'tls_ca_cert' => :'tls_ca_cert',
    :'tls_client_cert' => :'tls_client_cert',
    :'tls_client_key' => :'tls_client_key',
    :'tls_cert_hostname' => :'tls_cert_hostname',
    :'use_tls' => :'use_tls',
    :'name' => :'name',
    :'shield' => :'shield',
    :'request_condition' => :'request_condition',
    :'max_conn_default' => :'max_conn_default',
    :'connect_timeout' => :'connect_timeout',
    :'first_byte_timeout' => :'first_byte_timeout',
    :'quorum' => :'quorum',
    :'tls_ciphers' => :'tls_ciphers',
    :'tls_sni_hostname' => :'tls_sni_hostname',
    :'tls_check_cert' => :'tls_check_cert',
    :'min_tls_version' => :'min_tls_version',
    :'max_tls_version' => :'max_tls_version',
    :'healthcheck' => :'healthcheck',
    :'comment' => :'comment',
    :'type' => :'type',
    :'override_host' => :'override_host'
  }
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



410
411
412
 
# File 'lib/fastly/models/pool.rb', line 410

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.fastly_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



181
182
183
184
185
186
 
# File 'lib/fastly/models/pool.rb', line 181

def self.fastly_all_of
  [
  :'PoolAllOf',
  :'TlsCommon'
  ]
end

.fastly_nullable ⇒ Object

List of attributes with nullable: true



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/fastly/models/pool.rb', line 161

def self.fastly_nullable
  Set.new([
    :'tls_ca_cert',
    :'tls_client_cert',
    :'tls_client_key',
    :'tls_cert_hostname',
    :'shield',
    :'request_condition',
    :'tls_ciphers',
    :'tls_sni_hostname',
    :'tls_check_cert',
    :'min_tls_version',
    :'max_tls_version',
    :'healthcheck',
    :'comment',
    :'override_host'
  ])
end

.fastly_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/fastly/models/pool.rb', line 134

def self.fastly_types
  {
    :'tls_ca_cert' => :'String',
    :'tls_client_cert' => :'String',
    :'tls_client_key' => :'String',
    :'tls_cert_hostname' => :'String',
    :'use_tls' => :'Integer',
    :'name' => :'String',
    :'shield' => :'String',
    :'request_condition' => :'String',
    :'max_conn_default' => :'Integer',
    :'connect_timeout' => :'Integer',
    :'first_byte_timeout' => :'Integer',
    :'quorum' => :'Integer',
    :'tls_ciphers' => :'String',
    :'tls_sni_hostname' => :'String',
    :'tls_check_cert' => :'Integer',
    :'min_tls_version' => :'Integer',
    :'max_tls_version' => :'Integer',
    :'healthcheck' => :'String',
    :'comment' => :'String',
    :'type' => :'String',
    :'override_host' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
 
# File 'lib/fastly/models/pool.rb', line 369

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      tls_ca_cert == o.tls_ca_cert &&
      tls_client_cert == o.tls_client_cert &&
      tls_client_key == o.tls_client_key &&
      tls_cert_hostname == o.tls_cert_hostname &&
      use_tls == o.use_tls &&
      name == o.name &&
      shield == o.shield &&
      request_condition == o.request_condition &&
      max_conn_default == o.max_conn_default &&
      connect_timeout == o.connect_timeout &&
      first_byte_timeout == o.first_byte_timeout &&
      quorum == o.quorum &&
      tls_ciphers == o.tls_ciphers &&
      tls_sni_hostname == o.tls_sni_hostname &&
      tls_check_cert == o.tls_check_cert &&
      min_tls_version == o.min_tls_version &&
      max_tls_version == o.max_tls_version &&
      healthcheck == o.healthcheck &&
      comment == o.comment &&
      type == o.type &&
      override_host == o.override_host
end

#_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



440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
 
# File 'lib/fastly/models/pool.rb', line 440

def _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 = Fastly.const_get(type)
    klass.respond_to?(:fastly_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
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



511
512
513
514
515
516
517
518
519
520
521
522
523
 
# File 'lib/fastly/models/pool.rb', line 511

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

#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



417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
 
# File 'lib/fastly/models/pool.rb', line 417

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.fastly_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.fastly_nullable.include?(key)
      self.send("#{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[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


397
398
399
 
# File 'lib/fastly/models/pool.rb', line 397

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



403
404
405
 
# File 'lib/fastly/models/pool.rb', line 403

def hash
  [tls_ca_cert, tls_client_cert, tls_client_key, tls_cert_hostname, use_tls, name, shield, request_condition, max_conn_default, connect_timeout, first_byte_timeout, quorum, tls_ciphers, tls_sni_hostname, tls_check_cert, min_tls_version, max_tls_version, healthcheck, comment, type, override_host].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



308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/fastly/models/pool.rb', line 308

def list_invalid_properties
  invalid_properties = Array.new
  if !@quorum.nil? && @quorum > 100
    invalid_properties.push('invalid value for "quorum", must be smaller than or equal to 100.')
  end

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



487
488
489
 
# File 'lib/fastly/models/pool.rb', line 487

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



493
494
495
496
497
498
499
500
501
502
503
504
505
 
# File 'lib/fastly/models/pool.rb', line 493

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.fastly_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



481
482
483
 
# File 'lib/fastly/models/pool.rb', line 481

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



323
324
325
326
327
328
329
330
331
 
# File 'lib/fastly/models/pool.rb', line 323

def valid?
  use_tls_validator = EnumAttributeValidator.new('Integer', [0, 1])
  return false unless use_tls_validator.valid?(@use_tls)
  return false if !@quorum.nil? && @quorum > 100
  return false if !@quorum.nil? && @quorum < 0
  type_validator = EnumAttributeValidator.new('String', ["random", "hash", "client"])
  return false unless type_validator.valid?(@type)
  true
end