Class: PulpPythonClient::ContentPackagesApi

Inherits:

Object

Object
PulpPythonClient::ContentPackagesApi

show all

Defined in:: lib/pulp_python_client/api/content_packages_api.rb

Instance Attribute Summary collapse

#api_client ⇒ Object

Returns the value of attribute api_client.

Instance Method Summary collapse

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

Create a python package content Trigger an asynchronous task to create content,optionally create new repository version.
#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.
#initialize(api_client = ApiClient.default) ⇒ ContentPackagesApi constructor

A new instance of ContentPackagesApi.
#list(opts = {}) ⇒ PaginatedpythonPythonPackageContentResponseList

List python package contents PythonPackageContent represents each individually installable Python package.
#list_with_http_info(opts = {}) ⇒ Array<(PaginatedpythonPythonPackageContentResponseList, Integer, Hash)>

List python package contents PythonPackageContent represents each individually installable Python package.
#read(python_python_package_content_href, opts = {}) ⇒ PythonPythonPackageContentResponse

Inspect a python package content PythonPackageContent represents each individually installable Python package.
#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.
#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.
#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.
#unset_label(python_python_package_content_href, unset_label, opts = {}) ⇒ UnsetLabelResponse

Unset a label Unset a single pulp_label on the object.
#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.

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

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

(AsyncOperationResponse)

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

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

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

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

AsyncOperationResponse data, response status code and response headers

# File 'lib/pulp_python_client/api/content_packages_api.rb', line 93

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

  # 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

  # 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['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[: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):

: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 * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `upstream_id` - Upstream id * `-upstream_id` - Upstream id (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `timestamp_of_interest` - Timestamp of interest * `-timestamp_of_interest` - Timestamp of interest (descending) * `filename` - Filename * `-filename` - Filename (descending) * `packagetype` - Packagetype * `-packagetype` - Packagetype (descending) * `name` - Name * `-name` - Name (descending) * `version` - Version * `-version` - Version (descending) * `sha256` - Sha256 * `-sha256` - Sha256 (descending) * `python_version` - Python version * `-python_version` - Python version (descending) * `metadata_version` - Metadata version * `-metadata_version` - Metadata version (descending) * `summary` - Summary * `-summary` - Summary (descending) * `description` - Description * `-description` - Description (descending) * `keywords` - Keywords * `-keywords` - Keywords (descending) * `home_page` - Home page * `-home_page` - Home page (descending) * `download_url` - Download url * `-download_url` - Download url (descending) * `author` - Author * `-author` - Author (descending) * `author_email` - Author email * `-author_email` - Author email (descending) * `maintainer` - Maintainer * `-maintainer` - Maintainer (descending) * `maintainer_email` - Maintainer email * `-maintainer_email` - Maintainer email (descending) * `license` - License * `-license` - License (descending) * `requires_python` - Requires python * `-requires_python` - Requires python (descending) * `project_url` - Project url * `-project_url` - Project url (descending) * `platform` - Platform * `-platform` - Platform (descending) * `supported_platform` - Supported platform * `-supported_platform` - Supported platform (descending) * `requires_dist` - Requires dist * `-requires_dist` - Requires dist (descending) * `provides_dist` - Provides dist * `-provides_dist` - Provides dist (descending) * `obsoletes_dist` - Obsoletes dist * `-obsoletes_dist` - Obsoletes dist (descending) * `requires_external` - Requires external * `-requires_external` - Requires external (descending) * `classifiers` - Classifiers * `-classifiers` - Classifiers (descending) * `project_urls` - Project urls * `-project_urls` - Project urls (descending) * `description_content_type` - Description content type * `-description_content_type` - Description content type (descending) * `pk` - Pk * `-pk` - Pk (descending)
:orphaned_for (Float) —

Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME.
:packagetype (String) —

Filter results where packagetype matches value * `bdist_dmg` - bdist_dmg * `bdist_dumb` - bdist_dumb * `bdist_egg` - bdist_egg * `bdist_msi` - bdist_msi * `bdist_rpm` - bdist_rpm * `bdist_wheel` - bdist_wheel * `bdist_wininst` - bdist_wininst * `sdist` - 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:

(PaginatedpythonPythonPackageContentResponseList)

# File 'lib/pulp_python_client/api/content_packages_api.rb', line 226

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

Ordering * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `upstream_id` - Upstream id * `-upstream_id` - Upstream id (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `timestamp_of_interest` - Timestamp of interest * `-timestamp_of_interest` - Timestamp of interest (descending) * `filename` - Filename * `-filename` - Filename (descending) * `packagetype` - Packagetype * `-packagetype` - Packagetype (descending) * `name` - Name * `-name` - Name (descending) * `version` - Version * `-version` - Version (descending) * `sha256` - Sha256 * `-sha256` - Sha256 (descending) * `python_version` - Python version * `-python_version` - Python version (descending) * `metadata_version` - Metadata version * `-metadata_version` - Metadata version (descending) * `summary` - Summary * `-summary` - Summary (descending) * `description` - Description * `-description` - Description (descending) * `keywords` - Keywords * `-keywords` - Keywords (descending) * `home_page` - Home page * `-home_page` - Home page (descending) * `download_url` - Download url * `-download_url` - Download url (descending) * `author` - Author * `-author` - Author (descending) * `author_email` - Author email * `-author_email` - Author email (descending) * `maintainer` - Maintainer * `-maintainer` - Maintainer (descending) * `maintainer_email` - Maintainer email * `-maintainer_email` - Maintainer email (descending) * `license` - License * `-license` - License (descending) * `requires_python` - Requires python * `-requires_python` - Requires python (descending) * `project_url` - Project url * `-project_url` - Project url (descending) * `platform` - Platform * `-platform` - Platform (descending) * `supported_platform` - Supported platform * `-supported_platform` - Supported platform (descending) * `requires_dist` - Requires dist * `-requires_dist` - Requires dist (descending) * `provides_dist` - Provides dist * `-provides_dist` - Provides dist (descending) * `obsoletes_dist` - Obsoletes dist * `-obsoletes_dist` - Obsoletes dist (descending) * `requires_external` - Requires external * `-requires_external` - Requires external (descending) * `classifiers` - Classifiers * `-classifiers` - Classifiers (descending) * `project_urls` - Project urls * `-project_urls` - Project urls (descending) * `description_content_type` - Description content type * `-description_content_type` - Description content type (descending) * `pk` - Pk * `-pk` - Pk (descending)
:orphaned_for (Float) —

Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME.
:packagetype (String) —

Filter results where packagetype matches value * `bdist_dmg` - bdist_dmg * `bdist_dumb` - bdist_dumb * `bdist_egg` - bdist_egg * `bdist_msi` - bdist_msi * `bdist_rpm` - bdist_rpm * `bdist_wheel` - bdist_wheel * `bdist_wininst` - bdist_wininst * `sdist` - 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:

(Array<(PaginatedpythonPythonPackageContentResponseList, Integer, Hash)>) —

PaginatedpythonPythonPackageContentResponseList data, response status code and response headers

# File 'lib/pulp_python_client/api/content_packages_api.rb', line 270

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", "-filename", "-home_page", "-keywords", "-license", "-maintainer", "-maintainer_email", "-metadata_version", "-name", "-obsoletes_dist", "-packagetype", "-pk", "-platform", "-project_url", "-project_urls", "-provides_dist", "-pulp_created", "-pulp_id", "-pulp_labels", "-pulp_last_updated", "-pulp_type", "-python_version", "-requires_dist", "-requires_external", "-requires_python", "-sha256", "-summary", "-supported_platform", "-timestamp_of_interest", "-upstream_id", "-version", "author", "author_email", "classifiers", "description", "description_content_type", "download_url", "filename", "home_page", "keywords", "license", "maintainer", "maintainer_email", "metadata_version", "name", "obsoletes_dist", "packagetype", "pk", "platform", "project_url", "project_urls", "provides_dist", "pulp_created", "pulp_id", "pulp_labels", "pulp_last_updated", "pulp_type", "python_version", "requires_dist", "requires_external", "requires_python", "sha256", "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']

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

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

(PythonPythonPackageContentResponse)

# File 'lib/pulp_python_client/api/content_packages_api.rb', line 364

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

(Array<(PythonPythonPackageContentResponse, Integer, Hash)>) —

PythonPythonPackageContentResponse data, response status code and response headers

# File 'lib/pulp_python_client/api/content_packages_api.rb', line 376

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']

  # 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

Returns:

(SetLabelResponse)

# File 'lib/pulp_python_client/api/content_packages_api.rb', line 432

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

Returns:

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

SetLabelResponse data, response status code and response headers

# File 'lib/pulp_python_client/api/content_packages_api.rb', line 443

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

  # 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

Returns:

(UnsetLabelResponse)

# File 'lib/pulp_python_client/api/content_packages_api.rb', line 506

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

Returns:

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

UnsetLabelResponse data, response status code and response headers

# File 'lib/pulp_python_client/api/content_packages_api.rb', line 517

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

  # 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

Class: PulpPythonClient::ContentPackagesApi

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ContentPackagesApi

Instance Attribute Details

#api_client ⇒ Object

Instance Method Details

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

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

#list(opts = {}) ⇒ PaginatedpythonPythonPackageContentResponseList

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

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

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

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

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

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

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

#initialize(api_client = ApiClient.default) ⇒ `ContentPackagesApi`

#api_client ⇒ `Object`

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

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

#list(opts = {}) ⇒ `PaginatedpythonPythonPackageContentResponseList`

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

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

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

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

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

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

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