Class: Fastly::RequestSettingsResponse

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RequestSettingsResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#action ⇒ Object

Allows you to terminate request handling and immediately perform an action.



30
31
32
 
# File 'lib/fastly/models/request_settings_response.rb', line 30

def action
  @action
end

#bypass_busy_wait ⇒ Object

Disable collapsed forwarding, so you don’t wait for other objects to origin.



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

def bypass_busy_wait
  @bypass_busy_wait
end

#created_at ⇒ Object

Date and time in ISO 8601 format.



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

def created_at
  @created_at
end

#default_host ⇒ Object

Sets the host header.



33
34
35
 
# File 'lib/fastly/models/request_settings_response.rb', line 33

def default_host
  @default_host
end

#deleted_at ⇒ Object

Date and time in ISO 8601 format.



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

def deleted_at
  @deleted_at
end

#force_miss ⇒ Object

Allows you to force a cache miss for the request. Replaces the item in the cache if the content is cacheable.



51
52
53
 
# File 'lib/fastly/models/request_settings_response.rb', line 51

def force_miss
  @force_miss
end

#force_ssl ⇒ Object

Forces the request use SSL (redirects a non-SSL to SSL).



54
55
56
 
# File 'lib/fastly/models/request_settings_response.rb', line 54

def force_ssl
  @force_ssl
end

#geo_headers ⇒ Object

Injects Fastly-Geo-Country, Fastly-Geo-City, and Fastly-Geo-Region into the request headers.



57
58
59
 
# File 'lib/fastly/models/request_settings_response.rb', line 57

def geo_headers
  @geo_headers
end

#hash_keys ⇒ Object

Comma separated list of varnish request object fields that should be in the hash key.



36
37
38
 
# File 'lib/fastly/models/request_settings_response.rb', line 36

def hash_keys
  @hash_keys
end

#max_stale_age ⇒ Object

How old an object is allowed to be to serve stale-if-error or stale-while-revalidate.



60
61
62
 
# File 'lib/fastly/models/request_settings_response.rb', line 60

def max_stale_age
  @max_stale_age
end

#name ⇒ Object

Name for the request settings.



39
40
41
 
# File 'lib/fastly/models/request_settings_response.rb', line 39

def name
  @name
end

#request_condition ⇒ Object

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



42
43
44
 
# File 'lib/fastly/models/request_settings_response.rb', line 42

def request_condition
  @request_condition
end

#service_id ⇒ Object

Returns the value of attribute service_id.



25
26
27
 
# File 'lib/fastly/models/request_settings_response.rb', line 25

def service_id
  @service_id
end

#timer_support ⇒ Object

Injects the X-Timer info into the request for viewing origin fetch durations.



63
64
65
 
# File 'lib/fastly/models/request_settings_response.rb', line 63

def timer_support
  @timer_support
end

#updated_at ⇒ Object

Date and time in ISO 8601 format.



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

def updated_at
  @updated_at
end

#version ⇒ Object

Returns the value of attribute version.



27
28
29
 
# File 'lib/fastly/models/request_settings_response.rb', line 27

def version
  @version
end

#xff ⇒ Object

Short for X-Forwarded-For.



45
46
47
 
# File 'lib/fastly/models/request_settings_response.rb', line 45

def xff
  @xff
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



111
112
113
 
# File 'lib/fastly/models/request_settings_response.rb', line 111

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/fastly/models/request_settings_response.rb', line 88

def self.attribute_map
  {
    :'created_at' => :'created_at',
    :'deleted_at' => :'deleted_at',
    :'updated_at' => :'updated_at',
    :'service_id' => :'service_id',
    :'version' => :'version',
    :'action' => :'action',
    :'default_host' => :'default_host',
    :'hash_keys' => :'hash_keys',
    :'name' => :'name',
    :'request_condition' => :'request_condition',
    :'xff' => :'xff',
    :'bypass_busy_wait' => :'bypass_busy_wait',
    :'force_miss' => :'force_miss',
    :'force_ssl' => :'force_ssl',
    :'geo_headers' => :'geo_headers',
    :'max_stale_age' => :'max_stale_age',
    :'timer_support' => :'timer_support'
  }
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



327
328
329
 
# File 'lib/fastly/models/request_settings_response.rb', line 327

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

.fastly_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



158
159
160
161
162
163
164
165
 
# File 'lib/fastly/models/request_settings_response.rb', line 158

def self.fastly_all_of
  [
  :'RequestSettingsAdditional',
  :'RequestSettingsResponseAllOf',
  :'ServiceIdAndVersionString',
  :'Timestamps'
  ]
end

.fastly_nullable ⇒ Object

List of attributes with nullable: true



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/fastly/models/request_settings_response.rb', line 139

def self.fastly_nullable
  Set.new([
    :'created_at',
    :'deleted_at',
    :'updated_at',
    :'action',
    :'default_host',
    :'hash_keys',
    :'request_condition',
    :'xff',
    :'bypass_busy_wait',
    :'force_miss',
    :'geo_headers',
    :'max_stale_age',
    :'timer_support'
  ])
end

.fastly_types ⇒ Object

Attribute type mapping.



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/fastly/models/request_settings_response.rb', line 116

def self.fastly_types
  {
    :'created_at' => :'Time',
    :'deleted_at' => :'Time',
    :'updated_at' => :'Time',
    :'service_id' => :'String',
    :'version' => :'String',
    :'action' => :'String',
    :'default_host' => :'String',
    :'hash_keys' => :'String',
    :'name' => :'String',
    :'request_condition' => :'String',
    :'xff' => :'String',
    :'bypass_busy_wait' => :'String',
    :'force_miss' => :'String',
    :'force_ssl' => :'String',
    :'geo_headers' => :'String',
    :'max_stale_age' => :'String',
    :'timer_support' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/fastly/models/request_settings_response.rb', line 290

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      created_at == o.created_at &&
      deleted_at == o.deleted_at &&
      updated_at == o.updated_at &&
      service_id == o.service_id &&
      version == o.version &&
      action == o.action &&
      default_host == o.default_host &&
      hash_keys == o.hash_keys &&
      name == o.name &&
      request_condition == o.request_condition &&
      xff == o.xff &&
      bypass_busy_wait == o.bypass_busy_wait &&
      force_miss == o.force_miss &&
      force_ssl == o.force_ssl &&
      geo_headers == o.geo_headers &&
      max_stale_age == o.max_stale_age &&
      timer_support == o.timer_support
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



357
358
359
360
361
362
363
364
365
366
367
368
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
394
 
# File 'lib/fastly/models/request_settings_response.rb', line 357

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



428
429
430
431
432
433
434
435
436
437
438
439
440
 
# File 'lib/fastly/models/request_settings_response.rb', line 428

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



334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/fastly/models/request_settings_response.rb', line 334

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


314
315
316
 
# File 'lib/fastly/models/request_settings_response.rb', line 314

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



320
321
322
 
# File 'lib/fastly/models/request_settings_response.rb', line 320

def hash
  [created_at, deleted_at, updated_at, service_id, version, action, default_host, hash_keys, name, request_condition, xff, bypass_busy_wait, force_miss, force_ssl, geo_headers, max_stale_age, timer_support].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



253
254
255
256
 
# File 'lib/fastly/models/request_settings_response.rb', line 253

def list_invalid_properties
  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



404
405
406
 
# File 'lib/fastly/models/request_settings_response.rb', line 404

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



410
411
412
413
414
415
416
417
418
419
420
421
422
 
# File 'lib/fastly/models/request_settings_response.rb', line 410

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



398
399
400
 
# File 'lib/fastly/models/request_settings_response.rb', line 398

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



260
261
262
263
264
265
266
 
# File 'lib/fastly/models/request_settings_response.rb', line 260

def valid?
  action_validator = EnumAttributeValidator.new('String', ["lookup", "pass"])
  return false unless action_validator.valid?(@action)
  xff_validator = EnumAttributeValidator.new('String', ["clear", "leave", "append", "append_all", "overwrite"])
  return false unless xff_validator.valid?(@xff)
  true
end