pulp_container_client

PulpContainerClient - 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: 2.22.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_container_client.gemspec

Then either install the gem locally:

gem install ./pulp_container_client-2.22.0.gem

(for development, run gem install --dev ./pulp_container_client-2.22.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_container_client', '~> 2.22.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_container_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_container_client'

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

api_instance = PulpContainerClient::ContentBlobsApi.new
opts = {
  digest: 'digest_example', # String | Filter results where digest matches value
  digest__in: ['digest__in_example'], # Array<String> | Filter results where digest is in a comma-separated list of values
  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) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `upstream_id` - Upstream id * `-upstream_id` - Upstream id (descending) * `timestamp_of_interest` - Timestamp of interest * `-timestamp_of_interest` - Timestamp of interest (descending) * `digest` - Digest * `-digest` - Digest (descending) * `pk` - Pk * `-pk` - Pk (descending)
  orphaned_for: 3.4, # Float | Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME.
  prn__in: ['prn__in_example'], # Array<String> | Multiple values may be separated by commas.
  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.
  q: 'q_example', # String | Filter results by using NOT, AND and OR operations on other filters
  repository_version: 'repository_version_example', # String | Repository Version referenced by HREF/PRN
  repository_version_added: 'repository_version_added_example', # String | Repository Version referenced by HREF/PRN
  repository_version_removed: 'repository_version_removed_example', # String | Repository Version referenced by HREF/PRN
  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 blobs
  result = api_instance.list(opts)
  p result
rescue PulpContainerClient::ApiError => e
  puts "Exception when calling ContentBlobsApi->list: #{e}"
end

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
PulpContainerClient::ContentBlobsApi	list	GET /pulp/api/v3/content/container/blobs/	List blobs
PulpContainerClient::ContentBlobsApi	read	GET container_blob_href	Inspect a blob
PulpContainerClient::ContentManifestsApi	list	GET /pulp/api/v3/content/container/manifests/	List manifests
PulpContainerClient::ContentManifestsApi	read	GET container_manifest_href	Inspect a manifest
PulpContainerClient::ContentSignaturesApi	list	GET /pulp/api/v3/content/container/signatures/	List manifest signatures
PulpContainerClient::ContentSignaturesApi	read	GET container_manifest_signature_href	Inspect a manifest signature
PulpContainerClient::ContentTagsApi	list	GET /pulp/api/v3/content/container/tags/	List tags
PulpContainerClient::ContentTagsApi	read	GET container_tag_href	Inspect a tag
PulpContainerClient::DistributionsContainerApi	add_role	POST container_container_distribution_hrefadd_role/	Add a role
PulpContainerClient::DistributionsContainerApi	create	POST /pulp/api/v3/distributions/container/container/	Create a container distribution
PulpContainerClient::DistributionsContainerApi	delete	DELETE container_container_distribution_href	Delete a container distribution
PulpContainerClient::DistributionsContainerApi	list	GET /pulp/api/v3/distributions/container/container/	List container distributions
PulpContainerClient::DistributionsContainerApi	list_roles	GET container_container_distribution_hreflist_roles/	List roles
PulpContainerClient::DistributionsContainerApi	my_permissions	GET container_container_distribution_hrefmy_permissions/	List user permissions
PulpContainerClient::DistributionsContainerApi	partial_update	PATCH container_container_distribution_href	Update a container distribution
PulpContainerClient::DistributionsContainerApi	read	GET container_container_distribution_href	Inspect a container distribution
PulpContainerClient::DistributionsContainerApi	remove_role	POST container_container_distribution_hrefremove_role/	Remove a role
PulpContainerClient::DistributionsContainerApi	set_label	POST container_container_distribution_hrefset_label/	Set a label
PulpContainerClient::DistributionsContainerApi	unset_label	POST container_container_distribution_hrefunset_label/	Unset a label
PulpContainerClient::DistributionsContainerApi	update	PUT container_container_distribution_href	Update a container distribution
PulpContainerClient::DistributionsPullThroughApi	add_role	POST container_container_pull_through_distribution_hrefadd_role/	Add a role
PulpContainerClient::DistributionsPullThroughApi	create	POST /pulp/api/v3/distributions/container/pull-through/	Create a container pull through distribution
PulpContainerClient::DistributionsPullThroughApi	delete	DELETE container_container_pull_through_distribution_href	Delete a container pull through distribution
PulpContainerClient::DistributionsPullThroughApi	list	GET /pulp/api/v3/distributions/container/pull-through/	List container pull through distributions
PulpContainerClient::DistributionsPullThroughApi	list_roles	GET container_container_pull_through_distribution_hreflist_roles/	List roles
PulpContainerClient::DistributionsPullThroughApi	my_permissions	GET container_container_pull_through_distribution_hrefmy_permissions/	List user permissions
PulpContainerClient::DistributionsPullThroughApi	partial_update	PATCH container_container_pull_through_distribution_href	Update a container pull through distribution
PulpContainerClient::DistributionsPullThroughApi	read	GET container_container_pull_through_distribution_href	Inspect a container pull through distribution
PulpContainerClient::DistributionsPullThroughApi	remove_role	POST container_container_pull_through_distribution_hrefremove_role/	Remove a role
PulpContainerClient::DistributionsPullThroughApi	set_label	POST container_container_pull_through_distribution_hrefset_label/	Set a label
PulpContainerClient::DistributionsPullThroughApi	unset_label	POST container_container_pull_through_distribution_hrefunset_label/	Unset a label
PulpContainerClient::DistributionsPullThroughApi	update	PUT container_container_pull_through_distribution_href	Update a container pull through distribution
PulpContainerClient::PulpContainerNamespacesApi	add_role	POST container_container_namespace_hrefadd_role/	Add a role
PulpContainerClient::PulpContainerNamespacesApi	create	POST /pulp/api/v3/pulp_container/namespaces/	Create a container namespace
PulpContainerClient::PulpContainerNamespacesApi	delete	DELETE container_container_namespace_href	Delete a container namespace
PulpContainerClient::PulpContainerNamespacesApi	list	GET /pulp/api/v3/pulp_container/namespaces/	List container namespaces
PulpContainerClient::PulpContainerNamespacesApi	list_roles	GET container_container_namespace_hreflist_roles/	List roles
PulpContainerClient::PulpContainerNamespacesApi	my_permissions	GET container_container_namespace_hrefmy_permissions/	List user permissions
PulpContainerClient::PulpContainerNamespacesApi	read	GET container_container_namespace_href	Inspect a container namespace
PulpContainerClient::PulpContainerNamespacesApi	remove_role	POST container_container_namespace_hrefremove_role/	Remove a role
PulpContainerClient::RemotesContainerApi	add_role	POST container_container_remote_hrefadd_role/	Add a role
PulpContainerClient::RemotesContainerApi	create	POST /pulp/api/v3/remotes/container/container/	Create a container remote
PulpContainerClient::RemotesContainerApi	delete	DELETE container_container_remote_href	Delete a container remote
PulpContainerClient::RemotesContainerApi	list	GET /pulp/api/v3/remotes/container/container/	List container remotes
PulpContainerClient::RemotesContainerApi	list_roles	GET container_container_remote_hreflist_roles/	List roles
PulpContainerClient::RemotesContainerApi	my_permissions	GET container_container_remote_hrefmy_permissions/	List user permissions
PulpContainerClient::RemotesContainerApi	partial_update	PATCH container_container_remote_href	Update a container remote
PulpContainerClient::RemotesContainerApi	read	GET container_container_remote_href	Inspect a container remote
PulpContainerClient::RemotesContainerApi	remove_role	POST container_container_remote_hrefremove_role/	Remove a role
PulpContainerClient::RemotesContainerApi	set_label	POST container_container_remote_hrefset_label/	Set a label
PulpContainerClient::RemotesContainerApi	unset_label	POST container_container_remote_hrefunset_label/	Unset a label
PulpContainerClient::RemotesContainerApi	update	PUT container_container_remote_href	Update a container remote
PulpContainerClient::RemotesPullThroughApi	add_role	POST container_container_pull_through_remote_hrefadd_role/	Add a role
PulpContainerClient::RemotesPullThroughApi	create	POST /pulp/api/v3/remotes/container/pull-through/	Create a container pull through remote
PulpContainerClient::RemotesPullThroughApi	delete	DELETE container_container_pull_through_remote_href	Delete a container pull through remote
PulpContainerClient::RemotesPullThroughApi	list	GET /pulp/api/v3/remotes/container/pull-through/	List container pull through remotes
PulpContainerClient::RemotesPullThroughApi	list_roles	GET container_container_pull_through_remote_hreflist_roles/	List roles
PulpContainerClient::RemotesPullThroughApi	my_permissions	GET container_container_pull_through_remote_hrefmy_permissions/	List user permissions
PulpContainerClient::RemotesPullThroughApi	partial_update	PATCH container_container_pull_through_remote_href	Update a container pull through remote
PulpContainerClient::RemotesPullThroughApi	read	GET container_container_pull_through_remote_href	Inspect a container pull through remote
PulpContainerClient::RemotesPullThroughApi	remove_role	POST container_container_pull_through_remote_hrefremove_role/	Remove a role
PulpContainerClient::RemotesPullThroughApi	set_label	POST container_container_pull_through_remote_hrefset_label/	Set a label
PulpContainerClient::RemotesPullThroughApi	unset_label	POST container_container_pull_through_remote_hrefunset_label/	Unset a label
PulpContainerClient::RemotesPullThroughApi	update	PUT container_container_pull_through_remote_href	Update a container pull through remote
PulpContainerClient::RepositoriesContainerApi	add	POST container_container_repository_hrefadd/	Add content
PulpContainerClient::RepositoriesContainerApi	add_role	POST container_container_repository_hrefadd_role/	Add a role
PulpContainerClient::RepositoriesContainerApi	build_image	POST container_container_repository_hrefbuild_image/	Build an Image
PulpContainerClient::RepositoriesContainerApi	copy_manifests	POST container_container_repository_hrefcopy_manifests/	Copy manifests
PulpContainerClient::RepositoriesContainerApi	copy_tags	POST container_container_repository_hrefcopy_tags/	Copy tags
PulpContainerClient::RepositoriesContainerApi	create	POST /pulp/api/v3/repositories/container/container/	Create a container repository
PulpContainerClient::RepositoriesContainerApi	delete	DELETE container_container_repository_href	Delete a container repository
PulpContainerClient::RepositoriesContainerApi	list	GET /pulp/api/v3/repositories/container/container/	List container repositorys
PulpContainerClient::RepositoriesContainerApi	list_roles	GET container_container_repository_hreflist_roles/	List roles
PulpContainerClient::RepositoriesContainerApi	my_permissions	GET container_container_repository_hrefmy_permissions/	List user permissions
PulpContainerClient::RepositoriesContainerApi	partial_update	PATCH container_container_repository_href	Update a container repository
PulpContainerClient::RepositoriesContainerApi	read	GET container_container_repository_href	Inspect a container repository
PulpContainerClient::RepositoriesContainerApi	remove	POST container_container_repository_hrefremove/	Remove content
PulpContainerClient::RepositoriesContainerApi	remove_role	POST container_container_repository_hrefremove_role/	Remove a role
PulpContainerClient::RepositoriesContainerApi	set_label	POST container_container_repository_hrefset_label/	Set a label
PulpContainerClient::RepositoriesContainerApi	sign	POST container_container_repository_hrefsign/	Sign images in the repo
PulpContainerClient::RepositoriesContainerApi	sync	POST container_container_repository_hrefsync/	Sync from a remote
PulpContainerClient::RepositoriesContainerApi	tag	POST container_container_repository_hreftag/	Create a Tag
PulpContainerClient::RepositoriesContainerApi	unset_label	POST container_container_repository_hrefunset_label/	Unset a label
PulpContainerClient::RepositoriesContainerApi	untag	POST container_container_repository_hrefuntag/	Delete a tag
PulpContainerClient::RepositoriesContainerApi	update	PUT container_container_repository_href	Update a container repository
PulpContainerClient::RepositoriesContainerPushApi	add_role	POST container_container_push_repository_hrefadd_role/	Add a role
PulpContainerClient::RepositoriesContainerPushApi	list	GET /pulp/api/v3/repositories/container/container-push/	List container push repositorys
PulpContainerClient::RepositoriesContainerPushApi	list_roles	GET container_container_push_repository_hreflist_roles/	List roles
PulpContainerClient::RepositoriesContainerPushApi	my_permissions	GET container_container_push_repository_hrefmy_permissions/	List user permissions
PulpContainerClient::RepositoriesContainerPushApi	partial_update	PATCH container_container_push_repository_href	Update a container push repository
PulpContainerClient::RepositoriesContainerPushApi	read	GET container_container_push_repository_href	Inspect a container push repository
PulpContainerClient::RepositoriesContainerPushApi	remove_image	POST container_container_push_repository_hrefremove_image/	Delete an image from a repository
PulpContainerClient::RepositoriesContainerPushApi	remove_role	POST container_container_push_repository_hrefremove_role/	Remove a role
PulpContainerClient::RepositoriesContainerPushApi	remove_signatures	POST container_container_push_repository_hrefremove_signatures/
PulpContainerClient::RepositoriesContainerPushApi	sign	POST container_container_push_repository_hrefsign/	Sign images in the repo
PulpContainerClient::RepositoriesContainerPushApi	tag	POST container_container_push_repository_hreftag/	Create a Tag
PulpContainerClient::RepositoriesContainerPushApi	untag	POST container_container_push_repository_hrefuntag/	Delete a tag
PulpContainerClient::RepositoriesContainerPushApi	update	PUT container_container_push_repository_href	Update a container push repository
PulpContainerClient::RepositoriesContainerPushVersionsApi	delete	DELETE container_container_push_repository_version_href	Delete a repository version
PulpContainerClient::RepositoriesContainerPushVersionsApi	list	GET container_container_push_repository_hrefversions/	List repository versions
PulpContainerClient::RepositoriesContainerPushVersionsApi	read	GET container_container_push_repository_version_href	Inspect a repository version
PulpContainerClient::RepositoriesContainerPushVersionsApi	repair	POST container_container_push_repository_version_hrefrepair/
PulpContainerClient::RepositoriesContainerVersionsApi	delete	DELETE container_container_repository_version_href	Delete a repository version
PulpContainerClient::RepositoriesContainerVersionsApi	list	GET container_container_repository_hrefversions/	List repository versions
PulpContainerClient::RepositoriesContainerVersionsApi	read	GET container_container_repository_version_href	Inspect a repository version
PulpContainerClient::RepositoriesContainerVersionsApi	repair	POST container_container_repository_version_hrefrepair/
PulpContainerClient::TokenApi	get	GET /token/

Documentation for Models

• PulpContainerClient::AsyncOperationResponse
• PulpContainerClient::ContainerBlobResponse
• PulpContainerClient::ContainerContainerDistribution
• PulpContainerClient::ContainerContainerDistributionResponse
• PulpContainerClient::ContainerContainerNamespace
• PulpContainerClient::ContainerContainerNamespaceResponse
• PulpContainerClient::ContainerContainerPullThroughDistribution
• PulpContainerClient::ContainerContainerPullThroughDistributionResponse
• PulpContainerClient::ContainerContainerPullThroughRemote
• PulpContainerClient::ContainerContainerPullThroughRemoteResponse
• PulpContainerClient::ContainerContainerPullThroughRemoteResponseHiddenFields
• PulpContainerClient::ContainerContainerPushRepository
• PulpContainerClient::ContainerContainerPushRepositoryResponse
• PulpContainerClient::ContainerContainerRemote
• PulpContainerClient::ContainerContainerRemoteResponse
• PulpContainerClient::ContainerContainerRepository
• PulpContainerClient::ContainerContainerRepositoryResponse
• PulpContainerClient::ContainerManifestResponse
• PulpContainerClient::ContainerManifestSignatureResponse
• PulpContainerClient::ContainerRepositorySyncURL
• PulpContainerClient::ContainerTagResponse
• PulpContainerClient::ContentSummaryResponse
• PulpContainerClient::ManifestCopy
• PulpContainerClient::MediaTypesEnum
• PulpContainerClient::MyPermissionsResponse
• PulpContainerClient::NestedRole
• PulpContainerClient::NestedRoleResponse
• PulpContainerClient::OCIBuildImage
• PulpContainerClient::ObjectRolesResponse
• PulpContainerClient::PaginatedRepositoryVersionResponseList
• PulpContainerClient::PaginatedcontainerBlobResponseList
• PulpContainerClient::PaginatedcontainerContainerDistributionResponseList
• PulpContainerClient::PaginatedcontainerContainerNamespaceResponseList
• PulpContainerClient::PaginatedcontainerContainerPullThroughDistributionResponseList
• PulpContainerClient::PaginatedcontainerContainerPullThroughRemoteResponseList
• PulpContainerClient::PaginatedcontainerContainerPushRepositoryResponseList
• PulpContainerClient::PaginatedcontainerContainerRemoteResponseList
• PulpContainerClient::PaginatedcontainerContainerRepositoryResponseList
• PulpContainerClient::PaginatedcontainerManifestResponseList
• PulpContainerClient::PaginatedcontainerManifestSignatureResponseList
• PulpContainerClient::PaginatedcontainerTagResponseList
• PulpContainerClient::PatchedcontainerContainerDistribution
• PulpContainerClient::PatchedcontainerContainerPullThroughDistribution
• PulpContainerClient::PatchedcontainerContainerPullThroughRemote
• PulpContainerClient::PatchedcontainerContainerPushRepository
• PulpContainerClient::PatchedcontainerContainerRemote
• PulpContainerClient::PatchedcontainerContainerRepository
• PulpContainerClient::Policy692Enum
• PulpContainerClient::Policy7e0Enum
• PulpContainerClient::RecursiveManage
• PulpContainerClient::RemoveImage
• PulpContainerClient::RemoveSignatures
• PulpContainerClient::RemoveSignaturesResponse
• PulpContainerClient::Repair
• PulpContainerClient::RepositorySign
• PulpContainerClient::RepositoryVersionResponse
• PulpContainerClient::SetLabel
• PulpContainerClient::SetLabelResponse
• PulpContainerClient::TagCopy
• PulpContainerClient::TagImage
• PulpContainerClient::UnTagImage
• PulpContainerClient::UnsetLabel
• PulpContainerClient::UnsetLabelResponse

Documentation for Authorization

basicAuth

• Type: HTTP basic authentication