crc-pulpcore-client 20260209.2

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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]

read

AccessPolicyResponse read(access_policy_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

Inspect an access policy

ViewSet for AccessPolicy.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.access_policy_response import AccessPolicyResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.AccessPoliciesApi(api_client)
    access_policy_href = 'access_policy_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 an access policy
        api_response = api_instance.read(access_policy_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of AccessPoliciesApi->read:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AccessPoliciesApi->read: %s\n" % e)

Parameters

Name	Type	Description	Notes
access_policy_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

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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]

reset

AccessPolicyResponse reset(access_policy_href, x_task_diagnostics=x_task_diagnostics)

Reset the access policy to its uncustomized default value.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.access_policy_response import AccessPolicyResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.AccessPoliciesApi(api_client)
    access_policy_href = 'access_policy_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

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

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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]

update

AccessPolicyResponse update(access_policy_href, access_policy, x_task_diagnostics=x_task_diagnostics)

Update an access policy

ViewSet for AccessPolicy.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.access_policy import AccessPolicy
from pulpcore.client.pulpcore.models.access_policy_response import AccessPolicyResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.AccessPoliciesApi(api_client)
    access_policy_href = 'access_policy_href_example' # str | 
    access_policy = pulpcore.client.pulpcore.AccessPolicy() # AccessPolicy | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Update an access policy
        api_response = api_instance.update(access_policy_href, access_policy, x_task_diagnostics=x_task_diagnostics)
        print("The response of AccessPoliciesApi->update:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AccessPoliciesApi->update: %s\n" % e)

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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]

AccessPolicy

Serializer for AccessPolicy.

Properties

Name	Type	Description	Notes
permissions_assignment	List[object]	List of callables that define the new permissions to be created for new objects.This is deprecated. Use `creation_hooks` instead.	[optional]
creation_hooks	List[object]	List of callables that may associate user roles for new objects.	[optional]
statements	List[object]	List of policy statements defining the policy.
queryset_scoping	object	A callable for performing queryset scoping. See plugin documentation for valid callables. Set to blank to turn off queryset scoping.	[optional]

Example

from pulpcore.client.pulpcore.models.access_policy import AccessPolicy

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

# convert the object into a dict
access_policy_dict = access_policy_instance.to_dict()
# create an instance of AccessPolicy from a dict
access_policy_from_dict = AccessPolicy.from_dict(access_policy_dict)

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

AccessPolicyResponse

Serializer for AccessPolicy.

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]
permissions_assignment	List[object]	List of callables that define the new permissions to be created for new objects.This is deprecated. Use `creation_hooks` instead.	[optional]
creation_hooks	List[object]	List of callables that may associate user roles for new objects.	[optional]
statements	List[object]	List of policy statements defining the policy.
viewset_name	str	The name of ViewSet this AccessPolicy authorizes.	[optional] [readonly]
customized	bool	True if the AccessPolicy has been user-modified. False otherwise.	[optional] [readonly]
queryset_scoping	object	A callable for performing queryset scoping. See plugin documentation for valid callables. Set to blank to turn off queryset scoping.	[optional]

Example

from pulpcore.client.pulpcore.models.access_policy_response import AccessPolicyResponse

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

# convert the object into a dict
access_policy_response_dict = access_policy_response_instance.to_dict()
# create an instance of AccessPolicyResponse from a dict
access_policy_response_from_dict = AccessPolicyResponse.from_dict(access_policy_response_dict)

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

AppStatusResponse

Properties

Name	Type	Description	Notes
name	str	The name of the worker.	[optional] [readonly]
last_heartbeat	datetime	Timestamp of the last time the worker talked to the service.	[optional] [readonly]
versions	Dict[str, Optional[str]]	Versions of the components installed.	[optional] [readonly]

Example

from pulpcore.client.pulpcore.models.app_status_response import AppStatusResponse

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

# convert the object into a dict
app_status_response_dict = app_status_response_instance.to_dict()
# create an instance of AppStatusResponse from a dict
app_status_response_from_dict = AppStatusResponse.from_dict(app_status_response_dict)

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

ArtifactDistributionResponse

A serializer for ArtifactDistribution.

Properties

Name	Type	Description	Notes
hidden	bool	Whether this distribution should be shown in the content app.	[optional] [default to False]
name	str	A unique name. Ex, `rawhide` and `stable`.
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]
content_guard	str	An optional content-guard.	[optional]
pulp_href	str		[optional] [readonly]
pulp_labels	Dict[str, Optional[str]]		[optional]
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]
prn	str	The Pulp Resource Name (PRN).	[optional] [readonly]
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]
pulp_created	datetime	Timestamp of creation.	[optional] [readonly]

Example

from pulpcore.client.pulpcore.models.artifact_distribution_response import ArtifactDistributionResponse

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

# convert the object into a dict
artifact_distribution_response_dict = artifact_distribution_response_instance.to_dict()
# create an instance of ArtifactDistributionResponse from a dict
artifact_distribution_response_from_dict = ArtifactDistributionResponse.from_dict(artifact_distribution_response_dict)

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

ArtifactResponse

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]
file	str	The stored file.
size	int	The size of the file in bytes.	[optional]
md5	str	The MD5 checksum of the file if available.	[optional]
sha1	str	The SHA-1 checksum of the file if available.	[optional]
sha224	str	The SHA-224 checksum of the file if available.	[optional]
sha256	str	The SHA-256 checksum of the file if available.	[optional]
sha384	str	The SHA-384 checksum of the file if available.	[optional]
sha512	str	The SHA-512 checksum of the file if available.	[optional]

Example

from pulpcore.client.pulpcore.models.artifact_response import ArtifactResponse

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

# convert the object into a dict
artifact_response_dict = artifact_response_instance.to_dict()
# create an instance of ArtifactResponse from a dict
artifact_response_from_dict = ArtifactResponse.from_dict(artifact_response_dict)

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

pulpcore.client.pulpcore.ArtifactsApi

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

Method	HTTP request	Description
create	POST /api/pulp/{pulp_domain}/api/v3/artifacts/	Create an artifact
delete	DELETE {artifact_href}	Delete an artifact
list	GET /api/pulp/{pulp_domain}/api/v3/artifacts/	List artifacts
read	GET {artifact_href}	Inspect an artifact

create

ArtifactResponse create(pulp_domain, file, x_task_diagnostics=x_task_diagnostics, size=size, md5=md5, sha1=sha1, sha224=sha224, sha256=sha256, sha384=sha384, sha512=sha512)

Create an artifact

A customized named ModelViewSet that knows how to register itself with the Pulp API router. This viewset is discoverable by its name. "Normal" Django Models and Master/Detail models are supported by the register_with method. Attributes: lookup_field (str): The name of the field by which an object should be looked up, in addition to any parent lookups if this ViewSet is nested. Defaults to 'pk' endpoint_name (str): The name of the final path segment that should identify the ViewSet's collection endpoint. nest_prefix (str): Optional prefix under which this ViewSet should be nested. This must correspond to the "parent_prefix" of a router with rest_framework_nested.NestedMixin. None indicates this ViewSet should not be nested. parent_lookup_kwargs (dict): Optional mapping of key names that would appear in self.kwargs to django model filter expressions that can be used with the corresponding value from self.kwargs, used only by a nested ViewSet to filter based on the parent object's identity. schema (DefaultSchema): The schema class to use by default in a viewset.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.artifact_response import ArtifactResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ArtifactsApi(api_client)
    pulp_domain = 'pulp_domain_example' # str | 
    file = None # bytearray | The stored file.
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    size = 56 # int | The size of the file in bytes. (optional)
    md5 = 'md5_example' # str | The MD5 checksum of the file if available. (optional)
    sha1 = 'sha1_example' # str | The SHA-1 checksum of the file if available. (optional)
    sha224 = 'sha224_example' # str | The SHA-224 checksum of the file if available. (optional)
    sha256 = 'sha256_example' # str | The SHA-256 checksum of the file if available. (optional)
    sha384 = 'sha384_example' # str | The SHA-384 checksum of the file if available. (optional)
    sha512 = 'sha512_example' # str | The SHA-512 checksum of the file if available. (optional)

    try:
        # Create an artifact
        api_response = api_instance.create(pulp_domain, file, x_task_diagnostics=x_task_diagnostics, size=size, md5=md5, sha1=sha1, sha224=sha224, sha256=sha256, sha384=sha384, sha512=sha512)
        print("The response of ArtifactsApi->create:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ArtifactsApi->create: %s\n" % e)

Parameters

Name	Type	Description	Notes
pulp_domain	str
file	bytearray	The stored file.
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]
size	int	The size of the file in bytes.	[optional]
md5	str	The MD5 checksum of the file if available.	[optional]
sha1	str	The SHA-1 checksum of the file if available.	[optional]
sha224	str	The SHA-224 checksum of the file if available.	[optional]
sha256	str	The SHA-256 checksum of the file if available.	[optional]
sha384	str	The SHA-384 checksum of the file if available.	[optional]
sha512	str	The SHA-512 checksum of the file if available.	[optional]

Return type

ArtifactResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

Content-Type: multipart/form-data, application/x-www-form-urlencoded
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

delete(artifact_href, x_task_diagnostics=x_task_diagnostics)

Delete an artifact

Remove Artifact only if it is not associated with any Content.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

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

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ArtifactsApi(api_client)
    artifact_href = 'artifact_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Delete an artifact
        api_instance.delete(artifact_href, x_task_diagnostics=x_task_diagnostics)
    except Exception as e:
        print("Exception when calling ArtifactsApi->delete: %s\n" % e)

Parameters

Name	Type	Description	Notes
artifact_href	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
204	No response body	-

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

list

PaginatedArtifactResponseList list(pulp_domain, x_task_diagnostics=x_task_diagnostics, limit=limit, md5=md5, offset=offset, ordering=ordering, orphaned_for=orphaned_for, prn__in=prn__in, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, q=q, repository_version=repository_version, sha1=sha1, sha224=sha224, sha256=sha256, sha384=sha384, sha512=sha512, fields=fields, exclude_fields=exclude_fields)

List artifacts

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.paginated_artifact_response_list import PaginatedArtifactResponseList
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ArtifactsApi(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)
    md5 = 'md5_example' # str | Filter results where md5 matches 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) * `file` - File * `-file` - File (descending) * `size` - Size * `-size` - Size (descending) * `md5` - Md5 * `-md5` - Md5 (descending) * `sha1` - Sha1 * `-sha1` - Sha1 (descending) * `sha224` - Sha224 * `-sha224` - Sha224 (descending) * `sha256` - Sha256 * `-sha256` - Sha256 (descending) * `sha384` - Sha384 * `-sha384` - Sha384 (descending) * `sha512` - Sha512 * `-sha512` - Sha512 (descending) * `timestamp_of_interest` - Timestamp of interest * `-timestamp_of_interest` - Timestamp of interest (descending) * `pk` - Pk * `-pk` - Pk (descending) (optional)
    orphaned_for = 3.4 # float | Minutes Artifacts have 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)
    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)
    sha1 = 'sha1_example' # str | Filter results where sha1 matches value (optional)
    sha224 = 'sha224_example' # str | Filter results where sha224 matches value (optional)
    sha256 = 'sha256_example' # str | Filter results where sha256 matches value (optional)
    sha384 = 'sha384_example' # str | Filter results where sha384 matches value (optional)
    sha512 = 'sha512_example' # str | Filter results where sha512 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 artifacts
        api_response = api_instance.list(pulp_domain, x_task_diagnostics=x_task_diagnostics, limit=limit, md5=md5, offset=offset, ordering=ordering, orphaned_for=orphaned_for, prn__in=prn__in, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, q=q, repository_version=repository_version, sha1=sha1, sha224=sha224, sha256=sha256, sha384=sha384, sha512=sha512, fields=fields, exclude_fields=exclude_fields)
        print("The response of ArtifactsApi->list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ArtifactsApi->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]
md5	str	Filter results where md5 matches 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) * `file` - File * `-file` - File (descending) * `size` - Size * `-size` - Size (descending) * `md5` - Md5 * `-md5` - Md5 (descending) * `sha1` - Sha1 * `-sha1` - Sha1 (descending) * `sha224` - Sha224 * `-sha224` - Sha224 (descending) * `sha256` - Sha256 * `-sha256` - Sha256 (descending) * `sha384` - Sha384 * `-sha384` - Sha384 (descending) * `sha512` - Sha512 * `-sha512` - Sha512 (descending) * `timestamp_of_interest` - Timestamp of interest * `-timestamp_of_interest` - Timestamp of interest (descending) * `pk` - Pk * `-pk` - Pk (descending)	[optional]
orphaned_for	float	Minutes Artifacts have 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]
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]
sha1	str	Filter results where sha1 matches value	[optional]
sha224	str	Filter results where sha224 matches value	[optional]
sha256	str	Filter results where sha256 matches value	[optional]
sha384	str	Filter results where sha384 matches value	[optional]
sha512	str	Filter results where sha512 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

PaginatedArtifactResponseList

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

ArtifactResponse read(artifact_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

Inspect an artifact

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.artifact_response import ArtifactResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ArtifactsApi(api_client)
    artifact_href = '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 an artifact
        api_response = api_instance.read(artifact_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of ArtifactsApi->read:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ArtifactsApi->read: %s\n" % e)

Parameters

Name	Type	Description	Notes
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

ArtifactResponse

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]

AsyncOperationResponse

Serializer for asynchronous operations.

Properties

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

Example

from pulpcore.client.pulpcore.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]

CompositeContentGuard

Base class for content guard serializers.

Properties

Name	Type	Description	Notes
name	str	The unique name.
description	str	An optional description.	[optional]
guards	List[Optional[str]]	List of ContentGuards to ask for access-permission.	[optional]

Example

from pulpcore.client.pulpcore.models.composite_content_guard import CompositeContentGuard

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

# convert the object into a dict
composite_content_guard_dict = composite_content_guard_instance.to_dict()
# create an instance of CompositeContentGuard from a dict
composite_content_guard_from_dict = CompositeContentGuard.from_dict(composite_content_guard_dict)

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

CompositeContentGuardResponse

Base class for content guard serializers.

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]
name	str	The unique name.
description	str	An optional description.	[optional]
guards	List[Optional[str]]	List of ContentGuards to ask for access-permission.	[optional]

Example

from pulpcore.client.pulpcore.models.composite_content_guard_response import CompositeContentGuardResponse

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

# convert the object into a dict
composite_content_guard_response_dict = composite_content_guard_response_instance.to_dict()
# create an instance of CompositeContentGuardResponse from a dict
composite_content_guard_response_from_dict = CompositeContentGuardResponse.from_dict(composite_content_guard_response_dict)

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

pulpcore.client.pulpcore.ContentApi

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

Method	HTTP request	Description
list	GET /api/pulp/{pulp_domain}/api/v3/content/	List content

list

PaginatedMultipleArtifactContentResponseList list(pulp_domain, x_task_diagnostics=x_task_diagnostics, 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, pulp_type=pulp_type, pulp_type__in=pulp_type__in, q=q, repository_version=repository_version, repository_version_added=repository_version_added, repository_version_removed=repository_version_removed, fields=fields, exclude_fields=exclude_fields)

List content

Endpoint to list all content.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.paginated_multiple_artifact_content_response_list import PaginatedMultipleArtifactContentResponseList
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ContentApi(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)
    offset = 56 # int | The initial index from which to return the results. (optional)
    ordering = ['ordering_example'] # List[str] | Ordering  * `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)
    pulp_type = 'pulp_type_example' # str | Pulp type  * `core.publishedmetadata` - core.publishedmetadata * `core.openpgp_publickey` - core.openpgp_publickey * `core.openpgp_publicsubkey` - core.openpgp_publicsubkey * `core.openpgp_userid` - core.openpgp_userid * `core.openpgp_userattribute` - core.openpgp_userattribute * `core.openpgp_signature` - core.openpgp_signature * `container.blob` - container.blob * `container.manifest` - container.manifest * `container.tag` - container.tag * `container.signature` - container.signature * `gem.gem` - gem.gem * `hugging_face.hugging-face` - hugging_face.hugging-face * `maven.artifact` - maven.artifact * `maven.metadata` - maven.metadata * `npm.package` - npm.package * `python.python` - python.python * `python.provenance` - python.provenance * `rpm.advisory` - rpm.advisory * `rpm.packagegroup` - rpm.packagegroup * `rpm.packagecategory` - rpm.packagecategory * `rpm.packageenvironment` - rpm.packageenvironment * `rpm.packagelangpacks` - rpm.packagelangpacks * `rpm.repo_metadata_file` - rpm.repo_metadata_file * `rpm.distribution_tree` - rpm.distribution_tree * `rpm.package` - rpm.package * `rpm.modulemd` - rpm.modulemd * `rpm.modulemd_defaults` - rpm.modulemd_defaults * `rpm.modulemd_obsolete` - rpm.modulemd_obsolete * `file.file` - file.file (optional)
    pulp_type__in = ['pulp_type__in_example'] # List[str] | Multiple values may be separated by commas.  * `core.publishedmetadata` - core.publishedmetadata * `core.openpgp_publickey` - core.openpgp_publickey * `core.openpgp_publicsubkey` - core.openpgp_publicsubkey * `core.openpgp_userid` - core.openpgp_userid * `core.openpgp_userattribute` - core.openpgp_userattribute * `core.openpgp_signature` - core.openpgp_signature * `container.blob` - container.blob * `container.manifest` - container.manifest * `container.tag` - container.tag * `container.signature` - container.signature * `gem.gem` - gem.gem * `hugging_face.hugging-face` - hugging_face.hugging-face * `maven.artifact` - maven.artifact * `maven.metadata` - maven.metadata * `npm.package` - npm.package * `python.python` - python.python * `python.provenance` - python.provenance * `rpm.advisory` - rpm.advisory * `rpm.packagegroup` - rpm.packagegroup * `rpm.packagecategory` - rpm.packagecategory * `rpm.packageenvironment` - rpm.packageenvironment * `rpm.packagelangpacks` - rpm.packagelangpacks * `rpm.repo_metadata_file` - rpm.repo_metadata_file * `rpm.distribution_tree` - rpm.distribution_tree * `rpm.package` - rpm.package * `rpm.modulemd` - rpm.modulemd * `rpm.modulemd_defaults` - rpm.modulemd_defaults * `rpm.modulemd_obsolete` - rpm.modulemd_obsolete * `file.file` - file.file (optional)
    q = 'q_example' # str | Filter results by using NOT, AND and OR operations on other filters (optional)
    repository_version = 'repository_version_example' # str | Repository Version referenced by HREF/PRN (optional)
    repository_version_added = 'repository_version_added_example' # str | Repository Version referenced by HREF/PRN (optional)
    repository_version_removed = 'repository_version_removed_example' # str | Repository Version referenced by HREF/PRN (optional)
    fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
    exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)

    try:
        # List content
        api_response = api_instance.list(pulp_domain, x_task_diagnostics=x_task_diagnostics, 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, pulp_type=pulp_type, pulp_type__in=pulp_type__in, q=q, repository_version=repository_version, repository_version_added=repository_version_added, repository_version_removed=repository_version_removed, fields=fields, exclude_fields=exclude_fields)
        print("The response of ContentApi->list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentApi->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]
offset	int	The initial index from which to return the results.	[optional]
ordering	List[str]	Ordering * `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]
pulp_type	str	Pulp type * `core.publishedmetadata` - core.publishedmetadata * `core.openpgp_publickey` - core.openpgp_publickey * `core.openpgp_publicsubkey` - core.openpgp_publicsubkey * `core.openpgp_userid` - core.openpgp_userid * `core.openpgp_userattribute` - core.openpgp_userattribute * `core.openpgp_signature` - core.openpgp_signature * `container.blob` - container.blob * `container.manifest` - container.manifest * `container.tag` - container.tag * `container.signature` - container.signature * `gem.gem` - gem.gem * `hugging_face.hugging-face` - hugging_face.hugging-face * `maven.artifact` - maven.artifact * `maven.metadata` - maven.metadata * `npm.package` - npm.package * `python.python` - python.python * `python.provenance` - python.provenance * `rpm.advisory` - rpm.advisory * `rpm.packagegroup` - rpm.packagegroup * `rpm.packagecategory` - rpm.packagecategory * `rpm.packageenvironment` - rpm.packageenvironment * `rpm.packagelangpacks` - rpm.packagelangpacks * `rpm.repo_metadata_file` - rpm.repo_metadata_file * `rpm.distribution_tree` - rpm.distribution_tree * `rpm.package` - rpm.package * `rpm.modulemd` - rpm.modulemd * `rpm.modulemd_defaults` - rpm.modulemd_defaults * `rpm.modulemd_obsolete` - rpm.modulemd_obsolete * `file.file` - file.file	[optional]
pulp_type__in	List[str]	Multiple values may be separated by commas. * `core.publishedmetadata` - core.publishedmetadata * `core.openpgp_publickey` - core.openpgp_publickey * `core.openpgp_publicsubkey` - core.openpgp_publicsubkey * `core.openpgp_userid` - core.openpgp_userid * `core.openpgp_userattribute` - core.openpgp_userattribute * `core.openpgp_signature` - core.openpgp_signature * `container.blob` - container.blob * `container.manifest` - container.manifest * `container.tag` - container.tag * `container.signature` - container.signature * `gem.gem` - gem.gem * `hugging_face.hugging-face` - hugging_face.hugging-face * `maven.artifact` - maven.artifact * `maven.metadata` - maven.metadata * `npm.package` - npm.package * `python.python` - python.python * `python.provenance` - python.provenance * `rpm.advisory` - rpm.advisory * `rpm.packagegroup` - rpm.packagegroup * `rpm.packagecategory` - rpm.packagecategory * `rpm.packageenvironment` - rpm.packageenvironment * `rpm.packagelangpacks` - rpm.packagelangpacks * `rpm.repo_metadata_file` - rpm.repo_metadata_file * `rpm.distribution_tree` - rpm.distribution_tree * `rpm.package` - rpm.package * `rpm.modulemd` - rpm.modulemd * `rpm.modulemd_defaults` - rpm.modulemd_defaults * `rpm.modulemd_obsolete` - rpm.modulemd_obsolete * `file.file` - file.file	[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]
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

PaginatedMultipleArtifactContentResponseList

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]

ContentGuardResponse

Base class for content guard serializers.

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]
name	str	The unique name.
description	str	An optional description.	[optional]

Example

from pulpcore.client.pulpcore.models.content_guard_response import ContentGuardResponse

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

# convert the object into a dict
content_guard_response_dict = content_guard_response_instance.to_dict()
# create an instance of ContentGuardResponse from a dict
content_guard_response_from_dict = ContentGuardResponse.from_dict(content_guard_response_dict)

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

pulpcore.client.pulpcore.ContentguardsApi

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

Method	HTTP request	Description
list	GET /api/pulp/{pulp_domain}/api/v3/contentguards/	List content guards

list

PaginatedContentGuardResponseList 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_type=pulp_type, pulp_type__in=pulp_type__in, q=q, fields=fields, exclude_fields=exclude_fields)

List content guards

Endpoint to list all contentguards.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.paginated_content_guard_response_list import PaginatedContentGuardResponseList
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ContentguardsApi(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) * `description` - Description * `-description` - Description (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_type = 'pulp_type_example' # str | Pulp type  * `core.rbac` - core.rbac * `core.content_redirect` - core.content_redirect * `core.header` - core.header * `core.composite` - core.composite * `certguard.rhsm` - certguard.rhsm * `certguard.x509` - certguard.x509 (optional)
    pulp_type__in = ['pulp_type__in_example'] # List[str] | Multiple values may be separated by commas.  * `core.rbac` - core.rbac * `core.content_redirect` - core.content_redirect * `core.header` - core.header * `core.composite` - core.composite * `certguard.rhsm` - certguard.rhsm * `certguard.x509` - certguard.x509 (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 content guards
        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_type=pulp_type, pulp_type__in=pulp_type__in, q=q, fields=fields, exclude_fields=exclude_fields)
        print("The response of ContentguardsApi->list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentguardsApi->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) * `description` - Description * `-description` - Description (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_type	str	Pulp type * `core.rbac` - core.rbac * `core.content_redirect` - core.content_redirect * `core.header` - core.header * `core.composite` - core.composite * `certguard.rhsm` - certguard.rhsm * `certguard.x509` - certguard.x509	[optional]
pulp_type__in	List[str]	Multiple values may be separated by commas. * `core.rbac` - core.rbac * `core.content_redirect` - core.content_redirect * `core.header` - core.header * `core.composite` - core.composite * `certguard.rhsm` - certguard.rhsm * `certguard.x509` - certguard.x509	[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

PaginatedContentGuardResponseList

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]

pulpcore.client.pulpcore.ContentguardsCompositeApi

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

Method	HTTP request	Description
add_role	POST {composite_content_guard_href}add_role/	Add a role
create	POST /api/pulp/{pulp_domain}/api/v3/contentguards/core/composite/	Create a composite content guard
delete	DELETE {composite_content_guard_href}	Delete a composite content guard
list	GET /api/pulp/{pulp_domain}/api/v3/contentguards/core/composite/	List composite content guards
list_roles	GET {composite_content_guard_href}list_roles/	List roles
my_permissions	GET {composite_content_guard_href}my_permissions/	List user permissions
partial_update	PATCH {composite_content_guard_href}	Update a composite content guard
read	GET {composite_content_guard_href}	Inspect a composite content guard
remove_role	POST {composite_content_guard_href}remove_role/	Remove a role
update	PUT {composite_content_guard_href}	Update a composite content guard

add_role

NestedRoleResponse add_role(composite_content_guard_href, nested_role, x_task_diagnostics=x_task_diagnostics)

Add a role

Add a role for this object to users/groups.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.nested_role import NestedRole
from pulpcore.client.pulpcore.models.nested_role_response import NestedRoleResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ContentguardsCompositeApi(api_client)
    composite_content_guard_href = 'composite_content_guard_href_example' # str | 
    nested_role = pulpcore.client.pulpcore.NestedRole() # NestedRole | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Add a role
        api_response = api_instance.add_role(composite_content_guard_href, nested_role, x_task_diagnostics=x_task_diagnostics)
        print("The response of ContentguardsCompositeApi->add_role:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentguardsCompositeApi->add_role: %s\n" % e)

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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]

create

CompositeContentGuardResponse create(pulp_domain, composite_content_guard, x_task_diagnostics=x_task_diagnostics)

Create a composite content guard

Content guard that queries a list-of content-guards for access permissions.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.composite_content_guard import CompositeContentGuard
from pulpcore.client.pulpcore.models.composite_content_guard_response import CompositeContentGuardResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ContentguardsCompositeApi(api_client)
    pulp_domain = 'pulp_domain_example' # str | 
    composite_content_guard = pulpcore.client.pulpcore.CompositeContentGuard() # CompositeContentGuard | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Create a composite content guard
        api_response = api_instance.create(pulp_domain, composite_content_guard, x_task_diagnostics=x_task_diagnostics)
        print("The response of ContentguardsCompositeApi->create:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentguardsCompositeApi->create: %s\n" % e)

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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

delete(composite_content_guard_href, x_task_diagnostics=x_task_diagnostics)

Delete a composite content guard

Content guard that queries a list-of content-guards for access permissions.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

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

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ContentguardsCompositeApi(api_client)
    composite_content_guard_href = 'composite_content_guard_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Delete a composite content guard
        api_instance.delete(composite_content_guard_href, x_task_diagnostics=x_task_diagnostics)
    except Exception as e:
        print("Exception when calling ContentguardsCompositeApi->delete: %s\n" % e)

Parameters

Name	Type	Description	Notes
composite_content_guard_href	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
204	No response body	-

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

list

PaginatedCompositeContentGuardResponseList 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, q=q, fields=fields, exclude_fields=exclude_fields)

List composite content guards

Content guard that queries a list-of content-guards for access permissions.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.paginated_composite_content_guard_response_list import PaginatedCompositeContentGuardResponseList
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ContentguardsCompositeApi(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) * `description` - Description * `-description` - Description (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)
    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 composite content guards
        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, q=q, fields=fields, exclude_fields=exclude_fields)
        print("The response of ContentguardsCompositeApi->list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentguardsCompositeApi->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) * `description` - Description * `-description` - Description (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]
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

PaginatedCompositeContentGuardResponseList

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]

list_roles

ObjectRolesResponse list_roles(composite_content_guard_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

List roles

List roles assigned to this object.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.object_roles_response import ObjectRolesResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ContentguardsCompositeApi(api_client)
    composite_content_guard_href = 'composite_content_guard_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:
        # List roles
        api_response = api_instance.list_roles(composite_content_guard_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of ContentguardsCompositeApi->list_roles:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentguardsCompositeApi->list_roles: %s\n" % e)

Parameters

Name	Type	Description	Notes
composite_content_guard_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

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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]

my_permissions

MyPermissionsResponse my_permissions(composite_content_guard_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

List user permissions

List permissions available to the current user on this object.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.my_permissions_response import MyPermissionsResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ContentguardsCompositeApi(api_client)
    composite_content_guard_href = 'composite_content_guard_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:
        # List user permissions
        api_response = api_instance.my_permissions(composite_content_guard_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of ContentguardsCompositeApi->my_permissions:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentguardsCompositeApi->my_permissions: %s\n" % e)

Parameters

Name	Type	Description	Notes
composite_content_guard_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

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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

CompositeContentGuardResponse partial_update(composite_content_guard_href, patched_composite_content_guard, x_task_diagnostics=x_task_diagnostics)

Update a composite content guard

Content guard that queries a list-of content-guards for access permissions.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.composite_content_guard_response import CompositeContentGuardResponse
from pulpcore.client.pulpcore.models.patched_composite_content_guard import PatchedCompositeContentGuard
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ContentguardsCompositeApi(api_client)
    composite_content_guard_href = 'composite_content_guard_href_example' # str | 
    patched_composite_content_guard = pulpcore.client.pulpcore.PatchedCompositeContentGuard() # PatchedCompositeContentGuard | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Update a composite content guard
        api_response = api_instance.partial_update(composite_content_guard_href, patched_composite_content_guard, x_task_diagnostics=x_task_diagnostics)
        print("The response of ContentguardsCompositeApi->partial_update:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentguardsCompositeApi->partial_update: %s\n" % e)

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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]

read

CompositeContentGuardResponse read(composite_content_guard_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

Inspect a composite content guard

Content guard that queries a list-of content-guards for access permissions.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.composite_content_guard_response import CompositeContentGuardResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ContentguardsCompositeApi(api_client)
    composite_content_guard_href = 'composite_content_guard_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 composite content guard
        api_response = api_instance.read(composite_content_guard_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of ContentguardsCompositeApi->read:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentguardsCompositeApi->read: %s\n" % e)

Parameters

Name	Type	Description	Notes
composite_content_guard_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

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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]

remove_role

NestedRoleResponse remove_role(composite_content_guard_href, nested_role, x_task_diagnostics=x_task_diagnostics)

Remove a role

Remove a role for this object from users/groups.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.nested_role import NestedRole
from pulpcore.client.pulpcore.models.nested_role_response import NestedRoleResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ContentguardsCompositeApi(api_client)
    composite_content_guard_href = 'composite_content_guard_href_example' # str | 
    nested_role = pulpcore.client.pulpcore.NestedRole() # NestedRole | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Remove a role
        api_response = api_instance.remove_role(composite_content_guard_href, nested_role, x_task_diagnostics=x_task_diagnostics)
        print("The response of ContentguardsCompositeApi->remove_role:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentguardsCompositeApi->remove_role: %s\n" % e)

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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

CompositeContentGuardResponse update(composite_content_guard_href, composite_content_guard, x_task_diagnostics=x_task_diagnostics)

Update a composite content guard

Content guard that queries a list-of content-guards for access permissions.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.composite_content_guard import CompositeContentGuard
from pulpcore.client.pulpcore.models.composite_content_guard_response import CompositeContentGuardResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ContentguardsCompositeApi(api_client)
    composite_content_guard_href = 'composite_content_guard_href_example' # str | 
    composite_content_guard = pulpcore.client.pulpcore.CompositeContentGuard() # CompositeContentGuard | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Update a composite content guard
        api_response = api_instance.update(composite_content_guard_href, composite_content_guard, x_task_diagnostics=x_task_diagnostics)
        print("The response of ContentguardsCompositeApi->update:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentguardsCompositeApi->update: %s\n" % e)

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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]

pulpcore.client.pulpcore.ContentguardsContentRedirectApi

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

Method	HTTP request	Description
add_role	POST {content_redirect_content_guard_href}add_role/	Add a role
create	POST /api/pulp/{pulp_domain}/api/v3/contentguards/core/content_redirect/	Create a content redirect content guard
delete	DELETE {content_redirect_content_guard_href}	Delete a content redirect content guard
list	GET /api/pulp/{pulp_domain}/api/v3/contentguards/core/content_redirect/	List content redirect content guards
list_roles	GET {content_redirect_content_guard_href}list_roles/	List roles
my_permissions	GET {content_redirect_content_guard_href}my_permissions/	List user permissions
partial_update	PATCH {content_redirect_content_guard_href}	Update a content redirect content guard
read	GET {content_redirect_content_guard_href}	Inspect a content redirect content guard
remove_role	POST {content_redirect_content_guard_href}remove_role/	Remove a role
update	PUT {content_redirect_content_guard_href}	Update a content redirect content guard

add_role

NestedRoleResponse add_role(content_redirect_content_guard_href, nested_role, x_task_diagnostics=x_task_diagnostics)

Add a role

Add a role for this object to users/groups.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.nested_role import NestedRole
from pulpcore.client.pulpcore.models.nested_role_response import NestedRoleResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ContentguardsContentRedirectApi(api_client)
    content_redirect_content_guard_href = 'content_redirect_content_guard_href_example' # str | 
    nested_role = pulpcore.client.pulpcore.NestedRole() # NestedRole | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Add a role
        api_response = api_instance.add_role(content_redirect_content_guard_href, nested_role, x_task_diagnostics=x_task_diagnostics)
        print("The response of ContentguardsContentRedirectApi->add_role:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentguardsContentRedirectApi->add_role: %s\n" % e)

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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]

create

ContentRedirectContentGuardResponse create(pulp_domain, content_redirect_content_guard, x_task_diagnostics=x_task_diagnostics)

Create a content redirect content guard

Content guard to protect preauthenticated redirects to the content app.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.content_redirect_content_guard import ContentRedirectContentGuard
from pulpcore.client.pulpcore.models.content_redirect_content_guard_response import ContentRedirectContentGuardResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ContentguardsContentRedirectApi(api_client)
    pulp_domain = 'pulp_domain_example' # str | 
    content_redirect_content_guard = pulpcore.client.pulpcore.ContentRedirectContentGuard() # ContentRedirectContentGuard | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Create a content redirect content guard
        api_response = api_instance.create(pulp_domain, content_redirect_content_guard, x_task_diagnostics=x_task_diagnostics)
        print("The response of ContentguardsContentRedirectApi->create:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentguardsContentRedirectApi->create: %s\n" % e)

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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

delete(content_redirect_content_guard_href, x_task_diagnostics=x_task_diagnostics)

Delete a content redirect content guard

Content guard to protect preauthenticated redirects to the content app.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

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

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ContentguardsContentRedirectApi(api_client)
    content_redirect_content_guard_href = 'content_redirect_content_guard_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Delete a content redirect content guard
        api_instance.delete(content_redirect_content_guard_href, x_task_diagnostics=x_task_diagnostics)
    except Exception as e:
        print("Exception when calling ContentguardsContentRedirectApi->delete: %s\n" % e)

Parameters

Name	Type	Description	Notes
content_redirect_content_guard_href	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
204	No response body	-

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

list

PaginatedContentRedirectContentGuardResponseList 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, q=q, fields=fields, exclude_fields=exclude_fields)

List content redirect content guards

Content guard to protect preauthenticated redirects to the content app.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.paginated_content_redirect_content_guard_response_list import PaginatedContentRedirectContentGuardResponseList
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ContentguardsContentRedirectApi(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) * `description` - Description * `-description` - Description (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)
    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 content redirect content guards
        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, q=q, fields=fields, exclude_fields=exclude_fields)
        print("The response of ContentguardsContentRedirectApi->list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentguardsContentRedirectApi->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) * `description` - Description * `-description` - Description (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]
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

PaginatedContentRedirectContentGuardResponseList

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]

list_roles

ObjectRolesResponse list_roles(content_redirect_content_guard_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

List roles

List roles assigned to this object.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.object_roles_response import ObjectRolesResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ContentguardsContentRedirectApi(api_client)
    content_redirect_content_guard_href = 'content_redirect_content_guard_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:
        # List roles
        api_response = api_instance.list_roles(content_redirect_content_guard_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of ContentguardsContentRedirectApi->list_roles:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentguardsContentRedirectApi->list_roles: %s\n" % e)

Parameters

Name	Type	Description	Notes
content_redirect_content_guard_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

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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]

my_permissions

MyPermissionsResponse my_permissions(content_redirect_content_guard_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

List user permissions

List permissions available to the current user on this object.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.my_permissions_response import MyPermissionsResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ContentguardsContentRedirectApi(api_client)
    content_redirect_content_guard_href = 'content_redirect_content_guard_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:
        # List user permissions
        api_response = api_instance.my_permissions(content_redirect_content_guard_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of ContentguardsContentRedirectApi->my_permissions:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentguardsContentRedirectApi->my_permissions: %s\n" % e)

Parameters

Name	Type	Description	Notes
content_redirect_content_guard_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

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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

ContentRedirectContentGuardResponse partial_update(content_redirect_content_guard_href, patched_content_redirect_content_guard, x_task_diagnostics=x_task_diagnostics)

Update a content redirect content guard

Content guard to protect preauthenticated redirects to the content app.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.content_redirect_content_guard_response import ContentRedirectContentGuardResponse
from pulpcore.client.pulpcore.models.patched_content_redirect_content_guard import PatchedContentRedirectContentGuard
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ContentguardsContentRedirectApi(api_client)
    content_redirect_content_guard_href = 'content_redirect_content_guard_href_example' # str | 
    patched_content_redirect_content_guard = pulpcore.client.pulpcore.PatchedContentRedirectContentGuard() # PatchedContentRedirectContentGuard | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Update a content redirect content guard
        api_response = api_instance.partial_update(content_redirect_content_guard_href, patched_content_redirect_content_guard, x_task_diagnostics=x_task_diagnostics)
        print("The response of ContentguardsContentRedirectApi->partial_update:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentguardsContentRedirectApi->partial_update: %s\n" % e)

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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]

read

ContentRedirectContentGuardResponse read(content_redirect_content_guard_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

Inspect a content redirect content guard

Content guard to protect preauthenticated redirects to the content app.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.content_redirect_content_guard_response import ContentRedirectContentGuardResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ContentguardsContentRedirectApi(api_client)
    content_redirect_content_guard_href = 'content_redirect_content_guard_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 content redirect content guard
        api_response = api_instance.read(content_redirect_content_guard_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of ContentguardsContentRedirectApi->read:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentguardsContentRedirectApi->read: %s\n" % e)

Parameters

Name	Type	Description	Notes
content_redirect_content_guard_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

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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]

remove_role

NestedRoleResponse remove_role(content_redirect_content_guard_href, nested_role, x_task_diagnostics=x_task_diagnostics)

Remove a role

Remove a role for this object from users/groups.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.nested_role import NestedRole
from pulpcore.client.pulpcore.models.nested_role_response import NestedRoleResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ContentguardsContentRedirectApi(api_client)
    content_redirect_content_guard_href = 'content_redirect_content_guard_href_example' # str | 
    nested_role = pulpcore.client.pulpcore.NestedRole() # NestedRole | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Remove a role
        api_response = api_instance.remove_role(content_redirect_content_guard_href, nested_role, x_task_diagnostics=x_task_diagnostics)
        print("The response of ContentguardsContentRedirectApi->remove_role:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentguardsContentRedirectApi->remove_role: %s\n" % e)

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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

ContentRedirectContentGuardResponse update(content_redirect_content_guard_href, content_redirect_content_guard, x_task_diagnostics=x_task_diagnostics)

Update a content redirect content guard

Content guard to protect preauthenticated redirects to the content app.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.content_redirect_content_guard import ContentRedirectContentGuard
from pulpcore.client.pulpcore.models.content_redirect_content_guard_response import ContentRedirectContentGuardResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ContentguardsContentRedirectApi(api_client)
    content_redirect_content_guard_href = 'content_redirect_content_guard_href_example' # str | 
    content_redirect_content_guard = pulpcore.client.pulpcore.ContentRedirectContentGuard() # ContentRedirectContentGuard | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Update a content redirect content guard
        api_response = api_instance.update(content_redirect_content_guard_href, content_redirect_content_guard, x_task_diagnostics=x_task_diagnostics)
        print("The response of ContentguardsContentRedirectApi->update:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentguardsContentRedirectApi->update: %s\n" % e)

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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]

pulpcore.client.pulpcore.ContentguardsHeaderApi

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

Method	HTTP request	Description
add_role	POST {header_content_guard_href}add_role/	Add a role
create	POST /api/pulp/{pulp_domain}/api/v3/contentguards/core/header/	Create a header content guard
delete	DELETE {header_content_guard_href}	Delete a header content guard
list	GET /api/pulp/{pulp_domain}/api/v3/contentguards/core/header/	List header content guards
list_roles	GET {header_content_guard_href}list_roles/	List roles
my_permissions	GET {header_content_guard_href}my_permissions/	List user permissions
partial_update	PATCH {header_content_guard_href}	Update a header content guard
read	GET {header_content_guard_href}	Inspect a header content guard
remove_role	POST {header_content_guard_href}remove_role/	Remove a role
update	PUT {header_content_guard_href}	Update a header content guard

add_role

NestedRoleResponse add_role(header_content_guard_href, nested_role, x_task_diagnostics=x_task_diagnostics)

Add a role

Add a role for this object to users/groups.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.nested_role import NestedRole
from pulpcore.client.pulpcore.models.nested_role_response import NestedRoleResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ContentguardsHeaderApi(api_client)
    header_content_guard_href = 'header_content_guard_href_example' # str | 
    nested_role = pulpcore.client.pulpcore.NestedRole() # NestedRole | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Add a role
        api_response = api_instance.add_role(header_content_guard_href, nested_role, x_task_diagnostics=x_task_diagnostics)
        print("The response of ContentguardsHeaderApi->add_role:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentguardsHeaderApi->add_role: %s\n" % e)

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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]

create

HeaderContentGuardResponse create(pulp_domain, header_content_guard, x_task_diagnostics=x_task_diagnostics)

Create a header content guard

Content guard to protect the content app using a specific header.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.header_content_guard import HeaderContentGuard
from pulpcore.client.pulpcore.models.header_content_guard_response import HeaderContentGuardResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ContentguardsHeaderApi(api_client)
    pulp_domain = 'pulp_domain_example' # str | 
    header_content_guard = pulpcore.client.pulpcore.HeaderContentGuard() # HeaderContentGuard | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Create a header content guard
        api_response = api_instance.create(pulp_domain, header_content_guard, x_task_diagnostics=x_task_diagnostics)
        print("The response of ContentguardsHeaderApi->create:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentguardsHeaderApi->create: %s\n" % e)

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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

delete(header_content_guard_href, x_task_diagnostics=x_task_diagnostics)

Delete a header content guard

Content guard to protect the content app using a specific header.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

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

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ContentguardsHeaderApi(api_client)
    header_content_guard_href = 'header_content_guard_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Delete a header content guard
        api_instance.delete(header_content_guard_href, x_task_diagnostics=x_task_diagnostics)
    except Exception as e:
        print("Exception when calling ContentguardsHeaderApi->delete: %s\n" % e)

Parameters

Name	Type	Description	Notes
header_content_guard_href	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
204	No response body	-

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

list

PaginatedHeaderContentGuardResponseList 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, q=q, fields=fields, exclude_fields=exclude_fields)

List header content guards

Content guard to protect the content app using a specific header.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.paginated_header_content_guard_response_list import PaginatedHeaderContentGuardResponseList
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ContentguardsHeaderApi(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) * `description` - Description * `-description` - Description (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)
    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 header content guards
        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, q=q, fields=fields, exclude_fields=exclude_fields)
        print("The response of ContentguardsHeaderApi->list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentguardsHeaderApi->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) * `description` - Description * `-description` - Description (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]
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

PaginatedHeaderContentGuardResponseList

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]

list_roles

ObjectRolesResponse list_roles(header_content_guard_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

List roles

List roles assigned to this object.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.object_roles_response import ObjectRolesResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ContentguardsHeaderApi(api_client)
    header_content_guard_href = 'header_content_guard_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:
        # List roles
        api_response = api_instance.list_roles(header_content_guard_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of ContentguardsHeaderApi->list_roles:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentguardsHeaderApi->list_roles: %s\n" % e)

Parameters

Name	Type	Description	Notes
header_content_guard_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

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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]

my_permissions

MyPermissionsResponse my_permissions(header_content_guard_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

List user permissions

List permissions available to the current user on this object.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.my_permissions_response import MyPermissionsResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ContentguardsHeaderApi(api_client)
    header_content_guard_href = 'header_content_guard_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:
        # List user permissions
        api_response = api_instance.my_permissions(header_content_guard_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of ContentguardsHeaderApi->my_permissions:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentguardsHeaderApi->my_permissions: %s\n" % e)

Parameters

Name	Type	Description	Notes
header_content_guard_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

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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

HeaderContentGuardResponse partial_update(header_content_guard_href, patched_header_content_guard, x_task_diagnostics=x_task_diagnostics)

Update a header content guard

Content guard to protect the content app using a specific header.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.header_content_guard_response import HeaderContentGuardResponse
from pulpcore.client.pulpcore.models.patched_header_content_guard import PatchedHeaderContentGuard
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ContentguardsHeaderApi(api_client)
    header_content_guard_href = 'header_content_guard_href_example' # str | 
    patched_header_content_guard = pulpcore.client.pulpcore.PatchedHeaderContentGuard() # PatchedHeaderContentGuard | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Update a header content guard
        api_response = api_instance.partial_update(header_content_guard_href, patched_header_content_guard, x_task_diagnostics=x_task_diagnostics)
        print("The response of ContentguardsHeaderApi->partial_update:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentguardsHeaderApi->partial_update: %s\n" % e)

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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]

read

HeaderContentGuardResponse read(header_content_guard_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

Inspect a header content guard

Content guard to protect the content app using a specific header.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.header_content_guard_response import HeaderContentGuardResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ContentguardsHeaderApi(api_client)
    header_content_guard_href = 'header_content_guard_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 header content guard
        api_response = api_instance.read(header_content_guard_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of ContentguardsHeaderApi->read:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentguardsHeaderApi->read: %s\n" % e)

Parameters

Name	Type	Description	Notes
header_content_guard_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

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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]

remove_role

NestedRoleResponse remove_role(header_content_guard_href, nested_role, x_task_diagnostics=x_task_diagnostics)

Remove a role

Remove a role for this object from users/groups.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.nested_role import NestedRole
from pulpcore.client.pulpcore.models.nested_role_response import NestedRoleResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ContentguardsHeaderApi(api_client)
    header_content_guard_href = 'header_content_guard_href_example' # str | 
    nested_role = pulpcore.client.pulpcore.NestedRole() # NestedRole | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Remove a role
        api_response = api_instance.remove_role(header_content_guard_href, nested_role, x_task_diagnostics=x_task_diagnostics)
        print("The response of ContentguardsHeaderApi->remove_role:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentguardsHeaderApi->remove_role: %s\n" % e)

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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

HeaderContentGuardResponse update(header_content_guard_href, header_content_guard, x_task_diagnostics=x_task_diagnostics)

Update a header content guard

Content guard to protect the content app using a specific header.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.header_content_guard import HeaderContentGuard
from pulpcore.client.pulpcore.models.header_content_guard_response import HeaderContentGuardResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ContentguardsHeaderApi(api_client)
    header_content_guard_href = 'header_content_guard_href_example' # str | 
    header_content_guard = pulpcore.client.pulpcore.HeaderContentGuard() # HeaderContentGuard | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Update a header content guard
        api_response = api_instance.update(header_content_guard_href, header_content_guard, x_task_diagnostics=x_task_diagnostics)
        print("The response of ContentguardsHeaderApi->update:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentguardsHeaderApi->update: %s\n" % e)

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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]

pulpcore.client.pulpcore.ContentguardsRbacApi

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

Method	HTTP request	Description
add_role	POST {r_b_a_c_content_guard_href}add_role/	Add a role
create	POST /api/pulp/{pulp_domain}/api/v3/contentguards/core/rbac/	Create a rbac content guard
delete	DELETE {r_b_a_c_content_guard_href}	Delete a rbac content guard
list	GET /api/pulp/{pulp_domain}/api/v3/contentguards/core/rbac/	List rbac content guards
list_roles	GET {r_b_a_c_content_guard_href}list_roles/	List roles
my_permissions	GET {r_b_a_c_content_guard_href}my_permissions/	List user permissions
partial_update	PATCH {r_b_a_c_content_guard_href}	Update a rbac content guard
read	GET {r_b_a_c_content_guard_href}	Inspect a rbac content guard
remove_role	POST {r_b_a_c_content_guard_href}remove_role/	Remove a role
update	PUT {r_b_a_c_content_guard_href}	Update a rbac content guard

add_role

NestedRoleResponse add_role(r_b_a_c_content_guard_href, nested_role, x_task_diagnostics=x_task_diagnostics)

Add a role

Add a role for this object to users/groups.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.nested_role import NestedRole
from pulpcore.client.pulpcore.models.nested_role_response import NestedRoleResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ContentguardsRbacApi(api_client)
    r_b_a_c_content_guard_href = 'r_b_a_c_content_guard_href_example' # str | 
    nested_role = pulpcore.client.pulpcore.NestedRole() # NestedRole | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Add a role
        api_response = api_instance.add_role(r_b_a_c_content_guard_href, nested_role, x_task_diagnostics=x_task_diagnostics)
        print("The response of ContentguardsRbacApi->add_role:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentguardsRbacApi->add_role: %s\n" % e)

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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]

create

RBACContentGuardResponse create(pulp_domain, rbac_content_guard, x_task_diagnostics=x_task_diagnostics)

Create a rbac content guard

Viewset for creating contentguards that use RBAC to protect content. Has add and remove actions for managing permission for users and groups to download content protected by this guard.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.rbac_content_guard import RBACContentGuard
from pulpcore.client.pulpcore.models.rbac_content_guard_response import RBACContentGuardResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ContentguardsRbacApi(api_client)
    pulp_domain = 'pulp_domain_example' # str | 
    rbac_content_guard = pulpcore.client.pulpcore.RBACContentGuard() # RBACContentGuard | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Create a rbac content guard
        api_response = api_instance.create(pulp_domain, rbac_content_guard, x_task_diagnostics=x_task_diagnostics)
        print("The response of ContentguardsRbacApi->create:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentguardsRbacApi->create: %s\n" % e)

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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

delete(r_b_a_c_content_guard_href, x_task_diagnostics=x_task_diagnostics)

Delete a rbac content guard

Viewset for creating contentguards that use RBAC to protect content. Has add and remove actions for managing permission for users and groups to download content protected by this guard.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

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

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ContentguardsRbacApi(api_client)
    r_b_a_c_content_guard_href = 'r_b_a_c_content_guard_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Delete a rbac content guard
        api_instance.delete(r_b_a_c_content_guard_href, x_task_diagnostics=x_task_diagnostics)
    except Exception as e:
        print("Exception when calling ContentguardsRbacApi->delete: %s\n" % e)

Parameters

Name	Type	Description	Notes
r_b_a_c_content_guard_href	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
204	No response body	-

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

list

PaginatedRBACContentGuardResponseList 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, q=q, fields=fields, exclude_fields=exclude_fields)

List rbac content guards

Viewset for creating contentguards that use RBAC to protect content. Has add and remove actions for managing permission for users and groups to download content protected by this guard.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.paginated_rbac_content_guard_response_list import PaginatedRBACContentGuardResponseList
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ContentguardsRbacApi(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) * `description` - Description * `-description` - Description (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)
    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 rbac content guards
        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, q=q, fields=fields, exclude_fields=exclude_fields)
        print("The response of ContentguardsRbacApi->list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentguardsRbacApi->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) * `description` - Description * `-description` - Description (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]
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

PaginatedRBACContentGuardResponseList

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]

list_roles

ObjectRolesResponse list_roles(r_b_a_c_content_guard_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

List roles

List roles assigned to this object.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.object_roles_response import ObjectRolesResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ContentguardsRbacApi(api_client)
    r_b_a_c_content_guard_href = 'r_b_a_c_content_guard_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:
        # List roles
        api_response = api_instance.list_roles(r_b_a_c_content_guard_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of ContentguardsRbacApi->list_roles:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentguardsRbacApi->list_roles: %s\n" % e)

Parameters

Name	Type	Description	Notes
r_b_a_c_content_guard_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

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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]

my_permissions

MyPermissionsResponse my_permissions(r_b_a_c_content_guard_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

List user permissions

List permissions available to the current user on this object.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.my_permissions_response import MyPermissionsResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ContentguardsRbacApi(api_client)
    r_b_a_c_content_guard_href = 'r_b_a_c_content_guard_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:
        # List user permissions
        api_response = api_instance.my_permissions(r_b_a_c_content_guard_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of ContentguardsRbacApi->my_permissions:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentguardsRbacApi->my_permissions: %s\n" % e)

Parameters

Name	Type	Description	Notes
r_b_a_c_content_guard_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

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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

RBACContentGuardResponse partial_update(r_b_a_c_content_guard_href, patched_rbac_content_guard, x_task_diagnostics=x_task_diagnostics)

Update a rbac content guard

Viewset for creating contentguards that use RBAC to protect content. Has add and remove actions for managing permission for users and groups to download content protected by this guard.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.patched_rbac_content_guard import PatchedRBACContentGuard
from pulpcore.client.pulpcore.models.rbac_content_guard_response import RBACContentGuardResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ContentguardsRbacApi(api_client)
    r_b_a_c_content_guard_href = 'r_b_a_c_content_guard_href_example' # str | 
    patched_rbac_content_guard = pulpcore.client.pulpcore.PatchedRBACContentGuard() # PatchedRBACContentGuard | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Update a rbac content guard
        api_response = api_instance.partial_update(r_b_a_c_content_guard_href, patched_rbac_content_guard, x_task_diagnostics=x_task_diagnostics)
        print("The response of ContentguardsRbacApi->partial_update:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentguardsRbacApi->partial_update: %s\n" % e)

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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]

read

RBACContentGuardResponse read(r_b_a_c_content_guard_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

Inspect a rbac content guard

Viewset for creating contentguards that use RBAC to protect content. Has add and remove actions for managing permission for users and groups to download content protected by this guard.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.rbac_content_guard_response import RBACContentGuardResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ContentguardsRbacApi(api_client)
    r_b_a_c_content_guard_href = 'r_b_a_c_content_guard_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 rbac content guard
        api_response = api_instance.read(r_b_a_c_content_guard_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of ContentguardsRbacApi->read:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentguardsRbacApi->read: %s\n" % e)

Parameters

Name	Type	Description	Notes
r_b_a_c_content_guard_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

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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]

remove_role

NestedRoleResponse remove_role(r_b_a_c_content_guard_href, nested_role, x_task_diagnostics=x_task_diagnostics)

Remove a role

Remove a role for this object from users/groups.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.nested_role import NestedRole
from pulpcore.client.pulpcore.models.nested_role_response import NestedRoleResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ContentguardsRbacApi(api_client)
    r_b_a_c_content_guard_href = 'r_b_a_c_content_guard_href_example' # str | 
    nested_role = pulpcore.client.pulpcore.NestedRole() # NestedRole | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Remove a role
        api_response = api_instance.remove_role(r_b_a_c_content_guard_href, nested_role, x_task_diagnostics=x_task_diagnostics)
        print("The response of ContentguardsRbacApi->remove_role:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentguardsRbacApi->remove_role: %s\n" % e)

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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

RBACContentGuardResponse update(r_b_a_c_content_guard_href, rbac_content_guard, x_task_diagnostics=x_task_diagnostics)

Update a rbac content guard

Viewset for creating contentguards that use RBAC to protect content. Has add and remove actions for managing permission for users and groups to download content protected by this guard.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.rbac_content_guard import RBACContentGuard
from pulpcore.client.pulpcore.models.rbac_content_guard_response import RBACContentGuardResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ContentguardsRbacApi(api_client)
    r_b_a_c_content_guard_href = 'r_b_a_c_content_guard_href_example' # str | 
    rbac_content_guard = pulpcore.client.pulpcore.RBACContentGuard() # RBACContentGuard | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Update a rbac content guard
        api_response = api_instance.update(r_b_a_c_content_guard_href, rbac_content_guard, x_task_diagnostics=x_task_diagnostics)
        print("The response of ContentguardsRbacApi->update:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentguardsRbacApi->update: %s\n" % e)

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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]

pulpcore.client.pulpcore.ContentOpenpgpPublickeyApi

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

Method	HTTP request	Description
create	POST /api/pulp/{pulp_domain}/api/v3/content/core/openpgp_publickey/	Create an open pgp public key
list	GET /api/pulp/{pulp_domain}/api/v3/content/core/openpgp_publickey/	List open pgp public keys
read	GET {open_p_g_p_public_key_href}	Inspect an open pgp public key
set_label	POST {open_p_g_p_public_key_href}set_label/	Set a label
unset_label	POST {open_p_g_p_public_key_href}unset_label/	Unset a label

create

AsyncOperationResponse create(pulp_domain, x_task_diagnostics=x_task_diagnostics, repository=repository, pulp_labels=pulp_labels, file=file, upload=upload, file_url=file_url, downloader_config=downloader_config)

Create an open pgp public key

Trigger an asynchronous task to create content,optionally create new repository version.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.async_operation_response import AsyncOperationResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ContentOpenpgpPublickeyApi(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)
    repository = 'repository_example' # str | A URI of a repository the new content unit should be associated with. (optional)
    pulp_labels = None # Dict[str, Optional[str]] | A dictionary of arbitrary key/value pairs used to describe a specific Content instance. (optional)
    file = None # bytearray | An uploaded file that may be turned into the content unit. (optional)
    upload = 'upload_example' # str | An uncommitted upload that may be turned into the content unit. (optional)
    file_url = 'file_url_example' # str | A url that Pulp can download and turn into the content unit. (optional)
    downloader_config = pulpcore.client.pulpcore.RemoteNetworkConfig() # RemoteNetworkConfig | Configuration for the download process (e.g., proxies, auth, timeouts). Only applicable when providing a 'file_url. (optional)

    try:
        # Create an open pgp public key
        api_response = api_instance.create(pulp_domain, x_task_diagnostics=x_task_diagnostics, repository=repository, pulp_labels=pulp_labels, file=file, upload=upload, file_url=file_url, downloader_config=downloader_config)
        print("The response of ContentOpenpgpPublickeyApi->create:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentOpenpgpPublickeyApi->create: %s\n" % e)

Parameters

Name	Type	Description	Notes
pulp_domain	str
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]
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]
file	bytearray	An uploaded file that may be turned into the content unit.	[optional]
upload	str	An uncommitted upload that may be turned into the content unit.	[optional]
file_url	str	A url that Pulp can download and turn into the content unit.	[optional]
downloader_config	RemoteNetworkConfig	Configuration for the download process (e.g., proxies, auth, timeouts). Only applicable when providing a 'file_url.	[optional]

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

HTTP request headers

Content-Type: multipart/form-data, application/x-www-form-urlencoded
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

PaginatedOpenPGPPublicKeyResponseList list(pulp_domain, x_task_diagnostics=x_task_diagnostics, fingerprint=fingerprint, limit=limit, offset=offset, ordering=ordering, orphaned_for=orphaned_for, prn__in=prn__in, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, pulp_label_select=pulp_label_select, q=q, repository_version=repository_version, repository_version_added=repository_version_added, repository_version_removed=repository_version_removed, fields=fields, exclude_fields=exclude_fields)

List open pgp public keys

A ViewSet for uploads that do not require to store an uploaded content as an Artifact.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.paginated_open_pgp_public_key_response_list import PaginatedOpenPGPPublicKeyResponseList
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ContentOpenpgpPublickeyApi(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)
    fingerprint = 'fingerprint_example' # str | Filter results where fingerprint 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) * `raw_data` - Raw data * `-raw_data` - Raw data (descending) * `fingerprint` - Fingerprint * `-fingerprint` - Fingerprint (descending) * `created` - Created * `-created` - Created (descending) * `pk` - Pk * `-pk` - Pk (descending) (optional)
    orphaned_for = 3.4 # float | Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME. (optional)
    prn__in = ['prn__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
    pulp_href__in = ['pulp_href__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
    pulp_id__in = ['pulp_id__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
    pulp_label_select = 'pulp_label_select_example' # str | Filter labels by search string (optional)
    q = 'q_example' # str | Filter results by using NOT, AND and OR operations on other filters (optional)
    repository_version = 'repository_version_example' # str | Repository Version referenced by HREF/PRN (optional)
    repository_version_added = 'repository_version_added_example' # str | Repository Version referenced by HREF/PRN (optional)
    repository_version_removed = 'repository_version_removed_example' # str | Repository Version referenced by HREF/PRN (optional)
    fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
    exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)

    try:
        # List open pgp public keys
        api_response = api_instance.list(pulp_domain, x_task_diagnostics=x_task_diagnostics, fingerprint=fingerprint, limit=limit, offset=offset, ordering=ordering, orphaned_for=orphaned_for, prn__in=prn__in, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, pulp_label_select=pulp_label_select, q=q, repository_version=repository_version, repository_version_added=repository_version_added, repository_version_removed=repository_version_removed, fields=fields, exclude_fields=exclude_fields)
        print("The response of ContentOpenpgpPublickeyApi->list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentOpenpgpPublickeyApi->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]
fingerprint	str	Filter results where fingerprint 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) * `raw_data` - Raw data * `-raw_data` - Raw data (descending) * `fingerprint` - Fingerprint * `-fingerprint` - Fingerprint (descending) * `created` - Created * `-created` - Created (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]
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

PaginatedOpenPGPPublicKeyResponseList

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

OpenPGPPublicKeyResponse read(open_p_g_p_public_key_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

Inspect an open pgp public key

A ViewSet for uploads that do not require to store an uploaded content as an Artifact.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.open_pgp_public_key_response import OpenPGPPublicKeyResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ContentOpenpgpPublickeyApi(api_client)
    open_p_g_p_public_key_href = 'open_p_g_p_public_key_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 an open pgp public key
        api_response = api_instance.read(open_p_g_p_public_key_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of ContentOpenpgpPublickeyApi->read:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentOpenpgpPublickeyApi->read: %s\n" % e)

Parameters

Name	Type	Description	Notes
open_p_g_p_public_key_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

OpenPGPPublicKeyResponse

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(open_p_g_p_public_key_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.pulpcore
from pulpcore.client.pulpcore.models.set_label import SetLabel
from pulpcore.client.pulpcore.models.set_label_response import SetLabelResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ContentOpenpgpPublickeyApi(api_client)
    open_p_g_p_public_key_href = 'open_p_g_p_public_key_href_example' # str | 
    set_label = pulpcore.client.pulpcore.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(open_p_g_p_public_key_href, set_label, x_task_diagnostics=x_task_diagnostics)
        print("The response of ContentOpenpgpPublickeyApi->set_label:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentOpenpgpPublickeyApi->set_label: %s\n" % e)

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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(open_p_g_p_public_key_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.pulpcore
from pulpcore.client.pulpcore.models.unset_label import UnsetLabel
from pulpcore.client.pulpcore.models.unset_label_response import UnsetLabelResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ContentOpenpgpPublickeyApi(api_client)
    open_p_g_p_public_key_href = 'open_p_g_p_public_key_href_example' # str | 
    unset_label = pulpcore.client.pulpcore.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(open_p_g_p_public_key_href, unset_label, x_task_diagnostics=x_task_diagnostics)
        print("The response of ContentOpenpgpPublickeyApi->unset_label:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentOpenpgpPublickeyApi->unset_label: %s\n" % e)

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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]

pulpcore.client.pulpcore.ContentOpenpgpPublicsubkeyApi

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

Method	HTTP request	Description
list	GET /api/pulp/{pulp_domain}/api/v3/content/core/openpgp_publicsubkey/	List open pgp public subkeys
read	GET {open_p_g_p_public_subkey_href}	Inspect an open pgp public subkey
set_label	POST {open_p_g_p_public_subkey_href}set_label/	Set a label
unset_label	POST {open_p_g_p_public_subkey_href}unset_label/	Unset a label

list

PaginatedOpenPGPPublicSubkeyResponseList list(pulp_domain, x_task_diagnostics=x_task_diagnostics, fingerprint=fingerprint, limit=limit, offset=offset, ordering=ordering, orphaned_for=orphaned_for, prn__in=prn__in, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, pulp_label_select=pulp_label_select, q=q, repository_version=repository_version, repository_version_added=repository_version_added, repository_version_removed=repository_version_removed, fields=fields, exclude_fields=exclude_fields)

List open pgp public subkeys

Content viewset that supports only GET by default.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.paginated_open_pgp_public_subkey_response_list import PaginatedOpenPGPPublicSubkeyResponseList
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ContentOpenpgpPublicsubkeyApi(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)
    fingerprint = 'fingerprint_example' # str | Filter results where fingerprint 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) * `raw_data` - Raw data * `-raw_data` - Raw data (descending) * `fingerprint` - Fingerprint * `-fingerprint` - Fingerprint (descending) * `created` - Created * `-created` - Created (descending) * `pk` - Pk * `-pk` - Pk (descending) (optional)
    orphaned_for = 3.4 # float | Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME. (optional)
    prn__in = ['prn__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
    pulp_href__in = ['pulp_href__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
    pulp_id__in = ['pulp_id__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
    pulp_label_select = 'pulp_label_select_example' # str | Filter labels by search string (optional)
    q = 'q_example' # str | Filter results by using NOT, AND and OR operations on other filters (optional)
    repository_version = 'repository_version_example' # str | Repository Version referenced by HREF/PRN (optional)
    repository_version_added = 'repository_version_added_example' # str | Repository Version referenced by HREF/PRN (optional)
    repository_version_removed = 'repository_version_removed_example' # str | Repository Version referenced by HREF/PRN (optional)
    fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
    exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)

    try:
        # List open pgp public subkeys
        api_response = api_instance.list(pulp_domain, x_task_diagnostics=x_task_diagnostics, fingerprint=fingerprint, limit=limit, offset=offset, ordering=ordering, orphaned_for=orphaned_for, prn__in=prn__in, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, pulp_label_select=pulp_label_select, q=q, repository_version=repository_version, repository_version_added=repository_version_added, repository_version_removed=repository_version_removed, fields=fields, exclude_fields=exclude_fields)
        print("The response of ContentOpenpgpPublicsubkeyApi->list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentOpenpgpPublicsubkeyApi->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]
fingerprint	str	Filter results where fingerprint 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) * `raw_data` - Raw data * `-raw_data` - Raw data (descending) * `fingerprint` - Fingerprint * `-fingerprint` - Fingerprint (descending) * `created` - Created * `-created` - Created (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]
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

PaginatedOpenPGPPublicSubkeyResponseList

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

OpenPGPPublicSubkeyResponse read(open_p_g_p_public_subkey_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

Inspect an open pgp public subkey

Content viewset that supports only GET by default.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.open_pgp_public_subkey_response import OpenPGPPublicSubkeyResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ContentOpenpgpPublicsubkeyApi(api_client)
    open_p_g_p_public_subkey_href = 'open_p_g_p_public_subkey_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 an open pgp public subkey
        api_response = api_instance.read(open_p_g_p_public_subkey_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of ContentOpenpgpPublicsubkeyApi->read:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentOpenpgpPublicsubkeyApi->read: %s\n" % e)

Parameters

Name	Type	Description	Notes
open_p_g_p_public_subkey_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

OpenPGPPublicSubkeyResponse

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(open_p_g_p_public_subkey_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.pulpcore
from pulpcore.client.pulpcore.models.set_label import SetLabel
from pulpcore.client.pulpcore.models.set_label_response import SetLabelResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ContentOpenpgpPublicsubkeyApi(api_client)
    open_p_g_p_public_subkey_href = 'open_p_g_p_public_subkey_href_example' # str | 
    set_label = pulpcore.client.pulpcore.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(open_p_g_p_public_subkey_href, set_label, x_task_diagnostics=x_task_diagnostics)
        print("The response of ContentOpenpgpPublicsubkeyApi->set_label:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentOpenpgpPublicsubkeyApi->set_label: %s\n" % e)

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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(open_p_g_p_public_subkey_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.pulpcore
from pulpcore.client.pulpcore.models.unset_label import UnsetLabel
from pulpcore.client.pulpcore.models.unset_label_response import UnsetLabelResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ContentOpenpgpPublicsubkeyApi(api_client)
    open_p_g_p_public_subkey_href = 'open_p_g_p_public_subkey_href_example' # str | 
    unset_label = pulpcore.client.pulpcore.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(open_p_g_p_public_subkey_href, unset_label, x_task_diagnostics=x_task_diagnostics)
        print("The response of ContentOpenpgpPublicsubkeyApi->unset_label:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentOpenpgpPublicsubkeyApi->unset_label: %s\n" % e)

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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]

pulpcore.client.pulpcore.ContentOpenpgpSignatureApi

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

Method	HTTP request	Description
list	GET /api/pulp/{pulp_domain}/api/v3/content/core/openpgp_signature/	List open pgp signatures
read	GET {open_p_g_p_signature_href}	Inspect an open pgp signature
set_label	POST {open_p_g_p_signature_href}set_label/	Set a label
unset_label	POST {open_p_g_p_signature_href}unset_label/	Unset a label

list

PaginatedOpenPGPSignatureResponseList list(pulp_domain, x_task_diagnostics=x_task_diagnostics, issuer=issuer, limit=limit, offset=offset, ordering=ordering, orphaned_for=orphaned_for, prn__in=prn__in, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, pulp_label_select=pulp_label_select, q=q, repository_version=repository_version, repository_version_added=repository_version_added, repository_version_removed=repository_version_removed, fields=fields, exclude_fields=exclude_fields)

List open pgp signatures

Content viewset that supports only GET by default.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.paginated_open_pgp_signature_response_list import PaginatedOpenPGPSignatureResponseList
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ContentOpenpgpSignatureApi(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)
    issuer = 'issuer_example' # str | Filter results where issuer 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) * `raw_data` - Raw data * `-raw_data` - Raw data (descending) * `sha256` - Sha256 * `-sha256` - Sha256 (descending) * `signature_type` - Signature type * `-signature_type` - Signature type (descending) * `created` - Created * `-created` - Created (descending) * `expiration_time` - Expiration time * `-expiration_time` - Expiration time (descending) * `key_expiration_time` - Key expiration time * `-key_expiration_time` - Key expiration time (descending) * `issuer` - Issuer * `-issuer` - Issuer (descending) * `signers_user_id` - Signers user id * `-signers_user_id` - Signers user id (descending) * `pk` - Pk * `-pk` - Pk (descending) (optional)
    orphaned_for = 3.4 # float | Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME. (optional)
    prn__in = ['prn__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
    pulp_href__in = ['pulp_href__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
    pulp_id__in = ['pulp_id__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
    pulp_label_select = 'pulp_label_select_example' # str | Filter labels by search string (optional)
    q = 'q_example' # str | Filter results by using NOT, AND and OR operations on other filters (optional)
    repository_version = 'repository_version_example' # str | Repository Version referenced by HREF/PRN (optional)
    repository_version_added = 'repository_version_added_example' # str | Repository Version referenced by HREF/PRN (optional)
    repository_version_removed = 'repository_version_removed_example' # str | Repository Version referenced by HREF/PRN (optional)
    fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
    exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)

    try:
        # List open pgp signatures
        api_response = api_instance.list(pulp_domain, x_task_diagnostics=x_task_diagnostics, issuer=issuer, limit=limit, offset=offset, ordering=ordering, orphaned_for=orphaned_for, prn__in=prn__in, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, pulp_label_select=pulp_label_select, q=q, repository_version=repository_version, repository_version_added=repository_version_added, repository_version_removed=repository_version_removed, fields=fields, exclude_fields=exclude_fields)
        print("The response of ContentOpenpgpSignatureApi->list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentOpenpgpSignatureApi->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]
issuer	str	Filter results where issuer 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) * `raw_data` - Raw data * `-raw_data` - Raw data (descending) * `sha256` - Sha256 * `-sha256` - Sha256 (descending) * `signature_type` - Signature type * `-signature_type` - Signature type (descending) * `created` - Created * `-created` - Created (descending) * `expiration_time` - Expiration time * `-expiration_time` - Expiration time (descending) * `key_expiration_time` - Key expiration time * `-key_expiration_time` - Key expiration time (descending) * `issuer` - Issuer * `-issuer` - Issuer (descending) * `signers_user_id` - Signers user id * `-signers_user_id` - Signers user id (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]
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

PaginatedOpenPGPSignatureResponseList

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

OpenPGPSignatureResponse read(open_p_g_p_signature_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

Inspect an open pgp signature

Content viewset that supports only GET by default.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.open_pgp_signature_response import OpenPGPSignatureResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ContentOpenpgpSignatureApi(api_client)
    open_p_g_p_signature_href = 'open_p_g_p_signature_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 an open pgp signature
        api_response = api_instance.read(open_p_g_p_signature_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of ContentOpenpgpSignatureApi->read:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentOpenpgpSignatureApi->read: %s\n" % e)

Parameters

Name	Type	Description	Notes
open_p_g_p_signature_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

OpenPGPSignatureResponse

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(open_p_g_p_signature_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.pulpcore
from pulpcore.client.pulpcore.models.set_label import SetLabel
from pulpcore.client.pulpcore.models.set_label_response import SetLabelResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ContentOpenpgpSignatureApi(api_client)
    open_p_g_p_signature_href = 'open_p_g_p_signature_href_example' # str | 
    set_label = pulpcore.client.pulpcore.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(open_p_g_p_signature_href, set_label, x_task_diagnostics=x_task_diagnostics)
        print("The response of ContentOpenpgpSignatureApi->set_label:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentOpenpgpSignatureApi->set_label: %s\n" % e)

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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(open_p_g_p_signature_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.pulpcore
from pulpcore.client.pulpcore.models.unset_label import UnsetLabel
from pulpcore.client.pulpcore.models.unset_label_response import UnsetLabelResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ContentOpenpgpSignatureApi(api_client)
    open_p_g_p_signature_href = 'open_p_g_p_signature_href_example' # str | 
    unset_label = pulpcore.client.pulpcore.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(open_p_g_p_signature_href, unset_label, x_task_diagnostics=x_task_diagnostics)
        print("The response of ContentOpenpgpSignatureApi->unset_label:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentOpenpgpSignatureApi->unset_label: %s\n" % e)

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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]

pulpcore.client.pulpcore.ContentOpenpgpUserattributeApi

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

Method	HTTP request	Description
list	GET /api/pulp/{pulp_domain}/api/v3/content/core/openpgp_userattribute/	List open pgp user attributes
read	GET {open_p_g_p_user_attribute_href}	Inspect an open pgp user attribute
set_label	POST {open_p_g_p_user_attribute_href}set_label/	Set a label
unset_label	POST {open_p_g_p_user_attribute_href}unset_label/	Unset a label

list

PaginatedOpenPGPUserAttributeResponseList list(pulp_domain, x_task_diagnostics=x_task_diagnostics, 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, sha256=sha256, fields=fields, exclude_fields=exclude_fields)

List open pgp user attributes

Content viewset that supports only GET by default.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.paginated_open_pgp_user_attribute_response_list import PaginatedOpenPGPUserAttributeResponseList
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ContentOpenpgpUserattributeApi(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)
    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) * `raw_data` - Raw data * `-raw_data` - Raw data (descending) * `sha256` - Sha256 * `-sha256` - Sha256 (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)
    sha256 = 'sha256_example' # str | Filter results where sha256 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 open pgp user attributes
        api_response = api_instance.list(pulp_domain, x_task_diagnostics=x_task_diagnostics, 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, sha256=sha256, fields=fields, exclude_fields=exclude_fields)
        print("The response of ContentOpenpgpUserattributeApi->list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentOpenpgpUserattributeApi->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]
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) * `raw_data` - Raw data * `-raw_data` - Raw data (descending) * `sha256` - Sha256 * `-sha256` - Sha256 (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]
sha256	str	Filter results where sha256 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

PaginatedOpenPGPUserAttributeResponseList

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

OpenPGPUserAttributeResponse read(open_p_g_p_user_attribute_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

Inspect an open pgp user attribute

Content viewset that supports only GET by default.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.open_pgp_user_attribute_response import OpenPGPUserAttributeResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ContentOpenpgpUserattributeApi(api_client)
    open_p_g_p_user_attribute_href = 'open_p_g_p_user_attribute_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 an open pgp user attribute
        api_response = api_instance.read(open_p_g_p_user_attribute_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of ContentOpenpgpUserattributeApi->read:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentOpenpgpUserattributeApi->read: %s\n" % e)

Parameters

Name	Type	Description	Notes
open_p_g_p_user_attribute_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

OpenPGPUserAttributeResponse

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(open_p_g_p_user_attribute_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.pulpcore
from pulpcore.client.pulpcore.models.set_label import SetLabel
from pulpcore.client.pulpcore.models.set_label_response import SetLabelResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ContentOpenpgpUserattributeApi(api_client)
    open_p_g_p_user_attribute_href = 'open_p_g_p_user_attribute_href_example' # str | 
    set_label = pulpcore.client.pulpcore.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(open_p_g_p_user_attribute_href, set_label, x_task_diagnostics=x_task_diagnostics)
        print("The response of ContentOpenpgpUserattributeApi->set_label:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentOpenpgpUserattributeApi->set_label: %s\n" % e)

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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(open_p_g_p_user_attribute_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.pulpcore
from pulpcore.client.pulpcore.models.unset_label import UnsetLabel
from pulpcore.client.pulpcore.models.unset_label_response import UnsetLabelResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ContentOpenpgpUserattributeApi(api_client)
    open_p_g_p_user_attribute_href = 'open_p_g_p_user_attribute_href_example' # str | 
    unset_label = pulpcore.client.pulpcore.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(open_p_g_p_user_attribute_href, unset_label, x_task_diagnostics=x_task_diagnostics)
        print("The response of ContentOpenpgpUserattributeApi->unset_label:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentOpenpgpUserattributeApi->unset_label: %s\n" % e)

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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]

pulpcore.client.pulpcore.ContentOpenpgpUseridApi

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

Method	HTTP request	Description
list	GET /api/pulp/{pulp_domain}/api/v3/content/core/openpgp_userid/	List open pgp user ids
read	GET {open_p_g_p_user_i_d_href}	Inspect an open pgp user id
set_label	POST {open_p_g_p_user_i_d_href}set_label/	Set a label
unset_label	POST {open_p_g_p_user_i_d_href}unset_label/	Unset a label

list

PaginatedOpenPGPUserIDResponseList list(pulp_domain, x_task_diagnostics=x_task_diagnostics, 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, user_id=user_id, user_id__contains=user_id__contains, user_id__icontains=user_id__icontains, user_id__iexact=user_id__iexact, user_id__in=user_id__in, user_id__iregex=user_id__iregex, user_id__istartswith=user_id__istartswith, user_id__regex=user_id__regex, user_id__startswith=user_id__startswith, fields=fields, exclude_fields=exclude_fields)

List open pgp user ids

Content viewset that supports only GET by default.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.paginated_open_pgp_user_id_response_list import PaginatedOpenPGPUserIDResponseList
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ContentOpenpgpUseridApi(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)
    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) * `raw_data` - Raw data * `-raw_data` - Raw data (descending) * `user_id` - User id * `-user_id` - User id (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)
    user_id = 'user_id_example' # str | Filter results where user_id matches value (optional)
    user_id__contains = 'user_id__contains_example' # str | Filter results where user_id contains value (optional)
    user_id__icontains = 'user_id__icontains_example' # str | Filter results where user_id contains value (optional)
    user_id__iexact = 'user_id__iexact_example' # str | Filter results where user_id matches value (optional)
    user_id__in = ['user_id__in_example'] # List[str] | Filter results where user_id is in a comma-separated list of values (optional)
    user_id__iregex = 'user_id__iregex_example' # str | Filter results where user_id matches regex value (optional)
    user_id__istartswith = 'user_id__istartswith_example' # str | Filter results where user_id starts with value (optional)
    user_id__regex = 'user_id__regex_example' # str | Filter results where user_id matches regex value (optional)
    user_id__startswith = 'user_id__startswith_example' # str | Filter results where user_id starts with 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 open pgp user ids
        api_response = api_instance.list(pulp_domain, x_task_diagnostics=x_task_diagnostics, 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, user_id=user_id, user_id__contains=user_id__contains, user_id__icontains=user_id__icontains, user_id__iexact=user_id__iexact, user_id__in=user_id__in, user_id__iregex=user_id__iregex, user_id__istartswith=user_id__istartswith, user_id__regex=user_id__regex, user_id__startswith=user_id__startswith, fields=fields, exclude_fields=exclude_fields)
        print("The response of ContentOpenpgpUseridApi->list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentOpenpgpUseridApi->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]
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) * `raw_data` - Raw data * `-raw_data` - Raw data (descending) * `user_id` - User id * `-user_id` - User id (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]
user_id	str	Filter results where user_id matches value	[optional]
user_id__contains	str	Filter results where user_id contains value	[optional]
user_id__icontains	str	Filter results where user_id contains value	[optional]
user_id__iexact	str	Filter results where user_id matches value	[optional]
user_id__in	List[str]	Filter results where user_id is in a comma-separated list of values	[optional]
user_id__iregex	str	Filter results where user_id matches regex value	[optional]
user_id__istartswith	str	Filter results where user_id starts with value	[optional]
user_id__regex	str	Filter results where user_id matches regex value	[optional]
user_id__startswith	str	Filter results where user_id starts with 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

PaginatedOpenPGPUserIDResponseList

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

OpenPGPUserIDResponse read(open_p_g_p_user_i_d_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

Inspect an open pgp user id

Content viewset that supports only GET by default.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.open_pgp_user_id_response import OpenPGPUserIDResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ContentOpenpgpUseridApi(api_client)
    open_p_g_p_user_i_d_href = 'open_p_g_p_user_i_d_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 an open pgp user id
        api_response = api_instance.read(open_p_g_p_user_i_d_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of ContentOpenpgpUseridApi->read:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentOpenpgpUseridApi->read: %s\n" % e)

Parameters

Name	Type	Description	Notes
open_p_g_p_user_i_d_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

OpenPGPUserIDResponse

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(open_p_g_p_user_i_d_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.pulpcore
from pulpcore.client.pulpcore.models.set_label import SetLabel
from pulpcore.client.pulpcore.models.set_label_response import SetLabelResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ContentOpenpgpUseridApi(api_client)
    open_p_g_p_user_i_d_href = 'open_p_g_p_user_i_d_href_example' # str | 
    set_label = pulpcore.client.pulpcore.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(open_p_g_p_user_i_d_href, set_label, x_task_diagnostics=x_task_diagnostics)
        print("The response of ContentOpenpgpUseridApi->set_label:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentOpenpgpUseridApi->set_label: %s\n" % e)

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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(open_p_g_p_user_i_d_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.pulpcore
from pulpcore.client.pulpcore.models.unset_label import UnsetLabel
from pulpcore.client.pulpcore.models.unset_label_response import UnsetLabelResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ContentOpenpgpUseridApi(api_client)
    open_p_g_p_user_i_d_href = 'open_p_g_p_user_i_d_href_example' # str | 
    unset_label = pulpcore.client.pulpcore.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(open_p_g_p_user_i_d_href, unset_label, x_task_diagnostics=x_task_diagnostics)
        print("The response of ContentOpenpgpUseridApi->unset_label:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentOpenpgpUseridApi->unset_label: %s\n" % e)

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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]

ContentRedirectContentGuard

A serializer for ContentRedirectContentGuard.

Properties

Name	Type	Description	Notes
name	str	The unique name.
description	str	An optional description.	[optional]

Example

from pulpcore.client.pulpcore.models.content_redirect_content_guard import ContentRedirectContentGuard

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

# convert the object into a dict
content_redirect_content_guard_dict = content_redirect_content_guard_instance.to_dict()
# create an instance of ContentRedirectContentGuard from a dict
content_redirect_content_guard_from_dict = ContentRedirectContentGuard.from_dict(content_redirect_content_guard_dict)

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

ContentRedirectContentGuardResponse

A serializer for ContentRedirectContentGuard.

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]
name	str	The unique name.
description	str	An optional description.	[optional]

Example

from pulpcore.client.pulpcore.models.content_redirect_content_guard_response import ContentRedirectContentGuardResponse

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

# convert the object into a dict
content_redirect_content_guard_response_dict = content_redirect_content_guard_response_instance.to_dict()
# create an instance of ContentRedirectContentGuardResponse from a dict
content_redirect_content_guard_response_from_dict = ContentRedirectContentGuardResponse.from_dict(content_redirect_content_guard_response_dict)

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

ContentSettingsResponse

Serializer for information about content-app-settings for the pulp instance

Properties

Name	Type	Description	Notes
content_origin	str	The CONTENT_ORIGIN setting for this Pulp instance	[optional]
content_path_prefix	str	The CONTENT_PATH_PREFIX setting for this Pulp instance

Example

from pulpcore.client.pulpcore.models.content_settings_response import ContentSettingsResponse

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

# convert the object into a dict
content_settings_response_dict = content_settings_response_instance.to_dict()
# create an instance of ContentSettingsResponse from a dict
content_settings_response_from_dict = ContentSettingsResponse.from_dict(content_settings_response_dict)

[Back to Model list] [Back to API 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.pulpcore.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]

DatabaseConnectionResponse

Serializer for the database connection information

Properties

Name	Type	Description	Notes
connected	bool	Info about whether the app can connect to the database

Example

from pulpcore.client.pulpcore.models.database_connection_response import DatabaseConnectionResponse

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

# convert the object into a dict
database_connection_response_dict = database_connection_response_instance.to_dict()
# create an instance of DatabaseConnectionResponse from a dict
database_connection_response_from_dict = DatabaseConnectionResponse.from_dict(database_connection_response_dict)

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

DistributionResponse

The Serializer for the Distribution model. The serializer deliberately omits the publication and repository_version field due to plugins typically requiring one or the other but not both. To include the publication field, it is recommended plugins define the field:: publication = DetailRelatedField( required=False, help_text=("Publication to be served"), view_name_pattern=r"publications(-./.)?-detail", queryset=models.Publication.objects.exclude(complete=False), allow_null=True, ) To include the repository_version field, it is recommended plugins define the field:: repository_version = RepositoryVersionRelatedField( required=False, help_text=("RepositoryVersion to be served"), allow_null=True ) Additionally, the serializer omits the remote field, which is used for pull-through caching feature and only by plugins which use publications. Plugins implementing a pull-through caching should define the field in their derived serializer class like this:: remote = DetailRelatedField( required=False, help_text=_('Remote that can be used to fetch content when using pull-through caching.'), queryset=models.Remote.objects.all(), allow_null=True )

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]

Example

from pulpcore.client.pulpcore.models.distribution_response import DistributionResponse

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

# convert the object into a dict
distribution_response_dict = distribution_response_instance.to_dict()
# create an instance of DistributionResponse from a dict
distribution_response_from_dict = DistributionResponse.from_dict(distribution_response_dict)

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

pulpcore.client.pulpcore.DistributionsApi

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

Method	HTTP request	Description
list	GET /api/pulp/{pulp_domain}/api/v3/distributions/	List distributions

list

PaginatedDistributionResponseList 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, pulp_type=pulp_type, pulp_type__in=pulp_type__in, q=q, repository=repository, repository__in=repository__in, with_content=with_content, fields=fields, exclude_fields=exclude_fields)

List distributions

Provides base viewset for Distributions.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.paginated_distribution_response_list import PaginatedDistributionResponseList
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.DistributionsApi(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)
    pulp_type = 'pulp_type_example' # str | Pulp type  * `core.artifact` - core.artifact * `core.openpgp` - core.openpgp * `container.pull-through` - container.pull-through * `container.container` - container.container * `gem.gem` - gem.gem * `hugging_face.hugging-face` - hugging_face.hugging-face * `maven.maven` - maven.maven * `npm.npm` - npm.npm * `python.python` - python.python * `rpm.rpm` - rpm.rpm * `file.file` - file.file (optional)
    pulp_type__in = ['pulp_type__in_example'] # List[str] | Multiple values may be separated by commas.  * `core.artifact` - core.artifact * `core.openpgp` - core.openpgp * `container.pull-through` - container.pull-through * `container.container` - container.container * `gem.gem` - gem.gem * `hugging_face.hugging-face` - hugging_face.hugging-face * `maven.maven` - maven.maven * `npm.npm` - npm.npm * `python.python` - python.python * `rpm.rpm` - rpm.rpm * `file.file` - file.file (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 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, pulp_type=pulp_type, pulp_type__in=pulp_type__in, q=q, repository=repository, repository__in=repository__in, with_content=with_content, fields=fields, exclude_fields=exclude_fields)
        print("The response of DistributionsApi->list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DistributionsApi->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]
pulp_type	str	Pulp type * `core.artifact` - core.artifact * `core.openpgp` - core.openpgp * `container.pull-through` - container.pull-through * `container.container` - container.container * `gem.gem` - gem.gem * `hugging_face.hugging-face` - hugging_face.hugging-face * `maven.maven` - maven.maven * `npm.npm` - npm.npm * `python.python` - python.python * `rpm.rpm` - rpm.rpm * `file.file` - file.file	[optional]
pulp_type__in	List[str]	Multiple values may be separated by commas. * `core.artifact` - core.artifact * `core.openpgp` - core.openpgp * `container.pull-through` - container.pull-through * `container.container` - container.container * `gem.gem` - gem.gem * `hugging_face.hugging-face` - hugging_face.hugging-face * `maven.maven` - maven.maven * `npm.npm` - npm.npm * `python.python` - python.python * `rpm.rpm` - rpm.rpm * `file.file` - file.file	[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

PaginatedDistributionResponseList

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]

pulpcore.client.pulpcore.DistributionsArtifactsApi

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

Method	HTTP request	Description
list	GET /api/pulp/{pulp_domain}/api/v3/distributions/core/artifacts/	List artifact distributions
read	GET {artifact_distribution_href}	Inspect an artifact distribution

list

PaginatedArtifactDistributionResponseList 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 artifact distributions

ViewSet for ArtifactDistribution.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.paginated_artifact_distribution_response_list import PaginatedArtifactDistributionResponseList
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.DistributionsArtifactsApi(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 artifact 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 DistributionsArtifactsApi->list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DistributionsArtifactsApi->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

PaginatedArtifactDistributionResponseList

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

ArtifactDistributionResponse read(artifact_distribution_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

Inspect an artifact distribution

ViewSet for ArtifactDistribution.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.artifact_distribution_response import ArtifactDistributionResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.DistributionsArtifactsApi(api_client)
    artifact_distribution_href = 'artifact_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 an artifact distribution
        api_response = api_instance.read(artifact_distribution_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of DistributionsArtifactsApi->read:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DistributionsArtifactsApi->read: %s\n" % e)

Parameters

Name	Type	Description	Notes
artifact_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

ArtifactDistributionResponse

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]

pulpcore.client.pulpcore.DistributionsOpenpgpApi

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

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

create

AsyncOperationResponse create(pulp_domain, open_pgp_distribution, x_task_diagnostics=x_task_diagnostics)

Create an open pgp distribution

Trigger an asynchronous create task

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.async_operation_response import AsyncOperationResponse
from pulpcore.client.pulpcore.models.open_pgp_distribution import OpenPGPDistribution
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.DistributionsOpenpgpApi(api_client)
    pulp_domain = 'pulp_domain_example' # str | 
    open_pgp_distribution = pulpcore.client.pulpcore.OpenPGPDistribution() # OpenPGPDistribution | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Create an open pgp distribution
        api_response = api_instance.create(pulp_domain, open_pgp_distribution, x_task_diagnostics=x_task_diagnostics)
        print("The response of DistributionsOpenpgpApi->create:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DistributionsOpenpgpApi->create: %s\n" % e)

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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(open_p_g_p_distribution_href, x_task_diagnostics=x_task_diagnostics)

Delete an open pgp distribution

Trigger an asynchronous delete task

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.async_operation_response import AsyncOperationResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.DistributionsOpenpgpApi(api_client)
    open_p_g_p_distribution_href = 'open_p_g_p_distribution_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Delete an open pgp distribution
        api_response = api_instance.delete(open_p_g_p_distribution_href, x_task_diagnostics=x_task_diagnostics)
        print("The response of DistributionsOpenpgpApi->delete:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DistributionsOpenpgpApi->delete: %s\n" % e)

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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

PaginatedOpenPGPDistributionResponseList list(pulp_domain, x_task_diagnostics=x_task_diagnostics, limit=limit, 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_version=repository_version, with_content=with_content, fields=fields, exclude_fields=exclude_fields)

List open pgp distributions

Provides read and list methods and also provides asynchronous CUD methods to dispatch tasks with reservation that lock all Distributions preventing race conditions during base_path checking.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.paginated_open_pgp_distribution_response_list import PaginatedOpenPGPDistributionResponseList
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.DistributionsOpenpgpApi(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)
    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_version = 'repository_version_example' # str | Filter results where repository_version matches value (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 open pgp distributions
        api_response = api_instance.list(pulp_domain, x_task_diagnostics=x_task_diagnostics, limit=limit, 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_version=repository_version, with_content=with_content, fields=fields, exclude_fields=exclude_fields)
        print("The response of DistributionsOpenpgpApi->list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DistributionsOpenpgpApi->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]
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_version	str	Filter results where repository_version matches value	[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

PaginatedOpenPGPDistributionResponseList

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

OpenPGPDistributionResponse partial_update(open_p_g_p_distribution_href, patched_open_pgp_distribution, x_task_diagnostics=x_task_diagnostics)

Update an open pgp 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.pulpcore
from pulpcore.client.pulpcore.models.open_pgp_distribution_response import OpenPGPDistributionResponse
from pulpcore.client.pulpcore.models.patched_open_pgp_distribution import PatchedOpenPGPDistribution
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.DistributionsOpenpgpApi(api_client)
    open_p_g_p_distribution_href = 'open_p_g_p_distribution_href_example' # str | 
    patched_open_pgp_distribution = pulpcore.client.pulpcore.PatchedOpenPGPDistribution() # PatchedOpenPGPDistribution | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Update an open pgp distribution
        api_response = api_instance.partial_update(open_p_g_p_distribution_href, patched_open_pgp_distribution, x_task_diagnostics=x_task_diagnostics)
        print("The response of DistributionsOpenpgpApi->partial_update:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DistributionsOpenpgpApi->partial_update: %s\n" % e)

Parameters

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

Return type

OpenPGPDistributionResponse

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

OpenPGPDistributionResponse read(open_p_g_p_distribution_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

Inspect an open pgp distribution

Provides read and list methods and also provides asynchronous CUD methods to dispatch tasks with reservation that lock all Distributions preventing race conditions during base_path checking.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.open_pgp_distribution_response import OpenPGPDistributionResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.DistributionsOpenpgpApi(api_client)
    open_p_g_p_distribution_href = 'open_p_g_p_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 an open pgp distribution
        api_response = api_instance.read(open_p_g_p_distribution_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of DistributionsOpenpgpApi->read:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DistributionsOpenpgpApi->read: %s\n" % e)

Parameters

Name	Type	Description	Notes
open_p_g_p_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

OpenPGPDistributionResponse

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(open_p_g_p_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.pulpcore
from pulpcore.client.pulpcore.models.set_label import SetLabel
from pulpcore.client.pulpcore.models.set_label_response import SetLabelResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.DistributionsOpenpgpApi(api_client)
    open_p_g_p_distribution_href = 'open_p_g_p_distribution_href_example' # str | 
    set_label = pulpcore.client.pulpcore.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(open_p_g_p_distribution_href, set_label, x_task_diagnostics=x_task_diagnostics)
        print("The response of DistributionsOpenpgpApi->set_label:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DistributionsOpenpgpApi->set_label: %s\n" % e)

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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(open_p_g_p_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.pulpcore
from pulpcore.client.pulpcore.models.unset_label import UnsetLabel
from pulpcore.client.pulpcore.models.unset_label_response import UnsetLabelResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.DistributionsOpenpgpApi(api_client)
    open_p_g_p_distribution_href = 'open_p_g_p_distribution_href_example' # str | 
    unset_label = pulpcore.client.pulpcore.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(open_p_g_p_distribution_href, unset_label, x_task_diagnostics=x_task_diagnostics)
        print("The response of DistributionsOpenpgpApi->unset_label:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DistributionsOpenpgpApi->unset_label: %s\n" % e)

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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

OpenPGPDistributionResponse update(open_p_g_p_distribution_href, open_pgp_distribution, x_task_diagnostics=x_task_diagnostics)

Update an open pgp 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.pulpcore
from pulpcore.client.pulpcore.models.open_pgp_distribution import OpenPGPDistribution
from pulpcore.client.pulpcore.models.open_pgp_distribution_response import OpenPGPDistributionResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.DistributionsOpenpgpApi(api_client)
    open_p_g_p_distribution_href = 'open_p_g_p_distribution_href_example' # str | 
    open_pgp_distribution = pulpcore.client.pulpcore.OpenPGPDistribution() # OpenPGPDistribution | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Update an open pgp distribution
        api_response = api_instance.update(open_p_g_p_distribution_href, open_pgp_distribution, x_task_diagnostics=x_task_diagnostics)
        print("The response of DistributionsOpenpgpApi->update:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DistributionsOpenpgpApi->update: %s\n" % e)

Parameters

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

Return type

OpenPGPDistributionResponse

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]

DomainBackendMigrator

Special serializer for performing a storage backend migration on a Domain.

Properties

Name	Type	Description	Notes
storage_class	StorageClassEnum	The new backend storage class to migrate to. * `pulpcore.app.models.storage.FileSystem` - Use local filesystem as storage * `storages.backends.s3boto3.S3Boto3Storage` - Use Amazon S3 as storage [deprecated] * `storages.backends.s3.S3Storage` - Use Amazon S3 as storage * `storages.backends.azure_storage.AzureStorage` - Use Azure Blob as storage * `pulp_service.app.storage.OCIStorage` - Use OCI as storage
storage_settings	object	The settings for the new storage class to migrate to.

Example

from pulpcore.client.pulpcore.models.domain_backend_migrator import DomainBackendMigrator

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

# convert the object into a dict
domain_backend_migrator_dict = domain_backend_migrator_instance.to_dict()
# create an instance of DomainBackendMigrator from a dict
domain_backend_migrator_from_dict = DomainBackendMigrator.from_dict(domain_backend_migrator_dict)

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

Domain

Serializer for Domain.

Properties

Name	Type	Description	Notes
name	str	A name for this domain.
description	str	An optional description.	[optional]
pulp_labels	Dict[str, Optional[str]]		[optional]
storage_class	StorageClassEnum	Backend storage class for domain. * `pulpcore.app.models.storage.FileSystem` - Use local filesystem as storage * `storages.backends.s3boto3.S3Boto3Storage` - Use Amazon S3 as storage [deprecated] * `storages.backends.s3.S3Storage` - Use Amazon S3 as storage * `storages.backends.azure_storage.AzureStorage` - Use Azure Blob as storage * `pulp_service.app.storage.OCIStorage` - Use OCI as storage
storage_settings	object	Settings for storage class.
redirect_to_object_storage	bool	Boolean to have the content app redirect to object storage.	[optional] [default to True]
hide_guarded_distributions	bool	Boolean to hide distributions with a content guard in the content app.	[optional] [default to False]

Example

from pulpcore.client.pulpcore.models.domain import Domain

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

# convert the object into a dict
domain_dict = domain_instance.to_dict()
# create an instance of Domain from a dict
domain_from_dict = Domain.from_dict(domain_dict)

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

DomainResponse

Serializer for Domain.

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]
name	str	A name for this domain.
description	str	An optional description.	[optional]
pulp_labels	Dict[str, Optional[str]]		[optional]
storage_class	StorageClassEnum	Backend storage class for domain. * `pulpcore.app.models.storage.FileSystem` - Use local filesystem as storage * `storages.backends.s3boto3.S3Boto3Storage` - Use Amazon S3 as storage [deprecated] * `storages.backends.s3.S3Storage` - Use Amazon S3 as storage * `storages.backends.azure_storage.AzureStorage` - Use Azure Blob as storage * `pulp_service.app.storage.OCIStorage` - Use OCI as storage
storage_settings	object	Settings for storage class.
redirect_to_object_storage	bool	Boolean to have the content app redirect to object storage.	[optional] [default to True]
hide_guarded_distributions	bool	Boolean to hide distributions with a content guard in the content app.	[optional] [default to False]

Example

from pulpcore.client.pulpcore.models.domain_response import DomainResponse

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

# convert the object into a dict
domain_response_dict = domain_response_instance.to_dict()
# create an instance of DomainResponse from a dict
domain_response_from_dict = DomainResponse.from_dict(domain_response_dict)

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

pulpcore.client.pulpcore.DomainsApi

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

Method	HTTP request	Description
create	POST /api/pulp/{pulp_domain}/api/v3/domains/	Create a domain
delete	DELETE {domain_href}	Delete a domain
list	GET /api/pulp/{pulp_domain}/api/v3/domains/	List domains
migrate	POST /api/pulp/{pulp_domain}/api/v3/domains/migrate/	Migrate storage backend
partial_update	PATCH {domain_href}	Update a domain
read	GET {domain_href}	Inspect a domain
set_label	POST {domain_href}set_label/	Set a label
unset_label	POST {domain_href}unset_label/	Unset a label
update	PUT {domain_href}	Update a domain

create

DomainResponse create(pulp_domain, domain, x_task_diagnostics=x_task_diagnostics)

Create a domain

ViewSet for Domain. NOTE: This API endpoint is in "tech preview" and subject to change

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.domain import Domain
from pulpcore.client.pulpcore.models.domain_response import DomainResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.DomainsApi(api_client)
    pulp_domain = 'pulp_domain_example' # str | 
    domain = pulpcore.client.pulpcore.Domain() # Domain | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

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

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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(domain_href, x_task_diagnostics=x_task_diagnostics)

Delete a domain

Trigger an asynchronous delete task

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.async_operation_response import AsyncOperationResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.DomainsApi(api_client)
    domain_href = 'domain_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

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

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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

PaginatedDomainResponseList 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, q=q, fields=fields, exclude_fields=exclude_fields)

List domains

ViewSet for Domain. NOTE: This API endpoint is in "tech preview" and subject to change

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.paginated_domain_response_list import PaginatedDomainResponseList
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.DomainsApi(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) * `name` - Name * `-name` - Name (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `description` - Description * `-description` - Description (descending) * `storage_class` - Storage class * `-storage_class` - Storage class (descending) * `storage_settings` - Storage settings * `-storage_settings` - Storage settings (descending) * `redirect_to_object_storage` - Redirect to object storage * `-redirect_to_object_storage` - Redirect to object storage (descending) * `hide_guarded_distributions` - Hide guarded distributions * `-hide_guarded_distributions` - Hide guarded distributions (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)
    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 domains
        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, q=q, fields=fields, exclude_fields=exclude_fields)
        print("The response of DomainsApi->list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DomainsApi->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) * `name` - Name * `-name` - Name (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `description` - Description * `-description` - Description (descending) * `storage_class` - Storage class * `-storage_class` - Storage class (descending) * `storage_settings` - Storage settings * `-storage_settings` - Storage settings (descending) * `redirect_to_object_storage` - Redirect to object storage * `-redirect_to_object_storage` - Redirect to object storage (descending) * `hide_guarded_distributions` - Hide guarded distributions * `-hide_guarded_distributions` - Hide guarded distributions (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]
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

PaginatedDomainResponseList

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]

migrate

AsyncOperationResponse migrate(pulp_domain, domain_backend_migrator, x_task_diagnostics=x_task_diagnostics)

Migrate storage backend

Migrate the domain's storage backend to a new one. Launches a background task to copy the domain's artifacts over to the supplied storage backend. Then updates the domain's storage settings to the new storage backend. This task does not delete the stored files of the artifacts from the previous backend. IMPORTANT This task will block all other tasks within the domain until the migration is completed, essentially putting the domain into a read only state. Content will still be served from the old storage backend until the migration has completed, so don't remove the old backend until then. Note, this endpoint is not allowed on the default domain. This feature is in Tech Preview and is subject to future change and thus not guaranteed to be backwards compatible.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.async_operation_response import AsyncOperationResponse
from pulpcore.client.pulpcore.models.domain_backend_migrator import DomainBackendMigrator
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.DomainsApi(api_client)
    pulp_domain = 'pulp_domain_example' # str | 
    domain_backend_migrator = pulpcore.client.pulpcore.DomainBackendMigrator() # DomainBackendMigrator | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Migrate storage backend
        api_response = api_instance.migrate(pulp_domain, domain_backend_migrator, x_task_diagnostics=x_task_diagnostics)
        print("The response of DomainsApi->migrate:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DomainsApi->migrate: %s\n" % e)

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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]

partial_update

DomainResponse partial_update(domain_href, patched_domain, x_task_diagnostics=x_task_diagnostics)

Update a domain

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.pulpcore
from pulpcore.client.pulpcore.models.domain_response import DomainResponse
from pulpcore.client.pulpcore.models.patched_domain import PatchedDomain
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.DomainsApi(api_client)
    domain_href = 'domain_href_example' # str | 
    patched_domain = pulpcore.client.pulpcore.PatchedDomain() # PatchedDomain | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Update a domain
        api_response = api_instance.partial_update(domain_href, patched_domain, x_task_diagnostics=x_task_diagnostics)
        print("The response of DomainsApi->partial_update:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DomainsApi->partial_update: %s\n" % e)

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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

DomainResponse read(domain_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

Inspect a domain

ViewSet for Domain. NOTE: This API endpoint is in "tech preview" and subject to change

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.domain_response import DomainResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.DomainsApi(api_client)
    domain_href = 'domain_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 domain
        api_response = api_instance.read(domain_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of DomainsApi->read:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DomainsApi->read: %s\n" % e)

Parameters

Name	Type	Description	Notes
domain_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

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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(domain_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.pulpcore
from pulpcore.client.pulpcore.models.set_label import SetLabel
from pulpcore.client.pulpcore.models.set_label_response import SetLabelResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.DomainsApi(api_client)
    domain_href = 'domain_href_example' # str | 
    set_label = pulpcore.client.pulpcore.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(domain_href, set_label, x_task_diagnostics=x_task_diagnostics)
        print("The response of DomainsApi->set_label:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DomainsApi->set_label: %s\n" % e)

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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(domain_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.pulpcore
from pulpcore.client.pulpcore.models.unset_label import UnsetLabel
from pulpcore.client.pulpcore.models.unset_label_response import UnsetLabelResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.DomainsApi(api_client)
    domain_href = 'domain_href_example' # str | 
    unset_label = pulpcore.client.pulpcore.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(domain_href, unset_label, x_task_diagnostics=x_task_diagnostics)
        print("The response of DomainsApi->unset_label:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DomainsApi->unset_label: %s\n" % e)

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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

DomainResponse update(domain_href, domain, x_task_diagnostics=x_task_diagnostics)

Update a domain

Trigger an asynchronous update task

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.domain import Domain
from pulpcore.client.pulpcore.models.domain_response import DomainResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.DomainsApi(api_client)
    domain_href = 'domain_href_example' # str | 
    domain = pulpcore.client.pulpcore.Domain() # Domain | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

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

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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]

EvaluationResponse

Results from evaluating a proposed parameter to a PulpImport call.

Properties

Name	Type	Description
context	str	Parameter value being evaluated.
is_valid	bool	True if evaluation passed, false otherwise.
messages	List[str]	Messages describing results of all evaluations done. May be an empty list.

Example

from pulpcore.client.pulpcore.models.evaluation_response import EvaluationResponse

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

# convert the object into a dict
evaluation_response_dict = evaluation_response_instance.to_dict()
# create an instance of EvaluationResponse from a dict
evaluation_response_from_dict = EvaluationResponse.from_dict(evaluation_response_dict)

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

pulpcore.client.pulpcore.ExportersFilesystemApi

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

Method	HTTP request	Description
create	POST /api/pulp/{pulp_domain}/api/v3/exporters/core/filesystem/	Create a filesystem exporter
delete	DELETE {filesystem_exporter_href}	Delete a filesystem exporter
list	GET /api/pulp/{pulp_domain}/api/v3/exporters/core/filesystem/	List filesystem exporters
partial_update	PATCH {filesystem_exporter_href}	Update a filesystem exporter
read	GET {filesystem_exporter_href}	Inspect a filesystem exporter
update	PUT {filesystem_exporter_href}	Update a filesystem exporter

create

FilesystemExporterResponse create(pulp_domain, filesystem_exporter, x_task_diagnostics=x_task_diagnostics)

Create a filesystem exporter

Endpoint for managing FilesystemExporters.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.filesystem_exporter import FilesystemExporter
from pulpcore.client.pulpcore.models.filesystem_exporter_response import FilesystemExporterResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ExportersFilesystemApi(api_client)
    pulp_domain = 'pulp_domain_example' # str | 
    filesystem_exporter = pulpcore.client.pulpcore.FilesystemExporter() # FilesystemExporter | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

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

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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(filesystem_exporter_href, x_task_diagnostics=x_task_diagnostics)

Delete a filesystem exporter

Trigger an asynchronous delete task

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.async_operation_response import AsyncOperationResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ExportersFilesystemApi(api_client)
    filesystem_exporter_href = 'filesystem_exporter_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

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

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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

PaginatedFilesystemExporterResponseList 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, q=q, fields=fields, exclude_fields=exclude_fields)

List filesystem exporters

Endpoint for managing FilesystemExporters.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.paginated_filesystem_exporter_response_list import PaginatedFilesystemExporterResponseList
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ExportersFilesystemApi(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) * `path` - Path * `-path` - Path (descending) * `method` - Method * `-method` - Method (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)
    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 filesystem exporters
        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, q=q, fields=fields, exclude_fields=exclude_fields)
        print("The response of ExportersFilesystemApi->list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ExportersFilesystemApi->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) * `path` - Path * `-path` - Path (descending) * `method` - Method * `-method` - Method (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]
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

PaginatedFilesystemExporterResponseList

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

FilesystemExporterResponse partial_update(filesystem_exporter_href, patched_filesystem_exporter, x_task_diagnostics=x_task_diagnostics)

Update a filesystem exporter

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.pulpcore
from pulpcore.client.pulpcore.models.filesystem_exporter_response import FilesystemExporterResponse
from pulpcore.client.pulpcore.models.patched_filesystem_exporter import PatchedFilesystemExporter
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ExportersFilesystemApi(api_client)
    filesystem_exporter_href = 'filesystem_exporter_href_example' # str | 
    patched_filesystem_exporter = pulpcore.client.pulpcore.PatchedFilesystemExporter() # PatchedFilesystemExporter | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Update a filesystem exporter
        api_response = api_instance.partial_update(filesystem_exporter_href, patched_filesystem_exporter, x_task_diagnostics=x_task_diagnostics)
        print("The response of ExportersFilesystemApi->partial_update:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ExportersFilesystemApi->partial_update: %s\n" % e)

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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

FilesystemExporterResponse read(filesystem_exporter_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

Inspect a filesystem exporter

Endpoint for managing FilesystemExporters.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.filesystem_exporter_response import FilesystemExporterResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ExportersFilesystemApi(api_client)
    filesystem_exporter_href = 'filesystem_exporter_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 filesystem exporter
        api_response = api_instance.read(filesystem_exporter_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of ExportersFilesystemApi->read:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ExportersFilesystemApi->read: %s\n" % e)

Parameters

Name	Type	Description	Notes
filesystem_exporter_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

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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]

update

FilesystemExporterResponse update(filesystem_exporter_href, filesystem_exporter, x_task_diagnostics=x_task_diagnostics)

Update a filesystem exporter

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.pulpcore
from pulpcore.client.pulpcore.models.filesystem_exporter import FilesystemExporter
from pulpcore.client.pulpcore.models.filesystem_exporter_response import FilesystemExporterResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ExportersFilesystemApi(api_client)
    filesystem_exporter_href = 'filesystem_exporter_href_example' # str | 
    filesystem_exporter = pulpcore.client.pulpcore.FilesystemExporter() # FilesystemExporter | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Update a filesystem exporter
        api_response = api_instance.update(filesystem_exporter_href, filesystem_exporter, x_task_diagnostics=x_task_diagnostics)
        print("The response of ExportersFilesystemApi->update:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ExportersFilesystemApi->update: %s\n" % e)

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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.pulpcore.ExportersFilesystemExportsApi

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

Method	HTTP request	Description
create	POST {filesystem_exporter_href}exports/	Create a filesystem export
delete	DELETE {filesystem_filesystem_export_href}	Delete a filesystem export
list	GET {filesystem_exporter_href}exports/	List filesystem exports
read	GET {filesystem_filesystem_export_href}	Inspect a filesystem export

create

AsyncOperationResponse create(filesystem_exporter_href, filesystem_export, x_task_diagnostics=x_task_diagnostics)

Create a filesystem export

Trigger an asynchronous task to export files to the filesystem

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.async_operation_response import AsyncOperationResponse
from pulpcore.client.pulpcore.models.filesystem_export import FilesystemExport
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ExportersFilesystemExportsApi(api_client)
    filesystem_exporter_href = 'filesystem_exporter_href_example' # str | 
    filesystem_export = pulpcore.client.pulpcore.FilesystemExport() # FilesystemExport | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Create a filesystem export
        api_response = api_instance.create(filesystem_exporter_href, filesystem_export, x_task_diagnostics=x_task_diagnostics)
        print("The response of ExportersFilesystemExportsApi->create:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ExportersFilesystemExportsApi->create: %s\n" % e)

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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

delete(filesystem_filesystem_export_href, x_task_diagnostics=x_task_diagnostics)

Delete a filesystem export

Endpoint for managing FilesystemExports.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

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

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ExportersFilesystemExportsApi(api_client)
    filesystem_filesystem_export_href = 'filesystem_filesystem_export_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Delete a filesystem export
        api_instance.delete(filesystem_filesystem_export_href, x_task_diagnostics=x_task_diagnostics)
    except Exception as e:
        print("Exception when calling ExportersFilesystemExportsApi->delete: %s\n" % e)

Parameters

Name	Type	Description	Notes
filesystem_filesystem_export_href	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
204	No response body	-

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

list

PaginatedFilesystemExportResponseList list(filesystem_exporter_href, x_task_diagnostics=x_task_diagnostics, limit=limit, offset=offset, fields=fields, exclude_fields=exclude_fields)

List filesystem exports

Endpoint for managing FilesystemExports.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.paginated_filesystem_export_response_list import PaginatedFilesystemExportResponseList
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ExportersFilesystemExportsApi(api_client)
    filesystem_exporter_href = 'filesystem_exporter_href_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)
    offset = 56 # int | The initial index from which to return the results. (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 filesystem exports
        api_response = api_instance.list(filesystem_exporter_href, x_task_diagnostics=x_task_diagnostics, limit=limit, offset=offset, fields=fields, exclude_fields=exclude_fields)
        print("The response of ExportersFilesystemExportsApi->list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ExportersFilesystemExportsApi->list: %s\n" % e)

Parameters

Name	Type	Description	Notes
filesystem_exporter_href	str
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]
limit	int	Number of results to return per page.	[optional]
offset	int	The initial index from which to return the results.	[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

PaginatedFilesystemExportResponseList

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

FilesystemExportResponse read(filesystem_filesystem_export_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

Inspect a filesystem export

Endpoint for managing FilesystemExports.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.filesystem_export_response import FilesystemExportResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ExportersFilesystemExportsApi(api_client)
    filesystem_filesystem_export_href = 'filesystem_filesystem_export_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 filesystem export
        api_response = api_instance.read(filesystem_filesystem_export_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of ExportersFilesystemExportsApi->read:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ExportersFilesystemExportsApi->read: %s\n" % e)

Parameters

Name	Type	Description	Notes
filesystem_filesystem_export_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

FilesystemExportResponse

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]

pulpcore.client.pulpcore.ExportersPulpApi

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

Method	HTTP request	Description
create	POST /api/pulp/{pulp_domain}/api/v3/exporters/core/pulp/	Create a pulp exporter
delete	DELETE {pulp_exporter_href}	Delete a pulp exporter
list	GET /api/pulp/{pulp_domain}/api/v3/exporters/core/pulp/	List pulp exporters
partial_update	PATCH {pulp_exporter_href}	Update a pulp exporter
read	GET {pulp_exporter_href}	Inspect a pulp exporter
update	PUT {pulp_exporter_href}	Update a pulp exporter

create

PulpExporterResponse create(pulp_domain, pulp_exporter, x_task_diagnostics=x_task_diagnostics)

Create a pulp exporter

ViewSet for viewing PulpExporters.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.pulp_exporter import PulpExporter
from pulpcore.client.pulpcore.models.pulp_exporter_response import PulpExporterResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ExportersPulpApi(api_client)
    pulp_domain = 'pulp_domain_example' # str | 
    pulp_exporter = pulpcore.client.pulpcore.PulpExporter() # PulpExporter | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

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

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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(pulp_exporter_href, x_task_diagnostics=x_task_diagnostics)

Delete a pulp exporter

Trigger an asynchronous delete task

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.async_operation_response import AsyncOperationResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ExportersPulpApi(api_client)
    pulp_exporter_href = 'pulp_exporter_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

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

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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

PaginatedPulpExporterResponseList 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, q=q, fields=fields, exclude_fields=exclude_fields)

List pulp exporters

ViewSet for viewing PulpExporters.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.paginated_pulp_exporter_response_list import PaginatedPulpExporterResponseList
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ExportersPulpApi(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) * `path` - Path * `-path` - Path (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)
    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 pulp exporters
        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, q=q, fields=fields, exclude_fields=exclude_fields)
        print("The response of ExportersPulpApi->list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ExportersPulpApi->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) * `path` - Path * `-path` - Path (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]
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

PaginatedPulpExporterResponseList

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

PulpExporterResponse partial_update(pulp_exporter_href, patched_pulp_exporter, x_task_diagnostics=x_task_diagnostics)

Update a pulp exporter

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.pulpcore
from pulpcore.client.pulpcore.models.patched_pulp_exporter import PatchedPulpExporter
from pulpcore.client.pulpcore.models.pulp_exporter_response import PulpExporterResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ExportersPulpApi(api_client)
    pulp_exporter_href = 'pulp_exporter_href_example' # str | 
    patched_pulp_exporter = pulpcore.client.pulpcore.PatchedPulpExporter() # PatchedPulpExporter | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Update a pulp exporter
        api_response = api_instance.partial_update(pulp_exporter_href, patched_pulp_exporter, x_task_diagnostics=x_task_diagnostics)
        print("The response of ExportersPulpApi->partial_update:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ExportersPulpApi->partial_update: %s\n" % e)

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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

PulpExporterResponse read(pulp_exporter_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

Inspect a pulp exporter

ViewSet for viewing PulpExporters.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.pulp_exporter_response import PulpExporterResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ExportersPulpApi(api_client)
    pulp_exporter_href = 'pulp_exporter_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 pulp exporter
        api_response = api_instance.read(pulp_exporter_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of ExportersPulpApi->read:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ExportersPulpApi->read: %s\n" % e)

Parameters

Name	Type	Description	Notes
pulp_exporter_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

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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]

update

PulpExporterResponse update(pulp_exporter_href, pulp_exporter, x_task_diagnostics=x_task_diagnostics)

Update a pulp exporter

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.pulpcore
from pulpcore.client.pulpcore.models.pulp_exporter import PulpExporter
from pulpcore.client.pulpcore.models.pulp_exporter_response import PulpExporterResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ExportersPulpApi(api_client)
    pulp_exporter_href = 'pulp_exporter_href_example' # str | 
    pulp_exporter = pulpcore.client.pulpcore.PulpExporter() # PulpExporter | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Update a pulp exporter
        api_response = api_instance.update(pulp_exporter_href, pulp_exporter, x_task_diagnostics=x_task_diagnostics)
        print("The response of ExportersPulpApi->update:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ExportersPulpApi->update: %s\n" % e)

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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.pulpcore.ExportersPulpExportsApi

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

Method	HTTP request	Description
create	POST {pulp_exporter_href}exports/	Create a pulp export
delete	DELETE {pulp_pulp_export_href}	Delete a pulp export
list	GET {pulp_exporter_href}exports/	List pulp exports
read	GET {pulp_pulp_export_href}	Inspect a pulp export

create

AsyncOperationResponse create(pulp_exporter_href, pulp_export, x_task_diagnostics=x_task_diagnostics)

Create a pulp export

Trigger an asynchronous task to export a set of repositories

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.async_operation_response import AsyncOperationResponse
from pulpcore.client.pulpcore.models.pulp_export import PulpExport
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ExportersPulpExportsApi(api_client)
    pulp_exporter_href = 'pulp_exporter_href_example' # str | 
    pulp_export = pulpcore.client.pulpcore.PulpExport() # PulpExport | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Create a pulp export
        api_response = api_instance.create(pulp_exporter_href, pulp_export, x_task_diagnostics=x_task_diagnostics)
        print("The response of ExportersPulpExportsApi->create:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ExportersPulpExportsApi->create: %s\n" % e)

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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

delete(pulp_pulp_export_href, x_task_diagnostics=x_task_diagnostics)

Delete a pulp export

ViewSet for viewing exports from a PulpExporter.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

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

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ExportersPulpExportsApi(api_client)
    pulp_pulp_export_href = 'pulp_pulp_export_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Delete a pulp export
        api_instance.delete(pulp_pulp_export_href, x_task_diagnostics=x_task_diagnostics)
    except Exception as e:
        print("Exception when calling ExportersPulpExportsApi->delete: %s\n" % e)

Parameters

Name	Type	Description	Notes
pulp_pulp_export_href	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
204	No response body	-

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

list

PaginatedPulpExportResponseList list(pulp_exporter_href, x_task_diagnostics=x_task_diagnostics, limit=limit, offset=offset, fields=fields, exclude_fields=exclude_fields)

List pulp exports

ViewSet for viewing exports from a PulpExporter.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.paginated_pulp_export_response_list import PaginatedPulpExportResponseList
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ExportersPulpExportsApi(api_client)
    pulp_exporter_href = 'pulp_exporter_href_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)
    offset = 56 # int | The initial index from which to return the results. (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 pulp exports
        api_response = api_instance.list(pulp_exporter_href, x_task_diagnostics=x_task_diagnostics, limit=limit, offset=offset, fields=fields, exclude_fields=exclude_fields)
        print("The response of ExportersPulpExportsApi->list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ExportersPulpExportsApi->list: %s\n" % e)

Parameters

Name	Type	Description	Notes
pulp_exporter_href	str
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]
limit	int	Number of results to return per page.	[optional]
offset	int	The initial index from which to return the results.	[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

PaginatedPulpExportResponseList

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

PulpExportResponse read(pulp_pulp_export_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

Inspect a pulp export

ViewSet for viewing exports from a PulpExporter.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.pulp_export_response import PulpExportResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ExportersPulpExportsApi(api_client)
    pulp_pulp_export_href = 'pulp_pulp_export_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 pulp export
        api_response = api_instance.read(pulp_pulp_export_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of ExportersPulpExportsApi->read:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ExportersPulpExportsApi->read: %s\n" % e)

Parameters

Name	Type	Description	Notes
pulp_pulp_export_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

PulpExportResponse

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]

FilesystemExporter

Serializer for FilesystemExporters.

Properties

Name	Type	Description	Notes
name	str	Unique name of the exporter.
path	str	File system location to export to.
method	MethodEnum	Method of exporting * `write` - Export by writing * `hardlink` - Export by hardlinking * `symlink` - Export by symlinking	[optional]

Example

from pulpcore.client.pulpcore.models.filesystem_exporter import FilesystemExporter

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

# convert the object into a dict
filesystem_exporter_dict = filesystem_exporter_instance.to_dict()
# create an instance of FilesystemExporter from a dict
filesystem_exporter_from_dict = FilesystemExporter.from_dict(filesystem_exporter_dict)

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

FilesystemExporterResponse

Serializer for FilesystemExporters.

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]
name	str	Unique name of the exporter.
path	str	File system location to export to.
method	MethodEnum	Method of exporting * `write` - Export by writing * `hardlink` - Export by hardlinking * `symlink` - Export by symlinking	[optional]

Example

from pulpcore.client.pulpcore.models.filesystem_exporter_response import FilesystemExporterResponse

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

# convert the object into a dict
filesystem_exporter_response_dict = filesystem_exporter_response_instance.to_dict()
# create an instance of FilesystemExporterResponse from a dict
filesystem_exporter_response_from_dict = FilesystemExporterResponse.from_dict(filesystem_exporter_response_dict)

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

FilesystemExport

Serializer for FilesystemExports.

Properties

Name	Type	Description	Notes
task	str	A URI of the task that ran the Export.	[optional]
publication	str	A URI of the publication to be exported.	[optional]
repository_version	str	A URI of the repository version export.	[optional]
start_repository_version	str	The URI of the last-exported-repo-version.	[optional]

Example

from pulpcore.client.pulpcore.models.filesystem_export import FilesystemExport

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

# convert the object into a dict
filesystem_export_dict = filesystem_export_instance.to_dict()
# create an instance of FilesystemExport from a dict
filesystem_export_from_dict = FilesystemExport.from_dict(filesystem_export_dict)

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

FilesystemExportResponse

Serializer for FilesystemExports.

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]
task	str	A URI of the task that ran the Export.	[optional]
exported_resources	List[str]	Resources that were exported.	[optional] [readonly]
params	object	Any additional parameters that were used to create the export.	[optional] [readonly]

Example

from pulpcore.client.pulpcore.models.filesystem_export_response import FilesystemExportResponse

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

# convert the object into a dict
filesystem_export_response_dict = filesystem_export_response_instance.to_dict()
# create an instance of FilesystemExportResponse from a dict
filesystem_export_response_from_dict = FilesystemExportResponse.from_dict(filesystem_export_response_dict)

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

GenericRemoteResponseHiddenFieldsInner

Properties

Name	Type	Description	Notes
name	str
is_set	bool

Example

from pulpcore.client.pulpcore.models.generic_remote_response_hidden_fields_inner import GenericRemoteResponseHiddenFieldsInner

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

# convert the object into a dict
generic_remote_response_hidden_fields_inner_dict = generic_remote_response_hidden_fields_inner_instance.to_dict()
# create an instance of GenericRemoteResponseHiddenFieldsInner from a dict
generic_remote_response_hidden_fields_inner_from_dict = GenericRemoteResponseHiddenFieldsInner.from_dict(generic_remote_response_hidden_fields_inner_dict)

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

GenericRemoteResponse

Every remote defined by a plugin should have a Remote serializer that inherits from this class. Please import from pulpcore.plugin.serializers rather than from this module directly.

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.
pulp_labels	Dict[str, Optional[str]]		[optional]
policy	GenericRemoteResponsePolicyEnum	The policy to use when downloading content. * `immediate` - When syncing, download all metadata and content now. * `on_demand` - When syncing, download metadata, but do not download content now. Instead, download content as clients request it, and save it in Pulp to be served for future client requests. * `streamed` - When syncing, download metadata, but do not download content now. Instead,download content as clients request it, but never save it in Pulp. This causes future requests for that same content to have to be downloaded again.	[optional]
hidden_fields	List[GenericRemoteResponseHiddenFieldsInner]	List of hidden (write only) fields	[optional] [readonly]
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]
max_retries	int	Maximum number of retry attempts after a download failure. If not set then the default value (3) will be used.	[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]
download_concurrency	int	Total number of simultaneous connections. If not set then the default value will be used.	[optional]
rate_limit	int	Limits requests per second for each concurrent downloader	[optional]

Example

from pulpcore.client.pulpcore.models.generic_remote_response import GenericRemoteResponse

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

# convert the object into a dict
generic_remote_response_dict = generic_remote_response_instance.to_dict()
# create an instance of GenericRemoteResponse from a dict
generic_remote_response_from_dict = GenericRemoteResponse.from_dict(generic_remote_response_dict)

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

GenericRemoteResponsePolicyEnum

immediate - When syncing, download all metadata and content now. * on_demand - When syncing, download metadata, but do not download content now. Instead, download content as clients request it, and save it in Pulp to be served for future client requests. * streamed - When syncing, download metadata, but do not download content now. Instead,download content as clients request it, but never save it in Pulp. This causes future requests for that same content to have to be downloaded again.

Enum

IMMEDIATE (value: 'immediate')
ON_DEMAND (value: 'on_demand')
STREAMED (value: 'streamed')

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

Group

Serializer for Group.

Properties

Name	Type	Description	Notes
name	str	Name

Example

from pulpcore.client.pulpcore.models.group import Group

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

# convert the object into a dict
group_dict = group_instance.to_dict()
# create an instance of Group from a dict
group_from_dict = Group.from_dict(group_dict)

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

GroupProgressReportResponse

Properties

Name	Type	Description	Notes
message	str	The message shown to the user for the group progress report.	[optional] [readonly]
code	str	Identifies the type of group progress report'.	[optional] [readonly]
total	int	The total count of items.	[optional] [readonly]
done	int	The count of items already processed. Defaults to 0.	[optional] [readonly]
suffix	str	The suffix to be shown with the group progress report.	[optional] [readonly]

Example

from pulpcore.client.pulpcore.models.group_progress_report_response import GroupProgressReportResponse

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

# convert the object into a dict
group_progress_report_response_dict = group_progress_report_response_instance.to_dict()
# create an instance of GroupProgressReportResponse from a dict
group_progress_report_response_from_dict = GroupProgressReportResponse.from_dict(group_progress_report_response_dict)

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

GroupResponse

Serializer for Group.

Properties

Name	Type	Description	Notes
name	str	Name
pulp_href	str		[optional] [readonly]
prn	str		[optional] [readonly]
id	int		[optional] [readonly]

Example

from pulpcore.client.pulpcore.models.group_response import GroupResponse

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

# convert the object into a dict
group_response_dict = group_response_instance.to_dict()
# create an instance of GroupResponse from a dict
group_response_from_dict = GroupResponse.from_dict(group_response_dict)

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

GroupRole

Serializer for GroupRole.

Properties

Name	Type	Description	Notes
role	str
content_object	str	pulp_href of the object for which role permissions should be asserted. If set to 'null', permissions will act on the model-level.	[optional]
content_object_prn	str	prn of the object for which role permissions should be asserted. If set to 'null', permissions will act on either domain or model-level.	[optional]
domain	str	Domain this role should be applied on, mutually exclusive with content_object.	[optional]

Example

from pulpcore.client.pulpcore.models.group_role import GroupRole

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

# convert the object into a dict
group_role_dict = group_role_instance.to_dict()
# create an instance of GroupRole from a dict
group_role_from_dict = GroupRole.from_dict(group_role_dict)

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

GroupRoleResponse

Serializer for GroupRole.

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]
role	str
content_object	str	pulp_href of the object for which role permissions should be asserted. If set to 'null', permissions will act on the model-level.	[optional]
content_object_prn	str	prn of the object for which role permissions should be asserted. If set to 'null', permissions will act on either domain or model-level.	[optional]
description	str		[optional] [readonly]
permissions	List[str]		[optional] [readonly]
domain	str	Domain this role should be applied on, mutually exclusive with content_object.	[optional]

Example

from pulpcore.client.pulpcore.models.group_role_response import GroupRoleResponse

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

# convert the object into a dict
group_role_response_dict = group_role_response_instance.to_dict()
# create an instance of GroupRoleResponse from a dict
group_role_response_from_dict = GroupRoleResponse.from_dict(group_role_response_dict)

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

pulpcore.client.pulpcore.GroupsApi

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

Method	HTTP request	Description
add_role	POST {group_href}add_role/	Add a role
create	POST /api/pulp/{pulp_domain}/api/v3/groups/	Create a group
delete	DELETE {group_href}	Delete a group
list	GET /api/pulp/{pulp_domain}/api/v3/groups/	List groups
list_roles	GET {group_href}list_roles/	List roles
my_permissions	GET {group_href}my_permissions/	List user permissions
partial_update	PATCH {group_href}	Update a group
read	GET {group_href}	Inspect a group
remove_role	POST {group_href}remove_role/	Remove a role
update	PUT {group_href}	Update a group

add_role

NestedRoleResponse add_role(group_href, nested_role, x_task_diagnostics=x_task_diagnostics)

Add a role

Add a role for this object to users/groups.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.nested_role import NestedRole
from pulpcore.client.pulpcore.models.nested_role_response import NestedRoleResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.GroupsApi(api_client)
    group_href = 'group_href_example' # str | 
    nested_role = pulpcore.client.pulpcore.NestedRole() # NestedRole | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Add a role
        api_response = api_instance.add_role(group_href, nested_role, x_task_diagnostics=x_task_diagnostics)
        print("The response of GroupsApi->add_role:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling GroupsApi->add_role: %s\n" % e)

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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]

create

GroupResponse create(pulp_domain, group, x_task_diagnostics=x_task_diagnostics)

Create a group

ViewSet for Group.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.group import Group
from pulpcore.client.pulpcore.models.group_response import GroupResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.GroupsApi(api_client)
    pulp_domain = 'pulp_domain_example' # str | 
    group = pulpcore.client.pulpcore.Group() # Group | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

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

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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

delete(group_href, x_task_diagnostics=x_task_diagnostics)

Delete a group

ViewSet for Group.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

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

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.GroupsApi(api_client)
    group_href = 'group_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Delete a group
        api_instance.delete(group_href, x_task_diagnostics=x_task_diagnostics)
    except Exception as e:
        print("Exception when calling GroupsApi->delete: %s\n" % e)

Parameters

Name	Type	Description	Notes
group_href	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
204	No response body	-

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

list

PaginatedGroupResponseList list(pulp_domain, x_task_diagnostics=x_task_diagnostics, id=id, id__in=id__in, limit=limit, name=name, name__contains=name__contains, name__icontains=name__icontains, name__iexact=name__iexact, name__in=name__in, offset=offset, ordering=ordering, prn__in=prn__in, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, q=q, fields=fields, exclude_fields=exclude_fields)

List groups

ViewSet for Group.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.paginated_group_response_list import PaginatedGroupResponseList
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.GroupsApi(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)
    id = 56 # int | Filter results where id matches value (optional)
    id__in = [56] # List[int] | Filter results where id is in a comma-separated list of values (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)
    offset = 56 # int | The initial index from which to return the results. (optional)
    ordering = ['ordering_example'] # List[str] | Ordering  * `id` - Id * `-id` - Id (descending) * `name` - Name * `-name` - Name (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)
    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 groups
        api_response = api_instance.list(pulp_domain, x_task_diagnostics=x_task_diagnostics, id=id, id__in=id__in, limit=limit, name=name, name__contains=name__contains, name__icontains=name__icontains, name__iexact=name__iexact, name__in=name__in, offset=offset, ordering=ordering, prn__in=prn__in, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, q=q, fields=fields, exclude_fields=exclude_fields)
        print("The response of GroupsApi->list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling GroupsApi->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]
id	int	Filter results where id matches value	[optional]
id__in	List[int]	Filter results where id is in a comma-separated list of values	[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]
offset	int	The initial index from which to return the results.	[optional]
ordering	List[str]	Ordering * `id` - Id * `-id` - Id (descending) * `name` - Name * `-name` - Name (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]
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

PaginatedGroupResponseList

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]

list_roles

ObjectRolesResponse list_roles(group_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

List roles

List roles assigned to this object.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.object_roles_response import ObjectRolesResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.GroupsApi(api_client)
    group_href = 'group_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:
        # List roles
        api_response = api_instance.list_roles(group_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of GroupsApi->list_roles:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling GroupsApi->list_roles: %s\n" % e)

Parameters

Name	Type	Description	Notes
group_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

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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]

my_permissions

MyPermissionsResponse my_permissions(group_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

List user permissions

List permissions available to the current user on this object.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.my_permissions_response import MyPermissionsResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.GroupsApi(api_client)
    group_href = 'group_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:
        # List user permissions
        api_response = api_instance.my_permissions(group_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of GroupsApi->my_permissions:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling GroupsApi->my_permissions: %s\n" % e)

Parameters

Name	Type	Description	Notes
group_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

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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

GroupResponse partial_update(group_href, patched_group, x_task_diagnostics=x_task_diagnostics)

Update a group

ViewSet for Group.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.group_response import GroupResponse
from pulpcore.client.pulpcore.models.patched_group import PatchedGroup
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.GroupsApi(api_client)
    group_href = 'group_href_example' # str | 
    patched_group = pulpcore.client.pulpcore.PatchedGroup() # PatchedGroup | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Update a group
        api_response = api_instance.partial_update(group_href, patched_group, x_task_diagnostics=x_task_diagnostics)
        print("The response of GroupsApi->partial_update:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling GroupsApi->partial_update: %s\n" % e)

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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]

read

GroupResponse read(group_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

Inspect a group

ViewSet for Group.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.group_response import GroupResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.GroupsApi(api_client)
    group_href = 'group_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 group
        api_response = api_instance.read(group_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of GroupsApi->read:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling GroupsApi->read: %s\n" % e)

Parameters

Name	Type	Description	Notes
group_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

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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]

remove_role

NestedRoleResponse remove_role(group_href, nested_role, x_task_diagnostics=x_task_diagnostics)

Remove a role

Remove a role for this object from users/groups.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.nested_role import NestedRole
from pulpcore.client.pulpcore.models.nested_role_response import NestedRoleResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.GroupsApi(api_client)
    group_href = 'group_href_example' # str | 
    nested_role = pulpcore.client.pulpcore.NestedRole() # NestedRole | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Remove a role
        api_response = api_instance.remove_role(group_href, nested_role, x_task_diagnostics=x_task_diagnostics)
        print("The response of GroupsApi->remove_role:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling GroupsApi->remove_role: %s\n" % e)

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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

GroupResponse update(group_href, group, x_task_diagnostics=x_task_diagnostics)

Update a group

ViewSet for Group.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.group import Group
from pulpcore.client.pulpcore.models.group_response import GroupResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.GroupsApi(api_client)
    group_href = 'group_href_example' # str | 
    group = pulpcore.client.pulpcore.Group() # Group | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

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

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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]

pulpcore.client.pulpcore.GroupsRolesApi

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

Method	HTTP request	Description
create	POST {group_href}roles/	Create a group role
delete	DELETE {groups_group_role_href}	Delete a group role
list	GET {group_href}roles/	List group roles
read	GET {groups_group_role_href}	Inspect a group role

create

GroupRoleResponse create(group_href, group_role, x_task_diagnostics=x_task_diagnostics)

Create a group role

ViewSet for GroupRole.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.group_role import GroupRole
from pulpcore.client.pulpcore.models.group_role_response import GroupRoleResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.GroupsRolesApi(api_client)
    group_href = 'group_href_example' # str | 
    group_role = pulpcore.client.pulpcore.GroupRole() # GroupRole | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Create a group role
        api_response = api_instance.create(group_href, group_role, x_task_diagnostics=x_task_diagnostics)
        print("The response of GroupsRolesApi->create:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling GroupsRolesApi->create: %s\n" % e)

Parameters

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

Return type

GroupRoleResponse

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

delete(groups_group_role_href, x_task_diagnostics=x_task_diagnostics)

Delete a group role

ViewSet for GroupRole.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

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

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.GroupsRolesApi(api_client)
    groups_group_role_href = 'groups_group_role_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Delete a group role
        api_instance.delete(groups_group_role_href, x_task_diagnostics=x_task_diagnostics)
    except Exception as e:
        print("Exception when calling GroupsRolesApi->delete: %s\n" % e)

Parameters

Name	Type	Description	Notes
groups_group_role_href	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
204	No response body	-

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

list

PaginatedGroupRoleResponseList list(group_href, x_task_diagnostics=x_task_diagnostics, content_object=content_object, domain=domain, limit=limit, offset=offset, ordering=ordering, prn__in=prn__in, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, q=q, role=role, role__contains=role__contains, role__icontains=role__icontains, role__in=role__in, role__startswith=role__startswith, fields=fields, exclude_fields=exclude_fields)

List group roles

ViewSet for GroupRole.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.paginated_group_role_response_list import PaginatedGroupRoleResponseList
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.GroupsRolesApi(api_client)
    group_href = 'group_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    content_object = 'content_object_example' # str | content_object (optional)
    domain = 'domain_example' # str | Foreign Key referenced by HREF (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  * `role` - Role * `-role` - Role (descending) * `description` - Description * `-description` - Description (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (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)
    q = 'q_example' # str | Filter results by using NOT, AND and OR operations on other filters (optional)
    role = 'role_example' # str |  (optional)
    role__contains = 'role__contains_example' # str |  (optional)
    role__icontains = 'role__icontains_example' # str |  (optional)
    role__in = ['role__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
    role__startswith = 'role__startswith_example' # str |  (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 group roles
        api_response = api_instance.list(group_href, x_task_diagnostics=x_task_diagnostics, content_object=content_object, domain=domain, limit=limit, offset=offset, ordering=ordering, prn__in=prn__in, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, q=q, role=role, role__contains=role__contains, role__icontains=role__icontains, role__in=role__in, role__startswith=role__startswith, fields=fields, exclude_fields=exclude_fields)
        print("The response of GroupsRolesApi->list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling GroupsRolesApi->list: %s\n" % e)

Parameters

Name	Type	Description	Notes
group_href	str
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]
content_object	str	content_object	[optional]
domain	str	Foreign Key referenced by HREF	[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 * `role` - Role * `-role` - Role (descending) * `description` - Description * `-description` - Description (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (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]
q	str	Filter results by using NOT, AND and OR operations on other filters	[optional]
role	str		[optional]
role__contains	str		[optional]
role__icontains	str		[optional]
role__in	List[str]	Multiple values may be separated by commas.	[optional]
role__startswith	str		[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

PaginatedGroupRoleResponseList

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

GroupRoleResponse read(groups_group_role_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

Inspect a group role

ViewSet for GroupRole.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.group_role_response import GroupRoleResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.GroupsRolesApi(api_client)
    groups_group_role_href = 'groups_group_role_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 group role
        api_response = api_instance.read(groups_group_role_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of GroupsRolesApi->read:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling GroupsRolesApi->read: %s\n" % e)

Parameters

Name	Type	Description	Notes
groups_group_role_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

GroupRoleResponse

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]

pulpcore.client.pulpcore.GroupsUsersApi

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

Method	HTTP request	Description
create	POST {group_href}users/	Create an user
delete	DELETE {groups_user_href}	Delete an user
list	GET {group_href}users/	List users

create

GroupUserResponse create(group_href, group_user, x_task_diagnostics=x_task_diagnostics)

Create an user

Add a user to a group.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.group_user import GroupUser
from pulpcore.client.pulpcore.models.group_user_response import GroupUserResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.GroupsUsersApi(api_client)
    group_href = 'group_href_example' # str | 
    group_user = pulpcore.client.pulpcore.GroupUser() # GroupUser | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Create an user
        api_response = api_instance.create(group_href, group_user, x_task_diagnostics=x_task_diagnostics)
        print("The response of GroupsUsersApi->create:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling GroupsUsersApi->create: %s\n" % e)

Parameters

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

Return type

GroupUserResponse

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

delete(groups_user_href, x_task_diagnostics=x_task_diagnostics)

Delete an user

Remove a user from a group.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

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

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.GroupsUsersApi(api_client)
    groups_user_href = 'groups_user_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Delete an user
        api_instance.delete(groups_user_href, x_task_diagnostics=x_task_diagnostics)
    except Exception as e:
        print("Exception when calling GroupsUsersApi->delete: %s\n" % e)

Parameters

Name	Type	Description	Notes
groups_user_href	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
204	No response body	-

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

list

PaginatedGroupUserResponseList list(group_href, x_task_diagnostics=x_task_diagnostics, limit=limit, offset=offset, fields=fields, exclude_fields=exclude_fields)

List users

List group users.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.paginated_group_user_response_list import PaginatedGroupUserResponseList
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.GroupsUsersApi(api_client)
    group_href = 'group_href_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)
    offset = 56 # int | The initial index from which to return the results. (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 users
        api_response = api_instance.list(group_href, x_task_diagnostics=x_task_diagnostics, limit=limit, offset=offset, fields=fields, exclude_fields=exclude_fields)
        print("The response of GroupsUsersApi->list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling GroupsUsersApi->list: %s\n" % e)

Parameters

Name	Type	Description	Notes
group_href	str
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]
limit	int	Number of results to return per page.	[optional]
offset	int	The initial index from which to return the results.	[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

PaginatedGroupUserResponseList

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]

GroupUser

Serializer for Users that belong to a Group.

Properties

Name	Type	Description	Notes
username	str	Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

Example

from pulpcore.client.pulpcore.models.group_user import GroupUser

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

# convert the object into a dict
group_user_dict = group_user_instance.to_dict()
# create an instance of GroupUser from a dict
group_user_from_dict = GroupUser.from_dict(group_user_dict)

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

GroupUserResponse

Serializer for Users that belong to a Group.

Properties

Name	Type	Description	Notes
username	str	Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
pulp_href	str		[optional] [readonly]
prn	str		[optional] [readonly]

Example

from pulpcore.client.pulpcore.models.group_user_response import GroupUserResponse

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

# convert the object into a dict
group_user_response_dict = group_user_response_instance.to_dict()
# create an instance of GroupUserResponse from a dict
group_user_response_from_dict = GroupUserResponse.from_dict(group_user_response_dict)

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

HeaderContentGuard

A serializer for HeaderContentGuard.

Properties

Name	Type	Description	Notes
name	str	The unique name.
description	str	An optional description.	[optional]
header_name	str	The header name the guard will check on.
header_value	str	The value that will authorize the request.
jq_filter	str	A JQ syntax compatible filter. If jq_filter is not set, then the value willonly be Base64 decoded and checked as an explicit string match.	[optional]

Example

from pulpcore.client.pulpcore.models.header_content_guard import HeaderContentGuard

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

# convert the object into a dict
header_content_guard_dict = header_content_guard_instance.to_dict()
# create an instance of HeaderContentGuard from a dict
header_content_guard_from_dict = HeaderContentGuard.from_dict(header_content_guard_dict)

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

HeaderContentGuardResponse

A serializer for HeaderContentGuard.

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]
name	str	The unique name.
description	str	An optional description.	[optional]
header_name	str	The header name the guard will check on.
header_value	str	The value that will authorize the request.
jq_filter	str	A JQ syntax compatible filter. If jq_filter is not set, then the value willonly be Base64 decoded and checked as an explicit string match.	[optional]

Example

from pulpcore.client.pulpcore.models.header_content_guard_response import HeaderContentGuardResponse

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

# convert the object into a dict
header_content_guard_response_dict = header_content_guard_response_instance.to_dict()
# create an instance of HeaderContentGuardResponse from a dict
header_content_guard_response_from_dict = HeaderContentGuardResponse.from_dict(header_content_guard_response_dict)

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

pulpcore.client.pulpcore.ImportersPulpApi

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

Method	HTTP request	Description
create	POST /api/pulp/{pulp_domain}/api/v3/importers/core/pulp/	Create a pulp importer
delete	DELETE {pulp_importer_href}	Delete a pulp importer
list	GET /api/pulp/{pulp_domain}/api/v3/importers/core/pulp/	List pulp importers
partial_update	PATCH {pulp_importer_href}	Update a pulp importer
read	GET {pulp_importer_href}	Inspect a pulp importer
update	PUT {pulp_importer_href}	Update a pulp importer

create

PulpImporterResponse create(pulp_domain, pulp_importer, x_task_diagnostics=x_task_diagnostics)

Create a pulp importer

ViewSet for PulpImporters.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.pulp_importer import PulpImporter
from pulpcore.client.pulpcore.models.pulp_importer_response import PulpImporterResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ImportersPulpApi(api_client)
    pulp_domain = 'pulp_domain_example' # str | 
    pulp_importer = pulpcore.client.pulpcore.PulpImporter() # PulpImporter | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

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

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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

delete(pulp_importer_href, x_task_diagnostics=x_task_diagnostics)

Delete a pulp importer

ViewSet for PulpImporters.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

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

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ImportersPulpApi(api_client)
    pulp_importer_href = 'pulp_importer_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Delete a pulp importer
        api_instance.delete(pulp_importer_href, x_task_diagnostics=x_task_diagnostics)
    except Exception as e:
        print("Exception when calling ImportersPulpApi->delete: %s\n" % e)

Parameters

Name	Type	Description	Notes
pulp_importer_href	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
204	No response body	-

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

list

PaginatedPulpImporterResponseList 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, q=q, fields=fields, exclude_fields=exclude_fields)

List pulp importers

ViewSet for PulpImporters.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.paginated_pulp_importer_response_list import PaginatedPulpImporterResponseList
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ImportersPulpApi(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) * `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)
    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 pulp importers
        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, q=q, fields=fields, exclude_fields=exclude_fields)
        print("The response of ImportersPulpApi->list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ImportersPulpApi->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) * `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]
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

PaginatedPulpImporterResponseList

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

PulpImporterResponse partial_update(pulp_importer_href, patched_pulp_importer, x_task_diagnostics=x_task_diagnostics)

Update a pulp importer

ViewSet for PulpImporters.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.patched_pulp_importer import PatchedPulpImporter
from pulpcore.client.pulpcore.models.pulp_importer_response import PulpImporterResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ImportersPulpApi(api_client)
    pulp_importer_href = 'pulp_importer_href_example' # str | 
    patched_pulp_importer = pulpcore.client.pulpcore.PatchedPulpImporter() # PatchedPulpImporter | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Update a pulp importer
        api_response = api_instance.partial_update(pulp_importer_href, patched_pulp_importer, x_task_diagnostics=x_task_diagnostics)
        print("The response of ImportersPulpApi->partial_update:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ImportersPulpApi->partial_update: %s\n" % e)

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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]

read

PulpImporterResponse read(pulp_importer_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

Inspect a pulp importer

ViewSet for PulpImporters.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.pulp_importer_response import PulpImporterResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ImportersPulpApi(api_client)
    pulp_importer_href = 'pulp_importer_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 pulp importer
        api_response = api_instance.read(pulp_importer_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of ImportersPulpApi->read:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ImportersPulpApi->read: %s\n" % e)

Parameters

Name	Type	Description	Notes
pulp_importer_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

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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]

update

PulpImporterResponse update(pulp_importer_href, pulp_importer, x_task_diagnostics=x_task_diagnostics)

Update a pulp importer

ViewSet for PulpImporters.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.pulp_importer import PulpImporter
from pulpcore.client.pulpcore.models.pulp_importer_response import PulpImporterResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ImportersPulpApi(api_client)
    pulp_importer_href = 'pulp_importer_href_example' # str | 
    pulp_importer = pulpcore.client.pulpcore.PulpImporter() # PulpImporter | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Update a pulp importer
        api_response = api_instance.update(pulp_importer_href, pulp_importer, x_task_diagnostics=x_task_diagnostics)
        print("The response of ImportersPulpApi->update:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ImportersPulpApi->update: %s\n" % e)

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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]

pulpcore.client.pulpcore.ImportersPulpImportCheckApi

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

Method	HTTP request	Description
pulp_import_check_post	POST /api/pulp/{pulp_domain}/api/v3/importers/core/pulp/import-check/	Validate the parameters to be used for a PulpImport call

pulp_import_check_post

PulpImportCheckResponse pulp_import_check_post(pulp_domain, pulp_import_check, x_task_diagnostics=x_task_diagnostics)

Validate the parameters to be used for a PulpImport call

Evaluates validity of proposed PulpImport parameters 'toc', 'path', and 'repo_mapping'. * Checks that toc, path are in ALLOWED_IMPORT_PATHS * if ALLOWED: * Checks that toc, path exist and are readable * If toc specified, checks that containing dir is writeable * Checks that repo_mapping is valid JSON

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.pulp_import_check import PulpImportCheck
from pulpcore.client.pulpcore.models.pulp_import_check_response import PulpImportCheckResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ImportersPulpImportCheckApi(api_client)
    pulp_domain = 'pulp_domain_example' # str | 
    pulp_import_check = pulpcore.client.pulpcore.PulpImportCheck() # PulpImportCheck | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Validate the parameters to be used for a PulpImport call
        api_response = api_instance.pulp_import_check_post(pulp_domain, pulp_import_check, x_task_diagnostics=x_task_diagnostics)
        print("The response of ImportersPulpImportCheckApi->pulp_import_check_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ImportersPulpImportCheckApi->pulp_import_check_post: %s\n" % e)

Parameters

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

Return type

PulpImportCheckResponse

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]

pulpcore.client.pulpcore.ImportersPulpImportsApi

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

Method	HTTP request	Description
create	POST {pulp_importer_href}imports/	Create a pulp import
delete	DELETE {pulp_pulp_import_href}	Delete a pulp import
list	GET {pulp_importer_href}imports/	List pulp imports
read	GET {pulp_pulp_import_href}	Inspect a pulp import

create

TaskGroupOperationResponse create(pulp_importer_href, pulp_import, x_task_diagnostics=x_task_diagnostics)

Create a pulp import

Trigger an asynchronous task to import a Pulp export.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.pulp_import import PulpImport
from pulpcore.client.pulpcore.models.task_group_operation_response import TaskGroupOperationResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ImportersPulpImportsApi(api_client)
    pulp_importer_href = 'pulp_importer_href_example' # str | 
    pulp_import = pulpcore.client.pulpcore.PulpImport() # PulpImport | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Create a pulp import
        api_response = api_instance.create(pulp_importer_href, pulp_import, x_task_diagnostics=x_task_diagnostics)
        print("The response of ImportersPulpImportsApi->create:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ImportersPulpImportsApi->create: %s\n" % e)

Parameters

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

Return type

TaskGroupOperationResponse

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

delete(pulp_pulp_import_href, x_task_diagnostics=x_task_diagnostics)

Delete a pulp import

ViewSet for PulpImports.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

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

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ImportersPulpImportsApi(api_client)
    pulp_pulp_import_href = 'pulp_pulp_import_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Delete a pulp import
        api_instance.delete(pulp_pulp_import_href, x_task_diagnostics=x_task_diagnostics)
    except Exception as e:
        print("Exception when calling ImportersPulpImportsApi->delete: %s\n" % e)

Parameters

Name	Type	Description	Notes
pulp_pulp_import_href	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
204	No response body	-

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

list

PaginatedImportResponseList list(pulp_importer_href, x_task_diagnostics=x_task_diagnostics, limit=limit, offset=offset, fields=fields, exclude_fields=exclude_fields)

List pulp imports

ViewSet for PulpImports.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.paginated_import_response_list import PaginatedImportResponseList
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ImportersPulpImportsApi(api_client)
    pulp_importer_href = 'pulp_importer_href_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)
    offset = 56 # int | The initial index from which to return the results. (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 pulp imports
        api_response = api_instance.list(pulp_importer_href, x_task_diagnostics=x_task_diagnostics, limit=limit, offset=offset, fields=fields, exclude_fields=exclude_fields)
        print("The response of ImportersPulpImportsApi->list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ImportersPulpImportsApi->list: %s\n" % e)

Parameters

Name	Type	Description	Notes
pulp_importer_href	str
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]
limit	int	Number of results to return per page.	[optional]
offset	int	The initial index from which to return the results.	[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

PaginatedImportResponseList

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

ImportResponse read(pulp_pulp_import_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

Inspect a pulp import

ViewSet for PulpImports.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.import_response import ImportResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.ImportersPulpImportsApi(api_client)
    pulp_pulp_import_href = 'pulp_pulp_import_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 pulp import
        api_response = api_instance.read(pulp_pulp_import_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of ImportersPulpImportsApi->read:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ImportersPulpImportsApi->read: %s\n" % e)

Parameters

Name	Type	Description	Notes
pulp_pulp_import_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

ImportResponse

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]

ImportResponse

Serializer for Imports.

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]
task	str	A URI of the Task that ran the Import.
params	object	Any parameters that were used to create the import.

Example

from pulpcore.client.pulpcore.models.import_response import ImportResponse

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

# convert the object into a dict
import_response_dict = import_response_instance.to_dict()
# create an instance of ImportResponse from a dict
import_response_from_dict = ImportResponse.from_dict(import_response_dict)

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

pulpcore.client.pulpcore.LivezApi

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

Method	HTTP request	Description
livez_read	GET /api/pulp/api/v3/livez/	Inspect liveness of Pulp's REST API.

livez_read

livez_read(x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

Inspect liveness of Pulp's REST API.

Returns 200 OK when API is alive.

Example

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

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


# Enter a context with an instance of the API client
with pulpcore.client.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.LivezApi(api_client)
    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 liveness of Pulp's REST API.
        api_instance.livez_read(x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
    except Exception as e:
        print("Exception when calling LivezApi->livez_read: %s\n" % e)

Parameters

Name	Type	Description	Notes
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

No authorization required

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]

pulpcore.client.pulpcore.LoginApi

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

Method	HTTP request	Description
login	POST /api/pulp/{pulp_domain}/api/v3/login/
login_read	GET /api/pulp/{pulp_domain}/api/v3/login/
logout	DELETE /api/pulp/{pulp_domain}/api/v3/login/

login

LoginResponse login(pulp_domain, x_task_diagnostics=x_task_diagnostics)

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.login_response import LoginResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.LoginApi(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)

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

Parameters

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

Return type

LoginResponse

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
201		-

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

login_read

LoginResponse login_read(pulp_domain, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.login_response import LoginResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.LoginApi(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)
    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_response = api_instance.login_read(pulp_domain, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of LoginApi->login_read:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling LoginApi->login_read: %s\n" % e)

Parameters

Name	Type	Description	Notes
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

LoginResponse

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]

logout

logout(pulp_domain, x_task_diagnostics=x_task_diagnostics)

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

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

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.LoginApi(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)

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

Parameters

Name	Type	Description	Notes
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
204	No response body	-

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

LoginResponse

Properties

Name	Type	Notes
pulp_href	str	[optional] [readonly]
prn	str	[optional] [readonly]
username	str	[optional] [readonly]

Example

from pulpcore.client.pulpcore.models.login_response import LoginResponse

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

# convert the object into a dict
login_response_dict = login_response_instance.to_dict()
# create an instance of LoginResponse from a dict
login_response_from_dict = LoginResponse.from_dict(login_response_dict)

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

MethodEnum

write - Export by writing * hardlink - Export by hardlinking * symlink - Export by symlinking

Enum

WRITE (value: 'write')
HARDLINK (value: 'hardlink')
SYMLINK (value: 'symlink')

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

MinimalTaskResponse

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]
name	str	The name of task.
state	str	The current state of the task. The possible values include: 'waiting', 'skipped', 'running', 'completed', 'failed', 'canceled' and 'canceling'.	[optional] [readonly]
unblocked_at	datetime	Timestamp of when this task was identified ready for pickup.	[optional] [readonly]
started_at	datetime	Timestamp of when this task started execution.	[optional] [readonly]
finished_at	datetime	Timestamp of when this task stopped execution.	[optional] [readonly]
worker	str	DEPRECATED - Always null	[optional] [readonly]

Example

from pulpcore.client.pulpcore.models.minimal_task_response import MinimalTaskResponse

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

# convert the object into a dict
minimal_task_response_dict = minimal_task_response_instance.to_dict()
# create an instance of MinimalTaskResponse from a dict
minimal_task_response_from_dict = MinimalTaskResponse.from_dict(minimal_task_response_dict)

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

MultipleArtifactContentResponse

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]
artifacts	object	A dict mapping relative paths inside the Content to the correspondingArtifact URLs. E.g.: {'relative/path': '/artifacts/1/'

Example

from pulpcore.client.pulpcore.models.multiple_artifact_content_response import MultipleArtifactContentResponse

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

# convert the object into a dict
multiple_artifact_content_response_dict = multiple_artifact_content_response_instance.to_dict()
# create an instance of MultipleArtifactContentResponse from a dict
multiple_artifact_content_response_from_dict = MultipleArtifactContentResponse.from_dict(multiple_artifact_content_response_dict)

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

MyPermissionsResponse

Properties

Name	Type	Description	Notes
permissions	List[str]

Example

from pulpcore.client.pulpcore.models.my_permissions_response import MyPermissionsResponse

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

# convert the object into a dict
my_permissions_response_dict = my_permissions_response_instance.to_dict()
# create an instance of MyPermissionsResponse from a dict
my_permissions_response_from_dict = MyPermissionsResponse.from_dict(my_permissions_response_dict)

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

NestedOpenPGPPublicSubkey

Properties

Name	Type	Description	Notes
fingerprint	str
created	datetime

Example

from pulpcore.client.pulpcore.models.nested_open_pgp_public_subkey import NestedOpenPGPPublicSubkey

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

# convert the object into a dict
nested_open_pgp_public_subkey_dict = nested_open_pgp_public_subkey_instance.to_dict()
# create an instance of NestedOpenPGPPublicSubkey from a dict
nested_open_pgp_public_subkey_from_dict = NestedOpenPGPPublicSubkey.from_dict(nested_open_pgp_public_subkey_dict)

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

NestedOpenPGPPublicSubkeyResponse

Properties

Name	Type	Notes
fingerprint	str
created	datetime
signatures	List[NestedOpenPGPSignatureResponse]	[optional] [readonly]

Example

from pulpcore.client.pulpcore.models.nested_open_pgp_public_subkey_response import NestedOpenPGPPublicSubkeyResponse

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

# convert the object into a dict
nested_open_pgp_public_subkey_response_dict = nested_open_pgp_public_subkey_response_instance.to_dict()
# create an instance of NestedOpenPGPPublicSubkeyResponse from a dict
nested_open_pgp_public_subkey_response_from_dict = NestedOpenPGPPublicSubkeyResponse.from_dict(nested_open_pgp_public_subkey_response_dict)

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

NestedOpenPGPSignature

Properties

Name	Type	Notes
issuer	str	[optional]
created	datetime
expiration_time	str	[optional]
signers_user_id	str	[optional]
key_expiration_time	str	[optional]
expired	bool

Example

from pulpcore.client.pulpcore.models.nested_open_pgp_signature import NestedOpenPGPSignature

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

# convert the object into a dict
nested_open_pgp_signature_dict = nested_open_pgp_signature_instance.to_dict()
# create an instance of NestedOpenPGPSignature from a dict
nested_open_pgp_signature_from_dict = NestedOpenPGPSignature.from_dict(nested_open_pgp_signature_dict)

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

NestedOpenPGPSignatureResponse

Properties

Name	Type	Notes
issuer	str	[optional]
created	datetime
expiration_time	str	[optional]
signers_user_id	str	[optional]
key_expiration_time	str	[optional]
expired	bool
key_expired	str	[optional] [readonly]

Example

from pulpcore.client.pulpcore.models.nested_open_pgp_signature_response import NestedOpenPGPSignatureResponse

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

# convert the object into a dict
nested_open_pgp_signature_response_dict = nested_open_pgp_signature_response_instance.to_dict()
# create an instance of NestedOpenPGPSignatureResponse from a dict
nested_open_pgp_signature_response_from_dict = NestedOpenPGPSignatureResponse.from_dict(nested_open_pgp_signature_response_dict)

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

NestedOpenPGPUserAttribute

Properties

Name	Type	Description	Notes
sha256	str

Example

from pulpcore.client.pulpcore.models.nested_open_pgp_user_attribute import NestedOpenPGPUserAttribute

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

# convert the object into a dict
nested_open_pgp_user_attribute_dict = nested_open_pgp_user_attribute_instance.to_dict()
# create an instance of NestedOpenPGPUserAttribute from a dict
nested_open_pgp_user_attribute_from_dict = NestedOpenPGPUserAttribute.from_dict(nested_open_pgp_user_attribute_dict)

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

NestedOpenPGPUserAttributeResponse

Properties

Name	Type	Description	Notes
sha256	str
signatures	List[NestedOpenPGPSignatureResponse]		[optional] [readonly]

Example

from pulpcore.client.pulpcore.models.nested_open_pgp_user_attribute_response import NestedOpenPGPUserAttributeResponse

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

# convert the object into a dict
nested_open_pgp_user_attribute_response_dict = nested_open_pgp_user_attribute_response_instance.to_dict()
# create an instance of NestedOpenPGPUserAttributeResponse from a dict
nested_open_pgp_user_attribute_response_from_dict = NestedOpenPGPUserAttributeResponse.from_dict(nested_open_pgp_user_attribute_response_dict)

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

NestedOpenPGPUserID

Properties

Name	Type	Description	Notes
user_id	str

Example

from pulpcore.client.pulpcore.models.nested_open_pgp_user_id import NestedOpenPGPUserID

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

# convert the object into a dict
nested_open_pgp_user_id_dict = nested_open_pgp_user_id_instance.to_dict()
# create an instance of NestedOpenPGPUserID from a dict
nested_open_pgp_user_id_from_dict = NestedOpenPGPUserID.from_dict(nested_open_pgp_user_id_dict)

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

NestedOpenPGPUserIDResponse

Properties

Name	Type	Description	Notes
user_id	str
signatures	List[NestedOpenPGPSignatureResponse]		[optional] [readonly]

Example

from pulpcore.client.pulpcore.models.nested_open_pgp_user_id_response import NestedOpenPGPUserIDResponse

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

# convert the object into a dict
nested_open_pgp_user_id_response_dict = nested_open_pgp_user_id_response_instance.to_dict()
# create an instance of NestedOpenPGPUserIDResponse from a dict
nested_open_pgp_user_id_response_from_dict = NestedOpenPGPUserIDResponse.from_dict(nested_open_pgp_user_id_response_dict)

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

NestedRole

Serializer to add/remove object roles to/from users/groups. This is used in conjunction with pulpcore.app.viewsets.base.RolesMixin and requires the underlying object to be passed as content_object in the context.

Properties

Name	Type	Notes
users	List[str]	[optional] [default to []]
groups	List[str]	[optional] [default to []]
role	str

Example

from pulpcore.client.pulpcore.models.nested_role import NestedRole

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

# convert the object into a dict
nested_role_dict = nested_role_instance.to_dict()
# create an instance of NestedRole from a dict
nested_role_from_dict = NestedRole.from_dict(nested_role_dict)

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

NestedRoleResponse

Properties

Name	Type	Notes
users	List[str]	[optional] [default to []]
groups	List[str]	[optional] [default to []]
role	str

Example

from pulpcore.client.pulpcore.models.nested_role_response import NestedRoleResponse

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

# convert the object into a dict
nested_role_response_dict = nested_role_response_instance.to_dict()
# create an instance of NestedRoleResponse from a dict
nested_role_response_from_dict = NestedRoleResponse.from_dict(nested_role_response_dict)

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

ObjectRolesResponse

Properties

Name	Type	Description	Notes
roles	List[NestedRoleResponse]

Example

from pulpcore.client.pulpcore.models.object_roles_response import ObjectRolesResponse

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

# convert the object into a dict
object_roles_response_dict = object_roles_response_instance.to_dict()
# create an instance of ObjectRolesResponse from a dict
object_roles_response_from_dict = ObjectRolesResponse.from_dict(object_roles_response_dict)

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

OpenPGPDistribution

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]
repository_version	str	RepositoryVersion to be served	[optional]

Example

from pulpcore.client.pulpcore.models.open_pgp_distribution import OpenPGPDistribution

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

# convert the object into a dict
open_pgp_distribution_dict = open_pgp_distribution_instance.to_dict()
# create an instance of OpenPGPDistribution from a dict
open_pgp_distribution_from_dict = OpenPGPDistribution.from_dict(open_pgp_distribution_dict)

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

OpenPGPDistributionResponse

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]
repository_version	str	RepositoryVersion to be served	[optional]

Example

from pulpcore.client.pulpcore.models.open_pgp_distribution_response import OpenPGPDistributionResponse

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

# convert the object into a dict
open_pgp_distribution_response_dict = open_pgp_distribution_response_instance.to_dict()
# create an instance of OpenPGPDistributionResponse from a dict
open_pgp_distribution_response_from_dict = OpenPGPDistributionResponse.from_dict(open_pgp_distribution_response_dict)

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

OpenPGPKeyring

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.pulpcore.models.open_pgp_keyring import OpenPGPKeyring

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

# convert the object into a dict
open_pgp_keyring_dict = open_pgp_keyring_instance.to_dict()
# create an instance of OpenPGPKeyring from a dict
open_pgp_keyring_from_dict = OpenPGPKeyring.from_dict(open_pgp_keyring_dict)

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

OpenPGPKeyringResponse

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.pulpcore.models.open_pgp_keyring_response import OpenPGPKeyringResponse

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

# convert the object into a dict
open_pgp_keyring_response_dict = open_pgp_keyring_response_instance.to_dict()
# create an instance of OpenPGPKeyringResponse from a dict
open_pgp_keyring_response_from_dict = OpenPGPKeyringResponse.from_dict(open_pgp_keyring_response_dict)

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

OpenPGPPublicKeyResponse

A serializer for content types with no Artifact.

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]
fingerprint	str		[optional] [readonly]
created	datetime		[optional] [readonly]
user_ids	List[NestedOpenPGPUserIDResponse]		[optional] [readonly]
user_attributes	List[NestedOpenPGPUserAttributeResponse]		[optional] [readonly]
public_subkeys	List[NestedOpenPGPPublicSubkeyResponse]		[optional] [readonly]

Example

from pulpcore.client.pulpcore.models.open_pgp_public_key_response import OpenPGPPublicKeyResponse

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

# convert the object into a dict
open_pgp_public_key_response_dict = open_pgp_public_key_response_instance.to_dict()
# create an instance of OpenPGPPublicKeyResponse from a dict
open_pgp_public_key_response_from_dict = OpenPGPPublicKeyResponse.from_dict(open_pgp_public_key_response_dict)

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

OpenPGPPublicSubkeyResponse

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]
fingerprint	str
created	datetime
signatures	List[NestedOpenPGPSignatureResponse]		[optional] [readonly]
public_key	str		[optional] [readonly]

Example

from pulpcore.client.pulpcore.models.open_pgp_public_subkey_response import OpenPGPPublicSubkeyResponse

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

# convert the object into a dict
open_pgp_public_subkey_response_dict = open_pgp_public_subkey_response_instance.to_dict()
# create an instance of OpenPGPPublicSubkeyResponse from a dict
open_pgp_public_subkey_response_from_dict = OpenPGPPublicSubkeyResponse.from_dict(open_pgp_public_subkey_response_dict)

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

OpenPGPSignatureResponse

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]
issuer	str		[optional]
created	datetime
expiration_time	str		[optional]
signers_user_id	str		[optional]
key_expiration_time	str		[optional]
expired	bool
key_expired	str		[optional] [readonly]
signed_content	str		[optional] [readonly]

Example

from pulpcore.client.pulpcore.models.open_pgp_signature_response import OpenPGPSignatureResponse

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

# convert the object into a dict
open_pgp_signature_response_dict = open_pgp_signature_response_instance.to_dict()
# create an instance of OpenPGPSignatureResponse from a dict
open_pgp_signature_response_from_dict = OpenPGPSignatureResponse.from_dict(open_pgp_signature_response_dict)

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

OpenPGPUserAttributeResponse

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]
sha256	str
signatures	List[NestedOpenPGPSignatureResponse]		[optional] [readonly]
public_key	str		[optional] [readonly]

Example

from pulpcore.client.pulpcore.models.open_pgp_user_attribute_response import OpenPGPUserAttributeResponse

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

# convert the object into a dict
open_pgp_user_attribute_response_dict = open_pgp_user_attribute_response_instance.to_dict()
# create an instance of OpenPGPUserAttributeResponse from a dict
open_pgp_user_attribute_response_from_dict = OpenPGPUserAttributeResponse.from_dict(open_pgp_user_attribute_response_dict)

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

OpenPGPUserIDResponse

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]
user_id	str
signatures	List[NestedOpenPGPSignatureResponse]		[optional] [readonly]
public_key	str		[optional] [readonly]

Example

from pulpcore.client.pulpcore.models.open_pgp_user_id_response import OpenPGPUserIDResponse

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

# convert the object into a dict
open_pgp_user_id_response_dict = open_pgp_user_id_response_instance.to_dict()
# create an instance of OpenPGPUserIDResponse from a dict
open_pgp_user_id_response_from_dict = OpenPGPUserIDResponse.from_dict(open_pgp_user_id_response_dict)

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

pulpcore.client.pulpcore.OrphansApi

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

Method	HTTP request	Description
delete	DELETE /api/pulp/{pulp_domain}/api/v3/orphans/	Delete orphans

delete

AsyncOperationResponse delete(pulp_domain, x_task_diagnostics=x_task_diagnostics)

Delete orphans

DEPRECATED! Trigger an asynchronous task that deletes all orphaned content and artifacts. Use the POST /pulp/api/v3/orphans/cleanup/ call instead.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.async_operation_response import AsyncOperationResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.OrphansApi(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)

    try:
        # Delete orphans
        api_response = api_instance.delete(pulp_domain, x_task_diagnostics=x_task_diagnostics)
        print("The response of OrphansApi->delete:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling OrphansApi->delete: %s\n" % e)

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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]

pulpcore.client.pulpcore.OrphansCleanupApi

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

Method	HTTP request	Description
cleanup	POST /api/pulp/{pulp_domain}/api/v3/orphans/cleanup/

cleanup

AsyncOperationResponse cleanup(pulp_domain, orphans_cleanup, x_task_diagnostics=x_task_diagnostics)

Trigger an asynchronous orphan cleanup operation.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.async_operation_response import AsyncOperationResponse
from pulpcore.client.pulpcore.models.orphans_cleanup import OrphansCleanup
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.OrphansCleanupApi(api_client)
    pulp_domain = 'pulp_domain_example' # str | 
    orphans_cleanup = pulpcore.client.pulpcore.OrphansCleanup() # OrphansCleanup | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

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

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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]

OrphansCleanup

Properties

Name	Type	Description	Notes
content_hrefs	List[object]	Will delete specified content and associated Artifacts if they are orphans.	[optional]
orphan_protection_time	int	The time in minutes for how long Pulp will hold orphan Content and Artifacts before they become candidates for deletion by this orphan cleanup task. This should ideally be longer than your longest running task otherwise any content created during that task could be cleaned up before the task finishes. If not specified, a default value is taken from the setting ORPHAN_PROTECTION_TIME.	[optional]

Example

from pulpcore.client.pulpcore.models.orphans_cleanup import OrphansCleanup

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

# convert the object into a dict
orphans_cleanup_dict = orphans_cleanup_instance.to_dict()
# create an instance of OrphansCleanup from a dict
orphans_cleanup_from_dict = OrphansCleanup.from_dict(orphans_cleanup_dict)

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

PaginatedAccessPolicyResponseList

Properties

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

Example

from pulpcore.client.pulpcore.models.paginated_access_policy_response_list import PaginatedAccessPolicyResponseList

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

# convert the object into a dict
paginated_access_policy_response_list_dict = paginated_access_policy_response_list_instance.to_dict()
# create an instance of PaginatedAccessPolicyResponseList from a dict
paginated_access_policy_response_list_from_dict = PaginatedAccessPolicyResponseList.from_dict(paginated_access_policy_response_list_dict)

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

PaginatedArtifactDistributionResponseList

Properties

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

Example

from pulpcore.client.pulpcore.models.paginated_artifact_distribution_response_list import PaginatedArtifactDistributionResponseList

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

# convert the object into a dict
paginated_artifact_distribution_response_list_dict = paginated_artifact_distribution_response_list_instance.to_dict()
# create an instance of PaginatedArtifactDistributionResponseList from a dict
paginated_artifact_distribution_response_list_from_dict = PaginatedArtifactDistributionResponseList.from_dict(paginated_artifact_distribution_response_list_dict)

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

PaginatedArtifactResponseList

Properties

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

Example

from pulpcore.client.pulpcore.models.paginated_artifact_response_list import PaginatedArtifactResponseList

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

# convert the object into a dict
paginated_artifact_response_list_dict = paginated_artifact_response_list_instance.to_dict()
# create an instance of PaginatedArtifactResponseList from a dict
paginated_artifact_response_list_from_dict = PaginatedArtifactResponseList.from_dict(paginated_artifact_response_list_dict)

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

PaginatedCompositeContentGuardResponseList

Properties

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

Example

from pulpcore.client.pulpcore.models.paginated_composite_content_guard_response_list import PaginatedCompositeContentGuardResponseList

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

# convert the object into a dict
paginated_composite_content_guard_response_list_dict = paginated_composite_content_guard_response_list_instance.to_dict()
# create an instance of PaginatedCompositeContentGuardResponseList from a dict
paginated_composite_content_guard_response_list_from_dict = PaginatedCompositeContentGuardResponseList.from_dict(paginated_composite_content_guard_response_list_dict)

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

PaginatedContentGuardResponseList

Properties

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

Example

from pulpcore.client.pulpcore.models.paginated_content_guard_response_list import PaginatedContentGuardResponseList

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

# convert the object into a dict
paginated_content_guard_response_list_dict = paginated_content_guard_response_list_instance.to_dict()
# create an instance of PaginatedContentGuardResponseList from a dict
paginated_content_guard_response_list_from_dict = PaginatedContentGuardResponseList.from_dict(paginated_content_guard_response_list_dict)

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

PaginatedContentRedirectContentGuardResponseList

Properties

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

Example

from pulpcore.client.pulpcore.models.paginated_content_redirect_content_guard_response_list import PaginatedContentRedirectContentGuardResponseList

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

# convert the object into a dict
paginated_content_redirect_content_guard_response_list_dict = paginated_content_redirect_content_guard_response_list_instance.to_dict()
# create an instance of PaginatedContentRedirectContentGuardResponseList from a dict
paginated_content_redirect_content_guard_response_list_from_dict = PaginatedContentRedirectContentGuardResponseList.from_dict(paginated_content_redirect_content_guard_response_list_dict)

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

PaginatedDistributionResponseList

Properties

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

Example

from pulpcore.client.pulpcore.models.paginated_distribution_response_list import PaginatedDistributionResponseList

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

# convert the object into a dict
paginated_distribution_response_list_dict = paginated_distribution_response_list_instance.to_dict()
# create an instance of PaginatedDistributionResponseList from a dict
paginated_distribution_response_list_from_dict = PaginatedDistributionResponseList.from_dict(paginated_distribution_response_list_dict)

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

PaginatedDomainResponseList

Properties

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

Example

from pulpcore.client.pulpcore.models.paginated_domain_response_list import PaginatedDomainResponseList

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

# convert the object into a dict
paginated_domain_response_list_dict = paginated_domain_response_list_instance.to_dict()
# create an instance of PaginatedDomainResponseList from a dict
paginated_domain_response_list_from_dict = PaginatedDomainResponseList.from_dict(paginated_domain_response_list_dict)

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

PaginatedFilesystemExporterResponseList

Properties

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

Example

from pulpcore.client.pulpcore.models.paginated_filesystem_exporter_response_list import PaginatedFilesystemExporterResponseList

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

# convert the object into a dict
paginated_filesystem_exporter_response_list_dict = paginated_filesystem_exporter_response_list_instance.to_dict()
# create an instance of PaginatedFilesystemExporterResponseList from a dict
paginated_filesystem_exporter_response_list_from_dict = PaginatedFilesystemExporterResponseList.from_dict(paginated_filesystem_exporter_response_list_dict)

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

PaginatedFilesystemExportResponseList

Properties

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

Example

from pulpcore.client.pulpcore.models.paginated_filesystem_export_response_list import PaginatedFilesystemExportResponseList

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

# convert the object into a dict
paginated_filesystem_export_response_list_dict = paginated_filesystem_export_response_list_instance.to_dict()
# create an instance of PaginatedFilesystemExportResponseList from a dict
paginated_filesystem_export_response_list_from_dict = PaginatedFilesystemExportResponseList.from_dict(paginated_filesystem_export_response_list_dict)

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

PaginatedGenericRemoteResponseList

Properties

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

Example

from pulpcore.client.pulpcore.models.paginated_generic_remote_response_list import PaginatedGenericRemoteResponseList

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

# convert the object into a dict
paginated_generic_remote_response_list_dict = paginated_generic_remote_response_list_instance.to_dict()
# create an instance of PaginatedGenericRemoteResponseList from a dict
paginated_generic_remote_response_list_from_dict = PaginatedGenericRemoteResponseList.from_dict(paginated_generic_remote_response_list_dict)

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

PaginatedGroupResponseList

Properties

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

Example

from pulpcore.client.pulpcore.models.paginated_group_response_list import PaginatedGroupResponseList

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

# convert the object into a dict
paginated_group_response_list_dict = paginated_group_response_list_instance.to_dict()
# create an instance of PaginatedGroupResponseList from a dict
paginated_group_response_list_from_dict = PaginatedGroupResponseList.from_dict(paginated_group_response_list_dict)

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

PaginatedGroupRoleResponseList

Properties

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

Example

from pulpcore.client.pulpcore.models.paginated_group_role_response_list import PaginatedGroupRoleResponseList

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

# convert the object into a dict
paginated_group_role_response_list_dict = paginated_group_role_response_list_instance.to_dict()
# create an instance of PaginatedGroupRoleResponseList from a dict
paginated_group_role_response_list_from_dict = PaginatedGroupRoleResponseList.from_dict(paginated_group_role_response_list_dict)

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

PaginatedGroupUserResponseList

Properties

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

Example

from pulpcore.client.pulpcore.models.paginated_group_user_response_list import PaginatedGroupUserResponseList

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

# convert the object into a dict
paginated_group_user_response_list_dict = paginated_group_user_response_list_instance.to_dict()
# create an instance of PaginatedGroupUserResponseList from a dict
paginated_group_user_response_list_from_dict = PaginatedGroupUserResponseList.from_dict(paginated_group_user_response_list_dict)

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

PaginatedHeaderContentGuardResponseList

Properties

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

Example

from pulpcore.client.pulpcore.models.paginated_header_content_guard_response_list import PaginatedHeaderContentGuardResponseList

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

# convert the object into a dict
paginated_header_content_guard_response_list_dict = paginated_header_content_guard_response_list_instance.to_dict()
# create an instance of PaginatedHeaderContentGuardResponseList from a dict
paginated_header_content_guard_response_list_from_dict = PaginatedHeaderContentGuardResponseList.from_dict(paginated_header_content_guard_response_list_dict)

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

PaginatedImportResponseList

Properties

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

Example

from pulpcore.client.pulpcore.models.paginated_import_response_list import PaginatedImportResponseList

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

# convert the object into a dict
paginated_import_response_list_dict = paginated_import_response_list_instance.to_dict()
# create an instance of PaginatedImportResponseList from a dict
paginated_import_response_list_from_dict = PaginatedImportResponseList.from_dict(paginated_import_response_list_dict)

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

PaginatedMultipleArtifactContentResponseList

Properties

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

Example

from pulpcore.client.pulpcore.models.paginated_multiple_artifact_content_response_list import PaginatedMultipleArtifactContentResponseList

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

# convert the object into a dict
paginated_multiple_artifact_content_response_list_dict = paginated_multiple_artifact_content_response_list_instance.to_dict()
# create an instance of PaginatedMultipleArtifactContentResponseList from a dict
paginated_multiple_artifact_content_response_list_from_dict = PaginatedMultipleArtifactContentResponseList.from_dict(paginated_multiple_artifact_content_response_list_dict)

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

PaginatedOpenPGPDistributionResponseList

Properties

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

Example

from pulpcore.client.pulpcore.models.paginated_open_pgp_distribution_response_list import PaginatedOpenPGPDistributionResponseList

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

# convert the object into a dict
paginated_open_pgp_distribution_response_list_dict = paginated_open_pgp_distribution_response_list_instance.to_dict()
# create an instance of PaginatedOpenPGPDistributionResponseList from a dict
paginated_open_pgp_distribution_response_list_from_dict = PaginatedOpenPGPDistributionResponseList.from_dict(paginated_open_pgp_distribution_response_list_dict)

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

PaginatedOpenPGPKeyringResponseList

Properties

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

Example

from pulpcore.client.pulpcore.models.paginated_open_pgp_keyring_response_list import PaginatedOpenPGPKeyringResponseList

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

# convert the object into a dict
paginated_open_pgp_keyring_response_list_dict = paginated_open_pgp_keyring_response_list_instance.to_dict()
# create an instance of PaginatedOpenPGPKeyringResponseList from a dict
paginated_open_pgp_keyring_response_list_from_dict = PaginatedOpenPGPKeyringResponseList.from_dict(paginated_open_pgp_keyring_response_list_dict)

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

PaginatedOpenPGPPublicKeyResponseList

Properties

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

Example

from pulpcore.client.pulpcore.models.paginated_open_pgp_public_key_response_list import PaginatedOpenPGPPublicKeyResponseList

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

# convert the object into a dict
paginated_open_pgp_public_key_response_list_dict = paginated_open_pgp_public_key_response_list_instance.to_dict()
# create an instance of PaginatedOpenPGPPublicKeyResponseList from a dict
paginated_open_pgp_public_key_response_list_from_dict = PaginatedOpenPGPPublicKeyResponseList.from_dict(paginated_open_pgp_public_key_response_list_dict)

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

PaginatedOpenPGPPublicSubkeyResponseList

Properties

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

Example

from pulpcore.client.pulpcore.models.paginated_open_pgp_public_subkey_response_list import PaginatedOpenPGPPublicSubkeyResponseList

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

# convert the object into a dict
paginated_open_pgp_public_subkey_response_list_dict = paginated_open_pgp_public_subkey_response_list_instance.to_dict()
# create an instance of PaginatedOpenPGPPublicSubkeyResponseList from a dict
paginated_open_pgp_public_subkey_response_list_from_dict = PaginatedOpenPGPPublicSubkeyResponseList.from_dict(paginated_open_pgp_public_subkey_response_list_dict)

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

PaginatedOpenPGPSignatureResponseList

Properties

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

Example

from pulpcore.client.pulpcore.models.paginated_open_pgp_signature_response_list import PaginatedOpenPGPSignatureResponseList

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

# convert the object into a dict
paginated_open_pgp_signature_response_list_dict = paginated_open_pgp_signature_response_list_instance.to_dict()
# create an instance of PaginatedOpenPGPSignatureResponseList from a dict
paginated_open_pgp_signature_response_list_from_dict = PaginatedOpenPGPSignatureResponseList.from_dict(paginated_open_pgp_signature_response_list_dict)

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

PaginatedOpenPGPUserAttributeResponseList

Properties

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

Example

from pulpcore.client.pulpcore.models.paginated_open_pgp_user_attribute_response_list import PaginatedOpenPGPUserAttributeResponseList

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

# convert the object into a dict
paginated_open_pgp_user_attribute_response_list_dict = paginated_open_pgp_user_attribute_response_list_instance.to_dict()
# create an instance of PaginatedOpenPGPUserAttributeResponseList from a dict
paginated_open_pgp_user_attribute_response_list_from_dict = PaginatedOpenPGPUserAttributeResponseList.from_dict(paginated_open_pgp_user_attribute_response_list_dict)

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

PaginatedOpenPGPUserIDResponseList

Properties

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

Example

from pulpcore.client.pulpcore.models.paginated_open_pgp_user_id_response_list import PaginatedOpenPGPUserIDResponseList

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

# convert the object into a dict
paginated_open_pgp_user_id_response_list_dict = paginated_open_pgp_user_id_response_list_instance.to_dict()
# create an instance of PaginatedOpenPGPUserIDResponseList from a dict
paginated_open_pgp_user_id_response_list_from_dict = PaginatedOpenPGPUserIDResponseList.from_dict(paginated_open_pgp_user_id_response_list_dict)

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

PaginatedPublicationResponseList

Properties

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

Example

from pulpcore.client.pulpcore.models.paginated_publication_response_list import PaginatedPublicationResponseList

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

# convert the object into a dict
paginated_publication_response_list_dict = paginated_publication_response_list_instance.to_dict()
# create an instance of PaginatedPublicationResponseList from a dict
paginated_publication_response_list_from_dict = PaginatedPublicationResponseList.from_dict(paginated_publication_response_list_dict)

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

PaginatedPulpExporterResponseList

Properties

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

Example

from pulpcore.client.pulpcore.models.paginated_pulp_exporter_response_list import PaginatedPulpExporterResponseList

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

# convert the object into a dict
paginated_pulp_exporter_response_list_dict = paginated_pulp_exporter_response_list_instance.to_dict()
# create an instance of PaginatedPulpExporterResponseList from a dict
paginated_pulp_exporter_response_list_from_dict = PaginatedPulpExporterResponseList.from_dict(paginated_pulp_exporter_response_list_dict)

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

PaginatedPulpExportResponseList

Properties

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

Example

from pulpcore.client.pulpcore.models.paginated_pulp_export_response_list import PaginatedPulpExportResponseList

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

# convert the object into a dict
paginated_pulp_export_response_list_dict = paginated_pulp_export_response_list_instance.to_dict()
# create an instance of PaginatedPulpExportResponseList from a dict
paginated_pulp_export_response_list_from_dict = PaginatedPulpExportResponseList.from_dict(paginated_pulp_export_response_list_dict)

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

PaginatedPulpImporterResponseList

Properties

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

Example

from pulpcore.client.pulpcore.models.paginated_pulp_importer_response_list import PaginatedPulpImporterResponseList

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

# convert the object into a dict
paginated_pulp_importer_response_list_dict = paginated_pulp_importer_response_list_instance.to_dict()
# create an instance of PaginatedPulpImporterResponseList from a dict
paginated_pulp_importer_response_list_from_dict = PaginatedPulpImporterResponseList.from_dict(paginated_pulp_importer_response_list_dict)

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

PaginatedRBACContentGuardResponseList

Properties

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

Example

from pulpcore.client.pulpcore.models.paginated_rbac_content_guard_response_list import PaginatedRBACContentGuardResponseList

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

# convert the object into a dict
paginated_rbac_content_guard_response_list_dict = paginated_rbac_content_guard_response_list_instance.to_dict()
# create an instance of PaginatedRBACContentGuardResponseList from a dict
paginated_rbac_content_guard_response_list_from_dict = PaginatedRBACContentGuardResponseList.from_dict(paginated_rbac_content_guard_response_list_dict)

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

PaginatedRepositoryResponseList

Properties

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

Example

from pulpcore.client.pulpcore.models.paginated_repository_response_list import PaginatedRepositoryResponseList

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

# convert the object into a dict
paginated_repository_response_list_dict = paginated_repository_response_list_instance.to_dict()
# create an instance of PaginatedRepositoryResponseList from a dict
paginated_repository_response_list_from_dict = PaginatedRepositoryResponseList.from_dict(paginated_repository_response_list_dict)

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

PaginatedRepositoryVersionResponseList

Properties

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

Example

from pulpcore.client.pulpcore.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]

PaginatedRoleResponseList

Properties

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

Example

from pulpcore.client.pulpcore.models.paginated_role_response_list import PaginatedRoleResponseList

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

# convert the object into a dict
paginated_role_response_list_dict = paginated_role_response_list_instance.to_dict()
# create an instance of PaginatedRoleResponseList from a dict
paginated_role_response_list_from_dict = PaginatedRoleResponseList.from_dict(paginated_role_response_list_dict)

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

PaginatedSigningServiceResponseList

Properties

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

Example

from pulpcore.client.pulpcore.models.paginated_signing_service_response_list import PaginatedSigningServiceResponseList

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

# convert the object into a dict
paginated_signing_service_response_list_dict = paginated_signing_service_response_list_instance.to_dict()
# create an instance of PaginatedSigningServiceResponseList from a dict
paginated_signing_service_response_list_from_dict = PaginatedSigningServiceResponseList.from_dict(paginated_signing_service_response_list_dict)

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

PaginatedTaskGroupResponseList

Properties

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

Example

from pulpcore.client.pulpcore.models.paginated_task_group_response_list import PaginatedTaskGroupResponseList

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

# convert the object into a dict
paginated_task_group_response_list_dict = paginated_task_group_response_list_instance.to_dict()
# create an instance of PaginatedTaskGroupResponseList from a dict
paginated_task_group_response_list_from_dict = PaginatedTaskGroupResponseList.from_dict(paginated_task_group_response_list_dict)

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

PaginatedTaskResponseList

Properties

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

Example

from pulpcore.client.pulpcore.models.paginated_task_response_list import PaginatedTaskResponseList

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

# convert the object into a dict
paginated_task_response_list_dict = paginated_task_response_list_instance.to_dict()
# create an instance of PaginatedTaskResponseList from a dict
paginated_task_response_list_from_dict = PaginatedTaskResponseList.from_dict(paginated_task_response_list_dict)

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

PaginatedTaskScheduleResponseList

Properties

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

Example

from pulpcore.client.pulpcore.models.paginated_task_schedule_response_list import PaginatedTaskScheduleResponseList

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

# convert the object into a dict
paginated_task_schedule_response_list_dict = paginated_task_schedule_response_list_instance.to_dict()
# create an instance of PaginatedTaskScheduleResponseList from a dict
paginated_task_schedule_response_list_from_dict = PaginatedTaskScheduleResponseList.from_dict(paginated_task_schedule_response_list_dict)

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

PaginatedUploadResponseList

Properties

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

Example

from pulpcore.client.pulpcore.models.paginated_upload_response_list import PaginatedUploadResponseList

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

# convert the object into a dict
paginated_upload_response_list_dict = paginated_upload_response_list_instance.to_dict()
# create an instance of PaginatedUploadResponseList from a dict
paginated_upload_response_list_from_dict = PaginatedUploadResponseList.from_dict(paginated_upload_response_list_dict)

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

PaginatedUpstreamPulpResponseList

Properties

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

Example

from pulpcore.client.pulpcore.models.paginated_upstream_pulp_response_list import PaginatedUpstreamPulpResponseList

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

# convert the object into a dict
paginated_upstream_pulp_response_list_dict = paginated_upstream_pulp_response_list_instance.to_dict()
# create an instance of PaginatedUpstreamPulpResponseList from a dict
paginated_upstream_pulp_response_list_from_dict = PaginatedUpstreamPulpResponseList.from_dict(paginated_upstream_pulp_response_list_dict)

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

PaginatedUserResponseList

Properties

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

Example

from pulpcore.client.pulpcore.models.paginated_user_response_list import PaginatedUserResponseList

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

# convert the object into a dict
paginated_user_response_list_dict = paginated_user_response_list_instance.to_dict()
# create an instance of PaginatedUserResponseList from a dict
paginated_user_response_list_from_dict = PaginatedUserResponseList.from_dict(paginated_user_response_list_dict)

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

PaginatedUserRoleResponseList

Properties

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

Example

from pulpcore.client.pulpcore.models.paginated_user_role_response_list import PaginatedUserRoleResponseList

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

# convert the object into a dict
paginated_user_role_response_list_dict = paginated_user_role_response_list_instance.to_dict()
# create an instance of PaginatedUserRoleResponseList from a dict
paginated_user_role_response_list_from_dict = PaginatedUserRoleResponseList.from_dict(paginated_user_role_response_list_dict)

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

PaginatedVulnerabilityReportResponseList

Properties

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

Example

from pulpcore.client.pulpcore.models.paginated_vulnerability_report_response_list import PaginatedVulnerabilityReportResponseList

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

# convert the object into a dict
paginated_vulnerability_report_response_list_dict = paginated_vulnerability_report_response_list_instance.to_dict()
# create an instance of PaginatedVulnerabilityReportResponseList from a dict
paginated_vulnerability_report_response_list_from_dict = PaginatedVulnerabilityReportResponseList.from_dict(paginated_vulnerability_report_response_list_dict)

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

PaginatedWorkerResponseList

Properties

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

Example

from pulpcore.client.pulpcore.models.paginated_worker_response_list import PaginatedWorkerResponseList

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

# convert the object into a dict
paginated_worker_response_list_dict = paginated_worker_response_list_instance.to_dict()
# create an instance of PaginatedWorkerResponseList from a dict
paginated_worker_response_list_from_dict = PaginatedWorkerResponseList.from_dict(paginated_worker_response_list_dict)

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

PatchedAccessPolicy

Serializer for AccessPolicy.

Properties

Name	Type	Description	Notes
permissions_assignment	List[object]	List of callables that define the new permissions to be created for new objects.This is deprecated. Use `creation_hooks` instead.	[optional]
creation_hooks	List[object]	List of callables that may associate user roles for new objects.	[optional]
statements	List[object]	List of policy statements defining the policy.	[optional]
queryset_scoping	object	A callable for performing queryset scoping. See plugin documentation for valid callables. Set to blank to turn off queryset scoping.	[optional]

Example

from pulpcore.client.pulpcore.models.patched_access_policy import PatchedAccessPolicy

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

# convert the object into a dict
patched_access_policy_dict = patched_access_policy_instance.to_dict()
# create an instance of PatchedAccessPolicy from a dict
patched_access_policy_from_dict = PatchedAccessPolicy.from_dict(patched_access_policy_dict)

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

PatchedCompositeContentGuard

Base class for content guard serializers.

Properties

Name	Type	Description	Notes
name	str	The unique name.	[optional]
description	str	An optional description.	[optional]
guards	List[Optional[str]]	List of ContentGuards to ask for access-permission.	[optional]

Example

from pulpcore.client.pulpcore.models.patched_composite_content_guard import PatchedCompositeContentGuard

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

# convert the object into a dict
patched_composite_content_guard_dict = patched_composite_content_guard_instance.to_dict()
# create an instance of PatchedCompositeContentGuard from a dict
patched_composite_content_guard_from_dict = PatchedCompositeContentGuard.from_dict(patched_composite_content_guard_dict)

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

PatchedContentRedirectContentGuard

A serializer for ContentRedirectContentGuard.

Properties

Name	Type	Description	Notes
name	str	The unique name.	[optional]
description	str	An optional description.	[optional]

Example

from pulpcore.client.pulpcore.models.patched_content_redirect_content_guard import PatchedContentRedirectContentGuard

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

# convert the object into a dict
patched_content_redirect_content_guard_dict = patched_content_redirect_content_guard_instance.to_dict()
# create an instance of PatchedContentRedirectContentGuard from a dict
patched_content_redirect_content_guard_from_dict = PatchedContentRedirectContentGuard.from_dict(patched_content_redirect_content_guard_dict)

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

PatchedDomain

Serializer for Domain.

Properties

Name	Type	Description	Notes
name	str	A name for this domain.	[optional]
description	str	An optional description.	[optional]
pulp_labels	Dict[str, Optional[str]]		[optional]
storage_class	StorageClassEnum	Backend storage class for domain. * `pulpcore.app.models.storage.FileSystem` - Use local filesystem as storage * `storages.backends.s3boto3.S3Boto3Storage` - Use Amazon S3 as storage [deprecated] * `storages.backends.s3.S3Storage` - Use Amazon S3 as storage * `storages.backends.azure_storage.AzureStorage` - Use Azure Blob as storage * `pulp_service.app.storage.OCIStorage` - Use OCI as storage	[optional]
storage_settings	object	Settings for storage class.	[optional]
redirect_to_object_storage	bool	Boolean to have the content app redirect to object storage.	[optional] [default to True]
hide_guarded_distributions	bool	Boolean to hide distributions with a content guard in the content app.	[optional] [default to False]

Example

from pulpcore.client.pulpcore.models.patched_domain import PatchedDomain

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

# convert the object into a dict
patched_domain_dict = patched_domain_instance.to_dict()
# create an instance of PatchedDomain from a dict
patched_domain_from_dict = PatchedDomain.from_dict(patched_domain_dict)

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

PatchedFilesystemExporter

Serializer for FilesystemExporters.

Properties

Name	Type	Description	Notes
name	str	Unique name of the exporter.	[optional]
path	str	File system location to export to.	[optional]
method	MethodEnum	Method of exporting * `write` - Export by writing * `hardlink` - Export by hardlinking * `symlink` - Export by symlinking	[optional]

Example

from pulpcore.client.pulpcore.models.patched_filesystem_exporter import PatchedFilesystemExporter

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

# convert the object into a dict
patched_filesystem_exporter_dict = patched_filesystem_exporter_instance.to_dict()
# create an instance of PatchedFilesystemExporter from a dict
patched_filesystem_exporter_from_dict = PatchedFilesystemExporter.from_dict(patched_filesystem_exporter_dict)

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

PatchedGroup

Serializer for Group.

Properties

Name	Type	Description	Notes
name	str	Name	[optional]

Example

from pulpcore.client.pulpcore.models.patched_group import PatchedGroup

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

# convert the object into a dict
patched_group_dict = patched_group_instance.to_dict()
# create an instance of PatchedGroup from a dict
patched_group_from_dict = PatchedGroup.from_dict(patched_group_dict)

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

PatchedHeaderContentGuard

A serializer for HeaderContentGuard.

Properties

Name	Type	Description	Notes
name	str	The unique name.	[optional]
description	str	An optional description.	[optional]
header_name	str	The header name the guard will check on.	[optional]
header_value	str	The value that will authorize the request.	[optional]
jq_filter	str	A JQ syntax compatible filter. If jq_filter is not set, then the value willonly be Base64 decoded and checked as an explicit string match.	[optional]

Example

from pulpcore.client.pulpcore.models.patched_header_content_guard import PatchedHeaderContentGuard

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

# convert the object into a dict
patched_header_content_guard_dict = patched_header_content_guard_instance.to_dict()
# create an instance of PatchedHeaderContentGuard from a dict
patched_header_content_guard_from_dict = PatchedHeaderContentGuard.from_dict(patched_header_content_guard_dict)

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

PatchedOpenPGPDistribution

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]
repository_version	str	RepositoryVersion to be served	[optional]

Example

from pulpcore.client.pulpcore.models.patched_open_pgp_distribution import PatchedOpenPGPDistribution

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

# convert the object into a dict
patched_open_pgp_distribution_dict = patched_open_pgp_distribution_instance.to_dict()
# create an instance of PatchedOpenPGPDistribution from a dict
patched_open_pgp_distribution_from_dict = PatchedOpenPGPDistribution.from_dict(patched_open_pgp_distribution_dict)

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

PatchedOpenPGPKeyring

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.pulpcore.models.patched_open_pgp_keyring import PatchedOpenPGPKeyring

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

# convert the object into a dict
patched_open_pgp_keyring_dict = patched_open_pgp_keyring_instance.to_dict()
# create an instance of PatchedOpenPGPKeyring from a dict
patched_open_pgp_keyring_from_dict = PatchedOpenPGPKeyring.from_dict(patched_open_pgp_keyring_dict)

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

PatchedPulpExporter

Serializer for pulp exporters.

Properties

Name	Type	Description	Notes
name	str	Unique name of the exporter.	[optional]
path	str	File system directory to store exported tar.gzs.	[optional]
repositories	List[str]		[optional]
last_export	str	Last attempted export for this PulpExporter	[optional]

Example

from pulpcore.client.pulpcore.models.patched_pulp_exporter import PatchedPulpExporter

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

# convert the object into a dict
patched_pulp_exporter_dict = patched_pulp_exporter_instance.to_dict()
# create an instance of PatchedPulpExporter from a dict
patched_pulp_exporter_from_dict = PatchedPulpExporter.from_dict(patched_pulp_exporter_dict)

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

PatchedPulpImporter

Serializer for PulpImporters.

Properties

Name	Type	Description	Notes
name	str	Unique name of the Importer.	[optional]
repo_mapping	Dict[str, str]	Mapping of repo names in an export file to the repo names in Pulp. For example, if the export has a repo named 'foo' and the repo to import content into was 'bar', the mapping would be "{'foo': 'bar'}".	[optional]

Example

from pulpcore.client.pulpcore.models.patched_pulp_importer import PatchedPulpImporter

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

# convert the object into a dict
patched_pulp_importer_dict = patched_pulp_importer_instance.to_dict()
# create an instance of PatchedPulpImporter from a dict
patched_pulp_importer_from_dict = PatchedPulpImporter.from_dict(patched_pulp_importer_dict)

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

PatchedRBACContentGuard

Base class for content guard serializers.

Properties

Name	Type	Description	Notes
name	str	The unique name.	[optional]
description	str	An optional description.	[optional]

Example

from pulpcore.client.pulpcore.models.patched_rbac_content_guard import PatchedRBACContentGuard

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

# convert the object into a dict
patched_rbac_content_guard_dict = patched_rbac_content_guard_instance.to_dict()
# create an instance of PatchedRBACContentGuard from a dict
patched_rbac_content_guard_from_dict = PatchedRBACContentGuard.from_dict(patched_rbac_content_guard_dict)

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

PatchedRole

Serializer for Role.

Properties

Name	Type	Description	Notes
name	str	The name of this role.	[optional]
description	str	An optional description.	[optional]
permissions	List[str]	List of permissions defining the role.	[optional]

Example

from pulpcore.client.pulpcore.models.patched_role import PatchedRole

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

# convert the object into a dict
patched_role_dict = patched_role_instance.to_dict()
# create an instance of PatchedRole from a dict
patched_role_from_dict = PatchedRole.from_dict(patched_role_dict)

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

PatchedTaskCancel

Properties

Name	Type	Description	Notes
state	str	The desired state of the task. Only 'canceled' is accepted.	[optional]

Example

from pulpcore.client.pulpcore.models.patched_task_cancel import PatchedTaskCancel

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

# convert the object into a dict
patched_task_cancel_dict = patched_task_cancel_instance.to_dict()
# create an instance of PatchedTaskCancel from a dict
patched_task_cancel_from_dict = PatchedTaskCancel.from_dict(patched_task_cancel_dict)

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

PatchedUpstreamPulp

Serializer for a Server.

Properties

Name	Type	Description	Notes
name	str	A unique name for this Pulp server.	[optional]
base_url	str	The transport, hostname, and an optional port of the Pulp server. e.g. https://example.com	[optional]
api_root	str	The API root. Defaults to '/pulp/'.	[optional]
domain	str	The domain of the Pulp server if enabled.	[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]
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]
q_select	str	Filter distributions on the upstream Pulp using complex filtering. E.g. pulp_label_select="foo" OR pulp_label_select="key=val"	[optional]
policy	Policy357Enum	Policy for how replicate will manage the local objects within the domain. * `all` - Replicate manages ALL local objects within the domain. * `labeled` - Replicate will only manage the objects created from a previous replication, unlabled local objects will be untouched. * `nodelete` - Replicate will not delete any local object whether they were created by replication or not.	[optional]

Example

from pulpcore.client.pulpcore.models.patched_upstream_pulp import PatchedUpstreamPulp

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

# convert the object into a dict
patched_upstream_pulp_dict = patched_upstream_pulp_instance.to_dict()
# create an instance of PatchedUpstreamPulp from a dict
patched_upstream_pulp_from_dict = PatchedUpstreamPulp.from_dict(patched_upstream_pulp_dict)

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

PatchedUser

Serializer for User.

Properties

Name	Type	Description	Notes
username	str	Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.	[optional]
password	str	Users password. Set to ``null`` to disable password authentication.	[optional]
first_name	str	First name	[optional]
last_name	str	Last name	[optional]
email	str	Email address	[optional]
is_staff	bool	Designates whether the user can log into this admin site.	[optional] [default to False]
is_active	bool	Designates whether this user should be treated as active.	[optional] [default to True]

Example

from pulpcore.client.pulpcore.models.patched_user import PatchedUser

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

# convert the object into a dict
patched_user_dict = patched_user_instance.to_dict()
# create an instance of PatchedUser from a dict
patched_user_from_dict = PatchedUser.from_dict(patched_user_dict)

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

Policy357Enum

all - Replicate manages ALL local objects within the domain. * labeled - Replicate will only manage the objects created from a previous replication, unlabled local objects will be untouched. * nodelete - Replicate will not delete any local object whether they were created by replication or not.

Enum

ALL (value: 'all')
LABELED (value: 'labeled')
NODELETE (value: 'nodelete')

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

ProfileArtifactResponse

Properties

Name	Type	Description	Notes
urls	Dict[str, str]

Example

from pulpcore.client.pulpcore.models.profile_artifact_response import ProfileArtifactResponse

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

# convert the object into a dict
profile_artifact_response_dict = profile_artifact_response_instance.to_dict()
# create an instance of ProfileArtifactResponse from a dict
profile_artifact_response_from_dict = ProfileArtifactResponse.from_dict(profile_artifact_response_dict)

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

ProgressReportResponse

Properties

Name	Type	Description	Notes
message	str	The message shown to the user for the progress report.	[optional] [readonly]
code	str	Identifies the type of progress report'.	[optional] [readonly]
state	str	The current state of the progress report. The possible values are: 'waiting', 'skipped', 'running', 'completed', 'failed', 'canceled' and 'canceling'. The default is 'waiting'.	[optional] [readonly]
total	int	The total count of items.	[optional] [readonly]
done	int	The count of items already processed. Defaults to 0.	[optional] [readonly]
suffix	str	The suffix to be shown with the progress report.	[optional] [readonly]

Example

from pulpcore.client.pulpcore.models.progress_report_response import ProgressReportResponse

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

# convert the object into a dict
progress_report_response_dict = progress_report_response_instance.to_dict()
# create an instance of ProgressReportResponse from a dict
progress_report_response_from_dict = ProgressReportResponse.from_dict(progress_report_response_dict)

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

PublicationResponse

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]
repository_version	str		[optional]
repository	str	A URI of the repository to be published.	[optional]

Example

from pulpcore.client.pulpcore.models.publication_response import PublicationResponse

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

# convert the object into a dict
publication_response_dict = publication_response_instance.to_dict()
# create an instance of PublicationResponse from a dict
publication_response_from_dict = PublicationResponse.from_dict(publication_response_dict)

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

pulpcore.client.pulpcore.PublicationsApi

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

Method	HTTP request	Description
list	GET /api/pulp/{pulp_domain}/api/v3/publications/	List publications

list

PaginatedPublicationResponseList list(pulp_domain, x_task_diagnostics=x_task_diagnostics, checkpoint=checkpoint, content=content, content__in=content__in, limit=limit, 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, pulp_id__in=pulp_id__in, pulp_type=pulp_type, pulp_type__in=pulp_type__in, q=q, repository=repository, repository_version=repository_version, fields=fields, exclude_fields=exclude_fields)

List publications

A base class for any publication viewset.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.paginated_publication_response_list import PaginatedPublicationResponseList
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.PublicationsApi(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)
    checkpoint = True # bool | Filter results where checkpoint matches value (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)
    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) * `complete` - Complete * `-complete` - Complete (descending) * `pass_through` - Pass through * `-pass_through` - Pass through (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_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)
    pulp_id__in = ['pulp_id__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
    pulp_type = 'pulp_type_example' # str | Pulp type  * `gem.gem` - gem.gem * `hugging_face.hugging-face` - hugging_face.hugging-face * `python.python` - python.python * `rpm.rpm` - rpm.rpm * `file.file` - file.file (optional)
    pulp_type__in = ['pulp_type__in_example'] # List[str] | Multiple values may be separated by commas.  * `gem.gem` - gem.gem * `hugging_face.hugging-face` - hugging_face.hugging-face * `python.python` - python.python * `rpm.rpm` - rpm.rpm * `file.file` - file.file (optional)
    q = 'q_example' # str | Filter results by using NOT, AND and OR operations on other filters (optional)
    repository = 'repository_example' # str | Repository referenced by HREF/PRN (optional)
    repository_version = 'repository_version_example' # str | Repository Version referenced by HREF/PRN (optional)
    fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
    exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)

    try:
        # List publications
        api_response = api_instance.list(pulp_domain, x_task_diagnostics=x_task_diagnostics, checkpoint=checkpoint, content=content, content__in=content__in, limit=limit, 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, pulp_id__in=pulp_id__in, pulp_type=pulp_type, pulp_type__in=pulp_type__in, q=q, repository=repository, repository_version=repository_version, fields=fields, exclude_fields=exclude_fields)
        print("The response of PublicationsApi->list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicationsApi->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]
checkpoint	bool	Filter results where checkpoint matches value	[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]
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) * `complete` - Complete * `-complete` - Complete (descending) * `pass_through` - Pass through * `-pass_through` - Pass through (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_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]
pulp_id__in	List[str]	Multiple values may be separated by commas.	[optional]
pulp_type	str	Pulp type * `gem.gem` - gem.gem * `hugging_face.hugging-face` - hugging_face.hugging-face * `python.python` - python.python * `rpm.rpm` - rpm.rpm * `file.file` - file.file	[optional]
pulp_type__in	List[str]	Multiple values may be separated by commas. * `gem.gem` - gem.gem * `hugging_face.hugging-face` - hugging_face.hugging-face * `python.python` - python.python * `rpm.rpm` - rpm.rpm * `file.file` - file.file	[optional]
q	str	Filter results by using NOT, AND and OR operations on other filters	[optional]
repository	str	Repository referenced by HREF/PRN	[optional]
repository_version	str	Repository Version 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

PaginatedPublicationResponseList

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]

PulpExporter

Serializer for pulp exporters.

Properties

Name	Type	Description	Notes
name	str	Unique name of the exporter.
path	str	File system directory to store exported tar.gzs.
repositories	List[str]
last_export	str	Last attempted export for this PulpExporter	[optional]

Example

from pulpcore.client.pulpcore.models.pulp_exporter import PulpExporter

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

# convert the object into a dict
pulp_exporter_dict = pulp_exporter_instance.to_dict()
# create an instance of PulpExporter from a dict
pulp_exporter_from_dict = PulpExporter.from_dict(pulp_exporter_dict)

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

PulpExporterResponse

Serializer for pulp exporters.

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]
name	str	Unique name of the exporter.
path	str	File system directory to store exported tar.gzs.
repositories	List[str]
last_export	str	Last attempted export for this PulpExporter	[optional]

Example

from pulpcore.client.pulpcore.models.pulp_exporter_response import PulpExporterResponse

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

# convert the object into a dict
pulp_exporter_response_dict = pulp_exporter_response_instance.to_dict()
# create an instance of PulpExporterResponse from a dict
pulp_exporter_response_from_dict = PulpExporterResponse.from_dict(pulp_exporter_response_dict)

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

PulpExport

Serializer for PulpExports.

Properties

Name	Type	Description	Notes
task	str	A URI of the task that ran the Export.	[optional]
full	bool	Do a Full (true) or Incremental (false) export.	[optional] [default to True]
dry_run	bool	Generate report on what would be exported and disk-space required.	[optional] [default to False]
versions	List[str]	List of explicit repo-version hrefs to export (replaces current_version).	[optional]
chunk_size	str	Chunk export-tarfile into pieces of chunk_size bytes. Recognizes units of B/KB/MB/GB/TB. A chunk has a maximum size of 1TB.	[optional]
start_versions	List[str]	List of explicit last-exported-repo-version hrefs (replaces last_export).	[optional]
meta	object	Dictionary of meta information about the export. Stored in the TOC JSON.	[optional]

Example

from pulpcore.client.pulpcore.models.pulp_export import PulpExport

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

# convert the object into a dict
pulp_export_dict = pulp_export_instance.to_dict()
# create an instance of PulpExport from a dict
pulp_export_from_dict = PulpExport.from_dict(pulp_export_dict)

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

PulpExportResponse

Serializer for PulpExports.

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]
task	str	A URI of the task that ran the Export.	[optional]
exported_resources	List[str]	Resources that were exported.	[optional] [readonly]
params	object	Any additional parameters that were used to create the export.	[optional] [readonly]
output_file_info	object	Dictionary of filename: sha256hash entries for export-output-file(s)	[optional] [readonly]
toc_info	object	Filename, sha256-checksum and meta of table-of-contents for this export	[optional] [readonly]

Example

from pulpcore.client.pulpcore.models.pulp_export_response import PulpExportResponse

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

# convert the object into a dict
pulp_export_response_dict = pulp_export_response_instance.to_dict()
# create an instance of PulpExportResponse from a dict
pulp_export_response_from_dict = PulpExportResponse.from_dict(pulp_export_response_dict)

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

PulpImportCheck

Check validity of provided import-options. Provides the ability to check that an import is 'sane' without having to actually create an importer.

Properties

Name	Type	Description	Notes
path	str	Path to export-tar-gz that will be imported.	[optional]
toc	str	Path to a table-of-contents file describing chunks to be validated, reassembled, and imported.	[optional]
repo_mapping	str	Mapping of repo names in an export file to the repo names in Pulp. For example, if the export has a repo named 'foo' and the repo to import content into was 'bar', the mapping would be "{'foo': 'bar'}".	[optional]

Example

from pulpcore.client.pulpcore.models.pulp_import_check import PulpImportCheck

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

# convert the object into a dict
pulp_import_check_dict = pulp_import_check_instance.to_dict()
# create an instance of PulpImportCheck from a dict
pulp_import_check_from_dict = PulpImportCheck.from_dict(pulp_import_check_dict)

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

PulpImportCheckResponse

Return the response to a PulpImport import-check call.

Properties

Name	Type	Description	Notes
toc	EvaluationResponse	Evaluation of proposed 'toc' file for PulpImport	[optional]
path	EvaluationResponse	Evaluation of proposed 'path' file for PulpImport	[optional]
repo_mapping	EvaluationResponse	Evaluation of proposed 'repo_mapping' file for PulpImport	[optional]

Example

from pulpcore.client.pulpcore.models.pulp_import_check_response import PulpImportCheckResponse

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

# convert the object into a dict
pulp_import_check_response_dict = pulp_import_check_response_instance.to_dict()
# create an instance of PulpImportCheckResponse from a dict
pulp_import_check_response_from_dict = PulpImportCheckResponse.from_dict(pulp_import_check_response_dict)

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

PulpImporter

Serializer for PulpImporters.

Properties

Name	Type	Description	Notes
name	str	Unique name of the Importer.
repo_mapping	Dict[str, str]	Mapping of repo names in an export file to the repo names in Pulp. For example, if the export has a repo named 'foo' and the repo to import content into was 'bar', the mapping would be "{'foo': 'bar'}".	[optional]

Example

from pulpcore.client.pulpcore.models.pulp_importer import PulpImporter

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

# convert the object into a dict
pulp_importer_dict = pulp_importer_instance.to_dict()
# create an instance of PulpImporter from a dict
pulp_importer_from_dict = PulpImporter.from_dict(pulp_importer_dict)

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

PulpImporterResponse

Serializer for PulpImporters.

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]
name	str	Unique name of the Importer.
repo_mapping	Dict[str, str]	Mapping of repo names in an export file to the repo names in Pulp. For example, if the export has a repo named 'foo' and the repo to import content into was 'bar', the mapping would be "{'foo': 'bar'}".	[optional]

Example

from pulpcore.client.pulpcore.models.pulp_importer_response import PulpImporterResponse

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

# convert the object into a dict
pulp_importer_response_dict = pulp_importer_response_instance.to_dict()
# create an instance of PulpImporterResponse from a dict
pulp_importer_response_from_dict = PulpImporterResponse.from_dict(pulp_importer_response_dict)

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

PulpImport

Serializer for call to import into Pulp.

Properties

Name	Type	Description	Notes
path	str	Path to export that will be imported.	[optional]
toc	str	Path to a table-of-contents file describing chunks to be validated, reassembled, and imported.	[optional]
create_repositories	bool	If True, missing repositories will be automatically created during the import.	[optional] [default to False]

Example

from pulpcore.client.pulpcore.models.pulp_import import PulpImport

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

# convert the object into a dict
pulp_import_dict = pulp_import_instance.to_dict()
# create an instance of PulpImport from a dict
pulp_import_from_dict = PulpImport.from_dict(pulp_import_dict)

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

Purge

Properties

Name	Type	Description	Notes
finished_before	datetime	Purge tasks completed earlier than this timestamp. Format '%Y-%m-%d[T%H:%M:%S]'	[optional]
states	List[StatesEnum]	List of task-states to be purged. Only 'final' states are allowed.	[optional] [default to ["completed"]]

Example

from pulpcore.client.pulpcore.models.purge import Purge

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

# convert the object into a dict
purge_dict = purge_instance.to_dict()
# create an instance of Purge from a dict
purge_from_dict = Purge.from_dict(purge_dict)

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

RBACContentGuard

Base class for content guard serializers.

Properties

Name	Type	Description	Notes
name	str	The unique name.
description	str	An optional description.	[optional]

Example

from pulpcore.client.pulpcore.models.rbac_content_guard import RBACContentGuard

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

# convert the object into a dict
rbac_content_guard_dict = rbac_content_guard_instance.to_dict()
# create an instance of RBACContentGuard from a dict
rbac_content_guard_from_dict = RBACContentGuard.from_dict(rbac_content_guard_dict)

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

RBACContentGuardResponse

Base class for content guard serializers.

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]
name	str	The unique name.
description	str	An optional description.	[optional]
users	List[GroupUserResponse]		[optional] [readonly]
groups	List[GroupResponse]		[optional] [readonly]

Example

from pulpcore.client.pulpcore.models.rbac_content_guard_response import RBACContentGuardResponse

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

# convert the object into a dict
rbac_content_guard_response_dict = rbac_content_guard_response_instance.to_dict()
# create an instance of RBACContentGuardResponse from a dict
rbac_content_guard_response_from_dict = RBACContentGuardResponse.from_dict(rbac_content_guard_response_dict)

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

ReclaimSpace

Serializer for reclaim disk space operation.

Properties

Name	Type	Description	Notes
repo_hrefs	List[object]	Will reclaim space for the specified list of repos. Use ['*'] to specify all repos.
repo_versions_keeplist	List[str]	Will exclude repo versions from space reclaim.	[optional]

Example

from pulpcore.client.pulpcore.models.reclaim_space import ReclaimSpace

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

# convert the object into a dict
reclaim_space_dict = reclaim_space_instance.to_dict()
# create an instance of ReclaimSpace from a dict
reclaim_space_from_dict = ReclaimSpace.from_dict(reclaim_space_dict)

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

RedisConnectionResponse

Serializer for information about the Redis connection

Properties

Name	Type	Description	Notes
connected	bool	Info about whether the app can connect to Redis

Example

from pulpcore.client.pulpcore.models.redis_connection_response import RedisConnectionResponse

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

# convert the object into a dict
redis_connection_response_dict = redis_connection_response_instance.to_dict()
# create an instance of RedisConnectionResponse from a dict
redis_connection_response_from_dict = RedisConnectionResponse.from_dict(redis_connection_response_dict)

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

RemoteNetworkConfig

Shared network configuration fields and validation logic used by both RemoteSerializer and UploadSerializerFieldsMixin.

Properties

Name	Type	Description	Notes
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]
max_retries	int	Maximum number of retry attempts after a download failure. If not set then the default value (3) will be used.	[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]
download_concurrency	int	Total number of simultaneous connections. If not set then the default value will be used.	[optional]
rate_limit	int	Limits requests per second for each concurrent downloader	[optional]

Example

from pulpcore.client.pulpcore.models.remote_network_config import RemoteNetworkConfig

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

# convert the object into a dict
remote_network_config_dict = remote_network_config_instance.to_dict()
# create an instance of RemoteNetworkConfig from a dict
remote_network_config_from_dict = RemoteNetworkConfig.from_dict(remote_network_config_dict)

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

RemoteNetworkConfigResponse

Shared network configuration fields and validation logic used by both RemoteSerializer and UploadSerializerFieldsMixin.

Properties

Name	Type	Description	Notes
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]
max_retries	int	Maximum number of retry attempts after a download failure. If not set then the default value (3) will be used.	[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]
download_concurrency	int	Total number of simultaneous connections. If not set then the default value will be used.	[optional]
rate_limit	int	Limits requests per second for each concurrent downloader	[optional]

Example

from pulpcore.client.pulpcore.models.remote_network_config_response import RemoteNetworkConfigResponse

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

# convert the object into a dict
remote_network_config_response_dict = remote_network_config_response_instance.to_dict()
# create an instance of RemoteNetworkConfigResponse from a dict
remote_network_config_response_from_dict = RemoteNetworkConfigResponse.from_dict(remote_network_config_response_dict)

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

pulpcore.client.pulpcore.RemotesApi

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

Method	HTTP request	Description
list	GET /api/pulp/{pulp_domain}/api/v3/remotes/	List remotes

list

PaginatedGenericRemoteResponseList 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, pulp_type=pulp_type, pulp_type__in=pulp_type__in, q=q, fields=fields, exclude_fields=exclude_fields)

List remotes

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.paginated_generic_remote_response_list import PaginatedGenericRemoteResponseList
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.RemotesApi(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)
    pulp_type = 'pulp_type_example' # str | Pulp type  * `container.container` - container.container * `container.pull-through` - container.pull-through * `gem.gem` - gem.gem * `hugging_face.hugging-face` - hugging_face.hugging-face * `maven.maven` - maven.maven * `npm.npm` - npm.npm * `python.python` - python.python * `rpm.rpm` - rpm.rpm * `rpm.uln` - rpm.uln * `file.file` - file.file (optional)
    pulp_type__in = ['pulp_type__in_example'] # List[str] | Multiple values may be separated by commas.  * `container.container` - container.container * `container.pull-through` - container.pull-through * `gem.gem` - gem.gem * `hugging_face.hugging-face` - hugging_face.hugging-face * `maven.maven` - maven.maven * `npm.npm` - npm.npm * `python.python` - python.python * `rpm.rpm` - rpm.rpm * `rpm.uln` - rpm.uln * `file.file` - file.file (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 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, pulp_type=pulp_type, pulp_type__in=pulp_type__in, q=q, fields=fields, exclude_fields=exclude_fields)
        print("The response of RemotesApi->list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RemotesApi->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]
pulp_type	str	Pulp type * `container.container` - container.container * `container.pull-through` - container.pull-through * `gem.gem` - gem.gem * `hugging_face.hugging-face` - hugging_face.hugging-face * `maven.maven` - maven.maven * `npm.npm` - npm.npm * `python.python` - python.python * `rpm.rpm` - rpm.rpm * `rpm.uln` - rpm.uln * `file.file` - file.file	[optional]
pulp_type__in	List[str]	Multiple values may be separated by commas. * `container.container` - container.container * `container.pull-through` - container.pull-through * `gem.gem` - gem.gem * `hugging_face.hugging-face` - hugging_face.hugging-face * `maven.maven` - maven.maven * `npm.npm` - npm.npm * `python.python` - python.python * `rpm.rpm` - rpm.rpm * `rpm.uln` - rpm.uln * `file.file` - file.file	[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

PaginatedGenericRemoteResponseList

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]

pulpcore.client.pulpcore.RepairApi

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

Method	HTTP request	Description
post	POST /api/pulp/{pulp_domain}/api/v3/repair/	Repair Artifact Storage

post

AsyncOperationResponse post(pulp_domain, repair, x_task_diagnostics=x_task_diagnostics)

Repair Artifact Storage

Trigger an asynchronous task that checks for missing or corrupted artifacts, and attempts to redownload them.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.async_operation_response import AsyncOperationResponse
from pulpcore.client.pulpcore.models.repair import Repair
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.RepairApi(api_client)
    pulp_domain = 'pulp_domain_example' # str | 
    repair = pulpcore.client.pulpcore.Repair() # Repair | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Repair Artifact Storage
        api_response = api_instance.post(pulp_domain, repair, x_task_diagnostics=x_task_diagnostics)
        print("The response of RepairApi->post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RepairApi->post: %s\n" % e)

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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]

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.pulpcore.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.pulpcore.RepositoriesApi

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

Method	HTTP request	Description
list	GET /api/pulp/{pulp_domain}/api/v3/repositories/	List repositories

list

PaginatedRepositoryResponseList 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, pulp_type=pulp_type, pulp_type__in=pulp_type__in, 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 repositories

Endpoint to list all repositories.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.paginated_repository_response_list import PaginatedRepositoryResponseList
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.RepositoriesApi(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)
    pulp_type = 'pulp_type_example' # str | Pulp type  * `core.openpgp` - core.openpgp * `container.container` - container.container * `container.container-push` - container.container-push * `gem.gem` - gem.gem * `hugging_face.hugging-face` - hugging_face.hugging-face * `maven.maven` - maven.maven * `npm.npm` - npm.npm * `python.python` - python.python * `rpm.rpm` - rpm.rpm * `file.file` - file.file (optional)
    pulp_type__in = ['pulp_type__in_example'] # List[str] | Multiple values may be separated by commas.  * `core.openpgp` - core.openpgp * `container.container` - container.container * `container.container-push` - container.container-push * `gem.gem` - gem.gem * `hugging_face.hugging-face` - hugging_face.hugging-face * `maven.maven` - maven.maven * `npm.npm` - npm.npm * `python.python` - python.python * `rpm.rpm` - rpm.rpm * `file.file` - file.file (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 repositories
        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, pulp_type=pulp_type, pulp_type__in=pulp_type__in, 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 RepositoriesApi->list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RepositoriesApi->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]
pulp_type	str	Pulp type * `core.openpgp` - core.openpgp * `container.container` - container.container * `container.container-push` - container.container-push * `gem.gem` - gem.gem * `hugging_face.hugging-face` - hugging_face.hugging-face * `maven.maven` - maven.maven * `npm.npm` - npm.npm * `python.python` - python.python * `rpm.rpm` - rpm.rpm * `file.file` - file.file	[optional]
pulp_type__in	List[str]	Multiple values may be separated by commas. * `core.openpgp` - core.openpgp * `container.container` - container.container * `container.container-push` - container.container-push * `gem.gem` - gem.gem * `hugging_face.hugging-face` - hugging_face.hugging-face * `maven.maven` - maven.maven * `npm.npm` - npm.npm * `python.python` - python.python * `rpm.rpm` - rpm.rpm * `file.file` - file.file	[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

PaginatedRepositoryResponseList

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]

pulpcore.client.pulpcore.RepositoriesOpenpgpKeyringApi

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

Method	HTTP request	Description
add_role	POST {open_p_g_p_keyring_href}add_role/	Add a role
create	POST /api/pulp/{pulp_domain}/api/v3/repositories/core/openpgp_keyring/	Create an open pgp keyring
delete	DELETE {open_p_g_p_keyring_href}	Delete an open pgp keyring
list	GET /api/pulp/{pulp_domain}/api/v3/repositories/core/openpgp_keyring/	List open pgp keyrings
list_roles	GET {open_p_g_p_keyring_href}list_roles/	List roles
modify	POST {open_p_g_p_keyring_href}modify/	Modify Repository Content
my_permissions	GET {open_p_g_p_keyring_href}my_permissions/	List user permissions
partial_update	PATCH {open_p_g_p_keyring_href}	Update an open pgp keyring
read	GET {open_p_g_p_keyring_href}	Inspect an open pgp keyring
remove_role	POST {open_p_g_p_keyring_href}remove_role/	Remove a role
set_label	POST {open_p_g_p_keyring_href}set_label/	Set a label
unset_label	POST {open_p_g_p_keyring_href}unset_label/	Unset a label
update	PUT {open_p_g_p_keyring_href}	Update an open pgp keyring

add_role

NestedRoleResponse add_role(open_p_g_p_keyring_href, nested_role, x_task_diagnostics=x_task_diagnostics)

Add a role

Add a role for this object to users/groups.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.nested_role import NestedRole
from pulpcore.client.pulpcore.models.nested_role_response import NestedRoleResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.RepositoriesOpenpgpKeyringApi(api_client)
    open_p_g_p_keyring_href = 'open_p_g_p_keyring_href_example' # str | 
    nested_role = pulpcore.client.pulpcore.NestedRole() # NestedRole | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Add a role
        api_response = api_instance.add_role(open_p_g_p_keyring_href, nested_role, x_task_diagnostics=x_task_diagnostics)
        print("The response of RepositoriesOpenpgpKeyringApi->add_role:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RepositoriesOpenpgpKeyringApi->add_role: %s\n" % e)

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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]

create

OpenPGPKeyringResponse create(pulp_domain, open_pgp_keyring, x_task_diagnostics=x_task_diagnostics)

Create an open pgp keyring

A ViewSet for an ordinary repository.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.open_pgp_keyring import OpenPGPKeyring
from pulpcore.client.pulpcore.models.open_pgp_keyring_response import OpenPGPKeyringResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.RepositoriesOpenpgpKeyringApi(api_client)
    pulp_domain = 'pulp_domain_example' # str | 
    open_pgp_keyring = pulpcore.client.pulpcore.OpenPGPKeyring() # OpenPGPKeyring | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Create an open pgp keyring
        api_response = api_instance.create(pulp_domain, open_pgp_keyring, x_task_diagnostics=x_task_diagnostics)
        print("The response of RepositoriesOpenpgpKeyringApi->create:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RepositoriesOpenpgpKeyringApi->create: %s\n" % e)

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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(open_p_g_p_keyring_href, x_task_diagnostics=x_task_diagnostics)

Delete an open pgp keyring

Trigger an asynchronous delete task

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.async_operation_response import AsyncOperationResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.RepositoriesOpenpgpKeyringApi(api_client)
    open_p_g_p_keyring_href = 'open_p_g_p_keyring_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Delete an open pgp keyring
        api_response = api_instance.delete(open_p_g_p_keyring_href, x_task_diagnostics=x_task_diagnostics)
        print("The response of RepositoriesOpenpgpKeyringApi->delete:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RepositoriesOpenpgpKeyringApi->delete: %s\n" % e)

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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

PaginatedOpenPGPKeyringResponseList 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 open pgp keyrings

A ViewSet for an ordinary repository.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.paginated_open_pgp_keyring_response_list import PaginatedOpenPGPKeyringResponseList
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.RepositoriesOpenpgpKeyringApi(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 open pgp keyrings
        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 RepositoriesOpenpgpKeyringApi->list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RepositoriesOpenpgpKeyringApi->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

PaginatedOpenPGPKeyringResponseList

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]

list_roles

ObjectRolesResponse list_roles(open_p_g_p_keyring_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

List roles

List roles assigned to this object.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.object_roles_response import ObjectRolesResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.RepositoriesOpenpgpKeyringApi(api_client)
    open_p_g_p_keyring_href = 'open_p_g_p_keyring_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:
        # List roles
        api_response = api_instance.list_roles(open_p_g_p_keyring_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of RepositoriesOpenpgpKeyringApi->list_roles:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RepositoriesOpenpgpKeyringApi->list_roles: %s\n" % e)

Parameters

Name	Type	Description	Notes
open_p_g_p_keyring_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

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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]

modify

AsyncOperationResponse modify(open_p_g_p_keyring_href, repository_add_remove_content, x_task_diagnostics=x_task_diagnostics)

Modify Repository Content

Trigger an asynchronous task to create a new repository version.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.async_operation_response import AsyncOperationResponse
from pulpcore.client.pulpcore.models.repository_add_remove_content import RepositoryAddRemoveContent
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.RepositoriesOpenpgpKeyringApi(api_client)
    open_p_g_p_keyring_href = 'open_p_g_p_keyring_href_example' # str | 
    repository_add_remove_content = pulpcore.client.pulpcore.RepositoryAddRemoveContent() # RepositoryAddRemoveContent | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Modify Repository Content
        api_response = api_instance.modify(open_p_g_p_keyring_href, repository_add_remove_content, x_task_diagnostics=x_task_diagnostics)
        print("The response of RepositoriesOpenpgpKeyringApi->modify:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RepositoriesOpenpgpKeyringApi->modify: %s\n" % e)

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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]

my_permissions

MyPermissionsResponse my_permissions(open_p_g_p_keyring_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

List user permissions

List permissions available to the current user on this object.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.my_permissions_response import MyPermissionsResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.RepositoriesOpenpgpKeyringApi(api_client)
    open_p_g_p_keyring_href = 'open_p_g_p_keyring_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:
        # List user permissions
        api_response = api_instance.my_permissions(open_p_g_p_keyring_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of RepositoriesOpenpgpKeyringApi->my_permissions:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RepositoriesOpenpgpKeyringApi->my_permissions: %s\n" % e)

Parameters

Name	Type	Description	Notes
open_p_g_p_keyring_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

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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

OpenPGPKeyringResponse partial_update(open_p_g_p_keyring_href, patched_open_pgp_keyring, x_task_diagnostics=x_task_diagnostics)

Update an open pgp keyring

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.pulpcore
from pulpcore.client.pulpcore.models.open_pgp_keyring_response import OpenPGPKeyringResponse
from pulpcore.client.pulpcore.models.patched_open_pgp_keyring import PatchedOpenPGPKeyring
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.RepositoriesOpenpgpKeyringApi(api_client)
    open_p_g_p_keyring_href = 'open_p_g_p_keyring_href_example' # str | 
    patched_open_pgp_keyring = pulpcore.client.pulpcore.PatchedOpenPGPKeyring() # PatchedOpenPGPKeyring | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Update an open pgp keyring
        api_response = api_instance.partial_update(open_p_g_p_keyring_href, patched_open_pgp_keyring, x_task_diagnostics=x_task_diagnostics)
        print("The response of RepositoriesOpenpgpKeyringApi->partial_update:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RepositoriesOpenpgpKeyringApi->partial_update: %s\n" % e)

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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

OpenPGPKeyringResponse read(open_p_g_p_keyring_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

Inspect an open pgp keyring

A ViewSet for an ordinary repository.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.open_pgp_keyring_response import OpenPGPKeyringResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.RepositoriesOpenpgpKeyringApi(api_client)
    open_p_g_p_keyring_href = 'open_p_g_p_keyring_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 an open pgp keyring
        api_response = api_instance.read(open_p_g_p_keyring_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of RepositoriesOpenpgpKeyringApi->read:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RepositoriesOpenpgpKeyringApi->read: %s\n" % e)

Parameters

Name	Type	Description	Notes
open_p_g_p_keyring_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

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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]

remove_role

NestedRoleResponse remove_role(open_p_g_p_keyring_href, nested_role, x_task_diagnostics=x_task_diagnostics)

Remove a role

Remove a role for this object from users/groups.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.nested_role import NestedRole
from pulpcore.client.pulpcore.models.nested_role_response import NestedRoleResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.RepositoriesOpenpgpKeyringApi(api_client)
    open_p_g_p_keyring_href = 'open_p_g_p_keyring_href_example' # str | 
    nested_role = pulpcore.client.pulpcore.NestedRole() # NestedRole | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Remove a role
        api_response = api_instance.remove_role(open_p_g_p_keyring_href, nested_role, x_task_diagnostics=x_task_diagnostics)
        print("The response of RepositoriesOpenpgpKeyringApi->remove_role:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RepositoriesOpenpgpKeyringApi->remove_role: %s\n" % e)

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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]

set_label

SetLabelResponse set_label(open_p_g_p_keyring_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.pulpcore
from pulpcore.client.pulpcore.models.set_label import SetLabel
from pulpcore.client.pulpcore.models.set_label_response import SetLabelResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.RepositoriesOpenpgpKeyringApi(api_client)
    open_p_g_p_keyring_href = 'open_p_g_p_keyring_href_example' # str | 
    set_label = pulpcore.client.pulpcore.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(open_p_g_p_keyring_href, set_label, x_task_diagnostics=x_task_diagnostics)
        print("The response of RepositoriesOpenpgpKeyringApi->set_label:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RepositoriesOpenpgpKeyringApi->set_label: %s\n" % e)

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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(open_p_g_p_keyring_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.pulpcore
from pulpcore.client.pulpcore.models.unset_label import UnsetLabel
from pulpcore.client.pulpcore.models.unset_label_response import UnsetLabelResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.RepositoriesOpenpgpKeyringApi(api_client)
    open_p_g_p_keyring_href = 'open_p_g_p_keyring_href_example' # str | 
    unset_label = pulpcore.client.pulpcore.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(open_p_g_p_keyring_href, unset_label, x_task_diagnostics=x_task_diagnostics)
        print("The response of RepositoriesOpenpgpKeyringApi->unset_label:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RepositoriesOpenpgpKeyringApi->unset_label: %s\n" % e)

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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

OpenPGPKeyringResponse update(open_p_g_p_keyring_href, open_pgp_keyring, x_task_diagnostics=x_task_diagnostics)

Update an open pgp keyring

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.pulpcore
from pulpcore.client.pulpcore.models.open_pgp_keyring import OpenPGPKeyring
from pulpcore.client.pulpcore.models.open_pgp_keyring_response import OpenPGPKeyringResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.RepositoriesOpenpgpKeyringApi(api_client)
    open_p_g_p_keyring_href = 'open_p_g_p_keyring_href_example' # str | 
    open_pgp_keyring = pulpcore.client.pulpcore.OpenPGPKeyring() # OpenPGPKeyring | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Update an open pgp keyring
        api_response = api_instance.update(open_p_g_p_keyring_href, open_pgp_keyring, x_task_diagnostics=x_task_diagnostics)
        print("The response of RepositoriesOpenpgpKeyringApi->update:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RepositoriesOpenpgpKeyringApi->update: %s\n" % e)

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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.pulpcore.RepositoriesReclaimSpaceApi

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

Method	HTTP request	Description
reclaim	POST /api/pulp/{pulp_domain}/api/v3/repositories/reclaim_space/

reclaim

AsyncOperationResponse reclaim(pulp_domain, reclaim_space, x_task_diagnostics=x_task_diagnostics)

Trigger an asynchronous space reclaim operation.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.async_operation_response import AsyncOperationResponse
from pulpcore.client.pulpcore.models.reclaim_space import ReclaimSpace
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.RepositoriesReclaimSpaceApi(api_client)
    pulp_domain = 'pulp_domain_example' # str | 
    reclaim_space = pulpcore.client.pulpcore.ReclaimSpace() # ReclaimSpace | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

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

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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]

RepositoryAddRemoveContent

Properties

Name	Type	Description	Notes
add_content_units	List[str]	A list of content units to add to a new repository version. This content is added after remove_content_units are removed.	[optional]
remove_content_units	List[str]	A list of content units to remove from the latest repository version. You may also specify '*' as an entry to remove all content. This content is removed before add_content_units are added.	[optional]
base_version	str	A repository version whose content will be used as the initial set of content for the new repository version	[optional]

Example

from pulpcore.client.pulpcore.models.repository_add_remove_content import RepositoryAddRemoveContent

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

# convert the object into a dict
repository_add_remove_content_dict = repository_add_remove_content_instance.to_dict()
# create an instance of RepositoryAddRemoveContent from a dict
repository_add_remove_content_from_dict = RepositoryAddRemoveContent.from_dict(repository_add_remove_content_dict)

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

RepositoryResponse

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.pulpcore.models.repository_response import RepositoryResponse

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

# convert the object into a dict
repository_response_dict = repository_response_instance.to_dict()
# create an instance of RepositoryResponse from a dict
repository_response_from_dict = RepositoryResponse.from_dict(repository_response_dict)

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

RepositoryVersionResponse

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.pulpcore.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]

pulpcore.client.pulpcore.RepositoryVersionsApi

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

Method	HTTP request	Description
list	GET /api/pulp/{pulp_domain}/api/v3/repository_versions/	List repository versions

list

PaginatedRepositoryVersionResponseList list(pulp_domain, 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

A mixin to hold the shared get_queryset logic used by RepositoryVersionViewSets.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.paginated_repository_version_response_list import PaginatedRepositoryVersionResponseList
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.RepositoryVersionsApi(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)
    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(pulp_domain, 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 RepositoryVersionsApi->list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RepositoryVersionsApi->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]
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]

Role

Serializer for Role.

Properties

Name	Type	Description	Notes
name	str	The name of this role.
description	str	An optional description.	[optional]
permissions	List[str]	List of permissions defining the role.

Example

from pulpcore.client.pulpcore.models.role import Role

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

# convert the object into a dict
role_dict = role_instance.to_dict()
# create an instance of Role from a dict
role_from_dict = Role.from_dict(role_dict)

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

RoleResponse

Serializer for Role.

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]
name	str	The name of this role.
description	str	An optional description.	[optional]
permissions	List[str]	List of permissions defining the role.
locked	bool	True if the role is system managed.	[optional] [readonly]

Example

from pulpcore.client.pulpcore.models.role_response import RoleResponse

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

# convert the object into a dict
role_response_dict = role_response_instance.to_dict()
# create an instance of RoleResponse from a dict
role_response_from_dict = RoleResponse.from_dict(role_response_dict)

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

pulpcore.client.pulpcore.RolesApi

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

Method	HTTP request	Description
create	POST /api/pulp/{pulp_domain}/api/v3/roles/	Create a role
delete	DELETE {role_href}	Delete a role
list	GET /api/pulp/{pulp_domain}/api/v3/roles/	List roles
partial_update	PATCH {role_href}	Update a role
read	GET {role_href}	Inspect a role
update	PUT {role_href}	Update a role

create

RoleResponse create(pulp_domain, role, x_task_diagnostics=x_task_diagnostics)

Create a role

ViewSet for Role.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.role import Role
from pulpcore.client.pulpcore.models.role_response import RoleResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.RolesApi(api_client)
    pulp_domain = 'pulp_domain_example' # str | 
    role = pulpcore.client.pulpcore.Role() # Role | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

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

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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

delete(role_href, x_task_diagnostics=x_task_diagnostics)

Delete a role

ViewSet for Role.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

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

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.RolesApi(api_client)
    role_href = 'role_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Delete a role
        api_instance.delete(role_href, x_task_diagnostics=x_task_diagnostics)
    except Exception as e:
        print("Exception when calling RolesApi->delete: %s\n" % e)

Parameters

Name	Type	Description	Notes
role_href	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
204	No response body	-

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

list

PaginatedRoleResponseList list(pulp_domain, x_task_diagnostics=x_task_diagnostics, contains_permission=contains_permission, description=description, description__contains=description__contains, description__icontains=description__icontains, description__iexact=description__iexact, for_object_type=for_object_type, limit=limit, locked=locked, 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, q=q, fields=fields, exclude_fields=exclude_fields)

List roles

ViewSet for Role.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.paginated_role_response_list import PaginatedRoleResponseList
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.RolesApi(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)
    contains_permission = ['contains_permission_example'] # List[str] | Filter roles that have any of the permissions in the list. (optional)
    description = 'description_example' # str | Filter results where description matches value (optional)
    description__contains = 'description__contains_example' # str | Filter results where description contains value (optional)
    description__icontains = 'description__icontains_example' # str | Filter results where description contains value (optional)
    description__iexact = 'description__iexact_example' # str | Filter results where description matches value (optional)
    for_object_type = 'for_object_type_example' # str | Filter roles that only have permissions for the specified object HREF. (optional)
    limit = 56 # int | Number of results to return per page. (optional)
    locked = True # bool | Filter results where locked matches value (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) * `name` - Name * `-name` - Name (descending) * `description` - Description * `-description` - Description (descending) * `locked` - Locked * `-locked` - Locked (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)
    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 roles
        api_response = api_instance.list(pulp_domain, x_task_diagnostics=x_task_diagnostics, contains_permission=contains_permission, description=description, description__contains=description__contains, description__icontains=description__icontains, description__iexact=description__iexact, for_object_type=for_object_type, limit=limit, locked=locked, 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, q=q, fields=fields, exclude_fields=exclude_fields)
        print("The response of RolesApi->list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RolesApi->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]
contains_permission	List[str]	Filter roles that have any of the permissions in the list.	[optional]
description	str	Filter results where description matches value	[optional]
description__contains	str	Filter results where description contains value	[optional]
description__icontains	str	Filter results where description contains value	[optional]
description__iexact	str	Filter results where description matches value	[optional]
for_object_type	str	Filter roles that only have permissions for the specified object HREF.	[optional]
limit	int	Number of results to return per page.	[optional]
locked	bool	Filter results where locked matches value	[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) * `name` - Name * `-name` - Name (descending) * `description` - Description * `-description` - Description (descending) * `locked` - Locked * `-locked` - Locked (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]
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

PaginatedRoleResponseList

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

RoleResponse partial_update(role_href, patched_role, x_task_diagnostics=x_task_diagnostics)

Update a role

ViewSet for Role.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.patched_role import PatchedRole
from pulpcore.client.pulpcore.models.role_response import RoleResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.RolesApi(api_client)
    role_href = 'role_href_example' # str | 
    patched_role = pulpcore.client.pulpcore.PatchedRole() # PatchedRole | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Update a role
        api_response = api_instance.partial_update(role_href, patched_role, x_task_diagnostics=x_task_diagnostics)
        print("The response of RolesApi->partial_update:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RolesApi->partial_update: %s\n" % e)

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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]

read

RoleResponse read(role_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

Inspect a role

ViewSet for Role.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.role_response import RoleResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.RolesApi(api_client)
    role_href = 'role_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 role
        api_response = api_instance.read(role_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of RolesApi->read:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RolesApi->read: %s\n" % e)

Parameters

Name	Type	Description	Notes
role_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

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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]

update

RoleResponse update(role_href, role, x_task_diagnostics=x_task_diagnostics)

Update a role

ViewSet for Role.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.role import Role
from pulpcore.client.pulpcore.models.role_response import RoleResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.RolesApi(api_client)
    role_href = 'role_href_example' # str | 
    role = pulpcore.client.pulpcore.Role() # Role | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

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

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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]

SetLabel

Serializer for synchronously setting a label.

Properties

Name	Type	Description	Notes
key	str
value	str

Example

from pulpcore.client.pulpcore.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.pulpcore.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]

SigningServiceResponse

A serializer for the model declaring a signing service.

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]
name	str	A unique name used to recognize a script.
public_key	str	The value of a public key used for the repository verification.
pubkey_fingerprint	str	The fingerprint of the public key.
script	str	An absolute path to a script which is going to be used for the signing.

Example

from pulpcore.client.pulpcore.models.signing_service_response import SigningServiceResponse

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

# convert the object into a dict
signing_service_response_dict = signing_service_response_instance.to_dict()
# create an instance of SigningServiceResponse from a dict
signing_service_response_from_dict = SigningServiceResponse.from_dict(signing_service_response_dict)

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

pulpcore.client.pulpcore.SigningServicesApi

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

Method	HTTP request	Description
list	GET /api/pulp/{pulp_domain}/api/v3/signing-services/	List signing services
read	GET {signing_service_href}	Inspect a signing service

list

PaginatedSigningServiceResponseList list(pulp_domain, x_task_diagnostics=x_task_diagnostics, limit=limit, name=name, offset=offset, ordering=ordering, prn__in=prn__in, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, q=q, fields=fields, exclude_fields=exclude_fields)

List signing services

A ViewSet that supports browsing of existing signing services.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.paginated_signing_service_response_list import PaginatedSigningServiceResponseList
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.SigningServicesApi(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)
    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) * `name` - Name * `-name` - Name (descending) * `public_key` - Public key * `-public_key` - Public key (descending) * `pubkey_fingerprint` - Pubkey fingerprint * `-pubkey_fingerprint` - Pubkey fingerprint (descending) * `script` - Script * `-script` - Script (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)
    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 signing services
        api_response = api_instance.list(pulp_domain, x_task_diagnostics=x_task_diagnostics, limit=limit, name=name, offset=offset, ordering=ordering, prn__in=prn__in, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, q=q, fields=fields, exclude_fields=exclude_fields)
        print("The response of SigningServicesApi->list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SigningServicesApi->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]
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) * `name` - Name * `-name` - Name (descending) * `public_key` - Public key * `-public_key` - Public key (descending) * `pubkey_fingerprint` - Pubkey fingerprint * `-pubkey_fingerprint` - Pubkey fingerprint (descending) * `script` - Script * `-script` - Script (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]
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

PaginatedSigningServiceResponseList

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

SigningServiceResponse read(signing_service_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

Inspect a signing service

A ViewSet that supports browsing of existing signing services.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.signing_service_response import SigningServiceResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.SigningServicesApi(api_client)
    signing_service_href = 'signing_service_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 signing service
        api_response = api_instance.read(signing_service_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of SigningServicesApi->read:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SigningServicesApi->read: %s\n" % e)

Parameters

Name	Type	Description	Notes
signing_service_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

SigningServiceResponse

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]

StatesEnum

skipped - skipped * completed - completed * failed - failed * canceled - canceled

Enum

SKIPPED (value: 'skipped')
COMPLETED (value: 'completed')
FAILED (value: 'failed')
CANCELED (value: 'canceled')

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

pulpcore.client.pulpcore.StatusApi

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

Method	HTTP request	Description
status_read	GET /api/pulp/api/v3/status/	Inspect status of Pulp

status_read

StatusResponse status_read(x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

Inspect status of Pulp

Returns status and app information about Pulp. Information includes: * version of pulpcore and loaded pulp plugins * known workers * known content apps * database connection status * redis connection status * disk usage information

Example

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.status_response import StatusResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

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


# Enter a context with an instance of the API client
with pulpcore.client.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.StatusApi(api_client)
    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 status of Pulp
        api_response = api_instance.status_read(x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of StatusApi->status_read:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling StatusApi->status_read: %s\n" % e)

Parameters

Name	Type	Description	Notes
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

StatusResponse

Authorization

No authorization required

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]

StatusResponse

Serializer for the status information of the app

Properties

Name	Type	Description	Notes
versions	List[VersionResponse]	Version information of Pulp components
online_workers	List[AppStatusResponse]	List of online workers known to the application. An online worker is actively heartbeating and can respond to new work.
online_api_apps	List[AppStatusResponse]	List of online api apps known to the application. An online api app is actively heartbeating and can serve the rest api to clients.
online_content_apps	List[AppStatusResponse]	List of online content apps known to the application. An online content app is actively heartbeating and can serve data to clients.
database_connection	DatabaseConnectionResponse	Database connection information
redis_connection	RedisConnectionResponse	Redis connection information	[optional]
storage	StorageResponse	Storage information	[optional]
content_settings	ContentSettingsResponse	Content-app settings
domain_enabled	bool	Is Domains enabled

Example

from pulpcore.client.pulpcore.models.status_response import StatusResponse

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

# convert the object into a dict
status_response_dict = status_response_instance.to_dict()
# create an instance of StatusResponse from a dict
status_response_from_dict = StatusResponse.from_dict(status_response_dict)

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

StorageClassEnum

pulpcore.app.models.storage.FileSystem - Use local filesystem as storage * storages.backends.s3boto3.S3Boto3Storage - Use Amazon S3 as storage [deprecated] * storages.backends.s3.S3Storage - Use Amazon S3 as storage * storages.backends.azure_storage.AzureStorage - Use Azure Blob as storage * pulp_service.app.storage.OCIStorage - Use OCI as storage

Enum

PULPCORE_DOT_APP_DOT_MODELS_DOT_STORAGE_DOT_FILE_SYSTEM (value: 'pulpcore.app.models.storage.FileSystem')
STORAGES_DOT_BACKENDS_DOT_S3BOTO3_DOT_S3_BOTO3_STORAGE (value: 'storages.backends.s3boto3.S3Boto3Storage')
STORAGES_DOT_BACKENDS_DOT_S3_DOT_S3_STORAGE (value: 'storages.backends.s3.S3Storage')
STORAGES_DOT_BACKENDS_DOT_AZURE_STORAGE_DOT_AZURE_STORAGE (value: 'storages.backends.azure_storage.AzureStorage')
PULP_SERVICE_DOT_APP_DOT_STORAGE_DOT_OCI_STORAGE (value: 'pulp_service.app.storage.OCIStorage')

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

StorageResponse

Serializer for information about the storage system

Properties

Name	Type	Description
total	int	Total number of bytes
used	int	Number of bytes in use
free	int	Number of free bytes

Example

from pulpcore.client.pulpcore.models.storage_response import StorageResponse

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

# convert the object into a dict
storage_response_dict = storage_response_instance.to_dict()
# create an instance of StorageResponse from a dict
storage_response_from_dict = StorageResponse.from_dict(storage_response_dict)

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

TaskGroupOperationResponse

Serializer for asynchronous operations that return a task group.

Properties

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

Example

from pulpcore.client.pulpcore.models.task_group_operation_response import TaskGroupOperationResponse

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

# convert the object into a dict
task_group_operation_response_dict = task_group_operation_response_instance.to_dict()
# create an instance of TaskGroupOperationResponse from a dict
task_group_operation_response_from_dict = TaskGroupOperationResponse.from_dict(task_group_operation_response_dict)

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

TaskGroupResponse

Properties

Name	Type	Description	Notes
pulp_href	str		[optional] [readonly]
prn	str	The Pulp Resource Name (PRN).	[optional] [readonly]
description	str	A description of the task group.
all_tasks_dispatched	bool	Whether all tasks have been spawned for this task group.
waiting	int	Number of tasks in the 'waiting' state	[optional] [readonly]
skipped	int	Number of tasks in the 'skipped' state	[optional] [readonly]
running	int	Number of tasks in the 'running' state	[optional] [readonly]
completed	int	Number of tasks in the 'completed' state	[optional] [readonly]
canceled	int	Number of tasks in the 'canceled' state	[optional] [readonly]
failed	int	Number of tasks in the 'failed' state	[optional] [readonly]
canceling	int	Number of tasks in the 'canceling' state	[optional] [readonly]
group_progress_reports	List[GroupProgressReportResponse]		[optional] [readonly]
tasks	List[MinimalTaskResponse]		[optional] [readonly]

Example

from pulpcore.client.pulpcore.models.task_group_response import TaskGroupResponse

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

# convert the object into a dict
task_group_response_dict = task_group_response_instance.to_dict()
# create an instance of TaskGroupResponse from a dict
task_group_response_from_dict = TaskGroupResponse.from_dict(task_group_response_dict)

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

pulpcore.client.pulpcore.TaskGroupsApi

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

Method	HTTP request	Description
list	GET /api/pulp/{pulp_domain}/api/v3/task-groups/	List task groups
read	GET {task_group_href}	Inspect a task group
task_groups_cancel	PATCH {task_group_href}	Cancel a task group

list

PaginatedTaskGroupResponseList list(pulp_domain, x_task_diagnostics=x_task_diagnostics, limit=limit, offset=offset, fields=fields, exclude_fields=exclude_fields)

List task groups

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.paginated_task_group_response_list import PaginatedTaskGroupResponseList
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.TaskGroupsApi(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)
    offset = 56 # int | The initial index from which to return the results. (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 task groups
        api_response = api_instance.list(pulp_domain, x_task_diagnostics=x_task_diagnostics, limit=limit, offset=offset, fields=fields, exclude_fields=exclude_fields)
        print("The response of TaskGroupsApi->list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TaskGroupsApi->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]
offset	int	The initial index from which to return the results.	[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

PaginatedTaskGroupResponseList

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

TaskGroupResponse read(task_group_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

Inspect a task group

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.task_group_response import TaskGroupResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.TaskGroupsApi(api_client)
    task_group_href = 'task_group_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 task group
        api_response = api_instance.read(task_group_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of TaskGroupsApi->read:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TaskGroupsApi->read: %s\n" % e)

Parameters

Name	Type	Description	Notes
task_group_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

TaskGroupResponse

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]

task_groups_cancel

TaskGroupResponse task_groups_cancel(task_group_href, patched_task_cancel, x_task_diagnostics=x_task_diagnostics)

Cancel a task group

This operation cancels a task group.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.patched_task_cancel import PatchedTaskCancel
from pulpcore.client.pulpcore.models.task_group_response import TaskGroupResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.TaskGroupsApi(api_client)
    task_group_href = 'task_group_href_example' # str | 
    patched_task_cancel = pulpcore.client.pulpcore.PatchedTaskCancel() # PatchedTaskCancel | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Cancel a task group
        api_response = api_instance.task_groups_cancel(task_group_href, patched_task_cancel, x_task_diagnostics=x_task_diagnostics)
        print("The response of TaskGroupsApi->task_groups_cancel:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TaskGroupsApi->task_groups_cancel: %s\n" % e)

Parameters

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

Return type

TaskGroupResponse

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		-
409		-

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

TaskResponse

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]
state	str	The current state of the task. The possible values include: 'waiting', 'skipped', 'running', 'completed', 'failed', 'canceled' and 'canceling'.	[optional] [readonly]
name	str	The name of task.
logging_cid	str	The logging correlation id associated with this task
created_by	str	User who dispatched this task.	[optional] [readonly]
unblocked_at	datetime	Timestamp of when this task was identified ready for pickup.	[optional] [readonly]
started_at	datetime	Timestamp of when this task started execution.	[optional] [readonly]
finished_at	datetime	Timestamp of when this task stopped execution.	[optional] [readonly]
error	object	A JSON Object of a fatal error encountered during the execution of this task.	[optional] [readonly]
worker	str	DEPRECATED - Always null	[optional] [readonly]
parent_task	str	The parent task that spawned this task.	[optional] [readonly]
child_tasks	List[str]	Any tasks spawned by this task.	[optional] [readonly]
task_group	str	The task group that this task is a member of.	[optional] [readonly]
progress_reports	List[ProgressReportResponse]		[optional] [readonly]
created_resources	List[str]	Resources created by this task.	[optional] [readonly]
reserved_resources_record	List[str]	A list of resources required by that task.	[optional] [readonly]
result	object	The result of this task.	[optional] [readonly]

Example

from pulpcore.client.pulpcore.models.task_response import TaskResponse

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

# convert the object into a dict
task_response_dict = task_response_instance.to_dict()
# create an instance of TaskResponse from a dict
task_response_from_dict = TaskResponse.from_dict(task_response_dict)

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

pulpcore.client.pulpcore.TasksApi

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

Method	HTTP request	Description
add_role	POST {task_href}add_role/	Add a role
delete	DELETE {task_href}	Delete a task
list	GET /api/pulp/{pulp_domain}/api/v3/tasks/	List tasks
list_roles	GET {task_href}list_roles/	List roles
my_permissions	GET {task_href}my_permissions/	List user permissions
profile_artifacts	GET {task_href}profile_artifacts/	Fetch downloadable links for profile artifacts
purge	POST /api/pulp/{pulp_domain}/api/v3/tasks/purge/	Purge Completed Tasks
read	GET {task_href}	Inspect a task
remove_role	POST {task_href}remove_role/	Remove a role
tasks_cancel	PATCH {task_href}	Cancel a task

add_role

NestedRoleResponse add_role(task_href, nested_role, x_task_diagnostics=x_task_diagnostics)

Add a role

Add a role for this object to users/groups.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.nested_role import NestedRole
from pulpcore.client.pulpcore.models.nested_role_response import NestedRoleResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.TasksApi(api_client)
    task_href = 'task_href_example' # str | 
    nested_role = pulpcore.client.pulpcore.NestedRole() # NestedRole | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Add a role
        api_response = api_instance.add_role(task_href, nested_role, x_task_diagnostics=x_task_diagnostics)
        print("The response of TasksApi->add_role:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TasksApi->add_role: %s\n" % e)

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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

delete(task_href, x_task_diagnostics=x_task_diagnostics)

Delete a task

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

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

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.TasksApi(api_client)
    task_href = 'task_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Delete a task
        api_instance.delete(task_href, x_task_diagnostics=x_task_diagnostics)
    except Exception as e:
        print("Exception when calling TasksApi->delete: %s\n" % e)

Parameters

Name	Type	Description	Notes
task_href	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
204	No response body	-

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

list

PaginatedTaskResponseList list(pulp_domain, x_task_diagnostics=x_task_diagnostics, child_tasks=child_tasks, created_resources=created_resources, exclusive_resources=exclusive_resources, exclusive_resources__in=exclusive_resources__in, finished_at=finished_at, finished_at__gt=finished_at__gt, finished_at__gte=finished_at__gte, finished_at__isnull=finished_at__isnull, finished_at__lt=finished_at__lt, finished_at__lte=finished_at__lte, finished_at__range=finished_at__range, limit=limit, logging_cid=logging_cid, logging_cid__contains=logging_cid__contains, name=name, name__contains=name__contains, name__in=name__in, name__ne=name__ne, offset=offset, ordering=ordering, parent_task=parent_task, 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, pulp_id__in=pulp_id__in, q=q, reserved_resources=reserved_resources, reserved_resources__in=reserved_resources__in, shared_resources=shared_resources, shared_resources__in=shared_resources__in, started_at=started_at, started_at__gt=started_at__gt, started_at__gte=started_at__gte, started_at__isnull=started_at__isnull, started_at__lt=started_at__lt, started_at__lte=started_at__lte, started_at__range=started_at__range, state=state, state__in=state__in, state__ne=state__ne, task_group=task_group, unblocked_at=unblocked_at, unblocked_at__gt=unblocked_at__gt, unblocked_at__gte=unblocked_at__gte, unblocked_at__isnull=unblocked_at__isnull, unblocked_at__lt=unblocked_at__lt, unblocked_at__lte=unblocked_at__lte, unblocked_at__range=unblocked_at__range, worker=worker, fields=fields, exclude_fields=exclude_fields)

List tasks

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.paginated_task_response_list import PaginatedTaskResponseList
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.TasksApi(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)
    child_tasks = 'child_tasks_example' # str | Filter results where child_tasks matches value (optional)
    created_resources = 'created_resources_example' # str |  (optional)
    exclusive_resources = 'exclusive_resources_example' # str |  (optional)
    exclusive_resources__in = ['exclusive_resources__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
    finished_at = '2013-10-20T19:20:30+01:00' # datetime | Filter results where finished_at matches value (optional)
    finished_at__gt = '2013-10-20T19:20:30+01:00' # datetime | Filter results where finished_at is greater than value (optional)
    finished_at__gte = '2013-10-20T19:20:30+01:00' # datetime | Filter results where finished_at is greater than or equal to value (optional)
    finished_at__isnull = True # bool | Filter results where finished_at has a null value (optional)
    finished_at__lt = '2013-10-20T19:20:30+01:00' # datetime | Filter results where finished_at is less than value (optional)
    finished_at__lte = '2013-10-20T19:20:30+01:00' # datetime | Filter results where finished_at is less than or equal to value (optional)
    finished_at__range = ['2013-10-20T19:20:30+01:00'] # List[datetime] | Filter results where finished_at is between two comma separated values (optional)
    limit = 56 # int | Number of results to return per page. (optional)
    logging_cid = 'logging_cid_example' # str | Filter results where logging_cid matches value (optional)
    logging_cid__contains = 'logging_cid__contains_example' # str | Filter results where logging_cid contains value (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__in = ['name__in_example'] # List[str] | Filter results where name is in a comma-separated list of values (optional)
    name__ne = 'name__ne_example' # str | Filter results where name not equal to 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) * `state` - State * `-state` - State (descending) * `name` - Name * `-name` - Name (descending) * `logging_cid` - Logging cid * `-logging_cid` - Logging cid (descending) * `unblocked_at` - Unblocked at * `-unblocked_at` - Unblocked at (descending) * `started_at` - Started at * `-started_at` - Started at (descending) * `finished_at` - Finished at * `-finished_at` - Finished at (descending) * `error` - Error * `-error` - Error (descending) * `enc_args` - Enc args * `-enc_args` - Enc args (descending) * `enc_kwargs` - Enc kwargs * `-enc_kwargs` - Enc kwargs (descending) * `reserved_resources_record` - Reserved resources record * `-reserved_resources_record` - Reserved resources record (descending) * `versions` - Versions * `-versions` - Versions (descending) * `profile_options` - Profile options * `-profile_options` - Profile options (descending) * `immediate` - Immediate * `-immediate` - Immediate (descending) * `deferred` - Deferred * `-deferred` - Deferred (descending) * `result` - Result * `-result` - Result (descending) * `pk` - Pk * `-pk` - Pk (descending) (optional)
    parent_task = 'parent_task_example' # str | Filter results where parent_task matches value (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)
    pulp_id__in = ['pulp_id__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)
    reserved_resources = 'reserved_resources_example' # str |  (optional)
    reserved_resources__in = ['reserved_resources__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
    shared_resources = 'shared_resources_example' # str |  (optional)
    shared_resources__in = ['shared_resources__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
    started_at = '2013-10-20T19:20:30+01:00' # datetime | Filter results where started_at matches value (optional)
    started_at__gt = '2013-10-20T19:20:30+01:00' # datetime | Filter results where started_at is greater than value (optional)
    started_at__gte = '2013-10-20T19:20:30+01:00' # datetime | Filter results where started_at is greater than or equal to value (optional)
    started_at__isnull = True # bool | Filter results where started_at has a null value (optional)
    started_at__lt = '2013-10-20T19:20:30+01:00' # datetime | Filter results where started_at is less than value (optional)
    started_at__lte = '2013-10-20T19:20:30+01:00' # datetime | Filter results where started_at is less than or equal to value (optional)
    started_at__range = ['2013-10-20T19:20:30+01:00'] # List[datetime] | Filter results where started_at is between two comma separated values (optional)
    state = 'state_example' # str | Filter results where state matches value  * `waiting` - Waiting * `skipped` - Skipped * `running` - Running * `completed` - Completed * `failed` - Failed * `canceled` - Canceled * `canceling` - Canceling (optional)
    state__in = ['state__in_example'] # List[str] | Filter results where state is in a comma-separated list of values (optional)
    state__ne = 'state__ne_example' # str | Filter results where state not equal to value (optional)
    task_group = 'task_group_example' # str | Filter results where task_group matches value (optional)
    unblocked_at = '2013-10-20T19:20:30+01:00' # datetime | Filter results where unblocked_at matches value (optional)
    unblocked_at__gt = '2013-10-20T19:20:30+01:00' # datetime | Filter results where unblocked_at is greater than value (optional)
    unblocked_at__gte = '2013-10-20T19:20:30+01:00' # datetime | Filter results where unblocked_at is greater than or equal to value (optional)
    unblocked_at__isnull = True # bool | Filter results where unblocked_at has a null value (optional)
    unblocked_at__lt = '2013-10-20T19:20:30+01:00' # datetime | Filter results where unblocked_at is less than value (optional)
    unblocked_at__lte = '2013-10-20T19:20:30+01:00' # datetime | Filter results where unblocked_at is less than or equal to value (optional)
    unblocked_at__range = ['2013-10-20T19:20:30+01:00'] # List[datetime] | Filter results where unblocked_at is between two comma separated values (optional)
    worker = 'worker_example' # str |  (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 tasks
        api_response = api_instance.list(pulp_domain, x_task_diagnostics=x_task_diagnostics, child_tasks=child_tasks, created_resources=created_resources, exclusive_resources=exclusive_resources, exclusive_resources__in=exclusive_resources__in, finished_at=finished_at, finished_at__gt=finished_at__gt, finished_at__gte=finished_at__gte, finished_at__isnull=finished_at__isnull, finished_at__lt=finished_at__lt, finished_at__lte=finished_at__lte, finished_at__range=finished_at__range, limit=limit, logging_cid=logging_cid, logging_cid__contains=logging_cid__contains, name=name, name__contains=name__contains, name__in=name__in, name__ne=name__ne, offset=offset, ordering=ordering, parent_task=parent_task, 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, pulp_id__in=pulp_id__in, q=q, reserved_resources=reserved_resources, reserved_resources__in=reserved_resources__in, shared_resources=shared_resources, shared_resources__in=shared_resources__in, started_at=started_at, started_at__gt=started_at__gt, started_at__gte=started_at__gte, started_at__isnull=started_at__isnull, started_at__lt=started_at__lt, started_at__lte=started_at__lte, started_at__range=started_at__range, state=state, state__in=state__in, state__ne=state__ne, task_group=task_group, unblocked_at=unblocked_at, unblocked_at__gt=unblocked_at__gt, unblocked_at__gte=unblocked_at__gte, unblocked_at__isnull=unblocked_at__isnull, unblocked_at__lt=unblocked_at__lt, unblocked_at__lte=unblocked_at__lte, unblocked_at__range=unblocked_at__range, worker=worker, fields=fields, exclude_fields=exclude_fields)
        print("The response of TasksApi->list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TasksApi->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]
child_tasks	str	Filter results where child_tasks matches value	[optional]
created_resources	str		[optional]
exclusive_resources	str		[optional]
exclusive_resources__in	List[str]	Multiple values may be separated by commas.	[optional]
finished_at	datetime	Filter results where finished_at matches value	[optional]
finished_at__gt	datetime	Filter results where finished_at is greater than value	[optional]
finished_at__gte	datetime	Filter results where finished_at is greater than or equal to value	[optional]
finished_at__isnull	bool	Filter results where finished_at has a null value	[optional]
finished_at__lt	datetime	Filter results where finished_at is less than value	[optional]
finished_at__lte	datetime	Filter results where finished_at is less than or equal to value	[optional]
finished_at__range	List[datetime]	Filter results where finished_at is between two comma separated values	[optional]
limit	int	Number of results to return per page.	[optional]
logging_cid	str	Filter results where logging_cid matches value	[optional]
logging_cid__contains	str	Filter results where logging_cid contains value	[optional]
name	str	Filter results where name matches value	[optional]
name__contains	str	Filter results where name contains value	[optional]
name__in	List[str]	Filter results where name is in a comma-separated list of values	[optional]
name__ne	str	Filter results where name not equal to 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) * `state` - State * `-state` - State (descending) * `name` - Name * `-name` - Name (descending) * `logging_cid` - Logging cid * `-logging_cid` - Logging cid (descending) * `unblocked_at` - Unblocked at * `-unblocked_at` - Unblocked at (descending) * `started_at` - Started at * `-started_at` - Started at (descending) * `finished_at` - Finished at * `-finished_at` - Finished at (descending) * `error` - Error * `-error` - Error (descending) * `enc_args` - Enc args * `-enc_args` - Enc args (descending) * `enc_kwargs` - Enc kwargs * `-enc_kwargs` - Enc kwargs (descending) * `reserved_resources_record` - Reserved resources record * `-reserved_resources_record` - Reserved resources record (descending) * `versions` - Versions * `-versions` - Versions (descending) * `profile_options` - Profile options * `-profile_options` - Profile options (descending) * `immediate` - Immediate * `-immediate` - Immediate (descending) * `deferred` - Deferred * `-deferred` - Deferred (descending) * `result` - Result * `-result` - Result (descending) * `pk` - Pk * `-pk` - Pk (descending)	[optional]
parent_task	str	Filter results where parent_task matches value	[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]
pulp_id__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]
reserved_resources	str		[optional]
reserved_resources__in	List[str]	Multiple values may be separated by commas.	[optional]
shared_resources	str		[optional]
shared_resources__in	List[str]	Multiple values may be separated by commas.	[optional]
started_at	datetime	Filter results where started_at matches value	[optional]
started_at__gt	datetime	Filter results where started_at is greater than value	[optional]
started_at__gte	datetime	Filter results where started_at is greater than or equal to value	[optional]
started_at__isnull	bool	Filter results where started_at has a null value	[optional]
started_at__lt	datetime	Filter results where started_at is less than value	[optional]
started_at__lte	datetime	Filter results where started_at is less than or equal to value	[optional]
started_at__range	List[datetime]	Filter results where started_at is between two comma separated values	[optional]
state	str	Filter results where state matches value * `waiting` - Waiting * `skipped` - Skipped * `running` - Running * `completed` - Completed * `failed` - Failed * `canceled` - Canceled * `canceling` - Canceling	[optional]
state__in	List[str]	Filter results where state is in a comma-separated list of values	[optional]
state__ne	str	Filter results where state not equal to value	[optional]
task_group	str	Filter results where task_group matches value	[optional]
unblocked_at	datetime	Filter results where unblocked_at matches value	[optional]
unblocked_at__gt	datetime	Filter results where unblocked_at is greater than value	[optional]
unblocked_at__gte	datetime	Filter results where unblocked_at is greater than or equal to value	[optional]
unblocked_at__isnull	bool	Filter results where unblocked_at has a null value	[optional]
unblocked_at__lt	datetime	Filter results where unblocked_at is less than value	[optional]
unblocked_at__lte	datetime	Filter results where unblocked_at is less than or equal to value	[optional]
unblocked_at__range	List[datetime]	Filter results where unblocked_at is between two comma separated values	[optional]
worker	str		[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

PaginatedTaskResponseList

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]

list_roles

ObjectRolesResponse list_roles(task_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

List roles

List roles assigned to this object.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.object_roles_response import ObjectRolesResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.TasksApi(api_client)
    task_href = 'task_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:
        # List roles
        api_response = api_instance.list_roles(task_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of TasksApi->list_roles:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TasksApi->list_roles: %s\n" % e)

Parameters

Name	Type	Description	Notes
task_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

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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]

my_permissions

MyPermissionsResponse my_permissions(task_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

List user permissions

List permissions available to the current user on this object.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.my_permissions_response import MyPermissionsResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.TasksApi(api_client)
    task_href = 'task_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:
        # List user permissions
        api_response = api_instance.my_permissions(task_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of TasksApi->my_permissions:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TasksApi->my_permissions: %s\n" % e)

Parameters

Name	Type	Description	Notes
task_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

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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]

profile_artifacts

ProfileArtifactResponse profile_artifacts(task_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

Fetch downloadable links for profile artifacts

Return pre-signed URLs used for downloading raw profile artifacts.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.profile_artifact_response import ProfileArtifactResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.TasksApi(api_client)
    task_href = 'task_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:
        # Fetch downloadable links for profile artifacts
        api_response = api_instance.profile_artifacts(task_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of TasksApi->profile_artifacts:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TasksApi->profile_artifacts: %s\n" % e)

Parameters

Name	Type	Description	Notes
task_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

ProfileArtifactResponse

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]

purge

AsyncOperationResponse purge(pulp_domain, purge, x_task_diagnostics=x_task_diagnostics)

Purge Completed Tasks

Trigger an asynchronous task that deletes completed tasks that finished prior to a specified timestamp.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.async_operation_response import AsyncOperationResponse
from pulpcore.client.pulpcore.models.purge import Purge
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.TasksApi(api_client)
    pulp_domain = 'pulp_domain_example' # str | 
    purge = pulpcore.client.pulpcore.Purge() # Purge | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Purge Completed Tasks
        api_response = api_instance.purge(pulp_domain, purge, x_task_diagnostics=x_task_diagnostics)
        print("The response of TasksApi->purge:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TasksApi->purge: %s\n" % e)

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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]

read

TaskResponse read(task_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

Inspect a task

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.task_response import TaskResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.TasksApi(api_client)
    task_href = 'task_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 task
        api_response = api_instance.read(task_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of TasksApi->read:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TasksApi->read: %s\n" % e)

Parameters

Name	Type	Description	Notes
task_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

TaskResponse

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]

remove_role

NestedRoleResponse remove_role(task_href, nested_role, x_task_diagnostics=x_task_diagnostics)

Remove a role

Remove a role for this object from users/groups.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.nested_role import NestedRole
from pulpcore.client.pulpcore.models.nested_role_response import NestedRoleResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.TasksApi(api_client)
    task_href = 'task_href_example' # str | 
    nested_role = pulpcore.client.pulpcore.NestedRole() # NestedRole | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Remove a role
        api_response = api_instance.remove_role(task_href, nested_role, x_task_diagnostics=x_task_diagnostics)
        print("The response of TasksApi->remove_role:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TasksApi->remove_role: %s\n" % e)

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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]

tasks_cancel

TaskResponse tasks_cancel(task_href, patched_task_cancel, x_task_diagnostics=x_task_diagnostics)

Cancel a task

This operation cancels a task.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.patched_task_cancel import PatchedTaskCancel
from pulpcore.client.pulpcore.models.task_response import TaskResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.TasksApi(api_client)
    task_href = 'task_href_example' # str | 
    patched_task_cancel = pulpcore.client.pulpcore.PatchedTaskCancel() # PatchedTaskCancel | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Cancel a task
        api_response = api_instance.tasks_cancel(task_href, patched_task_cancel, x_task_diagnostics=x_task_diagnostics)
        print("The response of TasksApi->tasks_cancel:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TasksApi->tasks_cancel: %s\n" % e)

Parameters

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

Return type

TaskResponse

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		-
409		-

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

TaskScheduleResponse

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]
name	str	The name of the task schedule.
task_name	str	The name of the task to be scheduled.
dispatch_interval	str	Periodicity of the schedule.
next_dispatch	datetime	Timestamp of the next time the task will be dispatched.	[optional] [readonly]
last_task	str	The last task dispatched by this schedule.	[optional] [readonly]

Example

from pulpcore.client.pulpcore.models.task_schedule_response import TaskScheduleResponse

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

# convert the object into a dict
task_schedule_response_dict = task_schedule_response_instance.to_dict()
# create an instance of TaskScheduleResponse from a dict
task_schedule_response_from_dict = TaskScheduleResponse.from_dict(task_schedule_response_dict)

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

pulpcore.client.pulpcore.TaskSchedulesApi

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

Method	HTTP request	Description
add_role	POST {task_schedule_href}add_role/	Add a role
list	GET /api/pulp/{pulp_domain}/api/v3/task-schedules/	List task schedules
list_roles	GET {task_schedule_href}list_roles/	List roles
my_permissions	GET {task_schedule_href}my_permissions/	List user permissions
read	GET {task_schedule_href}	Inspect a task schedule
remove_role	POST {task_schedule_href}remove_role/	Remove a role

add_role

NestedRoleResponse add_role(task_schedule_href, nested_role, x_task_diagnostics=x_task_diagnostics)

Add a role

Add a role for this object to users/groups.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.nested_role import NestedRole
from pulpcore.client.pulpcore.models.nested_role_response import NestedRoleResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.TaskSchedulesApi(api_client)
    task_schedule_href = 'task_schedule_href_example' # str | 
    nested_role = pulpcore.client.pulpcore.NestedRole() # NestedRole | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Add a role
        api_response = api_instance.add_role(task_schedule_href, nested_role, x_task_diagnostics=x_task_diagnostics)
        print("The response of TaskSchedulesApi->add_role:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TaskSchedulesApi->add_role: %s\n" % e)

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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

PaginatedTaskScheduleResponseList list(pulp_domain, x_task_diagnostics=x_task_diagnostics, limit=limit, name=name, name__contains=name__contains, offset=offset, ordering=ordering, prn__in=prn__in, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, q=q, task_name=task_name, task_name__contains=task_name__contains, fields=fields, exclude_fields=exclude_fields)

List task schedules

ViewSet to monitor task schedules.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.paginated_task_schedule_response_list import PaginatedTaskScheduleResponseList
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.TaskSchedulesApi(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)
    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) * `name` - Name * `-name` - Name (descending) * `next_dispatch` - Next dispatch * `-next_dispatch` - Next dispatch (descending) * `dispatch_interval` - Dispatch interval * `-dispatch_interval` - Dispatch interval (descending) * `task_name` - Task name * `-task_name` - Task name (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)
    q = 'q_example' # str | Filter results by using NOT, AND and OR operations on other filters (optional)
    task_name = 'task_name_example' # str | Filter results where task_name matches value (optional)
    task_name__contains = 'task_name__contains_example' # str | Filter results where task_name contains 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 task schedules
        api_response = api_instance.list(pulp_domain, x_task_diagnostics=x_task_diagnostics, limit=limit, name=name, name__contains=name__contains, offset=offset, ordering=ordering, prn__in=prn__in, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, q=q, task_name=task_name, task_name__contains=task_name__contains, fields=fields, exclude_fields=exclude_fields)
        print("The response of TaskSchedulesApi->list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TaskSchedulesApi->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]
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) * `name` - Name * `-name` - Name (descending) * `next_dispatch` - Next dispatch * `-next_dispatch` - Next dispatch (descending) * `dispatch_interval` - Dispatch interval * `-dispatch_interval` - Dispatch interval (descending) * `task_name` - Task name * `-task_name` - Task name (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]
q	str	Filter results by using NOT, AND and OR operations on other filters	[optional]
task_name	str	Filter results where task_name matches value	[optional]
task_name__contains	str	Filter results where task_name contains 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

PaginatedTaskScheduleResponseList

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]

list_roles

ObjectRolesResponse list_roles(task_schedule_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

List roles

List roles assigned to this object.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.object_roles_response import ObjectRolesResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.TaskSchedulesApi(api_client)
    task_schedule_href = 'task_schedule_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:
        # List roles
        api_response = api_instance.list_roles(task_schedule_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of TaskSchedulesApi->list_roles:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TaskSchedulesApi->list_roles: %s\n" % e)

Parameters

Name	Type	Description	Notes
task_schedule_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

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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]

my_permissions

MyPermissionsResponse my_permissions(task_schedule_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

List user permissions

List permissions available to the current user on this object.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.my_permissions_response import MyPermissionsResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.TaskSchedulesApi(api_client)
    task_schedule_href = 'task_schedule_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:
        # List user permissions
        api_response = api_instance.my_permissions(task_schedule_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of TaskSchedulesApi->my_permissions:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TaskSchedulesApi->my_permissions: %s\n" % e)

Parameters

Name	Type	Description	Notes
task_schedule_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

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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

TaskScheduleResponse read(task_schedule_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

Inspect a task schedule

ViewSet to monitor task schedules.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.task_schedule_response import TaskScheduleResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.TaskSchedulesApi(api_client)
    task_schedule_href = 'task_schedule_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 task schedule
        api_response = api_instance.read(task_schedule_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of TaskSchedulesApi->read:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TaskSchedulesApi->read: %s\n" % e)

Parameters

Name	Type	Description	Notes
task_schedule_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

TaskScheduleResponse

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]

remove_role

NestedRoleResponse remove_role(task_schedule_href, nested_role, x_task_diagnostics=x_task_diagnostics)

Remove a role

Remove a role for this object from users/groups.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.nested_role import NestedRole
from pulpcore.client.pulpcore.models.nested_role_response import NestedRoleResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.TaskSchedulesApi(api_client)
    task_schedule_href = 'task_schedule_href_example' # str | 
    nested_role = pulpcore.client.pulpcore.NestedRole() # NestedRole | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Remove a role
        api_response = api_instance.remove_role(task_schedule_href, nested_role, x_task_diagnostics=x_task_diagnostics)
        print("The response of TaskSchedulesApi->remove_role:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TaskSchedulesApi->remove_role: %s\n" % e)

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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]

UnsetLabel

Serializer for synchronously UNsetting a label.

Properties

Name	Type	Description	Notes
key	str

Example

from pulpcore.client.pulpcore.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.pulpcore.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]

UploadChunkResponse

A mixin for validating unknown serializers' fields.

Properties

Name	Type	Description	Notes
offset	int		[optional] [readonly]
size	int		[optional] [readonly]

Example

from pulpcore.client.pulpcore.models.upload_chunk_response import UploadChunkResponse

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

# convert the object into a dict
upload_chunk_response_dict = upload_chunk_response_instance.to_dict()
# create an instance of UploadChunkResponse from a dict
upload_chunk_response_from_dict = UploadChunkResponse.from_dict(upload_chunk_response_dict)

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

UploadCommit

A mixin for validating unknown serializers' fields.

Properties

Name	Type	Description	Notes
sha256	str	The expected sha256 checksum for the file.

Example

from pulpcore.client.pulpcore.models.upload_commit import UploadCommit

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

# convert the object into a dict
upload_commit_dict = upload_commit_instance.to_dict()
# create an instance of UploadCommit from a dict
upload_commit_from_dict = UploadCommit.from_dict(upload_commit_dict)

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

UploadDetailResponse

Serializer for chunked uploads.

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]
size	int	The size of the upload in bytes.
completed	datetime	Timestamp when upload is committed.	[optional] [readonly]
chunks	List[UploadChunkResponse]		[optional] [readonly]

Example

from pulpcore.client.pulpcore.models.upload_detail_response import UploadDetailResponse

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

# convert the object into a dict
upload_detail_response_dict = upload_detail_response_instance.to_dict()
# create an instance of UploadDetailResponse from a dict
upload_detail_response_from_dict = UploadDetailResponse.from_dict(upload_detail_response_dict)

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

Upload

Serializer for chunked uploads.

Properties

Name	Type	Description	Notes
size	int	The size of the upload in bytes.

Example

from pulpcore.client.pulpcore.models.upload import Upload

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

# convert the object into a dict
upload_dict = upload_instance.to_dict()
# create an instance of Upload from a dict
upload_from_dict = Upload.from_dict(upload_dict)

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

UploadResponse

Serializer for chunked uploads.

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]
size	int	The size of the upload in bytes.
completed	datetime	Timestamp when upload is committed.	[optional] [readonly]

Example

from pulpcore.client.pulpcore.models.upload_response import UploadResponse

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

# convert the object into a dict
upload_response_dict = upload_response_instance.to_dict()
# create an instance of UploadResponse from a dict
upload_response_from_dict = UploadResponse.from_dict(upload_response_dict)

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

pulpcore.client.pulpcore.UploadsApi

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

Method	HTTP request	Description
add_role	POST {upload_href}add_role/	Add a role
commit	POST {upload_href}commit/	Finish an Upload
create	POST /api/pulp/{pulp_domain}/api/v3/uploads/	Create an upload
delete	DELETE {upload_href}	Delete an upload
list	GET /api/pulp/{pulp_domain}/api/v3/uploads/	List uploads
list_roles	GET {upload_href}list_roles/	List roles
my_permissions	GET {upload_href}my_permissions/	List user permissions
read	GET {upload_href}	Inspect an upload
remove_role	POST {upload_href}remove_role/	Remove a role
update	PUT {upload_href}	Upload a file chunk

add_role

NestedRoleResponse add_role(upload_href, upload, x_task_diagnostics=x_task_diagnostics)

Add a role

Add a role for this object to users/groups.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.nested_role_response import NestedRoleResponse
from pulpcore.client.pulpcore.models.upload import Upload
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.UploadsApi(api_client)
    upload_href = 'upload_href_example' # str | 
    upload = pulpcore.client.pulpcore.Upload() # Upload | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Add a role
        api_response = api_instance.add_role(upload_href, upload, x_task_diagnostics=x_task_diagnostics)
        print("The response of UploadsApi->add_role:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UploadsApi->add_role: %s\n" % e)

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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]

commit

AsyncOperationResponse commit(upload_href, upload_commit, x_task_diagnostics=x_task_diagnostics)

Finish an Upload

Queues a Task that creates an Artifact, and the Upload gets deleted and cannot be re-used.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.async_operation_response import AsyncOperationResponse
from pulpcore.client.pulpcore.models.upload_commit import UploadCommit
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.UploadsApi(api_client)
    upload_href = 'upload_href_example' # str | 
    upload_commit = pulpcore.client.pulpcore.UploadCommit() # UploadCommit | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Finish an Upload
        api_response = api_instance.commit(upload_href, upload_commit, x_task_diagnostics=x_task_diagnostics)
        print("The response of UploadsApi->commit:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UploadsApi->commit: %s\n" % e)

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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

UploadResponse create(pulp_domain, upload, x_task_diagnostics=x_task_diagnostics)

Create an upload

View for chunked uploads.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.upload import Upload
from pulpcore.client.pulpcore.models.upload_response import UploadResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.UploadsApi(api_client)
    pulp_domain = 'pulp_domain_example' # str | 
    upload = pulpcore.client.pulpcore.Upload() # Upload | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

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

Parameters

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

Return type

UploadResponse

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

delete(upload_href, x_task_diagnostics=x_task_diagnostics)

Delete an upload

View for chunked uploads.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

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

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.UploadsApi(api_client)
    upload_href = 'upload_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Delete an upload
        api_instance.delete(upload_href, x_task_diagnostics=x_task_diagnostics)
    except Exception as e:
        print("Exception when calling UploadsApi->delete: %s\n" % e)

Parameters

Name	Type	Description	Notes
upload_href	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
204	No response body	-

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

list

PaginatedUploadResponseList list(pulp_domain, x_task_diagnostics=x_task_diagnostics, limit=limit, offset=offset, ordering=ordering, prn__in=prn__in, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, q=q, size=size, size__gt=size__gt, size__lt=size__lt, size__range=size__range, fields=fields, exclude_fields=exclude_fields)

List uploads

View for chunked uploads.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.paginated_upload_response_list import PaginatedUploadResponseList
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.UploadsApi(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)
    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) * `size` - Size * `-size` - Size (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)
    q = 'q_example' # str | Filter results by using NOT, AND and OR operations on other filters (optional)
    size = 56 # int | Filter results where size matches value (optional)
    size__gt = 56 # int | Filter results where size is greater than value (optional)
    size__lt = 56 # int | Filter results where size is less than value (optional)
    size__range = [56] # List[int] | Filter results where size is between two comma separated values (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 uploads
        api_response = api_instance.list(pulp_domain, x_task_diagnostics=x_task_diagnostics, limit=limit, offset=offset, ordering=ordering, prn__in=prn__in, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, q=q, size=size, size__gt=size__gt, size__lt=size__lt, size__range=size__range, fields=fields, exclude_fields=exclude_fields)
        print("The response of UploadsApi->list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UploadsApi->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]
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) * `size` - Size * `-size` - Size (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]
q	str	Filter results by using NOT, AND and OR operations on other filters	[optional]
size	int	Filter results where size matches value	[optional]
size__gt	int	Filter results where size is greater than value	[optional]
size__lt	int	Filter results where size is less than value	[optional]
size__range	List[int]	Filter results where size is between two comma separated values	[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

PaginatedUploadResponseList

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]

list_roles

ObjectRolesResponse list_roles(upload_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

List roles

List roles assigned to this object.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.object_roles_response import ObjectRolesResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.UploadsApi(api_client)
    upload_href = 'upload_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:
        # List roles
        api_response = api_instance.list_roles(upload_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of UploadsApi->list_roles:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UploadsApi->list_roles: %s\n" % e)

Parameters

Name	Type	Description	Notes
upload_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

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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]

my_permissions

MyPermissionsResponse my_permissions(upload_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

List user permissions

List permissions available to the current user on this object.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.my_permissions_response import MyPermissionsResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.UploadsApi(api_client)
    upload_href = 'upload_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:
        # List user permissions
        api_response = api_instance.my_permissions(upload_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of UploadsApi->my_permissions:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UploadsApi->my_permissions: %s\n" % e)

Parameters

Name	Type	Description	Notes
upload_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

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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

UploadDetailResponse read(upload_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

Inspect an upload

View for chunked uploads.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.upload_detail_response import UploadDetailResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.UploadsApi(api_client)
    upload_href = 'upload_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 an upload
        api_response = api_instance.read(upload_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of UploadsApi->read:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UploadsApi->read: %s\n" % e)

Parameters

Name	Type	Description	Notes
upload_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

UploadDetailResponse

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]

remove_role

NestedRoleResponse remove_role(upload_href, upload, x_task_diagnostics=x_task_diagnostics)

Remove a role

Remove a role for this object from users/groups.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.nested_role_response import NestedRoleResponse
from pulpcore.client.pulpcore.models.upload import Upload
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.UploadsApi(api_client)
    upload_href = 'upload_href_example' # str | 
    upload = pulpcore.client.pulpcore.Upload() # Upload | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Remove a role
        api_response = api_instance.remove_role(upload_href, upload, x_task_diagnostics=x_task_diagnostics)
        print("The response of UploadsApi->remove_role:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UploadsApi->remove_role: %s\n" % e)

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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

UploadResponse update(content_range, upload_href, file, x_task_diagnostics=x_task_diagnostics, sha256=sha256)

Upload a file chunk

Upload a chunk for an upload.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.upload_response import UploadResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.UploadsApi(api_client)
    content_range = 'content_range_example' # str | The Content-Range header specifies the location of the file chunk within the file.
    upload_href = 'upload_href_example' # str | 
    file = None # bytearray | A chunk of the uploaded file.
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    sha256 = 'sha256_example' # str | The SHA-256 checksum of the chunk if available. (optional)

    try:
        # Upload a file chunk
        api_response = api_instance.update(content_range, upload_href, file, x_task_diagnostics=x_task_diagnostics, sha256=sha256)
        print("The response of UploadsApi->update:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UploadsApi->update: %s\n" % e)

Parameters

Name	Type	Description	Notes
content_range	str	The Content-Range header specifies the location of the file chunk within the file.
upload_href	str
file	bytearray	A chunk of the uploaded file.
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]
sha256	str	The SHA-256 checksum of the chunk if available.	[optional]

Return type

UploadResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

Content-Type: multipart/form-data, application/x-www-form-urlencoded
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]

UpstreamPulp

Serializer for a Server.

Properties

Name	Type	Description	Notes
name	str	A unique name for this Pulp server.
base_url	str	The transport, hostname, and an optional port of the Pulp server. e.g. https://example.com
api_root	str	The API root. Defaults to '/pulp/'.
domain	str	The domain of the Pulp server if enabled.	[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]
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]
q_select	str	Filter distributions on the upstream Pulp using complex filtering. E.g. pulp_label_select="foo" OR pulp_label_select="key=val"	[optional]
policy	Policy357Enum	Policy for how replicate will manage the local objects within the domain. * `all` - Replicate manages ALL local objects within the domain. * `labeled` - Replicate will only manage the objects created from a previous replication, unlabled local objects will be untouched. * `nodelete` - Replicate will not delete any local object whether they were created by replication or not.	[optional]

Example

from pulpcore.client.pulpcore.models.upstream_pulp import UpstreamPulp

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

# convert the object into a dict
upstream_pulp_dict = upstream_pulp_instance.to_dict()
# create an instance of UpstreamPulp from a dict
upstream_pulp_from_dict = UpstreamPulp.from_dict(upstream_pulp_dict)

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

UpstreamPulpResponse

Serializer for a Server.

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 Pulp server.
base_url	str	The transport, hostname, and an optional port of the Pulp server. e.g. https://example.com
api_root	str	The API root. Defaults to '/pulp/'.
domain	str	The domain of the Pulp server if enabled.	[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]
tls_validation	bool	If True, TLS peer validation must be performed.	[optional]
hidden_fields	List[GenericRemoteResponseHiddenFieldsInner]	List of hidden (write only) fields	[optional] [readonly]
q_select	str	Filter distributions on the upstream Pulp using complex filtering. E.g. pulp_label_select="foo" OR pulp_label_select="key=val"	[optional]
last_replication	datetime	Timestamp of the last replication that occurred. Equals to 'null' if no replication task has been executed.	[optional] [readonly]
policy	Policy357Enum	Policy for how replicate will manage the local objects within the domain. * `all` - Replicate manages ALL local objects within the domain. * `labeled` - Replicate will only manage the objects created from a previous replication, unlabled local objects will be untouched. * `nodelete` - Replicate will not delete any local object whether they were created by replication or not.	[optional]

Example

from pulpcore.client.pulpcore.models.upstream_pulp_response import UpstreamPulpResponse

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

# convert the object into a dict
upstream_pulp_response_dict = upstream_pulp_response_instance.to_dict()
# create an instance of UpstreamPulpResponse from a dict
upstream_pulp_response_from_dict = UpstreamPulpResponse.from_dict(upstream_pulp_response_dict)

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

pulpcore.client.pulpcore.UpstreamPulpsApi

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

Method	HTTP request	Description
add_role	POST {upstream_pulp_href}add_role/	Add a role
create	POST /api/pulp/{pulp_domain}/api/v3/upstream-pulps/	Create an upstream pulp
delete	DELETE {upstream_pulp_href}	Delete an upstream pulp
list	GET /api/pulp/{pulp_domain}/api/v3/upstream-pulps/	List upstream pulps
list_roles	GET {upstream_pulp_href}list_roles/	List roles
my_permissions	GET {upstream_pulp_href}my_permissions/	List user permissions
partial_update	PATCH {upstream_pulp_href}	Update an upstream pulp
read	GET {upstream_pulp_href}	Inspect an upstream pulp
remove_role	POST {upstream_pulp_href}remove_role/	Remove a role
replicate	POST {upstream_pulp_href}replicate/	Replicate
update	PUT {upstream_pulp_href}	Update an upstream pulp

add_role

NestedRoleResponse add_role(upstream_pulp_href, nested_role, x_task_diagnostics=x_task_diagnostics)

Add a role

Add a role for this object to users/groups.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.nested_role import NestedRole
from pulpcore.client.pulpcore.models.nested_role_response import NestedRoleResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.UpstreamPulpsApi(api_client)
    upstream_pulp_href = 'upstream_pulp_href_example' # str | 
    nested_role = pulpcore.client.pulpcore.NestedRole() # NestedRole | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Add a role
        api_response = api_instance.add_role(upstream_pulp_href, nested_role, x_task_diagnostics=x_task_diagnostics)
        print("The response of UpstreamPulpsApi->add_role:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UpstreamPulpsApi->add_role: %s\n" % e)

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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]

create

UpstreamPulpResponse create(pulp_domain, upstream_pulp, x_task_diagnostics=x_task_diagnostics)

Create an upstream pulp

API for configuring an upstream Pulp to replicate. This API is provided as a tech preview.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.upstream_pulp import UpstreamPulp
from pulpcore.client.pulpcore.models.upstream_pulp_response import UpstreamPulpResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.UpstreamPulpsApi(api_client)
    pulp_domain = 'pulp_domain_example' # str | 
    upstream_pulp = pulpcore.client.pulpcore.UpstreamPulp() # UpstreamPulp | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Create an upstream pulp
        api_response = api_instance.create(pulp_domain, upstream_pulp, x_task_diagnostics=x_task_diagnostics)
        print("The response of UpstreamPulpsApi->create:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UpstreamPulpsApi->create: %s\n" % e)

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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

delete(upstream_pulp_href, x_task_diagnostics=x_task_diagnostics)

Delete an upstream pulp

API for configuring an upstream Pulp to replicate. This API is provided as a tech preview.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

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

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.UpstreamPulpsApi(api_client)
    upstream_pulp_href = 'upstream_pulp_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Delete an upstream pulp
        api_instance.delete(upstream_pulp_href, x_task_diagnostics=x_task_diagnostics)
    except Exception as e:
        print("Exception when calling UpstreamPulpsApi->delete: %s\n" % e)

Parameters

Name	Type	Description	Notes
upstream_pulp_href	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
204	No response body	-

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

list

PaginatedUpstreamPulpResponseList list(pulp_domain, x_task_diagnostics=x_task_diagnostics, base_url=base_url, base_url__contains=base_url__contains, base_url__icontains=base_url__icontains, base_url__iexact=base_url__iexact, base_url__in=base_url__in, base_url__iregex=base_url__iregex, base_url__istartswith=base_url__istartswith, base_url__regex=base_url__regex, base_url__startswith=base_url__startswith, last_replication=last_replication, last_replication__gt=last_replication__gt, last_replication__gte=last_replication__gte, last_replication__isnull=last_replication__isnull, last_replication__lt=last_replication__lt, last_replication__lte=last_replication__lte, last_replication__range=last_replication__range, 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, q=q, fields=fields, exclude_fields=exclude_fields)

List upstream pulps

API for configuring an upstream Pulp to replicate. This API is provided as a tech preview.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.paginated_upstream_pulp_response_list import PaginatedUpstreamPulpResponseList
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.UpstreamPulpsApi(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_url = 'base_url_example' # str | Filter results where base_url matches value (optional)
    base_url__contains = 'base_url__contains_example' # str | Filter results where base_url contains value (optional)
    base_url__icontains = 'base_url__icontains_example' # str | Filter results where base_url contains value (optional)
    base_url__iexact = 'base_url__iexact_example' # str | Filter results where base_url matches value (optional)
    base_url__in = ['base_url__in_example'] # List[str] | Filter results where base_url is in a comma-separated list of values (optional)
    base_url__iregex = 'base_url__iregex_example' # str | Filter results where base_url matches regex value (optional)
    base_url__istartswith = 'base_url__istartswith_example' # str | Filter results where base_url starts with value (optional)
    base_url__regex = 'base_url__regex_example' # str | Filter results where base_url matches regex value (optional)
    base_url__startswith = 'base_url__startswith_example' # str | Filter results where base_url starts with value (optional)
    last_replication = '2013-10-20T19:20:30+01:00' # datetime | Filter results where last_replication matches value (optional)
    last_replication__gt = '2013-10-20T19:20:30+01:00' # datetime | Filter results where last_replication is greater than value (optional)
    last_replication__gte = '2013-10-20T19:20:30+01:00' # datetime | Filter results where last_replication is greater than or equal to value (optional)
    last_replication__isnull = True # bool | Filter results where last_replication has a null value (optional)
    last_replication__lt = '2013-10-20T19:20:30+01:00' # datetime | Filter results where last_replication is less than value (optional)
    last_replication__lte = '2013-10-20T19:20:30+01:00' # datetime | Filter results where last_replication is less than or equal to value (optional)
    last_replication__range = ['2013-10-20T19:20:30+01:00'] # List[datetime] | Filter results where last_replication is between two comma separated values (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) * `name` - Name * `-name` - Name (descending) * `base_url` - Base url * `-base_url` - Base url (descending) * `api_root` - Api root * `-api_root` - Api root (descending) * `domain` - Domain * `-domain` - Domain (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) * `q_select` - Q select * `-q_select` - Q select (descending) * `policy` - Policy * `-policy` - Policy (descending) * `last_replication` - Last replication * `-last_replication` - Last replication (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)
    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 upstream pulps
        api_response = api_instance.list(pulp_domain, x_task_diagnostics=x_task_diagnostics, base_url=base_url, base_url__contains=base_url__contains, base_url__icontains=base_url__icontains, base_url__iexact=base_url__iexact, base_url__in=base_url__in, base_url__iregex=base_url__iregex, base_url__istartswith=base_url__istartswith, base_url__regex=base_url__regex, base_url__startswith=base_url__startswith, last_replication=last_replication, last_replication__gt=last_replication__gt, last_replication__gte=last_replication__gte, last_replication__isnull=last_replication__isnull, last_replication__lt=last_replication__lt, last_replication__lte=last_replication__lte, last_replication__range=last_replication__range, 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, q=q, fields=fields, exclude_fields=exclude_fields)
        print("The response of UpstreamPulpsApi->list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UpstreamPulpsApi->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_url	str	Filter results where base_url matches value	[optional]
base_url__contains	str	Filter results where base_url contains value	[optional]
base_url__icontains	str	Filter results where base_url contains value	[optional]
base_url__iexact	str	Filter results where base_url matches value	[optional]
base_url__in	List[str]	Filter results where base_url is in a comma-separated list of values	[optional]
base_url__iregex	str	Filter results where base_url matches regex value	[optional]
base_url__istartswith	str	Filter results where base_url starts with value	[optional]
base_url__regex	str	Filter results where base_url matches regex value	[optional]
base_url__startswith	str	Filter results where base_url starts with value	[optional]
last_replication	datetime	Filter results where last_replication matches value	[optional]
last_replication__gt	datetime	Filter results where last_replication is greater than value	[optional]
last_replication__gte	datetime	Filter results where last_replication is greater than or equal to value	[optional]
last_replication__isnull	bool	Filter results where last_replication has a null value	[optional]
last_replication__lt	datetime	Filter results where last_replication is less than value	[optional]
last_replication__lte	datetime	Filter results where last_replication is less than or equal to value	[optional]
last_replication__range	List[datetime]	Filter results where last_replication is between two comma separated values	[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) * `name` - Name * `-name` - Name (descending) * `base_url` - Base url * `-base_url` - Base url (descending) * `api_root` - Api root * `-api_root` - Api root (descending) * `domain` - Domain * `-domain` - Domain (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) * `q_select` - Q select * `-q_select` - Q select (descending) * `policy` - Policy * `-policy` - Policy (descending) * `last_replication` - Last replication * `-last_replication` - Last replication (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]
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

PaginatedUpstreamPulpResponseList

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]

list_roles

ObjectRolesResponse list_roles(upstream_pulp_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

List roles

List roles assigned to this object.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.object_roles_response import ObjectRolesResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.UpstreamPulpsApi(api_client)
    upstream_pulp_href = 'upstream_pulp_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:
        # List roles
        api_response = api_instance.list_roles(upstream_pulp_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of UpstreamPulpsApi->list_roles:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UpstreamPulpsApi->list_roles: %s\n" % e)

Parameters

Name	Type	Description	Notes
upstream_pulp_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

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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]

my_permissions

MyPermissionsResponse my_permissions(upstream_pulp_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

List user permissions

List permissions available to the current user on this object.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.my_permissions_response import MyPermissionsResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.UpstreamPulpsApi(api_client)
    upstream_pulp_href = 'upstream_pulp_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:
        # List user permissions
        api_response = api_instance.my_permissions(upstream_pulp_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of UpstreamPulpsApi->my_permissions:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UpstreamPulpsApi->my_permissions: %s\n" % e)

Parameters

Name	Type	Description	Notes
upstream_pulp_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

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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

UpstreamPulpResponse partial_update(upstream_pulp_href, patched_upstream_pulp, x_task_diagnostics=x_task_diagnostics)

Update an upstream pulp

API for configuring an upstream Pulp to replicate. This API is provided as a tech preview.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.patched_upstream_pulp import PatchedUpstreamPulp
from pulpcore.client.pulpcore.models.upstream_pulp_response import UpstreamPulpResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.UpstreamPulpsApi(api_client)
    upstream_pulp_href = 'upstream_pulp_href_example' # str | 
    patched_upstream_pulp = pulpcore.client.pulpcore.PatchedUpstreamPulp() # PatchedUpstreamPulp | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Update an upstream pulp
        api_response = api_instance.partial_update(upstream_pulp_href, patched_upstream_pulp, x_task_diagnostics=x_task_diagnostics)
        print("The response of UpstreamPulpsApi->partial_update:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UpstreamPulpsApi->partial_update: %s\n" % e)

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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]

read

UpstreamPulpResponse read(upstream_pulp_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

Inspect an upstream pulp

API for configuring an upstream Pulp to replicate. This API is provided as a tech preview.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.upstream_pulp_response import UpstreamPulpResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.UpstreamPulpsApi(api_client)
    upstream_pulp_href = 'upstream_pulp_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 an upstream pulp
        api_response = api_instance.read(upstream_pulp_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of UpstreamPulpsApi->read:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UpstreamPulpsApi->read: %s\n" % e)

Parameters

Name	Type	Description	Notes
upstream_pulp_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

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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]

remove_role

NestedRoleResponse remove_role(upstream_pulp_href, nested_role, x_task_diagnostics=x_task_diagnostics)

Remove a role

Remove a role for this object from users/groups.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.nested_role import NestedRole
from pulpcore.client.pulpcore.models.nested_role_response import NestedRoleResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.UpstreamPulpsApi(api_client)
    upstream_pulp_href = 'upstream_pulp_href_example' # str | 
    nested_role = pulpcore.client.pulpcore.NestedRole() # NestedRole | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Remove a role
        api_response = api_instance.remove_role(upstream_pulp_href, nested_role, x_task_diagnostics=x_task_diagnostics)
        print("The response of UpstreamPulpsApi->remove_role:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UpstreamPulpsApi->remove_role: %s\n" % e)

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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]

replicate

TaskGroupOperationResponse replicate(upstream_pulp_href, x_task_diagnostics=x_task_diagnostics)

Replicate

Trigger an asynchronous repository replication task group. This API is provided as a tech preview.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.task_group_operation_response import TaskGroupOperationResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.UpstreamPulpsApi(api_client)
    upstream_pulp_href = 'upstream_pulp_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Replicate
        api_response = api_instance.replicate(upstream_pulp_href, x_task_diagnostics=x_task_diagnostics)
        print("The response of UpstreamPulpsApi->replicate:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UpstreamPulpsApi->replicate: %s\n" % e)

Parameters

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

Return type

TaskGroupOperationResponse

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]

update

UpstreamPulpResponse update(upstream_pulp_href, upstream_pulp, x_task_diagnostics=x_task_diagnostics)

Update an upstream pulp

API for configuring an upstream Pulp to replicate. This API is provided as a tech preview.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.upstream_pulp import UpstreamPulp
from pulpcore.client.pulpcore.models.upstream_pulp_response import UpstreamPulpResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.UpstreamPulpsApi(api_client)
    upstream_pulp_href = 'upstream_pulp_href_example' # str | 
    upstream_pulp = pulpcore.client.pulpcore.UpstreamPulp() # UpstreamPulp | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Update an upstream pulp
        api_response = api_instance.update(upstream_pulp_href, upstream_pulp, x_task_diagnostics=x_task_diagnostics)
        print("The response of UpstreamPulpsApi->update:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UpstreamPulpsApi->update: %s\n" % e)

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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]

UserGroup

Serializer for Groups that belong to an User.

Properties

Name	Type	Description	Notes
name	str	Name.

Example

from pulpcore.client.pulpcore.models.user_group import UserGroup

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

# convert the object into a dict
user_group_dict = user_group_instance.to_dict()
# create an instance of UserGroup from a dict
user_group_from_dict = UserGroup.from_dict(user_group_dict)

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

UserGroupResponse

Serializer for Groups that belong to an User.

Properties

Name	Type	Description	Notes
name	str	Name.
pulp_href	str		[optional] [readonly]
prn	str		[optional] [readonly]

Example

from pulpcore.client.pulpcore.models.user_group_response import UserGroupResponse

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

# convert the object into a dict
user_group_response_dict = user_group_response_instance.to_dict()
# create an instance of UserGroupResponse from a dict
user_group_response_from_dict = UserGroupResponse.from_dict(user_group_response_dict)

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

User

Serializer for User.

Properties

Name	Type	Description	Notes
username	str	Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
password	str	Users password. Set to ``null`` to disable password authentication.	[optional]
first_name	str	First name	[optional]
last_name	str	Last name	[optional]
email	str	Email address	[optional]
is_staff	bool	Designates whether the user can log into this admin site.	[optional] [default to False]
is_active	bool	Designates whether this user should be treated as active.	[optional] [default to True]

Example

from pulpcore.client.pulpcore.models.user import User

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

# convert the object into a dict
user_dict = user_instance.to_dict()
# create an instance of User from a dict
user_from_dict = User.from_dict(user_dict)

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

UserResponse

Serializer for User.

Properties

Name	Type	Description	Notes
pulp_href	str		[optional] [readonly]
prn	str		[optional] [readonly]
id	int		[optional] [readonly]
username	str	Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
first_name	str	First name	[optional]
last_name	str	Last name	[optional]
email	str	Email address	[optional]
is_staff	bool	Designates whether the user can log into this admin site.	[optional] [default to False]
is_active	bool	Designates whether this user should be treated as active.	[optional] [default to True]
date_joined	datetime	Date joined	[optional] [readonly]
groups	List[UserGroupResponse]		[optional] [readonly]
hidden_fields	List[GenericRemoteResponseHiddenFieldsInner]	List of hidden (write only) fields	[optional] [readonly]

Example

from pulpcore.client.pulpcore.models.user_response import UserResponse

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

# convert the object into a dict
user_response_dict = user_response_instance.to_dict()
# create an instance of UserResponse from a dict
user_response_from_dict = UserResponse.from_dict(user_response_dict)

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

UserRole

Serializer for UserRole.

Properties

Name	Type	Description	Notes
role	str
content_object	str	pulp_href of the object for which role permissions should be asserted. If set to 'null', permissions will act on either domain or model-level.	[optional]
content_object_prn	str	prn of the object for which role permissions should be asserted. If set to 'null', permissions will act on either domain or model-level.	[optional]
domain	str	Domain this role should be applied on, mutually exclusive with content_object.	[optional]

Example

from pulpcore.client.pulpcore.models.user_role import UserRole

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

# convert the object into a dict
user_role_dict = user_role_instance.to_dict()
# create an instance of UserRole from a dict
user_role_from_dict = UserRole.from_dict(user_role_dict)

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

UserRoleResponse

Serializer for UserRole.

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]
role	str
content_object	str	pulp_href of the object for which role permissions should be asserted. If set to 'null', permissions will act on either domain or model-level.	[optional]
content_object_prn	str	prn of the object for which role permissions should be asserted. If set to 'null', permissions will act on either domain or model-level.	[optional]
description	str		[optional] [readonly]
permissions	List[str]		[optional] [readonly]
domain	str	Domain this role should be applied on, mutually exclusive with content_object.	[optional]

Example

from pulpcore.client.pulpcore.models.user_role_response import UserRoleResponse

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

# convert the object into a dict
user_role_response_dict = user_role_response_instance.to_dict()
# create an instance of UserRoleResponse from a dict
user_role_response_from_dict = UserRoleResponse.from_dict(user_role_response_dict)

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

pulpcore.client.pulpcore.UsersApi

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

Method	HTTP request	Description
create	POST /api/pulp/{pulp_domain}/api/v3/users/	Create an user
delete	DELETE {auth_user_href}	Delete an user
list	GET /api/pulp/{pulp_domain}/api/v3/users/	List users
partial_update	PATCH {auth_user_href}	Update an user
read	GET {auth_user_href}	Inspect an user
update	PUT {auth_user_href}	Update an user

create

UserResponse create(pulp_domain, user, x_task_diagnostics=x_task_diagnostics)

Create an user

ViewSet for User.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.user import User
from pulpcore.client.pulpcore.models.user_response import UserResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.UsersApi(api_client)
    pulp_domain = 'pulp_domain_example' # str | 
    user = pulpcore.client.pulpcore.User() # User | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

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

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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

delete(auth_user_href, x_task_diagnostics=x_task_diagnostics)

Delete an user

ViewSet for User.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

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

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.UsersApi(api_client)
    auth_user_href = 'auth_user_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Delete an user
        api_instance.delete(auth_user_href, x_task_diagnostics=x_task_diagnostics)
    except Exception as e:
        print("Exception when calling UsersApi->delete: %s\n" % e)

Parameters

Name	Type	Description	Notes
auth_user_href	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
204	No response body	-

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

list

PaginatedUserResponseList list(pulp_domain, x_task_diagnostics=x_task_diagnostics, email=email, email__contains=email__contains, email__icontains=email__icontains, email__iexact=email__iexact, email__in=email__in, first_name=first_name, first_name__contains=first_name__contains, first_name__icontains=first_name__icontains, first_name__iexact=first_name__iexact, first_name__in=first_name__in, is_active=is_active, is_staff=is_staff, last_name=last_name, last_name__contains=last_name__contains, last_name__icontains=last_name__icontains, last_name__iexact=last_name__iexact, last_name__in=last_name__in, limit=limit, offset=offset, ordering=ordering, prn__in=prn__in, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, q=q, username=username, username__contains=username__contains, username__icontains=username__icontains, username__iexact=username__iexact, username__in=username__in, fields=fields, exclude_fields=exclude_fields)

List users

ViewSet for User.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.paginated_user_response_list import PaginatedUserResponseList
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.UsersApi(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)
    email = 'email_example' # str | Filter results where email matches value (optional)
    email__contains = 'email__contains_example' # str | Filter results where email contains value (optional)
    email__icontains = 'email__icontains_example' # str | Filter results where email contains value (optional)
    email__iexact = 'email__iexact_example' # str | Filter results where email matches value (optional)
    email__in = ['email__in_example'] # List[str] | Filter results where email is in a comma-separated list of values (optional)
    first_name = 'first_name_example' # str | Filter results where first_name matches value (optional)
    first_name__contains = 'first_name__contains_example' # str | Filter results where first_name contains value (optional)
    first_name__icontains = 'first_name__icontains_example' # str | Filter results where first_name contains value (optional)
    first_name__iexact = 'first_name__iexact_example' # str | Filter results where first_name matches value (optional)
    first_name__in = ['first_name__in_example'] # List[str] | Filter results where first_name is in a comma-separated list of values (optional)
    is_active = True # bool | Filter results where is_active matches value (optional)
    is_staff = True # bool | Filter results where is_staff matches value (optional)
    last_name = 'last_name_example' # str | Filter results where last_name matches value (optional)
    last_name__contains = 'last_name__contains_example' # str | Filter results where last_name contains value (optional)
    last_name__icontains = 'last_name__icontains_example' # str | Filter results where last_name contains value (optional)
    last_name__iexact = 'last_name__iexact_example' # str | Filter results where last_name matches value (optional)
    last_name__in = ['last_name__in_example'] # List[str] | Filter results where last_name is in a comma-separated list of values (optional)
    limit = 56 # int | Number of results to return per page. (optional)
    offset = 56 # int | The initial index from which to return the results. (optional)
    ordering = ['ordering_example'] # List[str] | Ordering  * `id` - Id * `-id` - Id (descending) * `password` - Password * `-password` - Password (descending) * `last_login` - Last login * `-last_login` - Last login (descending) * `is_superuser` - Is superuser * `-is_superuser` - Is superuser (descending) * `username` - Username * `-username` - Username (descending) * `first_name` - First name * `-first_name` - First name (descending) * `last_name` - Last name * `-last_name` - Last name (descending) * `email` - Email * `-email` - Email (descending) * `is_staff` - Is staff * `-is_staff` - Is staff (descending) * `is_active` - Is active * `-is_active` - Is active (descending) * `date_joined` - Date joined * `-date_joined` - Date joined (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)
    q = 'q_example' # str | Filter results by using NOT, AND and OR operations on other filters (optional)
    username = 'username_example' # str | Filter results where username matches value (optional)
    username__contains = 'username__contains_example' # str | Filter results where username contains value (optional)
    username__icontains = 'username__icontains_example' # str | Filter results where username contains value (optional)
    username__iexact = 'username__iexact_example' # str | Filter results where username matches value (optional)
    username__in = ['username__in_example'] # List[str] | Filter results where username is in a comma-separated list of values (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 users
        api_response = api_instance.list(pulp_domain, x_task_diagnostics=x_task_diagnostics, email=email, email__contains=email__contains, email__icontains=email__icontains, email__iexact=email__iexact, email__in=email__in, first_name=first_name, first_name__contains=first_name__contains, first_name__icontains=first_name__icontains, first_name__iexact=first_name__iexact, first_name__in=first_name__in, is_active=is_active, is_staff=is_staff, last_name=last_name, last_name__contains=last_name__contains, last_name__icontains=last_name__icontains, last_name__iexact=last_name__iexact, last_name__in=last_name__in, limit=limit, offset=offset, ordering=ordering, prn__in=prn__in, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, q=q, username=username, username__contains=username__contains, username__icontains=username__icontains, username__iexact=username__iexact, username__in=username__in, fields=fields, exclude_fields=exclude_fields)
        print("The response of UsersApi->list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UsersApi->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]
email	str	Filter results where email matches value	[optional]
email__contains	str	Filter results where email contains value	[optional]
email__icontains	str	Filter results where email contains value	[optional]
email__iexact	str	Filter results where email matches value	[optional]
email__in	List[str]	Filter results where email is in a comma-separated list of values	[optional]
first_name	str	Filter results where first_name matches value	[optional]
first_name__contains	str	Filter results where first_name contains value	[optional]
first_name__icontains	str	Filter results where first_name contains value	[optional]
first_name__iexact	str	Filter results where first_name matches value	[optional]
first_name__in	List[str]	Filter results where first_name is in a comma-separated list of values	[optional]
is_active	bool	Filter results where is_active matches value	[optional]
is_staff	bool	Filter results where is_staff matches value	[optional]
last_name	str	Filter results where last_name matches value	[optional]
last_name__contains	str	Filter results where last_name contains value	[optional]
last_name__icontains	str	Filter results where last_name contains value	[optional]
last_name__iexact	str	Filter results where last_name matches value	[optional]
last_name__in	List[str]	Filter results where last_name is in a comma-separated list of values	[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 * `id` - Id * `-id` - Id (descending) * `password` - Password * `-password` - Password (descending) * `last_login` - Last login * `-last_login` - Last login (descending) * `is_superuser` - Is superuser * `-is_superuser` - Is superuser (descending) * `username` - Username * `-username` - Username (descending) * `first_name` - First name * `-first_name` - First name (descending) * `last_name` - Last name * `-last_name` - Last name (descending) * `email` - Email * `-email` - Email (descending) * `is_staff` - Is staff * `-is_staff` - Is staff (descending) * `is_active` - Is active * `-is_active` - Is active (descending) * `date_joined` - Date joined * `-date_joined` - Date joined (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]
q	str	Filter results by using NOT, AND and OR operations on other filters	[optional]
username	str	Filter results where username matches value	[optional]
username__contains	str	Filter results where username contains value	[optional]
username__icontains	str	Filter results where username contains value	[optional]
username__iexact	str	Filter results where username matches value	[optional]
username__in	List[str]	Filter results where username is in a comma-separated list of values	[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

PaginatedUserResponseList

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

UserResponse partial_update(auth_user_href, patched_user, x_task_diagnostics=x_task_diagnostics)

Update an user

ViewSet for User.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.patched_user import PatchedUser
from pulpcore.client.pulpcore.models.user_response import UserResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.UsersApi(api_client)
    auth_user_href = 'auth_user_href_example' # str | 
    patched_user = pulpcore.client.pulpcore.PatchedUser() # PatchedUser | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Update an user
        api_response = api_instance.partial_update(auth_user_href, patched_user, x_task_diagnostics=x_task_diagnostics)
        print("The response of UsersApi->partial_update:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UsersApi->partial_update: %s\n" % e)

Parameters

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

Return type

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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]

read

UserResponse read(auth_user_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

Inspect an user

ViewSet for User.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.user_response import UserResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.UsersApi(api_client)
    auth_user_href = 'auth_user_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 an user
        api_response = api_instance.read(auth_user_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of UsersApi->read:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UsersApi->read: %s\n" % e)

Parameters

Name	Type	Description	Notes
auth_user_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

json_header_remote_authentication, basicAuth, cookieAuth

Authorization

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]

update

UserResponse update(auth_user_href, user, x_task_diagnostics=x_task_diagnostics)

Update an user

ViewSet for User.

Example

OAuth Authentication (json_header_remote_authentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):

import pulpcore.client.pulpcore
from pulpcore.client.pulpcore.models.user import User
from pulpcore.client.pulpcore.models.user_response import UserResponse
from pulpcore.client.pulpcore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-pxpumb.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulpcore.Configuration(
    host = "https://env-ephemeral-pxpumb.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.pulpcore.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.pulpcore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulpcore.UsersApi(api_client)
    auth_user_href = 'auth_user_href_example' # str | 
    user = pulpcore.client.pulpcore.User() # User | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Update an user
        api_response = api_instance.update(auth_user_href, user, x_task_diagnostics=x_task_diagnostics)
        print("The response of UsersApi->update:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UsersApi->update: %s\n" % e)

Parameters

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

Return type