pulp-container-client 2.27.0

Pulp 3 API

pulp_container-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.27.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_container

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_container

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import pulpcore.client.pulp_container
from pulpcore.client.pulp_container.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_container.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_container.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_container.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_container.ContentBlobsApi(api_client)
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    digest = 'digest_example' # str | Filter results where digest matches value (optional)
    digest__in = ['digest__in_example'] # List[str] | Filter results where digest is in a comma-separated list of values (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) * `digest` - Digest * `-digest` - Digest (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 blobs
        api_response = api_instance.list(x_task_diagnostics=x_task_diagnostics, digest=digest, digest__in=digest__in, 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 ContentBlobsApi->list:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ContentBlobsApi->list: %s\n" % e)

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
ContentBlobsApi	list	GET /pulp/api/v3/content/container/blobs/	List blobs
ContentBlobsApi	read	GET {container_blob_href}	Inspect a blob
ContentBlobsApi	set_label	POST {container_blob_href}set_label/	Set a label
ContentBlobsApi	unset_label	POST {container_blob_href}unset_label/	Unset a label
ContentManifestsApi	list	GET /pulp/api/v3/content/container/manifests/	List manifests
ContentManifestsApi	read	GET {container_manifest_href}	Inspect a manifest
ContentManifestsApi	set_label	POST {container_manifest_href}set_label/	Set a label
ContentManifestsApi	unset_label	POST {container_manifest_href}unset_label/	Unset a label
ContentSignaturesApi	list	GET /pulp/api/v3/content/container/signatures/	List manifest signatures
ContentSignaturesApi	read	GET {container_manifest_signature_href}	Inspect a manifest signature
ContentSignaturesApi	set_label	POST {container_manifest_signature_href}set_label/	Set a label
ContentSignaturesApi	unset_label	POST {container_manifest_signature_href}unset_label/	Unset a label
ContentTagsApi	list	GET /pulp/api/v3/content/container/tags/	List tags
ContentTagsApi	read	GET {container_tag_href}	Inspect a tag
ContentTagsApi	set_label	POST {container_tag_href}set_label/	Set a label
ContentTagsApi	unset_label	POST {container_tag_href}unset_label/	Unset a label
DistributionsContainerApi	add_role	POST {container_container_distribution_href}add_role/	Add a role
DistributionsContainerApi	create	POST /pulp/api/v3/distributions/container/container/	Create a container distribution
DistributionsContainerApi	delete	DELETE {container_container_distribution_href}	Delete a container distribution
DistributionsContainerApi	list	GET /pulp/api/v3/distributions/container/container/	List container distributions
DistributionsContainerApi	list_roles	GET {container_container_distribution_href}list_roles/	List roles
DistributionsContainerApi	my_permissions	GET {container_container_distribution_href}my_permissions/	List user permissions
DistributionsContainerApi	partial_update	PATCH {container_container_distribution_href}	Update a container distribution
DistributionsContainerApi	read	GET {container_container_distribution_href}	Inspect a container distribution
DistributionsContainerApi	remove_role	POST {container_container_distribution_href}remove_role/	Remove a role
DistributionsContainerApi	set_label	POST {container_container_distribution_href}set_label/	Set a label
DistributionsContainerApi	unset_label	POST {container_container_distribution_href}unset_label/	Unset a label
DistributionsContainerApi	update	PUT {container_container_distribution_href}	Update a container distribution
DistributionsPullThroughApi	add_role	POST {container_container_pull_through_distribution_href}add_role/	Add a role
DistributionsPullThroughApi	create	POST /pulp/api/v3/distributions/container/pull-through/	Create a container pull through distribution
DistributionsPullThroughApi	delete	DELETE {container_container_pull_through_distribution_href}	Delete a container pull through distribution
DistributionsPullThroughApi	list	GET /pulp/api/v3/distributions/container/pull-through/	List container pull through distributions
DistributionsPullThroughApi	list_roles	GET {container_container_pull_through_distribution_href}list_roles/	List roles
DistributionsPullThroughApi	my_permissions	GET {container_container_pull_through_distribution_href}my_permissions/	List user permissions
DistributionsPullThroughApi	partial_update	PATCH {container_container_pull_through_distribution_href}	Update a container pull through distribution
DistributionsPullThroughApi	read	GET {container_container_pull_through_distribution_href}	Inspect a container pull through distribution
DistributionsPullThroughApi	remove_role	POST {container_container_pull_through_distribution_href}remove_role/	Remove a role
DistributionsPullThroughApi	set_label	POST {container_container_pull_through_distribution_href}set_label/	Set a label
DistributionsPullThroughApi	unset_label	POST {container_container_pull_through_distribution_href}unset_label/	Unset a label
DistributionsPullThroughApi	update	PUT {container_container_pull_through_distribution_href}	Update a container pull through distribution
PulpContainerNamespacesApi	add_role	POST {container_container_namespace_href}add_role/	Add a role
PulpContainerNamespacesApi	create	POST /pulp/api/v3/pulp_container/namespaces/	Create a container namespace
PulpContainerNamespacesApi	delete	DELETE {container_container_namespace_href}	Delete a container namespace
PulpContainerNamespacesApi	list	GET /pulp/api/v3/pulp_container/namespaces/	List container namespaces
PulpContainerNamespacesApi	list_roles	GET {container_container_namespace_href}list_roles/	List roles
PulpContainerNamespacesApi	my_permissions	GET {container_container_namespace_href}my_permissions/	List user permissions
PulpContainerNamespacesApi	read	GET {container_container_namespace_href}	Inspect a container namespace
PulpContainerNamespacesApi	remove_role	POST {container_container_namespace_href}remove_role/	Remove a role
RemotesContainerApi	add_role	POST {container_container_remote_href}add_role/	Add a role
RemotesContainerApi	create	POST /pulp/api/v3/remotes/container/container/	Create a container remote
RemotesContainerApi	delete	DELETE {container_container_remote_href}	Delete a container remote
RemotesContainerApi	list	GET /pulp/api/v3/remotes/container/container/	List container remotes
RemotesContainerApi	list_roles	GET {container_container_remote_href}list_roles/	List roles
RemotesContainerApi	my_permissions	GET {container_container_remote_href}my_permissions/	List user permissions
RemotesContainerApi	partial_update	PATCH {container_container_remote_href}	Update a container remote
RemotesContainerApi	read	GET {container_container_remote_href}	Inspect a container remote
RemotesContainerApi	remove_role	POST {container_container_remote_href}remove_role/	Remove a role
RemotesContainerApi	set_label	POST {container_container_remote_href}set_label/	Set a label
RemotesContainerApi	unset_label	POST {container_container_remote_href}unset_label/	Unset a label
RemotesContainerApi	update	PUT {container_container_remote_href}	Update a container remote
RemotesPullThroughApi	add_role	POST {container_container_pull_through_remote_href}add_role/	Add a role
RemotesPullThroughApi	create	POST /pulp/api/v3/remotes/container/pull-through/	Create a container pull through remote
RemotesPullThroughApi	delete	DELETE {container_container_pull_through_remote_href}	Delete a container pull through remote
RemotesPullThroughApi	list	GET /pulp/api/v3/remotes/container/pull-through/	List container pull through remotes
RemotesPullThroughApi	list_roles	GET {container_container_pull_through_remote_href}list_roles/	List roles
RemotesPullThroughApi	my_permissions	GET {container_container_pull_through_remote_href}my_permissions/	List user permissions
RemotesPullThroughApi	partial_update	PATCH {container_container_pull_through_remote_href}	Update a container pull through remote
RemotesPullThroughApi	read	GET {container_container_pull_through_remote_href}	Inspect a container pull through remote
RemotesPullThroughApi	remove_role	POST {container_container_pull_through_remote_href}remove_role/	Remove a role
RemotesPullThroughApi	set_label	POST {container_container_pull_through_remote_href}set_label/	Set a label
RemotesPullThroughApi	unset_label	POST {container_container_pull_through_remote_href}unset_label/	Unset a label
RemotesPullThroughApi	update	PUT {container_container_pull_through_remote_href}	Update a container pull through remote
RepositoriesContainerApi	add	POST {container_container_repository_href}add/	Add content
RepositoriesContainerApi	add_role	POST {container_container_repository_href}add_role/	Add a role
RepositoriesContainerApi	build_image	POST {container_container_repository_href}build_image/	Build an Image
RepositoriesContainerApi	copy_manifests	POST {container_container_repository_href}copy_manifests/	Copy manifests
RepositoriesContainerApi	copy_tags	POST {container_container_repository_href}copy_tags/	Copy tags
RepositoriesContainerApi	create	POST /pulp/api/v3/repositories/container/container/	Create a container repository
RepositoriesContainerApi	delete	DELETE {container_container_repository_href}	Delete a container repository
RepositoriesContainerApi	list	GET /pulp/api/v3/repositories/container/container/	List container repositorys
RepositoriesContainerApi	list_roles	GET {container_container_repository_href}list_roles/	List roles
RepositoriesContainerApi	my_permissions	GET {container_container_repository_href}my_permissions/	List user permissions
RepositoriesContainerApi	partial_update	PATCH {container_container_repository_href}	Update a container repository
RepositoriesContainerApi	read	GET {container_container_repository_href}	Inspect a container repository
RepositoriesContainerApi	remove	POST {container_container_repository_href}remove/	Remove content
RepositoriesContainerApi	remove_role	POST {container_container_repository_href}remove_role/	Remove a role
RepositoriesContainerApi	set_label	POST {container_container_repository_href}set_label/	Set a label
RepositoriesContainerApi	sign	POST {container_container_repository_href}sign/	Sign images in the repo
RepositoriesContainerApi	sync	POST {container_container_repository_href}sync/	Sync from a remote
RepositoriesContainerApi	tag	POST {container_container_repository_href}tag/	Create a Tag
RepositoriesContainerApi	unset_label	POST {container_container_repository_href}unset_label/	Unset a label
RepositoriesContainerApi	untag	POST {container_container_repository_href}untag/	Delete a tag
RepositoriesContainerApi	update	PUT {container_container_repository_href}	Update a container repository
RepositoriesContainerPushApi	add_role	POST {container_container_push_repository_href}add_role/	Add a role
RepositoriesContainerPushApi	list	GET /pulp/api/v3/repositories/container/container-push/	List container push repositorys
RepositoriesContainerPushApi	list_roles	GET {container_container_push_repository_href}list_roles/	List roles
RepositoriesContainerPushApi	my_permissions	GET {container_container_push_repository_href}my_permissions/	List user permissions
RepositoriesContainerPushApi	partial_update	PATCH {container_container_push_repository_href}	Update a container push repository
RepositoriesContainerPushApi	read	GET {container_container_push_repository_href}	Inspect a container push repository
RepositoriesContainerPushApi	remove_image	POST {container_container_push_repository_href}remove_image/	Delete an image from a repository
RepositoriesContainerPushApi	remove_role	POST {container_container_push_repository_href}remove_role/	Remove a role
RepositoriesContainerPushApi	remove_signatures	POST {container_container_push_repository_href}remove_signatures/
RepositoriesContainerPushApi	sign	POST {container_container_push_repository_href}sign/	Sign images in the repo
RepositoriesContainerPushApi	tag	POST {container_container_push_repository_href}tag/	Create a Tag
RepositoriesContainerPushApi	untag	POST {container_container_push_repository_href}untag/	Delete a tag
RepositoriesContainerPushApi	update	PUT {container_container_push_repository_href}	Update a container push repository
RepositoriesContainerPushVersionsApi	delete	DELETE {container_container_push_repository_version_href}	Delete a repository version
RepositoriesContainerPushVersionsApi	list	GET {container_container_push_repository_href}versions/	List repository versions
RepositoriesContainerPushVersionsApi	read	GET {container_container_push_repository_version_href}	Inspect a repository version
RepositoriesContainerPushVersionsApi	repair	POST {container_container_push_repository_version_href}repair/
RepositoriesContainerVersionsApi	delete	DELETE {container_container_repository_version_href}	Delete a repository version
RepositoriesContainerVersionsApi	list	GET {container_container_repository_href}versions/	List repository versions
RepositoriesContainerVersionsApi	read	GET {container_container_repository_version_href}	Inspect a repository version
RepositoriesContainerVersionsApi	repair	POST {container_container_repository_version_href}repair/
TokenApi	get	GET /token/

Documentation For Models

• AsyncOperationResponse
• ContainerBlobResponse
• ContainerContainerDistribution
• ContainerContainerDistributionResponse
• ContainerContainerNamespace
• ContainerContainerNamespaceResponse
• ContainerContainerPullThroughDistribution
• ContainerContainerPullThroughDistributionResponse
• ContainerContainerPullThroughRemote
• ContainerContainerPullThroughRemoteResponse
• ContainerContainerPullThroughRemoteResponseHiddenFieldsInner
• ContainerContainerPushRepository
• ContainerContainerPushRepositoryResponse
• ContainerContainerRemote
• ContainerContainerRemoteResponse
• ContainerContainerRepository
• ContainerContainerRepositoryResponse
• ContainerManifestResponse
• ContainerManifestSignatureResponse
• ContainerRepositorySyncURL
• ContainerTagResponse
• ContentSummaryResponse
• ManifestCopy
• MediaTypesEnum
• MyPermissionsResponse
• NestedRole
• NestedRoleResponse
• ObjectRolesResponse
• PaginatedRepositoryVersionResponseList
• PaginatedcontainerBlobResponseList
• PaginatedcontainerContainerDistributionResponseList
• PaginatedcontainerContainerNamespaceResponseList
• PaginatedcontainerContainerPullThroughDistributionResponseList
• PaginatedcontainerContainerPullThroughRemoteResponseList
• PaginatedcontainerContainerPushRepositoryResponseList
• PaginatedcontainerContainerRemoteResponseList
• PaginatedcontainerContainerRepositoryResponseList
• PaginatedcontainerManifestResponseList
• PaginatedcontainerManifestSignatureResponseList
• PaginatedcontainerTagResponseList
• PatchedcontainerContainerDistribution
• PatchedcontainerContainerPullThroughDistribution
• PatchedcontainerContainerPullThroughRemote
• PatchedcontainerContainerPushRepository
• PatchedcontainerContainerRemote
• PatchedcontainerContainerRepository
• Policy692Enum
• Policy7e0Enum
• RecursiveManage
• RemoveImage
• RemoveSignatures
• RemoveSignaturesResponse
• Repair
• RepositorySign
• RepositoryVersionResponse
• SetLabel
• SetLabelResponse
• TagCopy
• TagImage
• UnTagImage
• 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]