class PulpPythonClient::RemotesPythonApi
Attributes
Public Class Methods
# File lib/pulp_python_client/api/remotes_python_api.rb, line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Create a python remote
Python Remotes are representations of an external repository of Python content, eg. PyPI. Fields include upstream repository config. Python Remotes are also used to `sync` from upstream repositories, and contains sync settings.
@param python_python_remote [PythonPythonRemote] @param [Hash] opts the optional parameters @return [PythonPythonRemoteResponse]
# File lib/pulp_python_client/api/remotes_python_api.rb, line 27 def create(python_python_remote, opts = {}) data, _status_code, _headers = create_with_http_info(python_python_remote, opts) data end
Create a python remote
Python Remotes are representations of an external repository of Python content, eg. PyPI. Fields include upstream repository config. Python Remotes are also used to `sync` from upstream repositories, and contains sync settings.
@param python_python_remote [PythonPythonRemote] @param [Hash] opts the optional parameters @return [Array<(PythonPythonRemoteResponse
, Integer, Hash)>] PythonPythonRemoteResponse
data, response status code and response headers
# File lib/pulp_python_client/api/remotes_python_api.rb, line 37 def create_with_http_info(python_python_remote, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: RemotesPythonApi.create ...' end # verify the required parameter 'python_python_remote' is set if @api_client.config.client_side_validation && python_python_remote.nil? fail ArgumentError, "Missing the required parameter 'python_python_remote' when calling RemotesPythonApi.create" end # resource path local_var_path = '/pulp/api/v3/remotes/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_remote) # return_type return_type = opts[:return_type] || 'PythonPythonRemoteResponse' # 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: RemotesPythonApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete a python remote Trigger an asynchronous delete task @param python_python_remote_href [String] @param [Hash] opts the optional parameters @return [AsyncOperationResponse]
# File lib/pulp_python_client/api/remotes_python_api.rb, line 91 def delete(python_python_remote_href, opts = {}) data, _status_code, _headers = delete_with_http_info(python_python_remote_href, opts) data end
Delete a python remote Trigger an asynchronous delete task @param python_python_remote_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/remotes_python_api.rb, line 101 def delete_with_http_info(python_python_remote_href, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: RemotesPythonApi.delete ...' end # verify the required parameter 'python_python_remote_href' is set if @api_client.config.client_side_validation && python_python_remote_href.nil? fail ArgumentError, "Missing the required parameter 'python_python_remote_href' when calling RemotesPythonApi.delete" end # resource path local_var_path = '{python_python_remote_href}'.sub('{' + 'python_python_remote_href' + '}', CGI.escape(python_python_remote_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: RemotesPythonApi#delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Create from Bandersnatch
Takes the fields specified in the Bandersnatch config and creates a Python Remote from it.
@param config [File] A Bandersnatch config that may be used to construct a Python Remote. @param name [String] A unique name for this remote @param [Hash] opts the optional parameters @option opts [PolicyEnum] :policy The policy to use when downloading content. The possible values include: 'immediate', 'on_demand', and 'streamed'. 'on_demand' is the default. @return [PythonPythonRemoteResponse]
# File lib/pulp_python_client/api/remotes_python_api.rb, line 155 def from_bandersnatch(config, name, opts = {}) data, _status_code, _headers = from_bandersnatch_with_http_info(config, name, opts) data end
Create from Bandersnatch
Takes the fields specified in the Bandersnatch config and creates a Python Remote from it.
@param config [File] A Bandersnatch config that may be used to construct a Python Remote. @param name [String] A unique name for this remote @param [Hash] opts the optional parameters @option opts [PolicyEnum] :policy The policy to use when downloading content. The possible values include: 'immediate', 'on_demand', and 'streamed'. 'on_demand' is the default. @return [Array<(PythonPythonRemoteResponse
, Integer, Hash)>] PythonPythonRemoteResponse
data, response status code and response headers
# File lib/pulp_python_client/api/remotes_python_api.rb, line 167 def from_bandersnatch_with_http_info(config, name, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: RemotesPythonApi.from_bandersnatch ...' end # verify the required parameter 'config' is set if @api_client.config.client_side_validation && config.nil? fail ArgumentError, "Missing the required parameter 'config' when calling RemotesPythonApi.from_bandersnatch" end # verify the required parameter 'name' is set if @api_client.config.client_side_validation && name.nil? fail ArgumentError, "Missing the required parameter 'name' when calling RemotesPythonApi.from_bandersnatch" end # resource path local_var_path = '/pulp/api/v3/remotes/python/python/from_bandersnatch/' # 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']) # form parameters form_params = opts[:form_params] || {} form_params['config'] = config form_params['name'] = name form_params['policy'] = opts[:'policy'] if !opts[:'policy'].nil? # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'PythonPythonRemoteResponse' # 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: RemotesPythonApi#from_bandersnatch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
List python remotes
Python Remotes are representations of an external repository of Python content, eg. PyPI. Fields include upstream repository config. Python Remotes are also used to `sync` from upstream repositories, and contains sync settings.
@param [Hash] opts the optional parameters @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 [DateTime] :pulp_last_updated ISO 8601 formatted dates are supported @option opts [DateTime] :pulp_last_updated__gt Filter results where pulp_last_updated is greater than value @option opts [DateTime] :pulp_last_updated__gte Filter results where pulp_last_updated is greater than or equal to value @option opts [DateTime] :pulp_last_updated__lt Filter results where pulp_last_updated is less than value @option opts [DateTime] :pulp_last_updated__lte Filter results where pulp_last_updated is less than or equal to value @option opts [Array<DateTime>] :pulp_last_updated__range Filter results where pulp_last_updated is between two comma separated values @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 [PaginatedpythonPythonRemoteResponseList]
# File lib/pulp_python_client/api/remotes_python_api.rb, line 244 def list(opts = {}) data, _status_code, _headers = list_with_http_info(opts) data end
List python remotes
Python Remotes are representations of an external repository of Python content, eg. PyPI. Fields include upstream repository config. Python Remotes are also used to `sync` from upstream repositories, and contains sync settings.
@param [Hash] opts the optional parameters @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 [DateTime] :pulp_last_updated ISO 8601 formatted dates are supported @option opts [DateTime] :pulp_last_updated__gt Filter results where pulp_last_updated is greater than value @option opts [DateTime] :pulp_last_updated__gte Filter results where pulp_last_updated is greater than or equal to value @option opts [DateTime] :pulp_last_updated__lt Filter results where pulp_last_updated is less than value @option opts [DateTime] :pulp_last_updated__lte Filter results where pulp_last_updated is less than or equal to value @option opts [Array<DateTime>] :pulp_last_updated__range Filter results where pulp_last_updated is between two comma separated values @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<(PaginatedpythonPythonRemoteResponseList
, Integer, Hash)>] PaginatedpythonPythonRemoteResponseList
data, response status code and response headers
# File lib/pulp_python_client/api/remotes_python_api.rb, line 270 def list_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: RemotesPythonApi.list ...' end # resource path local_var_path = '/pulp/api/v3/remotes/python/python/' # query parameters query_params = opts[:query_params] || {} 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[:'pulp_last_updated'] = opts[:'pulp_last_updated'] if !opts[:'pulp_last_updated'].nil? query_params[:'pulp_last_updated__gt'] = opts[:'pulp_last_updated__gt'] if !opts[:'pulp_last_updated__gt'].nil? query_params[:'pulp_last_updated__gte'] = opts[:'pulp_last_updated__gte'] if !opts[:'pulp_last_updated__gte'].nil? query_params[:'pulp_last_updated__lt'] = opts[:'pulp_last_updated__lt'] if !opts[:'pulp_last_updated__lt'].nil? query_params[:'pulp_last_updated__lte'] = opts[:'pulp_last_updated__lte'] if !opts[:'pulp_last_updated__lte'].nil? query_params[:'pulp_last_updated__range'] = @api_client.build_collection_param(opts[:'pulp_last_updated__range'], :csv) if !opts[:'pulp_last_updated__range'].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] || 'PaginatedpythonPythonRemoteResponseList' # 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: RemotesPythonApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Update a python remote Trigger an asynchronous partial update task @param python_python_remote_href [String] @param patchedpython_python_remote [PatchedpythonPythonRemote] @param [Hash] opts the optional parameters @return [AsyncOperationResponse]
# File lib/pulp_python_client/api/remotes_python_api.rb, line 336 def partial_update(python_python_remote_href, patchedpython_python_remote, opts = {}) data, _status_code, _headers = partial_update_with_http_info(python_python_remote_href, patchedpython_python_remote, opts) data end
Update a python remote Trigger an asynchronous partial update task @param python_python_remote_href [String] @param patchedpython_python_remote [PatchedpythonPythonRemote] @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/remotes_python_api.rb, line 347 def partial_update_with_http_info(python_python_remote_href, patchedpython_python_remote, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: RemotesPythonApi.partial_update ...' end # verify the required parameter 'python_python_remote_href' is set if @api_client.config.client_side_validation && python_python_remote_href.nil? fail ArgumentError, "Missing the required parameter 'python_python_remote_href' when calling RemotesPythonApi.partial_update" end # verify the required parameter 'patchedpython_python_remote' is set if @api_client.config.client_side_validation && patchedpython_python_remote.nil? fail ArgumentError, "Missing the required parameter 'patchedpython_python_remote' when calling RemotesPythonApi.partial_update" end # resource path local_var_path = '{python_python_remote_href}'.sub('{' + 'python_python_remote_href' + '}', CGI.escape(python_python_remote_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_remote) # 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: RemotesPythonApi#partial_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Inspect a python remote
Python Remotes are representations of an external repository of Python content, eg. PyPI. Fields include upstream repository config. Python Remotes are also used to `sync` from upstream repositories, and contains sync settings.
@param python_python_remote_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 [PythonPythonRemoteResponse]
# File lib/pulp_python_client/api/remotes_python_api.rb, line 407 def read(python_python_remote_href, opts = {}) data, _status_code, _headers = read_with_http_info(python_python_remote_href, opts) data end
Inspect a python remote
Python Remotes are representations of an external repository of Python content, eg. PyPI. Fields include upstream repository config. Python Remotes are also used to `sync` from upstream repositories, and contains sync settings.
@param python_python_remote_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<(PythonPythonRemoteResponse
, Integer, Hash)>] PythonPythonRemoteResponse
data, response status code and response headers
# File lib/pulp_python_client/api/remotes_python_api.rb, line 419 def read_with_http_info(python_python_remote_href, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: RemotesPythonApi.read ...' end # verify the required parameter 'python_python_remote_href' is set if @api_client.config.client_side_validation && python_python_remote_href.nil? fail ArgumentError, "Missing the required parameter 'python_python_remote_href' when calling RemotesPythonApi.read" end # resource path local_var_path = '{python_python_remote_href}'.sub('{' + 'python_python_remote_href' + '}', CGI.escape(python_python_remote_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] || 'PythonPythonRemoteResponse' # 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: RemotesPythonApi#read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Update a python remote Trigger an asynchronous update task @param python_python_remote_href [String] @param python_python_remote [PythonPythonRemote] @param [Hash] opts the optional parameters @return [AsyncOperationResponse]
# File lib/pulp_python_client/api/remotes_python_api.rb, line 474 def update(python_python_remote_href, python_python_remote, opts = {}) data, _status_code, _headers = update_with_http_info(python_python_remote_href, python_python_remote, opts) data end
Update a python remote Trigger an asynchronous update task @param python_python_remote_href [String] @param python_python_remote [PythonPythonRemote] @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/remotes_python_api.rb, line 485 def update_with_http_info(python_python_remote_href, python_python_remote, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: RemotesPythonApi.update ...' end # verify the required parameter 'python_python_remote_href' is set if @api_client.config.client_side_validation && python_python_remote_href.nil? fail ArgumentError, "Missing the required parameter 'python_python_remote_href' when calling RemotesPythonApi.update" end # verify the required parameter 'python_python_remote' is set if @api_client.config.client_side_validation && python_python_remote.nil? fail ArgumentError, "Missing the required parameter 'python_python_remote' when calling RemotesPythonApi.update" end # resource path local_var_path = '{python_python_remote_href}'.sub('{' + 'python_python_remote_href' + '}', CGI.escape(python_python_remote_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_remote) # 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: RemotesPythonApi#update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end