pulp-maven-client 0.12.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.12.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)
    maven_maven_artifact = pulpcore.client.pulp_maven.MavenMavenArtifact() # MavenMavenArtifact | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Create a maven artifact
        api_response = api_instance.create(maven_maven_artifact, x_task_diagnostics=x_task_diagnostics)
        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
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	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
• MavenMavenArtifact
• MavenMavenArtifactResponse
• MavenMavenDistribution
• MavenMavenDistributionResponse
• MavenMavenRemote
• MavenMavenRemoteResponse
• MavenMavenRemoteResponseHiddenFieldsInner
• MavenMavenRepository
• MavenMavenRepositoryResponse
• PaginatedRepositoryVersionResponseList
• PaginatedmavenMavenArtifactResponseList
• PaginatedmavenMavenDistributionResponseList
• PaginatedmavenMavenRemoteResponseList
• PaginatedmavenMavenRepositoryResponseList
• PatchedmavenMavenDistribution
• PatchedmavenMavenRemote
• PatchedmavenMavenRepository
• PolicyEnum
• Repair
• RepositoryAddCachedContent
• 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]