class PulpcoreClient::UploadsApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/pulpcore_client/api/uploads_api.rb, line 19
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

commit(upload_href, data, opts = {}) click to toggle source

Finish an Upload Queues a Task that creates an Artifact, and the Upload gets deleted and cannot be re-used. @param upload_href [String] URI of Upload. e.g.: /pulp/api/v3/uploads/1/ @param data [UploadCommit] @param [Hash] opts the optional parameters @return [AsyncOperationResponse]

# File lib/pulpcore_client/api/uploads_api.rb, line 28
def commit(upload_href, data, opts = {})
  data, _status_code, _headers = commit_with_http_info(upload_href, data, opts)
  data
end
commit_with_http_info(upload_href, data, opts = {}) click to toggle source

Finish an Upload Queues a Task that creates an Artifact, and the Upload gets deleted and cannot be re-used. @param upload_href [String] URI of Upload. e.g.: /pulp/api/v3/uploads/1/ @param data [UploadCommit] @param [Hash] opts the optional parameters @return [Array<(AsyncOperationResponse, Integer, Hash)>] AsyncOperationResponse data, response status code and response headers

# File lib/pulpcore_client/api/uploads_api.rb, line 39
def commit_with_http_info(upload_href, data, 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 'data' is set
  if @api_client.config.client_side_validation && data.nil?
    fail ArgumentError, "Missing the required parameter 'data' 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'])

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

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

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

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

  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(data, opts = {}) click to toggle source

Create an upload View for chunked uploads. @param data [Upload] @param [Hash] opts the optional parameters @return [UploadRead]

# File lib/pulpcore_client/api/uploads_api.rb, line 97
def create(data, opts = {})
  data, _status_code, _headers = create_with_http_info(data, opts)
  data
end
create_with_http_info(data, opts = {}) click to toggle source

Create an upload View for chunked uploads. @param data [Upload] @param [Hash] opts the optional parameters @return [Array<(UploadRead, Integer, Hash)>] UploadRead data, response status code and response headers

# File lib/pulpcore_client/api/uploads_api.rb, line 107
def create_with_http_info(data, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UploadsApi.create ...'
  end
  # verify the required parameter 'data' is set
  if @api_client.config.client_side_validation && data.nil?
    fail ArgumentError, "Missing the required parameter 'data' 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'])

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

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

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

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

  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 = {}) click to toggle source

Delete an upload View for chunked uploads. @param upload_href [String] URI of Upload. e.g.: /pulp/api/v3/uploads/1/ @param [Hash] opts the optional parameters @return [nil]

# 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 = {}) click to toggle source

Delete an upload View for chunked uploads. @param upload_href [String] URI of Upload. e.g.: /pulp/api/v3/uploads/1/ @param [Hash] opts the optional parameters @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers

# 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] || ['Basic']

  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 = {}) click to toggle source

List uploads View for chunked uploads. @param [Hash] opts the optional parameters @option opts [String] :ordering Which field to use when ordering the results. @option opts [String] :completed ISO 8601 formatted dates are supported @option opts [Integer] :limit Number of results to return per page. @option opts [Integer] :offset The initial index from which to return the results. @option opts [String] :fields A list of fields to include in the response. @option opts [String] :exclude_fields A list of fields to exclude from the response. @return [InlineResponse2008]

# File lib/pulpcore_client/api/uploads_api.rb, line 226
def list(opts = {})
  data, _status_code, _headers = list_with_http_info(opts)
  data
end
list_with_http_info(opts = {}) click to toggle source

List uploads View for chunked uploads. @param [Hash] opts the optional parameters @option opts [String] :ordering Which field to use when ordering the results. @option opts [String] :completed ISO 8601 formatted dates are supported @option opts [Integer] :limit Number of results to return per page. @option opts [Integer] :offset The initial index from which to return the results. @option opts [String] :fields A list of fields to include in the response. @option opts [String] :exclude_fields A list of fields to exclude from the response. @return [Array<(InlineResponse2008, Integer, Hash)>] InlineResponse2008 data, response status code and response headers

# File lib/pulpcore_client/api/uploads_api.rb, line 241
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[:'ordering'] = opts[:'ordering'] if !opts[:'ordering'].nil?
  query_params[:'completed'] = opts[:'completed'] if !opts[:'completed'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].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] || 'InlineResponse2008' 

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

  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 = {}) click to toggle source

Inspect an upload View for chunked uploads. @param upload_href [String] URI of Upload. e.g.: /pulp/api/v3/uploads/1/ @param [Hash] opts the optional parameters @option opts [String] :fields A list of fields to include in the response. @option opts [String] :exclude_fields A list of fields to exclude from the response. @return [UploadDetailRead]

# File lib/pulpcore_client/api/uploads_api.rb, line 297
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 = {}) click to toggle source

Inspect an upload View for chunked uploads. @param upload_href [String] URI of Upload. e.g.: /pulp/api/v3/uploads/1/ @param [Hash] opts the optional parameters @option opts [String] :fields A list of fields to include in the response. @option opts [String] :exclude_fields A list of fields to exclude from the response. @return [Array<(UploadDetailRead, Integer, Hash)>] UploadDetailRead data, response status code and response headers

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

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

  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(upload_href, content_range, file, opts = {}) click to toggle source

Upload a file chunk Upload a chunk for an upload. @param upload_href [String] URI of Upload. e.g.: /pulp/api/v3/uploads/1/ @param content_range [String] The Content-Range header specifies the location of the file chunk within the file. @param file [File] A chunk of the uploaded file. @param [Hash] opts the optional parameters @option opts [String] :sha256 The SHA-256 checksum of the chunk if available. @return [Upload]

# File lib/pulpcore_client/api/uploads_api.rb, line 366
def update(upload_href, content_range, file, opts = {})
  data, _status_code, _headers = update_with_http_info(upload_href, content_range, file, opts)
  data
end
update_with_http_info(upload_href, content_range, file, opts = {}) click to toggle source

Upload a file chunk Upload a chunk for an upload. @param upload_href [String] URI of Upload. e.g.: /pulp/api/v3/uploads/1/ @param content_range [String] The Content-Range header specifies the location of the file chunk within the file. @param file [File] A chunk of the uploaded file. @param [Hash] opts the optional parameters @option opts [String] :sha256 The SHA-256 checksum of the chunk if available. @return [Array<(Upload, Integer, Hash)>] Upload data, response status code and response headers

# File lib/pulpcore_client/api/uploads_api.rb, line 379
def update_with_http_info(upload_href, content_range, file, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: 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 '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
  pattern = Regexp.new(/^bytes (\d+)-(\d+)\/(\d+|[*])$/)
  if @api_client.config.client_side_validation && content_range !~ pattern
    fail ArgumentError, "invalid value for 'content_range' when calling UploadsApi.update, must conform to the pattern #{pattern}."
  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] || 'Upload' 

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

  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