Class: Fastly::DdosProtectionRule

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DdosProtectionRule

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/fastly/models/ddos_protection_rule.rb', line 121

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

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

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

  if attributes.key?(:'action')
    self.action = attributes[:'action']
  else
    self.action = 'default'
  end

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

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

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

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

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

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

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

  if attributes.key?(:'additional_attributes')
    if (value = attributes[:'additional_attributes']).is_a?(Array)
      self.additional_attributes = value
    end
  end
end

Instance Attribute Details

#action ⇒ Object

Action types for a rule. Supported action values are default, block, log, off. The default action value follows the current protection mode of the associated service.



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

def action
  @action
end

#additional_attributes ⇒ Object

Attribute category for additional, unlisted attributes used in a rule.



53
54
55
 
# File 'lib/fastly/models/ddos_protection_rule.rb', line 53

def additional_attributes
  @additional_attributes
end

#asn ⇒ Object

ASN attribute.



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

def asn
  @asn
end

#country_code ⇒ Object

Country code attribute.



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

def country_code
  @country_code
end

#created_at ⇒ Object

Date and time in ISO 8601 format.



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

def created_at
  @created_at
end

#customer_id ⇒ Object

Alphanumeric string identifying the customer.



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

def customer_id
  @customer_id
end

#host ⇒ Object

Host attribute.



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

def host
  @host
end

#id ⇒ Object

Unique ID of the rule.



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

def id
  @id
end

#name ⇒ Object

A human-readable name for the rule.



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

def name
  @name
end

#service_id ⇒ Object

Alphanumeric string identifying the service.



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

def service_id
  @service_id
end

#source_ip ⇒ Object

Source IP address attribute.



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

def source_ip
  @source_ip
end

#source_ip_prefix ⇒ Object

Source IP prefix attribute.



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

def source_ip_prefix
  @source_ip_prefix
end

#updated_at ⇒ Object

Date and time in ISO 8601 format.



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

def updated_at
  @updated_at
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



75
76
77
 
# File 'lib/fastly/models/ddos_protection_rule.rb', line 75

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/fastly/models/ddos_protection_rule.rb', line 56

def self.attribute_map
  {
    :'created_at' => :'created_at',
    :'updated_at' => :'updated_at',
    :'id' => :'id',
    :'name' => :'name',
    :'action' => :'action',
    :'customer_id' => :'customer_id',
    :'service_id' => :'service_id',
    :'source_ip' => :'source_ip',
    :'country_code' => :'country_code',
    :'host' => :'host',
    :'asn' => :'asn',
    :'source_ip_prefix' => :'source_ip_prefix',
    :'additional_attributes' => :'additional_attributes'
  }
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



239
240
241
 
# File 'lib/fastly/models/ddos_protection_rule.rb', line 239

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

.fastly_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



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

def self.fastly_all_of
  [
  :'DdosProtectionRuleAllOf',
  :'TimestampsNoDelete'
  ]
end

.fastly_nullable ⇒ Object

List of attributes with nullable: true



99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/fastly/models/ddos_protection_rule.rb', line 99

def self.fastly_nullable
  Set.new([
    :'created_at',
    :'updated_at',
    :'source_ip',
    :'country_code',
    :'host',
    :'asn',
    :'source_ip_prefix',
  ])
end

.fastly_types ⇒ Object

Attribute type mapping.



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/fastly/models/ddos_protection_rule.rb', line 80

def self.fastly_types
  {
    :'created_at' => :'Time',
    :'updated_at' => :'Time',
    :'id' => :'String',
    :'name' => :'String',
    :'action' => :'String',
    :'customer_id' => :'String',
    :'service_id' => :'String',
    :'source_ip' => :'String',
    :'country_code' => :'String',
    :'host' => :'String',
    :'asn' => :'String',
    :'source_ip_prefix' => :'String',
    :'additional_attributes' => :'Array<String>'
  }
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
220
221
222
 
# File 'lib/fastly/models/ddos_protection_rule.rb', line 206

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      created_at == o.created_at &&
      updated_at == o.updated_at &&
      id == o.id &&
      name == o.name &&
      action == o.action &&
      customer_id == o.customer_id &&
      service_id == o.service_id &&
      source_ip == o.source_ip &&
      country_code == o.country_code &&
      host == o.host &&
      asn == o.asn &&
      source_ip_prefix == o.source_ip_prefix &&
      additional_attributes == o.additional_attributes
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



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

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



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

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



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

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


226
227
228
 
# File 'lib/fastly/models/ddos_protection_rule.rb', line 226

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



232
233
234
 
# File 'lib/fastly/models/ddos_protection_rule.rb', line 232

def hash
  [created_at, updated_at, id, name, action, customer_id, service_id, source_ip, country_code, host, asn, source_ip_prefix, additional_attributes].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



193
194
195
196
 
# File 'lib/fastly/models/ddos_protection_rule.rb', line 193

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



316
317
318
 
# File 'lib/fastly/models/ddos_protection_rule.rb', line 316

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



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

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



310
311
312
 
# File 'lib/fastly/models/ddos_protection_rule.rb', line 310

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



200
201
202
 
# File 'lib/fastly/models/ddos_protection_rule.rb', line 200

def valid?
  true
end