Class: Fastly::KvStoreApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ KvStoreApi

Returns a new instance of KvStoreApi.



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

def api_client
  @api_client
end

Instance Method Details

#kv_store_create(opts = {}) ⇒ KvStoreDetails

Create a KV store. Create a KV store.

Parameters:

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

    a customizable set of options

Options Hash (opts):

Returns:



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

def kv_store_create(opts = {})
  data, _status_code, _headers = kv_store_create_with_http_info(opts)
  data
end

#kv_store_create_with_http_info(opts = {}) ⇒ Array<(KvStoreDetails, Integer, Hash)>

Create a KV store. Create a KV store.

Parameters:

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

    a customizable set of options

Options Hash (opts):

Returns:

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

    KvStoreDetails 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
 
# File 'lib/fastly/api/kv_store_api.rb', line 35

def kv_store_create_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KvStoreApi.kv_store_create ...'
  end
  # unbox the parameters from the hash
  allowable_values = ["US", "EU", "ASIA", "AUS"]
  if @api_client.config.client_side_validation && opts[:'location'] && !allowable_values.include?(opts[:'location'])
    fail ArgumentError, "invalid value for \"location\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/resources/stores/kv'

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

  # 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/json'])
  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] || @api_client.object_to_http_body(opts[:'kv_store_request_create'])

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

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

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

#kv_store_delete(opts = {}) ⇒ nil

Delete a KV store. A KV store must be empty before it can be deleted. Attempting to delete a KV store that contains items will result in a response with a 409 status code.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :store_id (String) — default: required

Returns:

  • (nil) 


94
95
96
97
 
# File 'lib/fastly/api/kv_store_api.rb', line 94

def kv_store_delete(opts = {})
  kv_store_delete_with_http_info(opts)
  nil
end

#kv_store_delete_with_http_info(opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete a KV store. A KV store must be empty before it can be deleted. Attempting to delete a KV store that contains items will result in a response with a &#x60;409&#x60; status code.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :store_id (String) — default: required

Returns:

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

    nil, response status code and response headers



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
146
147
148
149
 
# File 'lib/fastly/api/kv_store_api.rb', line 103

def kv_store_delete_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KvStoreApi.kv_store_delete ...'
  end
  # unbox the parameters from the hash
  store_id = opts[:'store_id']
  # verify the required parameter 'store_id' is set
  if @api_client.config.client_side_validation && store_id.nil?
    fail ArgumentError, "Missing the required parameter 'store_id' when calling KvStoreApi.kv_store_delete"
  end
  # resource path
  local_var_path = '/resources/stores/kv/{store_id}'.sub('{' + 'store_id' + '}', CGI.escape(store_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

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

#kv_store_get(opts = {}) ⇒ KvStoreDetails

Describe a KV store. Get details of a KV store.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :store_id (String) — default: required

Returns:



155
156
157
158
 
# File 'lib/fastly/api/kv_store_api.rb', line 155

def kv_store_get(opts = {})
  data, _status_code, _headers = kv_store_get_with_http_info(opts)
  data
end

#kv_store_get_with_http_info(opts = {}) ⇒ Array<(KvStoreDetails, Integer, Hash)>

Describe a KV store. Get details of a KV store.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :store_id (String) — default: required

Returns:

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

    KvStoreDetails data, response status code and response headers



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

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

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

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

#kv_store_list(opts = {}) ⇒ InlineResponse2005

List all KV stores. List all KV stores.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :cursor (String)
  • :limit (Integer) — default: default to 1000

Returns:



219
220
221
222
 
# File 'lib/fastly/api/kv_store_api.rb', line 219

def kv_store_list(opts = {})
  data, _status_code, _headers = kv_store_list_with_http_info(opts)
  data
end

#kv_store_list_with_http_info(opts = {}) ⇒ Array<(InlineResponse2005, Integer, Hash)>

List all KV stores. List all KV stores.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :cursor (String)
  • :limit (Integer) — default: default to 1000

Returns:

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

    InlineResponse2005 data, response status code and response headers



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
272
273
274
275
276
277
278
 
# File 'lib/fastly/api/kv_store_api.rb', line 229

def kv_store_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KvStoreApi.kv_store_list ...'
  end
  # unbox the parameters from the hash
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling KvStoreApi.kv_store_list, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/resources/stores/kv'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].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] || 'InlineResponse2005'

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

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