Class: Fastly::WafFirewallsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ WafFirewallsApi 



17
18
19
 
# File 'lib/fastly/api/waf_firewalls_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/waf_firewalls_api.rb', line 15

def api_client
  @api_client
end

Instance Method Details

#create_waf_firewall(opts = {}) ⇒ WafFirewallResponse

Create a firewall Create a firewall object for a particular service and service version using a defined ‘prefetch_condition` and `response`. If the `prefetch_condition` or the `response` is missing from the request body, Fastly will generate a default object on your service.

Options Hash (opts):



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

def create_waf_firewall(opts = {})
  data, _status_code, _headers = create_waf_firewall_with_http_info(opts)
  data
end

#create_waf_firewall_with_http_info(opts = {}) ⇒ Array<(WafFirewallResponse, Integer, Hash)>

Create a firewall Create a firewall object for a particular service and service version using a defined &#x60;prefetch_condition&#x60; and &#x60;response&#x60;. If the &#x60;prefetch_condition&#x60; or the &#x60;response&#x60; is missing from the request body, Fastly will generate a default object on your service.

Options Hash (opts):



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/waf_firewalls_api.rb', line 33

def create_waf_firewall_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WafFirewallsApi.create_waf_firewall ...'
  end
  # unbox the parameters from the hash
  # resource path
  local_var_path = '/waf/firewalls'

  # 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/vnd.api+json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/vnd.api+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[:'waf_firewall'])

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

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

  new_options = opts.merge(
    :operation => :"WafFirewallsApi.create_waf_firewall",
    :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(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WafFirewallsApi#create_waf_firewall\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_waf_firewall(opts = {}) ⇒ nil

Delete a firewall Delete the firewall object for a particular service and service version.

Options Hash (opts):

  • :firewall_id (String) —

    Alphanumeric string identifying a WAF Firewall. (required)

  • :waf_firewall (WafFirewall) 


88
89
90
91
 
# File 'lib/fastly/api/waf_firewalls_api.rb', line 88

def delete_waf_firewall(opts = {})
  delete_waf_firewall_with_http_info(opts)
  nil
end

#delete_waf_firewall_with_http_info(opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete a firewall Delete the firewall object for a particular service and service version.

Options Hash (opts):

  • :firewall_id (String) —

    Alphanumeric string identifying a WAF Firewall. (required)

  • :waf_firewall (WafFirewall) 


98
99
100
101
102
103
104
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
 
# File 'lib/fastly/api/waf_firewalls_api.rb', line 98

def delete_waf_firewall_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WafFirewallsApi.delete_waf_firewall ...'
  end
  # unbox the parameters from the hash
  firewall_id = opts[:'firewall_id']
  # verify the required parameter 'firewall_id' is set
  if @api_client.config.client_side_validation && firewall_id.nil?
    fail ArgumentError, "Missing the required parameter 'firewall_id' when calling WafFirewallsApi.delete_waf_firewall"
  end
  # resource path
  local_var_path = '/waf/firewalls/{firewall_id}'.sub('{' + 'firewall_id' + '}', CGI.escape(firewall_id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}
  # 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[:'waf_firewall'])

  # return_type
  return_type = opts[:debug_return_type]

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

  new_options = opts.merge(
    :operation => :"WafFirewallsApi.delete_waf_firewall",
    :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(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WafFirewallsApi#delete_waf_firewall\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_waf_firewall(opts = {}) ⇒ WafFirewallResponse

Get a firewall Get a specific firewall object.

Options Hash (opts):

  • :firewall_id (String) —

    Alphanumeric string identifying a WAF Firewall. (required)

  • :filter_service_version_number (String) —

    Limit the results returned to a specific service version.

  • :include (String) —

    Include related objects. Optional. (default to ‘waf_firewall_versions’)



157
158
159
160
 
# File 'lib/fastly/api/waf_firewalls_api.rb', line 157

def get_waf_firewall(opts = {})
  data, _status_code, _headers = get_waf_firewall_with_http_info(opts)
  data
end

#get_waf_firewall_with_http_info(opts = {}) ⇒ Array<(WafFirewallResponse, Integer, Hash)>

Get a firewall Get a specific firewall object.

Options Hash (opts):

  • :firewall_id (String) —

    Alphanumeric string identifying a WAF Firewall. (required)

  • :filter_service_version_number (String) —

    Limit the results returned to a specific service version.

  • :include (String) —

    Include related objects. Optional. (default to ‘waf_firewall_versions’)



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
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/fastly/api/waf_firewalls_api.rb', line 168

def get_waf_firewall_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WafFirewallsApi.get_waf_firewall ...'
  end
  # unbox the parameters from the hash
  firewall_id = opts[:'firewall_id']
  # verify the required parameter 'firewall_id' is set
  if @api_client.config.client_side_validation && firewall_id.nil?
    fail ArgumentError, "Missing the required parameter 'firewall_id' when calling WafFirewallsApi.get_waf_firewall"
  end
  allowable_values = ["waf_firewall_versions"]
  if @api_client.config.client_side_validation && opts[:'include'] && !allowable_values.include?(opts[:'include'])
    fail ArgumentError, "invalid value for \"include\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/waf/firewalls/{firewall_id}'.sub('{' + 'firewall_id' + '}', CGI.escape(firewall_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter[service_version_number]'] = opts[:'filter_service_version_number'] if !opts[:'filter_service_version_number'].nil?
  query_params[:'include'] = opts[:'include'] if !opts[:'include'].nil?

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

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

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

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

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

  new_options = opts.merge(
    :operation => :"WafFirewallsApi.get_waf_firewall",
    :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: WafFirewallsApi#get_waf_firewall\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_waf_firewalls(opts = {}) ⇒ WafFirewallsResponse

List firewalls List all firewall objects.

Options Hash (opts):

  • :page_number (Integer) —

    Current page.

  • :page_size (Integer) —

    Number of records per page. (default to 20)

  • :filter_service_id (String) —

    Limit the results returned to a specific service.

  • :filter_service_version_number (String) —

    Limit the results returned to a specific service version.

  • :include (String) —

    Include related objects. Optional. (default to ‘waf_firewall_versions’)



232
233
234
235
 
# File 'lib/fastly/api/waf_firewalls_api.rb', line 232

def list_waf_firewalls(opts = {})
  data, _status_code, _headers = list_waf_firewalls_with_http_info(opts)
  data
end

#list_waf_firewalls_with_http_info(opts = {}) ⇒ Array<(WafFirewallsResponse, Integer, Hash)>

List firewalls List all firewall objects.

Options Hash (opts):

  • :page_number (Integer) —

    Current page.

  • :page_size (Integer) —

    Number of records per page. (default to 20)

  • :filter_service_id (String) —

    Limit the results returned to a specific service.

  • :filter_service_version_number (String) —

    Limit the results returned to a specific service version.

  • :include (String) —

    Include related objects. Optional. (default to ‘waf_firewall_versions’)



245
246
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
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/fastly/api/waf_firewalls_api.rb', line 245

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

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling WafFirewallsApi.list_waf_firewalls, must be greater than or equal to 1.'
  end

  allowable_values = ["waf_firewall_versions"]
  if @api_client.config.client_side_validation && opts[:'include'] && !allowable_values.include?(opts[:'include'])
    fail ArgumentError, "invalid value for \"include\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/waf/firewalls'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page[number]'] = opts[:'page_number'] if !opts[:'page_number'].nil?
  query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'filter[service_id]'] = opts[:'filter_service_id'] if !opts[:'filter_service_id'].nil?
  query_params[:'filter[service_version_number]'] = opts[:'filter_service_version_number'] if !opts[:'filter_service_version_number'].nil?
  query_params[:'include'] = opts[:'include'] if !opts[:'include'].nil?

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

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

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

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

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

  new_options = opts.merge(
    :operation => :"WafFirewallsApi.list_waf_firewalls",
    :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: WafFirewallsApi#list_waf_firewalls\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_waf_firewall(opts = {}) ⇒ WafFirewallResponse

Update a firewall Update a firewall object for a particular service and service version. Specifying a ‘service_version_number` is required.

Options Hash (opts):

  • :firewall_id (String) —

    Alphanumeric string identifying a WAF Firewall. (required)

  • :waf_firewall (WafFirewall) 


312
313
314
315
 
# File 'lib/fastly/api/waf_firewalls_api.rb', line 312

def update_waf_firewall(opts = {})
  data, _status_code, _headers = update_waf_firewall_with_http_info(opts)
  data
end

#update_waf_firewall_with_http_info(opts = {}) ⇒ Array<(WafFirewallResponse, Integer, Hash)>

Update a firewall Update a firewall object for a particular service and service version. Specifying a &#x60;service_version_number&#x60; is required.

Options Hash (opts):

  • :firewall_id (String) —

    Alphanumeric string identifying a WAF Firewall. (required)

  • :waf_firewall (WafFirewall) 


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
366
367
368
369
370
371
372
373
374
375
 
# File 'lib/fastly/api/waf_firewalls_api.rb', line 322

def update_waf_firewall_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WafFirewallsApi.update_waf_firewall ...'
  end
  # unbox the parameters from the hash
  firewall_id = opts[:'firewall_id']
  # verify the required parameter 'firewall_id' is set
  if @api_client.config.client_side_validation && firewall_id.nil?
    fail ArgumentError, "Missing the required parameter 'firewall_id' when calling WafFirewallsApi.update_waf_firewall"
  end
  # resource path
  local_var_path = '/waf/firewalls/{firewall_id}'.sub('{' + 'firewall_id' + '}', CGI.escape(firewall_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/vnd.api+json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/vnd.api+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[:'waf_firewall'])

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

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

  new_options = opts.merge(
    :operation => :"WafFirewallsApi.update_waf_firewall",
    :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: WafFirewallsApi#update_waf_firewall\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end