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.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_container_client.gemspec
Then either install the gem locally:
gem install ./pulp_container_client-2.10.0.gem
(for development, run gem install --dev ./pulp_container_client-2.10.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.10.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.
media_type: ['media_type_example'], # Array<String> |
offset: 56, # Integer | The initial index from which to return the results.
ordering: 'ordering_example', # String | Which field to use when ordering the results.
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
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 https://pulp
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::ContentTagsApi | list | GET /pulp/api/v3/content/container/tags/ | List tags |
PulpContainerClient::ContentTagsApi | read | GET container_tag_href | Inspect a tag |
PulpContainerClient::ContentguardsContentRedirectApi | create | POST /pulp/api/v3/contentguards/container/content_redirect/ | Create a content redirect content guard |
PulpContainerClient::ContentguardsContentRedirectApi | delete | DELETE container_content_redirect_content_guard_href | Delete a content redirect content guard |
PulpContainerClient::ContentguardsContentRedirectApi | list | GET /pulp/api/v3/contentguards/container/content_redirect/ | List content redirect content guards |
PulpContainerClient::ContentguardsContentRedirectApi | partial_update | PATCH container_content_redirect_content_guard_href | Update a content redirect content guard |
PulpContainerClient::ContentguardsContentRedirectApi | read | GET container_content_redirect_content_guard_href | Inspect a content redirect content guard |
PulpContainerClient::ContentguardsContentRedirectApi | update | PUT container_content_redirect_content_guard_href | Update a content redirect content guard |
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 | 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 | update | PUT container_container_distribution_href | Update a container distribution |
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 | read | GET container_container_namespace_href | Inspect a container namespace |
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 | 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 | update | PUT container_container_remote_href | Update a container remote |
PulpContainerClient::RepositoriesContainerApi | add | POST container_container_repository_hrefadd/ | Add content |
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 | 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 | sync | POST container_container_repository_hrefsync/ | Sync from a remote |
PulpContainerClient::RepositoriesContainerApi | tag | POST container_container_repository_hreftag/ | Create a Tag |
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 | list | GET /pulp/api/v3/repositories/container/container-push/ | List container push repositorys |
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 | 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::ContainerContainerPushRepository
- PulpContainerClient::ContainerContainerPushRepositoryResponse
- PulpContainerClient::ContainerContainerRemote
- PulpContainerClient::ContainerContainerRemoteResponse
- PulpContainerClient::ContainerContainerRepository
- PulpContainerClient::ContainerContainerRepositoryResponse
- PulpContainerClient::ContainerContentRedirectContentGuard
- PulpContainerClient::ContainerContentRedirectContentGuardResponse
- PulpContainerClient::ContainerManifestResponse
- PulpContainerClient::ContainerTagResponse
- PulpContainerClient::ContentSummary
- PulpContainerClient::ContentSummaryResponse
- PulpContainerClient::ManifestCopy
- PulpContainerClient::MediaTypesEnum
- PulpContainerClient::OCIBuildImage
- PulpContainerClient::PaginatedRepositoryVersionResponseList
- PulpContainerClient::PaginatedcontainerBlobResponseList
- PulpContainerClient::PaginatedcontainerContainerDistributionResponseList
- PulpContainerClient::PaginatedcontainerContainerNamespaceResponseList
- PulpContainerClient::PaginatedcontainerContainerPushRepositoryResponseList
- PulpContainerClient::PaginatedcontainerContainerRemoteResponseList
- PulpContainerClient::PaginatedcontainerContainerRepositoryResponseList
- PulpContainerClient::PaginatedcontainerContentRedirectContentGuardResponseList
- PulpContainerClient::PaginatedcontainerManifestResponseList
- PulpContainerClient::PaginatedcontainerTagResponseList
- PulpContainerClient::PatchedcontainerContainerDistribution
- PulpContainerClient::PatchedcontainerContainerPushRepository
- PulpContainerClient::PatchedcontainerContainerRemote
- PulpContainerClient::PatchedcontainerContainerRepository
- PulpContainerClient::PatchedcontainerContentRedirectContentGuard
- PulpContainerClient::PolicyEnum
- PulpContainerClient::RecursiveManage
- PulpContainerClient::RemoveImage
- PulpContainerClient::RepositorySyncURL
- PulpContainerClient::RepositoryVersion
- PulpContainerClient::RepositoryVersionResponse
- PulpContainerClient::TagCopy
- PulpContainerClient::TagImage
- PulpContainerClient::UnTagImage
Documentation for Authorization
basicAuth
- Type: HTTP basic authentication