pulpcore_client

PulpcoreClient - 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.16.9
• 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 pulpcore_client.gemspec

Then either install the gem locally:

gem install ./pulpcore_client-3.16.9.gem

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

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 'pulpcore_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 'pulpcore_client'

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

api_instance = PulpcoreClient::AccessPoliciesApi.new
opts = {
  customized: true, # Boolean | 
  limit: 56, # Integer | Number of results to return per page.
  offset: 56, # Integer | The initial index from which to return the results.
  ordering: 'ordering_example', # String | Which field to use when ordering the results.
  viewset_name: 'viewset_name_example', # String | Filter results where viewset_name matches value
  viewset_name__contains: 'viewset_name__contains_example', # String | Filter results where viewset_name contains value
  viewset_name__icontains: 'viewset_name__icontains_example', # String | Filter results where viewset_name contains value
  viewset_name__in: ['viewset_name__in_example'], # Array<String> | Filter results where viewset_name is in a comma-separated list of values
  viewset_name__startswith: 'viewset_name__startswith_example', # String | Filter results where viewset_name starts with value
  fields: 'fields_example', # String | A list of fields to include in the response.
  exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
}

begin
  #List access policys
  result = api_instance.list(opts)
  p result
rescue PulpcoreClient::ApiError => e
  puts "Exception when calling AccessPoliciesApi->list: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://pulp

Class	Method	HTTP request	Description
PulpcoreClient::AccessPoliciesApi	list	GET /pulp/api/v3/access_policies/	List access policys
PulpcoreClient::AccessPoliciesApi	partial_update	PATCH access_policy_href	Update an access policy
PulpcoreClient::AccessPoliciesApi	read	GET access_policy_href	Inspect an access policy
PulpcoreClient::AccessPoliciesApi	update	PUT access_policy_href	Update an access policy
PulpcoreClient::ArtifactsApi	create	POST /pulp/api/v3/artifacts/	Create an artifact
PulpcoreClient::ArtifactsApi	delete	DELETE artifact_href	Delete an artifact
PulpcoreClient::ArtifactsApi	list	GET /pulp/api/v3/artifacts/	List artifacts
PulpcoreClient::ArtifactsApi	read	GET artifact_href	Inspect an artifact
PulpcoreClient::ContentApi	list	GET /pulp/api/v3/content/	List content
PulpcoreClient::ContentguardsApi	list	GET /pulp/api/v3/contentguards/	List content guards
PulpcoreClient::ContentguardsRbacApi	assign_permission	POST r_b_a_c_content_guard_hrefassign_permission/	Add download permission
PulpcoreClient::ContentguardsRbacApi	create	POST /pulp/api/v3/contentguards/core/rbac/	Create a rbac content guard
PulpcoreClient::ContentguardsRbacApi	delete	DELETE r_b_a_c_content_guard_href	Delete a rbac content guard
PulpcoreClient::ContentguardsRbacApi	list	GET /pulp/api/v3/contentguards/core/rbac/	List rbac content guards
PulpcoreClient::ContentguardsRbacApi	partial_update	PATCH r_b_a_c_content_guard_href	Update a rbac content guard
PulpcoreClient::ContentguardsRbacApi	read	GET r_b_a_c_content_guard_href	Inspect a rbac content guard
PulpcoreClient::ContentguardsRbacApi	remove_permission	POST r_b_a_c_content_guard_hrefremove_permission/	Remove download permission
PulpcoreClient::ContentguardsRbacApi	update	PUT r_b_a_c_content_guard_href	Update a rbac content guard
PulpcoreClient::ExportersFilesystemApi	create	POST /pulp/api/v3/exporters/core/filesystem/	Create a filesystem exporter
PulpcoreClient::ExportersFilesystemApi	delete	DELETE filesystem_exporter_href	Delete a filesystem exporter
PulpcoreClient::ExportersFilesystemApi	list	GET /pulp/api/v3/exporters/core/filesystem/	List filesystem exporters
PulpcoreClient::ExportersFilesystemApi	partial_update	PATCH filesystem_exporter_href	Update a filesystem exporter
PulpcoreClient::ExportersFilesystemApi	read	GET filesystem_exporter_href	Inspect a filesystem exporter
PulpcoreClient::ExportersFilesystemApi	update	PUT filesystem_exporter_href	Update a filesystem exporter
PulpcoreClient::ExportersFilesystemExportsApi	create	POST filesystem_exporter_hrefexports/	Create a filesystem export
PulpcoreClient::ExportersFilesystemExportsApi	delete	DELETE filesystem_filesystem_export_href	Delete a filesystem export
PulpcoreClient::ExportersFilesystemExportsApi	list	GET filesystem_exporter_hrefexports/	List filesystem exports
PulpcoreClient::ExportersFilesystemExportsApi	read	GET filesystem_filesystem_export_href	Inspect a filesystem export
PulpcoreClient::ExportersPulpApi	create	POST /pulp/api/v3/exporters/core/pulp/	Create a pulp exporter
PulpcoreClient::ExportersPulpApi	delete	DELETE pulp_exporter_href	Delete a pulp exporter
PulpcoreClient::ExportersPulpApi	list	GET /pulp/api/v3/exporters/core/pulp/	List pulp exporters
PulpcoreClient::ExportersPulpApi	partial_update	PATCH pulp_exporter_href	Update a pulp exporter
PulpcoreClient::ExportersPulpApi	read	GET pulp_exporter_href	Inspect a pulp exporter
PulpcoreClient::ExportersPulpApi	update	PUT pulp_exporter_href	Update a pulp exporter
PulpcoreClient::ExportersPulpExportsApi	create	POST pulp_exporter_hrefexports/	Create a pulp export
PulpcoreClient::ExportersPulpExportsApi	delete	DELETE pulp_pulp_export_href	Delete a pulp export
PulpcoreClient::ExportersPulpExportsApi	list	GET pulp_exporter_hrefexports/	List pulp exports
PulpcoreClient::ExportersPulpExportsApi	read	GET pulp_pulp_export_href	Inspect a pulp export
PulpcoreClient::GroupsApi	create	POST /pulp/api/v3/groups/	Create a group
PulpcoreClient::GroupsApi	delete	DELETE auth_group_href	Delete a group
PulpcoreClient::GroupsApi	list	GET /pulp/api/v3/groups/	List groups
PulpcoreClient::GroupsApi	partial_update	PATCH auth_group_href	Update a group
PulpcoreClient::GroupsApi	read	GET auth_group_href	Inspect a group
PulpcoreClient::GroupsApi	update	PUT auth_group_href	Update a group
PulpcoreClient::GroupsModelPermissionsApi	create	POST auth_group_hrefmodel_permissions/	Create a permission
PulpcoreClient::GroupsModelPermissionsApi	delete	DELETE auth_groups_model_permission_href	Delete a permission
PulpcoreClient::GroupsModelPermissionsApi	list	GET auth_group_hrefmodel_permissions/	List permissions
PulpcoreClient::GroupsModelPermissionsApi	read	GET auth_groups_model_permission_href	Inspect a permission
PulpcoreClient::GroupsObjectPermissionsApi	create	POST auth_group_hrefobject_permissions/	Create a permission
PulpcoreClient::GroupsObjectPermissionsApi	delete	DELETE auth_groups_object_permission_href	Delete a permission
PulpcoreClient::GroupsObjectPermissionsApi	list	GET auth_group_hrefobject_permissions/	List permissions
PulpcoreClient::GroupsObjectPermissionsApi	read	GET auth_groups_object_permission_href	Inspect a permission
PulpcoreClient::GroupsUsersApi	create	POST auth_group_hrefusers/	Create an user
PulpcoreClient::GroupsUsersApi	delete	DELETE auth_groups_user_href	Delete an user
PulpcoreClient::GroupsUsersApi	list	GET auth_group_hrefusers/	List users
PulpcoreClient::ImportersPulpApi	create	POST /pulp/api/v3/importers/core/pulp/	Create a pulp importer
PulpcoreClient::ImportersPulpApi	delete	DELETE pulp_importer_href	Delete a pulp importer
PulpcoreClient::ImportersPulpApi	list	GET /pulp/api/v3/importers/core/pulp/	List pulp importers
PulpcoreClient::ImportersPulpApi	partial_update	PATCH pulp_importer_href	Update a pulp importer
PulpcoreClient::ImportersPulpApi	read	GET pulp_importer_href	Inspect a pulp importer
PulpcoreClient::ImportersPulpApi	update	PUT pulp_importer_href	Update a pulp importer
PulpcoreClient::ImportersPulpImportCheckApi	pulp_import_check_post	POST /pulp/api/v3/importers/core/pulp/import-check/	Validate the parameters to be used for a PulpImport call
PulpcoreClient::ImportersPulpImportsApi	create	POST pulp_importer_hrefimports/	Create a pulp import
PulpcoreClient::ImportersPulpImportsApi	delete	DELETE pulp_pulp_import_href	Delete a pulp import
PulpcoreClient::ImportersPulpImportsApi	list	GET pulp_importer_hrefimports/	List pulp imports
PulpcoreClient::ImportersPulpImportsApi	read	GET pulp_pulp_import_href	Inspect a pulp import
PulpcoreClient::OrphansApi	delete	DELETE /pulp/api/v3/orphans/	Delete orphans
PulpcoreClient::OrphansCleanupApi	cleanup	POST /pulp/api/v3/orphans/cleanup/
PulpcoreClient::PublicationsApi	list	GET /pulp/api/v3/publications/	List publications
PulpcoreClient::RepairApi	post	POST /pulp/api/v3/repair/	Repair Artifact Storage
PulpcoreClient::RepositoriesApi	list	GET /pulp/api/v3/repositories/	List repositories
PulpcoreClient::RepositoriesReclaimSpaceApi	reclaim	POST /pulp/api/v3/repositories/reclaim_space/
PulpcoreClient::RepositoryVersionsApi	list	GET /pulp/api/v3/repository_versions/	List repository versions
PulpcoreClient::SigningServicesApi	list	GET /pulp/api/v3/signing-services/	List signing services
PulpcoreClient::SigningServicesApi	read	GET signing_service_href	Inspect a signing service
PulpcoreClient::StatusApi	status_read	GET /pulp/api/v3/status/	Inspect status of Pulp
PulpcoreClient::TaskGroupsApi	list	GET /pulp/api/v3/task-groups/	List task groups
PulpcoreClient::TaskGroupsApi	read	GET task_group_href	Inspect a task group
PulpcoreClient::TasksApi	delete	DELETE task_href	Delete a task
PulpcoreClient::TasksApi	list	GET /pulp/api/v3/tasks/	List tasks
PulpcoreClient::TasksApi	read	GET task_href	Inspect a task
PulpcoreClient::TasksApi	tasks_cancel	PATCH task_href	Cancel a task
PulpcoreClient::UploadsApi	commit	POST upload_hrefcommit/	Finish an Upload
PulpcoreClient::UploadsApi	create	POST /pulp/api/v3/uploads/	Create an upload
PulpcoreClient::UploadsApi	delete	DELETE upload_href	Delete an upload
PulpcoreClient::UploadsApi	list	GET /pulp/api/v3/uploads/	List uploads
PulpcoreClient::UploadsApi	read	GET upload_href	Inspect an upload
PulpcoreClient::UploadsApi	update	PUT upload_href	Upload a file chunk
PulpcoreClient::UsersApi	list	GET /pulp/api/v3/users/	List users
PulpcoreClient::UsersApi	permissions	GET auth_user_hrefpermissions/
PulpcoreClient::UsersApi	read	GET auth_user_href	Inspect an user
PulpcoreClient::WorkersApi	list	GET /pulp/api/v3/workers/	List workers
PulpcoreClient::WorkersApi	read	GET worker_href	Inspect a worker

Documentation for Models

• PulpcoreClient::AccessPolicy
• PulpcoreClient::AccessPolicyResponse
• PulpcoreClient::Artifact
• PulpcoreClient::ArtifactResponse
• PulpcoreClient::AsyncOperationResponse
• PulpcoreClient::ContentAppStatusResponse
• PulpcoreClient::ContentGuardResponse
• PulpcoreClient::ContentSummaryResponse
• PulpcoreClient::DatabaseConnectionResponse
• PulpcoreClient::EvaluationResponse
• PulpcoreClient::FilesystemExport
• PulpcoreClient::FilesystemExportResponse
• PulpcoreClient::FilesystemExporter
• PulpcoreClient::FilesystemExporterResponse
• PulpcoreClient::Group
• PulpcoreClient::GroupProgressReportResponse
• PulpcoreClient::GroupResponse
• PulpcoreClient::GroupUser
• PulpcoreClient::GroupUserResponse
• PulpcoreClient::ImportResponse
• PulpcoreClient::MethodEnum
• PulpcoreClient::MinimalTaskResponse
• PulpcoreClient::MultipleArtifactContentResponse
• PulpcoreClient::OrphansCleanup
• PulpcoreClient::PaginatedAccessPolicyResponseList
• PulpcoreClient::PaginatedArtifactResponseList
• PulpcoreClient::PaginatedContentGuardResponseList
• PulpcoreClient::PaginatedFilesystemExportResponseList
• PulpcoreClient::PaginatedFilesystemExporterResponseList
• PulpcoreClient::PaginatedGroupResponseList
• PulpcoreClient::PaginatedGroupUserResponseList
• PulpcoreClient::PaginatedImportResponseList
• PulpcoreClient::PaginatedMultipleArtifactContentResponseList
• PulpcoreClient::PaginatedPermissionResponseList
• PulpcoreClient::PaginatedPublicationResponseList
• PulpcoreClient::PaginatedPulpExportResponseList
• PulpcoreClient::PaginatedPulpExporterResponseList
• PulpcoreClient::PaginatedPulpImporterResponseList
• PulpcoreClient::PaginatedRBACContentGuardResponseList
• PulpcoreClient::PaginatedRepositoryResponseList
• PulpcoreClient::PaginatedRepositoryVersionResponseList
• PulpcoreClient::PaginatedSigningServiceResponseList
• PulpcoreClient::PaginatedTaskGroupResponseList
• PulpcoreClient::PaginatedTaskResponseList
• PulpcoreClient::PaginatedUploadResponseList
• PulpcoreClient::PaginatedUserResponseList
• PulpcoreClient::PaginatedWorkerResponseList
• PulpcoreClient::PatchedAccessPolicy
• PulpcoreClient::PatchedFilesystemExporter
• PulpcoreClient::PatchedGroup
• PulpcoreClient::PatchedPulpExporter
• PulpcoreClient::PatchedPulpImporter
• PulpcoreClient::PatchedRBACContentGuard
• PulpcoreClient::PatchedTaskCancel
• PulpcoreClient::PermissionResponse
• PulpcoreClient::ProgressReportResponse
• PulpcoreClient::PublicationResponse
• PulpcoreClient::PulpExport
• PulpcoreClient::PulpExportResponse
• PulpcoreClient::PulpExporter
• PulpcoreClient::PulpExporterResponse
• PulpcoreClient::PulpImport
• PulpcoreClient::PulpImportCheck
• PulpcoreClient::PulpImportCheckResponse
• PulpcoreClient::PulpImporter
• PulpcoreClient::PulpImporterResponse
• PulpcoreClient::RBACContentGuard
• PulpcoreClient::RBACContentGuardPermission
• PulpcoreClient::RBACContentGuardResponse
• PulpcoreClient::ReclaimSpace
• PulpcoreClient::RedisConnectionResponse
• PulpcoreClient::Repair
• PulpcoreClient::RepositoryResponse
• PulpcoreClient::RepositoryVersionResponse
• PulpcoreClient::SigningServiceResponse
• PulpcoreClient::StatusResponse
• PulpcoreClient::StorageResponse
• PulpcoreClient::TaskGroupOperationResponse
• PulpcoreClient::TaskGroupResponse
• PulpcoreClient::TaskResponse
• PulpcoreClient::Upload
• PulpcoreClient::UploadChunk
• PulpcoreClient::UploadChunkResponse
• PulpcoreClient::UploadCommit
• PulpcoreClient::UploadDetailResponse
• PulpcoreClient::UploadResponse
• PulpcoreClient::UserGroupResponse
• PulpcoreClient::UserResponse
• PulpcoreClient::VersionResponse
• PulpcoreClient::WorkerResponse

Documentation for Authorization

basicAuth

• Type: HTTP basic authentication