Class: Fastly::RateLimiterApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ RateLimiterApi

Returns a new instance of RateLimiterApi.



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

def api_client
  @api_client
end

Instance Method Details

#delete_rate_limiter(opts = {}) ⇒ InlineResponse200

Delete a rate limiter Delete a rate limiter by its ID.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :rate_limiter_id (String) —

    Alphanumeric string identifying the rate limiter. (required)

Returns:



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

def delete_rate_limiter(opts = {})
  data, _status_code, _headers = delete_rate_limiter_with_http_info(opts)
  data
end

#delete_rate_limiter_with_http_info(opts = {}) ⇒ Array<(InlineResponse200, Integer, Hash)>

Delete a rate limiter Delete a rate limiter by its ID.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :rate_limiter_id (String) —

    Alphanumeric string identifying the rate limiter. (required)

Returns:

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

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

def delete_rate_limiter_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RateLimiterApi.delete_rate_limiter ...'
  end
  # unbox the parameters from the hash
  rate_limiter_id = opts[:'rate_limiter_id']
  # verify the required parameter 'rate_limiter_id' is set
  if @api_client.config.client_side_validation && rate_limiter_id.nil?
    fail ArgumentError, "Missing the required parameter 'rate_limiter_id' when calling RateLimiterApi.delete_rate_limiter"
  end
  # resource path
  local_var_path = '/rate-limiters/{rate_limiter_id}'.sub('{' + 'rate_limiter_id' + '}', CGI.escape(rate_limiter_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'])

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

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

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

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

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

#get_rate_limiter(opts = {}) ⇒ RateLimiterResponse

Get a rate limiter Get a rate limiter by its ID.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :rate_limiter_id (String) —

    Alphanumeric string identifying the rate limiter. (required)

Returns:



87
88
89
90
 
# File 'lib/fastly/api/rate_limiter_api.rb', line 87

def get_rate_limiter(opts = {})
  data, _status_code, _headers = get_rate_limiter_with_http_info(opts)
  data
end

#get_rate_limiter_with_http_info(opts = {}) ⇒ Array<(RateLimiterResponse, Integer, Hash)>

Get a rate limiter Get a rate limiter by its ID.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :rate_limiter_id (String) —

    Alphanumeric string identifying the rate limiter. (required)

Returns:

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

    RateLimiterResponse data, response status code and response headers



96
97
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
 
# File 'lib/fastly/api/rate_limiter_api.rb', line 96

def get_rate_limiter_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RateLimiterApi.get_rate_limiter ...'
  end
  # unbox the parameters from the hash
  rate_limiter_id = opts[:'rate_limiter_id']
  # verify the required parameter 'rate_limiter_id' is set
  if @api_client.config.client_side_validation && rate_limiter_id.nil?
    fail ArgumentError, "Missing the required parameter 'rate_limiter_id' when calling RateLimiterApi.get_rate_limiter"
  end
  # resource path
  local_var_path = '/rate-limiters/{rate_limiter_id}'.sub('{' + 'rate_limiter_id' + '}', CGI.escape(rate_limiter_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'])

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

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

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

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

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

#list_rate_limiters(opts = {}) ⇒ Array<RateLimiterResponse>

List rate limiters List all rate limiters for a particular service and version.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

Returns:



151
152
153
154
 
# File 'lib/fastly/api/rate_limiter_api.rb', line 151

def list_rate_limiters(opts = {})
  data, _status_code, _headers = list_rate_limiters_with_http_info(opts)
  data
end

#list_rate_limiters_with_http_info(opts = {}) ⇒ Array<(Array<RateLimiterResponse>, Integer, Hash)>

List rate limiters List all rate limiters for a particular service and version.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

Returns:

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

    Array<RateLimiterResponse> data, response status code and response headers



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

def list_rate_limiters_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RateLimiterApi.list_rate_limiters ...'
  end
  # unbox the parameters from the hash
  service_id = opts[:'service_id']
  version_id = opts[:'version_id']
  # verify the required parameter 'service_id' is set
  if @api_client.config.client_side_validation && service_id.nil?
    fail ArgumentError, "Missing the required parameter 'service_id' when calling RateLimiterApi.list_rate_limiters"
  end
  # verify the required parameter 'version_id' is set
  if @api_client.config.client_side_validation && version_id.nil?
    fail ArgumentError, "Missing the required parameter 'version_id' when calling RateLimiterApi.list_rate_limiters"
  end
  # resource path
  local_var_path = '/service/{service_id}/version/{version_id}/rate-limiters'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_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'])

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Array<RateLimiterResponse>'

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

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