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.27.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 pulpcore_client.gemspec

Then either install the gem locally:

gem install ./pulpcore_client-3.27.0.gem

(for development, run gem install --dev ./pulpcore_client-3.27.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 'pulpcore_client', '~> 3.27.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 '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 | Filter results where customized matches value
  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'], # Array<String> | Ordering  * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `creation_hooks` - Creation hooks * `-creation_hooks` - Creation hooks (descending) * `statements` - Statements * `-statements` - Statements (descending) * `viewset_name` - Viewset name * `-viewset_name` - Viewset name (descending) * `customized` - Customized * `-customized` - Customized (descending) * `queryset_scoping` - Queryset scoping * `-queryset_scoping` - Queryset scoping (descending) * `pk` - Pk * `-pk` - Pk (descending)
  pulp_href__in: ['pulp_href__in_example'], # Array<String> | Multiple values may be separated by commas.
  pulp_id__in: ['pulp_id__in_example'], # Array<String> | Multiple values may be separated by commas.
  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'], # Array<String> | A list of fields to include in the response.
  exclude_fields: ['exclude_fields_example'] # Array<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 reset POST access_policy_hrefreset/
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::ContentguardsContentRedirectApi add_role POST content_redirect_content_guard_hrefadd_role/
PulpcoreClient::ContentguardsContentRedirectApi create POST /pulp/api/v3/contentguards/core/content_redirect/ Create a content redirect content guard
PulpcoreClient::ContentguardsContentRedirectApi delete DELETE content_redirect_content_guard_href Delete a content redirect content guard
PulpcoreClient::ContentguardsContentRedirectApi list GET /pulp/api/v3/contentguards/core/content_redirect/ List content redirect content guards
PulpcoreClient::ContentguardsContentRedirectApi list_roles GET content_redirect_content_guard_hreflist_roles/
PulpcoreClient::ContentguardsContentRedirectApi my_permissions GET content_redirect_content_guard_hrefmy_permissions/
PulpcoreClient::ContentguardsContentRedirectApi partial_update PATCH content_redirect_content_guard_href Update a content redirect content guard
PulpcoreClient::ContentguardsContentRedirectApi read GET content_redirect_content_guard_href Inspect a content redirect content guard
PulpcoreClient::ContentguardsContentRedirectApi remove_role POST content_redirect_content_guard_hrefremove_role/
PulpcoreClient::ContentguardsContentRedirectApi update PUT content_redirect_content_guard_href Update a content redirect content guard
PulpcoreClient::ContentguardsRbacApi add_role POST r_b_a_c_content_guard_hrefadd_role/
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 list_roles GET r_b_a_c_content_guard_hreflist_roles/
PulpcoreClient::ContentguardsRbacApi my_permissions GET r_b_a_c_content_guard_hrefmy_permissions/
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_role POST r_b_a_c_content_guard_hrefremove_role/
PulpcoreClient::ContentguardsRbacApi update PUT r_b_a_c_content_guard_href Update a rbac content guard
PulpcoreClient::DistributionsApi list GET /pulp/api/v3/distributions/ List distributions
PulpcoreClient::DistributionsArtifactsApi list GET /pulp/api/v3/distributions/core/artifacts/ List artifact distributions
PulpcoreClient::DistributionsArtifactsApi read GET artifact_distribution_href Inspect an artifact distribution
PulpcoreClient::DomainsApi create POST /pulp/api/v3/domains/ Create a domain
PulpcoreClient::DomainsApi delete DELETE domain_href Delete a domain
PulpcoreClient::DomainsApi list GET /pulp/api/v3/domains/ List domains
PulpcoreClient::DomainsApi partial_update PATCH domain_href Update a domain
PulpcoreClient::DomainsApi read GET domain_href Inspect a domain
PulpcoreClient::DomainsApi update PUT domain_href Update a domain
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 add_role POST group_hrefadd_role/
PulpcoreClient::GroupsApi create POST /pulp/api/v3/groups/ Create a group
PulpcoreClient::GroupsApi delete DELETE group_href Delete a group
PulpcoreClient::GroupsApi list GET /pulp/api/v3/groups/ List groups
PulpcoreClient::GroupsApi list_roles GET group_hreflist_roles/
PulpcoreClient::GroupsApi my_permissions GET group_hrefmy_permissions/
PulpcoreClient::GroupsApi partial_update PATCH group_href Update a group
PulpcoreClient::GroupsApi read GET group_href Inspect a group
PulpcoreClient::GroupsApi remove_role POST group_hrefremove_role/
PulpcoreClient::GroupsApi update PUT group_href Update a group
PulpcoreClient::GroupsRolesApi create POST group_hrefroles/ Create a group role
PulpcoreClient::GroupsRolesApi delete DELETE groups_group_role_href Delete a group role
PulpcoreClient::GroupsRolesApi list GET group_hrefroles/ List group roles
PulpcoreClient::GroupsRolesApi read GET groups_group_role_href Inspect a group role
PulpcoreClient::GroupsUsersApi create POST group_hrefusers/ Create an user
PulpcoreClient::GroupsUsersApi delete DELETE groups_user_href Delete an user
PulpcoreClient::GroupsUsersApi list GET 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::RemotesApi list GET /pulp/api/v3/remotes/ List remotes
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::RolesApi create POST /pulp/api/v3/roles/ Create a role
PulpcoreClient::RolesApi delete DELETE role_href Delete a role
PulpcoreClient::RolesApi list GET /pulp/api/v3/roles/ List roles
PulpcoreClient::RolesApi partial_update PATCH role_href Update a role
PulpcoreClient::RolesApi read GET role_href Inspect a role
PulpcoreClient::RolesApi update PUT role_href Update a role
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::TaskSchedulesApi add_role POST task_schedule_hrefadd_role/
PulpcoreClient::TaskSchedulesApi list GET /pulp/api/v3/task-schedules/ List task schedules
PulpcoreClient::TaskSchedulesApi list_roles GET task_schedule_hreflist_roles/
PulpcoreClient::TaskSchedulesApi my_permissions GET task_schedule_hrefmy_permissions/
PulpcoreClient::TaskSchedulesApi read GET task_schedule_href Inspect a task schedule
PulpcoreClient::TaskSchedulesApi remove_role POST task_schedule_hrefremove_role/
PulpcoreClient::TasksApi add_role POST task_hrefadd_role/
PulpcoreClient::TasksApi delete DELETE task_href Delete a task
PulpcoreClient::TasksApi list GET /pulp/api/v3/tasks/ List tasks
PulpcoreClient::TasksApi list_roles GET task_hreflist_roles/
PulpcoreClient::TasksApi my_permissions GET task_hrefmy_permissions/
PulpcoreClient::TasksApi purge POST /pulp/api/v3/tasks/purge/ Purge Completed Tasks
PulpcoreClient::TasksApi read GET task_href Inspect a task
PulpcoreClient::TasksApi remove_role POST task_hrefremove_role/
PulpcoreClient::TasksApi tasks_cancel PATCH task_href Cancel a task
PulpcoreClient::UploadsApi add_role POST upload_hrefadd_role/
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 list_roles GET upload_hreflist_roles/
PulpcoreClient::UploadsApi my_permissions GET upload_hrefmy_permissions/
PulpcoreClient::UploadsApi read GET upload_href Inspect an upload
PulpcoreClient::UploadsApi remove_role POST upload_hrefremove_role/
PulpcoreClient::UploadsApi update PUT upload_href Upload a file chunk
PulpcoreClient::UpstreamPulpsApi create POST /pulp/api/v3/upstream-pulps/ Create an upstream pulp
PulpcoreClient::UpstreamPulpsApi delete DELETE upstream_pulp_href Delete an upstream pulp
PulpcoreClient::UpstreamPulpsApi list GET /pulp/api/v3/upstream-pulps/ List upstream pulps
PulpcoreClient::UpstreamPulpsApi partial_update PATCH upstream_pulp_href Update an upstream pulp
PulpcoreClient::UpstreamPulpsApi read GET upstream_pulp_href Inspect an upstream pulp
PulpcoreClient::UpstreamPulpsApi replicate POST upstream_pulp_hrefreplicate/ Replicate
PulpcoreClient::UpstreamPulpsApi update PUT upstream_pulp_href Update an upstream pulp
PulpcoreClient::UsersApi create POST /pulp/api/v3/users/ Create an user
PulpcoreClient::UsersApi delete DELETE auth_user_href Delete an user
PulpcoreClient::UsersApi list GET /pulp/api/v3/users/ List users
PulpcoreClient::UsersApi partial_update PATCH auth_user_href Update an user
PulpcoreClient::UsersApi read GET auth_user_href Inspect an user
PulpcoreClient::UsersApi update PUT auth_user_href Update an user
PulpcoreClient::UsersRolesApi create POST auth_user_hrefroles/ Create an user role
PulpcoreClient::UsersRolesApi delete DELETE auth_users_user_role_href Delete an user role
PulpcoreClient::UsersRolesApi list GET auth_user_hrefroles/ List user roles
PulpcoreClient::UsersRolesApi read GET auth_users_user_role_href Inspect an user role
PulpcoreClient::WorkersApi list GET /pulp/api/v3/workers/ List workers
PulpcoreClient::WorkersApi read GET worker_href Inspect a worker

Documentation for Models

Documentation for Authorization

basicAuth

  • Type: HTTP basic authentication