class PulpPythonClient::RepositoriesPythonApi

Attributes

api_client[RW]

Public Class Methods

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

Public Instance Methods

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

Create a python repository PythonRepository represents a single Python repository, to which content can be synced, added, or removed. @param python_python_repository [PythonPythonRepository] @param [Hash] opts the optional parameters @return [PythonPythonRepositoryResponse]

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

Create a python repository PythonRepository represents a single Python repository, to which content can be synced, added, or removed. @param python_python_repository [PythonPythonRepository] @param [Hash] opts the optional parameters @return [Array<(PythonPythonRepositoryResponse, Integer, Hash)>] PythonPythonRepositoryResponse data, response status code and response headers

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

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

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

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

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

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

Delete a python repository Trigger an asynchronous delete task @param python_python_repository_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/repositories_python_api.rb, line 101
def delete_with_http_info(python_python_repository_href, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RepositoriesPythonApi.delete ...'
  end
  # verify the required parameter 'python_python_repository_href' is set
  if @api_client.config.client_side_validation && python_python_repository_href.nil?
    fail ArgumentError, "Missing the required parameter 'python_python_repository_href' when calling RepositoriesPythonApi.delete"
  end
  # resource path
  local_var_path = '{python_python_repository_href}'.sub('{' + 'python_python_repository_href' + '}', CGI.escape(python_python_repository_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: RepositoriesPythonApi#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 repositorys PythonRepository represents a single Python repository, to which content can be synced, added, or removed. @param [Hash] opts the optional parameters @option opts [String] :latest_with_content Content Unit referenced by HREF @option opts [Integer] :limit Number of results to return per page. @option opts [String] :name Filter results where name matches value @option opts [String] :name__contains Filter results where name contains value @option opts [String] :name__icontains Filter results where name contains value @option opts [String] :name__iexact Filter results where name matches value @option opts [Array<String>] :name__in Filter results where name is in a comma-separated list of values @option opts [String] :name__iregex Filter results where name matches regex value @option opts [String] :name__istartswith Filter results where name starts with value @option opts [String] :name__regex Filter results where name matches regex value @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 [Array<String>] :ordering 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;pulp_type&#x60; - Pulp type * &#x60;-pulp_type&#x60; - Pulp type (descending) * &#x60;name&#x60; - Name * &#x60;-name&#x60; - Name (descending) * &#x60;pulp_labels&#x60; - Pulp labels * &#x60;-pulp_labels&#x60; - Pulp labels (descending) * &#x60;description&#x60; - Description * &#x60;-description&#x60; - Description (descending) * &#x60;next_version&#x60; - Next version * &#x60;-next_version&#x60; - Next version (descending) * &#x60;retain_repo_versions&#x60; - Retain repo versions * &#x60;-retain_repo_versions&#x60; - Retain repo versions (descending) * &#x60;user_hidden&#x60; - User hidden * &#x60;-user_hidden&#x60; - User hidden (descending) * &#x60;pk&#x60; - Pk * &#x60;-pk&#x60; - Pk (descending) @option opts [Array<String>] :pulp_href__in Multiple values may be separated by commas. @option opts [Array<String>] :pulp_id__in Multiple values may be separated by commas. @option opts [String] :pulp_label_select Filter labels by search string @option opts [String] :q @option opts [String] :remote Foreign Key referenced by HREF @option opts [Integer] :retain_repo_versions Filter results where retain_repo_versions matches value @option opts [Integer] :retain_repo_versions__gt Filter results where retain_repo_versions is greater than value @option opts [Integer] :retain_repo_versions__gte Filter results where retain_repo_versions is greater than or equal to value @option opts [Boolean] :retain_repo_versions__isnull Filter results where retain_repo_versions has a null value @option opts [Integer] :retain_repo_versions__lt Filter results where retain_repo_versions is less than value @option opts [Integer] :retain_repo_versions__lte Filter results where retain_repo_versions is less than or equal to value @option opts [Integer] :retain_repo_versions__ne Filter results where retain_repo_versions not equal to value @option opts [Array<Integer>] :retain_repo_versions__range Filter results where retain_repo_versions is between two comma separated values @option opts [String] :with_content Content Unit referenced by HREF @option opts [Array<String>] :fields A list of fields to include in the response. @option opts [Array<String>] :exclude_fields A list of fields to exclude from the response. @return [PaginatedpythonPythonRepositoryResponseList]

# File lib/pulp_python_client/api/repositories_python_api.rb, line 181
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 repositorys PythonRepository represents a single Python repository, to which content can be synced, added, or removed. @param [Hash] opts the optional parameters @option opts [String] :latest_with_content Content Unit referenced by HREF @option opts [Integer] :limit Number of results to return per page. @option opts [String] :name Filter results where name matches value @option opts [String] :name__contains Filter results where name contains value @option opts [String] :name__icontains Filter results where name contains value @option opts [String] :name__iexact Filter results where name matches value @option opts [Array<String>] :name__in Filter results where name is in a comma-separated list of values @option opts [String] :name__iregex Filter results where name matches regex value @option opts [String] :name__istartswith Filter results where name starts with value @option opts [String] :name__regex Filter results where name matches regex value @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 [Array<String>] :ordering 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;pulp_type&#x60; - Pulp type * &#x60;-pulp_type&#x60; - Pulp type (descending) * &#x60;name&#x60; - Name * &#x60;-name&#x60; - Name (descending) * &#x60;pulp_labels&#x60; - Pulp labels * &#x60;-pulp_labels&#x60; - Pulp labels (descending) * &#x60;description&#x60; - Description * &#x60;-description&#x60; - Description (descending) * &#x60;next_version&#x60; - Next version * &#x60;-next_version&#x60; - Next version (descending) * &#x60;retain_repo_versions&#x60; - Retain repo versions * &#x60;-retain_repo_versions&#x60; - Retain repo versions (descending) * &#x60;user_hidden&#x60; - User hidden * &#x60;-user_hidden&#x60; - User hidden (descending) * &#x60;pk&#x60; - Pk * &#x60;-pk&#x60; - Pk (descending) @option opts [Array<String>] :pulp_href__in Multiple values may be separated by commas. @option opts [Array<String>] :pulp_id__in Multiple values may be separated by commas. @option opts [String] :pulp_label_select Filter labels by search string @option opts [String] :q @option opts [String] :remote Foreign Key referenced by HREF @option opts [Integer] :retain_repo_versions Filter results where retain_repo_versions matches value @option opts [Integer] :retain_repo_versions__gt Filter results where retain_repo_versions is greater than value @option opts [Integer] :retain_repo_versions__gte Filter results where retain_repo_versions is greater than or equal to value @option opts [Boolean] :retain_repo_versions__isnull Filter results where retain_repo_versions has a null value @option opts [Integer] :retain_repo_versions__lt Filter results where retain_repo_versions is less than value @option opts [Integer] :retain_repo_versions__lte Filter results where retain_repo_versions is less than or equal to value @option opts [Integer] :retain_repo_versions__ne Filter results where retain_repo_versions not equal to value @option opts [Array<Integer>] :retain_repo_versions__range Filter results where retain_repo_versions is between two comma separated values @option opts [String] :with_content Content Unit referenced by HREF @option opts [Array<String>] :fields A list of fields to include in the response. @option opts [Array<String>] :exclude_fields A list of fields to exclude from the response. @return [Array<(PaginatedpythonPythonRepositoryResponseList, Integer, Hash)>] PaginatedpythonPythonRepositoryResponseList data, response status code and response headers

# File lib/pulp_python_client/api/repositories_python_api.rb, line 219
def list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RepositoriesPythonApi.list ...'
  end
  allowable_values = ["-description", "-name", "-next_version", "-pk", "-pulp_created", "-pulp_id", "-pulp_labels", "-pulp_last_updated", "-pulp_type", "-retain_repo_versions", "-user_hidden", "description", "name", "next_version", "pk", "pulp_created", "pulp_id", "pulp_labels", "pulp_last_updated", "pulp_type", "retain_repo_versions", "user_hidden"]
  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/repositories/python/python/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'latest_with_content'] = opts[:'latest_with_content'] if !opts[:'latest_with_content'].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__iexact'] = opts[:'name__iexact'] if !opts[:'name__iexact'].nil?
  query_params[:'name__in'] = @api_client.build_collection_param(opts[:'name__in'], :csv) if !opts[:'name__in'].nil?
  query_params[:'name__iregex'] = opts[:'name__iregex'] if !opts[:'name__iregex'].nil?
  query_params[:'name__istartswith'] = opts[:'name__istartswith'] if !opts[:'name__istartswith'].nil?
  query_params[:'name__regex'] = opts[:'name__regex'] if !opts[:'name__regex'].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'] = @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[:'pulp_label_select'] = opts[:'pulp_label_select'] if !opts[:'pulp_label_select'].nil?
  query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
  query_params[:'remote'] = opts[:'remote'] if !opts[:'remote'].nil?
  query_params[:'retain_repo_versions'] = opts[:'retain_repo_versions'] if !opts[:'retain_repo_versions'].nil?
  query_params[:'retain_repo_versions__gt'] = opts[:'retain_repo_versions__gt'] if !opts[:'retain_repo_versions__gt'].nil?
  query_params[:'retain_repo_versions__gte'] = opts[:'retain_repo_versions__gte'] if !opts[:'retain_repo_versions__gte'].nil?
  query_params[:'retain_repo_versions__isnull'] = opts[:'retain_repo_versions__isnull'] if !opts[:'retain_repo_versions__isnull'].nil?
  query_params[:'retain_repo_versions__lt'] = opts[:'retain_repo_versions__lt'] if !opts[:'retain_repo_versions__lt'].nil?
  query_params[:'retain_repo_versions__lte'] = opts[:'retain_repo_versions__lte'] if !opts[:'retain_repo_versions__lte'].nil?
  query_params[:'retain_repo_versions__ne'] = opts[:'retain_repo_versions__ne'] if !opts[:'retain_repo_versions__ne'].nil?
  query_params[:'retain_repo_versions__range'] = @api_client.build_collection_param(opts[:'retain_repo_versions__range'], :csv) if !opts[:'retain_repo_versions__range'].nil?
  query_params[:'with_content'] = opts[:'with_content'] if !opts[:'with_content'].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] || 'PaginatedpythonPythonRepositoryResponseList' 

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

Modify Repository Content Trigger an asynchronous task to create a new repository version. @param python_python_repository_href [String] @param repository_add_remove_content [RepositoryAddRemoveContent] @param [Hash] opts the optional parameters @return [AsyncOperationResponse]

# File lib/pulp_python_client/api/repositories_python_api.rb, line 301
def modify(python_python_repository_href, repository_add_remove_content, opts = {})
  data, _status_code, _headers = modify_with_http_info(python_python_repository_href, repository_add_remove_content, opts)
  data
end
modify_with_http_info(python_python_repository_href, repository_add_remove_content, opts = {}) click to toggle source

Modify Repository Content Trigger an asynchronous task to create a new repository version. @param python_python_repository_href [String] @param repository_add_remove_content [RepositoryAddRemoveContent] @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/repositories_python_api.rb, line 312
def modify_with_http_info(python_python_repository_href, repository_add_remove_content, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RepositoriesPythonApi.modify ...'
  end
  # verify the required parameter 'python_python_repository_href' is set
  if @api_client.config.client_side_validation && python_python_repository_href.nil?
    fail ArgumentError, "Missing the required parameter 'python_python_repository_href' when calling RepositoriesPythonApi.modify"
  end
  # verify the required parameter 'repository_add_remove_content' is set
  if @api_client.config.client_side_validation && repository_add_remove_content.nil?
    fail ArgumentError, "Missing the required parameter 'repository_add_remove_content' when calling RepositoriesPythonApi.modify"
  end
  # resource path
  local_var_path = '{python_python_repository_href}modify/'.sub('{' + 'python_python_repository_href' + '}', CGI.escape(python_python_repository_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(repository_add_remove_content) 

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

Update a python repository Trigger an asynchronous partial update task @param python_python_repository_href [String] @param patchedpython_python_repository [PatchedpythonPythonRepository] @param [Hash] opts the optional parameters @return [AsyncOperationResponse]

# File lib/pulp_python_client/api/repositories_python_api.rb, line 371
def partial_update(python_python_repository_href, patchedpython_python_repository, opts = {})
  data, _status_code, _headers = partial_update_with_http_info(python_python_repository_href, patchedpython_python_repository, opts)
  data
end
partial_update_with_http_info(python_python_repository_href, patchedpython_python_repository, opts = {}) click to toggle source

Update a python repository Trigger an asynchronous partial update task @param python_python_repository_href [String] @param patchedpython_python_repository [PatchedpythonPythonRepository] @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/repositories_python_api.rb, line 382
def partial_update_with_http_info(python_python_repository_href, patchedpython_python_repository, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RepositoriesPythonApi.partial_update ...'
  end
  # verify the required parameter 'python_python_repository_href' is set
  if @api_client.config.client_side_validation && python_python_repository_href.nil?
    fail ArgumentError, "Missing the required parameter 'python_python_repository_href' when calling RepositoriesPythonApi.partial_update"
  end
  # verify the required parameter 'patchedpython_python_repository' is set
  if @api_client.config.client_side_validation && patchedpython_python_repository.nil?
    fail ArgumentError, "Missing the required parameter 'patchedpython_python_repository' when calling RepositoriesPythonApi.partial_update"
  end
  # resource path
  local_var_path = '{python_python_repository_href}'.sub('{' + 'python_python_repository_href' + '}', CGI.escape(python_python_repository_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_repository) 

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

Inspect a python repository PythonRepository represents a single Python repository, to which content can be synced, added, or removed. @param python_python_repository_href [String] @param [Hash] opts the optional parameters @option opts [Array<String>] :fields A list of fields to include in the response. @option opts [Array<String>] :exclude_fields A list of fields to exclude from the response. @return [PythonPythonRepositoryResponse]

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

Inspect a python repository PythonRepository represents a single Python repository, to which content can be synced, added, or removed. @param python_python_repository_href [String] @param [Hash] opts the optional parameters @option opts [Array<String>] :fields A list of fields to include in the response. @option opts [Array<String>] :exclude_fields A list of fields to exclude from the response. @return [Array<(PythonPythonRepositoryResponse, Integer, Hash)>] PythonPythonRepositoryResponse data, response status code and response headers

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

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

Set a label Set a single pulp_label on the object to a specific value or null. @param python_python_repository_href [String] @param set_label [SetLabel] @param [Hash] opts the optional parameters @return [SetLabelResponse]

# File lib/pulp_python_client/api/repositories_python_api.rb, line 509
def set_label(python_python_repository_href, set_label, opts = {})
  data, _status_code, _headers = set_label_with_http_info(python_python_repository_href, set_label, opts)
  data
end
set_label_with_http_info(python_python_repository_href, set_label, opts = {}) click to toggle source

Set a label Set a single pulp_label on the object to a specific value or null. @param python_python_repository_href [String] @param set_label [SetLabel] @param [Hash] opts the optional parameters @return [Array<(SetLabelResponse, Integer, Hash)>] SetLabelResponse data, response status code and response headers

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

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

  # 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: RepositoriesPythonApi#set_label\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
sync(python_python_repository_href, repository_sync_url, opts = {}) click to toggle source

Sync from remote

Trigger an asynchronous task to sync python content. The sync task will retrieve Python content from the specified `Remote` and update the specified `Respository`, creating a new  `RepositoryVersion`.

@param python_python_repository_href [String] @param repository_sync_url [RepositorySyncURL] @param [Hash] opts the optional parameters @return [AsyncOperationResponse]

# File lib/pulp_python_client/api/repositories_python_api.rb, line 579
def sync(python_python_repository_href, repository_sync_url, opts = {})
  data, _status_code, _headers = sync_with_http_info(python_python_repository_href, repository_sync_url, opts)
  data
end
sync_with_http_info(python_python_repository_href, repository_sync_url, opts = {}) click to toggle source

Sync from remote

Trigger an asynchronous task to sync python content. The sync task will retrieve Python content from the specified &#x60;Remote&#x60; and update the specified &#x60;Respository&#x60;, creating a new  &#x60;RepositoryVersion&#x60;.

@param python_python_repository_href [String] @param repository_sync_url [RepositorySyncURL] @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/repositories_python_api.rb, line 590
def sync_with_http_info(python_python_repository_href, repository_sync_url, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RepositoriesPythonApi.sync ...'
  end
  # verify the required parameter 'python_python_repository_href' is set
  if @api_client.config.client_side_validation && python_python_repository_href.nil?
    fail ArgumentError, "Missing the required parameter 'python_python_repository_href' when calling RepositoriesPythonApi.sync"
  end
  # verify the required parameter 'repository_sync_url' is set
  if @api_client.config.client_side_validation && repository_sync_url.nil?
    fail ArgumentError, "Missing the required parameter 'repository_sync_url' when calling RepositoriesPythonApi.sync"
  end
  # resource path
  local_var_path = '{python_python_repository_href}sync/'.sub('{' + 'python_python_repository_href' + '}', CGI.escape(python_python_repository_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(repository_sync_url) 

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

Unset a label Unset a single pulp_label on the object. @param python_python_repository_href [String] @param unset_label [UnsetLabel] @param [Hash] opts the optional parameters @return [UnsetLabelResponse]

# File lib/pulp_python_client/api/repositories_python_api.rb, line 649
def unset_label(python_python_repository_href, unset_label, opts = {})
  data, _status_code, _headers = unset_label_with_http_info(python_python_repository_href, unset_label, opts)
  data
end
unset_label_with_http_info(python_python_repository_href, unset_label, opts = {}) click to toggle source

Unset a label Unset a single pulp_label on the object. @param python_python_repository_href [String] @param unset_label [UnsetLabel] @param [Hash] opts the optional parameters @return [Array<(UnsetLabelResponse, Integer, Hash)>] UnsetLabelResponse data, response status code and response headers

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

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

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

Update a python repository Trigger an asynchronous update task @param python_python_repository_href [String] @param python_python_repository [PythonPythonRepository] @param [Hash] opts the optional parameters @return [AsyncOperationResponse]

# File lib/pulp_python_client/api/repositories_python_api.rb, line 719
def update(python_python_repository_href, python_python_repository, opts = {})
  data, _status_code, _headers = update_with_http_info(python_python_repository_href, python_python_repository, opts)
  data
end
update_with_http_info(python_python_repository_href, python_python_repository, opts = {}) click to toggle source

Update a python repository Trigger an asynchronous update task @param python_python_repository_href [String] @param python_python_repository [PythonPythonRepository] @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/repositories_python_api.rb, line 730
def update_with_http_info(python_python_repository_href, python_python_repository, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RepositoriesPythonApi.update ...'
  end
  # verify the required parameter 'python_python_repository_href' is set
  if @api_client.config.client_side_validation && python_python_repository_href.nil?
    fail ArgumentError, "Missing the required parameter 'python_python_repository_href' when calling RepositoriesPythonApi.update"
  end
  # verify the required parameter 'python_python_repository' is set
  if @api_client.config.client_side_validation && python_python_repository.nil?
    fail ArgumentError, "Missing the required parameter 'python_python_repository' when calling RepositoriesPythonApi.update"
  end
  # resource path
  local_var_path = '{python_python_repository_href}'.sub('{' + 'python_python_repository_href' + '}', CGI.escape(python_python_repository_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_repository) 

  # 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: RepositoriesPythonApi#update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end