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):

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.

  • :repository (String) —

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

  • :pulp_labels (Hash<String, String>) —

    A dictionary of arbitrary key/value pairs used to describe a specific Content instance.

  • :artifact (String) —

    Artifact file representing the physical content

  • :file (File) —

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

  • :upload (String) —

    An uncommitted upload that may be turned into the content unit.

  • :file_url (String) —

    A url that Pulp can download and turn into the content unit.

  • :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.

  • :description (String) —

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

  • :home_page (String) —

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

  • :keywords (String) —

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

  • :license (String) —

    Text indicating the license covering the distribution

  • :platform (String) —

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

  • :summary (String) —

    A one-line summary of what the package does.

  • :classifiers (Object)
  • :download_url (String) —

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

  • :supported_platform (String) —

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

  • :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.

  • :obsoletes_dist (Object)
  • :project_url (String) —

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

  • :project_urls (Object)
  • :provides_dist (Object)
  • :requires_external (Object)
  • :requires_dist (Object)
  • :requires_python (String) —

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

  • :description_content_type (String) —

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

  • :provides_extras (Object)
  • :dynamic (Object)
  • :license_expression (String) —

    Text string that is a valid SPDX license expression.

  • :license_file (Object)
  • :sha256 (String) —

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

  • :metadata_sha256 (String) —

    The SHA256 digest of the package&#39;s METADATA file.

Returns:



61
62
63
64
 
# File 'lib/pulp_python_client/api/content_packages_api.rb', line 61

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):

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.

  • :repository (String) —

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

  • :pulp_labels (Hash<String, String>) —

    A dictionary of arbitrary key/value pairs used to describe a specific Content instance.

  • :artifact (String) —

    Artifact file representing the physical content

  • :file (File) —

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

  • :upload (String) —

    An uncommitted upload that may be turned into the content unit.

  • :file_url (String) —

    A url that Pulp can download and turn into the content unit.

  • :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.

  • :description (String) —

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

  • :home_page (String) —

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

  • :keywords (String) —

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

  • :license (String) —

    Text indicating the license covering the distribution

  • :platform (String) —

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

  • :summary (String) —

    A one-line summary of what the package does.

  • :classifiers (Object)
  • :download_url (String) —

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

  • :supported_platform (String) —

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

  • :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.

  • :obsoletes_dist (Object)
  • :project_url (String) —

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

  • :project_urls (Object)
  • :provides_dist (Object)
  • :requires_external (Object)
  • :requires_dist (Object)
  • :requires_python (String) —

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

  • :description_content_type (String) —

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

  • :provides_extras (Object)
  • :dynamic (Object)
  • :license_expression (String) —

    Text string that is a valid SPDX license expression.

  • :license_file (Object)
  • :sha256 (String) —

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

  • :metadata_sha256 (String) —

    The SHA256 digest of the package&#39;s METADATA file.

Returns:

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

    AsyncOperationResponse data, response status code and response headers



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
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/pulp_python_client/api/content_packages_api.rb', line 105

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[:'file_url'].nil? && opts[:'file_url'].to_s.length < 1
    fail ArgumentError, 'invalid value for "opts[:"file_url"]" 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

  if @api_client.config.client_side_validation && !opts[:'metadata_sha256'].nil? && opts[:'metadata_sha256'].to_s.length < 1
    fail ArgumentError, 'invalid value for "opts[:"metadata_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']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['multipart/form-data', 'application/x-www-form-urlencoded'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end
  header_params[:'X-Task-Diagnostics'] = @api_client.build_collection_param(opts[:'x_task_diagnostics'], :csv) if !opts[:'x_task_diagnostics'].nil?

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['relative_path'] = relative_path
  form_params['repository'] = opts[:'repository'] if !opts[:'repository'].nil?
  form_params['pulp_labels'] = opts[:'pulp_labels'] if !opts[:'pulp_labels'].nil?
  form_params['artifact'] = opts[:'artifact'] if !opts[:'artifact'].nil?
  form_params['file'] = opts[:'file'] if !opts[:'file'].nil?
  form_params['upload'] = opts[:'upload'] if !opts[:'upload'].nil?
  form_params['file_url'] = opts[:'file_url'] if !opts[:'file_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['description'] = opts[:'description'] if !opts[:'description'].nil?
  form_params['home_page'] = opts[:'home_page'] if !opts[:'home_page'].nil?
  form_params['keywords'] = opts[:'keywords'] if !opts[:'keywords'].nil?
  form_params['license'] = opts[:'license'] if !opts[:'license'].nil?
  form_params['platform'] = opts[:'platform'] if !opts[:'platform'].nil?
  form_params['summary'] = opts[:'summary'] if !opts[:'summary'].nil?
  form_params['classifiers'] = opts[:'classifiers'] if !opts[:'classifiers'].nil?
  form_params['download_url'] = opts[:'download_url'] if !opts[:'download_url'].nil?
  form_params['supported_platform'] = opts[:'supported_platform'] if !opts[:'supported_platform'].nil?
  form_params['maintainer'] = opts[:'maintainer'] if !opts[:'maintainer'].nil?
  form_params['maintainer_email'] = opts[:'maintainer_email'] if !opts[:'maintainer_email'].nil?
  form_params['obsoletes_dist'] = opts[:'obsoletes_dist'] if !opts[:'obsoletes_dist'].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['provides_dist'] = opts[:'provides_dist'] if !opts[:'provides_dist'].nil?
  form_params['requires_external'] = opts[:'requires_external'] if !opts[:'requires_external'].nil?
  form_params['requires_dist'] = opts[:'requires_dist'] if !opts[:'requires_dist'].nil?
  form_params['requires_python'] = opts[:'requires_python'] if !opts[:'requires_python'].nil?
  form_params['description_content_type'] = opts[:'description_content_type'] if !opts[:'description_content_type'].nil?
  form_params['provides_extras'] = opts[:'provides_extras'] if !opts[:'provides_extras'].nil?
  form_params['dynamic'] = opts[:'dynamic'] if !opts[:'dynamic'].nil?
  form_params['license_expression'] = opts[:'license_expression'] if !opts[:'license_expression'].nil?
  form_params['license_file'] = opts[:'license_file'] if !opts[:'license_file'].nil?
  form_params['sha256'] = opts[:'sha256'] if !opts[:'sha256'].nil?
  form_params['metadata_sha256'] = opts[:'metadata_sha256'] if !opts[:'metadata_sha256'].nil?

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth']

  new_options = opts.merge(
    :operation => :"ContentPackagesApi.create",
    :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):

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.

  • :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 (Array<String>) —

    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;upstream_id&#x60; - Upstream id * &#x60;-upstream_id&#x60; - Upstream id (descending) * &#x60;pulp_labels&#x60; - Pulp labels * &#x60;-pulp_labels&#x60; - Pulp labels (descending) * &#x60;timestamp_of_interest&#x60; - Timestamp of interest * &#x60;-timestamp_of_interest&#x60; - Timestamp of interest (descending) * &#x60;author&#x60; - Author * &#x60;-author&#x60; - Author (descending) * &#x60;author_email&#x60; - Author email * &#x60;-author_email&#x60; - Author email (descending) * &#x60;description&#x60; - Description * &#x60;-description&#x60; - Description (descending) * &#x60;home_page&#x60; - Home page * &#x60;-home_page&#x60; - Home page (descending) * &#x60;keywords&#x60; - Keywords * &#x60;-keywords&#x60; - Keywords (descending) * &#x60;license&#x60; - License * &#x60;-license&#x60; - License (descending) * &#x60;metadata_version&#x60; - Metadata version * &#x60;-metadata_version&#x60; - Metadata version (descending) * &#x60;name&#x60; - Name * &#x60;-name&#x60; - Name (descending) * &#x60;platform&#x60; - Platform * &#x60;-platform&#x60; - Platform (descending) * &#x60;summary&#x60; - Summary * &#x60;-summary&#x60; - Summary (descending) * &#x60;version&#x60; - Version * &#x60;-version&#x60; - Version (descending) * &#x60;classifiers&#x60; - Classifiers * &#x60;-classifiers&#x60; - Classifiers (descending) * &#x60;download_url&#x60; - Download url * &#x60;-download_url&#x60; - Download url (descending) * &#x60;supported_platform&#x60; - Supported platform * &#x60;-supported_platform&#x60; - Supported platform (descending) * &#x60;maintainer&#x60; - Maintainer * &#x60;-maintainer&#x60; - Maintainer (descending) * &#x60;maintainer_email&#x60; - Maintainer email * &#x60;-maintainer_email&#x60; - Maintainer email (descending) * &#x60;obsoletes_dist&#x60; - Obsoletes dist * &#x60;-obsoletes_dist&#x60; - Obsoletes dist (descending) * &#x60;project_url&#x60; - Project url * &#x60;-project_url&#x60; - Project url (descending) * &#x60;project_urls&#x60; - Project urls * &#x60;-project_urls&#x60; - Project urls (descending) * &#x60;provides_dist&#x60; - Provides dist * &#x60;-provides_dist&#x60; - Provides dist (descending) * &#x60;requires_external&#x60; - Requires external * &#x60;-requires_external&#x60; - Requires external (descending) * &#x60;requires_dist&#x60; - Requires dist * &#x60;-requires_dist&#x60; - Requires dist (descending) * &#x60;requires_python&#x60; - Requires python * &#x60;-requires_python&#x60; - Requires python (descending) * &#x60;description_content_type&#x60; - Description content type * &#x60;-description_content_type&#x60; - Description content type (descending) * &#x60;provides_extras&#x60; - Provides extras * &#x60;-provides_extras&#x60; - Provides extras (descending) * &#x60;dynamic&#x60; - Dynamic * &#x60;-dynamic&#x60; - Dynamic (descending) * &#x60;license_expression&#x60; - License expression * &#x60;-license_expression&#x60; - License expression (descending) * &#x60;license_file&#x60; - License file * &#x60;-license_file&#x60; - License file (descending) * &#x60;filename&#x60; - Filename * &#x60;-filename&#x60; - Filename (descending) * &#x60;packagetype&#x60; - Packagetype * &#x60;-packagetype&#x60; - Packagetype (descending) * &#x60;python_version&#x60; - Python version * &#x60;-python_version&#x60; - Python version (descending) * &#x60;sha256&#x60; - Sha256 * &#x60;-sha256&#x60; - Sha256 (descending) * &#x60;metadata_sha256&#x60; - Metadata sha256 * &#x60;-metadata_sha256&#x60; - Metadata sha256 (descending) * &#x60;size&#x60; - Size * &#x60;-size&#x60; - Size (descending) * &#x60;pk&#x60; - Pk * &#x60;-pk&#x60; - Pk (descending)

  • :orphaned_for (Float) —

    Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME.

  • :packagetype (String) —

    Filter results where packagetype matches value * &#x60;bdist_dmg&#x60; - bdist_dmg * &#x60;bdist_dumb&#x60; - bdist_dumb * &#x60;bdist_egg&#x60; - bdist_egg * &#x60;bdist_msi&#x60; - bdist_msi * &#x60;bdist_rpm&#x60; - bdist_rpm * &#x60;bdist_wheel&#x60; - bdist_wheel * &#x60;bdist_wininst&#x60; - bdist_wininst * &#x60;sdist&#x60; - sdist

  • :packagetype__in (Array<String>) —

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

  • :prn__in (Array<String>) —

    Multiple values may be separated by commas.

  • :pulp_href__in (Array<String>) —

    Multiple values may be separated by commas.

  • :pulp_id__in (Array<String>) —

    Multiple values may be separated by commas.

  • :pulp_label_select (String) —

    Filter labels by search string

  • :q (String) —

    Filter results by using NOT, AND and OR operations on other filters

  • :repository_version (String) —

    Repository Version referenced by HREF/PRN

  • :repository_version_added (String) —

    Repository Version referenced by HREF/PRN

  • :repository_version_removed (String) —

    Repository Version referenced by HREF/PRN

  • :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

  • :version (String) —

    Filter results where version matches value

  • :version__gt (String) —

    Filter results where version is greater than value

  • :version__gte (String) —

    Filter results where version is greater than or equal to value

  • :version__lt (String) —

    Filter results where version is less than value

  • :version__lte (String) —

    Filter results where version is less than or equal to value

  • :fields (Array<String>) —

    A list of fields to include in the response.

  • :exclude_fields (Array<String>) —

    A list of fields to exclude from the response.

Returns:



249
250
251
252
 
# File 'lib/pulp_python_client/api/content_packages_api.rb', line 249

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):

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.

  • :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 (Array<String>) —

    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;upstream_id&#x60; - Upstream id * &#x60;-upstream_id&#x60; - Upstream id (descending) * &#x60;pulp_labels&#x60; - Pulp labels * &#x60;-pulp_labels&#x60; - Pulp labels (descending) * &#x60;timestamp_of_interest&#x60; - Timestamp of interest * &#x60;-timestamp_of_interest&#x60; - Timestamp of interest (descending) * &#x60;author&#x60; - Author * &#x60;-author&#x60; - Author (descending) * &#x60;author_email&#x60; - Author email * &#x60;-author_email&#x60; - Author email (descending) * &#x60;description&#x60; - Description * &#x60;-description&#x60; - Description (descending) * &#x60;home_page&#x60; - Home page * &#x60;-home_page&#x60; - Home page (descending) * &#x60;keywords&#x60; - Keywords * &#x60;-keywords&#x60; - Keywords (descending) * &#x60;license&#x60; - License * &#x60;-license&#x60; - License (descending) * &#x60;metadata_version&#x60; - Metadata version * &#x60;-metadata_version&#x60; - Metadata version (descending) * &#x60;name&#x60; - Name * &#x60;-name&#x60; - Name (descending) * &#x60;platform&#x60; - Platform * &#x60;-platform&#x60; - Platform (descending) * &#x60;summary&#x60; - Summary * &#x60;-summary&#x60; - Summary (descending) * &#x60;version&#x60; - Version * &#x60;-version&#x60; - Version (descending) * &#x60;classifiers&#x60; - Classifiers * &#x60;-classifiers&#x60; - Classifiers (descending) * &#x60;download_url&#x60; - Download url * &#x60;-download_url&#x60; - Download url (descending) * &#x60;supported_platform&#x60; - Supported platform * &#x60;-supported_platform&#x60; - Supported platform (descending) * &#x60;maintainer&#x60; - Maintainer * &#x60;-maintainer&#x60; - Maintainer (descending) * &#x60;maintainer_email&#x60; - Maintainer email * &#x60;-maintainer_email&#x60; - Maintainer email (descending) * &#x60;obsoletes_dist&#x60; - Obsoletes dist * &#x60;-obsoletes_dist&#x60; - Obsoletes dist (descending) * &#x60;project_url&#x60; - Project url * &#x60;-project_url&#x60; - Project url (descending) * &#x60;project_urls&#x60; - Project urls * &#x60;-project_urls&#x60; - Project urls (descending) * &#x60;provides_dist&#x60; - Provides dist * &#x60;-provides_dist&#x60; - Provides dist (descending) * &#x60;requires_external&#x60; - Requires external * &#x60;-requires_external&#x60; - Requires external (descending) * &#x60;requires_dist&#x60; - Requires dist * &#x60;-requires_dist&#x60; - Requires dist (descending) * &#x60;requires_python&#x60; - Requires python * &#x60;-requires_python&#x60; - Requires python (descending) * &#x60;description_content_type&#x60; - Description content type * &#x60;-description_content_type&#x60; - Description content type (descending) * &#x60;provides_extras&#x60; - Provides extras * &#x60;-provides_extras&#x60; - Provides extras (descending) * &#x60;dynamic&#x60; - Dynamic * &#x60;-dynamic&#x60; - Dynamic (descending) * &#x60;license_expression&#x60; - License expression * &#x60;-license_expression&#x60; - License expression (descending) * &#x60;license_file&#x60; - License file * &#x60;-license_file&#x60; - License file (descending) * &#x60;filename&#x60; - Filename * &#x60;-filename&#x60; - Filename (descending) * &#x60;packagetype&#x60; - Packagetype * &#x60;-packagetype&#x60; - Packagetype (descending) * &#x60;python_version&#x60; - Python version * &#x60;-python_version&#x60; - Python version (descending) * &#x60;sha256&#x60; - Sha256 * &#x60;-sha256&#x60; - Sha256 (descending) * &#x60;metadata_sha256&#x60; - Metadata sha256 * &#x60;-metadata_sha256&#x60; - Metadata sha256 (descending) * &#x60;size&#x60; - Size * &#x60;-size&#x60; - Size (descending) * &#x60;pk&#x60; - Pk * &#x60;-pk&#x60; - Pk (descending)

  • :orphaned_for (Float) —

    Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME.

  • :packagetype (String) —

    Filter results where packagetype matches value * &#x60;bdist_dmg&#x60; - bdist_dmg * &#x60;bdist_dumb&#x60; - bdist_dumb * &#x60;bdist_egg&#x60; - bdist_egg * &#x60;bdist_msi&#x60; - bdist_msi * &#x60;bdist_rpm&#x60; - bdist_rpm * &#x60;bdist_wheel&#x60; - bdist_wheel * &#x60;bdist_wininst&#x60; - bdist_wininst * &#x60;sdist&#x60; - sdist

  • :packagetype__in (Array<String>) —

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

  • :prn__in (Array<String>) —

    Multiple values may be separated by commas.

  • :pulp_href__in (Array<String>) —

    Multiple values may be separated by commas.

  • :pulp_id__in (Array<String>) —

    Multiple values may be separated by commas.

  • :pulp_label_select (String) —

    Filter labels by search string

  • :q (String) —

    Filter results by using NOT, AND and OR operations on other filters

  • :repository_version (String) —

    Repository Version referenced by HREF/PRN

  • :repository_version_added (String) —

    Repository Version referenced by HREF/PRN

  • :repository_version_removed (String) —

    Repository Version referenced by HREF/PRN

  • :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

  • :version (String) —

    Filter results where version matches value

  • :version__gt (String) —

    Filter results where version is greater than value

  • :version__gte (String) —

    Filter results where version is greater than or equal to value

  • :version__lt (String) —

    Filter results where version is less than value

  • :version__lte (String) —

    Filter results where version is less than or equal to value

  • :fields (Array<String>) —

    A list of fields to include in the response.

  • :exclude_fields (Array<String>) —

    A list of fields to exclude from the response.

Returns:



294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
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
369
370
371
372
373
374
375
376
377
378
379
380
 
# File 'lib/pulp_python_client/api/content_packages_api.rb', line 294

def list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContentPackagesApi.list ...'
  end
  allowable_values = ["-author", "-author_email", "-classifiers", "-description", "-description_content_type", "-download_url", "-dynamic", "-filename", "-home_page", "-keywords", "-license", "-license_expression", "-license_file", "-maintainer", "-maintainer_email", "-metadata_sha256", "-metadata_version", "-name", "-obsoletes_dist", "-packagetype", "-pk", "-platform", "-project_url", "-project_urls", "-provides_dist", "-provides_extras", "-pulp_created", "-pulp_id", "-pulp_labels", "-pulp_last_updated", "-pulp_type", "-python_version", "-requires_dist", "-requires_external", "-requires_python", "-sha256", "-size", "-summary", "-supported_platform", "-timestamp_of_interest", "-upstream_id", "-version", "author", "author_email", "classifiers", "description", "description_content_type", "download_url", "dynamic", "filename", "home_page", "keywords", "license", "license_expression", "license_file", "maintainer", "maintainer_email", "metadata_sha256", "metadata_version", "name", "obsoletes_dist", "packagetype", "pk", "platform", "project_url", "project_urls", "provides_dist", "provides_extras", "pulp_created", "pulp_id", "pulp_labels", "pulp_last_updated", "pulp_type", "python_version", "requires_dist", "requires_external", "requires_python", "sha256", "size", "summary", "supported_platform", "timestamp_of_interest", "upstream_id", "version"]
  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
  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'] = @api_client.build_collection_param(opts[:'ordering'], :csv) if !opts[:'ordering'].nil?
  query_params[:'orphaned_for'] = opts[:'orphaned_for'] if !opts[:'orphaned_for'].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[:'prn__in'] = @api_client.build_collection_param(opts[:'prn__in'], :csv) if !opts[:'prn__in'].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[:'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[:'version'] = opts[:'version'] if !opts[:'version'].nil?
  query_params[:'version__gt'] = opts[:'version__gt'] if !opts[:'version__gt'].nil?
  query_params[:'version__gte'] = opts[:'version__gte'] if !opts[:'version__gte'].nil?
  query_params[:'version__lt'] = opts[:'version__lt'] if !opts[:'version__lt'].nil?
  query_params[:'version__lte'] = opts[:'version__lte'] if !opts[:'version__lte'].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']) unless header_params['Accept']
  header_params[:'X-Task-Diagnostics'] = @api_client.build_collection_param(opts[:'x_task_diagnostics'], :csv) if !opts[:'x_task_diagnostics'].nil?

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'PaginatedpythonPythonPackageContentResponseList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth']

  new_options = opts.merge(
    :operation => :"ContentPackagesApi.list",
    :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):

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.

  • :fields (Array<String>) —

    A list of fields to include in the response.

  • :exclude_fields (Array<String>) —

    A list of fields to exclude from the response.

Returns:



390
391
392
393
 
# File 'lib/pulp_python_client/api/content_packages_api.rb', line 390

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):

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.

  • :fields (Array<String>) —

    A list of fields to include in the response.

  • :exclude_fields (Array<String>) —

    A list of fields to exclude from the response.

Returns:



403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
 
# File 'lib/pulp_python_client/api/content_packages_api.rb', line 403

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'] = @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']) unless header_params['Accept']
  header_params[:'X-Task-Diagnostics'] = @api_client.build_collection_param(opts[:'x_task_diagnostics'], :csv) if !opts[:'x_task_diagnostics'].nil?

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'PythonPythonPackageContentResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth']

  new_options = opts.merge(
    :operation => :"ContentPackagesApi.read",
    :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

#set_label(python_python_package_content_href, set_label, opts = {}) ⇒ SetLabelResponse

Set a label Set a single pulp_label on the object to a specific value or null.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.

Returns:



461
462
463
464
 
# File 'lib/pulp_python_client/api/content_packages_api.rb', line 461

def set_label(python_python_package_content_href, set_label, opts = {})
  data, _status_code, _headers = set_label_with_http_info(python_python_package_content_href, set_label, opts)
  data
end

#set_label_with_http_info(python_python_package_content_href, set_label, opts = {}) ⇒ Array<(SetLabelResponse, Integer, Hash)>

Set a label Set a single pulp_label on the object to a specific value or null.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.

Returns:

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

    SetLabelResponse data, response status code and response headers



473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
 
# File 'lib/pulp_python_client/api/content_packages_api.rb', line 473

def set_label_with_http_info(python_python_package_content_href, set_label, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContentPackagesApi.set_label ...'
  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.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 ContentPackagesApi.set_label"
  end
  # resource path
  local_var_path = '{python_python_package_content_href}set_label/'.sub('{' + 'python_python_package_content_href' + '}', CGI.escape(python_python_package_content_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']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end
  header_params[:'X-Task-Diagnostics'] = @api_client.build_collection_param(opts[:'x_task_diagnostics'], :csv) if !opts[:'x_task_diagnostics'].nil?

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth']

  new_options = opts.merge(
    :operation => :"ContentPackagesApi.set_label",
    :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#set_label\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#unset_label(python_python_package_content_href, unset_label, opts = {}) ⇒ UnsetLabelResponse

Unset a label Unset a single pulp_label on the object.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.

Returns:



538
539
540
541
 
# File 'lib/pulp_python_client/api/content_packages_api.rb', line 538

def unset_label(python_python_package_content_href, unset_label, opts = {})
  data, _status_code, _headers = unset_label_with_http_info(python_python_package_content_href, unset_label, opts)
  data
end

#unset_label_with_http_info(python_python_package_content_href, unset_label, opts = {}) ⇒ Array<(UnsetLabelResponse, Integer, Hash)>

Unset a label Unset a single pulp_label on the object.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.

Returns:

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

    UnsetLabelResponse data, response status code and response headers



550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
 
# File 'lib/pulp_python_client/api/content_packages_api.rb', line 550

def unset_label_with_http_info(python_python_package_content_href, unset_label, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContentPackagesApi.unset_label ...'
  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.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 ContentPackagesApi.unset_label"
  end
  # resource path
  local_var_path = '{python_python_package_content_href}unset_label/'.sub('{' + 'python_python_package_content_href' + '}', CGI.escape(python_python_package_content_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']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end
  header_params[:'X-Task-Diagnostics'] = @api_client.build_collection_param(opts[:'x_task_diagnostics'], :csv) if !opts[:'x_task_diagnostics'].nil?

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth']

  new_options = opts.merge(
    :operation => :"ContentPackagesApi.unset_label",
    :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#unset_label\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#upload(opts = {}) ⇒ PythonPythonPackageContentResponse

Synchronous Python package upload Create a Python package.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.

  • :pulp_labels (Hash<String, String>) —

    A dictionary of arbitrary key/value pairs used to describe a specific Content instance.

  • :artifact (String) —

    Artifact file representing the physical content

  • :file (File) —

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

  • :upload (String) —

    An uncommitted upload that may be turned into the content unit.

  • :file_url (String) —

    A url that Pulp can download and turn into the content unit.

  • :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.

  • :description (String) —

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

  • :home_page (String) —

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

  • :keywords (String) —

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

  • :license (String) —

    Text indicating the license covering the distribution

  • :platform (String) —

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

  • :summary (String) —

    A one-line summary of what the package does.

  • :classifiers (Object)
  • :download_url (String) —

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

  • :supported_platform (String) —

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

  • :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.

  • :obsoletes_dist (Object)
  • :project_url (String) —

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

  • :project_urls (Object)
  • :provides_dist (Object)
  • :requires_external (Object)
  • :requires_dist (Object)
  • :requires_python (String) —

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

  • :description_content_type (String) —

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

  • :provides_extras (Object)
  • :dynamic (Object)
  • :license_expression (String) —

    Text string that is a valid SPDX license expression.

  • :license_file (Object)
  • :sha256 (String) —

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

  • :metadata_sha256 (String) —

    The SHA256 digest of the package&#39;s METADATA file.

Returns:



645
646
647
648
 
# File 'lib/pulp_python_client/api/content_packages_api.rb', line 645

def upload(opts = {})
  data, _status_code, _headers = upload_with_http_info(opts)
  data
end

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

Synchronous Python package upload Create a Python package.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.

  • :pulp_labels (Hash<String, String>) —

    A dictionary of arbitrary key/value pairs used to describe a specific Content instance.

  • :artifact (String) —

    Artifact file representing the physical content

  • :file (File) —

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

  • :upload (String) —

    An uncommitted upload that may be turned into the content unit.

  • :file_url (String) —

    A url that Pulp can download and turn into the content unit.

  • :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.

  • :description (String) —

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

  • :home_page (String) —

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

  • :keywords (String) —

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

  • :license (String) —

    Text indicating the license covering the distribution

  • :platform (String) —

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

  • :summary (String) —

    A one-line summary of what the package does.

  • :classifiers (Object)
  • :download_url (String) —

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

  • :supported_platform (String) —

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

  • :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.

  • :obsoletes_dist (Object)
  • :project_url (String) —

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

  • :project_urls (Object)
  • :provides_dist (Object)
  • :requires_external (Object)
  • :requires_dist (Object)
  • :requires_python (String) —

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

  • :description_content_type (String) —

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

  • :provides_extras (Object)
  • :dynamic (Object)
  • :license_expression (String) —

    Text string that is a valid SPDX license expression.

  • :license_file (Object)
  • :sha256 (String) —

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

  • :metadata_sha256 (String) —

    The SHA256 digest of the package&#39;s METADATA file.

Returns:



687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
 
# File 'lib/pulp_python_client/api/content_packages_api.rb', line 687

def upload_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContentPackagesApi.upload ...'
  end
  if @api_client.config.client_side_validation && !opts[:'file_url'].nil? && opts[:'file_url'].to_s.length < 1
    fail ArgumentError, 'invalid value for "opts[:"file_url"]" when calling ContentPackagesApi.upload, 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.upload, the character length must be great than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'metadata_sha256'].nil? && opts[:'metadata_sha256'].to_s.length < 1
    fail ArgumentError, 'invalid value for "opts[:"metadata_sha256"]" when calling ContentPackagesApi.upload, the character length must be great than or equal to 1.'
  end

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

  # 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']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['multipart/form-data', 'application/x-www-form-urlencoded'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end
  header_params[:'X-Task-Diagnostics'] = @api_client.build_collection_param(opts[:'x_task_diagnostics'], :csv) if !opts[:'x_task_diagnostics'].nil?

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['pulp_labels'] = opts[:'pulp_labels'] if !opts[:'pulp_labels'].nil?
  form_params['artifact'] = opts[:'artifact'] if !opts[:'artifact'].nil?
  form_params['file'] = opts[:'file'] if !opts[:'file'].nil?
  form_params['upload'] = opts[:'upload'] if !opts[:'upload'].nil?
  form_params['file_url'] = opts[:'file_url'] if !opts[:'file_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['description'] = opts[:'description'] if !opts[:'description'].nil?
  form_params['home_page'] = opts[:'home_page'] if !opts[:'home_page'].nil?
  form_params['keywords'] = opts[:'keywords'] if !opts[:'keywords'].nil?
  form_params['license'] = opts[:'license'] if !opts[:'license'].nil?
  form_params['platform'] = opts[:'platform'] if !opts[:'platform'].nil?
  form_params['summary'] = opts[:'summary'] if !opts[:'summary'].nil?
  form_params['classifiers'] = opts[:'classifiers'] if !opts[:'classifiers'].nil?
  form_params['download_url'] = opts[:'download_url'] if !opts[:'download_url'].nil?
  form_params['supported_platform'] = opts[:'supported_platform'] if !opts[:'supported_platform'].nil?
  form_params['maintainer'] = opts[:'maintainer'] if !opts[:'maintainer'].nil?
  form_params['maintainer_email'] = opts[:'maintainer_email'] if !opts[:'maintainer_email'].nil?
  form_params['obsoletes_dist'] = opts[:'obsoletes_dist'] if !opts[:'obsoletes_dist'].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['provides_dist'] = opts[:'provides_dist'] if !opts[:'provides_dist'].nil?
  form_params['requires_external'] = opts[:'requires_external'] if !opts[:'requires_external'].nil?
  form_params['requires_dist'] = opts[:'requires_dist'] if !opts[:'requires_dist'].nil?
  form_params['requires_python'] = opts[:'requires_python'] if !opts[:'requires_python'].nil?
  form_params['description_content_type'] = opts[:'description_content_type'] if !opts[:'description_content_type'].nil?
  form_params['provides_extras'] = opts[:'provides_extras'] if !opts[:'provides_extras'].nil?
  form_params['dynamic'] = opts[:'dynamic'] if !opts[:'dynamic'].nil?
  form_params['license_expression'] = opts[:'license_expression'] if !opts[:'license_expression'].nil?
  form_params['license_file'] = opts[:'license_file'] if !opts[:'license_file'].nil?
  form_params['sha256'] = opts[:'sha256'] if !opts[:'sha256'].nil?
  form_params['metadata_sha256'] = opts[:'metadata_sha256'] if !opts[:'metadata_sha256'].nil?

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

  # return_type
  return_type = opts[:debug_return_type] || 'PythonPythonPackageContentResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth']

  new_options = opts.merge(
    :operation => :"ContentPackagesApi.upload",
    :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#upload\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end