Class: Fastly::WafTagsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ WafTagsApi

Returns a new instance of WafTagsApi.



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

def api_client
  @api_client
end

Instance Method Details

#list_waf_tags(opts = {}) ⇒ WafTagsResponse

List tags List all tags.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :filter_name (String) —

    Limit the returned tags to a specific name.

  • :page_number (Integer) —

    Current page.

  • :page_size (Integer) —

    Number of records per page. (default to 20)

  • :include (String) —

    Include relationships. Optional. (default to ‘waf_rules’)

Returns:



27
28
29
30
 
# File 'lib/fastly/api/waf_tags_api.rb', line 27

def list_waf_tags(opts = {})
  data, _status_code, _headers = list_waf_tags_with_http_info(opts)
  data
end

#list_waf_tags_with_http_info(opts = {}) ⇒ Array<(WafTagsResponse, Integer, Hash)>

List tags List all tags.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :filter_name (String) —

    Limit the returned tags to a specific name.

  • :page_number (Integer) —

    Current page.

  • :page_size (Integer) —

    Number of records per page. (default to 20)

  • :include (String) —

    Include relationships. Optional. (default to ‘waf_rules’)

Returns:

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

    WafTagsResponse data, response status code and response headers



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
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/fastly/api/waf_tags_api.rb', line 39

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

  allowable_values = ["waf_rules"]
  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/tags'

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

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

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