Class: PulpRpmClient::ContentPackagesApi

Inherits:

Object

Object
PulpRpmClient::ContentPackagesApi

show all

Defined in:: lib/pulp_rpm_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(opts = {}) ⇒ AsyncOperationResponse

Create a package Trigger an asynchronous task to create an RPM package,optionally create new repository version.
#create_with_http_info(opts = {}) ⇒ Array<(AsyncOperationResponse, Integer, Hash)>

Create a package Trigger an asynchronous task to create an RPM package,optionally create new repository version.
#initialize(api_client = ApiClient.default) ⇒ ContentPackagesApi constructor

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

List packages A ViewSet for Package.
#list_with_http_info(opts = {}) ⇒ Array<(PaginatedrpmPackageResponseList, Integer, Hash)>

List packages A ViewSet for Package.
#read(rpm_package_href, opts = {}) ⇒ RpmPackageResponse

Inspect a package A ViewSet for Package.
#read_with_http_info(rpm_package_href, opts = {}) ⇒ Array<(RpmPackageResponse, Integer, Hash)>

Inspect a package A ViewSet for Package.
#set_label(rpm_package_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(rpm_package_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(rpm_package_href, unset_label, opts = {}) ⇒ UnsetLabelResponse

Unset a label Unset a single pulp_label on the object.
#unset_label_with_http_info(rpm_package_href, unset_label, opts = {}) ⇒ Array<(UnsetLabelResponse, Integer, Hash)>

Unset a label Unset a single pulp_label on the object.
#upload(opts = {}) ⇒ RpmPackageResponse

Upload an RPM package synchronously.
#upload_with_http_info(opts = {}) ⇒ Array<(RpmPackageResponse, Integer, Hash)>

Upload an RPM package synchronously.

Constructor Details

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

Returns a new instance of ContentPackagesApi.



19
20
21

# File 'lib/pulp_rpm_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_rpm_client/api/content_packages_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

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

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

Parameters:

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

Path where the artifact is located relative to distributions base_path
: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.
:downloader_config (RemoteNetworkConfig) —

Configuration for the download process (e.g., proxies, auth, timeouts). Only applicable when providing a 'file_url.

Returns:

(AsyncOperationResponse)

# File 'lib/pulp_rpm_client/api/content_packages_api.rb', line 35

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

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

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

Parameters:

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

Path where the artifact is located relative to distributions base_path
: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.
:downloader_config (RemoteNetworkConfig) —

Configuration for the download process (e.g., proxies, auth, timeouts). Only applicable when providing a 'file_url.

Returns:

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

AsyncOperationResponse data, response status code and response headers

# File 'lib/pulp_rpm_client/api/content_packages_api.rb', line 53

def create_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContentPackagesApi.create ...'
  end
  if @api_client.config.client_side_validation && !opts[:'relative_path'].nil? && opts[:'relative_path'].to_s.length < 1
    fail ArgumentError, 'invalid value for "opts[:"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

  # resource path
  local_var_path = '/pulp/api/v3/content/rpm/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['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['relative_path'] = opts[:'relative_path'] if !opts[:'relative_path'].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['downloader_config'] = opts[:'downloader_config'] if !opts[:'downloader_config'].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 = {}) ⇒ `PaginatedrpmPackageResponseList`

List packages

A ViewSet for Package. Define endpoint name which will appear in the API endpoint for this content type. For example: pulp.example.com/pulp/api/v3/content/rpm/packages/ Also specify queryset and serializer for Package.

Parameters:

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

the optional parameters

Options Hash (opts):

:x_task_diagnostics (Array<String>) —

List of profilers to use on tasks.
:arch (String) —

Filter results where arch matches value
:arch__contains (String) —

Filter results where arch contains value
:arch__in (Array<String>) —

Filter results where arch is in a comma-separated list of values
:arch__ne (String) —

Filter results where arch not equal to value
:arch__startswith (String) —

Filter results where arch starts with value
:checksum_type (String) —

Filter results where checksum_type matches value * `unknown` - unknown * `md5` - md5 * `sha1` - sha1 * `sha1` - sha1 * `sha224` - sha224 * `sha256` - sha256 * `sha384` - sha384 * `sha512` - sha512
:checksum_type__in (Array<String>) —

Filter results where checksum_type is in a comma-separated list of values
:checksum_type__ne (String) —

Filter results where checksum_type not equal to value
:epoch (String) —

Filter results where epoch matches value
:epoch__in (Array<String>) —

Filter results where epoch is in a comma-separated list of values
:epoch__ne (String) —

Filter results where epoch not equal to value
:filename (String)
:limit (Integer) —

Number of results to return per page.
:name (String) —

Filter results where name matches value
:name__contains (String) —

Filter results where name contains value
:name__in (Array<String>) —

Filter results where name is in a comma-separated list of values
:name__ne (String) —

Filter results where name not equal to value
:name__startswith (String) —

Filter results where name starts with value
: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) * `name` - Name * `-name` - Name (descending) * `epoch` - Epoch * `-epoch` - Epoch (descending) * `version` - Version * `-version` - Version (descending) * `release` - Release * `-release` - Release (descending) * `arch` - Arch * `-arch` - Arch (descending) * `evr` - Evr * `-evr` - Evr (descending) * `pkgId` - Pkgid * `-pkgId` - Pkgid (descending) * `checksum_type` - Checksum type * `-checksum_type` - Checksum type (descending) * `summary` - Summary * `-summary` - Summary (descending) * `description` - Description * `-description` - Description (descending) * `url` - Url * `-url` - Url (descending) * `changelogs` - Changelogs * `-changelogs` - Changelogs (descending) * `files` - Files * `-files` - Files (descending) * `requires` - Requires * `-requires` - Requires (descending) * `provides` - Provides * `-provides` - Provides (descending) * `conflicts` - Conflicts * `-conflicts` - Conflicts (descending) * `obsoletes` - Obsoletes * `-obsoletes` - Obsoletes (descending) * `suggests` - Suggests * `-suggests` - Suggests (descending) * `enhances` - Enhances * `-enhances` - Enhances (descending) * `recommends` - Recommends * `-recommends` - Recommends (descending) * `supplements` - Supplements * `-supplements` - Supplements (descending) * `location_base` - Location base * `-location_base` - Location base (descending) * `location_href` - Location href * `-location_href` - Location href (descending) * `rpm_buildhost` - Rpm buildhost * `-rpm_buildhost` - Rpm buildhost (descending) * `rpm_group` - Rpm group * `-rpm_group` - Rpm group (descending) * `rpm_license` - Rpm license * `-rpm_license` - Rpm license (descending) * `rpm_packager` - Rpm packager * `-rpm_packager` - Rpm packager (descending) * `rpm_sourcerpm` - Rpm sourcerpm * `-rpm_sourcerpm` - Rpm sourcerpm (descending) * `rpm_vendor` - Rpm vendor * `-rpm_vendor` - Rpm vendor (descending) * `rpm_header_start` - Rpm header start * `-rpm_header_start` - Rpm header start (descending) * `rpm_header_end` - Rpm header end * `-rpm_header_end` - Rpm header end (descending) * `size_archive` - Size archive * `-size_archive` - Size archive (descending) * `size_installed` - Size installed * `-size_installed` - Size installed (descending) * `size_package` - Size package * `-size_package` - Size package (descending) * `time_build` - Time build * `-time_build` - Time build (descending) * `time_file` - Time file * `-time_file` - Time file (descending) * `is_modular` - Is modular * `-is_modular` - Is modular (descending) * `pk` - Pk * `-pk` - Pk (descending)
:orphaned_for (Float) —

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

Filter results where pkgId matches value
:pkg_id__in (Array<String>) —

Filter results where pkgId 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
:release (String) —

Filter results where release matches value
:release__contains (String) —

Filter results where release contains value
:release__in (Array<String>) —

Filter results where release is in a comma-separated list of values
:release__ne (String) —

Filter results where release not equal to value
:release__startswith (String) —

Filter results where release starts with value
:repository_version (String)
:repository_version_added (String)
:repository_version_removed (String)
:sha256 (String)
:version (String) —

Filter results where version matches value
:version__in (Array<String>) —

Filter results where version is in a comma-separated list of values
:version__ne (String) —

Filter results where version not 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:

(PaginatedrpmPackageResponseList)

# File 'lib/pulp_rpm_client/api/content_packages_api.rb', line 166

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

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

List packages

A ViewSet for Package. Define endpoint name which will appear in the API endpoint for this content type. For example: pulp.example.com/pulp/api/v3/content/rpm/packages/ Also specify queryset and serializer for Package.

Parameters:

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

the optional parameters

Options Hash (opts):

:x_task_diagnostics (Array<String>) —

List of profilers to use on tasks.
:arch (String) —

Filter results where arch matches value
:arch__contains (String) —

Filter results where arch contains value
:arch__in (Array<String>) —

Filter results where arch is in a comma-separated list of values
:arch__ne (String) —

Filter results where arch not equal to value
:arch__startswith (String) —

Filter results where arch starts with value
:checksum_type (String) —

Filter results where checksum_type matches value * `unknown` - unknown * `md5` - md5 * `sha1` - sha1 * `sha1` - sha1 * `sha224` - sha224 * `sha256` - sha256 * `sha384` - sha384 * `sha512` - sha512
:checksum_type__in (Array<String>) —

Filter results where checksum_type is in a comma-separated list of values
:checksum_type__ne (String) —

Filter results where checksum_type not equal to value
:epoch (String) —

Filter results where epoch matches value
:epoch__in (Array<String>) —

Filter results where epoch is in a comma-separated list of values
:epoch__ne (String) —

Filter results where epoch not equal to value
:filename (String)
:limit (Integer) —

Number of results to return per page.
:name (String) —

Filter results where name matches value
:name__contains (String) —

Filter results where name contains value
:name__in (Array<String>) —

Filter results where name is in a comma-separated list of values
:name__ne (String) —

Filter results where name not equal to value
:name__startswith (String) —

Filter results where name starts with value
: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) * `name` - Name * `-name` - Name (descending) * `epoch` - Epoch * `-epoch` - Epoch (descending) * `version` - Version * `-version` - Version (descending) * `release` - Release * `-release` - Release (descending) * `arch` - Arch * `-arch` - Arch (descending) * `evr` - Evr * `-evr` - Evr (descending) * `pkgId` - Pkgid * `-pkgId` - Pkgid (descending) * `checksum_type` - Checksum type * `-checksum_type` - Checksum type (descending) * `summary` - Summary * `-summary` - Summary (descending) * `description` - Description * `-description` - Description (descending) * `url` - Url * `-url` - Url (descending) * `changelogs` - Changelogs * `-changelogs` - Changelogs (descending) * `files` - Files * `-files` - Files (descending) * `requires` - Requires * `-requires` - Requires (descending) * `provides` - Provides * `-provides` - Provides (descending) * `conflicts` - Conflicts * `-conflicts` - Conflicts (descending) * `obsoletes` - Obsoletes * `-obsoletes` - Obsoletes (descending) * `suggests` - Suggests * `-suggests` - Suggests (descending) * `enhances` - Enhances * `-enhances` - Enhances (descending) * `recommends` - Recommends * `-recommends` - Recommends (descending) * `supplements` - Supplements * `-supplements` - Supplements (descending) * `location_base` - Location base * `-location_base` - Location base (descending) * `location_href` - Location href * `-location_href` - Location href (descending) * `rpm_buildhost` - Rpm buildhost * `-rpm_buildhost` - Rpm buildhost (descending) * `rpm_group` - Rpm group * `-rpm_group` - Rpm group (descending) * `rpm_license` - Rpm license * `-rpm_license` - Rpm license (descending) * `rpm_packager` - Rpm packager * `-rpm_packager` - Rpm packager (descending) * `rpm_sourcerpm` - Rpm sourcerpm * `-rpm_sourcerpm` - Rpm sourcerpm (descending) * `rpm_vendor` - Rpm vendor * `-rpm_vendor` - Rpm vendor (descending) * `rpm_header_start` - Rpm header start * `-rpm_header_start` - Rpm header start (descending) * `rpm_header_end` - Rpm header end * `-rpm_header_end` - Rpm header end (descending) * `size_archive` - Size archive * `-size_archive` - Size archive (descending) * `size_installed` - Size installed * `-size_installed` - Size installed (descending) * `size_package` - Size package * `-size_package` - Size package (descending) * `time_build` - Time build * `-time_build` - Time build (descending) * `time_file` - Time file * `-time_file` - Time file (descending) * `is_modular` - Is modular * `-is_modular` - Is modular (descending) * `pk` - Pk * `-pk` - Pk (descending)
:orphaned_for (Float) —

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

Filter results where pkgId matches value
:pkg_id__in (Array<String>) —

Filter results where pkgId 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
:release (String) —

Filter results where release matches value
:release__contains (String) —

Filter results where release contains value
:release__in (Array<String>) —

Filter results where release is in a comma-separated list of values
:release__ne (String) —

Filter results where release not equal to value
:release__startswith (String) —

Filter results where release starts with value
:repository_version (String)
:repository_version_added (String)
:repository_version_removed (String)
:sha256 (String)
:version (String) —

Filter results where version matches value
:version__in (Array<String>) —

Filter results where version is in a comma-separated list of values
:version__ne (String) —

Filter results where version not 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<(PaginatedrpmPackageResponseList, Integer, Hash)>) —

PaginatedrpmPackageResponseList data, response status code and response headers

# File 'lib/pulp_rpm_client/api/content_packages_api.rb', line 218

def list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContentPackagesApi.list ...'
  end
  allowable_values = ["md5", "sha1", "sha1", "sha224", "sha256", "sha384", "sha512", "unknown"]
  if @api_client.config.client_side_validation && opts[:'checksum_type'] && !allowable_values.include?(opts[:'checksum_type'])
    fail ArgumentError, "invalid value for \"checksum_type\", must be one of #{allowable_values}"
  end
  allowable_values = ["-arch", "-changelogs", "-checksum_type", "-conflicts", "-description", "-enhances", "-epoch", "-evr", "-files", "-is_modular", "-location_base", "-location_href", "-name", "-obsoletes", "-pk", "-pkgId", "-provides", "-pulp_created", "-pulp_id", "-pulp_labels", "-pulp_last_updated", "-pulp_type", "-recommends", "-release", "-requires", "-rpm_buildhost", "-rpm_group", "-rpm_header_end", "-rpm_header_start", "-rpm_license", "-rpm_packager", "-rpm_sourcerpm", "-rpm_vendor", "-size_archive", "-size_installed", "-size_package", "-suggests", "-summary", "-supplements", "-time_build", "-time_file", "-timestamp_of_interest", "-upstream_id", "-url", "-version", "arch", "changelogs", "checksum_type", "conflicts", "description", "enhances", "epoch", "evr", "files", "is_modular", "location_base", "location_href", "name", "obsoletes", "pk", "pkgId", "provides", "pulp_created", "pulp_id", "pulp_labels", "pulp_last_updated", "pulp_type", "recommends", "release", "requires", "rpm_buildhost", "rpm_group", "rpm_header_end", "rpm_header_start", "rpm_license", "rpm_packager", "rpm_sourcerpm", "rpm_vendor", "size_archive", "size_installed", "size_package", "suggests", "summary", "supplements", "time_build", "time_file", "timestamp_of_interest", "upstream_id", "url", "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
  # resource path
  local_var_path = '/pulp/api/v3/content/rpm/packages/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'arch'] = opts[:'arch'] if !opts[:'arch'].nil?
  query_params[:'arch__contains'] = opts[:'arch__contains'] if !opts[:'arch__contains'].nil?
  query_params[:'arch__in'] = @api_client.build_collection_param(opts[:'arch__in'], :csv) if !opts[:'arch__in'].nil?
  query_params[:'arch__ne'] = opts[:'arch__ne'] if !opts[:'arch__ne'].nil?
  query_params[:'arch__startswith'] = opts[:'arch__startswith'] if !opts[:'arch__startswith'].nil?
  query_params[:'checksum_type'] = opts[:'checksum_type'] if !opts[:'checksum_type'].nil?
  query_params[:'checksum_type__in'] = @api_client.build_collection_param(opts[:'checksum_type__in'], :csv) if !opts[:'checksum_type__in'].nil?
  query_params[:'checksum_type__ne'] = opts[:'checksum_type__ne'] if !opts[:'checksum_type__ne'].nil?
  query_params[:'epoch'] = opts[:'epoch'] if !opts[:'epoch'].nil?
  query_params[:'epoch__in'] = @api_client.build_collection_param(opts[:'epoch__in'], :csv) if !opts[:'epoch__in'].nil?
  query_params[:'epoch__ne'] = opts[:'epoch__ne'] if !opts[:'epoch__ne'].nil?
  query_params[:'filename'] = opts[:'filename'] if !opts[:'filename'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'name__contains'] = opts[:'name__contains'] if !opts[:'name__contains'].nil?
  query_params[:'name__in'] = @api_client.build_collection_param(opts[:'name__in'], :csv) if !opts[:'name__in'].nil?
  query_params[:'name__ne'] = opts[:'name__ne'] if !opts[:'name__ne'].nil?
  query_params[:'name__startswith'] = opts[:'name__startswith'] if !opts[:'name__startswith'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'ordering'] = @api_client.build_collection_param(opts[:'ordering'], :csv) if !opts[:'ordering'].nil?
  query_params[:'orphaned_for'] = opts[:'orphaned_for'] if !opts[:'orphaned_for'].nil?
  query_params[:'pkgId'] = opts[:'pkg_id'] if !opts[:'pkg_id'].nil?
  query_params[:'pkgId__in'] = @api_client.build_collection_param(opts[:'pkg_id__in'], :csv) if !opts[:'pkg_id__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[:'release'] = opts[:'release'] if !opts[:'release'].nil?
  query_params[:'release__contains'] = opts[:'release__contains'] if !opts[:'release__contains'].nil?
  query_params[:'release__in'] = @api_client.build_collection_param(opts[:'release__in'], :csv) if !opts[:'release__in'].nil?
  query_params[:'release__ne'] = opts[:'release__ne'] if !opts[:'release__ne'].nil?
  query_params[:'release__startswith'] = opts[:'release__startswith'] if !opts[:'release__startswith'].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[:'sha256'] = opts[:'sha256'] if !opts[:'sha256'].nil?
  query_params[:'version'] = opts[:'version'] if !opts[:'version'].nil?
  query_params[:'version__in'] = @api_client.build_collection_param(opts[:'version__in'], :csv) if !opts[:'version__in'].nil?
  query_params[:'version__ne'] = opts[:'version__ne'] if !opts[:'version__ne'].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] || 'PaginatedrpmPackageResponseList'

  # 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(rpm_package_href, opts = {}) ⇒ `RpmPackageResponse`

Inspect a package

A ViewSet for Package. Define endpoint name which will appear in the API endpoint for this content type. For example: pulp.example.com/pulp/api/v3/content/rpm/packages/ Also specify queryset and serializer for Package.

Parameters:

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

(RpmPackageResponse)

# File 'lib/pulp_rpm_client/api/content_packages_api.rb', line 321

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

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

Inspect a package

A ViewSet for Package. Define endpoint name which will appear in the API endpoint for this content type. For example: pulp.example.com/pulp/api/v3/content/rpm/packages/ Also specify queryset and serializer for Package.

Parameters:

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

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

RpmPackageResponse data, response status code and response headers

# File 'lib/pulp_rpm_client/api/content_packages_api.rb', line 334

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

  # 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(rpm_package_href, set_label, opts = {}) ⇒ `SetLabelResponse`

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

Parameters:

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

(SetLabelResponse)

# File 'lib/pulp_rpm_client/api/content_packages_api.rb', line 392

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

#set_label_with_http_info(rpm_package_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:

rpm_package_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

# File 'lib/pulp_rpm_client/api/content_packages_api.rb', line 404

def set_label_with_http_info(rpm_package_href, set_label, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContentPackagesApi.set_label ...'
  end
  # verify the required parameter 'rpm_package_href' is set
  if @api_client.config.client_side_validation && rpm_package_href.nil?
    fail ArgumentError, "Missing the required parameter 'rpm_package_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 = '{rpm_package_href}set_label/'.sub('{' + 'rpm_package_href' + '}', CGI.escape(rpm_package_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(rpm_package_href, unset_label, opts = {}) ⇒ `UnsetLabelResponse`

Unset a label Unset a single pulp_label on the object.

Parameters:

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

(UnsetLabelResponse)

# File 'lib/pulp_rpm_client/api/content_packages_api.rb', line 469

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

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

Unset a label Unset a single pulp_label on the object.

Parameters:

rpm_package_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

# File 'lib/pulp_rpm_client/api/content_packages_api.rb', line 481

def unset_label_with_http_info(rpm_package_href, unset_label, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContentPackagesApi.unset_label ...'
  end
  # verify the required parameter 'rpm_package_href' is set
  if @api_client.config.client_side_validation && rpm_package_href.nil?
    fail ArgumentError, "Missing the required parameter 'rpm_package_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 = '{rpm_package_href}unset_label/'.sub('{' + 'rpm_package_href' + '}', CGI.escape(rpm_package_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 = {}) ⇒ `RpmPackageResponse`

Upload an RPM package synchronously. Synchronously upload an RPM 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.
:downloader_config (RemoteNetworkConfig) —

Configuration for the download process (e.g., proxies, auth, timeouts). Only applicable when providing a 'file_url.

Returns:

(RpmPackageResponse)

# File 'lib/pulp_rpm_client/api/content_packages_api.rb', line 550

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

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

Upload an RPM package synchronously. Synchronously upload an RPM 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.
:downloader_config (RemoteNetworkConfig) —

Configuration for the download process (e.g., proxies, auth, timeouts). Only applicable when providing a 'file_url.

Returns:

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

RpmPackageResponse data, response status code and response headers

# File 'lib/pulp_rpm_client/api/content_packages_api.rb', line 566

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

  # resource path
  local_var_path = '/pulp/api/v3/content/rpm/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['downloader_config'] = opts[:'downloader_config'] if !opts[:'downloader_config'].nil?

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

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

  # 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

Class: PulpRpmClient::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(opts = {}) ⇒ AsyncOperationResponse

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

#list(opts = {}) ⇒ PaginatedrpmPackageResponseList

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

#read(rpm_package_href, opts = {}) ⇒ RpmPackageResponse

#read_with_http_info(rpm_package_href, opts = {}) ⇒ Array<(RpmPackageResponse, Integer, Hash)>

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

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

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

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

#upload(opts = {}) ⇒ RpmPackageResponse

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

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

#api_client ⇒ `Object`

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

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

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

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

#read(rpm_package_href, opts = {}) ⇒ `RpmPackageResponse`

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

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

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

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

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

#upload(opts = {}) ⇒ `RpmPackageResponse`

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