pulp_file_client

PulpFileClient - 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: 1.11.1
  • 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_file_client.gemspec

Then either install the gem locally:

gem install ./pulp_file_client-1.11.1.gem

(for development, run gem install --dev ./pulp_file_client-1.11.1.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_file_client', '~> 1.11.1'

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_file_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_file_client'

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

api_instance = PulpFileClient::AcsFileApi.new
file_file_alternate_content_source_href = 'file_file_alternate_content_source_href_example' # String | 
nested_role = PulpFileClient::NestedRole.new # NestedRole | 

begin
  result = api_instance.add_role(file_file_alternate_content_source_href, nested_role)
  p result
rescue PulpFileClient::ApiError => e
  puts "Exception when calling AcsFileApi->add_role: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://pulp

Class Method HTTP request Description
PulpFileClient::AcsFileApi add_role POST file_file_alternate_content_source_hrefadd_role/
PulpFileClient::AcsFileApi create POST /pulp/api/v3/acs/file/file/ Create a file alternate content source
PulpFileClient::AcsFileApi delete DELETE file_file_alternate_content_source_href Delete a file alternate content source
PulpFileClient::AcsFileApi list GET /pulp/api/v3/acs/file/file/ List file alternate content sources
PulpFileClient::AcsFileApi list_roles GET file_file_alternate_content_source_hreflist_roles/
PulpFileClient::AcsFileApi my_permissions GET file_file_alternate_content_source_hrefmy_permissions/
PulpFileClient::AcsFileApi partial_update PATCH file_file_alternate_content_source_href Update a file alternate content source
PulpFileClient::AcsFileApi read GET file_file_alternate_content_source_href Inspect a file alternate content source
PulpFileClient::AcsFileApi refresh POST file_file_alternate_content_source_hrefrefresh/ Refresh metadata
PulpFileClient::AcsFileApi remove_role POST file_file_alternate_content_source_hrefremove_role/
PulpFileClient::AcsFileApi update PUT file_file_alternate_content_source_href Update a file alternate content source
PulpFileClient::ContentFilesApi create POST /pulp/api/v3/content/file/files/ Create a file content
PulpFileClient::ContentFilesApi list GET /pulp/api/v3/content/file/files/ List file contents
PulpFileClient::ContentFilesApi read GET file_file_content_href Inspect a file content
PulpFileClient::DistributionsFileApi add_role POST file_file_distribution_hrefadd_role/
PulpFileClient::DistributionsFileApi create POST /pulp/api/v3/distributions/file/file/ Create a file distribution
PulpFileClient::DistributionsFileApi delete DELETE file_file_distribution_href Delete a file distribution
PulpFileClient::DistributionsFileApi list GET /pulp/api/v3/distributions/file/file/ List file distributions
PulpFileClient::DistributionsFileApi list_roles GET file_file_distribution_hreflist_roles/
PulpFileClient::DistributionsFileApi my_permissions GET file_file_distribution_hrefmy_permissions/
PulpFileClient::DistributionsFileApi partial_update PATCH file_file_distribution_href Update a file distribution
PulpFileClient::DistributionsFileApi read GET file_file_distribution_href Inspect a file distribution
PulpFileClient::DistributionsFileApi remove_role POST file_file_distribution_hrefremove_role/
PulpFileClient::DistributionsFileApi update PUT file_file_distribution_href Update a file distribution
PulpFileClient::PublicationsFileApi add_role POST file_file_publication_hrefadd_role/
PulpFileClient::PublicationsFileApi create POST /pulp/api/v3/publications/file/file/ Create a file publication
PulpFileClient::PublicationsFileApi delete DELETE file_file_publication_href Delete a file publication
PulpFileClient::PublicationsFileApi list GET /pulp/api/v3/publications/file/file/ List file publications
PulpFileClient::PublicationsFileApi list_roles GET file_file_publication_hreflist_roles/
PulpFileClient::PublicationsFileApi my_permissions GET file_file_publication_hrefmy_permissions/
PulpFileClient::PublicationsFileApi read GET file_file_publication_href Inspect a file publication
PulpFileClient::PublicationsFileApi remove_role POST file_file_publication_hrefremove_role/
PulpFileClient::RemotesFileApi add_role POST file_file_remote_hrefadd_role/
PulpFileClient::RemotesFileApi create POST /pulp/api/v3/remotes/file/file/ Create a file remote
PulpFileClient::RemotesFileApi delete DELETE file_file_remote_href Delete a file remote
PulpFileClient::RemotesFileApi list GET /pulp/api/v3/remotes/file/file/ List file remotes
PulpFileClient::RemotesFileApi list_roles GET file_file_remote_hreflist_roles/
PulpFileClient::RemotesFileApi my_permissions GET file_file_remote_hrefmy_permissions/
PulpFileClient::RemotesFileApi partial_update PATCH file_file_remote_href Update a file remote
PulpFileClient::RemotesFileApi read GET file_file_remote_href Inspect a file remote
PulpFileClient::RemotesFileApi remove_role POST file_file_remote_hrefremove_role/
PulpFileClient::RemotesFileApi update PUT file_file_remote_href Update a file remote
PulpFileClient::RepositoriesFileApi add_role POST file_file_repository_hrefadd_role/
PulpFileClient::RepositoriesFileApi create POST /pulp/api/v3/repositories/file/file/ Create a file repository
PulpFileClient::RepositoriesFileApi delete DELETE file_file_repository_href Delete a file repository
PulpFileClient::RepositoriesFileApi list GET /pulp/api/v3/repositories/file/file/ List file repositorys
PulpFileClient::RepositoriesFileApi list_roles GET file_file_repository_hreflist_roles/
PulpFileClient::RepositoriesFileApi modify POST file_file_repository_hrefmodify/ Modify Repository Content
PulpFileClient::RepositoriesFileApi my_permissions GET file_file_repository_hrefmy_permissions/
PulpFileClient::RepositoriesFileApi partial_update PATCH file_file_repository_href Update a file repository
PulpFileClient::RepositoriesFileApi read GET file_file_repository_href Inspect a file repository
PulpFileClient::RepositoriesFileApi remove_role POST file_file_repository_hrefremove_role/
PulpFileClient::RepositoriesFileApi sync POST file_file_repository_hrefsync/ Sync from a remote
PulpFileClient::RepositoriesFileApi update PUT file_file_repository_href Update a file repository
PulpFileClient::RepositoriesFileVersionsApi delete DELETE file_file_repository_version_href Delete a repository version
PulpFileClient::RepositoriesFileVersionsApi list GET file_file_repository_hrefversions/ List repository versions
PulpFileClient::RepositoriesFileVersionsApi read GET file_file_repository_version_href Inspect a repository version
PulpFileClient::RepositoriesFileVersionsApi repair POST file_file_repository_version_hrefrepair/

Documentation for Models

Documentation for Authorization

basicAuth

  • Type: HTTP basic authentication