Class: PulpDebClient::ContentPackagesApi

Inherits:

Object

Object
PulpDebClient::ContentPackagesApi

show all

Defined in:: lib/pulp_deb_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 content,optionally create new repository version.
#create_with_http_info(opts = {}) ⇒ Array<(AsyncOperationResponse, Integer, Hash)>

Create a package 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 = {}) ⇒ PaginateddebPackageResponseList

List packages A Package represents a ‘.deb’ binary package.
#list_with_http_info(opts = {}) ⇒ Array<(PaginateddebPackageResponseList, Integer, Hash)>

List packages A Package represents a '.deb' binary package.
#read(deb_package_href, opts = {}) ⇒ DebPackageResponse

Inspect a package A Package represents a ‘.deb’ binary package.
#read_with_http_info(deb_package_href, opts = {}) ⇒ Array<(DebPackageResponse, Integer, Hash)>

Inspect a package A Package represents a '.deb' binary package.
#set_label(deb_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(deb_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(deb_package_href, unset_label, opts = {}) ⇒ UnsetLabelResponse

Unset a label Unset a single pulp_label on the object.
#unset_label_with_http_info(deb_package_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_deb_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_deb_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 content,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.
:distribution (String) —

Name of the distribution.
:component (String) —

Name of the component.

Returns:

(AsyncOperationResponse)

# File 'lib/pulp_deb_client/api/content_packages_api.rb', line 36

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 content,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.
:distribution (String) —

Name of the distribution.
:component (String) —

Name of the component.

Returns:

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

AsyncOperationResponse data, response status code and response headers

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

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

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

  if @api_client.config.client_side_validation && !opts[:'component'].nil? && opts[:'component'].to_s.length < 1
    fail ArgumentError, 'invalid value for "opts[:"component"]" 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/deb/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['distribution'] = opts[:'distribution'] if !opts[:'distribution'].nil?
  form_params['component'] = opts[:'component'] if !opts[:'component'].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 = {}) ⇒ `PaginateddebPackageResponseList`

List packages A Package represents a ‘.deb’ binary package. Associated artifacts: Exactly one ‘.deb’ package file.

Parameters:

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

the optional parameters

Options Hash (opts):

:x_task_diagnostics (Array<String>) —

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

Filter results where architecture matches value
:auto_built_package (String) —

Filter results where auto_built_package matches value
:build_essential (Boolean) —

Filter results where build_essential matches value * `True` - yes * `False` - no
:built_using (String) —

Filter results where built_using matches value
:essential (Boolean) —

Filter results where essential matches value * `True` - yes * `False` - no
:installed_size (Integer) —

Filter results where installed_size matches value
:limit (Integer) —

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

Filter results where maintainer matches value
:multi_arch (String) —

Filter results where multi_arch matches value * `no` - no * `same` - same * `foreign` - foreign * `allowed` - allowed
: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) * `package` - Package * `-package` - Package (descending) * `source` - Source * `-source` - Source (descending) * `version` - Version * `-version` - Version (descending) * `architecture` - Architecture * `-architecture` - Architecture (descending) * `section` - Section * `-section` - Section (descending) * `priority` - Priority * `-priority` - Priority (descending) * `origin` - Origin * `-origin` - Origin (descending) * `tag` - Tag * `-tag` - Tag (descending) * `bugs` - Bugs * `-bugs` - Bugs (descending) * `essential` - Essential * `-essential` - Essential (descending) * `build_essential` - Build essential * `-build_essential` - Build essential (descending) * `installed_size` - Installed size * `-installed_size` - Installed size (descending) * `maintainer` - Maintainer * `-maintainer` - Maintainer (descending) * `original_maintainer` - Original maintainer * `-original_maintainer` - Original maintainer (descending) * `description` - Description * `-description` - Description (descending) * `description_md5` - Description md5 * `-description_md5` - Description md5 (descending) * `homepage` - Homepage * `-homepage` - Homepage (descending) * `built_using` - Built using * `-built_using` - Built using (descending) * `auto_built_package` - Auto built package * `-auto_built_package` - Auto built package (descending) * `multi_arch` - Multi arch * `-multi_arch` - Multi arch (descending) * `breaks` - Breaks * `-breaks` - Breaks (descending) * `conflicts` - Conflicts * `-conflicts` - Conflicts (descending) * `depends` - Depends * `-depends` - Depends (descending) * `recommends` - Recommends * `-recommends` - Recommends (descending) * `suggests` - Suggests * `-suggests` - Suggests (descending) * `enhances` - Enhances * `-enhances` - Enhances (descending) * `pre_depends` - Pre depends * `-pre_depends` - Pre depends (descending) * `provides` - Provides * `-provides` - Provides (descending) * `replaces` - Replaces * `-replaces` - Replaces (descending) * `relative_path` - Relative path * `-relative_path` - Relative path (descending) * `sha256` - Sha256 * `-sha256` - Sha256 (descending) * `custom_fields` - Custom fields * `-custom_fields` - Custom fields (descending) * `pk` - Pk * `-pk` - Pk (descending)
:origin (String) —

Filter results where origin matches value
:original_maintainer (String) —

Filter results where original_maintainer matches value
:orphaned_for (Float) —

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

Filter results where package matches value
:package__contains (String) —

Filter results where package contains value
:package__icontains (String) —

Filter results where package contains value
:package__iexact (String) —

Filter results where package matches value
:package__in (Array<String>) —

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

Filter results where package matches regex value
:package__istartswith (String) —

Filter results where package starts with value
:package__regex (String) —

Filter results where package matches regex value
:package__startswith (String) —

Filter results where package starts with value
:priority (String) —

Filter results where priority matches value
: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
:relative_path (String) —

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

Must be a comma-separated string: "release_href,repository_or_repository_version_href" release_href: Filter results where Package in Release repository_or_repository_version_href: The RepositoryVersion href to filter by, or Repository href (assume latest version)
:release_component (String) —

Must be a comma-separated string: "release_component_href,repository_or_repository_version_href" release_component_href: Filter results where Package in ReleaseComponent repository_or_repository_version_href: The RepositoryVersion href to filter by, or Repository href (assume latest version)
: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
:section (String) —

Filter results where section matches value
:sha256 (String) —

Filter results where sha256 matches value
:source (String) —

Filter results where source matches value
:tag (String) —

Filter results where tag matches value
:version (String) —

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

(PaginateddebPackageResponseList)

# File 'lib/pulp_deb_client/api/content_packages_api.rb', line 177

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

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

List packages A Package represents a '.deb' binary package. Associated artifacts: Exactly one '.deb' package file.

Parameters:

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

the optional parameters

Options Hash (opts):

:x_task_diagnostics (Array<String>) —

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

Filter results where architecture matches value
:auto_built_package (String) —

Filter results where auto_built_package matches value
:build_essential (Boolean) —

Filter results where build_essential matches value * `True` - yes * `False` - no
:built_using (String) —

Filter results where built_using matches value
:essential (Boolean) —

Filter results where essential matches value * `True` - yes * `False` - no
:installed_size (Integer) —

Filter results where installed_size matches value
:limit (Integer) —

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

Filter results where maintainer matches value
:multi_arch (String) —

Filter results where multi_arch matches value * `no` - no * `same` - same * `foreign` - foreign * `allowed` - allowed
: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) * `package` - Package * `-package` - Package (descending) * `source` - Source * `-source` - Source (descending) * `version` - Version * `-version` - Version (descending) * `architecture` - Architecture * `-architecture` - Architecture (descending) * `section` - Section * `-section` - Section (descending) * `priority` - Priority * `-priority` - Priority (descending) * `origin` - Origin * `-origin` - Origin (descending) * `tag` - Tag * `-tag` - Tag (descending) * `bugs` - Bugs * `-bugs` - Bugs (descending) * `essential` - Essential * `-essential` - Essential (descending) * `build_essential` - Build essential * `-build_essential` - Build essential (descending) * `installed_size` - Installed size * `-installed_size` - Installed size (descending) * `maintainer` - Maintainer * `-maintainer` - Maintainer (descending) * `original_maintainer` - Original maintainer * `-original_maintainer` - Original maintainer (descending) * `description` - Description * `-description` - Description (descending) * `description_md5` - Description md5 * `-description_md5` - Description md5 (descending) * `homepage` - Homepage * `-homepage` - Homepage (descending) * `built_using` - Built using * `-built_using` - Built using (descending) * `auto_built_package` - Auto built package * `-auto_built_package` - Auto built package (descending) * `multi_arch` - Multi arch * `-multi_arch` - Multi arch (descending) * `breaks` - Breaks * `-breaks` - Breaks (descending) * `conflicts` - Conflicts * `-conflicts` - Conflicts (descending) * `depends` - Depends * `-depends` - Depends (descending) * `recommends` - Recommends * `-recommends` - Recommends (descending) * `suggests` - Suggests * `-suggests` - Suggests (descending) * `enhances` - Enhances * `-enhances` - Enhances (descending) * `pre_depends` - Pre depends * `-pre_depends` - Pre depends (descending) * `provides` - Provides * `-provides` - Provides (descending) * `replaces` - Replaces * `-replaces` - Replaces (descending) * `relative_path` - Relative path * `-relative_path` - Relative path (descending) * `sha256` - Sha256 * `-sha256` - Sha256 (descending) * `custom_fields` - Custom fields * `-custom_fields` - Custom fields (descending) * `pk` - Pk * `-pk` - Pk (descending)
:origin (String) —

Filter results where origin matches value
:original_maintainer (String) —

Filter results where original_maintainer matches value
:orphaned_for (Float) —

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

Filter results where package matches value
:package__contains (String) —

Filter results where package contains value
:package__icontains (String) —

Filter results where package contains value
:package__iexact (String) —

Filter results where package matches value
:package__in (Array<String>) —

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

Filter results where package matches regex value
:package__istartswith (String) —

Filter results where package starts with value
:package__regex (String) —

Filter results where package matches regex value
:package__startswith (String) —

Filter results where package starts with value
:priority (String) —

Filter results where priority matches value
: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
:relative_path (String) —

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

Must be a comma-separated string: "release_href,repository_or_repository_version_href" release_href: Filter results where Package in Release repository_or_repository_version_href: The RepositoryVersion href to filter by, or Repository href (assume latest version)
:release_component (String) —

Must be a comma-separated string: "release_component_href,repository_or_repository_version_href" release_component_href: Filter results where Package in ReleaseComponent repository_or_repository_version_href: The RepositoryVersion href to filter by, or Repository href (assume latest version)
: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
:section (String) —

Filter results where section matches value
:sha256 (String) —

Filter results where sha256 matches value
:source (String) —

Filter results where source matches value
:tag (String) —

Filter results where tag matches value
:version (String) —

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

PaginateddebPackageResponseList data, response status code and response headers

# File 'lib/pulp_deb_client/api/content_packages_api.rb', line 229

def list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContentPackagesApi.list ...'
  end
  allowable_values = ["allowed", "foreign", "no", "same"]
  if @api_client.config.client_side_validation && opts[:'multi_arch'] && !allowable_values.include?(opts[:'multi_arch'])
    fail ArgumentError, "invalid value for \"multi_arch\", must be one of #{allowable_values}"
  end
  allowable_values = ["-architecture", "-auto_built_package", "-breaks", "-bugs", "-build_essential", "-built_using", "-conflicts", "-custom_fields", "-depends", "-description", "-description_md5", "-enhances", "-essential", "-homepage", "-installed_size", "-maintainer", "-multi_arch", "-origin", "-original_maintainer", "-package", "-pk", "-pre_depends", "-priority", "-provides", "-pulp_created", "-pulp_id", "-pulp_labels", "-pulp_last_updated", "-pulp_type", "-recommends", "-relative_path", "-replaces", "-section", "-sha256", "-source", "-suggests", "-tag", "-timestamp_of_interest", "-upstream_id", "-version", "architecture", "auto_built_package", "breaks", "bugs", "build_essential", "built_using", "conflicts", "custom_fields", "depends", "description", "description_md5", "enhances", "essential", "homepage", "installed_size", "maintainer", "multi_arch", "origin", "original_maintainer", "package", "pk", "pre_depends", "priority", "provides", "pulp_created", "pulp_id", "pulp_labels", "pulp_last_updated", "pulp_type", "recommends", "relative_path", "replaces", "section", "sha256", "source", "suggests", "tag", "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
  # resource path
  local_var_path = '/pulp/api/v3/content/deb/packages/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'architecture'] = opts[:'architecture'] if !opts[:'architecture'].nil?
  query_params[:'auto_built_package'] = opts[:'auto_built_package'] if !opts[:'auto_built_package'].nil?
  query_params[:'build_essential'] = opts[:'build_essential'] if !opts[:'build_essential'].nil?
  query_params[:'built_using'] = opts[:'built_using'] if !opts[:'built_using'].nil?
  query_params[:'essential'] = opts[:'essential'] if !opts[:'essential'].nil?
  query_params[:'installed_size'] = opts[:'installed_size'] if !opts[:'installed_size'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'maintainer'] = opts[:'maintainer'] if !opts[:'maintainer'].nil?
  query_params[:'multi_arch'] = opts[:'multi_arch'] if !opts[:'multi_arch'].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[:'origin'] = opts[:'origin'] if !opts[:'origin'].nil?
  query_params[:'original_maintainer'] = opts[:'original_maintainer'] if !opts[:'original_maintainer'].nil?
  query_params[:'orphaned_for'] = opts[:'orphaned_for'] if !opts[:'orphaned_for'].nil?
  query_params[:'package'] = opts[:'package'] if !opts[:'package'].nil?
  query_params[:'package__contains'] = opts[:'package__contains'] if !opts[:'package__contains'].nil?
  query_params[:'package__icontains'] = opts[:'package__icontains'] if !opts[:'package__icontains'].nil?
  query_params[:'package__iexact'] = opts[:'package__iexact'] if !opts[:'package__iexact'].nil?
  query_params[:'package__in'] = @api_client.build_collection_param(opts[:'package__in'], :csv) if !opts[:'package__in'].nil?
  query_params[:'package__iregex'] = opts[:'package__iregex'] if !opts[:'package__iregex'].nil?
  query_params[:'package__istartswith'] = opts[:'package__istartswith'] if !opts[:'package__istartswith'].nil?
  query_params[:'package__regex'] = opts[:'package__regex'] if !opts[:'package__regex'].nil?
  query_params[:'package__startswith'] = opts[:'package__startswith'] if !opts[:'package__startswith'].nil?
  query_params[:'priority'] = opts[:'priority'] if !opts[:'priority'].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[:'relative_path'] = opts[:'relative_path'] if !opts[:'relative_path'].nil?
  query_params[:'release'] = opts[:'release'] if !opts[:'release'].nil?
  query_params[:'release_component'] = opts[:'release_component'] if !opts[:'release_component'].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[:'section'] = opts[:'section'] if !opts[:'section'].nil?
  query_params[:'sha256'] = opts[:'sha256'] if !opts[:'sha256'].nil?
  query_params[:'source'] = opts[:'source'] if !opts[:'source'].nil?
  query_params[:'tag'] = opts[:'tag'] if !opts[:'tag'].nil?
  query_params[:'version'] = opts[:'version'] if !opts[:'version'].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] || 'PaginateddebPackageResponseList'

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

Inspect a package A Package represents a ‘.deb’ binary package. Associated artifacts: Exactly one ‘.deb’ package file.

Parameters:

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

(DebPackageResponse)

# File 'lib/pulp_deb_client/api/content_packages_api.rb', line 332

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

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

Inspect a package A Package represents a '.deb' binary package. Associated artifacts: Exactly one '.deb' package file.

Parameters:

deb_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<(DebPackageResponse, Integer, Hash)>) —

DebPackageResponse data, response status code and response headers

# File 'lib/pulp_deb_client/api/content_packages_api.rb', line 345

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

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

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

Parameters:

deb_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_deb_client/api/content_packages_api.rb', line 403

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

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

deb_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_deb_client/api/content_packages_api.rb', line 415

def set_label_with_http_info(deb_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 'deb_package_href' is set
  if @api_client.config.client_side_validation && deb_package_href.nil?
    fail ArgumentError, "Missing the required parameter 'deb_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 = '{deb_package_href}set_label/'.sub('{' + 'deb_package_href' + '}', CGI.escape(deb_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(deb_package_href, unset_label, opts = {}) ⇒ `UnsetLabelResponse`

Unset a label Unset a single pulp_label on the object.

Parameters:

deb_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_deb_client/api/content_packages_api.rb', line 480

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

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

Unset a label Unset a single pulp_label on the object.

Parameters:

deb_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_deb_client/api/content_packages_api.rb', line 492

def unset_label_with_http_info(deb_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 'deb_package_href' is set
  if @api_client.config.client_side_validation && deb_package_href.nil?
    fail ArgumentError, "Missing the required parameter 'deb_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 = '{deb_package_href}unset_label/'.sub('{' + 'deb_package_href' + '}', CGI.escape(deb_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

Class: PulpDebClient::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 = {}) ⇒ PaginateddebPackageResponseList

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

#read(deb_package_href, opts = {}) ⇒ DebPackageResponse

#read_with_http_info(deb_package_href, opts = {}) ⇒ Array<(DebPackageResponse, Integer, Hash)>

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

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

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

#unset_label_with_http_info(deb_package_href, unset_label, opts = {}) ⇒ Array<(UnsetLabelResponse, 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 = {}) ⇒ `PaginateddebPackageResponseList`

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

#read(deb_package_href, opts = {}) ⇒ `DebPackageResponse`

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

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

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

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

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