pulp_ostree_client

PulpOstreeClient - 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.4.4
• 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_ostree_client.gemspec

Then either install the gem locally:

gem install ./pulp_ostree_client-2.4.4.gem

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

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_ostree_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_ostree_client'

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

api_instance = PulpOstreeClient::ContentCommitsApi.new
opts = {
  checksum: 'checksum_example', # String | Filter results where checksum 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) * `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) * `checksum` - Checksum * `-checksum` - Checksum (descending) * `relative_path` - Relative path * `-relative_path` - Relative path (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 ostree commits
  result = api_instance.list(opts)
  p result
rescue PulpOstreeClient::ApiError => e
  puts "Exception when calling ContentCommitsApi->list: #{e}"
end

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
PulpOstreeClient::ContentCommitsApi	list	GET /pulp/api/v3/content/ostree/commits/	List ostree commits
PulpOstreeClient::ContentCommitsApi	read	GET ostree_ostree_commit_href	Inspect an ostree commit
PulpOstreeClient::ContentConfigsApi	list	GET /pulp/api/v3/content/ostree/configs/	List ostree configs
PulpOstreeClient::ContentConfigsApi	read	GET ostree_ostree_config_href	Inspect an ostree config
PulpOstreeClient::ContentContentApi	create	POST /pulp/api/v3/content/ostree/content/	Create an ostree content
PulpOstreeClient::ContentContentApi	list	GET /pulp/api/v3/content/ostree/content/	List ostree contents
PulpOstreeClient::ContentContentApi	read	GET ostree_ostree_content_href	Inspect an ostree content
PulpOstreeClient::ContentObjectsApi	list	GET /pulp/api/v3/content/ostree/objects/	List ostree objects
PulpOstreeClient::ContentObjectsApi	read	GET ostree_ostree_object_href	Inspect an ostree object
PulpOstreeClient::ContentRefsApi	list	GET /pulp/api/v3/content/ostree/refs/	List ostree refs
PulpOstreeClient::ContentRefsApi	read	GET ostree_ostree_ref_href	Inspect an ostree ref
PulpOstreeClient::ContentSummariesApi	list	GET /pulp/api/v3/content/ostree/summaries/	List ostree summarys
PulpOstreeClient::ContentSummariesApi	read	GET ostree_ostree_summary_href	Inspect an ostree summary
PulpOstreeClient::DistributionsOstreeApi	add_role	POST ostree_ostree_distribution_hrefadd_role/	Add a role
PulpOstreeClient::DistributionsOstreeApi	create	POST /pulp/api/v3/distributions/ostree/ostree/	Create an ostree distribution
PulpOstreeClient::DistributionsOstreeApi	delete	DELETE ostree_ostree_distribution_href	Delete an ostree distribution
PulpOstreeClient::DistributionsOstreeApi	list	GET /pulp/api/v3/distributions/ostree/ostree/	List ostree distributions
PulpOstreeClient::DistributionsOstreeApi	list_roles	GET ostree_ostree_distribution_hreflist_roles/	List roles
PulpOstreeClient::DistributionsOstreeApi	my_permissions	GET ostree_ostree_distribution_hrefmy_permissions/	List user permissions
PulpOstreeClient::DistributionsOstreeApi	partial_update	PATCH ostree_ostree_distribution_href	Update an ostree distribution
PulpOstreeClient::DistributionsOstreeApi	read	GET ostree_ostree_distribution_href	Inspect an ostree distribution
PulpOstreeClient::DistributionsOstreeApi	remove_role	POST ostree_ostree_distribution_hrefremove_role/	Remove a role
PulpOstreeClient::DistributionsOstreeApi	set_label	POST ostree_ostree_distribution_hrefset_label/	Set a label
PulpOstreeClient::DistributionsOstreeApi	unset_label	POST ostree_ostree_distribution_hrefunset_label/	Unset a label
PulpOstreeClient::DistributionsOstreeApi	update	PUT ostree_ostree_distribution_href	Update an ostree distribution
PulpOstreeClient::RemotesOstreeApi	add_role	POST ostree_ostree_remote_hrefadd_role/	Add a role
PulpOstreeClient::RemotesOstreeApi	create	POST /pulp/api/v3/remotes/ostree/ostree/	Create an ostree remote
PulpOstreeClient::RemotesOstreeApi	delete	DELETE ostree_ostree_remote_href	Delete an ostree remote
PulpOstreeClient::RemotesOstreeApi	list	GET /pulp/api/v3/remotes/ostree/ostree/	List ostree remotes
PulpOstreeClient::RemotesOstreeApi	list_roles	GET ostree_ostree_remote_hreflist_roles/	List roles
PulpOstreeClient::RemotesOstreeApi	my_permissions	GET ostree_ostree_remote_hrefmy_permissions/	List user permissions
PulpOstreeClient::RemotesOstreeApi	partial_update	PATCH ostree_ostree_remote_href	Update an ostree remote
PulpOstreeClient::RemotesOstreeApi	read	GET ostree_ostree_remote_href	Inspect an ostree remote
PulpOstreeClient::RemotesOstreeApi	remove_role	POST ostree_ostree_remote_hrefremove_role/	Remove a role
PulpOstreeClient::RemotesOstreeApi	set_label	POST ostree_ostree_remote_hrefset_label/	Set a label
PulpOstreeClient::RemotesOstreeApi	unset_label	POST ostree_ostree_remote_hrefunset_label/	Unset a label
PulpOstreeClient::RemotesOstreeApi	update	PUT ostree_ostree_remote_href	Update an ostree remote
PulpOstreeClient::RepositoriesOstreeApi	add_role	POST ostree_ostree_repository_hrefadd_role/	Add a role
PulpOstreeClient::RepositoriesOstreeApi	create	POST /pulp/api/v3/repositories/ostree/ostree/	Create an ostree repository
PulpOstreeClient::RepositoriesOstreeApi	delete	DELETE ostree_ostree_repository_href	Delete an ostree repository
PulpOstreeClient::RepositoriesOstreeApi	import_all	POST ostree_ostree_repository_hrefimport_all/	Import refs and commits to a repository
PulpOstreeClient::RepositoriesOstreeApi	import_commits	POST ostree_ostree_repository_hrefimport_commits/	Append child commits to a repository
PulpOstreeClient::RepositoriesOstreeApi	list	GET /pulp/api/v3/repositories/ostree/ostree/	List ostree repositorys
PulpOstreeClient::RepositoriesOstreeApi	list_roles	GET ostree_ostree_repository_hreflist_roles/	List roles
PulpOstreeClient::RepositoriesOstreeApi	modify	POST ostree_ostree_repository_hrefmodify/	Modify repository
PulpOstreeClient::RepositoriesOstreeApi	my_permissions	GET ostree_ostree_repository_hrefmy_permissions/	List user permissions
PulpOstreeClient::RepositoriesOstreeApi	partial_update	PATCH ostree_ostree_repository_href	Update an ostree repository
PulpOstreeClient::RepositoriesOstreeApi	read	GET ostree_ostree_repository_href	Inspect an ostree repository
PulpOstreeClient::RepositoriesOstreeApi	remove_role	POST ostree_ostree_repository_hrefremove_role/	Remove a role
PulpOstreeClient::RepositoriesOstreeApi	set_label	POST ostree_ostree_repository_hrefset_label/	Set a label
PulpOstreeClient::RepositoriesOstreeApi	sync	POST ostree_ostree_repository_hrefsync/	Sync from remote
PulpOstreeClient::RepositoriesOstreeApi	unset_label	POST ostree_ostree_repository_hrefunset_label/	Unset a label
PulpOstreeClient::RepositoriesOstreeApi	update	PUT ostree_ostree_repository_href	Update an ostree repository
PulpOstreeClient::RepositoriesOstreeVersionsApi	delete	DELETE ostree_ostree_repository_version_href	Delete a repository version
PulpOstreeClient::RepositoriesOstreeVersionsApi	list	GET ostree_ostree_repository_hrefversions/	List repository versions
PulpOstreeClient::RepositoriesOstreeVersionsApi	read	GET ostree_ostree_repository_version_href	Inspect a repository version
PulpOstreeClient::RepositoriesOstreeVersionsApi	repair	POST ostree_ostree_repository_version_hrefrepair/

Documentation for Models

• PulpOstreeClient::AsyncOperationResponse
• PulpOstreeClient::ContentSummaryResponse
• PulpOstreeClient::MyPermissionsResponse
• PulpOstreeClient::NestedRole
• PulpOstreeClient::NestedRoleResponse
• PulpOstreeClient::ObjectRolesResponse
• PulpOstreeClient::OstreeImportAll
• PulpOstreeClient::OstreeImportCommitsToRef
• PulpOstreeClient::OstreeOstreeCommitResponse
• PulpOstreeClient::OstreeOstreeConfigResponse
• PulpOstreeClient::OstreeOstreeContent
• PulpOstreeClient::OstreeOstreeContentResponse
• PulpOstreeClient::OstreeOstreeDistribution
• PulpOstreeClient::OstreeOstreeDistributionResponse
• PulpOstreeClient::OstreeOstreeObjectResponse
• PulpOstreeClient::OstreeOstreeRefResponse
• PulpOstreeClient::OstreeOstreeRemote
• PulpOstreeClient::OstreeOstreeRemoteResponse
• PulpOstreeClient::OstreeOstreeRemoteResponseHiddenFields
• PulpOstreeClient::OstreeOstreeRepository
• PulpOstreeClient::OstreeOstreeRepositoryResponse
• PulpOstreeClient::OstreeOstreeSummaryResponse
• PulpOstreeClient::PaginatedRepositoryVersionResponseList
• PulpOstreeClient::PaginatedostreeOstreeCommitResponseList
• PulpOstreeClient::PaginatedostreeOstreeConfigResponseList
• PulpOstreeClient::PaginatedostreeOstreeContentResponseList
• PulpOstreeClient::PaginatedostreeOstreeDistributionResponseList
• PulpOstreeClient::PaginatedostreeOstreeObjectResponseList
• PulpOstreeClient::PaginatedostreeOstreeRefResponseList
• PulpOstreeClient::PaginatedostreeOstreeRemoteResponseList
• PulpOstreeClient::PaginatedostreeOstreeRepositoryResponseList
• PulpOstreeClient::PaginatedostreeOstreeSummaryResponseList
• PulpOstreeClient::PatchedostreeOstreeDistribution
• PulpOstreeClient::PatchedostreeOstreeRemote
• PulpOstreeClient::PatchedostreeOstreeRepository
• PulpOstreeClient::PolicyEnum
• PulpOstreeClient::Repair
• PulpOstreeClient::RepositoryAddRemoveContent
• PulpOstreeClient::RepositorySyncURL
• PulpOstreeClient::RepositoryVersionResponse
• PulpOstreeClient::SetLabel
• PulpOstreeClient::SetLabelResponse
• PulpOstreeClient::UnsetLabel
• PulpOstreeClient::UnsetLabelResponse

Documentation for Authorization

basicAuth

• Type: HTTP basic authentication