Class: Fastly::CacheSettingsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CacheSettingsApi

Returns a new instance of CacheSettingsApi.



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

def api_client
  @api_client
end

Instance Method Details

#create_cache_settings(opts = {}) ⇒ CacheSettingResponse

Create a cache settings object Create a cache 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)

  • :action (String) —

    If set, will cause vcl_fetch to terminate after processing this rule with the return state specified. If not set, other configuration logic in vcl_fetch with a lower priority will run after this rule.

  • :cache_condition (String) —

    Name of the cache condition controlling when this configuration applies.

  • :name (String) —

    Name for the cache settings object.

  • :stale_ttl (String) —

    Maximum time in seconds to continue to use a stale version of the object if future requests to your backend server fail (also known as 'stale if error').

  • :ttl (String) —

    Maximum time to consider the object fresh in the cache (the cache 'time to live').

Returns:



30
31
32
33
 
# File 'lib/fastly/api/cache_settings_api.rb', line 30

def create_cache_settings(opts = {})
  data, _status_code, _headers = create_cache_settings_with_http_info(opts)
  data
end

#create_cache_settings_with_http_info(opts = {}) ⇒ Array<(CacheSettingResponse, Integer, Hash)>

Create a cache settings object Create a cache 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)

  • :action (String) —

    If set, will cause vcl_fetch to terminate after processing this rule with the return state specified. If not set, other configuration logic in vcl_fetch with a lower priority will run after this rule.

  • :cache_condition (String) —

    Name of the cache condition controlling when this configuration applies.

  • :name (String) —

    Name for the cache settings object.

  • :stale_ttl (String) —

    Maximum time in seconds to continue to use a stale version of the object if future requests to your backend server fail (also known as &#39;stale if error&#39;).

  • :ttl (String) —

    Maximum time to consider the object fresh in the cache (the cache &#39;time to live&#39;).

Returns:

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

    CacheSettingResponse data, response status code and response headers



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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/fastly/api/cache_settings_api.rb', line 45

def create_cache_settings_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CacheSettingsApi.create_cache_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 CacheSettingsApi.create_cache_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 CacheSettingsApi.create_cache_settings"
  end
  allowable_values = ["pass", "cache", "restart"]
  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
  # resource path
  local_var_path = '/service/{service_id}/version/{version_id}/cache_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] || {}
  form_params['action'] = opts[:'action'] if !opts[:'action'].nil?
  form_params['cache_condition'] = opts[:'cache_condition'] if !opts[:'cache_condition'].nil?
  form_params['name'] = opts[:'name'] if !opts[:'name'].nil?
  form_params['stale_ttl'] = opts[:'stale_ttl'] if !opts[:'stale_ttl'].nil?
  form_params['ttl'] = opts[:'ttl'] if !opts[:'ttl'].nil?

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

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

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

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

#delete_cache_settings(opts = {}) ⇒ InlineResponse200

Delete a cache settings object Delete a specific cache 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)

  • :cache_settings_name (String) —

    Name for the cache settings object. (required)

Returns:



120
121
122
123
 
# File 'lib/fastly/api/cache_settings_api.rb', line 120

def delete_cache_settings(opts = {})
  data, _status_code, _headers = delete_cache_settings_with_http_info(opts)
  data
end

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

Delete a cache settings object Delete a specific cache 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)

  • :cache_settings_name (String) —

    Name for the cache settings object. (required)

Returns:

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

    InlineResponse200 data, response status code and response headers



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
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/fastly/api/cache_settings_api.rb', line 131

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

#get_cache_settings(opts = {}) ⇒ CacheSettingResponse

Get a cache settings object Get a specific cache 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)

  • :cache_settings_name (String) —

    Name for the cache settings object. (required)

Returns:



197
198
199
200
 
# File 'lib/fastly/api/cache_settings_api.rb', line 197

def get_cache_settings(opts = {})
  data, _status_code, _headers = get_cache_settings_with_http_info(opts)
  data
end

#get_cache_settings_with_http_info(opts = {}) ⇒ Array<(CacheSettingResponse, Integer, Hash)>

Get a cache settings object Get a specific cache 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)

  • :cache_settings_name (String) —

    Name for the cache settings object. (required)

Returns:

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

    CacheSettingResponse data, response status code and response headers



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
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/fastly/api/cache_settings_api.rb', line 208

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

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

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

#list_cache_settings(opts = {}) ⇒ Array<CacheSettingResponse>

List cache settings objects Get a list of all cache settings 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:



273
274
275
276
 
# File 'lib/fastly/api/cache_settings_api.rb', line 273

def list_cache_settings(opts = {})
  data, _status_code, _headers = list_cache_settings_with_http_info(opts)
  data
end

#list_cache_settings_with_http_info(opts = {}) ⇒ Array<(Array<CacheSettingResponse>, Integer, Hash)>

List cache settings objects Get a list of all cache settings 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<CacheSettingResponse>, Integer, Hash)>) —

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



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
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/fastly/api/cache_settings_api.rb', line 283

def list_cache_settings_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CacheSettingsApi.list_cache_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 CacheSettingsApi.list_cache_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 CacheSettingsApi.list_cache_settings"
  end
  # resource path
  local_var_path = '/service/{service_id}/version/{version_id}/cache_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<CacheSettingResponse>'

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

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

#update_cache_settings(opts = {}) ⇒ CacheSettingResponse

Update a cache settings object Update a specific cache 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)

  • :cache_settings_name (String) —

    Name for the cache settings object. (required)

  • :action (String) —

    If set, will cause vcl_fetch to terminate after processing this rule with the return state specified. If not set, other configuration logic in vcl_fetch with a lower priority will run after this rule.

  • :cache_condition (String) —

    Name of the cache condition controlling when this configuration applies.

  • :name (String) —

    Name for the cache settings object.

  • :stale_ttl (String) —

    Maximum time in seconds to continue to use a stale version of the object if future requests to your backend server fail (also known as &#39;stale if error&#39;).

  • :ttl (String) —

    Maximum time to consider the object fresh in the cache (the cache &#39;time to live&#39;).

Returns:



349
350
351
352
 
# File 'lib/fastly/api/cache_settings_api.rb', line 349

def update_cache_settings(opts = {})
  data, _status_code, _headers = update_cache_settings_with_http_info(opts)
  data
end

#update_cache_settings_with_http_info(opts = {}) ⇒ Array<(CacheSettingResponse, Integer, Hash)>

Update a cache settings object Update a specific cache 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)

  • :cache_settings_name (String) —

    Name for the cache settings object. (required)

  • :action (String) —

    If set, will cause vcl_fetch to terminate after processing this rule with the return state specified. If not set, other configuration logic in vcl_fetch with a lower priority will run after this rule.

  • :cache_condition (String) —

    Name of the cache condition controlling when this configuration applies.

  • :name (String) —

    Name for the cache settings object.

  • :stale_ttl (String) —

    Maximum time in seconds to continue to use a stale version of the object if future requests to your backend server fail (also known as &#39;stale if error&#39;).

  • :ttl (String) —

    Maximum time to consider the object fresh in the cache (the cache &#39;time to live&#39;).

Returns:

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

    CacheSettingResponse data, response status code and response headers



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

def update_cache_settings_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CacheSettingsApi.update_cache_settings ...'
  end
  # unbox the parameters from the hash
  service_id = opts[:'service_id']
  version_id = opts[:'version_id']
  cache_settings_name = opts[:'cache_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 CacheSettingsApi.update_cache_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 CacheSettingsApi.update_cache_settings"
  end
  # verify the required parameter 'cache_settings_name' is set
  if @api_client.config.client_side_validation && cache_settings_name.nil?
    fail ArgumentError, "Missing the required parameter 'cache_settings_name' when calling CacheSettingsApi.update_cache_settings"
  end
  allowable_values = ["pass", "cache", "restart"]
  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
  # resource path
  local_var_path = '/service/{service_id}/version/{version_id}/cache_settings/{cache_settings_name}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s)).sub('{' + 'cache_settings_name' + '}', CGI.escape(cache_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['cache_condition'] = opts[:'cache_condition'] if !opts[:'cache_condition'].nil?
  form_params['name'] = opts[:'name'] if !opts[:'name'].nil?
  form_params['stale_ttl'] = opts[:'stale_ttl'] if !opts[:'stale_ttl'].nil?
  form_params['ttl'] = opts[:'ttl'] if !opts[:'ttl'].nil?

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

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

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

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