Class: Falcon::CustomStorage

Inherits:
Object
  • Object
show all
Defined in:
lib/crimson-falcon/api/custom_storage.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CustomStorage

Returns a new instance of CustomStorage.



36
37
38
 
# File 'lib/crimson-falcon/api/custom_storage.rb', line 36

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



34
35
36
 
# File 'lib/crimson-falcon/api/custom_storage.rb', line 34

def api_client
  @api_client
end

Instance Method Details

#delete_object(collection_name, object_key, opts = {}) ⇒ CustomStorageResponse

Delete the specified object

Parameters:

  • collection_name (String) —

    The name of the collection

  • object_key (String) —

    The object key

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

    the optional parameters

Options Hash (opts):

  • :dry_run (Boolean) —

    If false, run the operation as normal. If true, validate that the request would succeed, but don't execute it.

Returns:



45
46
47
48
 
# File 'lib/crimson-falcon/api/custom_storage.rb', line 45

def delete_object(collection_name, object_key, opts = {})
  data, _status_code, _headers = delete_object_with_http_info(collection_name, object_key, opts)
  data
end

#delete_object_with_http_info(collection_name, object_key, opts = {}) ⇒ Array<(CustomStorageResponse, Integer, Hash)>

Delete the specified object

Parameters:

  • collection_name (String) —

    The name of the collection

  • object_key (String) —

    The object key

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

    the optional parameters

Options Hash (opts):

  • :dry_run (Boolean) —

    If false, run the operation as normal. If true, validate that the request would succeed, but don&#39;t execute it.

Returns:

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

    CustomStorageResponse data, response status code and response headers



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
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/crimson-falcon/api/custom_storage.rb', line 56

def delete_object_with_http_info(collection_name, object_key, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomStorage.delete_object ...'
  end
  # verify the required parameter 'collection_name' is set
  if @api_client.config.client_side_validation && collection_name.nil?
    fail ArgumentError, "Missing the required parameter 'collection_name' when calling CustomStorage.delete_object"
  end
  if @api_client.config.client_side_validation && collection_name.to_s.length > 255
    fail ArgumentError, 'invalid value for "collection_name" when calling CustomStorage.delete_object, the character length must be smaller than or equal to 255.'
  end

  if @api_client.config.client_side_validation && collection_name.to_s.length < 1
    fail ArgumentError, 'invalid value for "collection_name" when calling CustomStorage.delete_object, the character length must be great than or equal to 1.'
  end

  # verify the required parameter 'object_key' is set
  if @api_client.config.client_side_validation && object_key.nil?
    fail ArgumentError, "Missing the required parameter 'object_key' when calling CustomStorage.delete_object"
  end
  if @api_client.config.client_side_validation && object_key.to_s.length > 1000
    fail ArgumentError, 'invalid value for "object_key" when calling CustomStorage.delete_object, the character length must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && object_key.to_s.length < 1
    fail ArgumentError, 'invalid value for "object_key" when calling CustomStorage.delete_object, the character length must be great than or equal to 1.'
  end

  # resource path
  local_var_path = '/customobjects/v1/collections/{collection_name}/objects/{object_key}'.sub('{' + 'collection_name' + '}', CGI.escape(collection_name.to_s)).sub('{' + 'object_key' + '}', CGI.escape(object_key.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'dry_run'] = opts[:'dry_run'] if !opts[:'dry_run'].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] || 'CustomStorageResponse'

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

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

#delete_versioned_object(collection_name, collection_version, object_key, opts = {}) ⇒ CustomType3191042536

Delete the specified versioned object

Parameters:

  • collection_name (String) —

    The name of the collection

  • collection_version (String) —

    The version of the collection

  • object_key (String) —

    The object key

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

    the optional parameters

Options Hash (opts):

  • :dry_run (Boolean) —

    If false, run the operation as normal. If true, validate that the request would succeed, but don&#39;t execute it.

Returns:

  • (CustomType3191042536) 


132
133
134
135
 
# File 'lib/crimson-falcon/api/custom_storage.rb', line 132

def delete_versioned_object(collection_name, collection_version, object_key, opts = {})
  data, _status_code, _headers = delete_versioned_object_with_http_info(collection_name, collection_version, object_key, opts)
  data
end

#delete_versioned_object_with_http_info(collection_name, collection_version, object_key, opts = {}) ⇒ Array<(CustomType3191042536, Integer, Hash)>

Delete the specified versioned object

Parameters:

  • collection_name (String) —

    The name of the collection

  • collection_version (String) —

    The version of the collection

  • object_key (String) —

    The object key

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

    the optional parameters

Options Hash (opts):

  • :dry_run (Boolean) —

    If false, run the operation as normal. If true, validate that the request would succeed, but don&#39;t execute it.

Returns:

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

    CustomType3191042536 data, response status code and response headers



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
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
 
# File 'lib/crimson-falcon/api/custom_storage.rb', line 144

def delete_versioned_object_with_http_info(collection_name, collection_version, object_key, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomStorage.delete_versioned_object ...'
  end
  # verify the required parameter 'collection_name' is set
  if @api_client.config.client_side_validation && collection_name.nil?
    fail ArgumentError, "Missing the required parameter 'collection_name' when calling CustomStorage.delete_versioned_object"
  end
  if @api_client.config.client_side_validation && collection_name.to_s.length > 255
    fail ArgumentError, 'invalid value for "collection_name" when calling CustomStorage.delete_versioned_object, the character length must be smaller than or equal to 255.'
  end

  if @api_client.config.client_side_validation && collection_name.to_s.length < 1
    fail ArgumentError, 'invalid value for "collection_name" when calling CustomStorage.delete_versioned_object, the character length must be great than or equal to 1.'
  end

  # verify the required parameter 'collection_version' is set
  if @api_client.config.client_side_validation && collection_version.nil?
    fail ArgumentError, "Missing the required parameter 'collection_version' when calling CustomStorage.delete_versioned_object"
  end
  if @api_client.config.client_side_validation && collection_version.to_s.length > 20
    fail ArgumentError, 'invalid value for "collection_version" when calling CustomStorage.delete_versioned_object, the character length must be smaller than or equal to 20.'
  end

  if @api_client.config.client_side_validation && collection_version.to_s.length < 1
    fail ArgumentError, 'invalid value for "collection_version" when calling CustomStorage.delete_versioned_object, the character length must be great than or equal to 1.'
  end

  # verify the required parameter 'object_key' is set
  if @api_client.config.client_side_validation && object_key.nil?
    fail ArgumentError, "Missing the required parameter 'object_key' when calling CustomStorage.delete_versioned_object"
  end
  if @api_client.config.client_side_validation && object_key.to_s.length > 1000
    fail ArgumentError, 'invalid value for "object_key" when calling CustomStorage.delete_versioned_object, the character length must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && object_key.to_s.length < 1
    fail ArgumentError, 'invalid value for "object_key" when calling CustomStorage.delete_versioned_object, the character length must be great than or equal to 1.'
  end

  # resource path
  local_var_path = '/customobjects/v1/collections/{collection_name}/{collection_version}/objects/{object_key}'.sub('{' + 'collection_name' + '}', CGI.escape(collection_name.to_s)).sub('{' + 'collection_version' + '}', CGI.escape(collection_version.to_s)).sub('{' + 'object_key' + '}', CGI.escape(object_key.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'dry_run'] = opts[:'dry_run'] if !opts[:'dry_run'].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] || 'CustomType3191042536'

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

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

#describe_collection(collection_name, opts = {}) ⇒ CustomType1942251022

Fetch metadata about an existing collection

Parameters:

  • collection_name (String) —

    The name of the collection

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

    the optional parameters

Returns:



229
230
231
232
 
# File 'lib/crimson-falcon/api/custom_storage.rb', line 229

def describe_collection(collection_name, opts = {})
  data, _status_code, _headers = describe_collection_with_http_info(collection_name, opts)
  data
end

#describe_collection_with_http_info(collection_name, opts = {}) ⇒ Array<(CustomType1942251022, Integer, Hash)>

Fetch metadata about an existing collection

Parameters:

  • collection_name (String) —

    The name of the collection

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

    the optional parameters

Returns:

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

    CustomType1942251022 data, response status code and response headers



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
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/crimson-falcon/api/custom_storage.rb', line 238

def describe_collection_with_http_info(collection_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomStorage.describe_collection ...'
  end
  # verify the required parameter 'collection_name' is set
  if @api_client.config.client_side_validation && collection_name.nil?
    fail ArgumentError, "Missing the required parameter 'collection_name' when calling CustomStorage.describe_collection"
  end
  if @api_client.config.client_side_validation && collection_name.to_s.length > 255
    fail ArgumentError, 'invalid value for "collection_name" when calling CustomStorage.describe_collection, the character length must be smaller than or equal to 255.'
  end

  if @api_client.config.client_side_validation && collection_name.to_s.length < 1
    fail ArgumentError, 'invalid value for "collection_name" when calling CustomStorage.describe_collection, the character length must be great than or equal to 1.'
  end

  # resource path
  local_var_path = '/customobjects/v1/collections/{collection_name}'.sub('{' + 'collection_name' + '}', CGI.escape(collection_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] || 'CustomType1942251022'

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

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

#describe_collections(names, opts = {}) ⇒ CustomType1942251022

Fetch metadata about one or more existing collections

Parameters:

  • names (Array<String>) —

    A set of collection names

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

    the optional parameters

Returns:



298
299
300
301
 
# File 'lib/crimson-falcon/api/custom_storage.rb', line 298

def describe_collections(names, opts = {})
  data, _status_code, _headers = describe_collections_with_http_info(names, opts)
  data
end

#describe_collections_with_http_info(names, opts = {}) ⇒ Array<(CustomType1942251022, Integer, Hash)>

Fetch metadata about one or more existing collections

Parameters:

  • names (Array<String>) —

    A set of collection names

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

    the optional parameters

Returns:

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

    CustomType1942251022 data, response status code and response headers



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
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/crimson-falcon/api/custom_storage.rb', line 307

def describe_collections_with_http_info(names, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomStorage.describe_collections ...'
  end
  # verify the required parameter 'names' is set
  if @api_client.config.client_side_validation && names.nil?
    fail ArgumentError, "Missing the required parameter 'names' when calling CustomStorage.describe_collections"
  end
  # resource path
  local_var_path = '/customobjects/v1/collections'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'names'] = @api_client.build_collection_param(names, :csv)

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

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

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

#get_object(collection_name, object_key, opts = {}) ⇒ File

Get the bytes for the specified object

Parameters:

  • collection_name (String) —

    The name of the collection

  • object_key (String) —

    The object key

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

    the optional parameters

Returns:

  • (File) 


361
362
363
364
 
# File 'lib/crimson-falcon/api/custom_storage.rb', line 361

def get_object(collection_name, object_key, opts = {})
  data, _status_code, _headers = get_object_with_http_info(collection_name, object_key, opts)
  data
end

#get_object_metadata(collection_name, object_key, opts = {}) ⇒ CustomStorageResponse

Get the metadata for the specified object

Parameters:

  • collection_name (String) —

    The name of the collection

  • object_key (String) —

    The object key

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

    the optional parameters

Returns:



444
445
446
447
 
# File 'lib/crimson-falcon/api/custom_storage.rb', line 444

def get_object_metadata(collection_name, object_key, opts = {})
  data, _status_code, _headers = get_object_metadata_with_http_info(collection_name, object_key, opts)
  data
end

#get_object_metadata_with_http_info(collection_name, object_key, opts = {}) ⇒ Array<(CustomStorageResponse, Integer, Hash)>

Get the metadata for the specified object

Parameters:

  • collection_name (String) —

    The name of the collection

  • object_key (String) —

    The object key

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

    the optional parameters

Returns:

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

    CustomStorageResponse data, response status code and response headers



454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
 
# File 'lib/crimson-falcon/api/custom_storage.rb', line 454

def get_object_metadata_with_http_info(collection_name, object_key, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomStorage.get_object_metadata ...'
  end
  # verify the required parameter 'collection_name' is set
  if @api_client.config.client_side_validation && collection_name.nil?
    fail ArgumentError, "Missing the required parameter 'collection_name' when calling CustomStorage.get_object_metadata"
  end
  if @api_client.config.client_side_validation && collection_name.to_s.length > 255
    fail ArgumentError, 'invalid value for "collection_name" when calling CustomStorage.get_object_metadata, the character length must be smaller than or equal to 255.'
  end

  if @api_client.config.client_side_validation && collection_name.to_s.length < 1
    fail ArgumentError, 'invalid value for "collection_name" when calling CustomStorage.get_object_metadata, the character length must be great than or equal to 1.'
  end

  # verify the required parameter 'object_key' is set
  if @api_client.config.client_side_validation && object_key.nil?
    fail ArgumentError, "Missing the required parameter 'object_key' when calling CustomStorage.get_object_metadata"
  end
  if @api_client.config.client_side_validation && object_key.to_s.length > 1000
    fail ArgumentError, 'invalid value for "object_key" when calling CustomStorage.get_object_metadata, the character length must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && object_key.to_s.length < 1
    fail ArgumentError, 'invalid value for "object_key" when calling CustomStorage.get_object_metadata, the character length must be great than or equal to 1.'
  end

  # resource path
  local_var_path = '/customobjects/v1/collections/{collection_name}/objects/{object_key}/metadata'.sub('{' + 'collection_name' + '}', CGI.escape(collection_name.to_s)).sub('{' + 'object_key' + '}', CGI.escape(object_key.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] || 'CustomStorageResponse'

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

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

#get_object_with_http_info(collection_name, object_key, opts = {}) ⇒ Array<(File, Integer, Hash)>

Get the bytes for the specified object

Parameters:

  • collection_name (String) —

    The name of the collection

  • object_key (String) —

    The object key

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

    the optional parameters

Returns:

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

    File data, response status code and response headers



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/crimson-falcon/api/custom_storage.rb', line 371

def get_object_with_http_info(collection_name, object_key, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomStorage.get_object ...'
  end
  # verify the required parameter 'collection_name' is set
  if @api_client.config.client_side_validation && collection_name.nil?
    fail ArgumentError, "Missing the required parameter 'collection_name' when calling CustomStorage.get_object"
  end
  if @api_client.config.client_side_validation && collection_name.to_s.length > 255
    fail ArgumentError, 'invalid value for "collection_name" when calling CustomStorage.get_object, the character length must be smaller than or equal to 255.'
  end

  if @api_client.config.client_side_validation && collection_name.to_s.length < 1
    fail ArgumentError, 'invalid value for "collection_name" when calling CustomStorage.get_object, the character length must be great than or equal to 1.'
  end

  # verify the required parameter 'object_key' is set
  if @api_client.config.client_side_validation && object_key.nil?
    fail ArgumentError, "Missing the required parameter 'object_key' when calling CustomStorage.get_object"
  end
  if @api_client.config.client_side_validation && object_key.to_s.length > 1000
    fail ArgumentError, 'invalid value for "object_key" when calling CustomStorage.get_object, the character length must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && object_key.to_s.length < 1
    fail ArgumentError, 'invalid value for "object_key" when calling CustomStorage.get_object, the character length must be great than or equal to 1.'
  end

  # resource path
  local_var_path = '/customobjects/v1/collections/{collection_name}/objects/{object_key}'.sub('{' + 'collection_name' + '}', CGI.escape(collection_name.to_s)).sub('{' + 'object_key' + '}', CGI.escape(object_key.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', '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] || 'File'

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

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

#get_schema(collection_name, schema_version, opts = {}) ⇒ File

Get the bytes of the specified schema of the requested collection

Parameters:

  • collection_name (String) —

    The name of the collection

  • schema_version (String) —

    The version of the collection schema or &#39;latest&#39; for the latest version

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

    the optional parameters

Returns:

  • (File) 


527
528
529
530
 
# File 'lib/crimson-falcon/api/custom_storage.rb', line 527

def get_schema(collection_name, schema_version, opts = {})
  data, _status_code, _headers = get_schema_with_http_info(collection_name, schema_version, opts)
  data
end

#get_schema_metadata(collection_name, schema_version, opts = {}) ⇒ CustomType4161059146

Get the metadata for the specified schema of the requested collection

Parameters:

  • collection_name (String) —

    The name of the collection

  • schema_version (String) —

    The version of the collection schema or &#39;latest&#39; for the latest version

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

    the optional parameters

Returns:



606
607
608
609
 
# File 'lib/crimson-falcon/api/custom_storage.rb', line 606

def get_schema_metadata(collection_name, schema_version, opts = {})
  data, _status_code, _headers = get_schema_metadata_with_http_info(collection_name, schema_version, opts)
  data
end

#get_schema_metadata_with_http_info(collection_name, schema_version, opts = {}) ⇒ Array<(CustomType4161059146, Integer, Hash)>

Get the metadata for the specified schema of the requested collection

Parameters:

  • collection_name (String) —

    The name of the collection

  • schema_version (String) —

    The version of the collection schema or &#39;latest&#39; for the latest version

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

    the optional parameters

Returns:

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

    CustomType4161059146 data, response status code and response headers



616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
 
# File 'lib/crimson-falcon/api/custom_storage.rb', line 616

def get_schema_metadata_with_http_info(collection_name, schema_version, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomStorage.get_schema_metadata ...'
  end
  # verify the required parameter 'collection_name' is set
  if @api_client.config.client_side_validation && collection_name.nil?
    fail ArgumentError, "Missing the required parameter 'collection_name' when calling CustomStorage.get_schema_metadata"
  end
  if @api_client.config.client_side_validation && collection_name.to_s.length > 255
    fail ArgumentError, 'invalid value for "collection_name" when calling CustomStorage.get_schema_metadata, the character length must be smaller than or equal to 255.'
  end

  if @api_client.config.client_side_validation && collection_name.to_s.length < 1
    fail ArgumentError, 'invalid value for "collection_name" when calling CustomStorage.get_schema_metadata, the character length must be great than or equal to 1.'
  end

  # verify the required parameter 'schema_version' is set
  if @api_client.config.client_side_validation && schema_version.nil?
    fail ArgumentError, "Missing the required parameter 'schema_version' when calling CustomStorage.get_schema_metadata"
  end
  if @api_client.config.client_side_validation && schema_version.to_s.length < 1
    fail ArgumentError, 'invalid value for "schema_version" when calling CustomStorage.get_schema_metadata, the character length must be great than or equal to 1.'
  end

  # resource path
  local_var_path = '/customobjects/v1/collections/{collection_name}/schemas/{schema_version}/metadata'.sub('{' + 'collection_name' + '}', CGI.escape(collection_name.to_s)).sub('{' + 'schema_version' + '}', CGI.escape(schema_version.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] || 'CustomType4161059146'

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

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

#get_schema_with_http_info(collection_name, schema_version, opts = {}) ⇒ Array<(File, Integer, Hash)>

Get the bytes of the specified schema of the requested collection

Parameters:

  • collection_name (String) —

    The name of the collection

  • schema_version (String) —

    The version of the collection schema or &#39;latest&#39; for the latest version

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

    the optional parameters

Returns:

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

    File data, response status code and response headers



537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
 
# File 'lib/crimson-falcon/api/custom_storage.rb', line 537

def get_schema_with_http_info(collection_name, schema_version, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomStorage.get_schema ...'
  end
  # verify the required parameter 'collection_name' is set
  if @api_client.config.client_side_validation && collection_name.nil?
    fail ArgumentError, "Missing the required parameter 'collection_name' when calling CustomStorage.get_schema"
  end
  if @api_client.config.client_side_validation && collection_name.to_s.length > 255
    fail ArgumentError, 'invalid value for "collection_name" when calling CustomStorage.get_schema, the character length must be smaller than or equal to 255.'
  end

  if @api_client.config.client_side_validation && collection_name.to_s.length < 1
    fail ArgumentError, 'invalid value for "collection_name" when calling CustomStorage.get_schema, the character length must be great than or equal to 1.'
  end

  # verify the required parameter 'schema_version' is set
  if @api_client.config.client_side_validation && schema_version.nil?
    fail ArgumentError, "Missing the required parameter 'schema_version' when calling CustomStorage.get_schema"
  end
  if @api_client.config.client_side_validation && schema_version.to_s.length < 1
    fail ArgumentError, 'invalid value for "schema_version" when calling CustomStorage.get_schema, the character length must be great than or equal to 1.'
  end

  # resource path
  local_var_path = '/customobjects/v1/collections/{collection_name}/schemas/{schema_version}'.sub('{' + 'collection_name' + '}', CGI.escape(collection_name.to_s)).sub('{' + 'schema_version' + '}', CGI.escape(schema_version.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', 'application/schema+json', '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] || 'File'

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

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

#get_versioned_object(collection_name, collection_version, object_key, opts = {}) ⇒ File

Get the bytes for the specified object

Parameters:

  • collection_name (String) —

    The name of the collection

  • collection_version (String) —

    The version of the collection

  • object_key (String) —

    The object key

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

    the optional parameters

Returns:

  • (File) 


686
687
688
689
 
# File 'lib/crimson-falcon/api/custom_storage.rb', line 686

def get_versioned_object(collection_name, collection_version, object_key, opts = {})
  data, _status_code, _headers = get_versioned_object_with_http_info(collection_name, collection_version, object_key, opts)
  data
end

#get_versioned_object_metadata(collection_name, collection_version, object_key, opts = {}) ⇒ CustomType3191042536

Get the metadata for the specified object

Parameters:

  • collection_name (String) —

    The name of the collection

  • collection_version (String) —

    The version of the collection

  • object_key (String) —

    The object key

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

    the optional parameters

Returns:

  • (CustomType3191042536) 


783
784
785
786
 
# File 'lib/crimson-falcon/api/custom_storage.rb', line 783

def get_versioned_object_metadata(collection_name, collection_version, object_key, opts = {})
  data, _status_code, _headers = get_versioned_object_metadata_with_http_info(collection_name, collection_version, object_key, opts)
  data
end

#get_versioned_object_metadata_with_http_info(collection_name, collection_version, object_key, opts = {}) ⇒ Array<(CustomType3191042536, Integer, Hash)>

Get the metadata for the specified object

Parameters:

  • collection_name (String) —

    The name of the collection

  • collection_version (String) —

    The version of the collection

  • object_key (String) —

    The object key

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

    the optional parameters

Returns:

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

    CustomType3191042536 data, response status code and response headers



794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
 
# File 'lib/crimson-falcon/api/custom_storage.rb', line 794

def get_versioned_object_metadata_with_http_info(collection_name, collection_version, object_key, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomStorage.get_versioned_object_metadata ...'
  end
  # verify the required parameter 'collection_name' is set
  if @api_client.config.client_side_validation && collection_name.nil?
    fail ArgumentError, "Missing the required parameter 'collection_name' when calling CustomStorage.get_versioned_object_metadata"
  end
  if @api_client.config.client_side_validation && collection_name.to_s.length > 255
    fail ArgumentError, 'invalid value for "collection_name" when calling CustomStorage.get_versioned_object_metadata, the character length must be smaller than or equal to 255.'
  end

  if @api_client.config.client_side_validation && collection_name.to_s.length < 1
    fail ArgumentError, 'invalid value for "collection_name" when calling CustomStorage.get_versioned_object_metadata, the character length must be great than or equal to 1.'
  end

  # verify the required parameter 'collection_version' is set
  if @api_client.config.client_side_validation && collection_version.nil?
    fail ArgumentError, "Missing the required parameter 'collection_version' when calling CustomStorage.get_versioned_object_metadata"
  end
  if @api_client.config.client_side_validation && collection_version.to_s.length > 20
    fail ArgumentError, 'invalid value for "collection_version" when calling CustomStorage.get_versioned_object_metadata, the character length must be smaller than or equal to 20.'
  end

  if @api_client.config.client_side_validation && collection_version.to_s.length < 1
    fail ArgumentError, 'invalid value for "collection_version" when calling CustomStorage.get_versioned_object_metadata, the character length must be great than or equal to 1.'
  end

  # verify the required parameter 'object_key' is set
  if @api_client.config.client_side_validation && object_key.nil?
    fail ArgumentError, "Missing the required parameter 'object_key' when calling CustomStorage.get_versioned_object_metadata"
  end
  if @api_client.config.client_side_validation && object_key.to_s.length > 1000
    fail ArgumentError, 'invalid value for "object_key" when calling CustomStorage.get_versioned_object_metadata, the character length must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && object_key.to_s.length < 1
    fail ArgumentError, 'invalid value for "object_key" when calling CustomStorage.get_versioned_object_metadata, the character length must be great than or equal to 1.'
  end

  # resource path
  local_var_path = '/customobjects/v1/collections/{collection_name}/{collection_version}/objects/{object_key}/metadata'.sub('{' + 'collection_name' + '}', CGI.escape(collection_name.to_s)).sub('{' + 'collection_version' + '}', CGI.escape(collection_version.to_s)).sub('{' + 'object_key' + '}', CGI.escape(object_key.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] || 'CustomType3191042536'

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

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

#get_versioned_object_with_http_info(collection_name, collection_version, object_key, opts = {}) ⇒ Array<(File, Integer, Hash)>

Get the bytes for the specified object

Parameters:

  • collection_name (String) —

    The name of the collection

  • collection_version (String) —

    The version of the collection

  • object_key (String) —

    The object key

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

    the optional parameters

Returns:

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

    File data, response status code and response headers



697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
 
# File 'lib/crimson-falcon/api/custom_storage.rb', line 697

def get_versioned_object_with_http_info(collection_name, collection_version, object_key, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomStorage.get_versioned_object ...'
  end
  # verify the required parameter 'collection_name' is set
  if @api_client.config.client_side_validation && collection_name.nil?
    fail ArgumentError, "Missing the required parameter 'collection_name' when calling CustomStorage.get_versioned_object"
  end
  if @api_client.config.client_side_validation && collection_name.to_s.length > 255
    fail ArgumentError, 'invalid value for "collection_name" when calling CustomStorage.get_versioned_object, the character length must be smaller than or equal to 255.'
  end

  if @api_client.config.client_side_validation && collection_name.to_s.length < 1
    fail ArgumentError, 'invalid value for "collection_name" when calling CustomStorage.get_versioned_object, the character length must be great than or equal to 1.'
  end

  # verify the required parameter 'collection_version' is set
  if @api_client.config.client_side_validation && collection_version.nil?
    fail ArgumentError, "Missing the required parameter 'collection_version' when calling CustomStorage.get_versioned_object"
  end
  if @api_client.config.client_side_validation && collection_version.to_s.length > 20
    fail ArgumentError, 'invalid value for "collection_version" when calling CustomStorage.get_versioned_object, the character length must be smaller than or equal to 20.'
  end

  if @api_client.config.client_side_validation && collection_version.to_s.length < 1
    fail ArgumentError, 'invalid value for "collection_version" when calling CustomStorage.get_versioned_object, the character length must be great than or equal to 1.'
  end

  # verify the required parameter 'object_key' is set
  if @api_client.config.client_side_validation && object_key.nil?
    fail ArgumentError, "Missing the required parameter 'object_key' when calling CustomStorage.get_versioned_object"
  end
  if @api_client.config.client_side_validation && object_key.to_s.length > 1000
    fail ArgumentError, 'invalid value for "object_key" when calling CustomStorage.get_versioned_object, the character length must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && object_key.to_s.length < 1
    fail ArgumentError, 'invalid value for "object_key" when calling CustomStorage.get_versioned_object, the character length must be great than or equal to 1.'
  end

  # resource path
  local_var_path = '/customobjects/v1/collections/{collection_name}/{collection_version}/objects/{object_key}'.sub('{' + 'collection_name' + '}', CGI.escape(collection_name.to_s)).sub('{' + 'collection_version' + '}', CGI.escape(collection_version.to_s)).sub('{' + 'object_key' + '}', CGI.escape(object_key.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', '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] || 'File'

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

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

#list_collections(opts = {}) ⇒ CustomType1255839303

List available collection names in alphabetical order

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :_end (String) —

    The end key to end listing to

  • :limit (Integer) —

    The limit of results to return

  • :start (String) —

    The start key to start listing from

Returns:

  • (CustomType1255839303) 


880
881
882
883
 
# File 'lib/crimson-falcon/api/custom_storage.rb', line 880

def list_collections(opts = {})
  data, _status_code, _headers = list_collections_with_http_info(opts)
  data
end

#list_collections_with_http_info(opts = {}) ⇒ Array<(CustomType1255839303, Integer, Hash)>

List available collection names in alphabetical order

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :_end (String) —

    The end key to end listing to

  • :limit (Integer) —

    The limit of results to return

  • :start (String) —

    The start key to start listing from

Returns:

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

    CustomType1255839303 data, response status code and response headers



891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
 
# File 'lib/crimson-falcon/api/custom_storage.rb', line 891

def list_collections_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomStorage.list_collections ...'
  end
  if @api_client.config.client_side_validation && !opts[:'_end'].nil? && opts[:'_end'].to_s.length > 1000
    fail ArgumentError, 'invalid value for "opts[:"_end"]" when calling CustomStorage.list_collections, the character length must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'_end'].nil? && opts[:'_end'].to_s.length < 1
    fail ArgumentError, 'invalid value for "opts[:"_end"]" when calling CustomStorage.list_collections, the character length must be great than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'start'].nil? && opts[:'start'].to_s.length > 1000
    fail ArgumentError, 'invalid value for "opts[:"start"]" when calling CustomStorage.list_collections, the character length must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'start'].nil? && opts[:'start'].to_s.length < 1
    fail ArgumentError, 'invalid value for "opts[:"start"]" when calling CustomStorage.list_collections, the character length must be great than or equal to 1.'
  end

  # resource path
  local_var_path = '/customobjects/v1/collections'

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

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

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

#list_objects(collection_name, opts = {}) ⇒ CustomStorageObjectKeys

List the object keys in the specified collection in alphabetical order

Parameters:

  • collection_name (String) —

    The name of the collection

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

    the optional parameters

Options Hash (opts):

  • :_end (String) —

    The end key to end listing to

  • :limit (Integer) —

    The limit of results to return

  • :start (String) —

    The start key to start listing from

Returns:



961
962
963
964
 
# File 'lib/crimson-falcon/api/custom_storage.rb', line 961

def list_objects(collection_name, opts = {})
  data, _status_code, _headers = list_objects_with_http_info(collection_name, opts)
  data
end

#list_objects_by_version(collection_name, collection_version, opts = {}) ⇒ CustomType1255839303

List the object keys in the specified collection in alphabetical order

Parameters:

  • collection_name (String) —

    The name of the collection

  • collection_version (String) —

    The version of the collection

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

    the optional parameters

Options Hash (opts):

  • :_end (String) —

    The end key to end listing to

  • :limit (Integer) —

    The limit of results to return

  • :start (String) —

    The start key to start listing from

Returns:

  • (CustomType1255839303) 


1056
1057
1058
1059
 
# File 'lib/crimson-falcon/api/custom_storage.rb', line 1056

def list_objects_by_version(collection_name, collection_version, opts = {})
  data, _status_code, _headers = list_objects_by_version_with_http_info(collection_name, collection_version, opts)
  data
end

#list_objects_by_version_with_http_info(collection_name, collection_version, opts = {}) ⇒ Array<(CustomType1255839303, Integer, Hash)>

List the object keys in the specified collection in alphabetical order

Parameters:

  • collection_name (String) —

    The name of the collection

  • collection_version (String) —

    The version of the collection

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

    the optional parameters

Options Hash (opts):

  • :_end (String) —

    The end key to end listing to

  • :limit (Integer) —

    The limit of results to return

  • :start (String) —

    The start key to start listing from

Returns:

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

    CustomType1255839303 data, response status code and response headers



1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
 
# File 'lib/crimson-falcon/api/custom_storage.rb', line 1069

def list_objects_by_version_with_http_info(collection_name, collection_version, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomStorage.list_objects_by_version ...'
  end
  # verify the required parameter 'collection_name' is set
  if @api_client.config.client_side_validation && collection_name.nil?
    fail ArgumentError, "Missing the required parameter 'collection_name' when calling CustomStorage.list_objects_by_version"
  end
  if @api_client.config.client_side_validation && collection_name.to_s.length > 255
    fail ArgumentError, 'invalid value for "collection_name" when calling CustomStorage.list_objects_by_version, the character length must be smaller than or equal to 255.'
  end

  if @api_client.config.client_side_validation && collection_name.to_s.length < 1
    fail ArgumentError, 'invalid value for "collection_name" when calling CustomStorage.list_objects_by_version, the character length must be great than or equal to 1.'
  end

  # verify the required parameter 'collection_version' is set
  if @api_client.config.client_side_validation && collection_version.nil?
    fail ArgumentError, "Missing the required parameter 'collection_version' when calling CustomStorage.list_objects_by_version"
  end
  if @api_client.config.client_side_validation && collection_version.to_s.length > 20
    fail ArgumentError, 'invalid value for "collection_version" when calling CustomStorage.list_objects_by_version, the character length must be smaller than or equal to 20.'
  end

  if @api_client.config.client_side_validation && collection_version.to_s.length < 1
    fail ArgumentError, 'invalid value for "collection_version" when calling CustomStorage.list_objects_by_version, the character length must be great than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'_end'].nil? && opts[:'_end'].to_s.length > 1000
    fail ArgumentError, 'invalid value for "opts[:"_end"]" when calling CustomStorage.list_objects_by_version, the character length must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'_end'].nil? && opts[:'_end'].to_s.length < 1
    fail ArgumentError, 'invalid value for "opts[:"_end"]" when calling CustomStorage.list_objects_by_version, the character length must be great than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'start'].nil? && opts[:'start'].to_s.length > 1000
    fail ArgumentError, 'invalid value for "opts[:"start"]" when calling CustomStorage.list_objects_by_version, the character length must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'start'].nil? && opts[:'start'].to_s.length < 1
    fail ArgumentError, 'invalid value for "opts[:"start"]" when calling CustomStorage.list_objects_by_version, the character length must be great than or equal to 1.'
  end

  # resource path
  local_var_path = '/customobjects/v1/collections/{collection_name}/{collection_version}/objects'.sub('{' + 'collection_name' + '}', CGI.escape(collection_name.to_s)).sub('{' + 'collection_version' + '}', CGI.escape(collection_version.to_s))

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

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

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

#list_objects_with_http_info(collection_name, opts = {}) ⇒ Array<(CustomStorageObjectKeys, Integer, Hash)>

List the object keys in the specified collection in alphabetical order

Parameters:

  • collection_name (String) —

    The name of the collection

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

    the optional parameters

Options Hash (opts):

  • :_end (String) —

    The end key to end listing to

  • :limit (Integer) —

    The limit of results to return

  • :start (String) —

    The start key to start listing from

Returns:

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

    CustomStorageObjectKeys data, response status code and response headers



973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
 
# File 'lib/crimson-falcon/api/custom_storage.rb', line 973

def list_objects_with_http_info(collection_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomStorage.list_objects ...'
  end
  # verify the required parameter 'collection_name' is set
  if @api_client.config.client_side_validation && collection_name.nil?
    fail ArgumentError, "Missing the required parameter 'collection_name' when calling CustomStorage.list_objects"
  end
  if @api_client.config.client_side_validation && collection_name.to_s.length > 255
    fail ArgumentError, 'invalid value for "collection_name" when calling CustomStorage.list_objects, the character length must be smaller than or equal to 255.'
  end

  if @api_client.config.client_side_validation && collection_name.to_s.length < 1
    fail ArgumentError, 'invalid value for "collection_name" when calling CustomStorage.list_objects, the character length must be great than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'_end'].nil? && opts[:'_end'].to_s.length > 1000
    fail ArgumentError, 'invalid value for "opts[:"_end"]" when calling CustomStorage.list_objects, the character length must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'_end'].nil? && opts[:'_end'].to_s.length < 1
    fail ArgumentError, 'invalid value for "opts[:"_end"]" when calling CustomStorage.list_objects, the character length must be great than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'start'].nil? && opts[:'start'].to_s.length > 1000
    fail ArgumentError, 'invalid value for "opts[:"start"]" when calling CustomStorage.list_objects, the character length must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'start'].nil? && opts[:'start'].to_s.length < 1
    fail ArgumentError, 'invalid value for "opts[:"start"]" when calling CustomStorage.list_objects, the character length must be great than or equal to 1.'
  end

  # resource path
  local_var_path = '/customobjects/v1/collections/{collection_name}/objects'.sub('{' + 'collection_name' + '}', CGI.escape(collection_name.to_s))

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

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

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

#list_schemas(collection_name, opts = {}) ⇒ CustomType1255839303

Get the list of schemas for the requested collection in reverse version order (latest first)

Parameters:

  • collection_name (String) —

    The name of the collection

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

    the optional parameters

Options Hash (opts):

  • :_end (String) —

    The end key to end listing to

  • :limit (Integer) —

    The limit of results to return

  • :start (String) —

    The start key to start listing from

Returns:

  • (CustomType1255839303) 


1163
1164
1165
1166
 
# File 'lib/crimson-falcon/api/custom_storage.rb', line 1163

def list_schemas(collection_name, opts = {})
  data, _status_code, _headers = list_schemas_with_http_info(collection_name, opts)
  data
end

#list_schemas_with_http_info(collection_name, opts = {}) ⇒ Array<(CustomType1255839303, Integer, Hash)>

Get the list of schemas for the requested collection in reverse version order (latest first)

Parameters:

  • collection_name (String) —

    The name of the collection

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

    the optional parameters

Options Hash (opts):

  • :_end (String) —

    The end key to end listing to

  • :limit (Integer) —

    The limit of results to return

  • :start (String) —

    The start key to start listing from

Returns:

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

    CustomType1255839303 data, response status code and response headers



1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
 
# File 'lib/crimson-falcon/api/custom_storage.rb', line 1175

def list_schemas_with_http_info(collection_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomStorage.list_schemas ...'
  end
  # verify the required parameter 'collection_name' is set
  if @api_client.config.client_side_validation && collection_name.nil?
    fail ArgumentError, "Missing the required parameter 'collection_name' when calling CustomStorage.list_schemas"
  end
  if @api_client.config.client_side_validation && collection_name.to_s.length > 255
    fail ArgumentError, 'invalid value for "collection_name" when calling CustomStorage.list_schemas, the character length must be smaller than or equal to 255.'
  end

  if @api_client.config.client_side_validation && collection_name.to_s.length < 1
    fail ArgumentError, 'invalid value for "collection_name" when calling CustomStorage.list_schemas, the character length must be great than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'_end'].nil? && opts[:'_end'].to_s.length > 1000
    fail ArgumentError, 'invalid value for "opts[:"_end"]" when calling CustomStorage.list_schemas, the character length must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'_end'].nil? && opts[:'_end'].to_s.length < 1
    fail ArgumentError, 'invalid value for "opts[:"_end"]" when calling CustomStorage.list_schemas, the character length must be great than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'start'].nil? && opts[:'start'].to_s.length > 1000
    fail ArgumentError, 'invalid value for "opts[:"start"]" when calling CustomStorage.list_schemas, the character length must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'start'].nil? && opts[:'start'].to_s.length < 1
    fail ArgumentError, 'invalid value for "opts[:"start"]" when calling CustomStorage.list_schemas, the character length must be great than or equal to 1.'
  end

  # resource path
  local_var_path = '/customobjects/v1/collections/{collection_name}/schemas'.sub('{' + 'collection_name' + '}', CGI.escape(collection_name.to_s))

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

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

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

#put_object(collection_name, object_key, body, opts = {}) ⇒ CustomStorageResponse

Put the specified new object at the given key or overwrite an existing object at the given key

Parameters:

  • collection_name (String) —

    The name of the collection

  • object_key (String) —

    The object key

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

    the optional parameters

Options Hash (opts):

  • :dry_run (Boolean) —

    If false, run the operation as normal. If true, validate that the request would succeed, but don&#39;t execute it.

  • :schema_version (String) —

    The version of the collection schema

Returns:



1258
1259
1260
1261
 
# File 'lib/crimson-falcon/api/custom_storage.rb', line 1258

def put_object(collection_name, object_key, body, opts = {})
  data, _status_code, _headers = put_object_with_http_info(collection_name, object_key, body, opts)
  data
end

#put_object_by_version(collection_name, collection_version, object_key, body, opts = {}) ⇒ CustomType3191042536

Put the specified new object at the given key or overwrite an existing object at the given key

Parameters:

  • collection_name (String) —

    The name of the collection

  • collection_version (String) —

    The version of the collection

  • object_key (String) —

    The object key

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

    the optional parameters

Options Hash (opts):

  • :dry_run (Boolean) —

    If false, run the operation as normal. If true, validate that the request would succeed, but don&#39;t execute it.

Returns:

  • (CustomType3191042536) 


1362
1363
1364
1365
 
# File 'lib/crimson-falcon/api/custom_storage.rb', line 1362

def put_object_by_version(collection_name, collection_version, object_key, body, opts = {})
  data, _status_code, _headers = put_object_by_version_with_http_info(collection_name, collection_version, object_key, body, opts)
  data
end

#put_object_by_version_with_http_info(collection_name, collection_version, object_key, body, opts = {}) ⇒ Array<(CustomType3191042536, Integer, Hash)>

Put the specified new object at the given key or overwrite an existing object at the given key

Parameters:

  • collection_name (String) —

    The name of the collection

  • collection_version (String) —

    The version of the collection

  • object_key (String) —

    The object key

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

    the optional parameters

Options Hash (opts):

  • :dry_run (Boolean) —

    If false, run the operation as normal. If true, validate that the request would succeed, but don&#39;t execute it.

Returns:

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

    CustomType3191042536 data, response status code and response headers



1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
 
# File 'lib/crimson-falcon/api/custom_storage.rb', line 1375

def put_object_by_version_with_http_info(collection_name, collection_version, object_key, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomStorage.put_object_by_version ...'
  end
  # verify the required parameter 'collection_name' is set
  if @api_client.config.client_side_validation && collection_name.nil?
    fail ArgumentError, "Missing the required parameter 'collection_name' when calling CustomStorage.put_object_by_version"
  end
  if @api_client.config.client_side_validation && collection_name.to_s.length > 255
    fail ArgumentError, 'invalid value for "collection_name" when calling CustomStorage.put_object_by_version, the character length must be smaller than or equal to 255.'
  end

  if @api_client.config.client_side_validation && collection_name.to_s.length < 1
    fail ArgumentError, 'invalid value for "collection_name" when calling CustomStorage.put_object_by_version, the character length must be great than or equal to 1.'
  end

  # verify the required parameter 'collection_version' is set
  if @api_client.config.client_side_validation && collection_version.nil?
    fail ArgumentError, "Missing the required parameter 'collection_version' when calling CustomStorage.put_object_by_version"
  end
  if @api_client.config.client_side_validation && collection_version.to_s.length > 20
    fail ArgumentError, 'invalid value for "collection_version" when calling CustomStorage.put_object_by_version, the character length must be smaller than or equal to 20.'
  end

  if @api_client.config.client_side_validation && collection_version.to_s.length < 1
    fail ArgumentError, 'invalid value for "collection_version" when calling CustomStorage.put_object_by_version, the character length must be great than or equal to 1.'
  end

  # verify the required parameter 'object_key' is set
  if @api_client.config.client_side_validation && object_key.nil?
    fail ArgumentError, "Missing the required parameter 'object_key' when calling CustomStorage.put_object_by_version"
  end
  if @api_client.config.client_side_validation && object_key.to_s.length > 1000
    fail ArgumentError, 'invalid value for "object_key" when calling CustomStorage.put_object_by_version, the character length must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && object_key.to_s.length < 1
    fail ArgumentError, 'invalid value for "object_key" when calling CustomStorage.put_object_by_version, the character length must be great than or equal to 1.'
  end

  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling CustomStorage.put_object_by_version"
  end
  # resource path
  local_var_path = '/customobjects/v1/collections/{collection_name}/{collection_version}/objects/{object_key}'.sub('{' + 'collection_name' + '}', CGI.escape(collection_name.to_s)).sub('{' + 'collection_version' + '}', CGI.escape(collection_version.to_s)).sub('{' + 'object_key' + '}', CGI.escape(object_key.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'dry_run'] = opts[:'dry_run'] if !opts[:'dry_run'].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/octet-stream', '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(body)

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

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

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

#put_object_with_http_info(collection_name, object_key, body, opts = {}) ⇒ Array<(CustomStorageResponse, Integer, Hash)>

Put the specified new object at the given key or overwrite an existing object at the given key

Parameters:

  • collection_name (String) —

    The name of the collection

  • object_key (String) —

    The object key

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

    the optional parameters

Options Hash (opts):

  • :dry_run (Boolean) —

    If false, run the operation as normal. If true, validate that the request would succeed, but don&#39;t execute it.

  • :schema_version (String) —

    The version of the collection schema

Returns:

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

    CustomStorageResponse data, response status code and response headers



1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
 
# File 'lib/crimson-falcon/api/custom_storage.rb', line 1271

def put_object_with_http_info(collection_name, object_key, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomStorage.put_object ...'
  end
  # verify the required parameter 'collection_name' is set
  if @api_client.config.client_side_validation && collection_name.nil?
    fail ArgumentError, "Missing the required parameter 'collection_name' when calling CustomStorage.put_object"
  end
  if @api_client.config.client_side_validation && collection_name.to_s.length > 255
    fail ArgumentError, 'invalid value for "collection_name" when calling CustomStorage.put_object, the character length must be smaller than or equal to 255.'
  end

  if @api_client.config.client_side_validation && collection_name.to_s.length < 1
    fail ArgumentError, 'invalid value for "collection_name" when calling CustomStorage.put_object, the character length must be great than or equal to 1.'
  end

  # verify the required parameter 'object_key' is set
  if @api_client.config.client_side_validation && object_key.nil?
    fail ArgumentError, "Missing the required parameter 'object_key' when calling CustomStorage.put_object"
  end
  if @api_client.config.client_side_validation && object_key.to_s.length > 1000
    fail ArgumentError, 'invalid value for "object_key" when calling CustomStorage.put_object, the character length must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && object_key.to_s.length < 1
    fail ArgumentError, 'invalid value for "object_key" when calling CustomStorage.put_object, the character length must be great than or equal to 1.'
  end

  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling CustomStorage.put_object"
  end
  if @api_client.config.client_side_validation && !opts[:'schema_version'].nil? && opts[:'schema_version'].to_s.length < 1
    fail ArgumentError, 'invalid value for "opts[:"schema_version"]" when calling CustomStorage.put_object, the character length must be great than or equal to 1.'
  end

  # resource path
  local_var_path = '/customobjects/v1/collections/{collection_name}/objects/{object_key}'.sub('{' + 'collection_name' + '}', CGI.escape(collection_name.to_s)).sub('{' + 'object_key' + '}', CGI.escape(object_key.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'dry_run'] = opts[:'dry_run'] if !opts[:'dry_run'].nil?
  query_params[:'schema_version'] = opts[:'schema_version'] if !opts[:'schema_version'].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/octet-stream', '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(body)

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

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

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

#search_objects(collection_name, filter, opts = {}) ⇒ CustomStorageResponse

Search for objects that match the specified filter criteria (returns metadata, not actual objects)

Parameters:

  • collection_name (String) —

    The name of the collection

  • filter (String) —

    The filter to limit the returned results.

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    The limit of results to return

  • :offset (Integer) —

    The offset of results to return

  • :sort (String) —

    The sort order for the returned results.

Returns:



1473
1474
1475
1476
 
# File 'lib/crimson-falcon/api/custom_storage.rb', line 1473

def search_objects(collection_name, filter, opts = {})
  data, _status_code, _headers = search_objects_with_http_info(collection_name, filter, opts)
  data
end

#search_objects_by_version(collection_name, collection_version, filter, opts = {}) ⇒ CustomType3191042536

Search for objects that match the specified filter criteria (returns metadata, not actual objects)

Parameters:

  • collection_name (String) —

    The name of the collection

  • collection_version (String) —

    The version of the collection

  • filter (String) —

    The filter to limit the returned results.

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    The limit of results to return

  • :offset (Integer) —

    The offset of results to return

  • :sort (String) —

    The sort order for the returned results.

Returns:

  • (CustomType3191042536) 


1575
1576
1577
1578
 
# File 'lib/crimson-falcon/api/custom_storage.rb', line 1575

def search_objects_by_version(collection_name, collection_version, filter, opts = {})
  data, _status_code, _headers = search_objects_by_version_with_http_info(collection_name, collection_version, filter, opts)
  data
end

#search_objects_by_version_with_http_info(collection_name, collection_version, filter, opts = {}) ⇒ Array<(CustomType3191042536, Integer, Hash)>

Search for objects that match the specified filter criteria (returns metadata, not actual objects)

Parameters:

  • collection_name (String) —

    The name of the collection

  • collection_version (String) —

    The version of the collection

  • filter (String) —

    The filter to limit the returned results.

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    The limit of results to return

  • :offset (Integer) —

    The offset of results to return

  • :sort (String) —

    The sort order for the returned results.

Returns:

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

    CustomType3191042536 data, response status code and response headers



1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
 
# File 'lib/crimson-falcon/api/custom_storage.rb', line 1589

def search_objects_by_version_with_http_info(collection_name, collection_version, filter, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomStorage.search_objects_by_version ...'
  end
  # verify the required parameter 'collection_name' is set
  if @api_client.config.client_side_validation && collection_name.nil?
    fail ArgumentError, "Missing the required parameter 'collection_name' when calling CustomStorage.search_objects_by_version"
  end
  if @api_client.config.client_side_validation && collection_name.to_s.length > 255
    fail ArgumentError, 'invalid value for "collection_name" when calling CustomStorage.search_objects_by_version, the character length must be smaller than or equal to 255.'
  end

  if @api_client.config.client_side_validation && collection_name.to_s.length < 1
    fail ArgumentError, 'invalid value for "collection_name" when calling CustomStorage.search_objects_by_version, the character length must be great than or equal to 1.'
  end

  # verify the required parameter 'collection_version' is set
  if @api_client.config.client_side_validation && collection_version.nil?
    fail ArgumentError, "Missing the required parameter 'collection_version' when calling CustomStorage.search_objects_by_version"
  end
  if @api_client.config.client_side_validation && collection_version.to_s.length > 20
    fail ArgumentError, 'invalid value for "collection_version" when calling CustomStorage.search_objects_by_version, the character length must be smaller than or equal to 20.'
  end

  if @api_client.config.client_side_validation && collection_version.to_s.length < 1
    fail ArgumentError, 'invalid value for "collection_version" when calling CustomStorage.search_objects_by_version, the character length must be great than or equal to 1.'
  end

  # verify the required parameter 'filter' is set
  if @api_client.config.client_side_validation && filter.nil?
    fail ArgumentError, "Missing the required parameter 'filter' when calling CustomStorage.search_objects_by_version"
  end
  if @api_client.config.client_side_validation && filter.to_s.length > 255
    fail ArgumentError, 'invalid value for "filter" when calling CustomStorage.search_objects_by_version, the character length must be smaller than or equal to 255.'
  end

  if @api_client.config.client_side_validation && filter.to_s.length < 1
    fail ArgumentError, 'invalid value for "filter" when calling CustomStorage.search_objects_by_version, the character length must be great than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'sort'].nil? && opts[:'sort'].to_s.length > 255
    fail ArgumentError, 'invalid value for "opts[:"sort"]" when calling CustomStorage.search_objects_by_version, the character length must be smaller than or equal to 255.'
  end

  if @api_client.config.client_side_validation && !opts[:'sort'].nil? && opts[:'sort'].to_s.length < 1
    fail ArgumentError, 'invalid value for "opts[:"sort"]" when calling CustomStorage.search_objects_by_version, the character length must be great than or equal to 1.'
  end

  # resource path
  local_var_path = '/customobjects/v1/collections/{collection_name}/{collection_version}/objects'.sub('{' + 'collection_name' + '}', CGI.escape(collection_name.to_s)).sub('{' + 'collection_version' + '}', CGI.escape(collection_version.to_s))

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

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

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

#search_objects_with_http_info(collection_name, filter, opts = {}) ⇒ Array<(CustomStorageResponse, Integer, Hash)>

Search for objects that match the specified filter criteria (returns metadata, not actual objects)

Parameters:

  • collection_name (String) —

    The name of the collection

  • filter (String) —

    The filter to limit the returned results.

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    The limit of results to return

  • :offset (Integer) —

    The offset of results to return

  • :sort (String) —

    The sort order for the returned results.

Returns:

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

    CustomStorageResponse data, response status code and response headers



1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
 
# File 'lib/crimson-falcon/api/custom_storage.rb', line 1486

def search_objects_with_http_info(collection_name, filter, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomStorage.search_objects ...'
  end
  # verify the required parameter 'collection_name' is set
  if @api_client.config.client_side_validation && collection_name.nil?
    fail ArgumentError, "Missing the required parameter 'collection_name' when calling CustomStorage.search_objects"
  end
  if @api_client.config.client_side_validation && collection_name.to_s.length > 255
    fail ArgumentError, 'invalid value for "collection_name" when calling CustomStorage.search_objects, the character length must be smaller than or equal to 255.'
  end

  if @api_client.config.client_side_validation && collection_name.to_s.length < 1
    fail ArgumentError, 'invalid value for "collection_name" when calling CustomStorage.search_objects, the character length must be great than or equal to 1.'
  end

  # verify the required parameter 'filter' is set
  if @api_client.config.client_side_validation && filter.nil?
    fail ArgumentError, "Missing the required parameter 'filter' when calling CustomStorage.search_objects"
  end
  if @api_client.config.client_side_validation && filter.to_s.length > 255
    fail ArgumentError, 'invalid value for "filter" when calling CustomStorage.search_objects, the character length must be smaller than or equal to 255.'
  end

  if @api_client.config.client_side_validation && filter.to_s.length < 1
    fail ArgumentError, 'invalid value for "filter" when calling CustomStorage.search_objects, the character length must be great than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'sort'].nil? && opts[:'sort'].to_s.length > 255
    fail ArgumentError, 'invalid value for "opts[:"sort"]" when calling CustomStorage.search_objects, the character length must be smaller than or equal to 255.'
  end

  if @api_client.config.client_side_validation && !opts[:'sort'].nil? && opts[:'sort'].to_s.length < 1
    fail ArgumentError, 'invalid value for "opts[:"sort"]" when calling CustomStorage.search_objects, the character length must be great than or equal to 1.'
  end

  # resource path
  local_var_path = '/customobjects/v1/collections/{collection_name}/objects'.sub('{' + 'collection_name' + '}', CGI.escape(collection_name.to_s))

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

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

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