crc-pulp-gem-client 20260114.6

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

PaginatedgemGemContentResponseList list(pulp_domain, x_task_diagnostics=x_task_diagnostics, checksum=checksum, limit=limit, name=name, offset=offset, ordering=ordering, orphaned_for=orphaned_for, prerelease=prerelease, prn__in=prn__in, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, pulp_label_select=pulp_label_select, q=q, repository_version=repository_version, repository_version_added=repository_version_added, repository_version_removed=repository_version_removed, version=version, fields=fields, exclude_fields=exclude_fields)

List gem contents

A ViewSet for GemContent.

Example

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

import pulpcore.client.pulp_gem
from pulpcore.client.pulp_gem.models.paginatedgem_gem_content_response_list import PaginatedgemGemContentResponseList
from pulpcore.client.pulp_gem.rest import ApiException
from pprint import pprint

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

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_gem.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with pulpcore.client.pulp_gem.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_gem.ContentGemApi(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)
    checksum = 'checksum_example' # str | Filter results where checksum 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)
    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) * `name` - Name * `-name` - Name (descending) * `version` - Version * `-version` - Version (descending) * `platform` - Platform * `-platform` - Platform (descending) * `checksum` - Checksum * `-checksum` - Checksum (descending) * `prerelease` - Prerelease * `-prerelease` - Prerelease (descending) * `dependencies` - Dependencies * `-dependencies` - Dependencies (descending) * `required_ruby_version` - Required ruby version * `-required_ruby_version` - Required ruby version (descending) * `required_rubygems_version` - Required rubygems version * `-required_rubygems_version` - Required rubygems version (descending) * `pk` - Pk * `-pk` - Pk (descending) (optional)
    orphaned_for = 3.4 # float | Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME. (optional)
    prerelease = True # bool | Filter results where prerelease matches value (optional)
    prn__in = ['prn__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
    pulp_href__in = ['pulp_href__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
    pulp_id__in = ['pulp_id__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
    pulp_label_select = 'pulp_label_select_example' # str | Filter labels by search string (optional)
    q = 'q_example' # str | Filter results by using NOT, AND and OR operations on other filters (optional)
    repository_version = 'repository_version_example' # str | Repository Version referenced by HREF/PRN (optional)
    repository_version_added = 'repository_version_added_example' # str | Repository Version referenced by HREF/PRN (optional)
    repository_version_removed = 'repository_version_removed_example' # str | Repository Version referenced by HREF/PRN (optional)
    version = 'version_example' # str | Filter results where version matches value (optional)
    fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
    exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)

    try:
        # List gem contents
        api_response = api_instance.list(pulp_domain, x_task_diagnostics=x_task_diagnostics, checksum=checksum, limit=limit, name=name, offset=offset, ordering=ordering, orphaned_for=orphaned_for, prerelease=prerelease, prn__in=prn__in, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, pulp_label_select=pulp_label_select, q=q, repository_version=repository_version, repository_version_added=repository_version_added, repository_version_removed=repository_version_removed, version=version, fields=fields, exclude_fields=exclude_fields)
        print("The response of ContentGemApi->list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentGemApi->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]
checksum	str	Filter results where checksum matches value	[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) * `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) * `name` - Name * `-name` - Name (descending) * `version` - Version * `-version` - Version (descending) * `platform` - Platform * `-platform` - Platform (descending) * `checksum` - Checksum * `-checksum` - Checksum (descending) * `prerelease` - Prerelease * `-prerelease` - Prerelease (descending) * `dependencies` - Dependencies * `-dependencies` - Dependencies (descending) * `required_ruby_version` - Required ruby version * `-required_ruby_version` - Required ruby version (descending) * `required_rubygems_version` - Required rubygems version * `-required_rubygems_version` - Required rubygems version (descending) * `pk` - Pk * `-pk` - Pk (descending)	[optional]
orphaned_for	float	Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME.	[optional]
prerelease	bool	Filter results where prerelease matches value	[optional]
prn__in	List[str]	Multiple values may be separated by commas.	[optional]
pulp_href__in	List[str]	Multiple values may be separated by commas.	[optional]
pulp_id__in	List[str]	Multiple values may be separated by commas.	[optional]
pulp_label_select	str	Filter labels by search string	[optional]
q	str	Filter results by using NOT, AND and OR operations on other filters	[optional]
repository_version	str	Repository Version referenced by HREF/PRN	[optional]
repository_version_added	str	Repository Version referenced by HREF/PRN	[optional]
repository_version_removed	str	Repository Version referenced by HREF/PRN	[optional]
version	str	Filter results where version matches value	[optional]
fields	List[str]	A list of fields to include in the response.	[optional]
exclude_fields	List[str]	A list of fields to exclude from the response.	[optional]

Return type

PaginatedgemGemContentResponseList

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

GemGemContentResponse read(gem_gem_content_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

Inspect a gem content

A ViewSet for GemContent.

Example

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

import pulpcore.client.pulp_gem
from pulpcore.client.pulp_gem.models.gem_gem_content_response import GemGemContentResponse
from pulpcore.client.pulp_gem.rest import ApiException
from pprint import pprint

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

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_gem.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with pulpcore.client.pulp_gem.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_gem.ContentGemApi(api_client)
    gem_gem_content_href = 'gem_gem_content_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 gem content
        api_response = api_instance.read(gem_gem_content_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of ContentGemApi->read:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentGemApi->read: %s\n" % e)

Parameters

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

GemGemContentResponse

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

Set a label

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

Example

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

import pulpcore.client.pulp_gem
from pulpcore.client.pulp_gem.models.set_label import SetLabel
from pulpcore.client.pulp_gem.models.set_label_response import SetLabelResponse
from pulpcore.client.pulp_gem.rest import ApiException
from pprint import pprint

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

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_gem.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with pulpcore.client.pulp_gem.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_gem.ContentGemApi(api_client)
    gem_gem_content_href = 'gem_gem_content_href_example' # str | 
    set_label = pulpcore.client.pulp_gem.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(gem_gem_content_href, set_label, x_task_diagnostics=x_task_diagnostics)
        print("The response of ContentGemApi->set_label:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentGemApi->set_label: %s\n" % e)

Parameters

Name	Type	Description	Notes
gem_gem_content_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(gem_gem_content_href, unset_label, x_task_diagnostics=x_task_diagnostics)

Unset a label

Unset a single pulp_label on the object.

Example

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

import pulpcore.client.pulp_gem
from pulpcore.client.pulp_gem.models.unset_label import UnsetLabel
from pulpcore.client.pulp_gem.models.unset_label_response import UnsetLabelResponse
from pulpcore.client.pulp_gem.rest import ApiException
from pprint import pprint

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

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_gem.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with pulpcore.client.pulp_gem.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_gem.ContentGemApi(api_client)
    gem_gem_content_href = 'gem_gem_content_href_example' # str | 
    unset_label = pulpcore.client.pulp_gem.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(gem_gem_content_href, unset_label, x_task_diagnostics=x_task_diagnostics)
        print("The response of ContentGemApi->unset_label:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentGemApi->unset_label: %s\n" % e)

Parameters

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

ContentSummaryResponse

Serializer for the RepositoryVersion content summary

Properties

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

Example

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

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

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

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

pulpcore.client.pulp_gem.DistributionsGemApi

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

Method	HTTP request	Description
add_role	POST {gem_gem_distribution_href}add_role/	Add a role
create	POST /api/pulp/{pulp_domain}/api/v3/distributions/gem/gem/	Create a gem distribution
delete	DELETE {gem_gem_distribution_href}	Delete a gem distribution
list	GET /api/pulp/{pulp_domain}/api/v3/distributions/gem/gem/	List gem distributions
list_roles	GET {gem_gem_distribution_href}list_roles/	List roles
my_permissions	GET {gem_gem_distribution_href}my_permissions/	List user permissions
partial_update	PATCH {gem_gem_distribution_href}	Update a gem distribution
read	GET {gem_gem_distribution_href}	Inspect a gem distribution
remove_role	POST {gem_gem_distribution_href}remove_role/	Remove a role
set_label	POST {gem_gem_distribution_href}set_label/	Set a label
unset_label	POST {gem_gem_distribution_href}unset_label/	Unset a label
update	PUT {gem_gem_distribution_href}	Update a gem distribution

add_role

NestedRoleResponse add_role(gem_gem_distribution_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.pulp_gem
from pulpcore.client.pulp_gem.models.nested_role import NestedRole
from pulpcore.client.pulp_gem.models.nested_role_response import NestedRoleResponse
from pulpcore.client.pulp_gem.rest import ApiException
from pprint import pprint

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

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_gem.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with pulpcore.client.pulp_gem.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_gem.DistributionsGemApi(api_client)
    gem_gem_distribution_href = 'gem_gem_distribution_href_example' # str | 
    nested_role = pulpcore.client.pulp_gem.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(gem_gem_distribution_href, nested_role, x_task_diagnostics=x_task_diagnostics)
        print("The response of DistributionsGemApi->add_role:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DistributionsGemApi->add_role: %s\n" % e)

Parameters

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

AsyncOperationResponse create(pulp_domain, gem_gem_distribution, x_task_diagnostics=x_task_diagnostics)

Create a gem distribution

Trigger an asynchronous create task

Example

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

import pulpcore.client.pulp_gem
from pulpcore.client.pulp_gem.models.async_operation_response import AsyncOperationResponse
from pulpcore.client.pulp_gem.models.gem_gem_distribution import GemGemDistribution
from pulpcore.client.pulp_gem.rest import ApiException
from pprint import pprint

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

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_gem.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with pulpcore.client.pulp_gem.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_gem.DistributionsGemApi(api_client)
    pulp_domain = 'pulp_domain_example' # str | 
    gem_gem_distribution = pulpcore.client.pulp_gem.GemGemDistribution() # GemGemDistribution | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

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

Parameters

Name	Type	Description	Notes
pulp_domain	str
gem_gem_distribution	GemGemDistribution
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(gem_gem_distribution_href, x_task_diagnostics=x_task_diagnostics)

Delete a gem distribution

Trigger an asynchronous delete task

Example

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

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

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

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_gem.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with pulpcore.client.pulp_gem.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_gem.DistributionsGemApi(api_client)
    gem_gem_distribution_href = 'gem_gem_distribution_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

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

Parameters

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

PaginatedgemGemDistributionResponseList 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 gem distributions

ViewSet for GemDistributions.

Example

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

import pulpcore.client.pulp_gem
from pulpcore.client.pulp_gem.models.paginatedgem_gem_distribution_response_list import PaginatedgemGemDistributionResponseList
from pulpcore.client.pulp_gem.rest import ApiException
from pprint import pprint

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

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_gem.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with pulpcore.client.pulp_gem.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_gem.DistributionsGemApi(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 gem 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 DistributionsGemApi->list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DistributionsGemApi->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

PaginatedgemGemDistributionResponseList

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(gem_gem_distribution_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.pulp_gem
from pulpcore.client.pulp_gem.models.object_roles_response import ObjectRolesResponse
from pulpcore.client.pulp_gem.rest import ApiException
from pprint import pprint

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

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_gem.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with pulpcore.client.pulp_gem.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_gem.DistributionsGemApi(api_client)
    gem_gem_distribution_href = 'gem_gem_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:
        # List roles
        api_response = api_instance.list_roles(gem_gem_distribution_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of DistributionsGemApi->list_roles:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DistributionsGemApi->list_roles: %s\n" % e)

Parameters

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

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(gem_gem_distribution_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.pulp_gem
from pulpcore.client.pulp_gem.models.my_permissions_response import MyPermissionsResponse
from pulpcore.client.pulp_gem.rest import ApiException
from pprint import pprint

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

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_gem.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with pulpcore.client.pulp_gem.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_gem.DistributionsGemApi(api_client)
    gem_gem_distribution_href = 'gem_gem_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:
        # List user permissions
        api_response = api_instance.my_permissions(gem_gem_distribution_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of DistributionsGemApi->my_permissions:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DistributionsGemApi->my_permissions: %s\n" % e)

Parameters

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

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

GemGemDistributionResponse partial_update(gem_gem_distribution_href, patchedgem_gem_distribution, x_task_diagnostics=x_task_diagnostics)

Update a gem distribution

Update the entity partially and trigger an asynchronous task if necessary

Example

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

import pulpcore.client.pulp_gem
from pulpcore.client.pulp_gem.models.gem_gem_distribution_response import GemGemDistributionResponse
from pulpcore.client.pulp_gem.models.patchedgem_gem_distribution import PatchedgemGemDistribution
from pulpcore.client.pulp_gem.rest import ApiException
from pprint import pprint

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

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_gem.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with pulpcore.client.pulp_gem.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_gem.DistributionsGemApi(api_client)
    gem_gem_distribution_href = 'gem_gem_distribution_href_example' # str | 
    patchedgem_gem_distribution = pulpcore.client.pulp_gem.PatchedgemGemDistribution() # PatchedgemGemDistribution | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

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

Parameters

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

Return type

GemGemDistributionResponse

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

GemGemDistributionResponse read(gem_gem_distribution_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

Inspect a gem distribution

ViewSet for GemDistributions.

Example

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

import pulpcore.client.pulp_gem
from pulpcore.client.pulp_gem.models.gem_gem_distribution_response import GemGemDistributionResponse
from pulpcore.client.pulp_gem.rest import ApiException
from pprint import pprint

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

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_gem.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with pulpcore.client.pulp_gem.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_gem.DistributionsGemApi(api_client)
    gem_gem_distribution_href = 'gem_gem_distribution_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
    exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)

    try:
        # Inspect a gem distribution
        api_response = api_instance.read(gem_gem_distribution_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of DistributionsGemApi->read:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DistributionsGemApi->read: %s\n" % e)

Parameters

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

GemGemDistributionResponse

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(gem_gem_distribution_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.pulp_gem
from pulpcore.client.pulp_gem.models.nested_role import NestedRole
from pulpcore.client.pulp_gem.models.nested_role_response import NestedRoleResponse
from pulpcore.client.pulp_gem.rest import ApiException
from pprint import pprint

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

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_gem.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with pulpcore.client.pulp_gem.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_gem.DistributionsGemApi(api_client)
    gem_gem_distribution_href = 'gem_gem_distribution_href_example' # str | 
    nested_role = pulpcore.client.pulp_gem.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(gem_gem_distribution_href, nested_role, x_task_diagnostics=x_task_diagnostics)
        print("The response of DistributionsGemApi->remove_role:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DistributionsGemApi->remove_role: %s\n" % e)

Parameters

Name	Type	Description	Notes
gem_gem_distribution_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(gem_gem_distribution_href, set_label, x_task_diagnostics=x_task_diagnostics)

Set a label

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

Example

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

import pulpcore.client.pulp_gem
from pulpcore.client.pulp_gem.models.set_label import SetLabel
from pulpcore.client.pulp_gem.models.set_label_response import SetLabelResponse
from pulpcore.client.pulp_gem.rest import ApiException
from pprint import pprint

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

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_gem.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with pulpcore.client.pulp_gem.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_gem.DistributionsGemApi(api_client)
    gem_gem_distribution_href = 'gem_gem_distribution_href_example' # str | 
    set_label = pulpcore.client.pulp_gem.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(gem_gem_distribution_href, set_label, x_task_diagnostics=x_task_diagnostics)
        print("The response of DistributionsGemApi->set_label:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DistributionsGemApi->set_label: %s\n" % e)

Parameters

Name	Type	Description	Notes
gem_gem_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(gem_gem_distribution_href, unset_label, x_task_diagnostics=x_task_diagnostics)

Unset a label

Unset a single pulp_label on the object.

Example

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

import pulpcore.client.pulp_gem
from pulpcore.client.pulp_gem.models.unset_label import UnsetLabel
from pulpcore.client.pulp_gem.models.unset_label_response import UnsetLabelResponse
from pulpcore.client.pulp_gem.rest import ApiException
from pprint import pprint

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

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_gem.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with pulpcore.client.pulp_gem.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_gem.DistributionsGemApi(api_client)
    gem_gem_distribution_href = 'gem_gem_distribution_href_example' # str | 
    unset_label = pulpcore.client.pulp_gem.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(gem_gem_distribution_href, unset_label, x_task_diagnostics=x_task_diagnostics)
        print("The response of DistributionsGemApi->unset_label:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DistributionsGemApi->unset_label: %s\n" % e)

Parameters

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

GemGemDistributionResponse update(gem_gem_distribution_href, gem_gem_distribution, x_task_diagnostics=x_task_diagnostics)

Update a gem distribution

Update the entity and trigger an asynchronous task if necessary

Example

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

import pulpcore.client.pulp_gem
from pulpcore.client.pulp_gem.models.gem_gem_distribution import GemGemDistribution
from pulpcore.client.pulp_gem.models.gem_gem_distribution_response import GemGemDistributionResponse
from pulpcore.client.pulp_gem.rest import ApiException
from pprint import pprint

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

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_gem.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with pulpcore.client.pulp_gem.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_gem.DistributionsGemApi(api_client)
    gem_gem_distribution_href = 'gem_gem_distribution_href_example' # str | 
    gem_gem_distribution = pulpcore.client.pulp_gem.GemGemDistribution() # GemGemDistribution | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

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

Parameters

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

Return type

GemGemDistributionResponse

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]

GemGemContentResponse

A Serializer for GemContent.

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/'	[readonly]
checksum	str	SHA256 checksum of the gem	[optional] [readonly]
name	str	Name of the gem	[optional] [readonly]
version	str	Version of the gem	[optional] [readonly]
platform	str	Platform of the gem	[optional] [readonly]
prerelease	bool	Whether the gem is a prerelease	[optional] [readonly]
dependencies	Dict[str, Optional[str]]		[optional] [readonly]
required_ruby_version	str	Required ruby version of the gem	[optional] [readonly]
required_rubygems_version	str	Required rubygems version of the gem	[optional] [readonly]

Example

from pulpcore.client.pulp_gem.models.gem_gem_content_response import GemGemContentResponse

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

# convert the object into a dict
gem_gem_content_response_dict = gem_gem_content_response_instance.to_dict()
# create an instance of GemGemContentResponse from a dict
gem_gem_content_response_from_dict = GemGemContentResponse.from_dict(gem_gem_content_response_dict)

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

GemGemDistribution

A Serializer for GemDistribution.

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]
publication	str	Publication to be served	[optional]
remote	str	Remote that can be used to fetch content when using pull-through caching.	[optional]

Example

from pulpcore.client.pulp_gem.models.gem_gem_distribution import GemGemDistribution

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

# convert the object into a dict
gem_gem_distribution_dict = gem_gem_distribution_instance.to_dict()
# create an instance of GemGemDistribution from a dict
gem_gem_distribution_from_dict = GemGemDistribution.from_dict(gem_gem_distribution_dict)

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

GemGemDistributionResponse

A Serializer for GemDistribution.

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]
publication	str	Publication to be served	[optional]
remote	str	Remote that can be used to fetch content when using pull-through caching.	[optional]

Example

from pulpcore.client.pulp_gem.models.gem_gem_distribution_response import GemGemDistributionResponse

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

# convert the object into a dict
gem_gem_distribution_response_dict = gem_gem_distribution_response_instance.to_dict()
# create an instance of GemGemDistributionResponse from a dict
gem_gem_distribution_response_from_dict = GemGemDistributionResponse.from_dict(gem_gem_distribution_response_dict)

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

GemGemPublication

A Serializer for GemPublication.

Properties

Name	Type	Description	Notes
repository_version	str		[optional]
repository	str	A URI of the repository to be published.	[optional]

Example

from pulpcore.client.pulp_gem.models.gem_gem_publication import GemGemPublication

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

# convert the object into a dict
gem_gem_publication_dict = gem_gem_publication_instance.to_dict()
# create an instance of GemGemPublication from a dict
gem_gem_publication_from_dict = GemGemPublication.from_dict(gem_gem_publication_dict)

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

GemGemPublicationResponse

A Serializer for GemPublication.

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.pulp_gem.models.gem_gem_publication_response import GemGemPublicationResponse

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

# convert the object into a dict
gem_gem_publication_response_dict = gem_gem_publication_response_instance.to_dict()
# create an instance of GemGemPublicationResponse from a dict
gem_gem_publication_response_from_dict = GemGemPublicationResponse.from_dict(gem_gem_publication_response_dict)

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

GemGemRemote

A Serializer for GemRemote.

Properties

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

Example

from pulpcore.client.pulp_gem.models.gem_gem_remote import GemGemRemote

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

# convert the object into a dict
gem_gem_remote_dict = gem_gem_remote_instance.to_dict()
# create an instance of GemGemRemote from a dict
gem_gem_remote_from_dict = GemGemRemote.from_dict(gem_gem_remote_dict)

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

GemGemRemoteResponseHiddenFieldsInner

Properties

Name	Type	Description	Notes
name	str
is_set	bool

Example

from pulpcore.client.pulp_gem.models.gem_gem_remote_response_hidden_fields_inner import GemGemRemoteResponseHiddenFieldsInner

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

# convert the object into a dict
gem_gem_remote_response_hidden_fields_inner_dict = gem_gem_remote_response_hidden_fields_inner_instance.to_dict()
# create an instance of GemGemRemoteResponseHiddenFieldsInner from a dict
gem_gem_remote_response_hidden_fields_inner_from_dict = GemGemRemoteResponseHiddenFieldsInner.from_dict(gem_gem_remote_response_hidden_fields_inner_dict)

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

GemGemRemoteResponse

A Serializer for GemRemote.

Properties

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

Example

from pulpcore.client.pulp_gem.models.gem_gem_remote_response import GemGemRemoteResponse

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

# convert the object into a dict
gem_gem_remote_response_dict = gem_gem_remote_response_instance.to_dict()
# create an instance of GemGemRemoteResponse from a dict
gem_gem_remote_response_from_dict = GemGemRemoteResponse.from_dict(gem_gem_remote_response_dict)

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

GemGemRepository

A Serializer for GemRepository.

Properties

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

Example

from pulpcore.client.pulp_gem.models.gem_gem_repository import GemGemRepository

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

# convert the object into a dict
gem_gem_repository_dict = gem_gem_repository_instance.to_dict()
# create an instance of GemGemRepository from a dict
gem_gem_repository_from_dict = GemGemRepository.from_dict(gem_gem_repository_dict)

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

GemGemRepositoryResponse

A Serializer for GemRepository.

Properties

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

Example

from pulpcore.client.pulp_gem.models.gem_gem_repository_response import GemGemRepositoryResponse

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

# convert the object into a dict
gem_gem_repository_response_dict = gem_gem_repository_response_instance.to_dict()
# create an instance of GemGemRepositoryResponse from a dict
gem_gem_repository_response_from_dict = GemGemRepositoryResponse.from_dict(gem_gem_repository_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.pulp_gem.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]

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.pulp_gem.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.pulp_gem.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.pulp_gem.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]

PaginatedgemGemContentResponseList

Properties

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

Example

from pulpcore.client.pulp_gem.models.paginatedgem_gem_content_response_list import PaginatedgemGemContentResponseList

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

# convert the object into a dict
paginatedgem_gem_content_response_list_dict = paginatedgem_gem_content_response_list_instance.to_dict()
# create an instance of PaginatedgemGemContentResponseList from a dict
paginatedgem_gem_content_response_list_from_dict = PaginatedgemGemContentResponseList.from_dict(paginatedgem_gem_content_response_list_dict)

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

PaginatedgemGemDistributionResponseList

Properties

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

Example

from pulpcore.client.pulp_gem.models.paginatedgem_gem_distribution_response_list import PaginatedgemGemDistributionResponseList

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

# convert the object into a dict
paginatedgem_gem_distribution_response_list_dict = paginatedgem_gem_distribution_response_list_instance.to_dict()
# create an instance of PaginatedgemGemDistributionResponseList from a dict
paginatedgem_gem_distribution_response_list_from_dict = PaginatedgemGemDistributionResponseList.from_dict(paginatedgem_gem_distribution_response_list_dict)

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

PaginatedgemGemPublicationResponseList

Properties

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

Example

from pulpcore.client.pulp_gem.models.paginatedgem_gem_publication_response_list import PaginatedgemGemPublicationResponseList

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

# convert the object into a dict
paginatedgem_gem_publication_response_list_dict = paginatedgem_gem_publication_response_list_instance.to_dict()
# create an instance of PaginatedgemGemPublicationResponseList from a dict
paginatedgem_gem_publication_response_list_from_dict = PaginatedgemGemPublicationResponseList.from_dict(paginatedgem_gem_publication_response_list_dict)

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

PaginatedgemGemRemoteResponseList

Properties

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

Example

from pulpcore.client.pulp_gem.models.paginatedgem_gem_remote_response_list import PaginatedgemGemRemoteResponseList

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

# convert the object into a dict
paginatedgem_gem_remote_response_list_dict = paginatedgem_gem_remote_response_list_instance.to_dict()
# create an instance of PaginatedgemGemRemoteResponseList from a dict
paginatedgem_gem_remote_response_list_from_dict = PaginatedgemGemRemoteResponseList.from_dict(paginatedgem_gem_remote_response_list_dict)

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

PaginatedgemGemRepositoryResponseList

Properties

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

Example

from pulpcore.client.pulp_gem.models.paginatedgem_gem_repository_response_list import PaginatedgemGemRepositoryResponseList

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

# convert the object into a dict
paginatedgem_gem_repository_response_list_dict = paginatedgem_gem_repository_response_list_instance.to_dict()
# create an instance of PaginatedgemGemRepositoryResponseList from a dict
paginatedgem_gem_repository_response_list_from_dict = PaginatedgemGemRepositoryResponseList.from_dict(paginatedgem_gem_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.pulp_gem.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]

PatchedgemGemDistribution

A Serializer for GemDistribution.

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]
publication	str	Publication to be served	[optional]
remote	str	Remote that can be used to fetch content when using pull-through caching.	[optional]

Example

from pulpcore.client.pulp_gem.models.patchedgem_gem_distribution import PatchedgemGemDistribution

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

# convert the object into a dict
patchedgem_gem_distribution_dict = patchedgem_gem_distribution_instance.to_dict()
# create an instance of PatchedgemGemDistribution from a dict
patchedgem_gem_distribution_from_dict = PatchedgemGemDistribution.from_dict(patchedgem_gem_distribution_dict)

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

PatchedgemGemRemote

A Serializer for GemRemote.

Properties

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

Example

from pulpcore.client.pulp_gem.models.patchedgem_gem_remote import PatchedgemGemRemote

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

# convert the object into a dict
patchedgem_gem_remote_dict = patchedgem_gem_remote_instance.to_dict()
# create an instance of PatchedgemGemRemote from a dict
patchedgem_gem_remote_from_dict = PatchedgemGemRemote.from_dict(patchedgem_gem_remote_dict)

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

PatchedgemGemRepository

A Serializer for GemRepository.

Properties

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

Example

from pulpcore.client.pulp_gem.models.patchedgem_gem_repository import PatchedgemGemRepository

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

# convert the object into a dict
patchedgem_gem_repository_dict = patchedgem_gem_repository_instance.to_dict()
# create an instance of PatchedgemGemRepository from a dict
patchedgem_gem_repository_from_dict = PatchedgemGemRepository.from_dict(patchedgem_gem_repository_dict)

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

PolicyEnum

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]

pulpcore.client.pulp_gem.PublicationsGemApi

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

Method	HTTP request	Description
add_role	POST {gem_gem_publication_href}add_role/	Add a role
create	POST /api/pulp/{pulp_domain}/api/v3/publications/gem/gem/	Create a gem publication
delete	DELETE {gem_gem_publication_href}	Delete a gem publication
list	GET /api/pulp/{pulp_domain}/api/v3/publications/gem/gem/	List gem publications
list_roles	GET {gem_gem_publication_href}list_roles/	List roles
my_permissions	GET {gem_gem_publication_href}my_permissions/	List user permissions
read	GET {gem_gem_publication_href}	Inspect a gem publication
remove_role	POST {gem_gem_publication_href}remove_role/	Remove a role

add_role

NestedRoleResponse add_role(gem_gem_publication_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.pulp_gem
from pulpcore.client.pulp_gem.models.nested_role import NestedRole
from pulpcore.client.pulp_gem.models.nested_role_response import NestedRoleResponse
from pulpcore.client.pulp_gem.rest import ApiException
from pprint import pprint

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

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_gem.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with pulpcore.client.pulp_gem.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_gem.PublicationsGemApi(api_client)
    gem_gem_publication_href = 'gem_gem_publication_href_example' # str | 
    nested_role = pulpcore.client.pulp_gem.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(gem_gem_publication_href, nested_role, x_task_diagnostics=x_task_diagnostics)
        print("The response of PublicationsGemApi->add_role:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicationsGemApi->add_role: %s\n" % e)

Parameters

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

AsyncOperationResponse create(pulp_domain, gem_gem_publication, x_task_diagnostics=x_task_diagnostics)

Create a gem publication

Trigger an asynchronous task to publish gem content

Example

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

import pulpcore.client.pulp_gem
from pulpcore.client.pulp_gem.models.async_operation_response import AsyncOperationResponse
from pulpcore.client.pulp_gem.models.gem_gem_publication import GemGemPublication
from pulpcore.client.pulp_gem.rest import ApiException
from pprint import pprint

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

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_gem.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with pulpcore.client.pulp_gem.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_gem.PublicationsGemApi(api_client)
    pulp_domain = 'pulp_domain_example' # str | 
    gem_gem_publication = pulpcore.client.pulp_gem.GemGemPublication() # GemGemPublication | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

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

Parameters

Name	Type	Description	Notes
pulp_domain	str
gem_gem_publication	GemGemPublication
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(gem_gem_publication_href, x_task_diagnostics=x_task_diagnostics)

Delete a gem publication

A ViewSet for GemPublication.

Example

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

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

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

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_gem.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with pulpcore.client.pulp_gem.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_gem.PublicationsGemApi(api_client)
    gem_gem_publication_href = 'gem_gem_publication_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Delete a gem publication
        api_instance.delete(gem_gem_publication_href, x_task_diagnostics=x_task_diagnostics)
    except Exception as e:
        print("Exception when calling PublicationsGemApi->delete: %s\n" % e)

Parameters

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

PaginatedgemGemPublicationResponseList 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, q=q, repository=repository, repository_version=repository_version, fields=fields, exclude_fields=exclude_fields)

List gem publications

A ViewSet for GemPublication.

Example

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

import pulpcore.client.pulp_gem
from pulpcore.client.pulp_gem.models.paginatedgem_gem_publication_response_list import PaginatedgemGemPublicationResponseList
from pulpcore.client.pulp_gem.rest import ApiException
from pprint import pprint

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

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_gem.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with pulpcore.client.pulp_gem.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_gem.PublicationsGemApi(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)
    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 gem 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, q=q, repository=repository, repository_version=repository_version, fields=fields, exclude_fields=exclude_fields)
        print("The response of PublicationsGemApi->list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicationsGemApi->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]
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

PaginatedgemGemPublicationResponseList

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(gem_gem_publication_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.pulp_gem
from pulpcore.client.pulp_gem.models.object_roles_response import ObjectRolesResponse
from pulpcore.client.pulp_gem.rest import ApiException
from pprint import pprint

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

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_gem.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with pulpcore.client.pulp_gem.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_gem.PublicationsGemApi(api_client)
    gem_gem_publication_href = 'gem_gem_publication_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(gem_gem_publication_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of PublicationsGemApi->list_roles:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicationsGemApi->list_roles: %s\n" % e)

Parameters

Name	Type	Description	Notes
gem_gem_publication_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(gem_gem_publication_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.pulp_gem
from pulpcore.client.pulp_gem.models.my_permissions_response import MyPermissionsResponse
from pulpcore.client.pulp_gem.rest import ApiException
from pprint import pprint

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

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_gem.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with pulpcore.client.pulp_gem.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_gem.PublicationsGemApi(api_client)
    gem_gem_publication_href = 'gem_gem_publication_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(gem_gem_publication_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of PublicationsGemApi->my_permissions:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicationsGemApi->my_permissions: %s\n" % e)

Parameters

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

GemGemPublicationResponse read(gem_gem_publication_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

Inspect a gem publication

A ViewSet for GemPublication.

Example

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

import pulpcore.client.pulp_gem
from pulpcore.client.pulp_gem.models.gem_gem_publication_response import GemGemPublicationResponse
from pulpcore.client.pulp_gem.rest import ApiException
from pprint import pprint

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

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_gem.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with pulpcore.client.pulp_gem.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_gem.PublicationsGemApi(api_client)
    gem_gem_publication_href = 'gem_gem_publication_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 gem publication
        api_response = api_instance.read(gem_gem_publication_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of PublicationsGemApi->read:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicationsGemApi->read: %s\n" % e)

Parameters

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

GemGemPublicationResponse

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(gem_gem_publication_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.pulp_gem
from pulpcore.client.pulp_gem.models.nested_role import NestedRole
from pulpcore.client.pulp_gem.models.nested_role_response import NestedRoleResponse
from pulpcore.client.pulp_gem.rest import ApiException
from pprint import pprint

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

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_gem.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with pulpcore.client.pulp_gem.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_gem.PublicationsGemApi(api_client)
    gem_gem_publication_href = 'gem_gem_publication_href_example' # str | 
    nested_role = pulpcore.client.pulp_gem.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(gem_gem_publication_href, nested_role, x_task_diagnostics=x_task_diagnostics)
        print("The response of PublicationsGemApi->remove_role:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicationsGemApi->remove_role: %s\n" % e)

Parameters

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

pulpcore.client.pulp_gem.RemotesGemApi

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

Method	HTTP request	Description
add_role	POST {gem_gem_remote_href}add_role/	Add a role
create	POST /api/pulp/{pulp_domain}/api/v3/remotes/gem/gem/	Create a gem remote
delete	DELETE {gem_gem_remote_href}	Delete a gem remote
list	GET /api/pulp/{pulp_domain}/api/v3/remotes/gem/gem/	List gem remotes
list_roles	GET {gem_gem_remote_href}list_roles/	List roles
my_permissions	GET {gem_gem_remote_href}my_permissions/	List user permissions
partial_update	PATCH {gem_gem_remote_href}	Update a gem remote
read	GET {gem_gem_remote_href}	Inspect a gem remote
remove_role	POST {gem_gem_remote_href}remove_role/	Remove a role
set_label	POST {gem_gem_remote_href}set_label/	Set a label
unset_label	POST {gem_gem_remote_href}unset_label/	Unset a label
update	PUT {gem_gem_remote_href}	Update a gem remote

add_role

NestedRoleResponse add_role(gem_gem_remote_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.pulp_gem
from pulpcore.client.pulp_gem.models.nested_role import NestedRole
from pulpcore.client.pulp_gem.models.nested_role_response import NestedRoleResponse
from pulpcore.client.pulp_gem.rest import ApiException
from pprint import pprint

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

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_gem.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with pulpcore.client.pulp_gem.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_gem.RemotesGemApi(api_client)
    gem_gem_remote_href = 'gem_gem_remote_href_example' # str | 
    nested_role = pulpcore.client.pulp_gem.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(gem_gem_remote_href, nested_role, x_task_diagnostics=x_task_diagnostics)
        print("The response of RemotesGemApi->add_role:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RemotesGemApi->add_role: %s\n" % e)

Parameters

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

GemGemRemoteResponse create(pulp_domain, gem_gem_remote, x_task_diagnostics=x_task_diagnostics)

Create a gem remote

A ViewSet for GemRemote.

Example

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

import pulpcore.client.pulp_gem
from pulpcore.client.pulp_gem.models.gem_gem_remote import GemGemRemote
from pulpcore.client.pulp_gem.models.gem_gem_remote_response import GemGemRemoteResponse
from pulpcore.client.pulp_gem.rest import ApiException
from pprint import pprint

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

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_gem.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with pulpcore.client.pulp_gem.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_gem.RemotesGemApi(api_client)
    pulp_domain = 'pulp_domain_example' # str | 
    gem_gem_remote = pulpcore.client.pulp_gem.GemGemRemote() # GemGemRemote | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

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

Parameters

Name	Type	Description	Notes
pulp_domain	str
gem_gem_remote	GemGemRemote
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(gem_gem_remote_href, x_task_diagnostics=x_task_diagnostics)

Delete a gem remote

Trigger an asynchronous delete task

Example

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

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

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

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_gem.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with pulpcore.client.pulp_gem.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_gem.RemotesGemApi(api_client)
    gem_gem_remote_href = 'gem_gem_remote_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

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

Parameters

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

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

List gem remotes

A ViewSet for GemRemote.

Example

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

import pulpcore.client.pulp_gem
from pulpcore.client.pulp_gem.models.paginatedgem_gem_remote_response_list import PaginatedgemGemRemoteResponseList
from pulpcore.client.pulp_gem.rest import ApiException
from pprint import pprint

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

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_gem.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with pulpcore.client.pulp_gem.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_gem.RemotesGemApi(api_client)
    pulp_domain = 'pulp_domain_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    limit = 56 # int | Number of results to return per page. (optional)
    name = 'name_example' # str | Filter results where name matches value (optional)
    name__contains = 'name__contains_example' # str | Filter results where name contains value (optional)
    name__icontains = 'name__icontains_example' # str | Filter results where name contains value (optional)
    name__iexact = 'name__iexact_example' # str | Filter results where name matches value (optional)
    name__in = ['name__in_example'] # List[str] | Filter results where name is in a comma-separated list of values (optional)
    name__iregex = 'name__iregex_example' # str | Filter results where name matches regex value (optional)
    name__istartswith = 'name__istartswith_example' # str | Filter results where name starts with value (optional)
    name__regex = 'name__regex_example' # str | Filter results where name matches regex value (optional)
    name__startswith = 'name__startswith_example' # str | Filter results where name starts with value (optional)
    offset = 56 # int | The initial index from which to return the results. (optional)
    ordering = ['ordering_example'] # List[str] | Ordering  * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `name` - Name * `-name` - Name (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `url` - Url * `-url` - Url (descending) * `ca_cert` - Ca cert * `-ca_cert` - Ca cert (descending) * `client_cert` - Client cert * `-client_cert` - Client cert (descending) * `client_key` - Client key * `-client_key` - Client key (descending) * `tls_validation` - Tls validation * `-tls_validation` - Tls validation (descending) * `username` - Username * `-username` - Username (descending) * `password` - Password * `-password` - Password (descending) * `proxy_url` - Proxy url * `-proxy_url` - Proxy url (descending) * `proxy_username` - Proxy username * `-proxy_username` - Proxy username (descending) * `proxy_password` - Proxy password * `-proxy_password` - Proxy password (descending) * `download_concurrency` - Download concurrency * `-download_concurrency` - Download concurrency (descending) * `max_retries` - Max retries * `-max_retries` - Max retries (descending) * `policy` - Policy * `-policy` - Policy (descending) * `total_timeout` - Total timeout * `-total_timeout` - Total timeout (descending) * `connect_timeout` - Connect timeout * `-connect_timeout` - Connect timeout (descending) * `sock_connect_timeout` - Sock connect timeout * `-sock_connect_timeout` - Sock connect timeout (descending) * `sock_read_timeout` - Sock read timeout * `-sock_read_timeout` - Sock read timeout (descending) * `headers` - Headers * `-headers` - Headers (descending) * `rate_limit` - Rate limit * `-rate_limit` - Rate limit (descending) * `pk` - Pk * `-pk` - Pk (descending) (optional)
    prn__in = ['prn__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
    pulp_href__in = ['pulp_href__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
    pulp_id__in = ['pulp_id__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
    pulp_label_select = 'pulp_label_select_example' # str | Filter labels by search string (optional)
    pulp_last_updated = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_last_updated matches value (optional)
    pulp_last_updated__gt = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_last_updated is greater than value (optional)
    pulp_last_updated__gte = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_last_updated is greater than or equal to value (optional)
    pulp_last_updated__isnull = True # bool | Filter results where pulp_last_updated has a null value (optional)
    pulp_last_updated__lt = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_last_updated is less than value (optional)
    pulp_last_updated__lte = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_last_updated is less than or equal to value (optional)
    pulp_last_updated__range = ['2013-10-20T19:20:30+01:00'] # List[datetime] | Filter results where pulp_last_updated is between two comma separated values (optional)
    q = 'q_example' # str | Filter results by using NOT, AND and OR operations on other filters (optional)
    fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
    exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)

    try:
        # List gem remotes
        api_response = api_instance.list(pulp_domain, x_task_diagnostics=x_task_diagnostics, limit=limit, name=name, name__contains=name__contains, name__icontains=name__icontains, name__iexact=name__iexact, name__in=name__in, name__iregex=name__iregex, name__istartswith=name__istartswith, name__regex=name__regex, name__startswith=name__startswith, offset=offset, ordering=ordering, prn__in=prn__in, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, pulp_label_select=pulp_label_select, pulp_last_updated=pulp_last_updated, pulp_last_updated__gt=pulp_last_updated__gt, pulp_last_updated__gte=pulp_last_updated__gte, pulp_last_updated__isnull=pulp_last_updated__isnull, pulp_last_updated__lt=pulp_last_updated__lt, pulp_last_updated__lte=pulp_last_updated__lte, pulp_last_updated__range=pulp_last_updated__range, q=q, fields=fields, exclude_fields=exclude_fields)
        print("The response of RemotesGemApi->list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RemotesGemApi->list: %s\n" % e)

Parameters

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

Return type

PaginatedgemGemRemoteResponseList

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(gem_gem_remote_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.pulp_gem
from pulpcore.client.pulp_gem.models.object_roles_response import ObjectRolesResponse
from pulpcore.client.pulp_gem.rest import ApiException
from pprint import pprint

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

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_gem.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with pulpcore.client.pulp_gem.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_gem.RemotesGemApi(api_client)
    gem_gem_remote_href = 'gem_gem_remote_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
    exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)

    try:
        # List roles
        api_response = api_instance.list_roles(gem_gem_remote_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of RemotesGemApi->list_roles:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RemotesGemApi->list_roles: %s\n" % e)

Parameters

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

Return type

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(gem_gem_remote_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.pulp_gem
from pulpcore.client.pulp_gem.models.my_permissions_response import MyPermissionsResponse
from pulpcore.client.pulp_gem.rest import ApiException
from pprint import pprint

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

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_gem.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with pulpcore.client.pulp_gem.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_gem.RemotesGemApi(api_client)
    gem_gem_remote_href = 'gem_gem_remote_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
    exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)

    try:
        # List user permissions
        api_response = api_instance.my_permissions(gem_gem_remote_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of RemotesGemApi->my_permissions:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RemotesGemApi->my_permissions: %s\n" % e)

Parameters

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

Return type

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

GemGemRemoteResponse partial_update(gem_gem_remote_href, patchedgem_gem_remote, x_task_diagnostics=x_task_diagnostics)

Update a gem remote

Update the entity partially and trigger an asynchronous task if necessary

Example

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

import pulpcore.client.pulp_gem
from pulpcore.client.pulp_gem.models.gem_gem_remote_response import GemGemRemoteResponse
from pulpcore.client.pulp_gem.models.patchedgem_gem_remote import PatchedgemGemRemote
from pulpcore.client.pulp_gem.rest import ApiException
from pprint import pprint

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

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_gem.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with pulpcore.client.pulp_gem.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_gem.RemotesGemApi(api_client)
    gem_gem_remote_href = 'gem_gem_remote_href_example' # str | 
    patchedgem_gem_remote = pulpcore.client.pulp_gem.PatchedgemGemRemote() # PatchedgemGemRemote | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

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

Parameters

Name	Type	Description	Notes
gem_gem_remote_href	str
patchedgem_gem_remote	PatchedgemGemRemote
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

GemGemRemoteResponse read(gem_gem_remote_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

Inspect a gem remote

A ViewSet for GemRemote.

Example

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

import pulpcore.client.pulp_gem
from pulpcore.client.pulp_gem.models.gem_gem_remote_response import GemGemRemoteResponse
from pulpcore.client.pulp_gem.rest import ApiException
from pprint import pprint

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

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_gem.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with pulpcore.client.pulp_gem.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_gem.RemotesGemApi(api_client)
    gem_gem_remote_href = 'gem_gem_remote_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
    exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)

    try:
        # Inspect a gem remote
        api_response = api_instance.read(gem_gem_remote_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of RemotesGemApi->read:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RemotesGemApi->read: %s\n" % e)

Parameters

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

Return type

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(gem_gem_remote_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.pulp_gem
from pulpcore.client.pulp_gem.models.nested_role import NestedRole
from pulpcore.client.pulp_gem.models.nested_role_response import NestedRoleResponse
from pulpcore.client.pulp_gem.rest import ApiException
from pprint import pprint

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

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_gem.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with pulpcore.client.pulp_gem.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_gem.RemotesGemApi(api_client)
    gem_gem_remote_href = 'gem_gem_remote_href_example' # str | 
    nested_role = pulpcore.client.pulp_gem.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(gem_gem_remote_href, nested_role, x_task_diagnostics=x_task_diagnostics)
        print("The response of RemotesGemApi->remove_role:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RemotesGemApi->remove_role: %s\n" % e)

Parameters

Name	Type	Description	Notes
gem_gem_remote_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(gem_gem_remote_href, set_label, x_task_diagnostics=x_task_diagnostics)

Set a label

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

Example

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

import pulpcore.client.pulp_gem
from pulpcore.client.pulp_gem.models.set_label import SetLabel
from pulpcore.client.pulp_gem.models.set_label_response import SetLabelResponse
from pulpcore.client.pulp_gem.rest import ApiException
from pprint import pprint

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

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_gem.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with pulpcore.client.pulp_gem.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_gem.RemotesGemApi(api_client)
    gem_gem_remote_href = 'gem_gem_remote_href_example' # str | 
    set_label = pulpcore.client.pulp_gem.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(gem_gem_remote_href, set_label, x_task_diagnostics=x_task_diagnostics)
        print("The response of RemotesGemApi->set_label:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RemotesGemApi->set_label: %s\n" % e)

Parameters

Name	Type	Description	Notes
gem_gem_remote_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(gem_gem_remote_href, unset_label, x_task_diagnostics=x_task_diagnostics)

Unset a label

Unset a single pulp_label on the object.

Example

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

import pulpcore.client.pulp_gem
from pulpcore.client.pulp_gem.models.unset_label import UnsetLabel
from pulpcore.client.pulp_gem.models.unset_label_response import UnsetLabelResponse
from pulpcore.client.pulp_gem.rest import ApiException
from pprint import pprint

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

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_gem.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with pulpcore.client.pulp_gem.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_gem.RemotesGemApi(api_client)
    gem_gem_remote_href = 'gem_gem_remote_href_example' # str | 
    unset_label = pulpcore.client.pulp_gem.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(gem_gem_remote_href, unset_label, x_task_diagnostics=x_task_diagnostics)
        print("The response of RemotesGemApi->unset_label:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RemotesGemApi->unset_label: %s\n" % e)

Parameters

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

GemGemRemoteResponse update(gem_gem_remote_href, gem_gem_remote, x_task_diagnostics=x_task_diagnostics)

Update a gem remote

Update the entity and trigger an asynchronous task if necessary

Example

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

import pulpcore.client.pulp_gem
from pulpcore.client.pulp_gem.models.gem_gem_remote import GemGemRemote
from pulpcore.client.pulp_gem.models.gem_gem_remote_response import GemGemRemoteResponse
from pulpcore.client.pulp_gem.rest import ApiException
from pprint import pprint

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

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_gem.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with pulpcore.client.pulp_gem.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_gem.RemotesGemApi(api_client)
    gem_gem_remote_href = 'gem_gem_remote_href_example' # str | 
    gem_gem_remote = pulpcore.client.pulp_gem.GemGemRemote() # GemGemRemote | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

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

Parameters

Name	Type	Description	Notes
gem_gem_remote_href	str
gem_gem_remote	GemGemRemote
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]

Repair

Properties

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

Example

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

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

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

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

pulpcore.client.pulp_gem.RepositoriesGemApi

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

Method	HTTP request	Description
add_role	POST {gem_gem_repository_href}add_role/	Add a role
create	POST /api/pulp/{pulp_domain}/api/v3/repositories/gem/gem/	Create a gem repository
delete	DELETE {gem_gem_repository_href}	Delete a gem repository
list	GET /api/pulp/{pulp_domain}/api/v3/repositories/gem/gem/	List gem repositorys
list_roles	GET {gem_gem_repository_href}list_roles/	List roles
modify	POST {gem_gem_repository_href}modify/	Modify Repository Content
my_permissions	GET {gem_gem_repository_href}my_permissions/	List user permissions
partial_update	PATCH {gem_gem_repository_href}	Update a gem repository
read	GET {gem_gem_repository_href}	Inspect a gem repository
remove_role	POST {gem_gem_repository_href}remove_role/	Remove a role
set_label	POST {gem_gem_repository_href}set_label/	Set a label
sync	POST {gem_gem_repository_href}sync/	Sync from a remote
unset_label	POST {gem_gem_repository_href}unset_label/	Unset a label
update	PUT {gem_gem_repository_href}	Update a gem repository

add_role

NestedRoleResponse add_role(gem_gem_repository_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.pulp_gem
from pulpcore.client.pulp_gem.models.nested_role import NestedRole
from pulpcore.client.pulp_gem.models.nested_role_response import NestedRoleResponse
from pulpcore.client.pulp_gem.rest import ApiException
from pprint import pprint

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

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_gem.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with pulpcore.client.pulp_gem.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_gem.RepositoriesGemApi(api_client)
    gem_gem_repository_href = 'gem_gem_repository_href_example' # str | 
    nested_role = pulpcore.client.pulp_gem.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(gem_gem_repository_href, nested_role, x_task_diagnostics=x_task_diagnostics)
        print("The response of RepositoriesGemApi->add_role:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RepositoriesGemApi->add_role: %s\n" % e)

Parameters

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

GemGemRepositoryResponse create(pulp_domain, gem_gem_repository, x_task_diagnostics=x_task_diagnostics)

Create a gem repository

A ViewSet for GemRepository.

Example

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

import pulpcore.client.pulp_gem
from pulpcore.client.pulp_gem.models.gem_gem_repository import GemGemRepository
from pulpcore.client.pulp_gem.models.gem_gem_repository_response import GemGemRepositoryResponse
from pulpcore.client.pulp_gem.rest import ApiException
from pprint import pprint

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

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_gem.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with pulpcore.client.pulp_gem.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_gem.RepositoriesGemApi(api_client)
    pulp_domain = 'pulp_domain_example' # str | 
    gem_gem_repository = pulpcore.client.pulp_gem.GemGemRepository() # GemGemRepository | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

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

Parameters

Name	Type	Description	Notes
pulp_domain	str
gem_gem_repository	GemGemRepository
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(gem_gem_repository_href, x_task_diagnostics=x_task_diagnostics)

Delete a gem repository

Trigger an asynchronous delete task

Example

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

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

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

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_gem.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with pulpcore.client.pulp_gem.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_gem.RepositoriesGemApi(api_client)
    gem_gem_repository_href = 'gem_gem_repository_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

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

Parameters

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

PaginatedgemGemRepositoryResponseList 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 gem repositorys

A ViewSet for GemRepository.

Example

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

import pulpcore.client.pulp_gem
from pulpcore.client.pulp_gem.models.paginatedgem_gem_repository_response_list import PaginatedgemGemRepositoryResponseList
from pulpcore.client.pulp_gem.rest import ApiException
from pprint import pprint

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

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_gem.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with pulpcore.client.pulp_gem.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_gem.RepositoriesGemApi(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 gem repositorys
        api_response = api_instance.list(pulp_domain, x_task_diagnostics=x_task_diagnostics, latest_with_content=latest_with_content, limit=limit, name=name, name__contains=name__contains, name__icontains=name__icontains, name__iexact=name__iexact, name__in=name__in, name__iregex=name__iregex, name__istartswith=name__istartswith, name__regex=name__regex, name__startswith=name__startswith, offset=offset, ordering=ordering, prn__in=prn__in, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, pulp_label_select=pulp_label_select, q=q, remote=remote, retain_repo_versions=retain_repo_versions, retain_repo_versions__gt=retain_repo_versions__gt, retain_repo_versions__gte=retain_repo_versions__gte, retain_repo_versions__isnull=retain_repo_versions__isnull, retain_repo_versions__lt=retain_repo_versions__lt, retain_repo_versions__lte=retain_repo_versions__lte, retain_repo_versions__ne=retain_repo_versions__ne, retain_repo_versions__range=retain_repo_versions__range, with_content=with_content, fields=fields, exclude_fields=exclude_fields)
        print("The response of RepositoriesGemApi->list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RepositoriesGemApi->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

PaginatedgemGemRepositoryResponseList

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(gem_gem_repository_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.pulp_gem
from pulpcore.client.pulp_gem.models.object_roles_response import ObjectRolesResponse
from pulpcore.client.pulp_gem.rest import ApiException
from pprint import pprint

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

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_gem.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with pulpcore.client.pulp_gem.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_gem.RepositoriesGemApi(api_client)
    gem_gem_repository_href = 'gem_gem_repository_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
    exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)

    try:
        # List roles
        api_response = api_instance.list_roles(gem_gem_repository_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of RepositoriesGemApi->list_roles:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RepositoriesGemApi->list_roles: %s\n" % e)

Parameters

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

Return type

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(gem_gem_repository_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.pulp_gem
from pulpcore.client.pulp_gem.models.async_operation_response import AsyncOperationResponse
from pulpcore.client.pulp_gem.models.repository_add_remove_content import RepositoryAddRemoveContent
from pulpcore.client.pulp_gem.rest import ApiException
from pprint import pprint

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

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_gem.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with pulpcore.client.pulp_gem.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_gem.RepositoriesGemApi(api_client)
    gem_gem_repository_href = 'gem_gem_repository_href_example' # str | 
    repository_add_remove_content = pulpcore.client.pulp_gem.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(gem_gem_repository_href, repository_add_remove_content, x_task_diagnostics=x_task_diagnostics)
        print("The response of RepositoriesGemApi->modify:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RepositoriesGemApi->modify: %s\n" % e)

Parameters

Name	Type	Description	Notes
gem_gem_repository_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(gem_gem_repository_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.pulp_gem
from pulpcore.client.pulp_gem.models.my_permissions_response import MyPermissionsResponse
from pulpcore.client.pulp_gem.rest import ApiException
from pprint import pprint

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

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_gem.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with pulpcore.client.pulp_gem.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_gem.RepositoriesGemApi(api_client)
    gem_gem_repository_href = 'gem_gem_repository_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
    exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)

    try:
        # List user permissions
        api_response = api_instance.my_permissions(gem_gem_repository_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of RepositoriesGemApi->my_permissions:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RepositoriesGemApi->my_permissions: %s\n" % e)

Parameters

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

Return type

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

GemGemRepositoryResponse partial_update(gem_gem_repository_href, patchedgem_gem_repository, x_task_diagnostics=x_task_diagnostics)

Update a gem repository

Update the entity partially and trigger an asynchronous task if necessary

Example

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

import pulpcore.client.pulp_gem
from pulpcore.client.pulp_gem.models.gem_gem_repository_response import GemGemRepositoryResponse
from pulpcore.client.pulp_gem.models.patchedgem_gem_repository import PatchedgemGemRepository
from pulpcore.client.pulp_gem.rest import ApiException
from pprint import pprint

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

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_gem.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with pulpcore.client.pulp_gem.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_gem.RepositoriesGemApi(api_client)
    gem_gem_repository_href = 'gem_gem_repository_href_example' # str | 
    patchedgem_gem_repository = pulpcore.client.pulp_gem.PatchedgemGemRepository() # PatchedgemGemRepository | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

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

Parameters

Name	Type	Description	Notes
gem_gem_repository_href	str
patchedgem_gem_repository	PatchedgemGemRepository
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

GemGemRepositoryResponse read(gem_gem_repository_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

Inspect a gem repository

A ViewSet for GemRepository.

Example

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

import pulpcore.client.pulp_gem
from pulpcore.client.pulp_gem.models.gem_gem_repository_response import GemGemRepositoryResponse
from pulpcore.client.pulp_gem.rest import ApiException
from pprint import pprint

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

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_gem.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with pulpcore.client.pulp_gem.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_gem.RepositoriesGemApi(api_client)
    gem_gem_repository_href = 'gem_gem_repository_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
    exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)

    try:
        # Inspect a gem repository
        api_response = api_instance.read(gem_gem_repository_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of RepositoriesGemApi->read:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RepositoriesGemApi->read: %s\n" % e)

Parameters

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

Return type

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(gem_gem_repository_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.pulp_gem
from pulpcore.client.pulp_gem.models.nested_role import NestedRole
from pulpcore.client.pulp_gem.models.nested_role_response import NestedRoleResponse
from pulpcore.client.pulp_gem.rest import ApiException
from pprint import pprint

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

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_gem.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with pulpcore.client.pulp_gem.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_gem.RepositoriesGemApi(api_client)
    gem_gem_repository_href = 'gem_gem_repository_href_example' # str | 
    nested_role = pulpcore.client.pulp_gem.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(gem_gem_repository_href, nested_role, x_task_diagnostics=x_task_diagnostics)
        print("The response of RepositoriesGemApi->remove_role:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RepositoriesGemApi->remove_role: %s\n" % e)

Parameters

Name	Type	Description	Notes
gem_gem_repository_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(gem_gem_repository_href, set_label, x_task_diagnostics=x_task_diagnostics)

Set a label

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

Example

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

import pulpcore.client.pulp_gem
from pulpcore.client.pulp_gem.models.set_label import SetLabel
from pulpcore.client.pulp_gem.models.set_label_response import SetLabelResponse
from pulpcore.client.pulp_gem.rest import ApiException
from pprint import pprint

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

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_gem.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with pulpcore.client.pulp_gem.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_gem.RepositoriesGemApi(api_client)
    gem_gem_repository_href = 'gem_gem_repository_href_example' # str | 
    set_label = pulpcore.client.pulp_gem.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(gem_gem_repository_href, set_label, x_task_diagnostics=x_task_diagnostics)
        print("The response of RepositoriesGemApi->set_label:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RepositoriesGemApi->set_label: %s\n" % e)

Parameters

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

sync

AsyncOperationResponse sync(gem_gem_repository_href, repository_sync_url, x_task_diagnostics=x_task_diagnostics)

Sync from a remote

Trigger an asynchronous task to sync gem content.

Example

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

import pulpcore.client.pulp_gem
from pulpcore.client.pulp_gem.models.async_operation_response import AsyncOperationResponse
from pulpcore.client.pulp_gem.models.repository_sync_url import RepositorySyncURL
from pulpcore.client.pulp_gem.rest import ApiException
from pprint import pprint

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

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_gem.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with pulpcore.client.pulp_gem.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_gem.RepositoriesGemApi(api_client)
    gem_gem_repository_href = 'gem_gem_repository_href_example' # str | 
    repository_sync_url = pulpcore.client.pulp_gem.RepositorySyncURL() # RepositorySyncURL | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Sync from a remote
        api_response = api_instance.sync(gem_gem_repository_href, repository_sync_url, x_task_diagnostics=x_task_diagnostics)
        print("The response of RepositoriesGemApi->sync:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RepositoriesGemApi->sync: %s\n" % e)

Parameters

Name	Type	Description	Notes
gem_gem_repository_href	str
repository_sync_url	RepositorySyncURL
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]

unset_label

UnsetLabelResponse unset_label(gem_gem_repository_href, unset_label, x_task_diagnostics=x_task_diagnostics)

Unset a label

Unset a single pulp_label on the object.

Example

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

import pulpcore.client.pulp_gem
from pulpcore.client.pulp_gem.models.unset_label import UnsetLabel
from pulpcore.client.pulp_gem.models.unset_label_response import UnsetLabelResponse
from pulpcore.client.pulp_gem.rest import ApiException
from pprint import pprint

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

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_gem.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with pulpcore.client.pulp_gem.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_gem.RepositoriesGemApi(api_client)
    gem_gem_repository_href = 'gem_gem_repository_href_example' # str | 
    unset_label = pulpcore.client.pulp_gem.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(gem_gem_repository_href, unset_label, x_task_diagnostics=x_task_diagnostics)
        print("The response of RepositoriesGemApi->unset_label:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RepositoriesGemApi->unset_label: %s\n" % e)

Parameters

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

GemGemRepositoryResponse update(gem_gem_repository_href, gem_gem_repository, x_task_diagnostics=x_task_diagnostics)

Update a gem repository

Update the entity and trigger an asynchronous task if necessary

Example

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

import pulpcore.client.pulp_gem
from pulpcore.client.pulp_gem.models.gem_gem_repository import GemGemRepository
from pulpcore.client.pulp_gem.models.gem_gem_repository_response import GemGemRepositoryResponse
from pulpcore.client.pulp_gem.rest import ApiException
from pprint import pprint

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

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_gem.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with pulpcore.client.pulp_gem.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_gem.RepositoriesGemApi(api_client)
    gem_gem_repository_href = 'gem_gem_repository_href_example' # str | 
    gem_gem_repository = pulpcore.client.pulp_gem.GemGemRepository() # GemGemRepository | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

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

Parameters

Name	Type	Description	Notes
gem_gem_repository_href	str
gem_gem_repository	GemGemRepository
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.pulp_gem.RepositoriesGemVersionsApi

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

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

delete

AsyncOperationResponse delete(gem_gem_repository_version_href, x_task_diagnostics=x_task_diagnostics)

Delete a repository version

Trigger an asynchronous task to delete a repository version.

Example

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

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

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

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_gem.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with pulpcore.client.pulp_gem.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_gem.RepositoriesGemVersionsApi(api_client)
    gem_gem_repository_version_href = 'gem_gem_repository_version_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

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

Parameters

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

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

List repository versions

A ViewSet for a GemRepositoryVersion represents a single Gem repository version.

Example

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

import pulpcore.client.pulp_gem
from pulpcore.client.pulp_gem.models.paginated_repository_version_response_list import PaginatedRepositoryVersionResponseList
from pulpcore.client.pulp_gem.rest import ApiException
from pprint import pprint

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

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_gem.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with pulpcore.client.pulp_gem.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_gem.RepositoriesGemVersionsApi(api_client)
    gem_gem_repository_href = 'gem_gem_repository_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    content = 'content_example' # str | Content Unit referenced by HREF/PRN (optional)
    content__in = ['content__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
    limit = 56 # int | Number of results to return per page. (optional)
    number = 56 # int | Filter results where number matches value (optional)
    number__gt = 56 # int | Filter results where number is greater than value (optional)
    number__gte = 56 # int | Filter results where number is greater than or equal to value (optional)
    number__lt = 56 # int | Filter results where number is less than value (optional)
    number__lte = 56 # int | Filter results where number is less than or equal to value (optional)
    number__range = [56] # List[int] | Filter results where number is between two comma separated values (optional)
    offset = 56 # int | The initial index from which to return the results. (optional)
    ordering = ['ordering_example'] # List[str] | Ordering  * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `number` - Number * `-number` - Number (descending) * `complete` - Complete * `-complete` - Complete (descending) * `info` - Info * `-info` - Info (descending) * `content_ids` - Content ids * `-content_ids` - Content ids (descending) * `pk` - Pk * `-pk` - Pk (descending) (optional)
    prn__in = ['prn__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
    pulp_created = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_created matches value (optional)
    pulp_created__gt = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_created is greater than value (optional)
    pulp_created__gte = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_created is greater than or equal to value (optional)
    pulp_created__isnull = True # bool | Filter results where pulp_created has a null value (optional)
    pulp_created__lt = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_created is less than value (optional)
    pulp_created__lte = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_created is less than or equal to value (optional)
    pulp_created__range = ['2013-10-20T19:20:30+01:00'] # List[datetime] | Filter results where pulp_created is between two comma separated values (optional)
    pulp_href__in = ['pulp_href__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
    q = 'q_example' # str | Filter results by using NOT, AND and OR operations on other filters (optional)
    fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
    exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)

    try:
        # List repository versions
        api_response = api_instance.list(gem_gem_repository_href, x_task_diagnostics=x_task_diagnostics, content=content, content__in=content__in, limit=limit, number=number, number__gt=number__gt, number__gte=number__gte, number__lt=number__lt, number__lte=number__lte, number__range=number__range, offset=offset, ordering=ordering, prn__in=prn__in, pulp_created=pulp_created, pulp_created__gt=pulp_created__gt, pulp_created__gte=pulp_created__gte, pulp_created__isnull=pulp_created__isnull, pulp_created__lt=pulp_created__lt, pulp_created__lte=pulp_created__lte, pulp_created__range=pulp_created__range, pulp_href__in=pulp_href__in, q=q, fields=fields, exclude_fields=exclude_fields)
        print("The response of RepositoriesGemVersionsApi->list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RepositoriesGemVersionsApi->list: %s\n" % e)

Parameters

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

Return type

PaginatedRepositoryVersionResponseList

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

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

read

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

Inspect a repository version

A ViewSet for a GemRepositoryVersion represents a single Gem repository version.

Example

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

import pulpcore.client.pulp_gem
from pulpcore.client.pulp_gem.models.repository_version_response import RepositoryVersionResponse
from pulpcore.client.pulp_gem.rest import ApiException
from pprint import pprint

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

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_gem.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with pulpcore.client.pulp_gem.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_gem.RepositoriesGemVersionsApi(api_client)
    gem_gem_repository_version_href = 'gem_gem_repository_version_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
    exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)

    try:
        # Inspect a repository version
        api_response = api_instance.read(gem_gem_repository_version_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of RepositoriesGemVersionsApi->read:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RepositoriesGemVersionsApi->read: %s\n" % e)

Parameters

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

Return type

RepositoryVersionResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

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

repair

AsyncOperationResponse repair(gem_gem_repository_version_href, repair, x_task_diagnostics=x_task_diagnostics)

Trigger an asynchronous task to repair a repository version.

Example

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

import pulpcore.client.pulp_gem
from pulpcore.client.pulp_gem.models.async_operation_response import AsyncOperationResponse
from pulpcore.client.pulp_gem.models.repair import Repair
from pulpcore.client.pulp_gem.rest import ApiException
from pprint import pprint

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

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_gem.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with pulpcore.client.pulp_gem.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_gem.RepositoriesGemVersionsApi(api_client)
    gem_gem_repository_version_href = 'gem_gem_repository_version_href_example' # str | 
    repair = pulpcore.client.pulp_gem.Repair() # Repair | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

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

Parameters

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

Return type