Class: Fastly::ObjectStoreItemApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ObjectStoreItemApi

Returns a new instance of ObjectStoreItemApi.



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

def api_client
  @api_client
end

Instance Method Details

#delete_key_from_store(opts = {}) ⇒ nil

Delete object store item. Delete an item from an object store

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :store_id (String) — default: required
  • :key_name (String) — default: required

Returns:

  • (nil) 


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

def delete_key_from_store(opts = {})
  delete_key_from_store_with_http_info(opts)
  nil
end

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

Delete object store item. Delete an item from an object store

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :store_id (String) — default: required
  • :key_name (String) — default: required

Returns:

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

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

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

#get_keys(opts = {}) ⇒ InlineResponse2004

List object store keys. List the keys of all items within an object store.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :store_id (String) — default: required
  • :cursor (String)
  • :limit (Integer) — default: default to 100

Returns:



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

def get_keys(opts = {})
  data, _status_code, _headers = get_keys_with_http_info(opts)
  data
end

#get_keys_with_http_info(opts = {}) ⇒ Array<(InlineResponse2004, Integer, Hash)>

List object store keys. List the keys of all items within an object store.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :store_id (String) — default: required
  • :cursor (String)
  • :limit (Integer) — default: default to 100

Returns:

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

    InlineResponse2004 data, response status code and response headers



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
150
151
152
153
154
155
 
# File 'lib/fastly/api/object_store_item_api.rb', line 105

def get_keys_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ObjectStoreItemApi.get_keys ...'
  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 ObjectStoreItemApi.get_keys"
  end
  # resource path
  local_var_path = '/resources/stores/object/{store_id}/keys'.sub('{' + 'store_id' + '}', CGI.escape(store_id.to_s))

  # 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] || 'InlineResponse2004'

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

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

#get_value_for_key(opts = {}) ⇒ File

Get the value of an object store item Get the value associated with a key.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :store_id (String) — default: required
  • :key_name (String) — default: required

Returns:

  • (File) 


162
163
164
165
 
# File 'lib/fastly/api/object_store_item_api.rb', line 162

def get_value_for_key(opts = {})
  data, _status_code, _headers = get_value_for_key_with_http_info(opts)
  data
end

#get_value_for_key_with_http_info(opts = {}) ⇒ Array<(File, Integer, Hash)>

Get the value of an object store item Get the value associated with a key.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :store_id (String) — default: required
  • :key_name (String) — default: required

Returns:

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

    File data, response status code and response headers



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
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/fastly/api/object_store_item_api.rb', line 172

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

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

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

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

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

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

#set_value_for_key(opts = {}) ⇒ File

Insert an item into an object store Set a new value for a new or existing key in an object store.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :store_id (String) — default: required
  • :key_name (String) — default: required
  • :body (File)

Returns:

  • (File) 


233
234
235
236
 
# File 'lib/fastly/api/object_store_item_api.rb', line 233

def set_value_for_key(opts = {})
  data, _status_code, _headers = set_value_for_key_with_http_info(opts)
  data
end

#set_value_for_key_with_http_info(opts = {}) ⇒ Array<(File, Integer, Hash)>

Insert an item into an object store Set a new value for a new or existing key in an object store.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :store_id (String) — default: required
  • :key_name (String) — default: required
  • :body (File)

Returns:

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

    File data, response status code and response headers



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
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/fastly/api/object_store_item_api.rb', line 244

def set_value_for_key_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ObjectStoreItemApi.set_value_for_key ...'
  end
  # unbox the parameters from the hash
  store_id = opts[:'store_id']
  key_name = opts[:'key_name']
  # 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 ObjectStoreItemApi.set_value_for_key"
  end
  # verify the required parameter 'key_name' is set
  if @api_client.config.client_side_validation && key_name.nil?
    fail ArgumentError, "Missing the required parameter 'key_name' when calling ObjectStoreItemApi.set_value_for_key"
  end
  # resource path
  local_var_path = '/resources/stores/object/{store_id}/keys/{key_name}'.sub('{' + 'store_id' + '}', CGI.escape(store_id.to_s)).sub('{' + 'key_name' + '}', CGI.escape(key_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/octet-stream'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/octet-stream'])
  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[:'body'])

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

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

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