Class: Fastly::DefaultSettingsResponse

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DefaultSettingsResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



105
106
107
108
109
110
111
112
113
114
115
116
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
# File 'lib/fastly/models/default_settings_response.rb', line 105

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

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

  if attributes.key?(:'webp_quality')
    self.webp_quality = attributes[:'webp_quality']
  else
    self.webp_quality = 85
  end

  if attributes.key?(:'jpeg_type')
    self.jpeg_type = attributes[:'jpeg_type']
  else
    self.jpeg_type = 'auto'
  end

  if attributes.key?(:'jpeg_quality')
    self.jpeg_quality = attributes[:'jpeg_quality']
  else
    self.jpeg_quality = 85
  end

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

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

Instance Attribute Details

#allow_videoObject

Enables GIF to MP4 transformations on this service.



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

def allow_video
  @allow_video
end

#jpeg_qualityObject

The default quality to use with JPEG output. This can be overridden with the "quality" parameter on specific image optimizer requests.



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

def jpeg_quality
  @jpeg_quality
end

#jpeg_typeObject

The default type of JPEG output to use. This can be overridden with "format=bjpeg" and "format=pjpeg" on specific image optimizer requests.



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

def jpeg_type
  @jpeg_type
end

#resize_filterObject

The type of filter to use while resizing an image.



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

def resize_filter
  @resize_filter
end

#upscaleObject

Whether or not we should allow output images to render at sizes larger than input.



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

def upscale
  @upscale
end

#webpObject

Controls whether or not to default to WebP output when the client supports it. This is equivalent to adding "auto=webp" to all image optimizer requests.



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

def webp
  @webp
end

#webp_qualityObject

The default quality to use with WebP output. This can be overridden with the second option in the "quality" URL parameter on specific image optimizer requests.



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

def webp_quality
  @webp_quality
end

Class Method Details

.acceptable_attributesObject

Returns all the JSON keys this model knows about



73
74
75
# File 'lib/fastly/models/default_settings_response.rb', line 73

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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



60
61
62
63
64
65
66
67
68
69
70
# File 'lib/fastly/models/default_settings_response.rb', line 60

def self.attribute_map
  {
    :'resize_filter' => :'resize_filter',
    :'webp' => :'webp',
    :'webp_quality' => :'webp_quality',
    :'jpeg_type' => :'jpeg_type',
    :'jpeg_quality' => :'jpeg_quality',
    :'upscale' => :'upscale',
    :'allow_video' => :'allow_video'
  }
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



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

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

.fastly_all_ofObject

List of class defined in allOf (OpenAPI v3)



97
98
99
100
101
# File 'lib/fastly/models/default_settings_response.rb', line 97

def self.fastly_all_of
  [
  :'DefaultSettings'
  ]
end

.fastly_nullableObject

List of attributes with nullable: true



91
92
93
94
# File 'lib/fastly/models/default_settings_response.rb', line 91

def self.fastly_nullable
  Set.new([
  ])
end

.fastly_typesObject

Attribute type mapping.



78
79
80
81
82
83
84
85
86
87
88
# File 'lib/fastly/models/default_settings_response.rb', line 78

def self.fastly_types
  {
    :'resize_filter' => :'String',
    :'webp' => :'Boolean',
    :'webp_quality' => :'Integer',
    :'jpeg_type' => :'String',
    :'jpeg_quality' => :'Integer',
    :'upscale' => :'Boolean',
    :'allow_video' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



291
292
293
294
295
296
297
298
299
300
301
# File 'lib/fastly/models/default_settings_response.rb', line 291

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      resize_filter == o.resize_filter &&
      webp == o.webp &&
      webp_quality == o.webp_quality &&
      jpeg_type == o.jpeg_type &&
      jpeg_quality == o.jpeg_quality &&
      upscale == o.upscale &&
      allow_video == o.allow_video
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



348
349
350
351
352
353
354
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
# File 'lib/fastly/models/default_settings_response.rb', line 348

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



419
420
421
422
423
424
425
426
427
428
429
430
431
# File 'lib/fastly/models/default_settings_response.rb', line 419

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



325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
# File 'lib/fastly/models/default_settings_response.rb', line 325

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


305
306
307
# File 'lib/fastly/models/default_settings_response.rb', line 305

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



311
312
313
# File 'lib/fastly/models/default_settings_response.rb', line 311

def hash
  [resize_filter, webp, webp_quality, jpeg_type, jpeg_quality, upscale, allow_video].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



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
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
# File 'lib/fastly/models/default_settings_response.rb', line 163

def list_invalid_properties
  invalid_properties = Array.new
  if @resize_filter.nil?
    invalid_properties.push('invalid value for "resize_filter", resize_filter cannot be nil.')
  end

  if @webp.nil?
    invalid_properties.push('invalid value for "webp", webp cannot be nil.')
  end

  if @webp_quality.nil?
    invalid_properties.push('invalid value for "webp_quality", webp_quality cannot be nil.')
  end

  if @webp_quality > 100
    invalid_properties.push('invalid value for "webp_quality", must be smaller than or equal to 100.')
  end

  if @webp_quality < 1
    invalid_properties.push('invalid value for "webp_quality", must be greater than or equal to 1.')
  end

  if @jpeg_type.nil?
    invalid_properties.push('invalid value for "jpeg_type", jpeg_type cannot be nil.')
  end

  if @jpeg_quality.nil?
    invalid_properties.push('invalid value for "jpeg_quality", jpeg_quality cannot be nil.')
  end

  if @jpeg_quality > 100
    invalid_properties.push('invalid value for "jpeg_quality", must be smaller than or equal to 100.')
  end

  if @jpeg_quality < 1
    invalid_properties.push('invalid value for "jpeg_quality", must be greater than or equal to 1.')
  end

  if @upscale.nil?
    invalid_properties.push('invalid value for "upscale", upscale cannot be nil.')
  end

  if @allow_video.nil?
    invalid_properties.push('invalid value for "allow_video", allow_video cannot be nil.')
  end

  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



395
396
397
# File 'lib/fastly/models/default_settings_response.rb', line 395

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



401
402
403
404
405
406
407
408
409
410
411
412
413
# File 'lib/fastly/models/default_settings_response.rb', line 401

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



389
390
391
# File 'lib/fastly/models/default_settings_response.rb', line 389

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



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
# File 'lib/fastly/models/default_settings_response.rb', line 214

def valid?
  return false if @resize_filter.nil?
  resize_filter_validator = EnumAttributeValidator.new('String', ["lanczos3", "lanczos2", "bicubic", "bilinear", "nearest"])
  return false unless resize_filter_validator.valid?(@resize_filter)
  return false if @webp.nil?
  return false if @webp_quality.nil?
  return false if @webp_quality > 100
  return false if @webp_quality < 1
  return false if @jpeg_type.nil?
  jpeg_type_validator = EnumAttributeValidator.new('String', ["auto", "baseline", "progressive"])
  return false unless jpeg_type_validator.valid?(@jpeg_type)
  return false if @jpeg_quality.nil?
  return false if @jpeg_quality > 100
  return false if @jpeg_quality < 1
  return false if @upscale.nil?
  return false if @allow_video.nil?
  true
end