Class: Fastly::ServerResponse

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ServerResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

  if attributes.key?(:'max_conn')
    self.max_conn = attributes[:'max_conn']
  else
    self.max_conn = 0
  end

  if attributes.key?(:'port')
    self.port = attributes[:'port']
  else
    self.port = 80
  end

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

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

  if attributes.key?(:'disabled')
    self.disabled = attributes[:'disabled']
  else
    self.disabled = false
  end

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

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

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

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

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

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

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

Instance Attribute Details

#address ⇒ Object

A hostname, IPv4, or IPv6 address for the server. Required.



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

def address
  @address
end

#comment ⇒ Object

A freeform descriptive note.



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

def comment
  @comment
end

#created_at ⇒ Object

Date and time in ISO 8601 format.



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

def created_at
  @created_at
end

#deleted_at ⇒ Object

Date and time in ISO 8601 format.



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

def deleted_at
  @deleted_at
end

#disabled ⇒ Object

Allows servers to be enabled and disabled in a pool.



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

def disabled
  @disabled
end

#id ⇒ Object

Returns the value of attribute id.



48
49
50
 
# File 'lib/fastly/models/server_response.rb', line 48

def id
  @id
end

#max_conn ⇒ Object

Maximum number of connections. If the value is ‘0`, it inherits the value from pool’s ‘max_conn_default`.



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

def max_conn
  @max_conn
end

#override_host ⇒ Object

The hostname to override the Host header. Defaults to ‘null` meaning no override of the Host header if not set. This setting can also be added to a Pool definition. However, the server setting will override the Pool setting.



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

def override_host
  @override_host
end

#pool_id ⇒ Object

Returns the value of attribute pool_id.



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

def pool_id
  @pool_id
end

#port ⇒ Object

Port number. Setting port ‘443` does not force TLS. Set `use_tls` in pool to force TLS.



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

def port
  @port
end

#service_id ⇒ Object

Returns the value of attribute service_id.



46
47
48
 
# File 'lib/fastly/models/server_response.rb', line 46

def service_id
  @service_id
end

#updated_at ⇒ Object

Date and time in ISO 8601 format.



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

def updated_at
  @updated_at
end

#weight ⇒ Object

Weight (‘1-100`) used to load balance this server against others.



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

def weight
  @weight
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



72
73
74
 
# File 'lib/fastly/models/server_response.rb', line 72

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/fastly/models/server_response.rb', line 53

def self.attribute_map
  {
    :'weight' => :'weight',
    :'max_conn' => :'max_conn',
    :'port' => :'port',
    :'address' => :'address',
    :'comment' => :'comment',
    :'disabled' => :'disabled',
    :'override_host' => :'override_host',
    :'created_at' => :'created_at',
    :'deleted_at' => :'deleted_at',
    :'updated_at' => :'updated_at',
    :'service_id' => :'service_id',
    :'id' => :'id',
    :'pool_id' => :'pool_id'
  }
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



265
266
267
 
# File 'lib/fastly/models/server_response.rb', line 265

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

.fastly_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



107
108
109
110
111
112
113
 
# File 'lib/fastly/models/server_response.rb', line 107

def self.fastly_all_of
  [
  :'Server',
  :'ServerResponseAllOf',
  :'Timestamps'
  ]
end

.fastly_nullable ⇒ Object

List of attributes with nullable: true



96
97
98
99
100
101
102
103
104
 
# File 'lib/fastly/models/server_response.rb', line 96

def self.fastly_nullable
  Set.new([
    :'comment',
    :'override_host',
    :'created_at',
    :'deleted_at',
    :'updated_at',
  ])
end

.fastly_types ⇒ Object

Attribute type mapping.



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/fastly/models/server_response.rb', line 77

def self.fastly_types
  {
    :'weight' => :'Integer',
    :'max_conn' => :'Integer',
    :'port' => :'Integer',
    :'address' => :'String',
    :'comment' => :'String',
    :'disabled' => :'Boolean',
    :'override_host' => :'String',
    :'created_at' => :'Time',
    :'deleted_at' => :'Time',
    :'updated_at' => :'Time',
    :'service_id' => :'String',
    :'id' => :'String',
    :'pool_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/fastly/models/server_response.rb', line 232

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      weight == o.weight &&
      max_conn == o.max_conn &&
      port == o.port &&
      address == o.address &&
      comment == o.comment &&
      disabled == o.disabled &&
      override_host == o.override_host &&
      created_at == o.created_at &&
      deleted_at == o.deleted_at &&
      updated_at == o.updated_at &&
      service_id == o.service_id &&
      id == o.id &&
      pool_id == o.pool_id
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



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
325
326
327
328
329
330
331
332
 
# File 'lib/fastly/models/server_response.rb', line 295

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



366
367
368
369
370
371
372
373
374
375
376
377
378
 
# File 'lib/fastly/models/server_response.rb', line 366

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



272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/fastly/models/server_response.rb', line 272

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


252
253
254
 
# File 'lib/fastly/models/server_response.rb', line 252

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



258
259
260
 
# File 'lib/fastly/models/server_response.rb', line 258

def hash
  [weight, max_conn, port, address, comment, disabled, override_host, created_at, deleted_at, updated_at, service_id, id, pool_id].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



195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/fastly/models/server_response.rb', line 195

def list_invalid_properties
  invalid_properties = Array.new
  if !@weight.nil? && @weight > 100
    invalid_properties.push('invalid value for "weight", must be smaller than or equal to 100.')
  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



342
343
344
 
# File 'lib/fastly/models/server_response.rb', line 342

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



348
349
350
351
352
353
354
355
356
357
358
359
360
 
# File 'lib/fastly/models/server_response.rb', line 348

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



336
337
338
 
# File 'lib/fastly/models/server_response.rb', line 336

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



210
211
212
213
214
 
# File 'lib/fastly/models/server_response.rb', line 210

def valid?
  return false if !@weight.nil? && @weight > 100
  return false if !@weight.nil? && @weight < 1
  true
end