pulp_container_client

PulpContainerClient - the Ruby gem for the Pulp 3 API

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

This SDK is automatically generated by the OpenAPI Generator project:

• API version: v3
• Package version: 1.0.0
• Build package: org.openapitools.codegen.languages.RubyClientCodegen

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-1.0.0.gem

(for development, run gem install --dev ./pulp_container_client-1.0.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', '~> 1.0.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: Basic
  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', # String | Filter results where digest is in a comma-separated list of values
  repository_version: 'repository_version_example', # String | Repository Version referenced by HREF
  repository_version_added: 'repository_version_added_example', # String | Repository Version referenced by HREF
  repository_version_removed: 'repository_version_removed_example', # String | Repository Version referenced by HREF
  media_type: 'media_type_example', # String | 
  limit: 56, # Integer | Number of results to return per page.
  offset: 56, # Integer | The initial index from which to return the results.
  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 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 blob_href	Inspect a blob
PulpContainerClient::ContentManifestsApi	list	GET /pulp/api/v3/content/container/manifests/	List manifests
PulpContainerClient::ContentManifestsApi	read	GET manifest_href	Inspect a manifest
PulpContainerClient::ContentTagsApi	list	GET /pulp/api/v3/content/container/tags/	List tags
PulpContainerClient::ContentTagsApi	read	GET tag_href	Inspect a tag
PulpContainerClient::DistributionsContainerApi	create	POST /pulp/api/v3/distributions/container/container/	Create a container distribution
PulpContainerClient::DistributionsContainerApi	delete	DELETE container_distribution_href	Delete a container distribution
PulpContainerClient::DistributionsContainerApi	list	GET /pulp/api/v3/distributions/container/container/	List container distributions
PulpContainerClient::DistributionsContainerApi	partial_update	PATCH container_distribution_href	Partially update a container distribution
PulpContainerClient::DistributionsContainerApi	read	GET container_distribution_href	Inspect a container distribution
PulpContainerClient::DistributionsContainerApi	update	PUT container_distribution_href	Update a container distribution
PulpContainerClient::RemotesContainerApi	create	POST /pulp/api/v3/remotes/container/container/	Create a container remote
PulpContainerClient::RemotesContainerApi	delete	DELETE container_remote_href	Delete a container remote
PulpContainerClient::RemotesContainerApi	list	GET /pulp/api/v3/remotes/container/container/	List container remotes
PulpContainerClient::RemotesContainerApi	partial_update	PATCH container_remote_href	Partially update a container remote
PulpContainerClient::RemotesContainerApi	read	GET container_remote_href	Inspect a container remote
PulpContainerClient::RemotesContainerApi	update	PUT container_remote_href	Update a container remote
PulpContainerClient::RepositoriesContainerApi	add	POST container_repository_hrefadd/
PulpContainerClient::RepositoriesContainerApi	copy_manifests	POST container_repository_hrefcopy_manifests/
PulpContainerClient::RepositoriesContainerApi	copy_tags	POST container_repository_hrefcopy_tags/
PulpContainerClient::RepositoriesContainerApi	create	POST /pulp/api/v3/repositories/container/container/	Create a container repository
PulpContainerClient::RepositoriesContainerApi	delete	DELETE container_repository_href	Delete a container repository
PulpContainerClient::RepositoriesContainerApi	list	GET /pulp/api/v3/repositories/container/container/	List container repositorys
PulpContainerClient::RepositoriesContainerApi	partial_update	PATCH container_repository_href	Partially update a container repository
PulpContainerClient::RepositoriesContainerApi	read	GET container_repository_href	Inspect a container repository
PulpContainerClient::RepositoriesContainerApi	remove	POST container_repository_hrefremove/
PulpContainerClient::RepositoriesContainerApi	sync	POST container_repository_hrefsync/
PulpContainerClient::RepositoriesContainerApi	tag	POST container_repository_hreftag/
PulpContainerClient::RepositoriesContainerApi	untag	POST container_repository_hrefuntag/
PulpContainerClient::RepositoriesContainerApi	update	PUT container_repository_href	Update a container repository
PulpContainerClient::RepositoriesContainerVersionsApi	delete	DELETE container_repository_version_href	Delete a repository version
PulpContainerClient::RepositoriesContainerVersionsApi	list	GET container_repository_hrefversions/	List repository versions
PulpContainerClient::RepositoriesContainerVersionsApi	read	GET container_repository_version_href	Inspect a repository version

Documentation for Models

• PulpContainerClient::AsyncOperationResponse
• PulpContainerClient::ContainerBlob
• PulpContainerClient::ContainerContainerDistribution
• PulpContainerClient::ContainerContainerRemote
• PulpContainerClient::ContainerContainerRepository
• PulpContainerClient::ContainerManifest
• PulpContainerClient::ContainerTag
• PulpContainerClient::ContentSummary
• PulpContainerClient::InlineResponse200
• PulpContainerClient::InlineResponse2001
• PulpContainerClient::InlineResponse2002
• PulpContainerClient::InlineResponse2003
• PulpContainerClient::InlineResponse2004
• PulpContainerClient::InlineResponse2005
• PulpContainerClient::InlineResponse2006
• PulpContainerClient::ManifestCopy
• PulpContainerClient::RecursiveManage
• PulpContainerClient::RepositorySyncURL
• PulpContainerClient::RepositoryVersion
• PulpContainerClient::TagCopy
• PulpContainerClient::TagImage
• PulpContainerClient::UnTagImage

Documentation for Authorization

Basic

• Type: HTTP basic authentication