Class: Fastly::LegacyWafRuleApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ LegacyWafRuleApi

Returns a new instance of LegacyWafRuleApi.



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

def api_client
  @api_client
end

Instance Method Details

#get_legacy_waf_firewall_rule_vcl(opts = {}) ⇒ Object

Get VCL for a rule associated with a firewall Get associated VCL for a specific rule associated with a specific firewall.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :firewall_id (String) —

    Alphanumeric string identifying a Firewall. (required)

  • :waf_rule_id (String) —

    Alphanumeric string identifying a WAF rule. (required)

Returns:

  • (Object) 


25
26
27
28
 
# File 'lib/fastly/api/legacy_waf_rule_api.rb', line 25

def get_legacy_waf_firewall_rule_vcl(opts = {})
  data, _status_code, _headers = get_legacy_waf_firewall_rule_vcl_with_http_info(opts)
  data
end

#get_legacy_waf_firewall_rule_vcl_with_http_info(opts = {}) ⇒ Array<(Object, Integer, Hash)>

Get VCL for a rule associated with a firewall Get associated VCL for a specific rule associated with a specific firewall.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :firewall_id (String) —

    Alphanumeric string identifying a Firewall. (required)

  • :waf_rule_id (String) —

    Alphanumeric string identifying a WAF rule. (required)

Returns:

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

    Object data, response status code and response headers



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
82
83
84
85
86
87
88
 
# File 'lib/fastly/api/legacy_waf_rule_api.rb', line 35

def get_legacy_waf_firewall_rule_vcl_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LegacyWafRuleApi.get_legacy_waf_firewall_rule_vcl ...'
  end
  # unbox the parameters from the hash
  firewall_id = opts[:'firewall_id']
  waf_rule_id = opts[:'waf_rule_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 LegacyWafRuleApi.get_legacy_waf_firewall_rule_vcl"
  end
  # verify the required parameter 'waf_rule_id' is set
  if @api_client.config.client_side_validation && waf_rule_id.nil?
    fail ArgumentError, "Missing the required parameter 'waf_rule_id' when calling LegacyWafRuleApi.get_legacy_waf_firewall_rule_vcl"
  end
  # resource path
  local_var_path = '/wafs/{firewall_id}/rules/{waf_rule_id}/vcl'.sub('{' + 'firewall_id' + '}', CGI.escape(firewall_id.to_s)).sub('{' + 'waf_rule_id' + '}', CGI.escape(waf_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/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] || 'Object'

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

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

#get_legacy_waf_rule(opts = {}) ⇒ Object

Get a rule Get a specific rule.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :waf_rule_id (String) —

    Alphanumeric string identifying a WAF rule. (required)

  • :filter_configuration_set_id (String) —

    Optional. Limit rule to a specific configuration set or pass &quot;all&quot; to search all configuration sets, including stale ones.

  • :include (String) —

    Include relationships. Optional. Comma separated values. Permitted values: &#x60;tags&#x60;, &#x60;rule_statuses&#x60;, &#x60;source&#x60;, and &#x60;vcl&#x60;.

Returns:

  • (Object) 


96
97
98
99
 
# File 'lib/fastly/api/legacy_waf_rule_api.rb', line 96

def get_legacy_waf_rule(opts = {})
  data, _status_code, _headers = get_legacy_waf_rule_with_http_info(opts)
  data
end

#get_legacy_waf_rule_vcl(opts = {}) ⇒ Object

Get VCL for a rule Get associated VCL for a specific rule.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :waf_rule_id (String) —

    Alphanumeric string identifying a WAF rule. (required)

Returns:

  • (Object) 


163
164
165
166
 
# File 'lib/fastly/api/legacy_waf_rule_api.rb', line 163

def get_legacy_waf_rule_vcl(opts = {})
  data, _status_code, _headers = get_legacy_waf_rule_vcl_with_http_info(opts)
  data
end

#get_legacy_waf_rule_vcl_with_http_info(opts = {}) ⇒ Array<(Object, Integer, Hash)>

Get VCL for a rule Get associated VCL for a specific rule.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :waf_rule_id (String) —

    Alphanumeric string identifying a WAF rule. (required)

Returns:

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

    Object data, response status code and response headers



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
 
# File 'lib/fastly/api/legacy_waf_rule_api.rb', line 172

def get_legacy_waf_rule_vcl_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LegacyWafRuleApi.get_legacy_waf_rule_vcl ...'
  end
  # unbox the parameters from the hash
  waf_rule_id = opts[:'waf_rule_id']
  # verify the required parameter 'waf_rule_id' is set
  if @api_client.config.client_side_validation && waf_rule_id.nil?
    fail ArgumentError, "Missing the required parameter 'waf_rule_id' when calling LegacyWafRuleApi.get_legacy_waf_rule_vcl"
  end
  # resource path
  local_var_path = '/wafs/rules/{waf_rule_id}/vcl'.sub('{' + 'waf_rule_id' + '}', CGI.escape(waf_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/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] || 'Object'

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

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

#get_legacy_waf_rule_with_http_info(opts = {}) ⇒ Array<(Object, Integer, Hash)>

Get a rule Get a specific rule.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :waf_rule_id (String) —

    Alphanumeric string identifying a WAF rule. (required)

  • :filter_configuration_set_id (String) —

    Optional. Limit rule to a specific configuration set or pass &quot;all&quot; to search all configuration sets, including stale ones.

  • :include (String) —

    Include relationships. Optional. Comma separated values. Permitted values: &#x60;tags&#x60;, &#x60;rule_statuses&#x60;, &#x60;source&#x60;, and &#x60;vcl&#x60;.

Returns:

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

    Object data, response status code and response headers



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
 
# File 'lib/fastly/api/legacy_waf_rule_api.rb', line 107

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

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter[configuration_set_id]'] = opts[:'filter_configuration_set_id'] if !opts[:'filter_configuration_set_id'].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] || 'Object'

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

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

#list_legacy_waf_rules(opts = {}) ⇒ Array<Object>

List rules in the latest configuration set List all rules in the latest configuration set.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :filter_rule_id (String) —

    Limit the returned rules to a specific rule ID.

  • :filter_severity (String) —

    Limit the returned rules to a specific severity.

  • :filter_tags_name (String) —

    Limit the returned rules to a set linked to a tag by name.

  • :filter_configuration_set_id (String) —

    Optional. Limit rules to specific configuration set or pass &quot;all&quot; to search all configuration sets, including stale ones.

  • :page_number (Integer) —

    Current page.

  • :page_size (Integer) —

    Number of records per page. (default to 20)

  • :include (String) —

    Include relationships. Optional. Comma separated values. Permitted values: &#x60;tags&#x60;, &#x60;rule_statuses&#x60;, and &#x60;source&#x60;.

Returns:

  • (Array<Object>) 


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

def list_legacy_waf_rules(opts = {})
  data, _status_code, _headers = list_legacy_waf_rules_with_http_info(opts)
  data
end

#list_legacy_waf_rules_with_http_info(opts = {}) ⇒ Array<(Array<Object>, Integer, Hash)>

List rules in the latest configuration set List all rules in the latest configuration set.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :filter_rule_id (String) —

    Limit the returned rules to a specific rule ID.

  • :filter_severity (String) —

    Limit the returned rules to a specific severity.

  • :filter_tags_name (String) —

    Limit the returned rules to a set linked to a tag by name.

  • :filter_configuration_set_id (String) —

    Optional. Limit rules to specific configuration set or pass &quot;all&quot; to search all configuration sets, including stale ones.

  • :page_number (Integer) —

    Current page.

  • :page_size (Integer) —

    Number of records per page. (default to 20)

  • :include (String) —

    Include relationships. Optional. Comma separated values. Permitted values: &#x60;tags&#x60;, &#x60;rule_statuses&#x60;, and &#x60;source&#x60;.

Returns:

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

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

def list_legacy_waf_rules_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LegacyWafRuleApi.list_legacy_waf_rules ...'
  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 LegacyWafRuleApi.list_legacy_waf_rules, 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 LegacyWafRuleApi.list_legacy_waf_rules, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/wafs/rules'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter[rule_id]'] = opts[:'filter_rule_id'] if !opts[:'filter_rule_id'].nil?
  query_params[:'filter[severity]'] = opts[:'filter_severity'] if !opts[:'filter_severity'].nil?
  query_params[:'filter[tags][name]'] = opts[:'filter_tags_name'] if !opts[:'filter_tags_name'].nil?
  query_params[:'filter[configuration_set_id]'] = opts[:'filter_configuration_set_id'] if !opts[:'filter_configuration_set_id'].nil?
  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[:'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] || 'Array<Object>'

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

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