Class: Fastly::CacheSettingResponse

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CacheSettingResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

#actionObject

If set, will cause vcl_fetch to terminate after processing this rule with the return state specified. If not set, other configuration logic in vcl_fetch with a lower priority will run after this rule.



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

def action
  @action
end

#cache_conditionObject

Name of the cache condition controlling when this configuration applies.



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

def cache_condition
  @cache_condition
end

#created_atObject

Date and time in ISO 8601 format.



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

def created_at
  @created_at
end

#deleted_atObject

Date and time in ISO 8601 format.



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

def deleted_at
  @deleted_at
end

#nameObject

Name for the cache settings object.



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

def name
  @name
end

#service_idObject

Returns the value of attribute service_id.



31
32
33
# File 'lib/fastly/models/cache_setting_response.rb', line 31

def service_id
  @service_id
end

#stale_ttlObject

Maximum time in seconds to continue to use a stale version of the object if future requests to your backend server fail (also known as ‘stale if error’).



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

def stale_ttl
  @stale_ttl
end

#ttlObject

Maximum time to consider the object fresh in the cache (the cache ‘time to live’).



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

def ttl
  @ttl
end

#updated_atObject

Date and time in ISO 8601 format.



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

def updated_at
  @updated_at
end

#versionObject

Returns the value of attribute version.



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

def version
  @version
end

Class Method Details

.acceptable_attributesObject

Returns all the JSON keys this model knows about



83
84
85
# File 'lib/fastly/models/cache_setting_response.rb', line 83

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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



67
68
69
70
71
72
73
74
75
76
77
78
79
80
# File 'lib/fastly/models/cache_setting_response.rb', line 67

def self.attribute_map
  {
    :'action' => :'action',
    :'cache_condition' => :'cache_condition',
    :'name' => :'name',
    :'stale_ttl' => :'stale_ttl',
    :'ttl' => :'ttl',
    :'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



236
237
238
# File 'lib/fastly/models/cache_setting_response.rb', line 236

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

.fastly_all_ofObject

List of class defined in allOf (OpenAPI v3)



115
116
117
118
119
120
121
# File 'lib/fastly/models/cache_setting_response.rb', line 115

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

.fastly_nullableObject

List of attributes with nullable: true



104
105
106
107
108
109
110
111
112
# File 'lib/fastly/models/cache_setting_response.rb', line 104

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

.fastly_typesObject

Attribute type mapping.



88
89
90
91
92
93
94
95
96
97
98
99
100
101
# File 'lib/fastly/models/cache_setting_response.rb', line 88

def self.fastly_types
  {
    :'action' => :'String',
    :'cache_condition' => :'String',
    :'name' => :'String',
    :'stale_ttl' => :'String',
    :'ttl' => :'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



206
207
208
209
210
211
212
213
214
215
216
217
218
219
# File 'lib/fastly/models/cache_setting_response.rb', line 206

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      action == o.action &&
      cache_condition == o.cache_condition &&
      name == o.name &&
      stale_ttl == o.stale_ttl &&
      ttl == o.ttl &&
      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



266
267
268
269
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
# File 'lib/fastly/models/cache_setting_response.rb', line 266

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



337
338
339
340
341
342
343
344
345
346
347
348
349
# File 'lib/fastly/models/cache_setting_response.rb', line 337

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



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
# File 'lib/fastly/models/cache_setting_response.rb', line 243

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


223
224
225
# File 'lib/fastly/models/cache_setting_response.rb', line 223

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



229
230
231
# File 'lib/fastly/models/cache_setting_response.rb', line 229

def hash
  [action, cache_condition, name, stale_ttl, ttl, service_id, version, created_at, deleted_at, updated_at].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



181
182
183
184
# File 'lib/fastly/models/cache_setting_response.rb', line 181

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



313
314
315
# File 'lib/fastly/models/cache_setting_response.rb', line 313

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



319
320
321
322
323
324
325
326
327
328
329
330
331
# File 'lib/fastly/models/cache_setting_response.rb', line 319

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



307
308
309
# File 'lib/fastly/models/cache_setting_response.rb', line 307

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



188
189
190
191
192
# File 'lib/fastly/models/cache_setting_response.rb', line 188

def valid?
  action_validator = EnumAttributeValidator.new('String', ["pass", "cache", "restart"])
  return false unless action_validator.valid?(@action)
  true
end