Class: Fastly::DdosProtectionApi

Inherits:
Object
  • Object
show all
Defined in:
lib/fastly/api/ddos_protection_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ DdosProtectionApi

Returns a new instance of DdosProtectionApi.



17
18
19
 
# File 'lib/fastly/api/ddos_protection_api.rb', line 17

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



15
16
17
 
# File 'lib/fastly/api/ddos_protection_api.rb', line 15

def api_client
  @api_client
end

Instance Method Details

#ddos_protection_event_get(opts = {}) ⇒ DdosProtectionEvent

Get event by ID Get event by ID.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :event_id (String) —

    Unique ID of the event. (required)

Returns:



24
25
26
27
 
# File 'lib/fastly/api/ddos_protection_api.rb', line 24

def ddos_protection_event_get(opts = {})
  data, _status_code, _headers = ddos_protection_event_get_with_http_info(opts)
  data
end

#ddos_protection_event_get_with_http_info(opts = {}) ⇒ Array<(DdosProtectionEvent, Integer, Hash)>

Get event by ID Get event by ID.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :event_id (String) —

    Unique ID of the event. (required)

Returns:

  • (Array<(DdosProtectionEvent, Integer, Hash)>) —

    DdosProtectionEvent data, response status code and response headers



33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/fastly/api/ddos_protection_api.rb', line 33

def ddos_protection_event_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DdosProtectionApi.ddos_protection_event_get ...'
  end
  # unbox the parameters from the hash
  event_id = opts[:'event_id']
  # verify the required parameter 'event_id' is set
  if @api_client.config.client_side_validation && event_id.nil?
    fail ArgumentError, "Missing the required parameter 'event_id' when calling DdosProtectionApi.ddos_protection_event_get"
  end
  # resource path
  local_var_path = '/ddos-protection/v1/events/{event_id}'.sub('{' + 'event_id' + '}', CGI.escape(event_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'DdosProtectionEvent'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"DdosProtectionApi.ddos_protection_event_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DdosProtectionApi#ddos_protection_event_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#ddos_protection_event_list(opts = {}) ⇒ InlineResponse2002

Get events Get events.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :cursor (String) —

    Cursor value from the &#x60;next_cursor&#x60; field of a previous response, used to retrieve the next page. To request the first page, this should be empty.

  • :limit (Integer) —

    Limit how many results are returned. (default to 20)

  • :service_id (String) —

    Filter results based on a service_id.

  • :from (Time) —

    Represents the start of a date-time range expressed in RFC 3339 format.

  • :to (Time) —

    Represents the end of a date-time range expressed in RFC 3339 format.

  • :name (String)

Returns:



92
93
94
95
 
# File 'lib/fastly/api/ddos_protection_api.rb', line 92

def ddos_protection_event_list(opts = {})
  data, _status_code, _headers = ddos_protection_event_list_with_http_info(opts)
  data
end

#ddos_protection_event_list_with_http_info(opts = {}) ⇒ Array<(InlineResponse2002, Integer, Hash)>

Get events Get events.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :cursor (String) —

    Cursor value from the &#x60;next_cursor&#x60; field of a previous response, used to retrieve the next page. To request the first page, this should be empty.

  • :limit (Integer) —

    Limit how many results are returned. (default to 20)

  • :service_id (String) —

    Filter results based on a service_id.

  • :from (Time) —

    Represents the start of a date-time range expressed in RFC 3339 format.

  • :to (Time) —

    Represents the end of a date-time range expressed in RFC 3339 format.

  • :name (String)

Returns:

  • (Array<(InlineResponse2002, Integer, Hash)>) —

    InlineResponse2002 data, response status code and response headers



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/api/ddos_protection_api.rb', line 106

def ddos_protection_event_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DdosProtectionApi.ddos_protection_event_list ...'
  end
  # unbox the parameters from the hash
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling DdosProtectionApi.ddos_protection_event_list, must be smaller than or equal to 100.'
  end

  # resource path
  local_var_path = '/ddos-protection/v1/events'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'service_id'] = opts[:'service_id'] if !opts[:'service_id'].nil?
  query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
  query_params[:'to'] = opts[:'to'] if !opts[:'to'].nil?
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'InlineResponse2002'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"DdosProtectionApi.ddos_protection_event_list",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DdosProtectionApi#ddos_protection_event_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#ddos_protection_event_rule_list(opts = {}) ⇒ InlineResponse2003

Get all rules for an event Get all rules for an event.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :event_id (String) —

    Unique ID of the event. (required)

  • :cursor (String) —

    Cursor value from the &#x60;next_cursor&#x60; field of a previous response, used to retrieve the next page. To request the first page, this should be empty.

  • :limit (Integer) —

    Limit how many results are returned. (default to 20)

Returns:



167
168
169
170
 
# File 'lib/fastly/api/ddos_protection_api.rb', line 167

def ddos_protection_event_rule_list(opts = {})
  data, _status_code, _headers = ddos_protection_event_rule_list_with_http_info(opts)
  data
end

#ddos_protection_event_rule_list_with_http_info(opts = {}) ⇒ Array<(InlineResponse2003, Integer, Hash)>

Get all rules for an event Get all rules for an event.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :event_id (String) —

    Unique ID of the event. (required)

  • :cursor (String) —

    Cursor value from the &#x60;next_cursor&#x60; field of a previous response, used to retrieve the next page. To request the first page, this should be empty.

  • :limit (Integer) —

    Limit how many results are returned. (default to 20)

Returns:

  • (Array<(InlineResponse2003, Integer, Hash)>) —

    InlineResponse2003 data, response status code and response headers



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
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/fastly/api/ddos_protection_api.rb', line 178

def ddos_protection_event_rule_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DdosProtectionApi.ddos_protection_event_rule_list ...'
  end
  # unbox the parameters from the hash
  event_id = opts[:'event_id']
  # verify the required parameter 'event_id' is set
  if @api_client.config.client_side_validation && event_id.nil?
    fail ArgumentError, "Missing the required parameter 'event_id' when calling DdosProtectionApi.ddos_protection_event_rule_list"
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling DdosProtectionApi.ddos_protection_event_rule_list, must be smaller than or equal to 100.'
  end

  # resource path
  local_var_path = '/ddos-protection/v1/events/{event_id}/rules'.sub('{' + 'event_id' + '}', CGI.escape(event_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'InlineResponse2003'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"DdosProtectionApi.ddos_protection_event_rule_list",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DdosProtectionApi#ddos_protection_event_rule_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#ddos_protection_rule_get(opts = {}) ⇒ DdosProtectionRule

Get a rule by ID Get a rule by ID.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :rule_id (String) —

    Unique ID of the rule. (required)

Returns:



238
239
240
241
 
# File 'lib/fastly/api/ddos_protection_api.rb', line 238

def ddos_protection_rule_get(opts = {})
  data, _status_code, _headers = ddos_protection_rule_get_with_http_info(opts)
  data
end

#ddos_protection_rule_get_with_http_info(opts = {}) ⇒ Array<(DdosProtectionRule, Integer, Hash)>

Get a rule by ID Get a rule by ID.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :rule_id (String) —

    Unique ID of the rule. (required)

Returns:

  • (Array<(DdosProtectionRule, Integer, Hash)>) —

    DdosProtectionRule data, response status code and response headers



247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
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
 
# File 'lib/fastly/api/ddos_protection_api.rb', line 247

def ddos_protection_rule_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DdosProtectionApi.ddos_protection_rule_get ...'
  end
  # unbox the parameters from the hash
  rule_id = opts[:'rule_id']
  # verify the required parameter 'rule_id' is set
  if @api_client.config.client_side_validation && rule_id.nil?
    fail ArgumentError, "Missing the required parameter 'rule_id' when calling DdosProtectionApi.ddos_protection_rule_get"
  end
  # resource path
  local_var_path = '/ddos-protection/v1/rules/{rule_id}'.sub('{' + 'rule_id' + '}', CGI.escape(rule_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'DdosProtectionRule'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"DdosProtectionApi.ddos_protection_rule_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DdosProtectionApi#ddos_protection_rule_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#ddos_protection_rule_patch(opts = {}) ⇒ DdosProtectionRule

Update rule Update rule.

Parameters:

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

    a customizable set of options

Options Hash (opts):

Returns:



302
303
304
305
 
# File 'lib/fastly/api/ddos_protection_api.rb', line 302

def ddos_protection_rule_patch(opts = {})
  data, _status_code, _headers = ddos_protection_rule_patch_with_http_info(opts)
  data
end

#ddos_protection_rule_patch_with_http_info(opts = {}) ⇒ Array<(DdosProtectionRule, Integer, Hash)>

Update rule Update rule.

Parameters:

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

    a customizable set of options

Options Hash (opts):

Returns:

  • (Array<(DdosProtectionRule, Integer, Hash)>) —

    DdosProtectionRule data, response status code and response headers



312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
 
# File 'lib/fastly/api/ddos_protection_api.rb', line 312

def ddos_protection_rule_patch_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DdosProtectionApi.ddos_protection_rule_patch ...'
  end
  # unbox the parameters from the hash
  rule_id = opts[:'rule_id']
  # verify the required parameter 'rule_id' is set
  if @api_client.config.client_side_validation && rule_id.nil?
    fail ArgumentError, "Missing the required parameter 'rule_id' when calling DdosProtectionApi.ddos_protection_rule_patch"
  end
  # resource path
  local_var_path = '/ddos-protection/v1/rules/{rule_id}'.sub('{' + 'rule_id' + '}', CGI.escape(rule_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'ddos_protection_rule_patch'])

  # return_type
  return_type = opts[:debug_return_type] || 'DdosProtectionRule'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"DdosProtectionApi.ddos_protection_rule_patch",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DdosProtectionApi#ddos_protection_rule_patch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#ddos_protection_traffic_stats_rule_get(opts = {}) ⇒ DdosProtectionTrafficStats

Get traffic stats for a rule Get traffic stats for a rule.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :event_id (String) —

    Unique ID of the event. (required)

  • :rule_id (String) —

    Unique ID of the rule. (required)

Returns:



372
373
374
375
 
# File 'lib/fastly/api/ddos_protection_api.rb', line 372

def ddos_protection_traffic_stats_rule_get(opts = {})
  data, _status_code, _headers = ddos_protection_traffic_stats_rule_get_with_http_info(opts)
  data
end

#ddos_protection_traffic_stats_rule_get_with_http_info(opts = {}) ⇒ Array<(DdosProtectionTrafficStats, Integer, Hash)>

Get traffic stats for a rule Get traffic stats for a rule.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :event_id (String) —

    Unique ID of the event. (required)

  • :rule_id (String) —

    Unique ID of the rule. (required)

Returns:

  • (Array<(DdosProtectionTrafficStats, Integer, Hash)>) —

    DdosProtectionTrafficStats data, response status code and response headers



382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
 
# File 'lib/fastly/api/ddos_protection_api.rb', line 382

def ddos_protection_traffic_stats_rule_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DdosProtectionApi.ddos_protection_traffic_stats_rule_get ...'
  end
  # unbox the parameters from the hash
  event_id = opts[:'event_id']
  rule_id = opts[:'rule_id']
  # verify the required parameter 'event_id' is set
  if @api_client.config.client_side_validation && event_id.nil?
    fail ArgumentError, "Missing the required parameter 'event_id' when calling DdosProtectionApi.ddos_protection_traffic_stats_rule_get"
  end
  # verify the required parameter 'rule_id' is set
  if @api_client.config.client_side_validation && rule_id.nil?
    fail ArgumentError, "Missing the required parameter 'rule_id' when calling DdosProtectionApi.ddos_protection_traffic_stats_rule_get"
  end
  # resource path
  local_var_path = '/ddos-protection/v1/events/{event_id}/rules/{rule_id}/traffic-stats'.sub('{' + 'event_id' + '}', CGI.escape(event_id.to_s)).sub('{' + 'rule_id' + '}', CGI.escape(rule_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'DdosProtectionTrafficStats'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"DdosProtectionApi.ddos_protection_traffic_stats_rule_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DdosProtectionApi#ddos_protection_traffic_stats_rule_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end