pulp_file_client

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

Then either install the gem locally:

gem install ./pulp_file_client-3.84.0.gem

(for development, run gem install --dev ./pulp_file_client-3.84.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_file_client', '~> 3.84.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_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'
  # Configure faraday connection
  config.configure_faraday_connection { |connection| 'YOUR CONNECTION CONFIG PROC' }
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({role: 'role_example'}) # NestedRole | 
opts = {
  x_task_diagnostics: ['inner_example'] # Array<String> | List of profilers to use on tasks.
}

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

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
PulpFileClient::AcsFileApi	add_role	POST {file_file_alternate_content_source_href}add_role/	Add a 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_href}list_roles/	List roles
PulpFileClient::AcsFileApi	my_permissions	GET {file_file_alternate_content_source_href}my_permissions/	List user 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_href}refresh/	Refresh metadata
PulpFileClient::AcsFileApi	remove_role	POST {file_file_alternate_content_source_href}remove_role/	Remove a 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::ContentFilesApi	set_label	POST {file_file_content_href}set_label/	Set a label
PulpFileClient::ContentFilesApi	unset_label	POST {file_file_content_href}unset_label/	Unset a label
PulpFileClient::DistributionsFileApi	add_role	POST {file_file_distribution_href}add_role/	Add a 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_href}list_roles/	List roles
PulpFileClient::DistributionsFileApi	my_permissions	GET {file_file_distribution_href}my_permissions/	List user 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_href}remove_role/	Remove a role
PulpFileClient::DistributionsFileApi	set_label	POST {file_file_distribution_href}set_label/	Set a label
PulpFileClient::DistributionsFileApi	unset_label	POST {file_file_distribution_href}unset_label/	Unset a label
PulpFileClient::DistributionsFileApi	update	PUT {file_file_distribution_href}	Update a file distribution
PulpFileClient::PublicationsFileApi	add_role	POST {file_file_publication_href}add_role/	Add a 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_href}list_roles/	List roles
PulpFileClient::PublicationsFileApi	my_permissions	GET {file_file_publication_href}my_permissions/	List user permissions
PulpFileClient::PublicationsFileApi	read	GET {file_file_publication_href}	Inspect a file publication
PulpFileClient::PublicationsFileApi	remove_role	POST {file_file_publication_href}remove_role/	Remove a role
PulpFileClient::RemotesFileApi	add_role	POST {file_file_remote_href}add_role/	Add a 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_href}list_roles/	List roles
PulpFileClient::RemotesFileApi	my_permissions	GET {file_file_remote_href}my_permissions/	List user 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_href}remove_role/	Remove a role
PulpFileClient::RemotesFileApi	set_label	POST {file_file_remote_href}set_label/	Set a label
PulpFileClient::RemotesFileApi	unset_label	POST {file_file_remote_href}unset_label/	Unset a label
PulpFileClient::RemotesFileApi	update	PUT {file_file_remote_href}	Update a file remote
PulpFileClient::RepositoriesFileApi	add_role	POST {file_file_repository_href}add_role/	Add a 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_href}list_roles/	List roles
PulpFileClient::RepositoriesFileApi	modify	POST {file_file_repository_href}modify/	Modify Repository Content
PulpFileClient::RepositoriesFileApi	my_permissions	GET {file_file_repository_href}my_permissions/	List user 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_href}remove_role/	Remove a role
PulpFileClient::RepositoriesFileApi	set_label	POST {file_file_repository_href}set_label/	Set a label
PulpFileClient::RepositoriesFileApi	sync	POST {file_file_repository_href}sync/	Sync from a remote
PulpFileClient::RepositoriesFileApi	unset_label	POST {file_file_repository_href}unset_label/	Unset a label
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_href}versions/	List repository versions
PulpFileClient::RepositoriesFileVersionsApi	read	GET {file_file_repository_version_href}	Inspect a repository version
PulpFileClient::RepositoriesFileVersionsApi	repair	POST {file_file_repository_version_href}repair/

Documentation for Models

• PulpFileClient::AsyncOperationResponse
• PulpFileClient::ContentSummaryResponse
• PulpFileClient::FileFileAlternateContentSource
• PulpFileClient::FileFileAlternateContentSourceResponse
• PulpFileClient::FileFileContentResponse
• PulpFileClient::FileFileDistribution
• PulpFileClient::FileFileDistributionResponse
• PulpFileClient::FileFilePublication
• PulpFileClient::FileFilePublicationResponse
• PulpFileClient::FileFileRemote
• PulpFileClient::FileFileRemoteResponse
• PulpFileClient::FileFileRemoteResponseHiddenFieldsInner
• PulpFileClient::FileFileRepository
• PulpFileClient::FileFileRepositoryResponse
• PulpFileClient::MyPermissionsResponse
• PulpFileClient::NestedRole
• PulpFileClient::NestedRoleResponse
• PulpFileClient::ObjectRolesResponse
• PulpFileClient::PaginatedRepositoryVersionResponseList
• PulpFileClient::PaginatedfileFileAlternateContentSourceResponseList
• PulpFileClient::PaginatedfileFileContentResponseList
• PulpFileClient::PaginatedfileFileDistributionResponseList
• PulpFileClient::PaginatedfileFilePublicationResponseList
• PulpFileClient::PaginatedfileFileRemoteResponseList
• PulpFileClient::PaginatedfileFileRepositoryResponseList
• PulpFileClient::PatchedfileFileAlternateContentSource
• PulpFileClient::PatchedfileFileDistribution
• PulpFileClient::PatchedfileFileRemote
• PulpFileClient::PatchedfileFileRepository
• PulpFileClient::PolicyEnum
• PulpFileClient::Repair
• PulpFileClient::RepositoryAddRemoveContent
• PulpFileClient::RepositorySyncURL
• PulpFileClient::RepositoryVersionResponse
• PulpFileClient::SetLabel
• PulpFileClient::SetLabelResponse
• PulpFileClient::TaskGroupOperationResponse
• PulpFileClient::UnsetLabel
• PulpFileClient::UnsetLabelResponse

Documentation for Authorization

Authentication schemes defined for the API:

basicAuth

• Type: HTTP basic authentication