Class: Fastly::Director

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Director

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
158
159
 
# File 'lib/fastly/models/director.rb', line 105

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

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

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

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

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

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

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

  if attributes.key?(:'retries')
    self.retries = attributes[:'retries']
  else
    self.retries = 5
  end
end

Instance Attribute Details

#backends ⇒ Object

List of backends associated to a director.



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

def backends
  @backends
end

#capacity ⇒ Object

Unused.



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

def capacity
  @capacity
end

#comment ⇒ Object

A freeform descriptive note.



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

def comment
  @comment
end

#name ⇒ Object

Name for the Director.



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

def name
  @name
end

#quorum ⇒ Object

The percentage of capacity that needs to be up for a director to be considered up. ‘0` to `100`.



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

def quorum
  @quorum
end

#retries ⇒ Object

How many backends to search if it fails.



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

def retries
  @retries
end

#shield ⇒ Object

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



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

def shield
  @shield
end

#type ⇒ Object

What type of load balance group to use.



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

def type
  @type
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/fastly/models/director.rb', line 63

def self.attribute_map
  {
    :'backends' => :'backends',
    :'capacity' => :'capacity',
    :'comment' => :'comment',
    :'name' => :'name',
    :'quorum' => :'quorum',
    :'shield' => :'shield',
    :'type' => :'type',
    :'retries' => :'retries'
  }
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



240
241
242
 
# File 'lib/fastly/models/director.rb', line 240

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

.fastly_nullable ⇒ Object

List of attributes with nullable: true



96
97
98
99
100
101
 
# File 'lib/fastly/models/director.rb', line 96

def self.fastly_nullable
  Set.new([
    :'comment',
    :'shield',
  ])
end

.fastly_types ⇒ Object

Attribute type mapping.



82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/fastly/models/director.rb', line 82

def self.fastly_types
  {
    :'backends' => :'Array<Backend>',
    :'capacity' => :'Integer',
    :'comment' => :'String',
    :'name' => :'String',
    :'quorum' => :'Integer',
    :'shield' => :'String',
    :'type' => :'Integer',
    :'retries' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/fastly/models/director.rb', line 212

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      backends == o.backends &&
      capacity == o.capacity &&
      comment == o.comment &&
      name == o.name &&
      quorum == o.quorum &&
      shield == o.shield &&
      type == o.type &&
      retries == o.retries
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



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
305
306
307
 
# File 'lib/fastly/models/director.rb', line 270

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



341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/fastly/models/director.rb', line 341

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



247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/fastly/models/director.rb', line 247

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


227
228
229
 
# File 'lib/fastly/models/director.rb', line 227

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



233
234
235
 
# File 'lib/fastly/models/director.rb', line 233

def hash
  [backends, capacity, comment, name, quorum, shield, type, retries].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



163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/fastly/models/director.rb', line 163

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



317
318
319
 
# File 'lib/fastly/models/director.rb', line 317

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



323
324
325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/fastly/models/director.rb', line 323

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



311
312
313
 
# File 'lib/fastly/models/director.rb', line 311

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



178
179
180
181
182
183
184
 
# File 'lib/fastly/models/director.rb', line 178

def valid?
  return false if !@quorum.nil? && @quorum > 100
  return false if !@quorum.nil? && @quorum < 0
  type_validator = EnumAttributeValidator.new('Integer', [1, 3, 4])
  return false unless type_validator.valid?(@type)
  true
end