Class: Fastly::RequestSettingsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ RequestSettingsApi

Returns a new instance of RequestSettingsApi.



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

def api_client
  @api_client
end

Instance Method Details

#create_request_settings(opts = {}) ⇒ RequestSettingsResponse

Create a Request Settings object Creates a new Request Settings object.

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:



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

def create_request_settings(opts = {})
  data, _status_code, _headers = create_request_settings_with_http_info(opts)
  data
end

#create_request_settings_with_http_info(opts = {}) ⇒ Array<(RequestSettingsResponse, Integer, Hash)>

Create a Request Settings object Creates a new Request Settings object.

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<(RequestSettingsResponse, Integer, Hash)>) —

    RequestSettingsResponse 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
89
90
91
92
93
 
# File 'lib/fastly/api/request_settings_api.rb', line 35

def create_request_settings_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RequestSettingsApi.create_request_settings ...'
  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 RequestSettingsApi.create_request_settings"
  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 RequestSettingsApi.create_request_settings"
  end
  # resource path
  local_var_path = '/service/{service_id}/version/{version_id}/request_settings'.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'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
  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]

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

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

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

#delete_request_settings(opts = {}) ⇒ InlineResponse200

Delete a Request Settings object Removes the specified Request Settings object.

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)

  • :request_settings_name (String) —

    Name for the request settings. (required)

Returns:



101
102
103
104
 
# File 'lib/fastly/api/request_settings_api.rb', line 101

def delete_request_settings(opts = {})
  data, _status_code, _headers = delete_request_settings_with_http_info(opts)
  data
end

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

Delete a Request Settings object Removes the specified Request Settings object.

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)

  • :request_settings_name (String) —

    Name for the request settings. (required)

Returns:

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

    InlineResponse200 data, response status code and response headers



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
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/fastly/api/request_settings_api.rb', line 112

def delete_request_settings_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RequestSettingsApi.delete_request_settings ...'
  end
  # unbox the parameters from the hash
  service_id = opts[:'service_id']
  version_id = opts[:'version_id']
  request_settings_name = opts[:'request_settings_name']
  # 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 RequestSettingsApi.delete_request_settings"
  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 RequestSettingsApi.delete_request_settings"
  end
  # verify the required parameter 'request_settings_name' is set
  if @api_client.config.client_side_validation && request_settings_name.nil?
    fail ArgumentError, "Missing the required parameter 'request_settings_name' when calling RequestSettingsApi.delete_request_settings"
  end
  # resource path
  local_var_path = '/service/{service_id}/version/{version_id}/request_settings/{request_settings_name}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s)).sub('{' + 'request_settings_name' + '}', CGI.escape(request_settings_name.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 => :"RequestSettingsApi.delete_request_settings",
    :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: RequestSettingsApi#delete_request_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_request_settings(opts = {}) ⇒ RequestSettingsResponse

Get a Request Settings object Gets the specified Request Settings object.

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)

  • :request_settings_name (String) —

    Name for the request settings. (required)

Returns:



178
179
180
181
 
# File 'lib/fastly/api/request_settings_api.rb', line 178

def get_request_settings(opts = {})
  data, _status_code, _headers = get_request_settings_with_http_info(opts)
  data
end

#get_request_settings_with_http_info(opts = {}) ⇒ Array<(RequestSettingsResponse, Integer, Hash)>

Get a Request Settings object Gets the specified Request Settings object.

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)

  • :request_settings_name (String) —

    Name for the request settings. (required)

Returns:

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

    RequestSettingsResponse data, response status code and response headers



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
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/fastly/api/request_settings_api.rb', line 189

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

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

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

#list_request_settings(opts = {}) ⇒ Array<RequestSettingsResponse>

List Request Settings objects Returns a list of all Request Settings objects for the given 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:



254
255
256
257
 
# File 'lib/fastly/api/request_settings_api.rb', line 254

def list_request_settings(opts = {})
  data, _status_code, _headers = list_request_settings_with_http_info(opts)
  data
end

#list_request_settings_with_http_info(opts = {}) ⇒ Array<(Array<RequestSettingsResponse>, Integer, Hash)>

List Request Settings objects Returns a list of all Request Settings objects for the given 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<RequestSettingsResponse>, Integer, Hash)>) —

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



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
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/fastly/api/request_settings_api.rb', line 264

def list_request_settings_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RequestSettingsApi.list_request_settings ...'
  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 RequestSettingsApi.list_request_settings"
  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 RequestSettingsApi.list_request_settings"
  end
  # resource path
  local_var_path = '/service/{service_id}/version/{version_id}/request_settings'.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<RequestSettingsResponse>'

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

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

#update_request_settings(opts = {}) ⇒ RequestSettingsResponse

Update a Request Settings object Updates the specified Request Settings object.

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)

  • :request_settings_name (String) —

    Name for the request settings. (required)

  • :action (String) —

    Allows you to terminate request handling and immediately perform an action.

  • :default_host (String) —

    Sets the host header.

  • :hash_keys (String) —

    Comma separated list of varnish request object fields that should be in the hash key.

  • :name (String) —

    Name for the request settings.

  • :request_condition (String) —

    Condition which, if met, will select this configuration during a request. Optional.

  • :xff (String) —

    Short for X-Forwarded-For.

  • :bypass_busy_wait (Integer) —

    Disable collapsed forwarding, so you don&#39;t wait for other objects to origin.

  • :force_miss (Integer) —

    Allows you to force a cache miss for the request. Replaces the item in the cache if the content is cacheable.

  • :force_ssl (Integer) —

    Forces the request use SSL (redirects a non-SSL to SSL).

  • :geo_headers (Integer) —

    Injects Fastly-Geo-Country, Fastly-Geo-City, and Fastly-Geo-Region into the request headers.

  • :max_stale_age (Integer) —

    How old an object is allowed to be to serve stale-if-error or stale-while-revalidate.

  • :timer_support (Integer) —

    Injects the X-Timer info into the request for viewing origin fetch durations.

Returns:



337
338
339
340
 
# File 'lib/fastly/api/request_settings_api.rb', line 337

def update_request_settings(opts = {})
  data, _status_code, _headers = update_request_settings_with_http_info(opts)
  data
end

#update_request_settings_with_http_info(opts = {}) ⇒ Array<(RequestSettingsResponse, Integer, Hash)>

Update a Request Settings object Updates the specified Request Settings object.

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)

  • :request_settings_name (String) —

    Name for the request settings. (required)

  • :action (String) —

    Allows you to terminate request handling and immediately perform an action.

  • :default_host (String) —

    Sets the host header.

  • :hash_keys (String) —

    Comma separated list of varnish request object fields that should be in the hash key.

  • :name (String) —

    Name for the request settings.

  • :request_condition (String) —

    Condition which, if met, will select this configuration during a request. Optional.

  • :xff (String) —

    Short for X-Forwarded-For.

  • :bypass_busy_wait (Integer) —

    Disable collapsed forwarding, so you don&#39;t wait for other objects to origin.

  • :force_miss (Integer) —

    Allows you to force a cache miss for the request. Replaces the item in the cache if the content is cacheable.

  • :force_ssl (Integer) —

    Forces the request use SSL (redirects a non-SSL to SSL).

  • :geo_headers (Integer) —

    Injects Fastly-Geo-Country, Fastly-Geo-City, and Fastly-Geo-Region into the request headers.

  • :max_stale_age (Integer) —

    How old an object is allowed to be to serve stale-if-error or stale-while-revalidate.

  • :timer_support (Integer) —

    Injects the X-Timer info into the request for viewing origin fetch durations.

Returns:

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

    RequestSettingsResponse data, response status code and response headers



360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
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
436
437
438
439
440
441
442
443
 
# File 'lib/fastly/api/request_settings_api.rb', line 360

def update_request_settings_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RequestSettingsApi.update_request_settings ...'
  end
  # unbox the parameters from the hash
  service_id = opts[:'service_id']
  version_id = opts[:'version_id']
  request_settings_name = opts[:'request_settings_name']
  # 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 RequestSettingsApi.update_request_settings"
  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 RequestSettingsApi.update_request_settings"
  end
  # verify the required parameter 'request_settings_name' is set
  if @api_client.config.client_side_validation && request_settings_name.nil?
    fail ArgumentError, "Missing the required parameter 'request_settings_name' when calling RequestSettingsApi.update_request_settings"
  end
  allowable_values = ["lookup", "pass"]
  if @api_client.config.client_side_validation && opts[:'action'] && !allowable_values.include?(opts[:'action'])
    fail ArgumentError, "invalid value for \"action\", must be one of #{allowable_values}"
  end
  allowable_values = ["clear", "leave", "append", "append_all", "overwrite"]
  if @api_client.config.client_side_validation && opts[:'xff'] && !allowable_values.include?(opts[:'xff'])
    fail ArgumentError, "invalid value for \"xff\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/service/{service_id}/version/{version_id}/request_settings/{request_settings_name}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s)).sub('{' + 'request_settings_name' + '}', CGI.escape(request_settings_name.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'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['action'] = opts[:'action'] if !opts[:'action'].nil?
  form_params['default_host'] = opts[:'default_host'] if !opts[:'default_host'].nil?
  form_params['hash_keys'] = opts[:'hash_keys'] if !opts[:'hash_keys'].nil?
  form_params['name'] = opts[:'name'] if !opts[:'name'].nil?
  form_params['request_condition'] = opts[:'request_condition'] if !opts[:'request_condition'].nil?
  form_params['xff'] = opts[:'xff'] if !opts[:'xff'].nil?
  form_params['bypass_busy_wait'] = opts[:'bypass_busy_wait'] if !opts[:'bypass_busy_wait'].nil?
  form_params['force_miss'] = opts[:'force_miss'] if !opts[:'force_miss'].nil?
  form_params['force_ssl'] = opts[:'force_ssl'] if !opts[:'force_ssl'].nil?
  form_params['geo_headers'] = opts[:'geo_headers'] if !opts[:'geo_headers'].nil?
  form_params['max_stale_age'] = opts[:'max_stale_age'] if !opts[:'max_stale_age'].nil?
  form_params['timer_support'] = opts[:'timer_support'] if !opts[:'timer_support'].nil?

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

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

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

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