class PulpPythonClient::DistributionsPypiApi

Attributes

api_client[RW]

Public Class Methods

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

Public Instance Methods

create(python_python_distribution, opts = {}) click to toggle source

Create a python distribution Trigger an asynchronous create task @param python_python_distribution [PythonPythonDistribution] @param [Hash] opts the optional parameters @return [AsyncOperationResponse]

# File lib/pulp_python_client/api/distributions_pypi_api.rb, line 27
def create(python_python_distribution, opts = {})
  data, _status_code, _headers = create_with_http_info(python_python_distribution, opts)
  data
end
create_with_http_info(python_python_distribution, opts = {}) click to toggle source

Create a python distribution Trigger an asynchronous create task @param python_python_distribution [PythonPythonDistribution] @param [Hash] opts the optional parameters @return [Array<(AsyncOperationResponse, Integer, Hash)>] AsyncOperationResponse data, response status code and response headers

# File lib/pulp_python_client/api/distributions_pypi_api.rb, line 37
def create_with_http_info(python_python_distribution, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DistributionsPypiApi.create ...'
  end
  # verify the required parameter 'python_python_distribution' is set
  if @api_client.config.client_side_validation && python_python_distribution.nil?
    fail ArgumentError, "Missing the required parameter 'python_python_distribution' when calling DistributionsPypiApi.create"
  end
  # resource path
  local_var_path = '/pulp/api/v3/distributions/python/pypi/'

  # 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(python_python_distribution) 

  # 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: DistributionsPypiApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
delete(python_python_distribution_href, opts = {}) click to toggle source

Delete a python distribution Trigger an asynchronous delete task @param python_python_distribution_href [String] @param [Hash] opts the optional parameters @return [AsyncOperationResponse]

# File lib/pulp_python_client/api/distributions_pypi_api.rb, line 91
def delete(python_python_distribution_href, opts = {})
  data, _status_code, _headers = delete_with_http_info(python_python_distribution_href, opts)
  data
end
delete_with_http_info(python_python_distribution_href, opts = {}) click to toggle source

Delete a python distribution Trigger an asynchronous delete task @param python_python_distribution_href [String] @param [Hash] opts the optional parameters @return [Array<(AsyncOperationResponse, Integer, Hash)>] AsyncOperationResponse data, response status code and response headers

# File lib/pulp_python_client/api/distributions_pypi_api.rb, line 101
def delete_with_http_info(python_python_distribution_href, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DistributionsPypiApi.delete ...'
  end
  # verify the required parameter 'python_python_distribution_href' is set
  if @api_client.config.client_side_validation && python_python_distribution_href.nil?
    fail ArgumentError, "Missing the required parameter 'python_python_distribution_href' when calling DistributionsPypiApi.delete"
  end
  # resource path
  local_var_path = '{python_python_distribution_href}'.sub('{' + 'python_python_distribution_href' + '}', CGI.escape(python_python_distribution_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'])

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

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

  # 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(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DistributionsPypiApi#delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
list(opts = {}) click to toggle source

List python distributions

Pulp Python Distributions are used to distribute Python content from Python Repositories or Python Publications.  Pulp Python Distributions should not be confused with \"Python Distribution\" as defined by the Python community. In Pulp usage, Python content is referred to as Python Package Content.

@param [Hash] opts the optional parameters @option opts [String] :base_path @option opts [String] :base_path__contains Filter results where base_path contains value @option opts [String] :base_path__icontains Filter results where base_path contains value @option opts [Array<String>] :base_path__in Filter results where base_path is in a comma-separated list of values @option opts [Integer] :limit Number of results to return per page. @option opts [String] :name @option opts [String] :name__contains Filter results where name contains value @option opts [String] :name__icontains Filter results where name contains value @option opts [Array<String>] :name__in Filter results where name is in a comma-separated list of values @option opts [String] :name__startswith Filter results where name starts with value @option opts [Integer] :offset The initial index from which to return the results. @option opts [String] :ordering Which field to use when ordering the results. @option opts [String] :pulp_label_select Filter labels by search string @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 [PaginatedpythonPythonDistributionResponseList]

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

List python distributions

Pulp Python Distributions are used to distribute Python content from Python Repositories or Python Publications.  Pulp Python Distributions should not be confused with \&quot;Python Distribution\&quot; as defined by the Python community. In Pulp usage, Python content is referred to as Python Package Content.

@param [Hash] opts the optional parameters @option opts [String] :base_path @option opts [String] :base_path__contains Filter results where base_path contains value @option opts [String] :base_path__icontains Filter results where base_path contains value @option opts [Array<String>] :base_path__in Filter results where base_path is in a comma-separated list of values @option opts [Integer] :limit Number of results to return per page. @option opts [String] :name @option opts [String] :name__contains Filter results where name contains value @option opts [String] :name__icontains Filter results where name contains value @option opts [Array<String>] :name__in Filter results where name is in a comma-separated list of values @option opts [String] :name__startswith Filter results where name starts with value @option opts [Integer] :offset The initial index from which to return the results. @option opts [String] :ordering Which field to use when ordering the results. @option opts [String] :pulp_label_select Filter labels by search string @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<(PaginatedpythonPythonDistributionResponseList, Integer, Hash)>] PaginatedpythonPythonDistributionResponseList data, response status code and response headers

# File lib/pulp_python_client/api/distributions_pypi_api.rb, line 191
def list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DistributionsPypiApi.list ...'
  end
  # resource path
  local_var_path = '/pulp/api/v3/distributions/python/pypi/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'base_path'] = opts[:'base_path'] if !opts[:'base_path'].nil?
  query_params[:'base_path__contains'] = opts[:'base_path__contains'] if !opts[:'base_path__contains'].nil?
  query_params[:'base_path__icontains'] = opts[:'base_path__icontains'] if !opts[:'base_path__icontains'].nil?
  query_params[:'base_path__in'] = @api_client.build_collection_param(opts[:'base_path__in'], :csv) if !opts[:'base_path__in'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'name__contains'] = opts[:'name__contains'] if !opts[:'name__contains'].nil?
  query_params[:'name__icontains'] = opts[:'name__icontains'] if !opts[:'name__icontains'].nil?
  query_params[:'name__in'] = @api_client.build_collection_param(opts[:'name__in'], :csv) if !opts[:'name__in'].nil?
  query_params[:'name__startswith'] = opts[:'name__startswith'] if !opts[:'name__startswith'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'ordering'] = opts[:'ordering'] if !opts[:'ordering'].nil?
  query_params[:'pulp_label_select'] = opts[:'pulp_label_select'] if !opts[:'pulp_label_select'].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] || 'PaginatedpythonPythonDistributionResponseList' 

  # 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: DistributionsPypiApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
partial_update(python_python_distribution_href, patchedpython_python_distribution, opts = {}) click to toggle source

Update a python distribution Trigger an asynchronous partial update task @param python_python_distribution_href [String] @param patchedpython_python_distribution [PatchedpythonPythonDistribution] @param [Hash] opts the optional parameters @return [AsyncOperationResponse]

# File lib/pulp_python_client/api/distributions_pypi_api.rb, line 255
def partial_update(python_python_distribution_href, patchedpython_python_distribution, opts = {})
  data, _status_code, _headers = partial_update_with_http_info(python_python_distribution_href, patchedpython_python_distribution, opts)
  data
end
partial_update_with_http_info(python_python_distribution_href, patchedpython_python_distribution, opts = {}) click to toggle source

Update a python distribution Trigger an asynchronous partial update task @param python_python_distribution_href [String] @param patchedpython_python_distribution [PatchedpythonPythonDistribution] @param [Hash] opts the optional parameters @return [Array<(AsyncOperationResponse, Integer, Hash)>] AsyncOperationResponse data, response status code and response headers

# File lib/pulp_python_client/api/distributions_pypi_api.rb, line 266
def partial_update_with_http_info(python_python_distribution_href, patchedpython_python_distribution, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DistributionsPypiApi.partial_update ...'
  end
  # verify the required parameter 'python_python_distribution_href' is set
  if @api_client.config.client_side_validation && python_python_distribution_href.nil?
    fail ArgumentError, "Missing the required parameter 'python_python_distribution_href' when calling DistributionsPypiApi.partial_update"
  end
  # verify the required parameter 'patchedpython_python_distribution' is set
  if @api_client.config.client_side_validation && patchedpython_python_distribution.nil?
    fail ArgumentError, "Missing the required parameter 'patchedpython_python_distribution' when calling DistributionsPypiApi.partial_update"
  end
  # resource path
  local_var_path = '{python_python_distribution_href}'.sub('{' + 'python_python_distribution_href' + '}', CGI.escape(python_python_distribution_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(patchedpython_python_distribution) 

  # 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(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DistributionsPypiApi#partial_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
read(python_python_distribution_href, opts = {}) click to toggle source

Inspect a python distribution

Pulp Python Distributions are used to distribute Python content from Python Repositories or Python Publications.  Pulp Python Distributions should not be confused with \"Python Distribution\" as defined by the Python community. In Pulp usage, Python content is referred to as Python Package Content.

@param python_python_distribution_href [String] @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 [PythonPythonDistributionResponse]

# File lib/pulp_python_client/api/distributions_pypi_api.rb, line 326
def read(python_python_distribution_href, opts = {})
  data, _status_code, _headers = read_with_http_info(python_python_distribution_href, opts)
  data
end
read_with_http_info(python_python_distribution_href, opts = {}) click to toggle source

Inspect a python distribution

Pulp Python Distributions are used to distribute Python content from Python Repositories or Python Publications.  Pulp Python Distributions should not be confused with \&quot;Python Distribution\&quot; as defined by the Python community. In Pulp usage, Python content is referred to as Python Package Content.

@param python_python_distribution_href [String] @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<(PythonPythonDistributionResponse, Integer, Hash)>] PythonPythonDistributionResponse data, response status code and response headers

# File lib/pulp_python_client/api/distributions_pypi_api.rb, line 338
def read_with_http_info(python_python_distribution_href, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DistributionsPypiApi.read ...'
  end
  # verify the required parameter 'python_python_distribution_href' is set
  if @api_client.config.client_side_validation && python_python_distribution_href.nil?
    fail ArgumentError, "Missing the required parameter 'python_python_distribution_href' when calling DistributionsPypiApi.read"
  end
  # resource path
  local_var_path = '{python_python_distribution_href}'.sub('{' + 'python_python_distribution_href' + '}', CGI.escape(python_python_distribution_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] || 'PythonPythonDistributionResponse' 

  # 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: DistributionsPypiApi#read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
update(python_python_distribution_href, python_python_distribution, opts = {}) click to toggle source

Update a python distribution Trigger an asynchronous update task @param python_python_distribution_href [String] @param python_python_distribution [PythonPythonDistribution] @param [Hash] opts the optional parameters @return [AsyncOperationResponse]

# File lib/pulp_python_client/api/distributions_pypi_api.rb, line 393
def update(python_python_distribution_href, python_python_distribution, opts = {})
  data, _status_code, _headers = update_with_http_info(python_python_distribution_href, python_python_distribution, opts)
  data
end
update_with_http_info(python_python_distribution_href, python_python_distribution, opts = {}) click to toggle source

Update a python distribution Trigger an asynchronous update task @param python_python_distribution_href [String] @param python_python_distribution [PythonPythonDistribution] @param [Hash] opts the optional parameters @return [Array<(AsyncOperationResponse, Integer, Hash)>] AsyncOperationResponse data, response status code and response headers

# File lib/pulp_python_client/api/distributions_pypi_api.rb, line 404
def update_with_http_info(python_python_distribution_href, python_python_distribution, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DistributionsPypiApi.update ...'
  end
  # verify the required parameter 'python_python_distribution_href' is set
  if @api_client.config.client_side_validation && python_python_distribution_href.nil?
    fail ArgumentError, "Missing the required parameter 'python_python_distribution_href' when calling DistributionsPypiApi.update"
  end
  # verify the required parameter 'python_python_distribution' is set
  if @api_client.config.client_side_validation && python_python_distribution.nil?
    fail ArgumentError, "Missing the required parameter 'python_python_distribution' when calling DistributionsPypiApi.update"
  end
  # resource path
  local_var_path = '{python_python_distribution_href}'.sub('{' + 'python_python_distribution_href' + '}', CGI.escape(python_python_distribution_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(python_python_distribution) 

  # 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(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DistributionsPypiApi#update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end