pulp_deb_client

PulpDebClient - the Ruby gem for the Pulp 3 API

Fetch, Upload, Organize, and Distribute Software Packages

This SDK is automatically generated by the OpenAPI Generator project:

API version: v3
Package version: 3.5.3
Generator version: 7.10.0
Build package: org.openapitools.codegen.languages.RubyClientCodegen For more information, please visit https://pulpproject.org

Installation

Build a gem

To build the Ruby code into a gem:

gem build pulp_deb_client.gemspec

Then either install the gem locally:

gem install ./pulp_deb_client-3.5.3.gem

(for development, run gem install --dev ./pulp_deb_client-3.5.3.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'pulp_deb_client', '~> 3.5.3'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:

gem 'pulp_deb_client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'pulp_deb_client'

# Setup authorization
PulpDebClient.configure do |config|
  # Configure HTTP basic authorization: basicAuth
  config.username = 'YOUR_USERNAME'
  config.password = 'YOUR_PASSWORD'
  # Configure faraday connection
  config.configure_faraday_connection { |connection| 'YOUR CONNECTION CONFIG PROC' }
end

api_instance = PulpDebClient::ContentGenericContentsApi.new
relative_path = 'relative_path_example' # String | Path where the artifact is located relative to distributions base_path
opts = {
  x_task_diagnostics: ['inner_example'], # Array<String> | List of profilers to use on tasks.
  repository: 'repository_example', # String | A URI of a repository the new content unit should be associated with.
  pulp_labels: { key: 'inner_example'}, # Hash<String, String> | A dictionary of arbitrary key/value pairs used to describe a specific Content instance.
  artifact: 'artifact_example', # String | Artifact file representing the physical content
  file: File.new('/path/to/some/file'), # File | An uploaded file that may be turned into the content unit.
  upload: 'upload_example', # String | An uncommitted upload that may be turned into the content unit.
  file_url: 'file_url_example' # String | A url that Pulp can download and turn into the content unit.
}

begin
  #Create a generic content
  result = api_instance.create(relative_path, opts)
  p result
rescue PulpDebClient::ApiError => e
  puts "Exception when calling ContentGenericContentsApi->create: #{e}"
end

Documentation for API Endpoints

All URIs are relative to http://localhost:24817

Class	Method	HTTP request	Description
PulpDebClient::ContentGenericContentsApi	create	POST /pulp/api/v3/content/deb/generic_contents/	Create a generic content
PulpDebClient::ContentGenericContentsApi	list	GET /pulp/api/v3/content/deb/generic_contents/	List generic contents
PulpDebClient::ContentGenericContentsApi	read	GET deb_generic_content_href	Inspect a generic content
PulpDebClient::ContentGenericContentsApi	set_label	POST deb_generic_content_hrefset_label/	Set a label
PulpDebClient::ContentGenericContentsApi	unset_label	POST deb_generic_content_hrefunset_label/	Unset a label
PulpDebClient::ContentInstallerFileIndicesApi	create	POST /pulp/api/v3/content/deb/installer_file_indices/	Create an installer file index
PulpDebClient::ContentInstallerFileIndicesApi	list	GET /pulp/api/v3/content/deb/installer_file_indices/	List InstallerFileIndices
PulpDebClient::ContentInstallerFileIndicesApi	read	GET deb_installer_file_index_href	Inspect an installer file index
PulpDebClient::ContentInstallerFileIndicesApi	set_label	POST deb_installer_file_index_hrefset_label/	Set a label
PulpDebClient::ContentInstallerFileIndicesApi	unset_label	POST deb_installer_file_index_hrefunset_label/	Unset a label
PulpDebClient::ContentInstallerPackagesApi	create	POST /pulp/api/v3/content/deb/installer_packages/	Create an installer package
PulpDebClient::ContentInstallerPackagesApi	list	GET /pulp/api/v3/content/deb/installer_packages/	List installer packages
PulpDebClient::ContentInstallerPackagesApi	read	GET deb_installer_package_href	Inspect an installer package
PulpDebClient::ContentInstallerPackagesApi	set_label	POST deb_installer_package_hrefset_label/	Set a label
PulpDebClient::ContentInstallerPackagesApi	unset_label	POST deb_installer_package_hrefunset_label/	Unset a label
PulpDebClient::ContentPackageIndicesApi	create	POST /pulp/api/v3/content/deb/package_indices/	Create a package index
PulpDebClient::ContentPackageIndicesApi	list	GET /pulp/api/v3/content/deb/package_indices/	List PackageIndices
PulpDebClient::ContentPackageIndicesApi	read	GET deb_package_index_href	Inspect a package index
PulpDebClient::ContentPackageIndicesApi	set_label	POST deb_package_index_hrefset_label/	Set a label
PulpDebClient::ContentPackageIndicesApi	unset_label	POST deb_package_index_hrefunset_label/	Unset a label
PulpDebClient::ContentPackageReleaseComponentsApi	create	POST /pulp/api/v3/content/deb/package_release_components/	Create a package release component
PulpDebClient::ContentPackageReleaseComponentsApi	list	GET /pulp/api/v3/content/deb/package_release_components/	List package release components
PulpDebClient::ContentPackageReleaseComponentsApi	read	GET deb_package_release_component_href	Inspect a package release component
PulpDebClient::ContentPackageReleaseComponentsApi	set_label	POST deb_package_release_component_hrefset_label/	Set a label
PulpDebClient::ContentPackageReleaseComponentsApi	unset_label	POST deb_package_release_component_hrefunset_label/	Unset a label
PulpDebClient::ContentPackagesApi	create	POST /pulp/api/v3/content/deb/packages/	Create a package
PulpDebClient::ContentPackagesApi	list	GET /pulp/api/v3/content/deb/packages/	List packages
PulpDebClient::ContentPackagesApi	read	GET deb_package_href	Inspect a package
PulpDebClient::ContentPackagesApi	set_label	POST deb_package_hrefset_label/	Set a label
PulpDebClient::ContentPackagesApi	unset_label	POST deb_package_hrefunset_label/	Unset a label
PulpDebClient::ContentReleaseArchitecturesApi	create	POST /pulp/api/v3/content/deb/release_architectures/	Create a release architecture
PulpDebClient::ContentReleaseArchitecturesApi	list	GET /pulp/api/v3/content/deb/release_architectures/	List release architectures
PulpDebClient::ContentReleaseArchitecturesApi	read	GET deb_release_architecture_href	Inspect a release architecture
PulpDebClient::ContentReleaseArchitecturesApi	set_label	POST deb_release_architecture_hrefset_label/	Set a label
PulpDebClient::ContentReleaseArchitecturesApi	unset_label	POST deb_release_architecture_hrefunset_label/	Unset a label
PulpDebClient::ContentReleaseComponentsApi	create	POST /pulp/api/v3/content/deb/release_components/	Create a release component
PulpDebClient::ContentReleaseComponentsApi	list	GET /pulp/api/v3/content/deb/release_components/	List release components
PulpDebClient::ContentReleaseComponentsApi	read	GET deb_release_component_href	Inspect a release component
PulpDebClient::ContentReleaseComponentsApi	set_label	POST deb_release_component_hrefset_label/	Set a label
PulpDebClient::ContentReleaseComponentsApi	unset_label	POST deb_release_component_hrefunset_label/	Unset a label
PulpDebClient::ContentReleaseFilesApi	create	POST /pulp/api/v3/content/deb/release_files/	Create a release file
PulpDebClient::ContentReleaseFilesApi	list	GET /pulp/api/v3/content/deb/release_files/	List release files
PulpDebClient::ContentReleaseFilesApi	read	GET deb_release_file_href	Inspect a release file
PulpDebClient::ContentReleaseFilesApi	set_label	POST deb_release_file_hrefset_label/	Set a label
PulpDebClient::ContentReleaseFilesApi	unset_label	POST deb_release_file_hrefunset_label/	Unset a label
PulpDebClient::ContentReleasesApi	create	POST /pulp/api/v3/content/deb/releases/	Create a release
PulpDebClient::ContentReleasesApi	list	GET /pulp/api/v3/content/deb/releases/	List releases
PulpDebClient::ContentReleasesApi	read	GET deb_release_href	Inspect a release
PulpDebClient::ContentReleasesApi	set_label	POST deb_release_hrefset_label/	Set a label
PulpDebClient::ContentReleasesApi	unset_label	POST deb_release_hrefunset_label/	Unset a label
PulpDebClient::ContentSourceIndicesApi	create	POST /pulp/api/v3/content/deb/source_indices/	Create a source index
PulpDebClient::ContentSourceIndicesApi	list	GET /pulp/api/v3/content/deb/source_indices/	List SourceIndices
PulpDebClient::ContentSourceIndicesApi	read	GET deb_source_index_href	Inspect a source index
PulpDebClient::ContentSourceIndicesApi	set_label	POST deb_source_index_hrefset_label/	Set a label
PulpDebClient::ContentSourceIndicesApi	unset_label	POST deb_source_index_hrefunset_label/	Unset a label
PulpDebClient::ContentSourcePackagesApi	create	POST /pulp/api/v3/content/deb/source_packages/	Create a source package
PulpDebClient::ContentSourcePackagesApi	list	GET /pulp/api/v3/content/deb/source_packages/	List source packages
PulpDebClient::ContentSourcePackagesApi	read	GET deb_source_package_href	Inspect a source package
PulpDebClient::ContentSourcePackagesApi	set_label	POST deb_source_package_hrefset_label/	Set a label
PulpDebClient::ContentSourcePackagesApi	unset_label	POST deb_source_package_hrefunset_label/	Unset a label
PulpDebClient::ContentSourceReleaseComponentsApi	create	POST /pulp/api/v3/content/deb/source_release_components/	Create a source package release component
PulpDebClient::ContentSourceReleaseComponentsApi	list	GET /pulp/api/v3/content/deb/source_release_components/	List source package release components
PulpDebClient::ContentSourceReleaseComponentsApi	read	GET deb_source_package_release_component_href	Inspect a source package release component
PulpDebClient::ContentSourceReleaseComponentsApi	set_label	POST deb_source_package_release_component_hrefset_label/	Set a label
PulpDebClient::ContentSourceReleaseComponentsApi	unset_label	POST deb_source_package_release_component_hrefunset_label/	Unset a label
PulpDebClient::DebCopyApi	copy_content	POST /pulp/api/v3/deb/copy/	Copy content
PulpDebClient::DistributionsAptApi	add_role	POST deb_apt_distribution_hrefadd_role/	Add a role
PulpDebClient::DistributionsAptApi	create	POST /pulp/api/v3/distributions/deb/apt/	Create an apt distribution
PulpDebClient::DistributionsAptApi	delete	DELETE deb_apt_distribution_href	Delete an apt distribution
PulpDebClient::DistributionsAptApi	list	GET /pulp/api/v3/distributions/deb/apt/	List apt distributions
PulpDebClient::DistributionsAptApi	list_roles	GET deb_apt_distribution_hreflist_roles/	List roles
PulpDebClient::DistributionsAptApi	my_permissions	GET deb_apt_distribution_hrefmy_permissions/	List user permissions
PulpDebClient::DistributionsAptApi	partial_update	PATCH deb_apt_distribution_href	Update an apt distribution
PulpDebClient::DistributionsAptApi	read	GET deb_apt_distribution_href	Inspect an apt distribution
PulpDebClient::DistributionsAptApi	remove_role	POST deb_apt_distribution_hrefremove_role/	Remove a role
PulpDebClient::DistributionsAptApi	set_label	POST deb_apt_distribution_hrefset_label/	Set a label
PulpDebClient::DistributionsAptApi	unset_label	POST deb_apt_distribution_hrefunset_label/	Unset a label
PulpDebClient::DistributionsAptApi	update	PUT deb_apt_distribution_href	Update an apt distribution
PulpDebClient::PublicationsAptApi	add_role	POST deb_apt_publication_hrefadd_role/	Add a role
PulpDebClient::PublicationsAptApi	create	POST /pulp/api/v3/publications/deb/apt/	Create an apt publication
PulpDebClient::PublicationsAptApi	delete	DELETE deb_apt_publication_href	Delete an apt publication
PulpDebClient::PublicationsAptApi	list	GET /pulp/api/v3/publications/deb/apt/	List apt publications
PulpDebClient::PublicationsAptApi	list_roles	GET deb_apt_publication_hreflist_roles/	List roles
PulpDebClient::PublicationsAptApi	my_permissions	GET deb_apt_publication_hrefmy_permissions/	List user permissions
PulpDebClient::PublicationsAptApi	read	GET deb_apt_publication_href	Inspect an apt publication
PulpDebClient::PublicationsAptApi	remove_role	POST deb_apt_publication_hrefremove_role/	Remove a role
PulpDebClient::PublicationsVerbatimApi	add_role	POST deb_verbatim_publication_hrefadd_role/	Add a role
PulpDebClient::PublicationsVerbatimApi	create	POST /pulp/api/v3/publications/deb/verbatim/	Create a verbatim publication
PulpDebClient::PublicationsVerbatimApi	delete	DELETE deb_verbatim_publication_href	Delete a verbatim publication
PulpDebClient::PublicationsVerbatimApi	list	GET /pulp/api/v3/publications/deb/verbatim/	List verbatim publications
PulpDebClient::PublicationsVerbatimApi	list_roles	GET deb_verbatim_publication_hreflist_roles/	List roles
PulpDebClient::PublicationsVerbatimApi	my_permissions	GET deb_verbatim_publication_hrefmy_permissions/	List user permissions
PulpDebClient::PublicationsVerbatimApi	read	GET deb_verbatim_publication_href	Inspect a verbatim publication
PulpDebClient::PublicationsVerbatimApi	remove_role	POST deb_verbatim_publication_hrefremove_role/	Remove a role
PulpDebClient::RemotesAptApi	add_role	POST deb_apt_remote_hrefadd_role/	Add a role
PulpDebClient::RemotesAptApi	create	POST /pulp/api/v3/remotes/deb/apt/	Create an apt remote
PulpDebClient::RemotesAptApi	delete	DELETE deb_apt_remote_href	Delete an apt remote
PulpDebClient::RemotesAptApi	list	GET /pulp/api/v3/remotes/deb/apt/	List apt remotes
PulpDebClient::RemotesAptApi	list_roles	GET deb_apt_remote_hreflist_roles/	List roles
PulpDebClient::RemotesAptApi	my_permissions	GET deb_apt_remote_hrefmy_permissions/	List user permissions
PulpDebClient::RemotesAptApi	partial_update	PATCH deb_apt_remote_href	Update an apt remote
PulpDebClient::RemotesAptApi	read	GET deb_apt_remote_href	Inspect an apt remote
PulpDebClient::RemotesAptApi	remove_role	POST deb_apt_remote_hrefremove_role/	Remove a role
PulpDebClient::RemotesAptApi	set_label	POST deb_apt_remote_hrefset_label/	Set a label
PulpDebClient::RemotesAptApi	unset_label	POST deb_apt_remote_hrefunset_label/	Unset a label
PulpDebClient::RemotesAptApi	update	PUT deb_apt_remote_href	Update an apt remote
PulpDebClient::RepositoriesAptApi	add_role	POST deb_apt_repository_hrefadd_role/	Add a role
PulpDebClient::RepositoriesAptApi	create	POST /pulp/api/v3/repositories/deb/apt/	Create an apt repository
PulpDebClient::RepositoriesAptApi	delete	DELETE deb_apt_repository_href	Delete an apt repository
PulpDebClient::RepositoriesAptApi	list	GET /pulp/api/v3/repositories/deb/apt/	List apt repositorys
PulpDebClient::RepositoriesAptApi	list_roles	GET deb_apt_repository_hreflist_roles/	List roles
PulpDebClient::RepositoriesAptApi	modify	POST deb_apt_repository_hrefmodify/	Modify Repository Content
PulpDebClient::RepositoriesAptApi	my_permissions	GET deb_apt_repository_hrefmy_permissions/	List user permissions
PulpDebClient::RepositoriesAptApi	partial_update	PATCH deb_apt_repository_href	Update an apt repository
PulpDebClient::RepositoriesAptApi	read	GET deb_apt_repository_href	Inspect an apt repository
PulpDebClient::RepositoriesAptApi	remove_role	POST deb_apt_repository_hrefremove_role/	Remove a role
PulpDebClient::RepositoriesAptApi	set_label	POST deb_apt_repository_hrefset_label/	Set a label
PulpDebClient::RepositoriesAptApi	sync	POST deb_apt_repository_hrefsync/	Sync from remote
PulpDebClient::RepositoriesAptApi	unset_label	POST deb_apt_repository_hrefunset_label/	Unset a label
PulpDebClient::RepositoriesAptApi	update	PUT deb_apt_repository_href	Update an apt repository
PulpDebClient::RepositoriesAptVersionsApi	delete	DELETE deb_apt_repository_version_href	Delete a repository version
PulpDebClient::RepositoriesAptVersionsApi	list	GET deb_apt_repository_hrefversions/	List repository versions
PulpDebClient::RepositoriesAptVersionsApi	read	GET deb_apt_repository_version_href	Inspect a repository version
PulpDebClient::RepositoriesAptVersionsApi	repair	POST deb_apt_repository_version_hrefrepair/