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.27.2
- 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.27.2.gem
(for development, run gem install --dev ./pulp_rpm_client-3.27.2.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.27.2'
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::AcsRpmApi.new
rpm_rpm_alternate_content_source_href = 'rpm_rpm_alternate_content_source_href_example' # String |
nested_role = PulpRpmClient::NestedRole.new # NestedRole |
begin
#Add a role
result = api_instance.add_role(rpm_rpm_alternate_content_source_href, nested_role)
p result
rescue PulpRpmClient::ApiError => e
puts "Exception when calling AcsRpmApi->add_role: #{e}"
end
Documentation for API Endpoints
All URIs are relative to http://localhost:24817
| Class | Method | HTTP request | Description |
|---|---|---|---|
| PulpRpmClient::AcsRpmApi | add_role | POST rpm_rpm_alternate_content_source_hrefadd_role/ | Add a role |
| PulpRpmClient::AcsRpmApi | create | POST /pulp/api/v3/acs/rpm/rpm/ | Create a rpm alternate content source |
| PulpRpmClient::AcsRpmApi | delete | DELETE rpm_rpm_alternate_content_source_href | Delete a rpm alternate content source |
| PulpRpmClient::AcsRpmApi | list | GET /pulp/api/v3/acs/rpm/rpm/ | List rpm alternate content sources |
| PulpRpmClient::AcsRpmApi | list_roles | GET rpm_rpm_alternate_content_source_hreflist_roles/ | List roles |
| PulpRpmClient::AcsRpmApi | my_permissions | GET rpm_rpm_alternate_content_source_hrefmy_permissions/ | List user permissions |
| PulpRpmClient::AcsRpmApi | partial_update | PATCH rpm_rpm_alternate_content_source_href | Update a rpm alternate content source |
| PulpRpmClient::AcsRpmApi | read | GET rpm_rpm_alternate_content_source_href | Inspect a rpm alternate content source |
| PulpRpmClient::AcsRpmApi | refresh | POST rpm_rpm_alternate_content_source_hrefrefresh/ | |
| PulpRpmClient::AcsRpmApi | remove_role | POST rpm_rpm_alternate_content_source_hrefremove_role/ | Remove a role |
| PulpRpmClient::AcsRpmApi | update | PUT rpm_rpm_alternate_content_source_href | Update a rpm alternate content source |
| 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 | 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::ContentModulemdObsoletesApi | create | POST /pulp/api/v3/content/rpm/modulemd_obsoletes/ | Create a modulemd obsolete |
| PulpRpmClient::ContentModulemdObsoletesApi | list | GET /pulp/api/v3/content/rpm/modulemd_obsoletes/ | List modulemd obsoletes |
| PulpRpmClient::ContentModulemdObsoletesApi | read | GET rpm_modulemd_obsolete_href | Inspect a modulemd obsolete |
| 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 | 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 | 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 | 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 | 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 | 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 | add_role | POST rpm_rpm_distribution_hrefadd_role/ | Add a role |
| 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 | list_roles | GET rpm_rpm_distribution_hreflist_roles/ | List roles |
| PulpRpmClient::DistributionsRpmApi | my_permissions | GET rpm_rpm_distribution_hrefmy_permissions/ | List user permissions |
| 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 | remove_role | POST rpm_rpm_distribution_hrefremove_role/ | Remove a role |
| PulpRpmClient::DistributionsRpmApi | set_label | POST rpm_rpm_distribution_hrefset_label/ | Set a label |
| PulpRpmClient::DistributionsRpmApi | unset_label | POST rpm_rpm_distribution_hrefunset_label/ | Unset a label |
| PulpRpmClient::DistributionsRpmApi | update | PUT rpm_rpm_distribution_href | Update a rpm distribution |
| PulpRpmClient::PublicationsRpmApi | add_role | POST rpm_rpm_publication_hrefadd_role/ | Add a role |
| 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 | list_roles | GET rpm_rpm_publication_hreflist_roles/ | List roles |
| PulpRpmClient::PublicationsRpmApi | my_permissions | GET rpm_rpm_publication_hrefmy_permissions/ | List user permissions |
| PulpRpmClient::PublicationsRpmApi | read | GET rpm_rpm_publication_href | Inspect a rpm publication |
| PulpRpmClient::PublicationsRpmApi | remove_role | POST rpm_rpm_publication_hrefremove_role/ | Remove a role |
| PulpRpmClient::RemotesRpmApi | add_role | POST rpm_rpm_remote_hrefadd_role/ | Add a role |
| 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 | list_roles | GET rpm_rpm_remote_hreflist_roles/ | List roles |
| PulpRpmClient::RemotesRpmApi | my_permissions | GET rpm_rpm_remote_hrefmy_permissions/ | List user permissions |
| 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 | remove_role | POST rpm_rpm_remote_hrefremove_role/ | Remove a role |
| PulpRpmClient::RemotesRpmApi | set_label | POST rpm_rpm_remote_hrefset_label/ | Set a label |
| PulpRpmClient::RemotesRpmApi | unset_label | POST rpm_rpm_remote_hrefunset_label/ | Unset a label |
| PulpRpmClient::RemotesRpmApi | update | PUT rpm_rpm_remote_href | Update a rpm remote |
| PulpRpmClient::RemotesUlnApi | add_role | POST rpm_uln_remote_hrefadd_role/ | Add a role |
| PulpRpmClient::RemotesUlnApi | create | POST /pulp/api/v3/remotes/rpm/uln/ | Create an uln remote |
| PulpRpmClient::RemotesUlnApi | delete | DELETE rpm_uln_remote_href | Delete an uln remote |
| PulpRpmClient::RemotesUlnApi | list | GET /pulp/api/v3/remotes/rpm/uln/ | List uln remotes |
| PulpRpmClient::RemotesUlnApi | list_roles | GET rpm_uln_remote_hreflist_roles/ | List roles |
| PulpRpmClient::RemotesUlnApi | my_permissions | GET rpm_uln_remote_hrefmy_permissions/ | List user permissions |
| PulpRpmClient::RemotesUlnApi | partial_update | PATCH rpm_uln_remote_href | Update an uln remote |
| PulpRpmClient::RemotesUlnApi | read | GET rpm_uln_remote_href | Inspect an uln remote |
| PulpRpmClient::RemotesUlnApi | remove_role | POST rpm_uln_remote_hrefremove_role/ | Remove a role |
| PulpRpmClient::RemotesUlnApi | set_label | POST rpm_uln_remote_hrefset_label/ | Set a label |
| PulpRpmClient::RemotesUlnApi | unset_label | POST rpm_uln_remote_hrefunset_label/ | Unset a label |
| PulpRpmClient::RemotesUlnApi | update | PUT rpm_uln_remote_href | Update an uln remote |
| PulpRpmClient::RepositoriesRpmApi | add_role | POST rpm_rpm_repository_hrefadd_role/ | Add a role |
| 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 | list_roles | GET rpm_rpm_repository_hreflist_roles/ | List roles |
| PulpRpmClient::RepositoriesRpmApi | modify | POST rpm_rpm_repository_hrefmodify/ | Modify Repository Content |
| PulpRpmClient::RepositoriesRpmApi | my_permissions | GET rpm_rpm_repository_hrefmy_permissions/ | List user permissions |
| 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 | remove_role | POST rpm_rpm_repository_hrefremove_role/ | Remove a role |
| PulpRpmClient::RepositoriesRpmApi | set_label | POST rpm_rpm_repository_hrefset_label/ | Set a label |
| PulpRpmClient::RepositoriesRpmApi | sync | POST rpm_rpm_repository_hrefsync/ | Sync from remote |
| PulpRpmClient::RepositoriesRpmApi | unset_label | POST rpm_rpm_repository_hrefunset_label/ | Unset a label |
| 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::RpmCompsApi | rpm_comps_upload | POST /pulp/api/v3/rpm/comps/ | Upload comps.xml |
| PulpRpmClient::RpmCopyApi | copy_content | POST /pulp/api/v3/rpm/copy/ | Copy content |
| PulpRpmClient::RpmPruneApi | prune_packages | POST /pulp/api/v3/rpm/prune/ |
Documentation for Models
- PulpRpmClient::AddonResponse
- PulpRpmClient::ArtifactResponse
- PulpRpmClient::AsyncOperationResponse
- PulpRpmClient::ChecksumResponse
- PulpRpmClient::CompressionTypeEnum
- PulpRpmClient::CompsXml
- PulpRpmClient::ContentSummaryResponse
- PulpRpmClient::Copy
- PulpRpmClient::ImageResponse
- PulpRpmClient::MyPermissionsResponse
- PulpRpmClient::NestedRole
- PulpRpmClient::NestedRoleResponse
- PulpRpmClient::ObjectRolesResponse
- PulpRpmClient::PackageChecksumTypeEnum
- PulpRpmClient::PaginatedRepositoryVersionResponseList
- PulpRpmClient::PaginatedrpmDistributionTreeResponseList
- PulpRpmClient::PaginatedrpmModulemdDefaultsResponseList
- PulpRpmClient::PaginatedrpmModulemdObsoleteResponseList
- PulpRpmClient::PaginatedrpmModulemdResponseList
- PulpRpmClient::PaginatedrpmPackageCategoryResponseList
- PulpRpmClient::PaginatedrpmPackageEnvironmentResponseList
- PulpRpmClient::PaginatedrpmPackageGroupResponseList
- PulpRpmClient::PaginatedrpmPackageLangpacksResponseList
- PulpRpmClient::PaginatedrpmPackageResponseList
- PulpRpmClient::PaginatedrpmRepoMetadataFileResponseList
- PulpRpmClient::PaginatedrpmRpmAlternateContentSourceResponseList
- PulpRpmClient::PaginatedrpmRpmDistributionResponseList
- PulpRpmClient::PaginatedrpmRpmPublicationResponseList
- PulpRpmClient::PaginatedrpmRpmRemoteResponseList
- PulpRpmClient::PaginatedrpmRpmRepositoryResponseList
- PulpRpmClient::PaginatedrpmUlnRemoteResponseList
- PulpRpmClient::PaginatedrpmUpdateRecordResponseList
- PulpRpmClient::PatchedrpmRpmAlternateContentSource
- PulpRpmClient::PatchedrpmRpmDistribution
- PulpRpmClient::PatchedrpmRpmRemote
- PulpRpmClient::PatchedrpmRpmRepository
- PulpRpmClient::PatchedrpmUlnRemote
- PulpRpmClient::PolicyEnum
- PulpRpmClient::PrunePackages
- PulpRpmClient::Repair
- PulpRpmClient::RepositoryAddRemoveContent
- PulpRpmClient::RepositoryVersionResponse
- PulpRpmClient::RpmDistributionTreeResponse
- PulpRpmClient::RpmModulemd
- PulpRpmClient::RpmModulemdDefaults
- PulpRpmClient::RpmModulemdDefaultsResponse
- PulpRpmClient::RpmModulemdObsolete
- PulpRpmClient::RpmModulemdObsoleteResponse
- PulpRpmClient::RpmModulemdResponse
- PulpRpmClient::RpmPackage
- PulpRpmClient::RpmPackageCategoryResponse
- PulpRpmClient::RpmPackageEnvironmentResponse
- PulpRpmClient::RpmPackageGroupResponse
- PulpRpmClient::RpmPackageLangpacksResponse
- PulpRpmClient::RpmPackageResponse
- PulpRpmClient::RpmRepoMetadataFileResponse
- PulpRpmClient::RpmRepositorySyncURL
- PulpRpmClient::RpmRpmAlternateContentSource
- PulpRpmClient::RpmRpmAlternateContentSourceResponse
- PulpRpmClient::RpmRpmDistribution
- PulpRpmClient::RpmRpmDistributionResponse
- PulpRpmClient::RpmRpmPublication
- PulpRpmClient::RpmRpmPublicationResponse
- PulpRpmClient::RpmRpmRemote
- PulpRpmClient::RpmRpmRemoteResponse
- PulpRpmClient::RpmRpmRemoteResponseHiddenFields
- PulpRpmClient::RpmRpmRepository
- PulpRpmClient::RpmRpmRepositoryResponse
- PulpRpmClient::RpmUlnRemote
- PulpRpmClient::RpmUlnRemoteResponse
- PulpRpmClient::RpmUpdateCollection
- PulpRpmClient::RpmUpdateCollectionResponse
- PulpRpmClient::RpmUpdateRecord
- PulpRpmClient::RpmUpdateRecordResponse
- PulpRpmClient::SetLabel
- PulpRpmClient::SetLabelResponse
- PulpRpmClient::SkipTypesEnum
- PulpRpmClient::SyncPolicyEnum
- PulpRpmClient::TaskGroupOperationResponse
- PulpRpmClient::UnsetLabel
- PulpRpmClient::UnsetLabelResponse
- PulpRpmClient::VariantResponse
Documentation for Authorization
basicAuth
- Type: HTTP basic authentication