pulp-maven-client 0.17.0

Pulp 3 API

pulp_maven-client

Fetch, Upload, Organize, and Distribute Software Packages

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

• API version: v3
• Package version: 0.17.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_maven

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_maven

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import pulpcore.client.pulp_maven
from pulpcore.client.pulp_maven.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_maven.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_maven.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_maven.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_maven.ContentArtifactApi(api_client)
    relative_path = 'relative_path_example' # str | Path where the artifact is located relative to distributions base_path
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    repository = 'repository_example' # str | A URI of a repository the new content unit should be associated with. (optional)
    overwrite = True # bool | When set to true, existing content in the repository with the same unique key will be silently overwritten. When set to false, the task will fail if content would be overwritten. Only used when 'repository' is specified. Defaults to true. (optional)
    pulp_labels = None # Dict[str, Optional[str]] | A dictionary of arbitrary key/value pairs used to describe a specific Content instance. (optional)
    artifact = 'artifact_example' # str | Artifact file representing the physical content (optional)
    file = None # bytearray | An uploaded file that may be turned into the content unit. (optional)
    upload = 'upload_example' # str | An uncommitted upload that may be turned into the content unit. (optional)
    file_url = 'file_url_example' # str | A url that Pulp can download and turn into the content unit. (optional)
    downloader_config = pulpcore.client.pulp_maven.RemoteNetworkConfig() # RemoteNetworkConfig | Configuration for the download process (e.g., proxies, auth, timeouts). Only applicable when providing a 'file_url. (optional)

    try:
        # Create a maven artifact
        api_response = api_instance.create(relative_path, x_task_diagnostics=x_task_diagnostics, repository=repository, overwrite=overwrite, pulp_labels=pulp_labels, artifact=artifact, file=file, upload=upload, file_url=file_url, downloader_config=downloader_config)
        print("The response of ContentArtifactApi->create:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ContentArtifactApi->create: %s\n" % e)

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
ContentArtifactApi	create	POST /pulp/api/v3/content/maven/artifact/	Create a maven artifact
ContentArtifactApi	list	GET /pulp/api/v3/content/maven/artifact/	List maven artifacts
ContentArtifactApi	read	GET {maven_maven_artifact_href}	Inspect a maven artifact
ContentArtifactApi	set_label	POST {maven_maven_artifact_href}set_label/	Set a label
ContentArtifactApi	unset_label	POST {maven_maven_artifact_href}unset_label/	Unset a label
ContentArtifactApi	upload	POST /pulp/api/v3/content/maven/artifact/upload/	Upload a Maven artifact synchronously.
ContentMetadataApi	create	POST /pulp/api/v3/content/maven/metadata/	Create a maven metadata
ContentMetadataApi	list	GET /pulp/api/v3/content/maven/metadata/	List maven metadatas
ContentMetadataApi	read	GET {maven_maven_metadata_href}	Inspect a maven metadata
ContentMetadataApi	set_label	POST {maven_maven_metadata_href}set_label/	Set a label
ContentMetadataApi	unset_label	POST {maven_maven_metadata_href}unset_label/	Unset a label
ContentMetadataApi	upload	POST /pulp/api/v3/content/maven/metadata/upload/	Upload a Maven metadata file synchronously.
DistributionsMavenApi	create	POST /pulp/api/v3/distributions/maven/maven/	Create a maven distribution
DistributionsMavenApi	delete	DELETE {maven_maven_distribution_href}	Delete a maven distribution
DistributionsMavenApi	list	GET /pulp/api/v3/distributions/maven/maven/	List maven distributions
DistributionsMavenApi	partial_update	PATCH {maven_maven_distribution_href}	Update a maven distribution
DistributionsMavenApi	read	GET {maven_maven_distribution_href}	Inspect a maven distribution
DistributionsMavenApi	set_label	POST {maven_maven_distribution_href}set_label/	Set a label
DistributionsMavenApi	unset_label	POST {maven_maven_distribution_href}unset_label/	Unset a label
DistributionsMavenApi	update	PUT {maven_maven_distribution_href}	Update a maven distribution
PulpMavenApi	get	GET /pulp/maven/{name}/{path}
PulpMavenApi	put	PUT /pulp/maven/{name}/{path}
RemotesMavenApi	create	POST /pulp/api/v3/remotes/maven/maven/	Create a maven remote
RemotesMavenApi	delete	DELETE {maven_maven_remote_href}	Delete a maven remote
RemotesMavenApi	list	GET /pulp/api/v3/remotes/maven/maven/	List maven remotes
RemotesMavenApi	partial_update	PATCH {maven_maven_remote_href}	Update a maven remote
RemotesMavenApi	read	GET {maven_maven_remote_href}	Inspect a maven remote
RemotesMavenApi	set_label	POST {maven_maven_remote_href}set_label/	Set a label
RemotesMavenApi	unset_label	POST {maven_maven_remote_href}unset_label/	Unset a label
RemotesMavenApi	update	PUT {maven_maven_remote_href}	Update a maven remote
RepositoriesMavenApi	add_cached_content	POST {maven_maven_repository_href}add_cached_content/	Add cached content
RepositoriesMavenApi	create	POST /pulp/api/v3/repositories/maven/maven/	Create a maven repository
RepositoriesMavenApi	delete	DELETE {maven_maven_repository_href}	Delete a maven repository
RepositoriesMavenApi	list	GET /pulp/api/v3/repositories/maven/maven/	List maven repositorys
RepositoriesMavenApi	modify	POST {maven_maven_repository_href}modify/	Modify Repository Content
RepositoriesMavenApi	partial_update	PATCH {maven_maven_repository_href}	Update a maven repository
RepositoriesMavenApi	read	GET {maven_maven_repository_href}	Inspect a maven repository
RepositoriesMavenApi	set_label	POST {maven_maven_repository_href}set_label/	Set a label
RepositoriesMavenApi	unset_label	POST {maven_maven_repository_href}unset_label/	Unset a label
RepositoriesMavenApi	update	PUT {maven_maven_repository_href}	Update a maven repository
RepositoriesMavenVersionsApi	delete	DELETE {maven_maven_repository_version_href}	Delete a repository version
RepositoriesMavenVersionsApi	list	GET {maven_maven_repository_href}versions/	List repository versions
RepositoriesMavenVersionsApi	read	GET {maven_maven_repository_version_href}	Inspect a repository version
RepositoriesMavenVersionsApi	repair	POST {maven_maven_repository_version_href}repair/

Documentation For Models

• AsyncOperationResponse
• ContentSummaryResponse
• MavenMavenArtifactResponse
• MavenMavenDistribution
• MavenMavenDistributionResponse
• MavenMavenMetadataResponse
• MavenMavenRemote
• MavenMavenRemoteResponse
• MavenMavenRemoteResponseHiddenFieldsInner
• MavenMavenRepository
• MavenMavenRepositoryResponse
• PaginatedRepositoryVersionResponseList
• PaginatedmavenMavenArtifactResponseList
• PaginatedmavenMavenDistributionResponseList
• PaginatedmavenMavenMetadataResponseList
• PaginatedmavenMavenRemoteResponseList
• PaginatedmavenMavenRepositoryResponseList
• PatchedmavenMavenDistribution
• PatchedmavenMavenRemote
• PatchedmavenMavenRepository
• PolicyEnum
• RemoteNetworkConfig
• RemoteNetworkConfigResponse
• Repair
• RepositoryAddCachedContent
• RepositoryAddRemoveContent
• 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]