pulp_rpm_client

PulpRpmClient - 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.7.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_rpm_client.gemspec

Then either install the gem locally:

gem install ./pulp_rpm_client-3.7.0.gem

(for development, run gem install --dev ./pulp_rpm_client-3.7.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_rpm_client', '~> 3.7.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_rpm_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_rpm_client'

# Setup authorization
PulpRpmClient.configure do |config|
  # Configure HTTP basic authorization: basicAuth
  config.username = 'YOUR_USERNAME'
  config.password = 'YOUR_PASSWORD'
end

api_instance = PulpRpmClient::ContentAdvisoriesApi.new
opts = {
  file: File.new('/path/to/file'), # File | An uploaded file that may be turned into the artifact of the content unit.
  repository: 'repository_example' # String | A URI of a repository the new content unit should be associated with.
}

begin
  #Create an update record
  result = api_instance.create(opts)
  p result
rescue PulpRpmClient::ApiError => e
  puts "Exception when calling ContentAdvisoriesApi->create: #{e}"
end

Documentation for API Endpoints

All URIs are relative to http://pulp

Class Method HTTP request Description
PulpRpmClient::ContentAdvisoriesApi create POST /pulp/api/v3/content/rpm/advisories/ Create an update record
PulpRpmClient::ContentAdvisoriesApi list GET /pulp/api/v3/content/rpm/advisories/ List update records
PulpRpmClient::ContentAdvisoriesApi read GET rpm_update_record_href Inspect an update record
PulpRpmClient::ContentDistributionTreesApi delete DELETE rpm_distribution_tree_href Delete a distribution tree
PulpRpmClient::ContentDistributionTreesApi list GET /pulp/api/v3/content/rpm/distribution_trees/ List distribution trees
PulpRpmClient::ContentDistributionTreesApi read GET rpm_distribution_tree_href Inspect a distribution tree
PulpRpmClient::ContentModulemdDefaultsApi create POST /pulp/api/v3/content/rpm/modulemd_defaults/ Create a modulemd defaults
PulpRpmClient::ContentModulemdDefaultsApi list GET /pulp/api/v3/content/rpm/modulemd_defaults/ List modulemd defaultss
PulpRpmClient::ContentModulemdDefaultsApi read GET rpm_modulemd_defaults_href Inspect a modulemd defaults
PulpRpmClient::ContentModulemdsApi create POST /pulp/api/v3/content/rpm/modulemds/ Create a modulemd
PulpRpmClient::ContentModulemdsApi list GET /pulp/api/v3/content/rpm/modulemds/ List modulemds
PulpRpmClient::ContentModulemdsApi read GET rpm_modulemd_href Inspect a modulemd
PulpRpmClient::ContentPackagecategoriesApi delete DELETE rpm_package_category_href Delete a package category
PulpRpmClient::ContentPackagecategoriesApi list GET /pulp/api/v3/content/rpm/packagecategories/ List package categorys
PulpRpmClient::ContentPackagecategoriesApi read GET rpm_package_category_href Inspect a package category
PulpRpmClient::ContentPackageenvironmentsApi delete DELETE rpm_package_environment_href Delete a package environment
PulpRpmClient::ContentPackageenvironmentsApi list GET /pulp/api/v3/content/rpm/packageenvironments/ List package environments
PulpRpmClient::ContentPackageenvironmentsApi read GET rpm_package_environment_href Inspect a package environment
PulpRpmClient::ContentPackagegroupsApi delete DELETE rpm_package_group_href Delete a package group
PulpRpmClient::ContentPackagegroupsApi list GET /pulp/api/v3/content/rpm/packagegroups/ List package groups
PulpRpmClient::ContentPackagegroupsApi read GET rpm_package_group_href Inspect a package group
PulpRpmClient::ContentPackagelangpacksApi delete DELETE rpm_package_langpacks_href Delete a package langpacks
PulpRpmClient::ContentPackagelangpacksApi list GET /pulp/api/v3/content/rpm/packagelangpacks/ List package langpackss
PulpRpmClient::ContentPackagelangpacksApi read GET rpm_package_langpacks_href Inspect a package langpacks
PulpRpmClient::ContentPackagesApi create POST /pulp/api/v3/content/rpm/packages/ Create a package
PulpRpmClient::ContentPackagesApi list GET /pulp/api/v3/content/rpm/packages/ List packages
PulpRpmClient::ContentPackagesApi read GET rpm_package_href Inspect a package
PulpRpmClient::ContentRepoMetadataFilesApi delete DELETE rpm_repo_metadata_file_href Delete a repo metadata file
PulpRpmClient::ContentRepoMetadataFilesApi list GET /pulp/api/v3/content/rpm/repo_metadata_files/ List repo metadata files
PulpRpmClient::ContentRepoMetadataFilesApi read GET rpm_repo_metadata_file_href Inspect a repo metadata file
PulpRpmClient::DistributionsRpmApi create POST /pulp/api/v3/distributions/rpm/rpm/ Create a rpm distribution
PulpRpmClient::DistributionsRpmApi delete DELETE rpm_rpm_distribution_href Delete a rpm distribution
PulpRpmClient::DistributionsRpmApi list GET /pulp/api/v3/distributions/rpm/rpm/ List rpm distributions
PulpRpmClient::DistributionsRpmApi partial_update PATCH rpm_rpm_distribution_href Update a rpm distribution
PulpRpmClient::DistributionsRpmApi read GET rpm_rpm_distribution_href Inspect a rpm distribution
PulpRpmClient::DistributionsRpmApi update PUT rpm_rpm_distribution_href Update a rpm distribution
PulpRpmClient::PublicationsRpmApi create POST /pulp/api/v3/publications/rpm/rpm/ Create a rpm publication
PulpRpmClient::PublicationsRpmApi delete DELETE rpm_rpm_publication_href Delete a rpm publication
PulpRpmClient::PublicationsRpmApi list GET /pulp/api/v3/publications/rpm/rpm/ List rpm publications
PulpRpmClient::PublicationsRpmApi read GET rpm_rpm_publication_href Inspect a rpm publication
PulpRpmClient::RemotesRpmApi create POST /pulp/api/v3/remotes/rpm/rpm/ Create a rpm remote
PulpRpmClient::RemotesRpmApi delete DELETE rpm_rpm_remote_href Delete a rpm remote
PulpRpmClient::RemotesRpmApi list GET /pulp/api/v3/remotes/rpm/rpm/ List rpm remotes
PulpRpmClient::RemotesRpmApi partial_update PATCH rpm_rpm_remote_href Update a rpm remote
PulpRpmClient::RemotesRpmApi read GET rpm_rpm_remote_href Inspect a rpm remote
PulpRpmClient::RemotesRpmApi update PUT rpm_rpm_remote_href Update a rpm remote
PulpRpmClient::RepositoriesRpmApi create POST /pulp/api/v3/repositories/rpm/rpm/ Create a rpm repository
PulpRpmClient::RepositoriesRpmApi delete DELETE rpm_rpm_repository_href Delete a rpm repository
PulpRpmClient::RepositoriesRpmApi list GET /pulp/api/v3/repositories/rpm/rpm/ List rpm repositorys
PulpRpmClient::RepositoriesRpmApi modify POST rpm_rpm_repository_hrefmodify/ Modify Repository Content
PulpRpmClient::RepositoriesRpmApi partial_update PATCH rpm_rpm_repository_href Update a rpm repository
PulpRpmClient::RepositoriesRpmApi read GET rpm_rpm_repository_href Inspect a rpm repository
PulpRpmClient::RepositoriesRpmApi sync POST rpm_rpm_repository_hrefsync/ Sync from remote
PulpRpmClient::RepositoriesRpmApi update PUT rpm_rpm_repository_href Update a rpm repository
PulpRpmClient::RepositoriesRpmVersionsApi delete DELETE rpm_rpm_repository_version_href Delete a repository version
PulpRpmClient::RepositoriesRpmVersionsApi list GET rpm_rpm_repository_hrefversions/ List repository versions
PulpRpmClient::RepositoriesRpmVersionsApi read GET rpm_rpm_repository_version_href Inspect a repository version
PulpRpmClient::RepositoriesRpmVersionsApi repair POST rpm_rpm_repository_version_hrefrepair/
PulpRpmClient::RpmCopyApi copy_content POST /pulp/api/v3/rpm/copy/ Copy content

Documentation for Models

Documentation for Authorization

basicAuth

  • Type: HTTP basic authentication