Class: PulpcoreClient::UploadsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/pulpcore_client/api/uploads_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ UploadsApi

Returns a new instance of UploadsApi.



19
20
21
 
# File 'lib/pulpcore_client/api/uploads_api.rb', line 19

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/pulpcore_client/api/uploads_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#add_role(upload_href, upload, opts = {}) ⇒ NestedRoleResponse

Add a role Add a role for this object to users/groups.

Parameters:

  • upload_href (String)
  • upload (Upload)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



28
29
30
31
 
# File 'lib/pulpcore_client/api/uploads_api.rb', line 28

def add_role(upload_href, upload, opts = {})
  data, _status_code, _headers = add_role_with_http_info(upload_href, upload, opts)
  data
end

#add_role_with_http_info(upload_href, upload, opts = {}) ⇒ Array<(NestedRoleResponse, Integer, Hash)>

Add a role Add a role for this object to users/groups.

Parameters:

  • upload_href (String)
  • upload (Upload)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    NestedRoleResponse data, response status code and response headers



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/pulpcore_client/api/uploads_api.rb', line 39

def add_role_with_http_info(upload_href, upload, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UploadsApi.add_role ...'
  end
  # verify the required parameter 'upload_href' is set
  if @api_client.config.client_side_validation && upload_href.nil?
    fail ArgumentError, "Missing the required parameter 'upload_href' when calling UploadsApi.add_role"
  end
  # verify the required parameter 'upload' is set
  if @api_client.config.client_side_validation && upload.nil?
    fail ArgumentError, "Missing the required parameter 'upload' when calling UploadsApi.add_role"
  end
  # resource path
  local_var_path = '{upload_href}add_role/'.sub('{' + 'upload_href' + '}', CGI.escape(upload_href.to_s).gsub('%2F', '/'))

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])

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

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(upload) 

  # return_type
  return_type = opts[:return_type] || 'NestedRoleResponse' 

  # auth_names
  auth_names = opts[:auth_names] || ['basicAuth']

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

#commit(upload_href, upload_commit, opts = {}) ⇒ AsyncOperationResponse

Finish an Upload Queues a Task that creates an Artifact, and the Upload gets deleted and cannot be re-used.

Parameters:

  • upload_href (String)
  • upload_commit (UploadCommit)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



98
99
100
101
 
# File 'lib/pulpcore_client/api/uploads_api.rb', line 98

def commit(upload_href, upload_commit, opts = {})
  data, _status_code, _headers = commit_with_http_info(upload_href, upload_commit, opts)
  data
end

#commit_with_http_info(upload_href, upload_commit, opts = {}) ⇒ Array<(AsyncOperationResponse, Integer, Hash)>

Finish an Upload Queues a Task that creates an Artifact, and the Upload gets deleted and cannot be re-used.

Parameters:

  • upload_href (String)
  • upload_commit (UploadCommit)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    AsyncOperationResponse data, response status code and response headers



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/pulpcore_client/api/uploads_api.rb', line 109

def commit_with_http_info(upload_href, upload_commit, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UploadsApi.commit ...'
  end
  # verify the required parameter 'upload_href' is set
  if @api_client.config.client_side_validation && upload_href.nil?
    fail ArgumentError, "Missing the required parameter 'upload_href' when calling UploadsApi.commit"
  end
  # verify the required parameter 'upload_commit' is set
  if @api_client.config.client_side_validation && upload_commit.nil?
    fail ArgumentError, "Missing the required parameter 'upload_commit' when calling UploadsApi.commit"
  end
  # resource path
  local_var_path = '{upload_href}commit/'.sub('{' + 'upload_href' + '}', CGI.escape(upload_href.to_s).gsub('%2F', '/'))

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])

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

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(upload_commit) 

  # return_type
  return_type = opts[:return_type] || 'AsyncOperationResponse' 

  # auth_names
  auth_names = opts[:auth_names] || ['basicAuth']

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

#create(upload, opts = {}) ⇒ UploadResponse

Create an upload View for chunked uploads.

Parameters:

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

    the optional parameters

Returns:



167
168
169
170
 
# File 'lib/pulpcore_client/api/uploads_api.rb', line 167

def create(upload, opts = {})
  data, _status_code, _headers = create_with_http_info(upload, opts)
  data
end

#create_with_http_info(upload, opts = {}) ⇒ Array<(UploadResponse, Integer, Hash)>

Create an upload View for chunked uploads.

Parameters:

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

    the optional parameters

Returns:

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

    UploadResponse data, response status code and response headers



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/pulpcore_client/api/uploads_api.rb', line 177

def create_with_http_info(upload, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UploadsApi.create ...'
  end
  # verify the required parameter 'upload' is set
  if @api_client.config.client_side_validation && upload.nil?
    fail ArgumentError, "Missing the required parameter 'upload' when calling UploadsApi.create"
  end
  # resource path
  local_var_path = '/pulp/api/v3/uploads/'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])

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

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(upload) 

  # return_type
  return_type = opts[:return_type] || 'UploadResponse' 

  # auth_names
  auth_names = opts[:auth_names] || ['basicAuth']

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

#delete(upload_href, opts = {}) ⇒ nil

Delete an upload View for chunked uploads.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


231
232
233
234
 
# File 'lib/pulpcore_client/api/uploads_api.rb', line 231

def delete(upload_href, opts = {})
  delete_with_http_info(upload_href, opts)
  nil
end

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

Delete an upload View for chunked uploads.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
 
# File 'lib/pulpcore_client/api/uploads_api.rb', line 241

def delete_with_http_info(upload_href, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UploadsApi.delete ...'
  end
  # verify the required parameter 'upload_href' is set
  if @api_client.config.client_side_validation && upload_href.nil?
    fail ArgumentError, "Missing the required parameter 'upload_href' when calling UploadsApi.delete"
  end
  # resource path
  local_var_path = '{upload_href}'.sub('{' + 'upload_href' + '}', CGI.escape(upload_href.to_s).gsub('%2F', '/'))

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

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

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

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

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['basicAuth']

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

#list(opts = {}) ⇒ PaginatedUploadResponseList

List uploads View for chunked uploads.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    Number of results to return per page.

  • :offset (Integer) —

    The initial index from which to return the results.

  • :ordering (Array<String>) —

    Ordering * &#x60;pulp_id&#x60; - Pulp id * &#x60;-pulp_id&#x60; - Pulp id (descending) * &#x60;pulp_created&#x60; - Pulp created * &#x60;-pulp_created&#x60; - Pulp created (descending) * &#x60;pulp_last_updated&#x60; - Pulp last updated * &#x60;-pulp_last_updated&#x60; - Pulp last updated (descending) * &#x60;size&#x60; - Size * &#x60;-size&#x60; - Size (descending) * &#x60;pk&#x60; - Pk * &#x60;-pk&#x60; - Pk (descending)

  • :pulp_href__in (Array<String>) —

    Multiple values may be separated by commas.

  • :pulp_id__in (Array<String>) —

    Multiple values may be separated by commas.

  • :q (String) —

    Filter results by using NOT, AND and OR operations on other filters

  • :size (Integer) —

    Filter results where size matches value

  • :size__gt (Integer) —

    Filter results where size is greater than value

  • :size__lt (Integer) —

    Filter results where size is less than value

  • :size__range (Array<Integer>) —

    Filter results where size is between two comma separated values

  • :fields (Array<String>) —

    A list of fields to include in the response.

  • :exclude_fields (Array<String>) —

    A list of fields to exclude from the response.

Returns:



302
303
304
305
 
# File 'lib/pulpcore_client/api/uploads_api.rb', line 302

def list(opts = {})
  data, _status_code, _headers = list_with_http_info(opts)
  data
end

#list_roles(upload_href, opts = {}) ⇒ ObjectRolesResponse

List roles List roles assigned to this object.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :fields (Array<String>) —

    A list of fields to include in the response.

  • :exclude_fields (Array<String>) —

    A list of fields to exclude from the response.

Returns:



389
390
391
392
 
# File 'lib/pulpcore_client/api/uploads_api.rb', line 389

def list_roles(upload_href, opts = {})
  data, _status_code, _headers = list_roles_with_http_info(upload_href, opts)
  data
end

#list_roles_with_http_info(upload_href, opts = {}) ⇒ Array<(ObjectRolesResponse, Integer, Hash)>

List roles List roles assigned to this object.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :fields (Array<String>) —

    A list of fields to include in the response.

  • :exclude_fields (Array<String>) —

    A list of fields to exclude from the response.

Returns:

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

    ObjectRolesResponse data, response status code and response headers



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
438
439
440
441
442
443
444
445
446
447
448
 
# File 'lib/pulpcore_client/api/uploads_api.rb', line 401

def list_roles_with_http_info(upload_href, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UploadsApi.list_roles ...'
  end
  # verify the required parameter 'upload_href' is set
  if @api_client.config.client_side_validation && upload_href.nil?
    fail ArgumentError, "Missing the required parameter 'upload_href' when calling UploadsApi.list_roles"
  end
  # resource path
  local_var_path = '{upload_href}list_roles/'.sub('{' + 'upload_href' + '}', CGI.escape(upload_href.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :multi) if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :multi) if !opts[:'exclude_fields'].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[:body] 

  # return_type
  return_type = opts[:return_type] || 'ObjectRolesResponse' 

  # auth_names
  auth_names = opts[:auth_names] || ['basicAuth']

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

#list_with_http_info(opts = {}) ⇒ Array<(PaginatedUploadResponseList, Integer, Hash)>

List uploads View for chunked uploads.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    Number of results to return per page.

  • :offset (Integer) —

    The initial index from which to return the results.

  • :ordering (Array<String>) —

    Ordering * &#x60;pulp_id&#x60; - Pulp id * &#x60;-pulp_id&#x60; - Pulp id (descending) * &#x60;pulp_created&#x60; - Pulp created * &#x60;-pulp_created&#x60; - Pulp created (descending) * &#x60;pulp_last_updated&#x60; - Pulp last updated * &#x60;-pulp_last_updated&#x60; - Pulp last updated (descending) * &#x60;size&#x60; - Size * &#x60;-size&#x60; - Size (descending) * &#x60;pk&#x60; - Pk * &#x60;-pk&#x60; - Pk (descending)

  • :pulp_href__in (Array<String>) —

    Multiple values may be separated by commas.

  • :pulp_id__in (Array<String>) —

    Multiple values may be separated by commas.

  • :q (String) —

    Filter results by using NOT, AND and OR operations on other filters

  • :size (Integer) —

    Filter results where size matches value

  • :size__gt (Integer) —

    Filter results where size is greater than value

  • :size__lt (Integer) —

    Filter results where size is less than value

  • :size__range (Array<Integer>) —

    Filter results where size is between two comma separated values

  • :fields (Array<String>) —

    A list of fields to include in the response.

  • :exclude_fields (Array<String>) —

    A list of fields to exclude from the response.

Returns:

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

    PaginatedUploadResponseList data, response status code and response headers



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
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
 
# File 'lib/pulpcore_client/api/uploads_api.rb', line 323

def list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UploadsApi.list ...'
  end
  allowable_values = ["-pk", "-pulp_created", "-pulp_id", "-pulp_last_updated", "-size", "pk", "pulp_created", "pulp_id", "pulp_last_updated", "size"]
  if @api_client.config.client_side_validation && opts[:'ordering'] && !opts[:'ordering'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"ordering\", must include one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/pulp/api/v3/uploads/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'ordering'] = @api_client.build_collection_param(opts[:'ordering'], :csv) if !opts[:'ordering'].nil?
  query_params[:'pulp_href__in'] = @api_client.build_collection_param(opts[:'pulp_href__in'], :csv) if !opts[:'pulp_href__in'].nil?
  query_params[:'pulp_id__in'] = @api_client.build_collection_param(opts[:'pulp_id__in'], :csv) if !opts[:'pulp_id__in'].nil?
  query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
  query_params[:'size__gt'] = opts[:'size__gt'] if !opts[:'size__gt'].nil?
  query_params[:'size__lt'] = opts[:'size__lt'] if !opts[:'size__lt'].nil?
  query_params[:'size__range'] = @api_client.build_collection_param(opts[:'size__range'], :csv) if !opts[:'size__range'].nil?
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :multi) if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :multi) if !opts[:'exclude_fields'].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[:body] 

  # return_type
  return_type = opts[:return_type] || 'PaginatedUploadResponseList' 

  # auth_names
  auth_names = opts[:auth_names] || ['basicAuth']

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

#my_permissions(upload_href, opts = {}) ⇒ MyPermissionsResponse

List user permissions List permissions available to the current user on this object.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :fields (Array<String>) —

    A list of fields to include in the response.

  • :exclude_fields (Array<String>) —

    A list of fields to exclude from the response.

Returns:



457
458
459
460
 
# File 'lib/pulpcore_client/api/uploads_api.rb', line 457

def my_permissions(upload_href, opts = {})
  data, _status_code, _headers = my_permissions_with_http_info(upload_href, opts)
  data
end

#my_permissions_with_http_info(upload_href, opts = {}) ⇒ Array<(MyPermissionsResponse, Integer, Hash)>

List user permissions List permissions available to the current user on this object.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :fields (Array<String>) —

    A list of fields to include in the response.

  • :exclude_fields (Array<String>) —

    A list of fields to exclude from the response.

Returns:

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

    MyPermissionsResponse data, response status code and response headers



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
 
# File 'lib/pulpcore_client/api/uploads_api.rb', line 469

def my_permissions_with_http_info(upload_href, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UploadsApi.my_permissions ...'
  end
  # verify the required parameter 'upload_href' is set
  if @api_client.config.client_side_validation && upload_href.nil?
    fail ArgumentError, "Missing the required parameter 'upload_href' when calling UploadsApi.my_permissions"
  end
  # resource path
  local_var_path = '{upload_href}my_permissions/'.sub('{' + 'upload_href' + '}', CGI.escape(upload_href.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :multi) if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :multi) if !opts[:'exclude_fields'].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[:body] 

  # return_type
  return_type = opts[:return_type] || 'MyPermissionsResponse' 

  # auth_names
  auth_names = opts[:auth_names] || ['basicAuth']

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

#read(upload_href, opts = {}) ⇒ UploadDetailResponse

Inspect an upload View for chunked uploads.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :fields (Array<String>) —

    A list of fields to include in the response.

  • :exclude_fields (Array<String>) —

    A list of fields to exclude from the response.

Returns:



525
526
527
528
 
# File 'lib/pulpcore_client/api/uploads_api.rb', line 525

def read(upload_href, opts = {})
  data, _status_code, _headers = read_with_http_info(upload_href, opts)
  data
end

#read_with_http_info(upload_href, opts = {}) ⇒ Array<(UploadDetailResponse, Integer, Hash)>

Inspect an upload View for chunked uploads.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :fields (Array<String>) —

    A list of fields to include in the response.

  • :exclude_fields (Array<String>) —

    A list of fields to exclude from the response.

Returns:

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

    UploadDetailResponse 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
 
# File 'lib/pulpcore_client/api/uploads_api.rb', line 537

def read_with_http_info(upload_href, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UploadsApi.read ...'
  end
  # verify the required parameter 'upload_href' is set
  if @api_client.config.client_side_validation && upload_href.nil?
    fail ArgumentError, "Missing the required parameter 'upload_href' when calling UploadsApi.read"
  end
  # resource path
  local_var_path = '{upload_href}'.sub('{' + 'upload_href' + '}', CGI.escape(upload_href.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :multi) if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :multi) if !opts[:'exclude_fields'].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[:body] 

  # return_type
  return_type = opts[:return_type] || 'UploadDetailResponse' 

  # auth_names
  auth_names = opts[:auth_names] || ['basicAuth']

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

#remove_role(upload_href, upload, opts = {}) ⇒ NestedRoleResponse

Remove a role Remove a role for this object from users/groups.

Parameters:

  • upload_href (String)
  • upload (Upload)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



592
593
594
595
 
# File 'lib/pulpcore_client/api/uploads_api.rb', line 592

def remove_role(upload_href, upload, opts = {})
  data, _status_code, _headers = remove_role_with_http_info(upload_href, upload, opts)
  data
end

#remove_role_with_http_info(upload_href, upload, opts = {}) ⇒ Array<(NestedRoleResponse, Integer, Hash)>

Remove a role Remove a role for this object from users/groups.

Parameters:

  • upload_href (String)
  • upload (Upload)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    NestedRoleResponse data, response status code and response headers



603
604
605
606
607
608
609
610
611
612
613
614
615
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
 
# File 'lib/pulpcore_client/api/uploads_api.rb', line 603

def remove_role_with_http_info(upload_href, upload, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UploadsApi.remove_role ...'
  end
  # verify the required parameter 'upload_href' is set
  if @api_client.config.client_side_validation && upload_href.nil?
    fail ArgumentError, "Missing the required parameter 'upload_href' when calling UploadsApi.remove_role"
  end
  # verify the required parameter 'upload' is set
  if @api_client.config.client_side_validation && upload.nil?
    fail ArgumentError, "Missing the required parameter 'upload' when calling UploadsApi.remove_role"
  end
  # resource path
  local_var_path = '{upload_href}remove_role/'.sub('{' + 'upload_href' + '}', CGI.escape(upload_href.to_s).gsub('%2F', '/'))

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])

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

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(upload) 

  # return_type
  return_type = opts[:return_type] || 'NestedRoleResponse' 

  # auth_names
  auth_names = opts[:auth_names] || ['basicAuth']

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

#update(content_range, upload_href, file, opts = {}) ⇒ UploadResponse

Upload a file chunk Upload a chunk for an upload.

Parameters:

  • content_range (String) —

    The Content-Range header specifies the location of the file chunk within the file.

  • upload_href (String)
  • file (File) —

    A chunk of the uploaded file.

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

    the optional parameters

Options Hash (opts):

  • :sha256 (String) —

    The SHA-256 checksum of the chunk if available.

Returns:



664
665
666
667
 
# File 'lib/pulpcore_client/api/uploads_api.rb', line 664

def update(content_range, upload_href, file, opts = {})
  data, _status_code, _headers = update_with_http_info(content_range, upload_href, file, opts)
  data
end

#update_with_http_info(content_range, upload_href, file, opts = {}) ⇒ Array<(UploadResponse, Integer, Hash)>

Upload a file chunk Upload a chunk for an upload.

Parameters:

  • content_range (String) —

    The Content-Range header specifies the location of the file chunk within the file.

  • upload_href (String)
  • file (File) —

    A chunk of the uploaded file.

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

    the optional parameters

Options Hash (opts):

  • :sha256 (String) —

    The SHA-256 checksum of the chunk if available.

Returns:

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

    UploadResponse data, response status code and response headers



677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
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
 
# File 'lib/pulpcore_client/api/uploads_api.rb', line 677

def update_with_http_info(content_range, upload_href, file, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UploadsApi.update ...'
  end
  # verify the required parameter 'content_range' is set
  if @api_client.config.client_side_validation && content_range.nil?
    fail ArgumentError, "Missing the required parameter 'content_range' when calling UploadsApi.update"
  end
  # verify the required parameter 'upload_href' is set
  if @api_client.config.client_side_validation && upload_href.nil?
    fail ArgumentError, "Missing the required parameter 'upload_href' when calling UploadsApi.update"
  end
  # verify the required parameter 'file' is set
  if @api_client.config.client_side_validation && file.nil?
    fail ArgumentError, "Missing the required parameter 'file' when calling UploadsApi.update"
  end
  if @api_client.config.client_side_validation && !opts[:'sha256'].nil? && opts[:'sha256'].to_s.length < 1
    fail ArgumentError, 'invalid value for "opts[:"sha256"]" when calling UploadsApi.update, the character length must be great than or equal to 1.'
  end

  # resource path
  local_var_path = '{upload_href}'.sub('{' + 'upload_href' + '}', CGI.escape(upload_href.to_s).gsub('%2F', '/'))

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data', 'application/x-www-form-urlencoded'])
  header_params[:'Content-Range'] = content_range

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['file'] = file
  form_params['sha256'] = opts[:'sha256'] if !opts[:'sha256'].nil?

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

  # return_type
  return_type = opts[:return_type] || 'UploadResponse' 

  # auth_names
  auth_names = opts[:auth_names] || ['basicAuth']

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