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

#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:



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

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



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 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:



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

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



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

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) 


161
162
163
164
 
# File 'lib/pulpcore_client/api/uploads_api.rb', line 161

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



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

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 (String) —

    Which field to use when ordering the results.

  • :fields (String) —

    A list of fields to include in the response.

  • :exclude_fields (String) —

    A list of fields to exclude from the response.

Returns:



225
226
227
228
 
# File 'lib/pulpcore_client/api/uploads_api.rb', line 225

def list(opts = {})
  data, _status_code, _headers = list_with_http_info(opts)
  data
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 (String) —

    Which field to use when ordering the results.

  • :fields (String) —

    A list of fields to include in the response.

  • :exclude_fields (String) —

    A list of fields to exclude from the response.

Returns:

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

    PaginatedUploadResponseList data, response status code and response headers



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

def list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UploadsApi.list ...'
  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'] = opts[:'ordering'] if !opts[:'ordering'].nil?
  query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = opts[:'exclude_fields'] 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

#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 (String) —

    A list of fields to include in the response.

  • :exclude_fields (String) —

    A list of fields to exclude from the response.

Returns:



294
295
296
297
 
# File 'lib/pulpcore_client/api/uploads_api.rb', line 294

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 (String) —

    A list of fields to include in the response.

  • :exclude_fields (String) —

    A list of fields to exclude from the response.

Returns:

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

    UploadDetailResponse data, response status code and response headers



306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/pulpcore_client/api/uploads_api.rb', line 306

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'] = opts[:'fields'] if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = opts[:'exclude_fields'] 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

#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:



363
364
365
366
 
# File 'lib/pulpcore_client/api/uploads_api.rb', line 363

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



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

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