Skip to main content

Pulp 3 API

Project description

pulpcore.client.pulp_maven.ApiMavenApi

All URIs are relative to https://env-ephemeral-jasrkb.apps.crc-eph.r9lp.p1.openshiftapps.com

Method HTTP request Description
get GET /api/pulp/maven/{pulp_domain}/{name}/{path}
put PUT /api/pulp/maven/{pulp_domain}/{name}/{path}

get

get(name, path, pulp_domain, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

Responds to GET requests about manifests by reference

Example

  • OAuth Authentication (json_header_remote_authentication):
  • Basic Authentication (basicAuth):
  • Api Key Authentication (cookieAuth):
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 https://env-ephemeral-jasrkb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_maven.Configuration(
    host = "https://env-ephemeral-jasrkb.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.ApiMavenApi(api_client)
    name = 'name_example' # str | 
    path = 'path_example' # str | 
    pulp_domain = 'pulp_domain_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (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:
        api_instance.get(name, path, pulp_domain, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
    except Exception as e:
        print("Exception when calling ApiMavenApi->get: %s\n" % e)

Parameters

Name Type Description Notes
name str
path str
pulp_domain str
x_task_diagnostics List[str] List of profilers to use on tasks. [optional]
fields List[str] A list of fields to include in the response. [optional]
exclude_fields List[str] A list of fields to exclude from the response. [optional]

Return type

void (empty response body)

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

HTTP response details

Status code Description Response headers
200 No response body -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

put

put(name, path, pulp_domain, x_task_diagnostics=x_task_diagnostics)

ViewSet for interacting with maven deploy API

Example

  • OAuth Authentication (json_header_remote_authentication):
  • Basic Authentication (basicAuth):
  • Api Key Authentication (cookieAuth):
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 https://env-ephemeral-jasrkb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_maven.Configuration(
    host = "https://env-ephemeral-jasrkb.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.ApiMavenApi(api_client)
    name = 'name_example' # str | 
    path = 'path_example' # str | 
    pulp_domain = 'pulp_domain_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        api_instance.put(name, path, pulp_domain, x_task_diagnostics=x_task_diagnostics)
    except Exception as e:
        print("Exception when calling ApiMavenApi->put: %s\n" % e)

Parameters

Name Type Description Notes
name str
path str
pulp_domain str
x_task_diagnostics List[str] List of profilers to use on tasks. [optional]

Return type

void (empty response body)

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

HTTP response details

Status code Description Response headers
200 No response body -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AsyncOperationResponse

Serializer for asynchronous operations.

Properties

Name Type Description Notes
task str The href of the task.

Example

from pulpcore.client.pulp_maven.models.async_operation_response import AsyncOperationResponse

# TODO update the JSON string below
json = "{}"
# create an instance of AsyncOperationResponse from a JSON string
async_operation_response_instance = AsyncOperationResponse.from_json(json)
# print the JSON string representation of the object
print(AsyncOperationResponse.to_json())

# convert the object into a dict
async_operation_response_dict = async_operation_response_instance.to_dict()
# create an instance of AsyncOperationResponse from a dict
async_operation_response_from_dict = AsyncOperationResponse.from_dict(async_operation_response_dict)

[Back to Model list] [Back to API list] [Back to README]

pulpcore.client.pulp_maven.ContentArtifactApi

All URIs are relative to https://env-ephemeral-jasrkb.apps.crc-eph.r9lp.p1.openshiftapps.com

Method HTTP request Description
create POST /api/pulp/{pulp_domain}/api/v3/content/maven/artifact/ Create a maven artifact
list GET /api/pulp/{pulp_domain}/api/v3/content/maven/artifact/ List maven artifacts
read GET {maven_maven_artifact_href} Inspect a maven artifact
set_label POST {maven_maven_artifact_href}set_label/ Set a label
unset_label POST {maven_maven_artifact_href}unset_label/ Unset a label

create

MavenMavenArtifactResponse create(pulp_domain, maven_maven_artifact, x_task_diagnostics=x_task_diagnostics)

Create a maven artifact

A ViewSet for MavenArtifact.

Example

  • OAuth Authentication (json_header_remote_authentication):
  • Basic Authentication (basicAuth):
  • Api Key Authentication (cookieAuth):
import pulpcore.client.pulp_maven
from pulpcore.client.pulp_maven.models.maven_maven_artifact import MavenMavenArtifact
from pulpcore.client.pulp_maven.models.maven_maven_artifact_response import MavenMavenArtifactResponse
from pulpcore.client.pulp_maven.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-jasrkb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_maven.Configuration(
    host = "https://env-ephemeral-jasrkb.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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)
    pulp_domain = 'pulp_domain_example' # str | 
    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(pulp_domain, maven_maven_artifact, x_task_diagnostics=x_task_diagnostics)
        print("The response of ContentArtifactApi->create:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentArtifactApi->create: %s\n" % e)

Parameters

Name Type Description Notes
pulp_domain str
maven_maven_artifact MavenMavenArtifact
x_task_diagnostics List[str] List of profilers to use on tasks. [optional]

Return type

MavenMavenArtifactResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

  • Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
  • Accept: application/json

HTTP response details

Status code Description Response headers
201 -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list

PaginatedmavenMavenArtifactResponseList list(pulp_domain, x_task_diagnostics=x_task_diagnostics, artifact_id=artifact_id, filename=filename, group_id=group_id, 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, version=version, fields=fields, exclude_fields=exclude_fields)

List maven artifacts

A ViewSet for MavenArtifact.

Example

  • OAuth Authentication (json_header_remote_authentication):
  • Basic Authentication (basicAuth):
  • Api Key Authentication (cookieAuth):
import pulpcore.client.pulp_maven
from pulpcore.client.pulp_maven.models.paginatedmaven_maven_artifact_response_list import PaginatedmavenMavenArtifactResponseList
from pulpcore.client.pulp_maven.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-jasrkb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_maven.Configuration(
    host = "https://env-ephemeral-jasrkb.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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)
    pulp_domain = 'pulp_domain_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    artifact_id = 'artifact_id_example' # str | Filter results where artifact_id matches value (optional)
    filename = 'filename_example' # str | Filter results where filename matches value (optional)
    group_id = 'group_id_example' # str | Filter results where group_id 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) * `group_id` - Group id * `-group_id` - Group id (descending) * `artifact_id` - Artifact id * `-artifact_id` - Artifact id (descending) * `version` - Version * `-version` - Version (descending) * `filename` - Filename * `-filename` - Filename (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)
    version = 'version_example' # str | Filter results where version matches value (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 maven artifacts
        api_response = api_instance.list(pulp_domain, x_task_diagnostics=x_task_diagnostics, artifact_id=artifact_id, filename=filename, group_id=group_id, 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, version=version, fields=fields, exclude_fields=exclude_fields)
        print("The response of ContentArtifactApi->list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentArtifactApi->list: %s\n" % e)

Parameters

Name Type Description Notes
pulp_domain str
x_task_diagnostics List[str] List of profilers to use on tasks. [optional]
artifact_id str Filter results where artifact_id matches value [optional]
filename str Filter results where filename matches value [optional]
group_id str Filter results where group_id matches value [optional]
limit int Number of results to return per page. [optional]
offset int The initial index from which to return the results. [optional]
ordering 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) * `group_id` - Group id * `-group_id` - Group id (descending) * `artifact_id` - Artifact id * `-artifact_id` - Artifact id (descending) * `version` - Version * `-version` - Version (descending) * `filename` - Filename * `-filename` - Filename (descending) * `pk` - Pk * `-pk` - Pk (descending) [optional]
orphaned_for float Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME. [optional]
prn__in List[str] Multiple values may be separated by commas. [optional]
pulp_href__in List[str] Multiple values may be separated by commas. [optional]
pulp_id__in List[str] Multiple values may be separated by commas. [optional]
pulp_label_select str Filter labels by search string [optional]
q str Filter results by using NOT, AND and OR operations on other filters [optional]
repository_version str Repository Version referenced by HREF/PRN [optional]
repository_version_added str Repository Version referenced by HREF/PRN [optional]
repository_version_removed str Repository Version referenced by HREF/PRN [optional]
version str Filter results where version matches value [optional]
fields List[str] A list of fields to include in the response. [optional]
exclude_fields List[str] A list of fields to exclude from the response. [optional]

Return type

PaginatedmavenMavenArtifactResponseList

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

read

MavenMavenArtifactResponse read(maven_maven_artifact_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

Inspect a maven artifact

A ViewSet for MavenArtifact.

Example

  • OAuth Authentication (json_header_remote_authentication):
  • Basic Authentication (basicAuth):
  • Api Key Authentication (cookieAuth):
import pulpcore.client.pulp_maven
from pulpcore.client.pulp_maven.models.maven_maven_artifact_response import MavenMavenArtifactResponse
from pulpcore.client.pulp_maven.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-jasrkb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_maven.Configuration(
    host = "https://env-ephemeral-jasrkb.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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_href = 'maven_maven_artifact_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (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:
        # Inspect a maven artifact
        api_response = api_instance.read(maven_maven_artifact_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of ContentArtifactApi->read:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentArtifactApi->read: %s\n" % e)

Parameters

Name Type Description Notes
maven_maven_artifact_href str
x_task_diagnostics List[str] List of profilers to use on tasks. [optional]
fields List[str] A list of fields to include in the response. [optional]
exclude_fields List[str] A list of fields to exclude from the response. [optional]

Return type

MavenMavenArtifactResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

set_label

SetLabelResponse set_label(maven_maven_artifact_href, set_label, x_task_diagnostics=x_task_diagnostics)

Set a label

Set a single pulp_label on the object to a specific value or null.

Example

  • OAuth Authentication (json_header_remote_authentication):
  • Basic Authentication (basicAuth):
  • Api Key Authentication (cookieAuth):
import pulpcore.client.pulp_maven
from pulpcore.client.pulp_maven.models.set_label import SetLabel
from pulpcore.client.pulp_maven.models.set_label_response import SetLabelResponse
from pulpcore.client.pulp_maven.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-jasrkb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_maven.Configuration(
    host = "https://env-ephemeral-jasrkb.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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_href = 'maven_maven_artifact_href_example' # str | 
    set_label = pulpcore.client.pulp_maven.SetLabel() # SetLabel | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Set a label
        api_response = api_instance.set_label(maven_maven_artifact_href, set_label, x_task_diagnostics=x_task_diagnostics)
        print("The response of ContentArtifactApi->set_label:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentArtifactApi->set_label: %s\n" % e)

Parameters

Name Type Description Notes
maven_maven_artifact_href str
set_label SetLabel
x_task_diagnostics List[str] List of profilers to use on tasks. [optional]

Return type

SetLabelResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

  • Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
  • Accept: application/json

HTTP response details

Status code Description Response headers
201 -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

unset_label

UnsetLabelResponse unset_label(maven_maven_artifact_href, unset_label, x_task_diagnostics=x_task_diagnostics)

Unset a label

Unset a single pulp_label on the object.

Example

  • OAuth Authentication (json_header_remote_authentication):
  • Basic Authentication (basicAuth):
  • Api Key Authentication (cookieAuth):
import pulpcore.client.pulp_maven
from pulpcore.client.pulp_maven.models.unset_label import UnsetLabel
from pulpcore.client.pulp_maven.models.unset_label_response import UnsetLabelResponse
from pulpcore.client.pulp_maven.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-jasrkb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_maven.Configuration(
    host = "https://env-ephemeral-jasrkb.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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_href = 'maven_maven_artifact_href_example' # str | 
    unset_label = pulpcore.client.pulp_maven.UnsetLabel() # UnsetLabel | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Unset a label
        api_response = api_instance.unset_label(maven_maven_artifact_href, unset_label, x_task_diagnostics=x_task_diagnostics)
        print("The response of ContentArtifactApi->unset_label:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentArtifactApi->unset_label: %s\n" % e)

Parameters

Name Type Description Notes
maven_maven_artifact_href str
unset_label UnsetLabel
x_task_diagnostics List[str] List of profilers to use on tasks. [optional]

Return type

UnsetLabelResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

  • Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
  • Accept: application/json

HTTP response details

Status code Description Response headers
201 -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ContentSummaryResponse

Serializer for the RepositoryVersion content summary

Properties

Name Type Description Notes
added Dict[str, object]
removed Dict[str, object]
present Dict[str, object]

Example

from pulpcore.client.pulp_maven.models.content_summary_response import ContentSummaryResponse

# TODO update the JSON string below
json = "{}"
# create an instance of ContentSummaryResponse from a JSON string
content_summary_response_instance = ContentSummaryResponse.from_json(json)
# print the JSON string representation of the object
print(ContentSummaryResponse.to_json())

# convert the object into a dict
content_summary_response_dict = content_summary_response_instance.to_dict()
# create an instance of ContentSummaryResponse from a dict
content_summary_response_from_dict = ContentSummaryResponse.from_dict(content_summary_response_dict)

[Back to Model list] [Back to API list] [Back to README]

pulpcore.client.pulp_maven.DistributionsMavenApi

All URIs are relative to https://env-ephemeral-jasrkb.apps.crc-eph.r9lp.p1.openshiftapps.com

Method HTTP request Description
create POST /api/pulp/{pulp_domain}/api/v3/distributions/maven/maven/ Create a maven distribution
delete DELETE {maven_maven_distribution_href} Delete a maven distribution
list GET /api/pulp/{pulp_domain}/api/v3/distributions/maven/maven/ List maven distributions
partial_update PATCH {maven_maven_distribution_href} Update a maven distribution
read GET {maven_maven_distribution_href} Inspect a maven distribution
set_label POST {maven_maven_distribution_href}set_label/ Set a label
unset_label POST {maven_maven_distribution_href}unset_label/ Unset a label
update PUT {maven_maven_distribution_href} Update a maven distribution

create

AsyncOperationResponse create(pulp_domain, maven_maven_distribution, x_task_diagnostics=x_task_diagnostics)

Create a maven distribution

Trigger an asynchronous create task

Example

  • OAuth Authentication (json_header_remote_authentication):
  • Basic Authentication (basicAuth):
  • Api Key Authentication (cookieAuth):
import pulpcore.client.pulp_maven
from pulpcore.client.pulp_maven.models.async_operation_response import AsyncOperationResponse
from pulpcore.client.pulp_maven.models.maven_maven_distribution import MavenMavenDistribution
from pulpcore.client.pulp_maven.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-jasrkb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_maven.Configuration(
    host = "https://env-ephemeral-jasrkb.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.DistributionsMavenApi(api_client)
    pulp_domain = 'pulp_domain_example' # str | 
    maven_maven_distribution = pulpcore.client.pulp_maven.MavenMavenDistribution() # MavenMavenDistribution | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Create a maven distribution
        api_response = api_instance.create(pulp_domain, maven_maven_distribution, x_task_diagnostics=x_task_diagnostics)
        print("The response of DistributionsMavenApi->create:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DistributionsMavenApi->create: %s\n" % e)

Parameters

Name Type Description Notes
pulp_domain str
maven_maven_distribution MavenMavenDistribution
x_task_diagnostics List[str] List of profilers to use on tasks. [optional]

Return type

AsyncOperationResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

  • Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
  • Accept: application/json

HTTP response details

Status code Description Response headers
202 -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete

AsyncOperationResponse delete(maven_maven_distribution_href, x_task_diagnostics=x_task_diagnostics)

Delete a maven distribution

Trigger an asynchronous delete task

Example

  • OAuth Authentication (json_header_remote_authentication):
  • Basic Authentication (basicAuth):
  • Api Key Authentication (cookieAuth):
import pulpcore.client.pulp_maven
from pulpcore.client.pulp_maven.models.async_operation_response import AsyncOperationResponse
from pulpcore.client.pulp_maven.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-jasrkb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_maven.Configuration(
    host = "https://env-ephemeral-jasrkb.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.DistributionsMavenApi(api_client)
    maven_maven_distribution_href = 'maven_maven_distribution_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Delete a maven distribution
        api_response = api_instance.delete(maven_maven_distribution_href, x_task_diagnostics=x_task_diagnostics)
        print("The response of DistributionsMavenApi->delete:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DistributionsMavenApi->delete: %s\n" % e)

Parameters

Name Type Description Notes
maven_maven_distribution_href str
x_task_diagnostics List[str] List of profilers to use on tasks. [optional]

Return type

AsyncOperationResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
202 -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list

PaginatedmavenMavenDistributionResponseList list(pulp_domain, x_task_diagnostics=x_task_diagnostics, base_path=base_path, base_path__contains=base_path__contains, base_path__icontains=base_path__icontains, base_path__in=base_path__in, checkpoint=checkpoint, limit=limit, name=name, name__contains=name__contains, name__icontains=name__icontains, name__iexact=name__iexact, name__in=name__in, name__iregex=name__iregex, name__istartswith=name__istartswith, name__regex=name__regex, name__startswith=name__startswith, offset=offset, ordering=ordering, 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=repository, repository__in=repository__in, with_content=with_content, fields=fields, exclude_fields=exclude_fields)

List maven distributions

ViewSet for Maven Distributions.

Example

  • OAuth Authentication (json_header_remote_authentication):
  • Basic Authentication (basicAuth):
  • Api Key Authentication (cookieAuth):
import pulpcore.client.pulp_maven
from pulpcore.client.pulp_maven.models.paginatedmaven_maven_distribution_response_list import PaginatedmavenMavenDistributionResponseList
from pulpcore.client.pulp_maven.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-jasrkb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_maven.Configuration(
    host = "https://env-ephemeral-jasrkb.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.DistributionsMavenApi(api_client)
    pulp_domain = 'pulp_domain_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    base_path = 'base_path_example' # str | Filter results where base_path matches value (optional)
    base_path__contains = 'base_path__contains_example' # str | Filter results where base_path contains value (optional)
    base_path__icontains = 'base_path__icontains_example' # str | Filter results where base_path contains value (optional)
    base_path__in = ['base_path__in_example'] # List[str] | Filter results where base_path is in a comma-separated list of values (optional)
    checkpoint = True # bool | Filter results where checkpoint matches value (optional)
    limit = 56 # int | Number of results to return per page. (optional)
    name = 'name_example' # str | Filter results where name matches value (optional)
    name__contains = 'name__contains_example' # str | Filter results where name contains value (optional)
    name__icontains = 'name__icontains_example' # str | Filter results where name contains value (optional)
    name__iexact = 'name__iexact_example' # str | Filter results where name matches value (optional)
    name__in = ['name__in_example'] # List[str] | Filter results where name is in a comma-separated list of values (optional)
    name__iregex = 'name__iregex_example' # str | Filter results where name matches regex value (optional)
    name__istartswith = 'name__istartswith_example' # str | Filter results where name starts with value (optional)
    name__regex = 'name__regex_example' # str | Filter results where name matches regex value (optional)
    name__startswith = 'name__startswith_example' # str | Filter results where name starts with value (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) * `name` - Name * `-name` - Name (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `base_path` - Base path * `-base_path` - Base path (descending) * `hidden` - Hidden * `-hidden` - Hidden (descending) * `checkpoint` - Checkpoint * `-checkpoint` - Checkpoint (descending) * `pk` - Pk * `-pk` - Pk (descending) (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 = 'repository_example' # str | Filter results where repository matches value (optional)
    repository__in = ['repository__in_example'] # List[str] | Filter results where repository is in a comma-separated list of values (optional)
    with_content = 'with_content_example' # str | Filter distributions based on the content served by them (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 maven distributions
        api_response = api_instance.list(pulp_domain, x_task_diagnostics=x_task_diagnostics, base_path=base_path, base_path__contains=base_path__contains, base_path__icontains=base_path__icontains, base_path__in=base_path__in, checkpoint=checkpoint, limit=limit, name=name, name__contains=name__contains, name__icontains=name__icontains, name__iexact=name__iexact, name__in=name__in, name__iregex=name__iregex, name__istartswith=name__istartswith, name__regex=name__regex, name__startswith=name__startswith, offset=offset, ordering=ordering, 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=repository, repository__in=repository__in, with_content=with_content, fields=fields, exclude_fields=exclude_fields)
        print("The response of DistributionsMavenApi->list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DistributionsMavenApi->list: %s\n" % e)

Parameters

Name Type Description Notes
pulp_domain str
x_task_diagnostics List[str] List of profilers to use on tasks. [optional]
base_path str Filter results where base_path matches value [optional]
base_path__contains str Filter results where base_path contains value [optional]
base_path__icontains str Filter results where base_path contains value [optional]
base_path__in List[str] Filter results where base_path is in a comma-separated list of values [optional]
checkpoint bool Filter results where checkpoint matches value [optional]
limit int Number of results to return per page. [optional]
name str Filter results where name matches value [optional]
name__contains str Filter results where name contains value [optional]
name__icontains str Filter results where name contains value [optional]
name__iexact str Filter results where name matches value [optional]
name__in List[str] Filter results where name is in a comma-separated list of values [optional]
name__iregex str Filter results where name matches regex value [optional]
name__istartswith str Filter results where name starts with value [optional]
name__regex str Filter results where name matches regex value [optional]
name__startswith str Filter results where name starts with value [optional]
offset int The initial index from which to return the results. [optional]
ordering 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) * `name` - Name * `-name` - Name (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `base_path` - Base path * `-base_path` - Base path (descending) * `hidden` - Hidden * `-hidden` - Hidden (descending) * `checkpoint` - Checkpoint * `-checkpoint` - Checkpoint (descending) * `pk` - Pk * `-pk` - Pk (descending) [optional]
prn__in List[str] Multiple values may be separated by commas. [optional]
pulp_href__in List[str] Multiple values may be separated by commas. [optional]
pulp_id__in List[str] Multiple values may be separated by commas. [optional]
pulp_label_select str Filter labels by search string [optional]
q str Filter results by using NOT, AND and OR operations on other filters [optional]
repository str Filter results where repository matches value [optional]
repository__in List[str] Filter results where repository is in a comma-separated list of values [optional]
with_content str Filter distributions based on the content served by them [optional]
fields List[str] A list of fields to include in the response. [optional]
exclude_fields List[str] A list of fields to exclude from the response. [optional]

Return type

PaginatedmavenMavenDistributionResponseList

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

partial_update

MavenMavenDistributionResponse partial_update(maven_maven_distribution_href, patchedmaven_maven_distribution, x_task_diagnostics=x_task_diagnostics)

Update a maven distribution

Update the entity partially and trigger an asynchronous task if necessary

Example

  • OAuth Authentication (json_header_remote_authentication):
  • Basic Authentication (basicAuth):
  • Api Key Authentication (cookieAuth):
import pulpcore.client.pulp_maven
from pulpcore.client.pulp_maven.models.maven_maven_distribution_response import MavenMavenDistributionResponse
from pulpcore.client.pulp_maven.models.patchedmaven_maven_distribution import PatchedmavenMavenDistribution
from pulpcore.client.pulp_maven.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-jasrkb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_maven.Configuration(
    host = "https://env-ephemeral-jasrkb.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.DistributionsMavenApi(api_client)
    maven_maven_distribution_href = 'maven_maven_distribution_href_example' # str | 
    patchedmaven_maven_distribution = pulpcore.client.pulp_maven.PatchedmavenMavenDistribution() # PatchedmavenMavenDistribution | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Update a maven distribution
        api_response = api_instance.partial_update(maven_maven_distribution_href, patchedmaven_maven_distribution, x_task_diagnostics=x_task_diagnostics)
        print("The response of DistributionsMavenApi->partial_update:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DistributionsMavenApi->partial_update: %s\n" % e)

Parameters

Name Type Description Notes
maven_maven_distribution_href str
patchedmaven_maven_distribution PatchedmavenMavenDistribution
x_task_diagnostics List[str] List of profilers to use on tasks. [optional]

Return type

MavenMavenDistributionResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

  • Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 -
202 -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

read

MavenMavenDistributionResponse read(maven_maven_distribution_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

Inspect a maven distribution

ViewSet for Maven Distributions.

Example

  • OAuth Authentication (json_header_remote_authentication):
  • Basic Authentication (basicAuth):
  • Api Key Authentication (cookieAuth):
import pulpcore.client.pulp_maven
from pulpcore.client.pulp_maven.models.maven_maven_distribution_response import MavenMavenDistributionResponse
from pulpcore.client.pulp_maven.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-jasrkb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_maven.Configuration(
    host = "https://env-ephemeral-jasrkb.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.DistributionsMavenApi(api_client)
    maven_maven_distribution_href = 'maven_maven_distribution_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (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:
        # Inspect a maven distribution
        api_response = api_instance.read(maven_maven_distribution_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of DistributionsMavenApi->read:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DistributionsMavenApi->read: %s\n" % e)

Parameters

Name Type Description Notes
maven_maven_distribution_href str
x_task_diagnostics List[str] List of profilers to use on tasks. [optional]
fields List[str] A list of fields to include in the response. [optional]
exclude_fields List[str] A list of fields to exclude from the response. [optional]

Return type

MavenMavenDistributionResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

set_label

SetLabelResponse set_label(maven_maven_distribution_href, set_label, x_task_diagnostics=x_task_diagnostics)

Set a label

Set a single pulp_label on the object to a specific value or null.

Example

  • OAuth Authentication (json_header_remote_authentication):
  • Basic Authentication (basicAuth):
  • Api Key Authentication (cookieAuth):
import pulpcore.client.pulp_maven
from pulpcore.client.pulp_maven.models.set_label import SetLabel
from pulpcore.client.pulp_maven.models.set_label_response import SetLabelResponse
from pulpcore.client.pulp_maven.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-jasrkb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_maven.Configuration(
    host = "https://env-ephemeral-jasrkb.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.DistributionsMavenApi(api_client)
    maven_maven_distribution_href = 'maven_maven_distribution_href_example' # str | 
    set_label = pulpcore.client.pulp_maven.SetLabel() # SetLabel | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Set a label
        api_response = api_instance.set_label(maven_maven_distribution_href, set_label, x_task_diagnostics=x_task_diagnostics)
        print("The response of DistributionsMavenApi->set_label:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DistributionsMavenApi->set_label: %s\n" % e)

Parameters

Name Type Description Notes
maven_maven_distribution_href str
set_label SetLabel
x_task_diagnostics List[str] List of profilers to use on tasks. [optional]

Return type

SetLabelResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

  • Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

unset_label

UnsetLabelResponse unset_label(maven_maven_distribution_href, unset_label, x_task_diagnostics=x_task_diagnostics)

Unset a label

Unset a single pulp_label on the object.

Example

  • OAuth Authentication (json_header_remote_authentication):
  • Basic Authentication (basicAuth):
  • Api Key Authentication (cookieAuth):
import pulpcore.client.pulp_maven
from pulpcore.client.pulp_maven.models.unset_label import UnsetLabel
from pulpcore.client.pulp_maven.models.unset_label_response import UnsetLabelResponse
from pulpcore.client.pulp_maven.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-jasrkb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_maven.Configuration(
    host = "https://env-ephemeral-jasrkb.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.DistributionsMavenApi(api_client)
    maven_maven_distribution_href = 'maven_maven_distribution_href_example' # str | 
    unset_label = pulpcore.client.pulp_maven.UnsetLabel() # UnsetLabel | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Unset a label
        api_response = api_instance.unset_label(maven_maven_distribution_href, unset_label, x_task_diagnostics=x_task_diagnostics)
        print("The response of DistributionsMavenApi->unset_label:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DistributionsMavenApi->unset_label: %s\n" % e)

Parameters

Name Type Description Notes
maven_maven_distribution_href str
unset_label UnsetLabel
x_task_diagnostics List[str] List of profilers to use on tasks. [optional]

Return type

UnsetLabelResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

  • Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update

MavenMavenDistributionResponse update(maven_maven_distribution_href, maven_maven_distribution, x_task_diagnostics=x_task_diagnostics)

Update a maven distribution

Update the entity and trigger an asynchronous task if necessary

Example

  • OAuth Authentication (json_header_remote_authentication):
  • Basic Authentication (basicAuth):
  • Api Key Authentication (cookieAuth):
import pulpcore.client.pulp_maven
from pulpcore.client.pulp_maven.models.maven_maven_distribution import MavenMavenDistribution
from pulpcore.client.pulp_maven.models.maven_maven_distribution_response import MavenMavenDistributionResponse
from pulpcore.client.pulp_maven.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-jasrkb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_maven.Configuration(
    host = "https://env-ephemeral-jasrkb.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.DistributionsMavenApi(api_client)
    maven_maven_distribution_href = 'maven_maven_distribution_href_example' # str | 
    maven_maven_distribution = pulpcore.client.pulp_maven.MavenMavenDistribution() # MavenMavenDistribution | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Update a maven distribution
        api_response = api_instance.update(maven_maven_distribution_href, maven_maven_distribution, x_task_diagnostics=x_task_diagnostics)
        print("The response of DistributionsMavenApi->update:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DistributionsMavenApi->update: %s\n" % e)

Parameters

Name Type Description Notes
maven_maven_distribution_href str
maven_maven_distribution MavenMavenDistribution
x_task_diagnostics List[str] List of profilers to use on tasks. [optional]

Return type

MavenMavenDistributionResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

  • Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 -
202 -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

MavenMavenArtifact

A Serializer for MavenArtifact.

Properties

Name Type Description Notes
repository str A URI of a repository the new content unit should be associated with. [optional]
pulp_labels Dict[str, Optional[str]] A dictionary of arbitrary key/value pairs used to describe a specific Content instance. [optional]
artifact str Artifact file representing the physical content
relative_path str Path where the artifact is located relative to distributions base_path

Example

from pulpcore.client.pulp_maven.models.maven_maven_artifact import MavenMavenArtifact

# TODO update the JSON string below
json = "{}"
# create an instance of MavenMavenArtifact from a JSON string
maven_maven_artifact_instance = MavenMavenArtifact.from_json(json)
# print the JSON string representation of the object
print(MavenMavenArtifact.to_json())

# convert the object into a dict
maven_maven_artifact_dict = maven_maven_artifact_instance.to_dict()
# create an instance of MavenMavenArtifact from a dict
maven_maven_artifact_from_dict = MavenMavenArtifact.from_dict(maven_maven_artifact_dict)

[Back to Model list] [Back to API list] [Back to README]

MavenMavenArtifactResponse

A Serializer for MavenArtifact.

Properties

Name Type Description Notes
pulp_href str [optional] [readonly]
prn str The Pulp Resource Name (PRN). [optional] [readonly]
pulp_created datetime Timestamp of creation. [optional] [readonly]
pulp_last_updated datetime Timestamp of the last time this resource was updated. Note: for immutable resources - like content, repository versions, and publication - pulp_created and pulp_last_updated dates will be the same. [optional] [readonly]
pulp_labels Dict[str, Optional[str]] A dictionary of arbitrary key/value pairs used to describe a specific Content instance. [optional]
vuln_report str [optional] [readonly]
artifact str Artifact file representing the physical content
group_id str Group Id of the artifact's package. [optional] [readonly]
artifact_id str Artifact Id of the artifact's package. [optional] [readonly]
version str Version of the artifact's package. [optional] [readonly]
filename str Filename of the artifact. [optional] [readonly]

Example

from pulpcore.client.pulp_maven.models.maven_maven_artifact_response import MavenMavenArtifactResponse

# TODO update the JSON string below
json = "{}"
# create an instance of MavenMavenArtifactResponse from a JSON string
maven_maven_artifact_response_instance = MavenMavenArtifactResponse.from_json(json)
# print the JSON string representation of the object
print(MavenMavenArtifactResponse.to_json())

# convert the object into a dict
maven_maven_artifact_response_dict = maven_maven_artifact_response_instance.to_dict()
# create an instance of MavenMavenArtifactResponse from a dict
maven_maven_artifact_response_from_dict = MavenMavenArtifactResponse.from_dict(maven_maven_artifact_response_dict)

[Back to Model list] [Back to API list] [Back to README]

MavenMavenDistribution

Serializer for Maven Distributions.

Properties

Name Type Description Notes
base_path str The base (relative) path component of the published url. Avoid paths that overlap with other distribution base paths (e.g. "foo" and "foo/bar")
content_guard str An optional content-guard. [optional]
hidden bool Whether this distribution should be shown in the content app. [optional] [default to False]
pulp_labels Dict[str, Optional[str]] [optional]
name str A unique name. Ex, `rawhide` and `stable`.
repository str The latest RepositoryVersion for this Repository will be served. [optional]
remote str Remote that can be used to fetch content when using pull-through caching. [optional]

Example

from pulpcore.client.pulp_maven.models.maven_maven_distribution import MavenMavenDistribution

# TODO update the JSON string below
json = "{}"
# create an instance of MavenMavenDistribution from a JSON string
maven_maven_distribution_instance = MavenMavenDistribution.from_json(json)
# print the JSON string representation of the object
print(MavenMavenDistribution.to_json())

# convert the object into a dict
maven_maven_distribution_dict = maven_maven_distribution_instance.to_dict()
# create an instance of MavenMavenDistribution from a dict
maven_maven_distribution_from_dict = MavenMavenDistribution.from_dict(maven_maven_distribution_dict)

[Back to Model list] [Back to API list] [Back to README]

MavenMavenDistributionResponse

Serializer for Maven Distributions.

Properties

Name Type Description Notes
pulp_href str [optional] [readonly]
prn str The Pulp Resource Name (PRN). [optional] [readonly]
pulp_created datetime Timestamp of creation. [optional] [readonly]
pulp_last_updated datetime Timestamp of the last time this resource was updated. Note: for immutable resources - like content, repository versions, and publication - pulp_created and pulp_last_updated dates will be the same. [optional] [readonly]
base_path str The base (relative) path component of the published url. Avoid paths that overlap with other distribution base paths (e.g. "foo" and "foo/bar")
base_url str The URL for accessing the publication as defined by this distribution. [optional] [readonly]
content_guard str An optional content-guard. [optional]
no_content_change_since str Timestamp since when the distributed content served by this distribution has not changed. If equals to `null`, no guarantee is provided about content changes. [optional] [readonly]
hidden bool Whether this distribution should be shown in the content app. [optional] [default to False]
pulp_labels Dict[str, Optional[str]] [optional]
name str A unique name. Ex, `rawhide` and `stable`.
repository str The latest RepositoryVersion for this Repository will be served. [optional]
remote str Remote that can be used to fetch content when using pull-through caching. [optional]

Example

from pulpcore.client.pulp_maven.models.maven_maven_distribution_response import MavenMavenDistributionResponse

# TODO update the JSON string below
json = "{}"
# create an instance of MavenMavenDistributionResponse from a JSON string
maven_maven_distribution_response_instance = MavenMavenDistributionResponse.from_json(json)
# print the JSON string representation of the object
print(MavenMavenDistributionResponse.to_json())

# convert the object into a dict
maven_maven_distribution_response_dict = maven_maven_distribution_response_instance.to_dict()
# create an instance of MavenMavenDistributionResponse from a dict
maven_maven_distribution_response_from_dict = MavenMavenDistributionResponse.from_dict(maven_maven_distribution_response_dict)

[Back to Model list] [Back to API list] [Back to README]

MavenMavenRemote

A Serializer for MavenRemote. Add any new fields if defined on MavenRemote. Similar to the example above, in MavenArtifactSerializer. Additional validators can be added to the parent validators list For example:: class Meta: validators = platform.RemoteSerializer.Meta.validators + [myValidator1, myValidator2]

Properties

Name Type Description Notes
name str A unique name for this remote.
url str The URL of an external content source.
ca_cert str A PEM encoded CA certificate used to validate the server certificate presented by the remote server. [optional]
client_cert str A PEM encoded client certificate used for authentication. [optional]
client_key str A PEM encoded private key used for authentication. [optional]
tls_validation bool If True, TLS peer validation must be performed. [optional]
proxy_url str The proxy URL. Format: scheme://host:port [optional]
proxy_username str The username to authenticte to the proxy. [optional]
proxy_password str The password to authenticate to the proxy. Extra leading and trailing whitespace characters are not trimmed. [optional]
username str The username to be used for authentication when syncing. [optional]
password str The password to be used for authentication when syncing. Extra leading and trailing whitespace characters are not trimmed. [optional]
pulp_labels Dict[str, Optional[str]] [optional]
download_concurrency int Total number of simultaneous connections. If not set then the default value will be used. [optional]
max_retries int Maximum number of retry attempts after a download failure. If not set then the default value (3) will be used. [optional]
policy PolicyEnum The policy to use when downloading content. * `immediate` - When syncing, download all metadata and content now. [optional]
total_timeout float aiohttp.ClientTimeout.total (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. [optional]
connect_timeout float aiohttp.ClientTimeout.connect (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. [optional]
sock_connect_timeout float aiohttp.ClientTimeout.sock_connect (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. [optional]
sock_read_timeout float aiohttp.ClientTimeout.sock_read (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. [optional]
headers List[object] Headers for aiohttp.Clientsession [optional]
rate_limit int Limits requests per second for each concurrent downloader [optional]

Example

from pulpcore.client.pulp_maven.models.maven_maven_remote import MavenMavenRemote

# TODO update the JSON string below
json = "{}"
# create an instance of MavenMavenRemote from a JSON string
maven_maven_remote_instance = MavenMavenRemote.from_json(json)
# print the JSON string representation of the object
print(MavenMavenRemote.to_json())

# convert the object into a dict
maven_maven_remote_dict = maven_maven_remote_instance.to_dict()
# create an instance of MavenMavenRemote from a dict
maven_maven_remote_from_dict = MavenMavenRemote.from_dict(maven_maven_remote_dict)

[Back to Model list] [Back to API list] [Back to README]

MavenMavenRemoteResponseHiddenFieldsInner

Properties

Name Type Description Notes
name str
is_set bool

Example

from pulpcore.client.pulp_maven.models.maven_maven_remote_response_hidden_fields_inner import MavenMavenRemoteResponseHiddenFieldsInner

# TODO update the JSON string below
json = "{}"
# create an instance of MavenMavenRemoteResponseHiddenFieldsInner from a JSON string
maven_maven_remote_response_hidden_fields_inner_instance = MavenMavenRemoteResponseHiddenFieldsInner.from_json(json)
# print the JSON string representation of the object
print(MavenMavenRemoteResponseHiddenFieldsInner.to_json())

# convert the object into a dict
maven_maven_remote_response_hidden_fields_inner_dict = maven_maven_remote_response_hidden_fields_inner_instance.to_dict()
# create an instance of MavenMavenRemoteResponseHiddenFieldsInner from a dict
maven_maven_remote_response_hidden_fields_inner_from_dict = MavenMavenRemoteResponseHiddenFieldsInner.from_dict(maven_maven_remote_response_hidden_fields_inner_dict)

[Back to Model list] [Back to API list] [Back to README]

MavenMavenRemoteResponse

A Serializer for MavenRemote. Add any new fields if defined on MavenRemote. Similar to the example above, in MavenArtifactSerializer. Additional validators can be added to the parent validators list For example:: class Meta: validators = platform.RemoteSerializer.Meta.validators + [myValidator1, myValidator2]

Properties

Name Type Description Notes
pulp_href str [optional] [readonly]
prn str The Pulp Resource Name (PRN). [optional] [readonly]
pulp_created datetime Timestamp of creation. [optional] [readonly]
pulp_last_updated datetime Timestamp of the most recent update of the remote. [optional] [readonly]
name str A unique name for this remote.
url str The URL of an external content source.
ca_cert str A PEM encoded CA certificate used to validate the server certificate presented by the remote server. [optional]
client_cert str A PEM encoded client certificate used for authentication. [optional]
tls_validation bool If True, TLS peer validation must be performed. [optional]
proxy_url str The proxy URL. Format: scheme://host:port [optional]
pulp_labels Dict[str, Optional[str]] [optional]
download_concurrency int Total number of simultaneous connections. If not set then the default value will be used. [optional]
max_retries int Maximum number of retry attempts after a download failure. If not set then the default value (3) will be used. [optional]
policy PolicyEnum The policy to use when downloading content. * `immediate` - When syncing, download all metadata and content now. [optional]
total_timeout float aiohttp.ClientTimeout.total (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. [optional]
connect_timeout float aiohttp.ClientTimeout.connect (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. [optional]
sock_connect_timeout float aiohttp.ClientTimeout.sock_connect (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. [optional]
sock_read_timeout float aiohttp.ClientTimeout.sock_read (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. [optional]
headers List[object] Headers for aiohttp.Clientsession [optional]
rate_limit int Limits requests per second for each concurrent downloader [optional]
hidden_fields List[MavenMavenRemoteResponseHiddenFieldsInner] List of hidden (write only) fields [optional] [readonly]

Example

from pulpcore.client.pulp_maven.models.maven_maven_remote_response import MavenMavenRemoteResponse

# TODO update the JSON string below
json = "{}"
# create an instance of MavenMavenRemoteResponse from a JSON string
maven_maven_remote_response_instance = MavenMavenRemoteResponse.from_json(json)
# print the JSON string representation of the object
print(MavenMavenRemoteResponse.to_json())

# convert the object into a dict
maven_maven_remote_response_dict = maven_maven_remote_response_instance.to_dict()
# create an instance of MavenMavenRemoteResponse from a dict
maven_maven_remote_response_from_dict = MavenMavenRemoteResponse.from_dict(maven_maven_remote_response_dict)

[Back to Model list] [Back to API list] [Back to README]

MavenMavenRepository

Serializer for Maven Repositories.

Properties

Name Type Description Notes
pulp_labels Dict[str, Optional[str]] [optional]
name str A unique name for this repository.
description str An optional description. [optional]
retain_repo_versions int Retain X versions of the repository. Default is null which retains all versions. [optional]
remote str An optional remote to use by default when syncing. [optional]

Example

from pulpcore.client.pulp_maven.models.maven_maven_repository import MavenMavenRepository

# TODO update the JSON string below
json = "{}"
# create an instance of MavenMavenRepository from a JSON string
maven_maven_repository_instance = MavenMavenRepository.from_json(json)
# print the JSON string representation of the object
print(MavenMavenRepository.to_json())

# convert the object into a dict
maven_maven_repository_dict = maven_maven_repository_instance.to_dict()
# create an instance of MavenMavenRepository from a dict
maven_maven_repository_from_dict = MavenMavenRepository.from_dict(maven_maven_repository_dict)

[Back to Model list] [Back to API list] [Back to README]

MavenMavenRepositoryResponse

Serializer for Maven Repositories.

Properties

Name Type Description Notes
pulp_href str [optional] [readonly]
prn str The Pulp Resource Name (PRN). [optional] [readonly]
pulp_created datetime Timestamp of creation. [optional] [readonly]
pulp_last_updated datetime Timestamp of the last time this resource was updated. Note: for immutable resources - like content, repository versions, and publication - pulp_created and pulp_last_updated dates will be the same. [optional] [readonly]
versions_href str [optional] [readonly]
pulp_labels Dict[str, Optional[str]] [optional]
latest_version_href str [optional] [readonly]
name str A unique name for this repository.
description str An optional description. [optional]
retain_repo_versions int Retain X versions of the repository. Default is null which retains all versions. [optional]
remote str An optional remote to use by default when syncing. [optional]

Example

from pulpcore.client.pulp_maven.models.maven_maven_repository_response import MavenMavenRepositoryResponse

# TODO update the JSON string below
json = "{}"
# create an instance of MavenMavenRepositoryResponse from a JSON string
maven_maven_repository_response_instance = MavenMavenRepositoryResponse.from_json(json)
# print the JSON string representation of the object
print(MavenMavenRepositoryResponse.to_json())

# convert the object into a dict
maven_maven_repository_response_dict = maven_maven_repository_response_instance.to_dict()
# create an instance of MavenMavenRepositoryResponse from a dict
maven_maven_repository_response_from_dict = MavenMavenRepositoryResponse.from_dict(maven_maven_repository_response_dict)

[Back to Model list] [Back to API list] [Back to README]

PaginatedmavenMavenArtifactResponseList

Properties

Name Type Description Notes
count int
next str [optional]
previous str [optional]
results List[MavenMavenArtifactResponse]

Example

from pulpcore.client.pulp_maven.models.paginatedmaven_maven_artifact_response_list import PaginatedmavenMavenArtifactResponseList

# TODO update the JSON string below
json = "{}"
# create an instance of PaginatedmavenMavenArtifactResponseList from a JSON string
paginatedmaven_maven_artifact_response_list_instance = PaginatedmavenMavenArtifactResponseList.from_json(json)
# print the JSON string representation of the object
print(PaginatedmavenMavenArtifactResponseList.to_json())

# convert the object into a dict
paginatedmaven_maven_artifact_response_list_dict = paginatedmaven_maven_artifact_response_list_instance.to_dict()
# create an instance of PaginatedmavenMavenArtifactResponseList from a dict
paginatedmaven_maven_artifact_response_list_from_dict = PaginatedmavenMavenArtifactResponseList.from_dict(paginatedmaven_maven_artifact_response_list_dict)

[Back to Model list] [Back to API list] [Back to README]

PaginatedmavenMavenDistributionResponseList

Properties

Name Type Description Notes
count int
next str [optional]
previous str [optional]
results List[MavenMavenDistributionResponse]

Example

from pulpcore.client.pulp_maven.models.paginatedmaven_maven_distribution_response_list import PaginatedmavenMavenDistributionResponseList

# TODO update the JSON string below
json = "{}"
# create an instance of PaginatedmavenMavenDistributionResponseList from a JSON string
paginatedmaven_maven_distribution_response_list_instance = PaginatedmavenMavenDistributionResponseList.from_json(json)
# print the JSON string representation of the object
print(PaginatedmavenMavenDistributionResponseList.to_json())

# convert the object into a dict
paginatedmaven_maven_distribution_response_list_dict = paginatedmaven_maven_distribution_response_list_instance.to_dict()
# create an instance of PaginatedmavenMavenDistributionResponseList from a dict
paginatedmaven_maven_distribution_response_list_from_dict = PaginatedmavenMavenDistributionResponseList.from_dict(paginatedmaven_maven_distribution_response_list_dict)

[Back to Model list] [Back to API list] [Back to README]

PaginatedmavenMavenRemoteResponseList

Properties

Name Type Description Notes
count int
next str [optional]
previous str [optional]
results List[MavenMavenRemoteResponse]

Example

from pulpcore.client.pulp_maven.models.paginatedmaven_maven_remote_response_list import PaginatedmavenMavenRemoteResponseList

# TODO update the JSON string below
json = "{}"
# create an instance of PaginatedmavenMavenRemoteResponseList from a JSON string
paginatedmaven_maven_remote_response_list_instance = PaginatedmavenMavenRemoteResponseList.from_json(json)
# print the JSON string representation of the object
print(PaginatedmavenMavenRemoteResponseList.to_json())

# convert the object into a dict
paginatedmaven_maven_remote_response_list_dict = paginatedmaven_maven_remote_response_list_instance.to_dict()
# create an instance of PaginatedmavenMavenRemoteResponseList from a dict
paginatedmaven_maven_remote_response_list_from_dict = PaginatedmavenMavenRemoteResponseList.from_dict(paginatedmaven_maven_remote_response_list_dict)

[Back to Model list] [Back to API list] [Back to README]

PaginatedmavenMavenRepositoryResponseList

Properties

Name Type Description Notes
count int
next str [optional]
previous str [optional]
results List[MavenMavenRepositoryResponse]

Example

from pulpcore.client.pulp_maven.models.paginatedmaven_maven_repository_response_list import PaginatedmavenMavenRepositoryResponseList

# TODO update the JSON string below
json = "{}"
# create an instance of PaginatedmavenMavenRepositoryResponseList from a JSON string
paginatedmaven_maven_repository_response_list_instance = PaginatedmavenMavenRepositoryResponseList.from_json(json)
# print the JSON string representation of the object
print(PaginatedmavenMavenRepositoryResponseList.to_json())

# convert the object into a dict
paginatedmaven_maven_repository_response_list_dict = paginatedmaven_maven_repository_response_list_instance.to_dict()
# create an instance of PaginatedmavenMavenRepositoryResponseList from a dict
paginatedmaven_maven_repository_response_list_from_dict = PaginatedmavenMavenRepositoryResponseList.from_dict(paginatedmaven_maven_repository_response_list_dict)

[Back to Model list] [Back to API list] [Back to README]

PaginatedRepositoryVersionResponseList

Properties

Name Type Description Notes
count int
next str [optional]
previous str [optional]
results List[RepositoryVersionResponse]

Example

from pulpcore.client.pulp_maven.models.paginated_repository_version_response_list import PaginatedRepositoryVersionResponseList

# TODO update the JSON string below
json = "{}"
# create an instance of PaginatedRepositoryVersionResponseList from a JSON string
paginated_repository_version_response_list_instance = PaginatedRepositoryVersionResponseList.from_json(json)
# print the JSON string representation of the object
print(PaginatedRepositoryVersionResponseList.to_json())

# convert the object into a dict
paginated_repository_version_response_list_dict = paginated_repository_version_response_list_instance.to_dict()
# create an instance of PaginatedRepositoryVersionResponseList from a dict
paginated_repository_version_response_list_from_dict = PaginatedRepositoryVersionResponseList.from_dict(paginated_repository_version_response_list_dict)

[Back to Model list] [Back to API list] [Back to README]

PatchedmavenMavenDistribution

Serializer for Maven Distributions.

Properties

Name Type Description Notes
base_path str The base (relative) path component of the published url. Avoid paths that overlap with other distribution base paths (e.g. "foo" and "foo/bar") [optional]
content_guard str An optional content-guard. [optional]
hidden bool Whether this distribution should be shown in the content app. [optional] [default to False]
pulp_labels Dict[str, Optional[str]] [optional]
name str A unique name. Ex, `rawhide` and `stable`. [optional]
repository str The latest RepositoryVersion for this Repository will be served. [optional]
remote str Remote that can be used to fetch content when using pull-through caching. [optional]

Example

from pulpcore.client.pulp_maven.models.patchedmaven_maven_distribution import PatchedmavenMavenDistribution

# TODO update the JSON string below
json = "{}"
# create an instance of PatchedmavenMavenDistribution from a JSON string
patchedmaven_maven_distribution_instance = PatchedmavenMavenDistribution.from_json(json)
# print the JSON string representation of the object
print(PatchedmavenMavenDistribution.to_json())

# convert the object into a dict
patchedmaven_maven_distribution_dict = patchedmaven_maven_distribution_instance.to_dict()
# create an instance of PatchedmavenMavenDistribution from a dict
patchedmaven_maven_distribution_from_dict = PatchedmavenMavenDistribution.from_dict(patchedmaven_maven_distribution_dict)

[Back to Model list] [Back to API list] [Back to README]

PatchedmavenMavenRemote

A Serializer for MavenRemote. Add any new fields if defined on MavenRemote. Similar to the example above, in MavenArtifactSerializer. Additional validators can be added to the parent validators list For example:: class Meta: validators = platform.RemoteSerializer.Meta.validators + [myValidator1, myValidator2]

Properties

Name Type Description Notes
name str A unique name for this remote. [optional]
url str The URL of an external content source. [optional]
ca_cert str A PEM encoded CA certificate used to validate the server certificate presented by the remote server. [optional]
client_cert str A PEM encoded client certificate used for authentication. [optional]
client_key str A PEM encoded private key used for authentication. [optional]
tls_validation bool If True, TLS peer validation must be performed. [optional]
proxy_url str The proxy URL. Format: scheme://host:port [optional]
proxy_username str The username to authenticte to the proxy. [optional]
proxy_password str The password to authenticate to the proxy. Extra leading and trailing whitespace characters are not trimmed. [optional]
username str The username to be used for authentication when syncing. [optional]
password str The password to be used for authentication when syncing. Extra leading and trailing whitespace characters are not trimmed. [optional]
pulp_labels Dict[str, Optional[str]] [optional]
download_concurrency int Total number of simultaneous connections. If not set then the default value will be used. [optional]
max_retries int Maximum number of retry attempts after a download failure. If not set then the default value (3) will be used. [optional]
policy PolicyEnum The policy to use when downloading content. * `immediate` - When syncing, download all metadata and content now. [optional]
total_timeout float aiohttp.ClientTimeout.total (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. [optional]
connect_timeout float aiohttp.ClientTimeout.connect (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. [optional]
sock_connect_timeout float aiohttp.ClientTimeout.sock_connect (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. [optional]
sock_read_timeout float aiohttp.ClientTimeout.sock_read (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. [optional]
headers List[object] Headers for aiohttp.Clientsession [optional]
rate_limit int Limits requests per second for each concurrent downloader [optional]

Example

from pulpcore.client.pulp_maven.models.patchedmaven_maven_remote import PatchedmavenMavenRemote

# TODO update the JSON string below
json = "{}"
# create an instance of PatchedmavenMavenRemote from a JSON string
patchedmaven_maven_remote_instance = PatchedmavenMavenRemote.from_json(json)
# print the JSON string representation of the object
print(PatchedmavenMavenRemote.to_json())

# convert the object into a dict
patchedmaven_maven_remote_dict = patchedmaven_maven_remote_instance.to_dict()
# create an instance of PatchedmavenMavenRemote from a dict
patchedmaven_maven_remote_from_dict = PatchedmavenMavenRemote.from_dict(patchedmaven_maven_remote_dict)

[Back to Model list] [Back to API list] [Back to README]

PatchedmavenMavenRepository

Serializer for Maven Repositories.

Properties

Name Type Description Notes
pulp_labels Dict[str, Optional[str]] [optional]
name str A unique name for this repository. [optional]
description str An optional description. [optional]
retain_repo_versions int Retain X versions of the repository. Default is null which retains all versions. [optional]
remote str An optional remote to use by default when syncing. [optional]

Example

from pulpcore.client.pulp_maven.models.patchedmaven_maven_repository import PatchedmavenMavenRepository

# TODO update the JSON string below
json = "{}"
# create an instance of PatchedmavenMavenRepository from a JSON string
patchedmaven_maven_repository_instance = PatchedmavenMavenRepository.from_json(json)
# print the JSON string representation of the object
print(PatchedmavenMavenRepository.to_json())

# convert the object into a dict
patchedmaven_maven_repository_dict = patchedmaven_maven_repository_instance.to_dict()
# create an instance of PatchedmavenMavenRepository from a dict
patchedmaven_maven_repository_from_dict = PatchedmavenMavenRepository.from_dict(patchedmaven_maven_repository_dict)

[Back to Model list] [Back to API list] [Back to README]

PolicyEnum

  • immediate - When syncing, download all metadata and content now.

Enum

  • IMMEDIATE (value: 'immediate')

[Back to Model list] [Back to API list] [Back to README]

pulpcore.client.pulp_maven.RemotesMavenApi

All URIs are relative to https://env-ephemeral-jasrkb.apps.crc-eph.r9lp.p1.openshiftapps.com

Method HTTP request Description
create POST /api/pulp/{pulp_domain}/api/v3/remotes/maven/maven/ Create a maven remote
delete DELETE {maven_maven_remote_href} Delete a maven remote
list GET /api/pulp/{pulp_domain}/api/v3/remotes/maven/maven/ List maven remotes
partial_update PATCH {maven_maven_remote_href} Update a maven remote
read GET {maven_maven_remote_href} Inspect a maven remote
set_label POST {maven_maven_remote_href}set_label/ Set a label
unset_label POST {maven_maven_remote_href}unset_label/ Unset a label
update PUT {maven_maven_remote_href} Update a maven remote

create

MavenMavenRemoteResponse create(pulp_domain, maven_maven_remote, x_task_diagnostics=x_task_diagnostics)

Create a maven remote

A ViewSet for MavenRemote.

Example

  • OAuth Authentication (json_header_remote_authentication):
  • Basic Authentication (basicAuth):
  • Api Key Authentication (cookieAuth):
import pulpcore.client.pulp_maven
from pulpcore.client.pulp_maven.models.maven_maven_remote import MavenMavenRemote
from pulpcore.client.pulp_maven.models.maven_maven_remote_response import MavenMavenRemoteResponse
from pulpcore.client.pulp_maven.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-jasrkb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_maven.Configuration(
    host = "https://env-ephemeral-jasrkb.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.RemotesMavenApi(api_client)
    pulp_domain = 'pulp_domain_example' # str | 
    maven_maven_remote = pulpcore.client.pulp_maven.MavenMavenRemote() # MavenMavenRemote | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Create a maven remote
        api_response = api_instance.create(pulp_domain, maven_maven_remote, x_task_diagnostics=x_task_diagnostics)
        print("The response of RemotesMavenApi->create:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RemotesMavenApi->create: %s\n" % e)

Parameters

Name Type Description Notes
pulp_domain str
maven_maven_remote MavenMavenRemote
x_task_diagnostics List[str] List of profilers to use on tasks. [optional]

Return type

MavenMavenRemoteResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

  • Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
  • Accept: application/json

HTTP response details

Status code Description Response headers
201 -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete

AsyncOperationResponse delete(maven_maven_remote_href, x_task_diagnostics=x_task_diagnostics)

Delete a maven remote

Trigger an asynchronous delete task

Example

  • OAuth Authentication (json_header_remote_authentication):
  • Basic Authentication (basicAuth):
  • Api Key Authentication (cookieAuth):
import pulpcore.client.pulp_maven
from pulpcore.client.pulp_maven.models.async_operation_response import AsyncOperationResponse
from pulpcore.client.pulp_maven.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-jasrkb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_maven.Configuration(
    host = "https://env-ephemeral-jasrkb.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.RemotesMavenApi(api_client)
    maven_maven_remote_href = 'maven_maven_remote_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Delete a maven remote
        api_response = api_instance.delete(maven_maven_remote_href, x_task_diagnostics=x_task_diagnostics)
        print("The response of RemotesMavenApi->delete:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RemotesMavenApi->delete: %s\n" % e)

Parameters

Name Type Description Notes
maven_maven_remote_href str
x_task_diagnostics List[str] List of profilers to use on tasks. [optional]

Return type

AsyncOperationResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
202 -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list

PaginatedmavenMavenRemoteResponseList list(pulp_domain, x_task_diagnostics=x_task_diagnostics, limit=limit, name=name, name__contains=name__contains, name__icontains=name__icontains, name__iexact=name__iexact, name__in=name__in, name__iregex=name__iregex, name__istartswith=name__istartswith, name__regex=name__regex, name__startswith=name__startswith, offset=offset, ordering=ordering, prn__in=prn__in, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, pulp_label_select=pulp_label_select, pulp_last_updated=pulp_last_updated, pulp_last_updated__gt=pulp_last_updated__gt, pulp_last_updated__gte=pulp_last_updated__gte, pulp_last_updated__isnull=pulp_last_updated__isnull, pulp_last_updated__lt=pulp_last_updated__lt, pulp_last_updated__lte=pulp_last_updated__lte, pulp_last_updated__range=pulp_last_updated__range, q=q, fields=fields, exclude_fields=exclude_fields)

List maven remotes

A ViewSet for MavenRemote.

Example

  • OAuth Authentication (json_header_remote_authentication):
  • Basic Authentication (basicAuth):
  • Api Key Authentication (cookieAuth):
import pulpcore.client.pulp_maven
from pulpcore.client.pulp_maven.models.paginatedmaven_maven_remote_response_list import PaginatedmavenMavenRemoteResponseList
from pulpcore.client.pulp_maven.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-jasrkb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_maven.Configuration(
    host = "https://env-ephemeral-jasrkb.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.RemotesMavenApi(api_client)
    pulp_domain = 'pulp_domain_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    limit = 56 # int | Number of results to return per page. (optional)
    name = 'name_example' # str | Filter results where name matches value (optional)
    name__contains = 'name__contains_example' # str | Filter results where name contains value (optional)
    name__icontains = 'name__icontains_example' # str | Filter results where name contains value (optional)
    name__iexact = 'name__iexact_example' # str | Filter results where name matches value (optional)
    name__in = ['name__in_example'] # List[str] | Filter results where name is in a comma-separated list of values (optional)
    name__iregex = 'name__iregex_example' # str | Filter results where name matches regex value (optional)
    name__istartswith = 'name__istartswith_example' # str | Filter results where name starts with value (optional)
    name__regex = 'name__regex_example' # str | Filter results where name matches regex value (optional)
    name__startswith = 'name__startswith_example' # str | Filter results where name starts with value (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) * `name` - Name * `-name` - Name (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `url` - Url * `-url` - Url (descending) * `ca_cert` - Ca cert * `-ca_cert` - Ca cert (descending) * `client_cert` - Client cert * `-client_cert` - Client cert (descending) * `client_key` - Client key * `-client_key` - Client key (descending) * `tls_validation` - Tls validation * `-tls_validation` - Tls validation (descending) * `username` - Username * `-username` - Username (descending) * `password` - Password * `-password` - Password (descending) * `proxy_url` - Proxy url * `-proxy_url` - Proxy url (descending) * `proxy_username` - Proxy username * `-proxy_username` - Proxy username (descending) * `proxy_password` - Proxy password * `-proxy_password` - Proxy password (descending) * `download_concurrency` - Download concurrency * `-download_concurrency` - Download concurrency (descending) * `max_retries` - Max retries * `-max_retries` - Max retries (descending) * `policy` - Policy * `-policy` - Policy (descending) * `total_timeout` - Total timeout * `-total_timeout` - Total timeout (descending) * `connect_timeout` - Connect timeout * `-connect_timeout` - Connect timeout (descending) * `sock_connect_timeout` - Sock connect timeout * `-sock_connect_timeout` - Sock connect timeout (descending) * `sock_read_timeout` - Sock read timeout * `-sock_read_timeout` - Sock read timeout (descending) * `headers` - Headers * `-headers` - Headers (descending) * `rate_limit` - Rate limit * `-rate_limit` - Rate limit (descending) * `pk` - Pk * `-pk` - Pk (descending) (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)
    pulp_last_updated = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_last_updated matches value (optional)
    pulp_last_updated__gt = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_last_updated is greater than value (optional)
    pulp_last_updated__gte = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_last_updated is greater than or equal to value (optional)
    pulp_last_updated__isnull = True # bool | Filter results where pulp_last_updated has a null value (optional)
    pulp_last_updated__lt = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_last_updated is less than value (optional)
    pulp_last_updated__lte = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_last_updated is less than or equal to value (optional)
    pulp_last_updated__range = ['2013-10-20T19:20:30+01:00'] # List[datetime] | Filter results where pulp_last_updated is between two comma separated values (optional)
    q = 'q_example' # str | Filter results by using NOT, AND and OR operations on other filters (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 maven remotes
        api_response = api_instance.list(pulp_domain, x_task_diagnostics=x_task_diagnostics, limit=limit, name=name, name__contains=name__contains, name__icontains=name__icontains, name__iexact=name__iexact, name__in=name__in, name__iregex=name__iregex, name__istartswith=name__istartswith, name__regex=name__regex, name__startswith=name__startswith, offset=offset, ordering=ordering, prn__in=prn__in, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, pulp_label_select=pulp_label_select, pulp_last_updated=pulp_last_updated, pulp_last_updated__gt=pulp_last_updated__gt, pulp_last_updated__gte=pulp_last_updated__gte, pulp_last_updated__isnull=pulp_last_updated__isnull, pulp_last_updated__lt=pulp_last_updated__lt, pulp_last_updated__lte=pulp_last_updated__lte, pulp_last_updated__range=pulp_last_updated__range, q=q, fields=fields, exclude_fields=exclude_fields)
        print("The response of RemotesMavenApi->list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RemotesMavenApi->list: %s\n" % e)

Parameters

Name Type Description Notes
pulp_domain str
x_task_diagnostics List[str] List of profilers to use on tasks. [optional]
limit int Number of results to return per page. [optional]
name str Filter results where name matches value [optional]
name__contains str Filter results where name contains value [optional]
name__icontains str Filter results where name contains value [optional]
name__iexact str Filter results where name matches value [optional]
name__in List[str] Filter results where name is in a comma-separated list of values [optional]
name__iregex str Filter results where name matches regex value [optional]
name__istartswith str Filter results where name starts with value [optional]
name__regex str Filter results where name matches regex value [optional]
name__startswith str Filter results where name starts with value [optional]
offset int The initial index from which to return the results. [optional]
ordering 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) * `name` - Name * `-name` - Name (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `url` - Url * `-url` - Url (descending) * `ca_cert` - Ca cert * `-ca_cert` - Ca cert (descending) * `client_cert` - Client cert * `-client_cert` - Client cert (descending) * `client_key` - Client key * `-client_key` - Client key (descending) * `tls_validation` - Tls validation * `-tls_validation` - Tls validation (descending) * `username` - Username * `-username` - Username (descending) * `password` - Password * `-password` - Password (descending) * `proxy_url` - Proxy url * `-proxy_url` - Proxy url (descending) * `proxy_username` - Proxy username * `-proxy_username` - Proxy username (descending) * `proxy_password` - Proxy password * `-proxy_password` - Proxy password (descending) * `download_concurrency` - Download concurrency * `-download_concurrency` - Download concurrency (descending) * `max_retries` - Max retries * `-max_retries` - Max retries (descending) * `policy` - Policy * `-policy` - Policy (descending) * `total_timeout` - Total timeout * `-total_timeout` - Total timeout (descending) * `connect_timeout` - Connect timeout * `-connect_timeout` - Connect timeout (descending) * `sock_connect_timeout` - Sock connect timeout * `-sock_connect_timeout` - Sock connect timeout (descending) * `sock_read_timeout` - Sock read timeout * `-sock_read_timeout` - Sock read timeout (descending) * `headers` - Headers * `-headers` - Headers (descending) * `rate_limit` - Rate limit * `-rate_limit` - Rate limit (descending) * `pk` - Pk * `-pk` - Pk (descending) [optional]
prn__in List[str] Multiple values may be separated by commas. [optional]
pulp_href__in List[str] Multiple values may be separated by commas. [optional]
pulp_id__in List[str] Multiple values may be separated by commas. [optional]
pulp_label_select str Filter labels by search string [optional]
pulp_last_updated datetime Filter results where pulp_last_updated matches value [optional]
pulp_last_updated__gt datetime Filter results where pulp_last_updated is greater than value [optional]
pulp_last_updated__gte datetime Filter results where pulp_last_updated is greater than or equal to value [optional]
pulp_last_updated__isnull bool Filter results where pulp_last_updated has a null value [optional]
pulp_last_updated__lt datetime Filter results where pulp_last_updated is less than value [optional]
pulp_last_updated__lte datetime Filter results where pulp_last_updated is less than or equal to value [optional]
pulp_last_updated__range List[datetime] Filter results where pulp_last_updated is between two comma separated values [optional]
q str Filter results by using NOT, AND and OR operations on other filters [optional]
fields List[str] A list of fields to include in the response. [optional]
exclude_fields List[str] A list of fields to exclude from the response. [optional]

Return type

PaginatedmavenMavenRemoteResponseList

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

partial_update

MavenMavenRemoteResponse partial_update(maven_maven_remote_href, patchedmaven_maven_remote, x_task_diagnostics=x_task_diagnostics)

Update a maven remote

Update the entity partially and trigger an asynchronous task if necessary

Example

  • OAuth Authentication (json_header_remote_authentication):
  • Basic Authentication (basicAuth):
  • Api Key Authentication (cookieAuth):
import pulpcore.client.pulp_maven
from pulpcore.client.pulp_maven.models.maven_maven_remote_response import MavenMavenRemoteResponse
from pulpcore.client.pulp_maven.models.patchedmaven_maven_remote import PatchedmavenMavenRemote
from pulpcore.client.pulp_maven.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-jasrkb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_maven.Configuration(
    host = "https://env-ephemeral-jasrkb.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.RemotesMavenApi(api_client)
    maven_maven_remote_href = 'maven_maven_remote_href_example' # str | 
    patchedmaven_maven_remote = pulpcore.client.pulp_maven.PatchedmavenMavenRemote() # PatchedmavenMavenRemote | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Update a maven remote
        api_response = api_instance.partial_update(maven_maven_remote_href, patchedmaven_maven_remote, x_task_diagnostics=x_task_diagnostics)
        print("The response of RemotesMavenApi->partial_update:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RemotesMavenApi->partial_update: %s\n" % e)

Parameters

Name Type Description Notes
maven_maven_remote_href str
patchedmaven_maven_remote PatchedmavenMavenRemote
x_task_diagnostics List[str] List of profilers to use on tasks. [optional]

Return type

MavenMavenRemoteResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

  • Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 -
202 -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

read

MavenMavenRemoteResponse read(maven_maven_remote_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

Inspect a maven remote

A ViewSet for MavenRemote.

Example

  • OAuth Authentication (json_header_remote_authentication):
  • Basic Authentication (basicAuth):
  • Api Key Authentication (cookieAuth):
import pulpcore.client.pulp_maven
from pulpcore.client.pulp_maven.models.maven_maven_remote_response import MavenMavenRemoteResponse
from pulpcore.client.pulp_maven.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-jasrkb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_maven.Configuration(
    host = "https://env-ephemeral-jasrkb.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.RemotesMavenApi(api_client)
    maven_maven_remote_href = 'maven_maven_remote_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (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:
        # Inspect a maven remote
        api_response = api_instance.read(maven_maven_remote_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of RemotesMavenApi->read:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RemotesMavenApi->read: %s\n" % e)

Parameters

Name Type Description Notes
maven_maven_remote_href str
x_task_diagnostics List[str] List of profilers to use on tasks. [optional]
fields List[str] A list of fields to include in the response. [optional]
exclude_fields List[str] A list of fields to exclude from the response. [optional]

Return type

MavenMavenRemoteResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

set_label

SetLabelResponse set_label(maven_maven_remote_href, set_label, x_task_diagnostics=x_task_diagnostics)

Set a label

Set a single pulp_label on the object to a specific value or null.

Example

  • OAuth Authentication (json_header_remote_authentication):
  • Basic Authentication (basicAuth):
  • Api Key Authentication (cookieAuth):
import pulpcore.client.pulp_maven
from pulpcore.client.pulp_maven.models.set_label import SetLabel
from pulpcore.client.pulp_maven.models.set_label_response import SetLabelResponse
from pulpcore.client.pulp_maven.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-jasrkb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_maven.Configuration(
    host = "https://env-ephemeral-jasrkb.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.RemotesMavenApi(api_client)
    maven_maven_remote_href = 'maven_maven_remote_href_example' # str | 
    set_label = pulpcore.client.pulp_maven.SetLabel() # SetLabel | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Set a label
        api_response = api_instance.set_label(maven_maven_remote_href, set_label, x_task_diagnostics=x_task_diagnostics)
        print("The response of RemotesMavenApi->set_label:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RemotesMavenApi->set_label: %s\n" % e)

Parameters

Name Type Description Notes
maven_maven_remote_href str
set_label SetLabel
x_task_diagnostics List[str] List of profilers to use on tasks. [optional]

Return type

SetLabelResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

  • Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
  • Accept: application/json

HTTP response details

Status code Description Response headers
201 -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

unset_label

UnsetLabelResponse unset_label(maven_maven_remote_href, unset_label, x_task_diagnostics=x_task_diagnostics)

Unset a label

Unset a single pulp_label on the object.

Example

  • OAuth Authentication (json_header_remote_authentication):
  • Basic Authentication (basicAuth):
  • Api Key Authentication (cookieAuth):
import pulpcore.client.pulp_maven
from pulpcore.client.pulp_maven.models.unset_label import UnsetLabel
from pulpcore.client.pulp_maven.models.unset_label_response import UnsetLabelResponse
from pulpcore.client.pulp_maven.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-jasrkb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_maven.Configuration(
    host = "https://env-ephemeral-jasrkb.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.RemotesMavenApi(api_client)
    maven_maven_remote_href = 'maven_maven_remote_href_example' # str | 
    unset_label = pulpcore.client.pulp_maven.UnsetLabel() # UnsetLabel | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Unset a label
        api_response = api_instance.unset_label(maven_maven_remote_href, unset_label, x_task_diagnostics=x_task_diagnostics)
        print("The response of RemotesMavenApi->unset_label:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RemotesMavenApi->unset_label: %s\n" % e)

Parameters

Name Type Description Notes
maven_maven_remote_href str
unset_label UnsetLabel
x_task_diagnostics List[str] List of profilers to use on tasks. [optional]

Return type

UnsetLabelResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

  • Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
  • Accept: application/json

HTTP response details

Status code Description Response headers
201 -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update

MavenMavenRemoteResponse update(maven_maven_remote_href, maven_maven_remote, x_task_diagnostics=x_task_diagnostics)

Update a maven remote

Update the entity and trigger an asynchronous task if necessary

Example

  • OAuth Authentication (json_header_remote_authentication):
  • Basic Authentication (basicAuth):
  • Api Key Authentication (cookieAuth):
import pulpcore.client.pulp_maven
from pulpcore.client.pulp_maven.models.maven_maven_remote import MavenMavenRemote
from pulpcore.client.pulp_maven.models.maven_maven_remote_response import MavenMavenRemoteResponse
from pulpcore.client.pulp_maven.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-jasrkb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_maven.Configuration(
    host = "https://env-ephemeral-jasrkb.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.RemotesMavenApi(api_client)
    maven_maven_remote_href = 'maven_maven_remote_href_example' # str | 
    maven_maven_remote = pulpcore.client.pulp_maven.MavenMavenRemote() # MavenMavenRemote | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Update a maven remote
        api_response = api_instance.update(maven_maven_remote_href, maven_maven_remote, x_task_diagnostics=x_task_diagnostics)
        print("The response of RemotesMavenApi->update:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RemotesMavenApi->update: %s\n" % e)

Parameters

Name Type Description Notes
maven_maven_remote_href str
maven_maven_remote MavenMavenRemote
x_task_diagnostics List[str] List of profilers to use on tasks. [optional]

Return type

MavenMavenRemoteResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

  • Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 -
202 -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Repair

Properties

Name Type Description Notes
verify_checksums bool Will verify that the checksum of all stored files matches what saved in the database. Otherwise only the existence of the files will be checked. Enabled by default [optional] [default to True]

Example

from pulpcore.client.pulp_maven.models.repair import Repair

# TODO update the JSON string below
json = "{}"
# create an instance of Repair from a JSON string
repair_instance = Repair.from_json(json)
# print the JSON string representation of the object
print(Repair.to_json())

# convert the object into a dict
repair_dict = repair_instance.to_dict()
# create an instance of Repair from a dict
repair_from_dict = Repair.from_dict(repair_dict)

[Back to Model list] [Back to API list] [Back to README]

pulpcore.client.pulp_maven.RepositoriesMavenApi

All URIs are relative to https://env-ephemeral-jasrkb.apps.crc-eph.r9lp.p1.openshiftapps.com

Method HTTP request Description
add_cached_content POST {maven_maven_repository_href}add_cached_content/ Add cached content
create POST /api/pulp/{pulp_domain}/api/v3/repositories/maven/maven/ Create a maven repository
delete DELETE {maven_maven_repository_href} Delete a maven repository
list GET /api/pulp/{pulp_domain}/api/v3/repositories/maven/maven/ List maven repositorys
partial_update PATCH {maven_maven_repository_href} Update a maven repository
read GET {maven_maven_repository_href} Inspect a maven repository
set_label POST {maven_maven_repository_href}set_label/ Set a label
unset_label POST {maven_maven_repository_href}unset_label/ Unset a label
update PUT {maven_maven_repository_href} Update a maven repository

add_cached_content

AsyncOperationResponse add_cached_content(maven_maven_repository_href, repository_add_cached_content, x_task_diagnostics=x_task_diagnostics)

Add cached content

Trigger an asynchronous task to add cached content to a repository.

Example

  • OAuth Authentication (json_header_remote_authentication):
  • Basic Authentication (basicAuth):
  • Api Key Authentication (cookieAuth):
import pulpcore.client.pulp_maven
from pulpcore.client.pulp_maven.models.async_operation_response import AsyncOperationResponse
from pulpcore.client.pulp_maven.models.repository_add_cached_content import RepositoryAddCachedContent
from pulpcore.client.pulp_maven.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-jasrkb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_maven.Configuration(
    host = "https://env-ephemeral-jasrkb.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.RepositoriesMavenApi(api_client)
    maven_maven_repository_href = 'maven_maven_repository_href_example' # str | 
    repository_add_cached_content = pulpcore.client.pulp_maven.RepositoryAddCachedContent() # RepositoryAddCachedContent | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Add cached content
        api_response = api_instance.add_cached_content(maven_maven_repository_href, repository_add_cached_content, x_task_diagnostics=x_task_diagnostics)
        print("The response of RepositoriesMavenApi->add_cached_content:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RepositoriesMavenApi->add_cached_content: %s\n" % e)

Parameters

Name Type Description Notes
maven_maven_repository_href str
repository_add_cached_content RepositoryAddCachedContent
x_task_diagnostics List[str] List of profilers to use on tasks. [optional]

Return type

AsyncOperationResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

  • Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
  • Accept: application/json

HTTP response details

Status code Description Response headers
202 -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create

MavenMavenRepositoryResponse create(pulp_domain, maven_maven_repository, x_task_diagnostics=x_task_diagnostics)

Create a maven repository

A ViewSet for MavenRemote.

Example

  • OAuth Authentication (json_header_remote_authentication):
  • Basic Authentication (basicAuth):
  • Api Key Authentication (cookieAuth):
import pulpcore.client.pulp_maven
from pulpcore.client.pulp_maven.models.maven_maven_repository import MavenMavenRepository
from pulpcore.client.pulp_maven.models.maven_maven_repository_response import MavenMavenRepositoryResponse
from pulpcore.client.pulp_maven.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-jasrkb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_maven.Configuration(
    host = "https://env-ephemeral-jasrkb.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.RepositoriesMavenApi(api_client)
    pulp_domain = 'pulp_domain_example' # str | 
    maven_maven_repository = pulpcore.client.pulp_maven.MavenMavenRepository() # MavenMavenRepository | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Create a maven repository
        api_response = api_instance.create(pulp_domain, maven_maven_repository, x_task_diagnostics=x_task_diagnostics)
        print("The response of RepositoriesMavenApi->create:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RepositoriesMavenApi->create: %s\n" % e)

Parameters

Name Type Description Notes
pulp_domain str
maven_maven_repository MavenMavenRepository
x_task_diagnostics List[str] List of profilers to use on tasks. [optional]

Return type

MavenMavenRepositoryResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

  • Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
  • Accept: application/json

HTTP response details

Status code Description Response headers
201 -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete

AsyncOperationResponse delete(maven_maven_repository_href, x_task_diagnostics=x_task_diagnostics)

Delete a maven repository

Trigger an asynchronous delete task

Example

  • OAuth Authentication (json_header_remote_authentication):
  • Basic Authentication (basicAuth):
  • Api Key Authentication (cookieAuth):
import pulpcore.client.pulp_maven
from pulpcore.client.pulp_maven.models.async_operation_response import AsyncOperationResponse
from pulpcore.client.pulp_maven.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-jasrkb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_maven.Configuration(
    host = "https://env-ephemeral-jasrkb.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.RepositoriesMavenApi(api_client)
    maven_maven_repository_href = 'maven_maven_repository_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Delete a maven repository
        api_response = api_instance.delete(maven_maven_repository_href, x_task_diagnostics=x_task_diagnostics)
        print("The response of RepositoriesMavenApi->delete:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RepositoriesMavenApi->delete: %s\n" % e)

Parameters

Name Type Description Notes
maven_maven_repository_href str
x_task_diagnostics List[str] List of profilers to use on tasks. [optional]

Return type

AsyncOperationResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
202 -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list

PaginatedmavenMavenRepositoryResponseList list(pulp_domain, x_task_diagnostics=x_task_diagnostics, latest_with_content=latest_with_content, limit=limit, name=name, name__contains=name__contains, name__icontains=name__icontains, name__iexact=name__iexact, name__in=name__in, name__iregex=name__iregex, name__istartswith=name__istartswith, name__regex=name__regex, name__startswith=name__startswith, offset=offset, ordering=ordering, prn__in=prn__in, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, pulp_label_select=pulp_label_select, q=q, remote=remote, retain_repo_versions=retain_repo_versions, retain_repo_versions__gt=retain_repo_versions__gt, retain_repo_versions__gte=retain_repo_versions__gte, retain_repo_versions__isnull=retain_repo_versions__isnull, retain_repo_versions__lt=retain_repo_versions__lt, retain_repo_versions__lte=retain_repo_versions__lte, retain_repo_versions__ne=retain_repo_versions__ne, retain_repo_versions__range=retain_repo_versions__range, with_content=with_content, fields=fields, exclude_fields=exclude_fields)

List maven repositorys

A ViewSet for MavenRemote.

Example

  • OAuth Authentication (json_header_remote_authentication):
  • Basic Authentication (basicAuth):
  • Api Key Authentication (cookieAuth):
import pulpcore.client.pulp_maven
from pulpcore.client.pulp_maven.models.paginatedmaven_maven_repository_response_list import PaginatedmavenMavenRepositoryResponseList
from pulpcore.client.pulp_maven.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-jasrkb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_maven.Configuration(
    host = "https://env-ephemeral-jasrkb.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.RepositoriesMavenApi(api_client)
    pulp_domain = 'pulp_domain_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    latest_with_content = 'latest_with_content_example' # str | Content Unit referenced by HREF/PRN (optional)
    limit = 56 # int | Number of results to return per page. (optional)
    name = 'name_example' # str | Filter results where name matches value (optional)
    name__contains = 'name__contains_example' # str | Filter results where name contains value (optional)
    name__icontains = 'name__icontains_example' # str | Filter results where name contains value (optional)
    name__iexact = 'name__iexact_example' # str | Filter results where name matches value (optional)
    name__in = ['name__in_example'] # List[str] | Filter results where name is in a comma-separated list of values (optional)
    name__iregex = 'name__iregex_example' # str | Filter results where name matches regex value (optional)
    name__istartswith = 'name__istartswith_example' # str | Filter results where name starts with value (optional)
    name__regex = 'name__regex_example' # str | Filter results where name matches regex value (optional)
    name__startswith = 'name__startswith_example' # str | Filter results where name starts with value (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) * `name` - Name * `-name` - Name (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `description` - Description * `-description` - Description (descending) * `next_version` - Next version * `-next_version` - Next version (descending) * `retain_repo_versions` - Retain repo versions * `-retain_repo_versions` - Retain repo versions (descending) * `user_hidden` - User hidden * `-user_hidden` - User hidden (descending) * `pk` - Pk * `-pk` - Pk (descending) (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)
    remote = 'remote_example' # str | Foreign Key referenced by HREF (optional)
    retain_repo_versions = 56 # int | Filter results where retain_repo_versions matches value (optional)
    retain_repo_versions__gt = 56 # int | Filter results where retain_repo_versions is greater than value (optional)
    retain_repo_versions__gte = 56 # int | Filter results where retain_repo_versions is greater than or equal to value (optional)
    retain_repo_versions__isnull = True # bool | Filter results where retain_repo_versions has a null value (optional)
    retain_repo_versions__lt = 56 # int | Filter results where retain_repo_versions is less than value (optional)
    retain_repo_versions__lte = 56 # int | Filter results where retain_repo_versions is less than or equal to value (optional)
    retain_repo_versions__ne = 56 # int | Filter results where retain_repo_versions not equal to value (optional)
    retain_repo_versions__range = [56] # List[int] | Filter results where retain_repo_versions is between two comma separated values (optional)
    with_content = 'with_content_example' # str | Content Unit 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 maven repositorys
        api_response = api_instance.list(pulp_domain, x_task_diagnostics=x_task_diagnostics, latest_with_content=latest_with_content, limit=limit, name=name, name__contains=name__contains, name__icontains=name__icontains, name__iexact=name__iexact, name__in=name__in, name__iregex=name__iregex, name__istartswith=name__istartswith, name__regex=name__regex, name__startswith=name__startswith, offset=offset, ordering=ordering, prn__in=prn__in, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, pulp_label_select=pulp_label_select, q=q, remote=remote, retain_repo_versions=retain_repo_versions, retain_repo_versions__gt=retain_repo_versions__gt, retain_repo_versions__gte=retain_repo_versions__gte, retain_repo_versions__isnull=retain_repo_versions__isnull, retain_repo_versions__lt=retain_repo_versions__lt, retain_repo_versions__lte=retain_repo_versions__lte, retain_repo_versions__ne=retain_repo_versions__ne, retain_repo_versions__range=retain_repo_versions__range, with_content=with_content, fields=fields, exclude_fields=exclude_fields)
        print("The response of RepositoriesMavenApi->list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RepositoriesMavenApi->list: %s\n" % e)

Parameters

Name Type Description Notes
pulp_domain str
x_task_diagnostics List[str] List of profilers to use on tasks. [optional]
latest_with_content str Content Unit referenced by HREF/PRN [optional]
limit int Number of results to return per page. [optional]
name str Filter results where name matches value [optional]
name__contains str Filter results where name contains value [optional]
name__icontains str Filter results where name contains value [optional]
name__iexact str Filter results where name matches value [optional]
name__in List[str] Filter results where name is in a comma-separated list of values [optional]
name__iregex str Filter results where name matches regex value [optional]
name__istartswith str Filter results where name starts with value [optional]
name__regex str Filter results where name matches regex value [optional]
name__startswith str Filter results where name starts with value [optional]
offset int The initial index from which to return the results. [optional]
ordering 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) * `name` - Name * `-name` - Name (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `description` - Description * `-description` - Description (descending) * `next_version` - Next version * `-next_version` - Next version (descending) * `retain_repo_versions` - Retain repo versions * `-retain_repo_versions` - Retain repo versions (descending) * `user_hidden` - User hidden * `-user_hidden` - User hidden (descending) * `pk` - Pk * `-pk` - Pk (descending) [optional]
prn__in List[str] Multiple values may be separated by commas. [optional]
pulp_href__in List[str] Multiple values may be separated by commas. [optional]
pulp_id__in List[str] Multiple values may be separated by commas. [optional]
pulp_label_select str Filter labels by search string [optional]
q str Filter results by using NOT, AND and OR operations on other filters [optional]
remote str Foreign Key referenced by HREF [optional]
retain_repo_versions int Filter results where retain_repo_versions matches value [optional]
retain_repo_versions__gt int Filter results where retain_repo_versions is greater than value [optional]
retain_repo_versions__gte int Filter results where retain_repo_versions is greater than or equal to value [optional]
retain_repo_versions__isnull bool Filter results where retain_repo_versions has a null value [optional]
retain_repo_versions__lt int Filter results where retain_repo_versions is less than value [optional]
retain_repo_versions__lte int Filter results where retain_repo_versions is less than or equal to value [optional]
retain_repo_versions__ne int Filter results where retain_repo_versions not equal to value [optional]
retain_repo_versions__range List[int] Filter results where retain_repo_versions is between two comma separated values [optional]
with_content str Content Unit referenced by HREF/PRN [optional]
fields List[str] A list of fields to include in the response. [optional]
exclude_fields List[str] A list of fields to exclude from the response. [optional]

Return type

PaginatedmavenMavenRepositoryResponseList

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

partial_update

MavenMavenRepositoryResponse partial_update(maven_maven_repository_href, patchedmaven_maven_repository, x_task_diagnostics=x_task_diagnostics)

Update a maven repository

Update the entity partially and trigger an asynchronous task if necessary

Example

  • OAuth Authentication (json_header_remote_authentication):
  • Basic Authentication (basicAuth):
  • Api Key Authentication (cookieAuth):
import pulpcore.client.pulp_maven
from pulpcore.client.pulp_maven.models.maven_maven_repository_response import MavenMavenRepositoryResponse
from pulpcore.client.pulp_maven.models.patchedmaven_maven_repository import PatchedmavenMavenRepository
from pulpcore.client.pulp_maven.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-jasrkb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_maven.Configuration(
    host = "https://env-ephemeral-jasrkb.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.RepositoriesMavenApi(api_client)
    maven_maven_repository_href = 'maven_maven_repository_href_example' # str | 
    patchedmaven_maven_repository = pulpcore.client.pulp_maven.PatchedmavenMavenRepository() # PatchedmavenMavenRepository | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Update a maven repository
        api_response = api_instance.partial_update(maven_maven_repository_href, patchedmaven_maven_repository, x_task_diagnostics=x_task_diagnostics)
        print("The response of RepositoriesMavenApi->partial_update:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RepositoriesMavenApi->partial_update: %s\n" % e)

Parameters

Name Type Description Notes
maven_maven_repository_href str
patchedmaven_maven_repository PatchedmavenMavenRepository
x_task_diagnostics List[str] List of profilers to use on tasks. [optional]

Return type

MavenMavenRepositoryResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

  • Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 -
202 -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

read

MavenMavenRepositoryResponse read(maven_maven_repository_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

Inspect a maven repository

A ViewSet for MavenRemote.

Example

  • OAuth Authentication (json_header_remote_authentication):
  • Basic Authentication (basicAuth):
  • Api Key Authentication (cookieAuth):
import pulpcore.client.pulp_maven
from pulpcore.client.pulp_maven.models.maven_maven_repository_response import MavenMavenRepositoryResponse
from pulpcore.client.pulp_maven.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-jasrkb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_maven.Configuration(
    host = "https://env-ephemeral-jasrkb.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.RepositoriesMavenApi(api_client)
    maven_maven_repository_href = 'maven_maven_repository_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (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:
        # Inspect a maven repository
        api_response = api_instance.read(maven_maven_repository_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of RepositoriesMavenApi->read:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RepositoriesMavenApi->read: %s\n" % e)

Parameters

Name Type Description Notes
maven_maven_repository_href str
x_task_diagnostics List[str] List of profilers to use on tasks. [optional]
fields List[str] A list of fields to include in the response. [optional]
exclude_fields List[str] A list of fields to exclude from the response. [optional]

Return type

MavenMavenRepositoryResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

set_label

SetLabelResponse set_label(maven_maven_repository_href, set_label, x_task_diagnostics=x_task_diagnostics)

Set a label

Set a single pulp_label on the object to a specific value or null.

Example

  • OAuth Authentication (json_header_remote_authentication):
  • Basic Authentication (basicAuth):
  • Api Key Authentication (cookieAuth):
import pulpcore.client.pulp_maven
from pulpcore.client.pulp_maven.models.set_label import SetLabel
from pulpcore.client.pulp_maven.models.set_label_response import SetLabelResponse
from pulpcore.client.pulp_maven.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-jasrkb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_maven.Configuration(
    host = "https://env-ephemeral-jasrkb.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.RepositoriesMavenApi(api_client)
    maven_maven_repository_href = 'maven_maven_repository_href_example' # str | 
    set_label = pulpcore.client.pulp_maven.SetLabel() # SetLabel | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Set a label
        api_response = api_instance.set_label(maven_maven_repository_href, set_label, x_task_diagnostics=x_task_diagnostics)
        print("The response of RepositoriesMavenApi->set_label:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RepositoriesMavenApi->set_label: %s\n" % e)

Parameters

Name Type Description Notes
maven_maven_repository_href str
set_label SetLabel
x_task_diagnostics List[str] List of profilers to use on tasks. [optional]

Return type

SetLabelResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

  • Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
  • Accept: application/json

HTTP response details

Status code Description Response headers
201 -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

unset_label

UnsetLabelResponse unset_label(maven_maven_repository_href, unset_label, x_task_diagnostics=x_task_diagnostics)

Unset a label

Unset a single pulp_label on the object.

Example

  • OAuth Authentication (json_header_remote_authentication):
  • Basic Authentication (basicAuth):
  • Api Key Authentication (cookieAuth):
import pulpcore.client.pulp_maven
from pulpcore.client.pulp_maven.models.unset_label import UnsetLabel
from pulpcore.client.pulp_maven.models.unset_label_response import UnsetLabelResponse
from pulpcore.client.pulp_maven.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-jasrkb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_maven.Configuration(
    host = "https://env-ephemeral-jasrkb.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.RepositoriesMavenApi(api_client)
    maven_maven_repository_href = 'maven_maven_repository_href_example' # str | 
    unset_label = pulpcore.client.pulp_maven.UnsetLabel() # UnsetLabel | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Unset a label
        api_response = api_instance.unset_label(maven_maven_repository_href, unset_label, x_task_diagnostics=x_task_diagnostics)
        print("The response of RepositoriesMavenApi->unset_label:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RepositoriesMavenApi->unset_label: %s\n" % e)

Parameters

Name Type Description Notes
maven_maven_repository_href str
unset_label UnsetLabel
x_task_diagnostics List[str] List of profilers to use on tasks. [optional]

Return type

UnsetLabelResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

  • Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
  • Accept: application/json

HTTP response details

Status code Description Response headers
201 -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update

MavenMavenRepositoryResponse update(maven_maven_repository_href, maven_maven_repository, x_task_diagnostics=x_task_diagnostics)

Update a maven repository

Update the entity and trigger an asynchronous task if necessary

Example

  • OAuth Authentication (json_header_remote_authentication):
  • Basic Authentication (basicAuth):
  • Api Key Authentication (cookieAuth):
import pulpcore.client.pulp_maven
from pulpcore.client.pulp_maven.models.maven_maven_repository import MavenMavenRepository
from pulpcore.client.pulp_maven.models.maven_maven_repository_response import MavenMavenRepositoryResponse
from pulpcore.client.pulp_maven.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-jasrkb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_maven.Configuration(
    host = "https://env-ephemeral-jasrkb.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.RepositoriesMavenApi(api_client)
    maven_maven_repository_href = 'maven_maven_repository_href_example' # str | 
    maven_maven_repository = pulpcore.client.pulp_maven.MavenMavenRepository() # MavenMavenRepository | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Update a maven repository
        api_response = api_instance.update(maven_maven_repository_href, maven_maven_repository, x_task_diagnostics=x_task_diagnostics)
        print("The response of RepositoriesMavenApi->update:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RepositoriesMavenApi->update: %s\n" % e)

Parameters

Name Type Description Notes
maven_maven_repository_href str
maven_maven_repository MavenMavenRepository
x_task_diagnostics List[str] List of profilers to use on tasks. [optional]

Return type

MavenMavenRepositoryResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

  • Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 -
202 -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

pulpcore.client.pulp_maven.RepositoriesMavenVersionsApi

All URIs are relative to https://env-ephemeral-jasrkb.apps.crc-eph.r9lp.p1.openshiftapps.com

Method HTTP request Description
delete DELETE {maven_maven_repository_version_href} Delete a repository version
list GET {maven_maven_repository_href}versions/ List repository versions
read GET {maven_maven_repository_version_href} Inspect a repository version
repair POST {maven_maven_repository_version_href}repair/

delete

AsyncOperationResponse delete(maven_maven_repository_version_href, x_task_diagnostics=x_task_diagnostics)

Delete a repository version

Trigger an asynchronous task to delete a repository version.

Example

  • OAuth Authentication (json_header_remote_authentication):
  • Basic Authentication (basicAuth):
  • Api Key Authentication (cookieAuth):
import pulpcore.client.pulp_maven
from pulpcore.client.pulp_maven.models.async_operation_response import AsyncOperationResponse
from pulpcore.client.pulp_maven.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-jasrkb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_maven.Configuration(
    host = "https://env-ephemeral-jasrkb.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.RepositoriesMavenVersionsApi(api_client)
    maven_maven_repository_version_href = 'maven_maven_repository_version_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Delete a repository version
        api_response = api_instance.delete(maven_maven_repository_version_href, x_task_diagnostics=x_task_diagnostics)
        print("The response of RepositoriesMavenVersionsApi->delete:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RepositoriesMavenVersionsApi->delete: %s\n" % e)

Parameters

Name Type Description Notes
maven_maven_repository_version_href str
x_task_diagnostics List[str] List of profilers to use on tasks. [optional]

Return type

AsyncOperationResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
202 -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list

PaginatedRepositoryVersionResponseList list(maven_maven_repository_href, x_task_diagnostics=x_task_diagnostics, content=content, content__in=content__in, limit=limit, number=number, number__gt=number__gt, number__gte=number__gte, number__lt=number__lt, number__lte=number__lte, number__range=number__range, offset=offset, ordering=ordering, prn__in=prn__in, pulp_created=pulp_created, pulp_created__gt=pulp_created__gt, pulp_created__gte=pulp_created__gte, pulp_created__isnull=pulp_created__isnull, pulp_created__lt=pulp_created__lt, pulp_created__lte=pulp_created__lte, pulp_created__range=pulp_created__range, pulp_href__in=pulp_href__in, q=q, fields=fields, exclude_fields=exclude_fields)

List repository versions

MavenRepositoryVersion represents a single Maven repository version.

Example

  • OAuth Authentication (json_header_remote_authentication):
  • Basic Authentication (basicAuth):
  • Api Key Authentication (cookieAuth):
import pulpcore.client.pulp_maven
from pulpcore.client.pulp_maven.models.paginated_repository_version_response_list import PaginatedRepositoryVersionResponseList
from pulpcore.client.pulp_maven.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-jasrkb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_maven.Configuration(
    host = "https://env-ephemeral-jasrkb.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.RepositoriesMavenVersionsApi(api_client)
    maven_maven_repository_href = 'maven_maven_repository_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    content = 'content_example' # str | Content Unit referenced by HREF/PRN (optional)
    content__in = ['content__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
    limit = 56 # int | Number of results to return per page. (optional)
    number = 56 # int | Filter results where number matches value (optional)
    number__gt = 56 # int | Filter results where number is greater than value (optional)
    number__gte = 56 # int | Filter results where number is greater than or equal to value (optional)
    number__lt = 56 # int | Filter results where number is less than value (optional)
    number__lte = 56 # int | Filter results where number is less than or equal to value (optional)
    number__range = [56] # List[int] | Filter results where number is between two comma separated values (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) * `number` - Number * `-number` - Number (descending) * `complete` - Complete * `-complete` - Complete (descending) * `info` - Info * `-info` - Info (descending) * `content_ids` - Content ids * `-content_ids` - Content ids (descending) * `pk` - Pk * `-pk` - Pk (descending) (optional)
    prn__in = ['prn__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
    pulp_created = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_created matches value (optional)
    pulp_created__gt = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_created is greater than value (optional)
    pulp_created__gte = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_created is greater than or equal to value (optional)
    pulp_created__isnull = True # bool | Filter results where pulp_created has a null value (optional)
    pulp_created__lt = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_created is less than value (optional)
    pulp_created__lte = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_created is less than or equal to value (optional)
    pulp_created__range = ['2013-10-20T19:20:30+01:00'] # List[datetime] | Filter results where pulp_created is between two comma separated values (optional)
    pulp_href__in = ['pulp_href__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
    q = 'q_example' # str | Filter results by using NOT, AND and OR operations on other filters (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 repository versions
        api_response = api_instance.list(maven_maven_repository_href, x_task_diagnostics=x_task_diagnostics, content=content, content__in=content__in, limit=limit, number=number, number__gt=number__gt, number__gte=number__gte, number__lt=number__lt, number__lte=number__lte, number__range=number__range, offset=offset, ordering=ordering, prn__in=prn__in, pulp_created=pulp_created, pulp_created__gt=pulp_created__gt, pulp_created__gte=pulp_created__gte, pulp_created__isnull=pulp_created__isnull, pulp_created__lt=pulp_created__lt, pulp_created__lte=pulp_created__lte, pulp_created__range=pulp_created__range, pulp_href__in=pulp_href__in, q=q, fields=fields, exclude_fields=exclude_fields)
        print("The response of RepositoriesMavenVersionsApi->list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RepositoriesMavenVersionsApi->list: %s\n" % e)

Parameters

Name Type Description Notes
maven_maven_repository_href str
x_task_diagnostics List[str] List of profilers to use on tasks. [optional]
content str Content Unit referenced by HREF/PRN [optional]
content__in List[str] Multiple values may be separated by commas. [optional]
limit int Number of results to return per page. [optional]
number int Filter results where number matches value [optional]
number__gt int Filter results where number is greater than value [optional]
number__gte int Filter results where number is greater than or equal to value [optional]
number__lt int Filter results where number is less than value [optional]
number__lte int Filter results where number is less than or equal to value [optional]
number__range List[int] Filter results where number is between two comma separated values [optional]
offset int The initial index from which to return the results. [optional]
ordering 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) * `number` - Number * `-number` - Number (descending) * `complete` - Complete * `-complete` - Complete (descending) * `info` - Info * `-info` - Info (descending) * `content_ids` - Content ids * `-content_ids` - Content ids (descending) * `pk` - Pk * `-pk` - Pk (descending) [optional]
prn__in List[str] Multiple values may be separated by commas. [optional]
pulp_created datetime Filter results where pulp_created matches value [optional]
pulp_created__gt datetime Filter results where pulp_created is greater than value [optional]
pulp_created__gte datetime Filter results where pulp_created is greater than or equal to value [optional]
pulp_created__isnull bool Filter results where pulp_created has a null value [optional]
pulp_created__lt datetime Filter results where pulp_created is less than value [optional]
pulp_created__lte datetime Filter results where pulp_created is less than or equal to value [optional]
pulp_created__range List[datetime] Filter results where pulp_created is between two comma separated values [optional]
pulp_href__in List[str] Multiple values may be separated by commas. [optional]
q str Filter results by using NOT, AND and OR operations on other filters [optional]
fields List[str] A list of fields to include in the response. [optional]
exclude_fields List[str] A list of fields to exclude from the response. [optional]

Return type

PaginatedRepositoryVersionResponseList

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

read

RepositoryVersionResponse read(maven_maven_repository_version_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

Inspect a repository version

MavenRepositoryVersion represents a single Maven repository version.

Example

  • OAuth Authentication (json_header_remote_authentication):
  • Basic Authentication (basicAuth):
  • Api Key Authentication (cookieAuth):
import pulpcore.client.pulp_maven
from pulpcore.client.pulp_maven.models.repository_version_response import RepositoryVersionResponse
from pulpcore.client.pulp_maven.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-jasrkb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_maven.Configuration(
    host = "https://env-ephemeral-jasrkb.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.RepositoriesMavenVersionsApi(api_client)
    maven_maven_repository_version_href = 'maven_maven_repository_version_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (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:
        # Inspect a repository version
        api_response = api_instance.read(maven_maven_repository_version_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of RepositoriesMavenVersionsApi->read:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RepositoriesMavenVersionsApi->read: %s\n" % e)

Parameters

Name Type Description Notes
maven_maven_repository_version_href str
x_task_diagnostics List[str] List of profilers to use on tasks. [optional]
fields List[str] A list of fields to include in the response. [optional]
exclude_fields List[str] A list of fields to exclude from the response. [optional]

Return type

RepositoryVersionResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repair

AsyncOperationResponse repair(maven_maven_repository_version_href, repair, x_task_diagnostics=x_task_diagnostics)

Trigger an asynchronous task to repair a repository version.

Example

  • OAuth Authentication (json_header_remote_authentication):
  • Basic Authentication (basicAuth):
  • Api Key Authentication (cookieAuth):
import pulpcore.client.pulp_maven
from pulpcore.client.pulp_maven.models.async_operation_response import AsyncOperationResponse
from pulpcore.client.pulp_maven.models.repair import Repair
from pulpcore.client.pulp_maven.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-jasrkb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_maven.Configuration(
    host = "https://env-ephemeral-jasrkb.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.RepositoriesMavenVersionsApi(api_client)
    maven_maven_repository_version_href = 'maven_maven_repository_version_href_example' # str | 
    repair = pulpcore.client.pulp_maven.Repair() # Repair | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        api_response = api_instance.repair(maven_maven_repository_version_href, repair, x_task_diagnostics=x_task_diagnostics)
        print("The response of RepositoriesMavenVersionsApi->repair:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RepositoriesMavenVersionsApi->repair: %s\n" % e)

Parameters

Name Type Description Notes
maven_maven_repository_version_href str
repair Repair
x_task_diagnostics List[str] List of profilers to use on tasks. [optional]

Return type

AsyncOperationResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

  • Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
  • Accept: application/json

HTTP response details

Status code Description Response headers
202 -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RepositoryAddCachedContent

A mixin for validating unknown serializers' fields.

Properties

Name Type Description Notes
remote str A remote to use to identify content that was cached. This will override a remote set on repository. [optional]

Example

from pulpcore.client.pulp_maven.models.repository_add_cached_content import RepositoryAddCachedContent

# TODO update the JSON string below
json = "{}"
# create an instance of RepositoryAddCachedContent from a JSON string
repository_add_cached_content_instance = RepositoryAddCachedContent.from_json(json)
# print the JSON string representation of the object
print(RepositoryAddCachedContent.to_json())

# convert the object into a dict
repository_add_cached_content_dict = repository_add_cached_content_instance.to_dict()
# create an instance of RepositoryAddCachedContent from a dict
repository_add_cached_content_from_dict = RepositoryAddCachedContent.from_dict(repository_add_cached_content_dict)

[Back to Model list] [Back to API list] [Back to README]

RepositoryVersionResponse

Base serializer for use with [pulpcore.app.models.Model][] This ensures that all Serializers provide values for the 'pulp_href` field. The class provides a default for the ref_name attribute in the ModelSerializers's ``Meta`` class. This ensures that the OpenAPI definitions of plugins are namespaced properly.

Properties

Name Type Description Notes
pulp_href str [optional] [readonly]
prn str The Pulp Resource Name (PRN). [optional] [readonly]
pulp_created datetime Timestamp of creation. [optional] [readonly]
pulp_last_updated datetime Timestamp of the last time this resource was updated. Note: for immutable resources - like content, repository versions, and publication - pulp_created and pulp_last_updated dates will be the same. [optional] [readonly]
number int [optional] [readonly]
repository str [optional] [readonly]
base_version str A repository version whose content was used as the initial set of content for this repository version [optional]
content_summary ContentSummaryResponse Various count summaries of the content in the version and the HREF to view them. [optional] [readonly]
vuln_report str [optional] [readonly]

Example

from pulpcore.client.pulp_maven.models.repository_version_response import RepositoryVersionResponse

# TODO update the JSON string below
json = "{}"
# create an instance of RepositoryVersionResponse from a JSON string
repository_version_response_instance = RepositoryVersionResponse.from_json(json)
# print the JSON string representation of the object
print(RepositoryVersionResponse.to_json())

# convert the object into a dict
repository_version_response_dict = repository_version_response_instance.to_dict()
# create an instance of RepositoryVersionResponse from a dict
repository_version_response_from_dict = RepositoryVersionResponse.from_dict(repository_version_response_dict)

[Back to Model list] [Back to API list] [Back to README]

SetLabel

Serializer for synchronously setting a label.

Properties

Name Type Description Notes
key str
value str

Example

from pulpcore.client.pulp_maven.models.set_label import SetLabel

# TODO update the JSON string below
json = "{}"
# create an instance of SetLabel from a JSON string
set_label_instance = SetLabel.from_json(json)
# print the JSON string representation of the object
print(SetLabel.to_json())

# convert the object into a dict
set_label_dict = set_label_instance.to_dict()
# create an instance of SetLabel from a dict
set_label_from_dict = SetLabel.from_dict(set_label_dict)

[Back to Model list] [Back to API list] [Back to README]

SetLabelResponse

Serializer for synchronously setting a label.

Properties

Name Type Description Notes
key str
value str

Example

from pulpcore.client.pulp_maven.models.set_label_response import SetLabelResponse

# TODO update the JSON string below
json = "{}"
# create an instance of SetLabelResponse from a JSON string
set_label_response_instance = SetLabelResponse.from_json(json)
# print the JSON string representation of the object
print(SetLabelResponse.to_json())

# convert the object into a dict
set_label_response_dict = set_label_response_instance.to_dict()
# create an instance of SetLabelResponse from a dict
set_label_response_from_dict = SetLabelResponse.from_dict(set_label_response_dict)

[Back to Model list] [Back to API list] [Back to README]

UnsetLabel

Serializer for synchronously UNsetting a label.

Properties

Name Type Description Notes
key str

Example

from pulpcore.client.pulp_maven.models.unset_label import UnsetLabel

# TODO update the JSON string below
json = "{}"
# create an instance of UnsetLabel from a JSON string
unset_label_instance = UnsetLabel.from_json(json)
# print the JSON string representation of the object
print(UnsetLabel.to_json())

# convert the object into a dict
unset_label_dict = unset_label_instance.to_dict()
# create an instance of UnsetLabel from a dict
unset_label_from_dict = UnsetLabel.from_dict(unset_label_dict)

[Back to Model list] [Back to API list] [Back to README]

UnsetLabelResponse

Serializer for synchronously UNsetting a label.

Properties

Name Type Description Notes
key str
value str [optional] [readonly]

Example

from pulpcore.client.pulp_maven.models.unset_label_response import UnsetLabelResponse

# TODO update the JSON string below
json = "{}"
# create an instance of UnsetLabelResponse from a JSON string
unset_label_response_instance = UnsetLabelResponse.from_json(json)
# print the JSON string representation of the object
print(UnsetLabelResponse.to_json())

# convert the object into a dict
unset_label_response_dict = unset_label_response_instance.to_dict()
# create an instance of UnsetLabelResponse from a dict
unset_label_response_from_dict = UnsetLabelResponse.from_dict(unset_label_response_dict)

[Back to Model list] [Back to API list] [Back to README]

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

crc_pulp_maven_client-20260121.8.tar.gz (96.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

crc_pulp_maven_client-20260121.8-py3-none-any.whl (119.7 kB view details)

Uploaded Python 3

File details

Details for the file crc_pulp_maven_client-20260121.8.tar.gz.

File metadata

File hashes

Hashes for crc_pulp_maven_client-20260121.8.tar.gz
Algorithm Hash digest
SHA256 80aac18c717a6caf4ce55f45a10291659373ae1f395eb176b52e405aa31e12f5
MD5 6d47450946e922964aa3e105a7fee40f
BLAKE2b-256 81210365e1be48d23423796d22d98ed5f7b51d5b4c06c302d2623780ff172f4d

See more details on using hashes here.

File details

Details for the file crc_pulp_maven_client-20260121.8-py3-none-any.whl.

File metadata

File hashes

Hashes for crc_pulp_maven_client-20260121.8-py3-none-any.whl
Algorithm Hash digest
SHA256 a3816cb677c2c5d5d223a024fdcc8127220126447bb4cdca6e8faf94945d3007
MD5 dd9a72e6051ae2b8f314cdaceba48512
BLAKE2b-256 35bda3e16d2e05c38d13fcc358e9a2cb65db203f774c0fc643b569a1b3fb1444

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page