Class: Fastly::HeaderResponse

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ HeaderResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'priority')
    self.priority = attributes[:'priority']
  else
    self.priority = '100'
  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?(:'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
end

Instance Attribute Details

#action ⇒ Object

Accepts a string value.



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

def action
  @action
end

#cache_condition ⇒ Object

Name of the cache condition controlling when this configuration applies.



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

def cache_condition
  @cache_condition
end

#created_at ⇒ Object

Date and time in ISO 8601 format.



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

def created_at
  @created_at
end

#deleted_at ⇒ Object

Date and time in ISO 8601 format.



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

def deleted_at
  @deleted_at
end

#dst ⇒ Object

Header to set.



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

def dst
  @dst
end

#ignore_if_set ⇒ Object

Don’t add the header if it is added already. Only applies to ‘set’ action. Numerical value ("0" = false, "1" = true)



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

def ignore_if_set
  @ignore_if_set
end

#name ⇒ Object

A handle to refer to this Header object.



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

def name
  @name
end

#priority ⇒ Object

Priority determines execution order. Lower numbers execute first.



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

def priority
  @priority
end

#regex ⇒ Object

Regular expression to use. Only applies to ‘regex` and `regex_repeat` actions.



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

def regex
  @regex
end

#request_condition ⇒ Object

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



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

def request_condition
  @request_condition
end

#response_condition ⇒ Object

Optional name of a response condition to apply.



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

def response_condition
  @response_condition
end

#service_id ⇒ Object

Returns the value of attribute service_id.



52
53
54
 
# File 'lib/fastly/models/header_response.rb', line 52

def service_id
  @service_id
end

#src ⇒ Object

Variable to be used as a source for the header content. Does not apply to ‘delete` action.



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

def src
  @src
end

#substitution ⇒ Object

Value to substitute in place of regular expression. Only applies to ‘regex` and `regex_repeat` actions.



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

def substitution
  @substitution
end

#type ⇒ Object

Accepts a string value.



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

def type
  @type
end

#updated_at ⇒ Object

Date and time in ISO 8601 format.



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

def updated_at
  @updated_at
end

#version ⇒ Object

Returns the value of attribute version.



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

def version
  @version
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



111
112
113
 
# File 'lib/fastly/models/header_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/header_response.rb', line 88

def self.attribute_map
  {
    :'action' => :'action',
    :'cache_condition' => :'cache_condition',
    :'dst' => :'dst',
    :'name' => :'name',
    :'regex' => :'regex',
    :'request_condition' => :'request_condition',
    :'response_condition' => :'response_condition',
    :'src' => :'src',
    :'substitution' => :'substitution',
    :'type' => :'type',
    :'ignore_if_set' => :'ignore_if_set',
    :'priority' => :'priority',
    :'service_id' => :'service_id',
    :'version' => :'version',
    :'created_at' => :'created_at',
    :'deleted_at' => :'deleted_at',
    :'updated_at' => :'updated_at'
  }
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



325
326
327
 
# File 'lib/fastly/models/header_response.rb', line 325

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

.fastly_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



154
155
156
157
158
159
160
161
 
# File 'lib/fastly/models/header_response.rb', line 154

def self.fastly_all_of
  [
  :'Header',
  :'HeaderResponseAdditional',
  :'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
 
# File 'lib/fastly/models/header_response.rb', line 139

def self.fastly_nullable
  Set.new([
    :'cache_condition',
    :'regex',
    :'request_condition',
    :'response_condition',
    :'src',
    :'substitution',
    :'created_at',
    :'deleted_at',
    :'updated_at'
  ])
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/header_response.rb', line 116

def self.fastly_types
  {
    :'action' => :'String',
    :'cache_condition' => :'String',
    :'dst' => :'String',
    :'name' => :'String',
    :'regex' => :'String',
    :'request_condition' => :'String',
    :'response_condition' => :'String',
    :'src' => :'String',
    :'substitution' => :'String',
    :'type' => :'String',
    :'ignore_if_set' => :'String',
    :'priority' => :'String',
    :'service_id' => :'String',
    :'version' => :'String',
    :'created_at' => :'Time',
    :'deleted_at' => :'Time',
    :'updated_at' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      action == o.action &&
      cache_condition == o.cache_condition &&
      dst == o.dst &&
      name == o.name &&
      regex == o.regex &&
      request_condition == o.request_condition &&
      response_condition == o.response_condition &&
      src == o.src &&
      substitution == o.substitution &&
      type == o.type &&
      ignore_if_set == o.ignore_if_set &&
      priority == o.priority &&
      service_id == o.service_id &&
      version == o.version &&
      created_at == o.created_at &&
      deleted_at == o.deleted_at &&
      updated_at == o.updated_at
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



355
356
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
 
# File 'lib/fastly/models/header_response.rb', line 355

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



426
427
428
429
430
431
432
433
434
435
436
437
438
 
# File 'lib/fastly/models/header_response.rb', line 426

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



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

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


312
313
314
 
# File 'lib/fastly/models/header_response.rb', line 312

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



318
319
320
 
# File 'lib/fastly/models/header_response.rb', line 318

def hash
  [action, cache_condition, dst, name, regex, request_condition, response_condition, src, substitution, type, ignore_if_set, priority, service_id, version, created_at, deleted_at, updated_at].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



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

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



402
403
404
 
# File 'lib/fastly/models/header_response.rb', line 402

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



408
409
410
411
412
413
414
415
416
417
418
419
420
 
# File 'lib/fastly/models/header_response.rb', line 408

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



396
397
398
 
# File 'lib/fastly/models/header_response.rb', line 396

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



258
259
260
261
262
263
264
 
# File 'lib/fastly/models/header_response.rb', line 258

def valid?
  action_validator = EnumAttributeValidator.new('String', ["set", "append", "delete", "regex", "regex_repeat"])
  return false unless action_validator.valid?(@action)
  type_validator = EnumAttributeValidator.new('String', ["request", "cache", "response"])
  return false unless type_validator.valid?(@type)
  true
end