Class: Fastly::WafExclusionResponseDataAttributes

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ WafExclusionResponseDataAttributes

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
160
161
162
163
164
165
166
167
168
169
170
# File 'lib/fastly/models/waf_exclusion_response_data_attributes.rb', line 120

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

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

  if attributes.key?(:'logging')
    self.logging = attributes[:'logging']
  else
    self.logging = true
  end

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

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

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

Instance Attribute Details

#conditionObject

A conditional expression in VCL used to determine if the condition is met.



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

def condition
  @condition
end

#created_atObject

Date and time in ISO 8601 format.



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

def created_at
  @created_at
end

#deleted_atObject

Date and time in ISO 8601 format.



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

def deleted_at
  @deleted_at
end

#exclusion_typeObject

The type of exclusion.



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

def exclusion_type
  @exclusion_type
end

#loggingObject

Whether to generate a log upon matching.



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

def logging
  @logging
end

#nameObject

Name of the exclusion.



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

def name
  @name
end

#numberObject

A numeric ID identifying a WAF exclusion.



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

def number
  @number
end

#updated_atObject

Date and time in ISO 8601 format.



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

def updated_at
  @updated_at
end

#variableObject

The variable to exclude. An optional selector can be specified after the variable separated by a colon (‘:`) to restrict the variable to a particular parameter. Required for `exclusion_type=variable`.



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

def variable
  @variable
end

Class Method Details

.acceptable_attributesObject

Returns all the JSON keys this model knows about



81
82
83
# File 'lib/fastly/models/waf_exclusion_response_data_attributes.rb', line 81

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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



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

def self.attribute_map
  {
    :'created_at' => :'created_at',
    :'deleted_at' => :'deleted_at',
    :'updated_at' => :'updated_at',
    :'condition' => :'condition',
    :'exclusion_type' => :'exclusion_type',
    :'logging' => :'logging',
    :'name' => :'name',
    :'number' => :'number',
    :'variable' => :'variable'
  }
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



240
241
242
# File 'lib/fastly/models/waf_exclusion_response_data_attributes.rb', line 240

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

.fastly_all_ofObject

List of class defined in allOf (OpenAPI v3)



111
112
113
114
115
116
# File 'lib/fastly/models/waf_exclusion_response_data_attributes.rb', line 111

def self.fastly_all_of
  [
  :'Timestamps',
  :'WafExclusionResponseDataAttributesAllOf'
  ]
end

.fastly_nullableObject

List of attributes with nullable: true



101
102
103
104
105
106
107
108
# File 'lib/fastly/models/waf_exclusion_response_data_attributes.rb', line 101

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

.fastly_typesObject

Attribute type mapping.



86
87
88
89
90
91
92
93
94
95
96
97
98
# File 'lib/fastly/models/waf_exclusion_response_data_attributes.rb', line 86

def self.fastly_types
  {
    :'created_at' => :'Time',
    :'deleted_at' => :'Time',
    :'updated_at' => :'Time',
    :'condition' => :'String',
    :'exclusion_type' => :'String',
    :'logging' => :'Boolean',
    :'name' => :'String',
    :'number' => :'Integer',
    :'variable' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



211
212
213
214
215
216
217
218
219
220
221
222
223
# File 'lib/fastly/models/waf_exclusion_response_data_attributes.rb', line 211

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 &&
      condition == o.condition &&
      exclusion_type == o.exclusion_type &&
      logging == o.logging &&
      name == o.name &&
      number == o.number &&
      variable == o.variable
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



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
304
305
306
307
# File 'lib/fastly/models/waf_exclusion_response_data_attributes.rb', line 270

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



341
342
343
344
345
346
347
348
349
350
351
352
353
# File 'lib/fastly/models/waf_exclusion_response_data_attributes.rb', line 341

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



247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
# File 'lib/fastly/models/waf_exclusion_response_data_attributes.rb', line 247

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


227
228
229
# File 'lib/fastly/models/waf_exclusion_response_data_attributes.rb', line 227

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



233
234
235
# File 'lib/fastly/models/waf_exclusion_response_data_attributes.rb', line 233

def hash
  [created_at, deleted_at, updated_at, condition, exclusion_type, logging, name, number, variable].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



174
175
176
177
# File 'lib/fastly/models/waf_exclusion_response_data_attributes.rb', line 174

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



317
318
319
# File 'lib/fastly/models/waf_exclusion_response_data_attributes.rb', line 317

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



323
324
325
326
327
328
329
330
331
332
333
334
335
# File 'lib/fastly/models/waf_exclusion_response_data_attributes.rb', line 323

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



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

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



181
182
183
184
185
186
187
# File 'lib/fastly/models/waf_exclusion_response_data_attributes.rb', line 181

def valid?
  exclusion_type_validator = EnumAttributeValidator.new('String', ["rule", "variable", "waf"])
  return false unless exclusion_type_validator.valid?(@exclusion_type)
  variable_validator = EnumAttributeValidator.new('String', ["req.cookies", "req.headers", "req.post", "req.post_filename", "req.qs", "null"])
  return false unless variable_validator.valid?(@variable)
  true
end