Class: Fastly::Header

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Header

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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/header.rb', line 129

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

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

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

Instance Attribute Details

#action ⇒ Object

Accepts a string value.



17
18
19
 
# File 'lib/fastly/models/header.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.rb', line 20

def cache_condition
  @cache_condition
end

#dst ⇒ Object

Header to set.



23
24
25
 
# File 'lib/fastly/models/header.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.



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

def ignore_if_set
  @ignore_if_set
end

#name ⇒ Object

A handle to refer to this Header object.



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

def name
  @name
end

#priority ⇒ Object

Priority determines execution order. Lower numbers execute first.



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

def priority
  @priority
end

#regex ⇒ Object

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



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

def regex
  @regex
end

#request_condition ⇒ Object

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



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

def request_condition
  @request_condition
end

#response_condition ⇒ Object

Optional name of a response condition to apply.



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

def response_condition
  @response_condition
end

#src ⇒ Object

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



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

def src
  @src
end

#substitution ⇒ Object

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



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

def substitution
  @substitution
end

#type ⇒ Object

Accepts a string value.



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

def type
  @type
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



93
94
95
 
# File 'lib/fastly/models/header.rb', line 93

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/fastly/models/header.rb', line 75

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



264
265
266
 
# File 'lib/fastly/models/header.rb', line 264

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

.fastly_nullable ⇒ Object

List of attributes with nullable: true



116
117
118
119
120
121
122
123
124
125
 
# File 'lib/fastly/models/header.rb', line 116

def self.fastly_nullable
  Set.new([
    :'cache_condition',
    :'regex',
    :'request_condition',
    :'response_condition',
    :'src',
    :'substitution',
  ])
end

.fastly_types ⇒ Object

Attribute type mapping.



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/fastly/models/header.rb', line 98

def self.fastly_types
  {
    :'action' => :'String',
    :'cache_condition' => :'String',
    :'dst' => :'String',
    :'ignore_if_set' => :'Integer',
    :'name' => :'String',
    :'priority' => :'Integer',
    :'regex' => :'String',
    :'request_condition' => :'String',
    :'response_condition' => :'String',
    :'src' => :'String',
    :'substitution' => :'String',
    :'type' => :'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
 
# File 'lib/fastly/models/header.rb', line 232

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



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

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



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

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



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

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


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

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



257
258
259
 
# File 'lib/fastly/models/header.rb', line 257

def hash
  [action, cache_condition, dst, ignore_if_set, name, priority, regex, request_condition, response_condition, src, substitution, type].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
 
# File 'lib/fastly/models/header.rb', line 195

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



341
342
343
 
# File 'lib/fastly/models/header.rb', line 341

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



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

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



335
336
337
 
# File 'lib/fastly/models/header.rb', line 335

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



202
203
204
205
206
207
208
 
# File 'lib/fastly/models/header.rb', line 202

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