pulp-ostree-client 2.6.0

Pulp 3 API

pulp_ostree-client

Fetch, Upload, Organize, and Distribute Software Packages

This Python package is automatically generated by the OpenAPI Generator project:

• API version: v3
• Package version: 2.6.0
• Generator version: 7.14.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://pulpproject.org

Requirements.

Python 3.9+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import pulpcore.client.pulp_ostree

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import pulpcore.client.pulp_ostree

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import pulpcore.client.pulp_ostree
from pulpcore.client.pulp_ostree.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:24817
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_ostree.Configuration(
    host = "http://localhost:24817"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_ostree.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'


# Enter a context with an instance of the API client
with pulpcore.client.pulp_ostree.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_ostree.ContentCommitsApi(api_client)
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    checksum = 'checksum_example' # str | Filter results where checksum matches value (optional)
    limit = 56 # int | Number of results to return per page. (optional)
    offset = 56 # int | The initial index from which to return the results. (optional)
    ordering = ['ordering_example'] # List[str] | 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) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (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) (optional)
    orphaned_for = 3.4 # float | Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME. (optional)
    prn__in = ['prn__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
    pulp_href__in = ['pulp_href__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
    pulp_id__in = ['pulp_id__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
    pulp_label_select = 'pulp_label_select_example' # str | Filter labels by search string (optional)
    q = 'q_example' # str | Filter results by using NOT, AND and OR operations on other filters (optional)
    repository_version = 'repository_version_example' # str | Repository Version referenced by HREF/PRN (optional)
    repository_version_added = 'repository_version_added_example' # str | Repository Version referenced by HREF/PRN (optional)
    repository_version_removed = 'repository_version_removed_example' # str | Repository Version referenced by HREF/PRN (optional)
    fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
    exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)

    try:
        # List ostree commits
        api_response = api_instance.list(x_task_diagnostics=x_task_diagnostics, checksum=checksum, limit=limit, offset=offset, ordering=ordering, orphaned_for=orphaned_for, prn__in=prn__in, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, pulp_label_select=pulp_label_select, q=q, repository_version=repository_version, repository_version_added=repository_version_added, repository_version_removed=repository_version_removed, fields=fields, exclude_fields=exclude_fields)
        print("The response of ContentCommitsApi->list:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ContentCommitsApi->list: %s\n" % e)

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
ContentCommitsApi	list	GET /pulp/api/v3/content/ostree/commits/	List ostree commits
ContentCommitsApi	read	GET {ostree_ostree_commit_href}	Inspect an ostree commit
ContentCommitsApi	set_label	POST {ostree_ostree_commit_href}set_label/	Set a label
ContentCommitsApi	unset_label	POST {ostree_ostree_commit_href}unset_label/	Unset a label
ContentConfigsApi	list	GET /pulp/api/v3/content/ostree/configs/	List ostree configs
ContentConfigsApi	read	GET {ostree_ostree_config_href}	Inspect an ostree config
ContentConfigsApi	set_label	POST {ostree_ostree_config_href}set_label/	Set a label
ContentConfigsApi	unset_label	POST {ostree_ostree_config_href}unset_label/	Unset a label
ContentContentApi	create	POST /pulp/api/v3/content/ostree/content/	Create an ostree content
ContentContentApi	list	GET /pulp/api/v3/content/ostree/content/	List ostree contents
ContentContentApi	read	GET {ostree_ostree_content_href}	Inspect an ostree content
ContentContentApi	set_label	POST {ostree_ostree_content_href}set_label/	Set a label
ContentContentApi	unset_label	POST {ostree_ostree_content_href}unset_label/	Unset a label
ContentObjectsApi	list	GET /pulp/api/v3/content/ostree/objects/	List ostree objects
ContentObjectsApi	read	GET {ostree_ostree_object_href}	Inspect an ostree object
ContentObjectsApi	set_label	POST {ostree_ostree_object_href}set_label/	Set a label
ContentObjectsApi	unset_label	POST {ostree_ostree_object_href}unset_label/	Unset a label
ContentRefsApi	list	GET /pulp/api/v3/content/ostree/refs/	List ostree refs
ContentRefsApi	read	GET {ostree_ostree_ref_href}	Inspect an ostree ref
ContentRefsApi	set_label	POST {ostree_ostree_ref_href}set_label/	Set a label
ContentRefsApi	unset_label	POST {ostree_ostree_ref_href}unset_label/	Unset a label
ContentSummariesApi	list	GET /pulp/api/v3/content/ostree/summaries/	List ostree summarys
ContentSummariesApi	read	GET {ostree_ostree_summary_href}	Inspect an ostree summary
ContentSummariesApi	set_label	POST {ostree_ostree_summary_href}set_label/	Set a label
ContentSummariesApi	unset_label	POST {ostree_ostree_summary_href}unset_label/	Unset a label
DistributionsOstreeApi	add_role	POST {ostree_ostree_distribution_href}add_role/	Add a role
DistributionsOstreeApi	create	POST /pulp/api/v3/distributions/ostree/ostree/	Create an ostree distribution
DistributionsOstreeApi	delete	DELETE {ostree_ostree_distribution_href}	Delete an ostree distribution
DistributionsOstreeApi	list	GET /pulp/api/v3/distributions/ostree/ostree/	List ostree distributions
DistributionsOstreeApi	list_roles	GET {ostree_ostree_distribution_href}list_roles/	List roles
DistributionsOstreeApi	my_permissions	GET {ostree_ostree_distribution_href}my_permissions/	List user permissions
DistributionsOstreeApi	partial_update	PATCH {ostree_ostree_distribution_href}	Update an ostree distribution
DistributionsOstreeApi	read	GET {ostree_ostree_distribution_href}	Inspect an ostree distribution
DistributionsOstreeApi	remove_role	POST {ostree_ostree_distribution_href}remove_role/	Remove a role
DistributionsOstreeApi	set_label	POST {ostree_ostree_distribution_href}set_label/	Set a label
DistributionsOstreeApi	unset_label	POST {ostree_ostree_distribution_href}unset_label/	Unset a label
DistributionsOstreeApi	update	PUT {ostree_ostree_distribution_href}	Update an ostree distribution
RemotesOstreeApi	add_role	POST {ostree_ostree_remote_href}add_role/	Add a role
RemotesOstreeApi	create	POST /pulp/api/v3/remotes/ostree/ostree/	Create an ostree remote
RemotesOstreeApi	delete	DELETE {ostree_ostree_remote_href}	Delete an ostree remote
RemotesOstreeApi	list	GET /pulp/api/v3/remotes/ostree/ostree/	List ostree remotes
RemotesOstreeApi	list_roles	GET {ostree_ostree_remote_href}list_roles/	List roles
RemotesOstreeApi	my_permissions	GET {ostree_ostree_remote_href}my_permissions/	List user permissions
RemotesOstreeApi	partial_update	PATCH {ostree_ostree_remote_href}	Update an ostree remote
RemotesOstreeApi	read	GET {ostree_ostree_remote_href}	Inspect an ostree remote
RemotesOstreeApi	remove_role	POST {ostree_ostree_remote_href}remove_role/	Remove a role
RemotesOstreeApi	set_label	POST {ostree_ostree_remote_href}set_label/	Set a label
RemotesOstreeApi	unset_label	POST {ostree_ostree_remote_href}unset_label/	Unset a label
RemotesOstreeApi	update	PUT {ostree_ostree_remote_href}	Update an ostree remote
RepositoriesOstreeApi	add_role	POST {ostree_ostree_repository_href}add_role/	Add a role
RepositoriesOstreeApi	create	POST /pulp/api/v3/repositories/ostree/ostree/	Create an ostree repository
RepositoriesOstreeApi	delete	DELETE {ostree_ostree_repository_href}	Delete an ostree repository
RepositoriesOstreeApi	import_all	POST {ostree_ostree_repository_href}import_all/	Import refs and commits to a repository
RepositoriesOstreeApi	import_commits	POST {ostree_ostree_repository_href}import_commits/	Append child commits to a repository
RepositoriesOstreeApi	list	GET /pulp/api/v3/repositories/ostree/ostree/	List ostree repositorys
RepositoriesOstreeApi	list_roles	GET {ostree_ostree_repository_href}list_roles/	List roles
RepositoriesOstreeApi	modify	POST {ostree_ostree_repository_href}modify/	Modify repository
RepositoriesOstreeApi	my_permissions	GET {ostree_ostree_repository_href}my_permissions/	List user permissions
RepositoriesOstreeApi	partial_update	PATCH {ostree_ostree_repository_href}	Update an ostree repository
RepositoriesOstreeApi	read	GET {ostree_ostree_repository_href}	Inspect an ostree repository
RepositoriesOstreeApi	remove_role	POST {ostree_ostree_repository_href}remove_role/	Remove a role
RepositoriesOstreeApi	set_label	POST {ostree_ostree_repository_href}set_label/	Set a label
RepositoriesOstreeApi	sync	POST {ostree_ostree_repository_href}sync/	Sync from remote
RepositoriesOstreeApi	unset_label	POST {ostree_ostree_repository_href}unset_label/	Unset a label
RepositoriesOstreeApi	update	PUT {ostree_ostree_repository_href}	Update an ostree repository
RepositoriesOstreeVersionsApi	delete	DELETE {ostree_ostree_repository_version_href}	Delete a repository version
RepositoriesOstreeVersionsApi	list	GET {ostree_ostree_repository_href}versions/	List repository versions
RepositoriesOstreeVersionsApi	read	GET {ostree_ostree_repository_version_href}	Inspect a repository version
RepositoriesOstreeVersionsApi	repair	POST {ostree_ostree_repository_version_href}repair/

Documentation For Models

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

Documentation For Authorization

Authentication schemes defined for the API:

basicAuth

• Type: HTTP basic authentication

cookieAuth

• Type: API key
• API key parameter name: sessionid
• Location:

Author

[e-mail]