Class: Fastly::ConfigStoreApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ConfigStoreApi

Returns a new instance of ConfigStoreApi.



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

def api_client
  @api_client
end

Instance Method Details

#create_config_store(opts = {}) ⇒ ConfigStoreResponse

Create a config store Create a config store.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :name (String) —

    The name of the config store.

Returns:



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

def create_config_store(opts = {})
  data, _status_code, _headers = create_config_store_with_http_info(opts)
  data
end

#create_config_store_with_http_info(opts = {}) ⇒ Array<(ConfigStoreResponse, Integer, Hash)>

Create a config store Create a config store.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :name (String) —

    The name of the config store.

Returns:

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

    ConfigStoreResponse 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
82
 
# File 'lib/fastly/api/config_store_api.rb', line 33

def create_config_store_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConfigStoreApi.create_config_store ...'
  end
  # unbox the parameters from the hash
  # resource path
  local_var_path = '/resources/stores/config'

  # 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['name'] = opts[:'name'] if !opts[:'name'].nil?

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

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

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

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

#delete_config_store(opts = {}) ⇒ InlineResponse200

Delete a config store Delete a config store.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :config_store_id (String) —

    An alphanumeric string identifying the config store. (required)

Returns:



88
89
90
91
 
# File 'lib/fastly/api/config_store_api.rb', line 88

def delete_config_store(opts = {})
  data, _status_code, _headers = delete_config_store_with_http_info(opts)
  data
end

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

Delete a config store Delete a config store.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :config_store_id (String) —

    An alphanumeric string identifying the config store. (required)

Returns:

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

    InlineResponse200 data, response status code and response headers



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

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

#get_config_store(opts = {}) ⇒ ConfigStoreResponse

Describe a config store Describe a config store by its identifier.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :config_store_id (String) —

    An alphanumeric string identifying the config store. (required)

Returns:



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

def get_config_store(opts = {})
  data, _status_code, _headers = get_config_store_with_http_info(opts)
  data
end

#get_config_store_info(opts = {}) ⇒ ConfigStoreInfoResponse

Get config store metadata Retrieve metadata for a single config store.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :config_store_id (String) —

    An alphanumeric string identifying the config store. (required)

Returns:



214
215
216
217
 
# File 'lib/fastly/api/config_store_api.rb', line 214

def get_config_store_info(opts = {})
  data, _status_code, _headers = get_config_store_info_with_http_info(opts)
  data
end

#get_config_store_info_with_http_info(opts = {}) ⇒ Array<(ConfigStoreInfoResponse, Integer, Hash)>

Get config store metadata Retrieve metadata for a single config store.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :config_store_id (String) —

    An alphanumeric string identifying the config store. (required)

Returns:

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

    ConfigStoreInfoResponse data, response status code and response headers



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
267
268
269
270
271
 
# File 'lib/fastly/api/config_store_api.rb', line 223

def get_config_store_info_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConfigStoreApi.get_config_store_info ...'
  end
  # unbox the parameters from the hash
  config_store_id = opts[:'config_store_id']
  # verify the required parameter 'config_store_id' is set
  if @api_client.config.client_side_validation && config_store_id.nil?
    fail ArgumentError, "Missing the required parameter 'config_store_id' when calling ConfigStoreApi.get_config_store_info"
  end
  # resource path
  local_var_path = '/resources/stores/config/{config_store_id}/info'.sub('{' + 'config_store_id' + '}', CGI.escape(config_store_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] || 'ConfigStoreInfoResponse'

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

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

#get_config_store_with_http_info(opts = {}) ⇒ Array<(ConfigStoreResponse, Integer, Hash)>

Describe a config store Describe a config store by its identifier.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :config_store_id (String) —

    An alphanumeric string identifying the config store. (required)

Returns:

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

    ConfigStoreResponse data, response status code and response headers



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
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/fastly/api/config_store_api.rb', line 160

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

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

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

#list_config_store_services(opts = {}) ⇒ Object

List linked services List services linked to a config store

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :config_store_id (String) —

    An alphanumeric string identifying the config store. (required)

Returns:

  • (Object) 


277
278
279
280
 
# File 'lib/fastly/api/config_store_api.rb', line 277

def list_config_store_services(opts = {})
  data, _status_code, _headers = list_config_store_services_with_http_info(opts)
  data
end

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

List linked services List services linked to a config store

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :config_store_id (String) —

    An alphanumeric string identifying the config store. (required)

Returns:

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

    Object data, response status code and response headers



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

def list_config_store_services_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConfigStoreApi.list_config_store_services ...'
  end
  # unbox the parameters from the hash
  config_store_id = opts[:'config_store_id']
  # verify the required parameter 'config_store_id' is set
  if @api_client.config.client_side_validation && config_store_id.nil?
    fail ArgumentError, "Missing the required parameter 'config_store_id' when calling ConfigStoreApi.list_config_store_services"
  end
  # resource path
  local_var_path = '/resources/stores/config/{config_store_id}/services'.sub('{' + 'config_store_id' + '}', CGI.escape(config_store_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] || 'Object'

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

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

#list_config_stores(opts = {}) ⇒ Array<ConfigStoreResponse>

List config stores List config stores.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :name (String) —

    Returns a one-element array containing the details for the named config store.

Returns:



340
341
342
343
 
# File 'lib/fastly/api/config_store_api.rb', line 340

def list_config_stores(opts = {})
  data, _status_code, _headers = list_config_stores_with_http_info(opts)
  data
end

#list_config_stores_with_http_info(opts = {}) ⇒ Array<(Array<ConfigStoreResponse>, Integer, Hash)>

List config stores List config stores.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :name (String) —

    Returns a one-element array containing the details for the named config store.

Returns:

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

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



349
350
351
352
353
354
355
356
357
358
359
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
 
# File 'lib/fastly/api/config_store_api.rb', line 349

def list_config_stores_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConfigStoreApi.list_config_stores ...'
  end
  # unbox the parameters from the hash
  # resource path
  local_var_path = '/resources/stores/config'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?

  # 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<ConfigStoreResponse>'

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

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

#update_config_store(opts = {}) ⇒ ConfigStoreResponse

Update a config store Update a config store.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :config_store_id (String) —

    An alphanumeric string identifying the config store. (required)

  • :name (String) —

    The name of the config store.

Returns:



400
401
402
403
 
# File 'lib/fastly/api/config_store_api.rb', line 400

def update_config_store(opts = {})
  data, _status_code, _headers = update_config_store_with_http_info(opts)
  data
end

#update_config_store_with_http_info(opts = {}) ⇒ Array<(ConfigStoreResponse, Integer, Hash)>

Update a config store Update a config store.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :config_store_id (String) —

    An alphanumeric string identifying the config store. (required)

  • :name (String) —

    The name of the config store.

Returns:

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

    ConfigStoreResponse data, response status code and response headers



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
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
 
# File 'lib/fastly/api/config_store_api.rb', line 410

def update_config_store_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConfigStoreApi.update_config_store ...'
  end
  # unbox the parameters from the hash
  config_store_id = opts[:'config_store_id']
  # verify the required parameter 'config_store_id' is set
  if @api_client.config.client_side_validation && config_store_id.nil?
    fail ArgumentError, "Missing the required parameter 'config_store_id' when calling ConfigStoreApi.update_config_store"
  end
  # resource path
  local_var_path = '/resources/stores/config/{config_store_id}'.sub('{' + 'config_store_id' + '}', CGI.escape(config_store_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['name'] = opts[:'name'] if !opts[:'name'].nil?

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

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

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

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