Class: PulpPythonClient::ContentPackagesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/pulp_python_client/api/content_packages_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ContentPackagesApi

Returns a new instance of ContentPackagesApi.



19
20
21
 
# File 'lib/pulp_python_client/api/content_packages_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/pulp_python_client/api/content_packages_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create(relative_path, opts = {}) ⇒ AsyncOperationResponse

Create a python package content Trigger an asynchronous task to create content,optionally create new repository version.

Parameters:

  • relative_path (String) —

    Path where the artifact is located relative to distributions base_path

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :artifact (String) —

    Artifact file representing the physical content

  • :file (File) —

    An uploaded file that may be turned into the artifact of the content unit.

  • :repository (String) —

    A URI of a repository the new content unit should be associated with.

  • :sha256 (String) —

    The SHA256 digest of this package. (default to ”)

  • :summary (String) —

    A one-line summary of what the package does.

  • :description (String) —

    A longer description of the package that can run to several paragraphs.

  • :description_content_type (String) —

    A string stating the markup syntax (if any) used in the distribution’s description, so that tools can intelligently render the description.

  • :keywords (String) —

    Additional keywords to be used to assist searching for the package in a larger catalog.

  • :home_page (String) —

    The URL for the package's home page.

  • :download_url (String) —

    Legacy field denoting the URL from which this package can be downloaded.

  • :author (String) —

    Text containing the author's name. Contact information can also be added, separated with newlines.

  • :author_email (String) —

    The author's e-mail address.

  • :maintainer (String) —

    The maintainer's name at a minimum; additional contact information may be provided.

  • :maintainer_email (String) —

    The maintainer's e-mail address.

  • :license (String) —

    Text indicating the license covering the distribution

  • :requires_python (String) —

    The Python version(s) that the distribution is guaranteed to be compatible with.

  • :project_url (String) —

    A browsable URL for the project and a label for it, separated by a comma.

  • :project_urls (Object) —

    A dictionary of labels and URLs for the project.

  • :platform (String) —

    A comma-separated list of platform specifications, summarizing the operating systems supported by the package.

  • :supported_platform (String) —

    Field to specify the OS and CPU for which the binary package was compiled.

  • :requires_dist (Object) —

    A JSON list containing names of some other distutils project required by this distribution.

  • :provides_dist (Object) —

    A JSON list containing names of a Distutils project which is contained within this distribution.

  • :obsoletes_dist (Object) —

    A JSON list containing names of a distutils project's distribution which this distribution renders obsolete, meaning that the two projects should not be installed at the same time.

  • :requires_external (Object) —

    A JSON list containing some dependency in the system that the distribution is to be used.

  • :classifiers (Object) —

    A JSON list containing classification values for a Python package.

Returns:



52
53
54
55
 
# File 'lib/pulp_python_client/api/content_packages_api.rb', line 52

def create(relative_path, opts = {})
  data, _status_code, _headers = create_with_http_info(relative_path, opts)
  data
end

#create_with_http_info(relative_path, opts = {}) ⇒ Array<(AsyncOperationResponse, Integer, Hash)>

Create a python package content Trigger an asynchronous task to create content,optionally create new repository version.

Parameters:

  • relative_path (String) —

    Path where the artifact is located relative to distributions base_path

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :artifact (String) —

    Artifact file representing the physical content

  • :file (File) —

    An uploaded file that may be turned into the artifact of the content unit.

  • :repository (String) —

    A URI of a repository the new content unit should be associated with.

  • :sha256 (String) —

    The SHA256 digest of this package.

  • :summary (String) —

    A one-line summary of what the package does.

  • :description (String) —

    A longer description of the package that can run to several paragraphs.

  • :description_content_type (String) —

    A string stating the markup syntax (if any) used in the distribution’s description, so that tools can intelligently render the description.

  • :keywords (String) —

    Additional keywords to be used to assist searching for the package in a larger catalog.

  • :home_page (String) —

    The URL for the package&#39;s home page.

  • :download_url (String) —

    Legacy field denoting the URL from which this package can be downloaded.

  • :author (String) —

    Text containing the author&#39;s name. Contact information can also be added, separated with newlines.

  • :author_email (String) —

    The author&#39;s e-mail address.

  • :maintainer (String) —

    The maintainer&#39;s name at a minimum; additional contact information may be provided.

  • :maintainer_email (String) —

    The maintainer&#39;s e-mail address.

  • :license (String) —

    Text indicating the license covering the distribution

  • :requires_python (String) —

    The Python version(s) that the distribution is guaranteed to be compatible with.

  • :project_url (String) —

    A browsable URL for the project and a label for it, separated by a comma.

  • :project_urls (Object) —

    A dictionary of labels and URLs for the project.

  • :platform (String) —

    A comma-separated list of platform specifications, summarizing the operating systems supported by the package.

  • :supported_platform (String) —

    Field to specify the OS and CPU for which the binary package was compiled.

  • :requires_dist (Object) —

    A JSON list containing names of some other distutils project required by this distribution.

  • :provides_dist (Object) —

    A JSON list containing names of a Distutils project which is contained within this distribution.

  • :obsoletes_dist (Object) —

    A JSON list containing names of a distutils project&#39;s distribution which this distribution renders obsolete, meaning that the two projects should not be installed at the same time.

  • :requires_external (Object) —

    A JSON list containing some dependency in the system that the distribution is to be used.

  • :classifiers (Object) —

    A JSON list containing classification values for a Python package.

Returns:

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

    AsyncOperationResponse data, response status code and response headers



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/pulp_python_client/api/content_packages_api.rb', line 87

def create_with_http_info(relative_path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContentPackagesApi.create ...'
  end
  # verify the required parameter 'relative_path' is set
  if @api_client.config.client_side_validation && relative_path.nil?
    fail ArgumentError, "Missing the required parameter 'relative_path' when calling ContentPackagesApi.create"
  end
  if @api_client.config.client_side_validation && relative_path.to_s.length < 1
    fail ArgumentError, 'invalid value for "relative_path" when calling ContentPackagesApi.create, the character length must be great than or equal to 1.'
  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 ContentPackagesApi.create, the character length must be great than or equal to 1.'
  end

  # resource path
  local_var_path = '/pulp/api/v3/content/python/packages/'

  # 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['relative_path'] = relative_path
  form_params['artifact'] = opts[:'artifact'] if !opts[:'artifact'].nil?
  form_params['file'] = opts[:'file'] if !opts[:'file'].nil?
  form_params['repository'] = opts[:'repository'] if !opts[:'repository'].nil?
  form_params['sha256'] = opts[:'sha256'] if !opts[:'sha256'].nil?
  form_params['summary'] = opts[:'summary'] if !opts[:'summary'].nil?
  form_params['description'] = opts[:'description'] if !opts[:'description'].nil?
  form_params['description_content_type'] = opts[:'description_content_type'] if !opts[:'description_content_type'].nil?
  form_params['keywords'] = opts[:'keywords'] if !opts[:'keywords'].nil?
  form_params['home_page'] = opts[:'home_page'] if !opts[:'home_page'].nil?
  form_params['download_url'] = opts[:'download_url'] if !opts[:'download_url'].nil?
  form_params['author'] = opts[:'author'] if !opts[:'author'].nil?
  form_params['author_email'] = opts[:'author_email'] if !opts[:'author_email'].nil?
  form_params['maintainer'] = opts[:'maintainer'] if !opts[:'maintainer'].nil?
  form_params['maintainer_email'] = opts[:'maintainer_email'] if !opts[:'maintainer_email'].nil?
  form_params['license'] = opts[:'license'] if !opts[:'license'].nil?
  form_params['requires_python'] = opts[:'requires_python'] if !opts[:'requires_python'].nil?
  form_params['project_url'] = opts[:'project_url'] if !opts[:'project_url'].nil?
  form_params['project_urls'] = opts[:'project_urls'] if !opts[:'project_urls'].nil?
  form_params['platform'] = opts[:'platform'] if !opts[:'platform'].nil?
  form_params['supported_platform'] = opts[:'supported_platform'] if !opts[:'supported_platform'].nil?
  form_params['requires_dist'] = opts[:'requires_dist'] if !opts[:'requires_dist'].nil?
  form_params['provides_dist'] = opts[:'provides_dist'] if !opts[:'provides_dist'].nil?
  form_params['obsoletes_dist'] = opts[:'obsoletes_dist'] if !opts[:'obsoletes_dist'].nil?
  form_params['requires_external'] = opts[:'requires_external'] if !opts[:'requires_external'].nil?
  form_params['classifiers'] = opts[:'classifiers'] if !opts[:'classifiers'].nil?

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

#list(opts = {}) ⇒ PaginatedpythonPythonPackageContentResponseList

List python package contents

PythonPackageContent represents each individually installable Python package. In the Python ecosystem, this is called a Python Distribution, sometimes (ambiguously) refered to as a package. In Pulp Python, we refer to it as PythonPackageContent. Each PythonPackageContent corresponds to a single filename, for example `pulpcore-3.0.0rc1-py3-none-any.whl` or `pulpcore-3.0.0rc1.tar.gz`.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :author (String) —

    Filter results where author matches value

  • :author__in (Array<String>) —

    Filter results where author is in a comma-separated list of values

  • :filename (String) —

    Filter results where filename matches value

  • :filename__contains (String) —

    Filter results where filename contains value

  • :filename__in (Array<String>) —

    Filter results where filename is in a comma-separated list of values

  • :keywords__contains (String) —

    Filter results where keywords contains value

  • :keywords__in (Array<String>) —

    Filter results where keywords is in a comma-separated list of values

  • :limit (Integer) —

    Number of results to return per page.

  • :name (String) —

    Filter results where name matches value

  • :name__in (Array<String>) —

    Filter results where name is in a comma-separated list of values

  • :offset (Integer) —

    The initial index from which to return the results.

  • :ordering (String) —

    Which field to use when ordering the results.

  • :packagetype (String) —

    Filter results where packagetype matches value

  • :packagetype__in (Array<String>) —

    Filter results where packagetype is in a comma-separated list of values

  • :repository_version (String) —

    Repository Version referenced by HREF

  • :repository_version_added (String) —

    Repository Version referenced by HREF

  • :repository_version_removed (String) —

    Repository Version referenced by HREF

  • :requires_python (String) —

    Filter results where requires_python matches value

  • :requires_python__contains (String) —

    Filter results where requires_python contains value

  • :requires_python__in (Array<String>) —

    Filter results where requires_python is in a comma-separated list of values

  • :sha256 (String) —

    Filter results where sha256 matches value

  • :sha256__in (Array<String>) —

    Filter results where sha256 is in a comma-separated list of values

  • :fields (String) —

    A list of fields to include in the response.

  • :exclude_fields (String) —

    A list of fields to exclude from the response.

Returns:



198
199
200
201
 
# File 'lib/pulp_python_client/api/content_packages_api.rb', line 198

def list(opts = {})
  data, _status_code, _headers = list_with_http_info(opts)
  data
end

#list_with_http_info(opts = {}) ⇒ Array<(PaginatedpythonPythonPackageContentResponseList, Integer, Hash)>

List python package contents

PythonPackageContent represents each individually installable Python package. In the Python ecosystem, this is called a Python Distribution, sometimes (ambiguously) refered to as a package. In Pulp Python, we refer to it as PythonPackageContent. Each PythonPackageContent corresponds to a single filename, for example &#x60;pulpcore-3.0.0rc1-py3-none-any.whl&#x60; or &#x60;pulpcore-3.0.0rc1.tar.gz&#x60;.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :author (String) —

    Filter results where author matches value

  • :author__in (Array<String>) —

    Filter results where author is in a comma-separated list of values

  • :filename (String) —

    Filter results where filename matches value

  • :filename__contains (String) —

    Filter results where filename contains value

  • :filename__in (Array<String>) —

    Filter results where filename is in a comma-separated list of values

  • :keywords__contains (String) —

    Filter results where keywords contains value

  • :keywords__in (Array<String>) —

    Filter results where keywords is in a comma-separated list of values

  • :limit (Integer) —

    Number of results to return per page.

  • :name (String) —

    Filter results where name matches value

  • :name__in (Array<String>) —

    Filter results where name is in a comma-separated list of values

  • :offset (Integer) —

    The initial index from which to return the results.

  • :ordering (String) —

    Which field to use when ordering the results.

  • :packagetype (String) —

    Filter results where packagetype matches value

  • :packagetype__in (Array<String>) —

    Filter results where packagetype is in a comma-separated list of values

  • :repository_version (String) —

    Repository Version referenced by HREF

  • :repository_version_added (String) —

    Repository Version referenced by HREF

  • :repository_version_removed (String) —

    Repository Version referenced by HREF

  • :requires_python (String) —

    Filter results where requires_python matches value

  • :requires_python__contains (String) —

    Filter results where requires_python contains value

  • :requires_python__in (Array<String>) —

    Filter results where requires_python is in a comma-separated list of values

  • :sha256 (String) —

    Filter results where sha256 matches value

  • :sha256__in (Array<String>) —

    Filter results where sha256 is in a comma-separated list of values

  • :fields (String) —

    A list of fields to include in the response.

  • :exclude_fields (String) —

    A list of fields to exclude from the response.

Returns:



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/pulp_python_client/api/content_packages_api.rb', line 231

def list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContentPackagesApi.list ...'
  end
  allowable_values = ["bdist_dmg", "bdist_dumb", "bdist_egg", "bdist_msi", "bdist_rpm", "bdist_wheel", "bdist_wininst", "sdist"]
  if @api_client.config.client_side_validation && opts[:'packagetype'] && !allowable_values.include?(opts[:'packagetype'])
    fail ArgumentError, "invalid value for \"packagetype\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/pulp/api/v3/content/python/packages/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'author'] = opts[:'author'] if !opts[:'author'].nil?
  query_params[:'author__in'] = @api_client.build_collection_param(opts[:'author__in'], :csv) if !opts[:'author__in'].nil?
  query_params[:'filename'] = opts[:'filename'] if !opts[:'filename'].nil?
  query_params[:'filename__contains'] = opts[:'filename__contains'] if !opts[:'filename__contains'].nil?
  query_params[:'filename__in'] = @api_client.build_collection_param(opts[:'filename__in'], :csv) if !opts[:'filename__in'].nil?
  query_params[:'keywords__contains'] = opts[:'keywords__contains'] if !opts[:'keywords__contains'].nil?
  query_params[:'keywords__in'] = @api_client.build_collection_param(opts[:'keywords__in'], :csv) if !opts[:'keywords__in'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'name__in'] = @api_client.build_collection_param(opts[:'name__in'], :csv) if !opts[:'name__in'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'ordering'] = opts[:'ordering'] if !opts[:'ordering'].nil?
  query_params[:'packagetype'] = opts[:'packagetype'] if !opts[:'packagetype'].nil?
  query_params[:'packagetype__in'] = @api_client.build_collection_param(opts[:'packagetype__in'], :csv) if !opts[:'packagetype__in'].nil?
  query_params[:'repository_version'] = opts[:'repository_version'] if !opts[:'repository_version'].nil?
  query_params[:'repository_version_added'] = opts[:'repository_version_added'] if !opts[:'repository_version_added'].nil?
  query_params[:'repository_version_removed'] = opts[:'repository_version_removed'] if !opts[:'repository_version_removed'].nil?
  query_params[:'requires_python'] = opts[:'requires_python'] if !opts[:'requires_python'].nil?
  query_params[:'requires_python__contains'] = opts[:'requires_python__contains'] if !opts[:'requires_python__contains'].nil?
  query_params[:'requires_python__in'] = @api_client.build_collection_param(opts[:'requires_python__in'], :csv) if !opts[:'requires_python__in'].nil?
  query_params[:'sha256'] = opts[:'sha256'] if !opts[:'sha256'].nil?
  query_params[:'sha256__in'] = @api_client.build_collection_param(opts[:'sha256__in'], :csv) if !opts[:'sha256__in'].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] || 'PaginatedpythonPythonPackageContentResponseList' 

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

#read(python_python_package_content_href, opts = {}) ⇒ PythonPythonPackageContentResponse

Inspect a python package content

PythonPackageContent represents each individually installable Python package. In the Python ecosystem, this is called a Python Distribution, sometimes (ambiguously) refered to as a package. In Pulp Python, we refer to it as PythonPackageContent. Each PythonPackageContent corresponds to a single filename, for example `pulpcore-3.0.0rc1-py3-none-any.whl` or `pulpcore-3.0.0rc1.tar.gz`.

Parameters:

  • python_python_package_content_href (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :fields (String) —

    A list of fields to include in the response.

  • :exclude_fields (String) —

    A list of fields to exclude from the response.

Returns:



309
310
311
312
 
# File 'lib/pulp_python_client/api/content_packages_api.rb', line 309

def read(python_python_package_content_href, opts = {})
  data, _status_code, _headers = read_with_http_info(python_python_package_content_href, opts)
  data
end

#read_with_http_info(python_python_package_content_href, opts = {}) ⇒ Array<(PythonPythonPackageContentResponse, Integer, Hash)>

Inspect a python package content

PythonPackageContent represents each individually installable Python package. In the Python ecosystem, this is called a Python Distribution, sometimes (ambiguously) refered to as a package. In Pulp Python, we refer to it as PythonPackageContent. Each PythonPackageContent corresponds to a single filename, for example &#x60;pulpcore-3.0.0rc1-py3-none-any.whl&#x60; or &#x60;pulpcore-3.0.0rc1.tar.gz&#x60;.

Parameters:

  • python_python_package_content_href (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :fields (String) —

    A list of fields to include in the response.

  • :exclude_fields (String) —

    A list of fields to exclude from the response.

Returns:



321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
 
# File 'lib/pulp_python_client/api/content_packages_api.rb', line 321

def read_with_http_info(python_python_package_content_href, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContentPackagesApi.read ...'
  end
  # verify the required parameter 'python_python_package_content_href' is set
  if @api_client.config.client_side_validation && python_python_package_content_href.nil?
    fail ArgumentError, "Missing the required parameter 'python_python_package_content_href' when calling ContentPackagesApi.read"
  end
  # resource path
  local_var_path = '{python_python_package_content_href}'.sub('{' + 'python_python_package_content_href' + '}', CGI.escape(python_python_package_content_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] || 'PythonPythonPackageContentResponse' 

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