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.4.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.4.0.gem
(for development, run gem install --dev ./pulp_deb_client-3.4.0.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.4.0'
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'
end
api_instance = PulpDebClient::ContentGenericContentsApi.new
relative_path = 'relative_path_example' # String | Path where the artifact is located relative to distributions base_path
opts = {
repository: 'repository_example', # String | A URI of a repository the new content unit should be associated with.
artifact: 'artifact_example', # String | Artifact file representing the physical content
file: File.new('/path/to/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::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::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::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::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::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::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::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::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::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::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::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::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::DebCopyApi | copy_content | POST /pulp/api/v3/deb/copy/ | Copy content |
| 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 | 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 | 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 | 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 | read | GET deb_apt_publication_href | Inspect an apt publication |
| 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 | read | GET deb_verbatim_publication_href | Inspect a verbatim publication |
| 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 | 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 | 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 | 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 | modify | POST deb_apt_repository_hrefmodify/ | Modify Repository Content |
| 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 | 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/ |
Documentation for Models
- PulpDebClient::AptRepositorySyncURL
- PulpDebClient::AsyncOperationResponse
- PulpDebClient::ContentSummaryResponse
- PulpDebClient::Copy
- PulpDebClient::DebAptDistribution
- PulpDebClient::DebAptDistributionResponse
- PulpDebClient::DebAptPublication
- PulpDebClient::DebAptPublicationResponse
- PulpDebClient::DebAptRemote
- PulpDebClient::DebAptRemoteResponse
- PulpDebClient::DebAptRemoteResponseHiddenFields
- PulpDebClient::DebAptRepository
- PulpDebClient::DebAptRepositoryResponse
- PulpDebClient::DebGenericContent
- PulpDebClient::DebGenericContentResponse
- PulpDebClient::DebInstallerFileIndex
- PulpDebClient::DebInstallerFileIndexResponse
- PulpDebClient::DebInstallerPackage
- PulpDebClient::DebInstallerPackageResponse
- PulpDebClient::DebPackage
- PulpDebClient::DebPackageIndex
- PulpDebClient::DebPackageIndexResponse
- PulpDebClient::DebPackageReleaseComponent
- PulpDebClient::DebPackageReleaseComponentResponse
- PulpDebClient::DebPackageResponse
- PulpDebClient::DebRelease
- PulpDebClient::DebReleaseArchitecture
- PulpDebClient::DebReleaseArchitectureResponse
- PulpDebClient::DebReleaseComponent
- PulpDebClient::DebReleaseComponentResponse
- PulpDebClient::DebReleaseFile
- PulpDebClient::DebReleaseFileResponse
- PulpDebClient::DebReleaseResponse
- PulpDebClient::DebSourceIndex
- PulpDebClient::DebSourceIndexResponse
- PulpDebClient::DebSourcePackage
- PulpDebClient::DebSourcePackageReleaseComponent
- PulpDebClient::DebSourcePackageReleaseComponentResponse
- PulpDebClient::DebSourcePackageResponse
- PulpDebClient::DebVerbatimPublication
- PulpDebClient::DebVerbatimPublicationResponse
- PulpDebClient::PaginatedRepositoryVersionResponseList
- PulpDebClient::PaginateddebAptDistributionResponseList
- PulpDebClient::PaginateddebAptPublicationResponseList
- PulpDebClient::PaginateddebAptRemoteResponseList
- PulpDebClient::PaginateddebAptRepositoryResponseList
- PulpDebClient::PaginateddebGenericContentResponseList
- PulpDebClient::PaginateddebInstallerFileIndexResponseList
- PulpDebClient::PaginateddebInstallerPackageResponseList
- PulpDebClient::PaginateddebPackageIndexResponseList
- PulpDebClient::PaginateddebPackageReleaseComponentResponseList
- PulpDebClient::PaginateddebPackageResponseList
- PulpDebClient::PaginateddebReleaseArchitectureResponseList
- PulpDebClient::PaginateddebReleaseComponentResponseList
- PulpDebClient::PaginateddebReleaseFileResponseList
- PulpDebClient::PaginateddebReleaseResponseList
- PulpDebClient::PaginateddebSourceIndexResponseList
- PulpDebClient::PaginateddebSourcePackageReleaseComponentResponseList
- PulpDebClient::PaginateddebSourcePackageResponseList
- PulpDebClient::PaginateddebVerbatimPublicationResponseList
- PulpDebClient::PatcheddebAptDistribution
- PulpDebClient::PatcheddebAptRemote
- PulpDebClient::PatcheddebAptRepository
- PulpDebClient::PolicyEnum
- PulpDebClient::Repair
- PulpDebClient::RepositoryAddRemoveContent
- PulpDebClient::RepositoryVersionResponse
- PulpDebClient::SetLabel
- PulpDebClient::SetLabelResponse
- PulpDebClient::UnsetLabel
- PulpDebClient::UnsetLabelResponse
Documentation for Authorization
basicAuth
- Type: HTTP basic authentication