# pulpcore.client.pulp_service.ApiCreateDomainApi
All URIs are relative to *https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com*
Method | HTTP request | Description
------------- | ------------- | -------------
[**post**](ApiCreateDomainApi.md#post) | **POST** /api/pulp/create-domain/ | Create domain
# **post**
> DomainResponse post(domain, x_task_diagnostics=x_task_diagnostics)
Create domain
Create a new domain for from S3 template domain, self-service path
### Example
* OAuth Authentication (json_header_remote_authentication):
* Basic Authentication (basicAuth):
* Api Key Authentication (cookieAuth):
```python
import pulpcore.client.pulp_service
from pulpcore.client.pulp_service.models.domain import Domain
from pulpcore.client.pulp_service.models.domain_response import DomainResponse
from pulpcore.client.pulp_service.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_service.Configuration(
host = "https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, 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_service.Configuration(
username = os.environ["USERNAME"],
password = os.environ["PASSWORD"]
)
# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) 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_service.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pulpcore.client.pulp_service.ApiCreateDomainApi(api_client)
domain = pulpcore.client.pulp_service.Domain() # Domain |
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
try:
# Create domain
api_response = api_instance.post(domain, x_task_diagnostics=x_task_diagnostics)
print("The response of ApiCreateDomainApi->post:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ApiCreateDomainApi->post: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**domain** | [**Domain**](Domain.md)| |
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
### Return type
[**DomainResponse**](DomainResponse.md)
### Authorization
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
### HTTP request headers
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**201** | | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# pulpcore.client.pulp_service.ApiDebugAuthHeaderApi
All URIs are relative to *https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com*
Method | HTTP request | Description
------------- | ------------- | -------------
[**get**](ApiDebugAuthHeaderApi.md#get) | **GET** /api/pulp/debug_auth_header/ |
# **get**
> get(x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
Returns the content of the authentication headers.
### Example
```python
import pulpcore.client.pulp_service
from pulpcore.client.pulp_service.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_service.Configuration(
host = "https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com"
)
# Enter a context with an instance of the API client
with pulpcore.client.pulp_service.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pulpcore.client.pulp_service.ApiDebugAuthHeaderApi(api_client)
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)
try:
api_instance.get(x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
except Exception as e:
print("Exception when calling ApiDebugAuthHeaderApi->get: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
**fields** | [**List[str]**](str.md)| A list of fields to include in the response. | [optional]
**exclude_fields** | [**List[str]**](str.md)| A list of fields to exclude from the response. | [optional]
### Return type
void (empty response body)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | No response body | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# pulpcore.client.pulp_service.ApiTestRandomLockTasksApi
All URIs are relative to *https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com*
Method | HTTP request | Description
------------- | ------------- | -------------
[**get**](ApiTestRandomLockTasksApi.md#get) | **GET** /api/pulp/test/random_lock_tasks/ |
# **get**
> get(x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
### Example
```python
import pulpcore.client.pulp_service
from pulpcore.client.pulp_service.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_service.Configuration(
host = "https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com"
)
# Enter a context with an instance of the API client
with pulpcore.client.pulp_service.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pulpcore.client.pulp_service.ApiTestRandomLockTasksApi(api_client)
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)
try:
api_instance.get(x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
except Exception as e:
print("Exception when calling ApiTestRandomLockTasksApi->get: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
**fields** | [**List[str]**](str.md)| A list of fields to include in the response. | [optional]
**exclude_fields** | [**List[str]**](str.md)| A list of fields to exclude from the response. | [optional]
### Return type
void (empty response body)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | No response body | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# pulpcore.client.pulp_service.ApiTestTasksApi
All URIs are relative to *https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com*
Method | HTTP request | Description
------------- | ------------- | -------------
[**get**](ApiTestTasksApi.md#get) | **GET** /api/pulp/test/tasks/ |
# **get**
> get(x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
### Example
```python
import pulpcore.client.pulp_service
from pulpcore.client.pulp_service.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_service.Configuration(
host = "https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com"
)
# Enter a context with an instance of the API client
with pulpcore.client.pulp_service.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pulpcore.client.pulp_service.ApiTestTasksApi(api_client)
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)
try:
api_instance.get(x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
except Exception as e:
print("Exception when calling ApiTestTasksApi->get: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
**fields** | [**List[str]**](str.md)| A list of fields to include in the response. | [optional]
**exclude_fields** | [**List[str]**](str.md)| A list of fields to exclude from the response. | [optional]
### Return type
void (empty response body)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | No response body | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# AsyncOperationResponse
Serializer for asynchronous operations.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**task** | **str** | The href of the task. |
## Example
```python
from pulpcore.client.pulp_service.models.async_operation_response import AsyncOperationResponse
# TODO update the JSON string below
json = "{}"
# create an instance of AsyncOperationResponse from a JSON string
async_operation_response_instance = AsyncOperationResponse.from_json(json)
# print the JSON string representation of the object
print(AsyncOperationResponse.to_json())
# convert the object into a dict
async_operation_response_dict = async_operation_response_instance.to_dict()
# create an instance of AsyncOperationResponse from a dict
async_operation_response_from_dict = AsyncOperationResponse.from_dict(async_operation_response_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
# pulpcore.client.pulp_service.ContentguardsFeatureApi
All URIs are relative to *https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com*
Method | HTTP request | Description
------------- | ------------- | -------------
[**add_role**](ContentguardsFeatureApi.md#add_role) | **POST** {service_feature_content_guard_href}add_role/ | Add a role
[**create**](ContentguardsFeatureApi.md#create) | **POST** /api/pulp/{pulp_domain}/api/v3/contentguards/service/feature/ | Create a feature content guard
[**delete**](ContentguardsFeatureApi.md#delete) | **DELETE** {service_feature_content_guard_href} | Delete a feature content guard
[**list**](ContentguardsFeatureApi.md#list) | **GET** /api/pulp/{pulp_domain}/api/v3/contentguards/service/feature/ | List feature content guards
[**list_roles**](ContentguardsFeatureApi.md#list_roles) | **GET** {service_feature_content_guard_href}list_roles/ | List roles
[**my_permissions**](ContentguardsFeatureApi.md#my_permissions) | **GET** {service_feature_content_guard_href}my_permissions/ | List user permissions
[**partial_update**](ContentguardsFeatureApi.md#partial_update) | **PATCH** {service_feature_content_guard_href} | Update a feature content guard
[**read**](ContentguardsFeatureApi.md#read) | **GET** {service_feature_content_guard_href} | Inspect a feature content guard
[**remove_role**](ContentguardsFeatureApi.md#remove_role) | **POST** {service_feature_content_guard_href}remove_role/ | Remove a role
[**update**](ContentguardsFeatureApi.md#update) | **PUT** {service_feature_content_guard_href} | Update a feature content guard
# **add_role**
> NestedRoleResponse add_role(service_feature_content_guard_href, nested_role, x_task_diagnostics=x_task_diagnostics)
Add a role
Add a role for this object to users/groups.
### Example
* OAuth Authentication (json_header_remote_authentication):
* Basic Authentication (basicAuth):
* Api Key Authentication (cookieAuth):
```python
import pulpcore.client.pulp_service
from pulpcore.client.pulp_service.models.nested_role import NestedRole
from pulpcore.client.pulp_service.models.nested_role_response import NestedRoleResponse
from pulpcore.client.pulp_service.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_service.Configuration(
host = "https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, 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_service.Configuration(
username = os.environ["USERNAME"],
password = os.environ["PASSWORD"]
)
# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) 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_service.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pulpcore.client.pulp_service.ContentguardsFeatureApi(api_client)
service_feature_content_guard_href = 'service_feature_content_guard_href_example' # str |
nested_role = pulpcore.client.pulp_service.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(service_feature_content_guard_href, nested_role, x_task_diagnostics=x_task_diagnostics)
print("The response of ContentguardsFeatureApi->add_role:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ContentguardsFeatureApi->add_role: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**service_feature_content_guard_href** | **str**| |
**nested_role** | [**NestedRole**](NestedRole.md)| |
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
### Return type
[**NestedRoleResponse**](NestedRoleResponse.md)
### Authorization
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
### HTTP request headers
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**201** | | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **create**
> ServiceFeatureContentGuardResponse create(pulp_domain, service_feature_content_guard, x_task_diagnostics=x_task_diagnostics)
Create a feature content guard
Content guard to protect the content guarded by Subscription Features.
### Example
* OAuth Authentication (json_header_remote_authentication):
* Basic Authentication (basicAuth):
* Api Key Authentication (cookieAuth):
```python
import pulpcore.client.pulp_service
from pulpcore.client.pulp_service.models.service_feature_content_guard import ServiceFeatureContentGuard
from pulpcore.client.pulp_service.models.service_feature_content_guard_response import ServiceFeatureContentGuardResponse
from pulpcore.client.pulp_service.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_service.Configuration(
host = "https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, 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_service.Configuration(
username = os.environ["USERNAME"],
password = os.environ["PASSWORD"]
)
# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) 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_service.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pulpcore.client.pulp_service.ContentguardsFeatureApi(api_client)
pulp_domain = 'pulp_domain_example' # str |
service_feature_content_guard = pulpcore.client.pulp_service.ServiceFeatureContentGuard() # ServiceFeatureContentGuard |
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
try:
# Create a feature content guard
api_response = api_instance.create(pulp_domain, service_feature_content_guard, x_task_diagnostics=x_task_diagnostics)
print("The response of ContentguardsFeatureApi->create:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ContentguardsFeatureApi->create: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**pulp_domain** | **str**| |
**service_feature_content_guard** | [**ServiceFeatureContentGuard**](ServiceFeatureContentGuard.md)| |
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
### Return type
[**ServiceFeatureContentGuardResponse**](ServiceFeatureContentGuardResponse.md)
### Authorization
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
### HTTP request headers
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**201** | | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **delete**
> delete(service_feature_content_guard_href, x_task_diagnostics=x_task_diagnostics)
Delete a feature content guard
Content guard to protect the content guarded by Subscription Features.
### Example
* OAuth Authentication (json_header_remote_authentication):
* Basic Authentication (basicAuth):
* Api Key Authentication (cookieAuth):
```python
import pulpcore.client.pulp_service
from pulpcore.client.pulp_service.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_service.Configuration(
host = "https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, 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_service.Configuration(
username = os.environ["USERNAME"],
password = os.environ["PASSWORD"]
)
# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) 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_service.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pulpcore.client.pulp_service.ContentguardsFeatureApi(api_client)
service_feature_content_guard_href = 'service_feature_content_guard_href_example' # str |
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
try:
# Delete a feature content guard
api_instance.delete(service_feature_content_guard_href, x_task_diagnostics=x_task_diagnostics)
except Exception as e:
print("Exception when calling ContentguardsFeatureApi->delete: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**service_feature_content_guard_href** | **str**| |
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
### Return type
void (empty response body)
### Authorization
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#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]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **list**
> PaginatedserviceFeatureContentGuardResponseList list(pulp_domain, x_task_diagnostics=x_task_diagnostics, limit=limit, name=name, name__contains=name__contains, name__icontains=name__icontains, name__iexact=name__iexact, name__in=name__in, name__iregex=name__iregex, name__istartswith=name__istartswith, name__regex=name__regex, name__startswith=name__startswith, offset=offset, ordering=ordering, prn__in=prn__in, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, q=q, fields=fields, exclude_fields=exclude_fields)
List feature content guards
Content guard to protect the content guarded by Subscription Features.
### Example
* OAuth Authentication (json_header_remote_authentication):
* Basic Authentication (basicAuth):
* Api Key Authentication (cookieAuth):
```python
import pulpcore.client.pulp_service
from pulpcore.client.pulp_service.models.paginatedservice_feature_content_guard_response_list import PaginatedserviceFeatureContentGuardResponseList
from pulpcore.client.pulp_service.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_service.Configuration(
host = "https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, 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_service.Configuration(
username = os.environ["USERNAME"],
password = os.environ["PASSWORD"]
)
# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) 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_service.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pulpcore.client.pulp_service.ContentguardsFeatureApi(api_client)
pulp_domain = 'pulp_domain_example' # str |
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
limit = 56 # int | Number of results to return per page. (optional)
name = 'name_example' # str | Filter results where name matches value (optional)
name__contains = 'name__contains_example' # str | Filter results where name contains value (optional)
name__icontains = 'name__icontains_example' # str | Filter results where name contains value (optional)
name__iexact = 'name__iexact_example' # str | Filter results where name matches value (optional)
name__in = ['name__in_example'] # List[str] | Filter results where name is in a comma-separated list of values (optional)
name__iregex = 'name__iregex_example' # str | Filter results where name matches regex value (optional)
name__istartswith = 'name__istartswith_example' # str | Filter results where name starts with value (optional)
name__regex = 'name__regex_example' # str | Filter results where name matches regex value (optional)
name__startswith = 'name__startswith_example' # str | Filter results where name starts with value (optional)
offset = 56 # int | The initial index from which to return the results. (optional)
ordering = ['ordering_example'] # List[str] | Ordering * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `name` - Name * `-name` - Name (descending) * `description` - Description * `-description` - Description (descending) * `pk` - Pk * `-pk` - Pk (descending) (optional)
prn__in = ['prn__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
pulp_href__in = ['pulp_href__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
pulp_id__in = ['pulp_id__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
q = 'q_example' # str | Filter results by using NOT, AND and OR operations on other filters (optional)
fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)
try:
# List feature content guards
api_response = api_instance.list(pulp_domain, x_task_diagnostics=x_task_diagnostics, limit=limit, name=name, name__contains=name__contains, name__icontains=name__icontains, name__iexact=name__iexact, name__in=name__in, name__iregex=name__iregex, name__istartswith=name__istartswith, name__regex=name__regex, name__startswith=name__startswith, offset=offset, ordering=ordering, prn__in=prn__in, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, q=q, fields=fields, exclude_fields=exclude_fields)
print("The response of ContentguardsFeatureApi->list:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ContentguardsFeatureApi->list: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**pulp_domain** | **str**| |
**x_task_diagnostics** | [**List[str]**](str.md)| 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]**](str.md)| 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]**](str.md)| Ordering * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `name` - Name * `-name` - Name (descending) * `description` - Description * `-description` - Description (descending) * `pk` - Pk * `-pk` - Pk (descending) | [optional]
**prn__in** | [**List[str]**](str.md)| Multiple values may be separated by commas. | [optional]
**pulp_href__in** | [**List[str]**](str.md)| Multiple values may be separated by commas. | [optional]
**pulp_id__in** | [**List[str]**](str.md)| 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]**](str.md)| A list of fields to include in the response. | [optional]
**exclude_fields** | [**List[str]**](str.md)| A list of fields to exclude from the response. | [optional]
### Return type
[**PaginatedserviceFeatureContentGuardResponseList**](PaginatedserviceFeatureContentGuardResponseList.md)
### Authorization
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#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]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **list_roles**
> ObjectRolesResponse list_roles(service_feature_content_guard_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
List roles
List roles assigned to this object.
### Example
* OAuth Authentication (json_header_remote_authentication):
* Basic Authentication (basicAuth):
* Api Key Authentication (cookieAuth):
```python
import pulpcore.client.pulp_service
from pulpcore.client.pulp_service.models.object_roles_response import ObjectRolesResponse
from pulpcore.client.pulp_service.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_service.Configuration(
host = "https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, 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_service.Configuration(
username = os.environ["USERNAME"],
password = os.environ["PASSWORD"]
)
# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) 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_service.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pulpcore.client.pulp_service.ContentguardsFeatureApi(api_client)
service_feature_content_guard_href = 'service_feature_content_guard_href_example' # str |
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)
try:
# List roles
api_response = api_instance.list_roles(service_feature_content_guard_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
print("The response of ContentguardsFeatureApi->list_roles:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ContentguardsFeatureApi->list_roles: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**service_feature_content_guard_href** | **str**| |
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
**fields** | [**List[str]**](str.md)| A list of fields to include in the response. | [optional]
**exclude_fields** | [**List[str]**](str.md)| A list of fields to exclude from the response. | [optional]
### Return type
[**ObjectRolesResponse**](ObjectRolesResponse.md)
### Authorization
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#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]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **my_permissions**
> MyPermissionsResponse my_permissions(service_feature_content_guard_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
List user permissions
List permissions available to the current user on this object.
### Example
* OAuth Authentication (json_header_remote_authentication):
* Basic Authentication (basicAuth):
* Api Key Authentication (cookieAuth):
```python
import pulpcore.client.pulp_service
from pulpcore.client.pulp_service.models.my_permissions_response import MyPermissionsResponse
from pulpcore.client.pulp_service.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_service.Configuration(
host = "https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, 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_service.Configuration(
username = os.environ["USERNAME"],
password = os.environ["PASSWORD"]
)
# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) 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_service.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pulpcore.client.pulp_service.ContentguardsFeatureApi(api_client)
service_feature_content_guard_href = 'service_feature_content_guard_href_example' # str |
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)
try:
# List user permissions
api_response = api_instance.my_permissions(service_feature_content_guard_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
print("The response of ContentguardsFeatureApi->my_permissions:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ContentguardsFeatureApi->my_permissions: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**service_feature_content_guard_href** | **str**| |
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
**fields** | [**List[str]**](str.md)| A list of fields to include in the response. | [optional]
**exclude_fields** | [**List[str]**](str.md)| A list of fields to exclude from the response. | [optional]
### Return type
[**MyPermissionsResponse**](MyPermissionsResponse.md)
### Authorization
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#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]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **partial_update**
> ServiceFeatureContentGuardResponse partial_update(service_feature_content_guard_href, patchedservice_feature_content_guard, x_task_diagnostics=x_task_diagnostics)
Update a feature content guard
Content guard to protect the content guarded by Subscription Features.
### Example
* OAuth Authentication (json_header_remote_authentication):
* Basic Authentication (basicAuth):
* Api Key Authentication (cookieAuth):
```python
import pulpcore.client.pulp_service
from pulpcore.client.pulp_service.models.patchedservice_feature_content_guard import PatchedserviceFeatureContentGuard
from pulpcore.client.pulp_service.models.service_feature_content_guard_response import ServiceFeatureContentGuardResponse
from pulpcore.client.pulp_service.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_service.Configuration(
host = "https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, 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_service.Configuration(
username = os.environ["USERNAME"],
password = os.environ["PASSWORD"]
)
# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) 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_service.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pulpcore.client.pulp_service.ContentguardsFeatureApi(api_client)
service_feature_content_guard_href = 'service_feature_content_guard_href_example' # str |
patchedservice_feature_content_guard = pulpcore.client.pulp_service.PatchedserviceFeatureContentGuard() # PatchedserviceFeatureContentGuard |
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
try:
# Update a feature content guard
api_response = api_instance.partial_update(service_feature_content_guard_href, patchedservice_feature_content_guard, x_task_diagnostics=x_task_diagnostics)
print("The response of ContentguardsFeatureApi->partial_update:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ContentguardsFeatureApi->partial_update: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**service_feature_content_guard_href** | **str**| |
**patchedservice_feature_content_guard** | [**PatchedserviceFeatureContentGuard**](PatchedserviceFeatureContentGuard.md)| |
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
### Return type
[**ServiceFeatureContentGuardResponse**](ServiceFeatureContentGuardResponse.md)
### Authorization
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
### HTTP request headers
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **read**
> ServiceFeatureContentGuardResponse read(service_feature_content_guard_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
Inspect a feature content guard
Content guard to protect the content guarded by Subscription Features.
### Example
* OAuth Authentication (json_header_remote_authentication):
* Basic Authentication (basicAuth):
* Api Key Authentication (cookieAuth):
```python
import pulpcore.client.pulp_service
from pulpcore.client.pulp_service.models.service_feature_content_guard_response import ServiceFeatureContentGuardResponse
from pulpcore.client.pulp_service.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_service.Configuration(
host = "https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, 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_service.Configuration(
username = os.environ["USERNAME"],
password = os.environ["PASSWORD"]
)
# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) 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_service.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pulpcore.client.pulp_service.ContentguardsFeatureApi(api_client)
service_feature_content_guard_href = 'service_feature_content_guard_href_example' # str |
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)
try:
# Inspect a feature content guard
api_response = api_instance.read(service_feature_content_guard_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
print("The response of ContentguardsFeatureApi->read:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ContentguardsFeatureApi->read: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**service_feature_content_guard_href** | **str**| |
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
**fields** | [**List[str]**](str.md)| A list of fields to include in the response. | [optional]
**exclude_fields** | [**List[str]**](str.md)| A list of fields to exclude from the response. | [optional]
### Return type
[**ServiceFeatureContentGuardResponse**](ServiceFeatureContentGuardResponse.md)
### Authorization
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#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]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **remove_role**
> NestedRoleResponse remove_role(service_feature_content_guard_href, nested_role, x_task_diagnostics=x_task_diagnostics)
Remove a role
Remove a role for this object from users/groups.
### Example
* OAuth Authentication (json_header_remote_authentication):
* Basic Authentication (basicAuth):
* Api Key Authentication (cookieAuth):
```python
import pulpcore.client.pulp_service
from pulpcore.client.pulp_service.models.nested_role import NestedRole
from pulpcore.client.pulp_service.models.nested_role_response import NestedRoleResponse
from pulpcore.client.pulp_service.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_service.Configuration(
host = "https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, 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_service.Configuration(
username = os.environ["USERNAME"],
password = os.environ["PASSWORD"]
)
# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) 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_service.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pulpcore.client.pulp_service.ContentguardsFeatureApi(api_client)
service_feature_content_guard_href = 'service_feature_content_guard_href_example' # str |
nested_role = pulpcore.client.pulp_service.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(service_feature_content_guard_href, nested_role, x_task_diagnostics=x_task_diagnostics)
print("The response of ContentguardsFeatureApi->remove_role:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ContentguardsFeatureApi->remove_role: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**service_feature_content_guard_href** | **str**| |
**nested_role** | [**NestedRole**](NestedRole.md)| |
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
### Return type
[**NestedRoleResponse**](NestedRoleResponse.md)
### Authorization
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
### HTTP request headers
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**201** | | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **update**
> ServiceFeatureContentGuardResponse update(service_feature_content_guard_href, service_feature_content_guard, x_task_diagnostics=x_task_diagnostics)
Update a feature content guard
Content guard to protect the content guarded by Subscription Features.
### Example
* OAuth Authentication (json_header_remote_authentication):
* Basic Authentication (basicAuth):
* Api Key Authentication (cookieAuth):
```python
import pulpcore.client.pulp_service
from pulpcore.client.pulp_service.models.service_feature_content_guard import ServiceFeatureContentGuard
from pulpcore.client.pulp_service.models.service_feature_content_guard_response import ServiceFeatureContentGuardResponse
from pulpcore.client.pulp_service.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_service.Configuration(
host = "https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, 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_service.Configuration(
username = os.environ["USERNAME"],
password = os.environ["PASSWORD"]
)
# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) 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_service.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pulpcore.client.pulp_service.ContentguardsFeatureApi(api_client)
service_feature_content_guard_href = 'service_feature_content_guard_href_example' # str |
service_feature_content_guard = pulpcore.client.pulp_service.ServiceFeatureContentGuard() # ServiceFeatureContentGuard |
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
try:
# Update a feature content guard
api_response = api_instance.update(service_feature_content_guard_href, service_feature_content_guard, x_task_diagnostics=x_task_diagnostics)
print("The response of ContentguardsFeatureApi->update:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ContentguardsFeatureApi->update: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**service_feature_content_guard_href** | **str**| |
**service_feature_content_guard** | [**ServiceFeatureContentGuard**](ServiceFeatureContentGuard.md)| |
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
### Return type
[**ServiceFeatureContentGuardResponse**](ServiceFeatureContentGuardResponse.md)
### Authorization
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
### HTTP request headers
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# Domain
Serializer for Domain.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | A name for this domain. |
**description** | **str** | An optional description. | [optional]
**pulp_labels** | **Dict[str, Optional[str]]** | | [optional]
**storage_class** | [**StorageClassEnum**](StorageClassEnum.md) | Backend storage class for domain. * `pulpcore.app.models.storage.FileSystem` - Use local filesystem as storage * `storages.backends.s3boto3.S3Boto3Storage` - Use Amazon S3 as storage * `storages.backends.azure_storage.AzureStorage` - Use Azure Blob as storage * `pulp_service.app.storage.OCIStorage` - Use OCI as storage |
**storage_settings** | **object** | Settings for storage class. |
**redirect_to_object_storage** | **bool** | Boolean to have the content app redirect to object storage. | [optional] [default to True]
**hide_guarded_distributions** | **bool** | Boolean to hide distributions with a content guard in the content app. | [optional] [default to False]
## Example
```python
from pulpcore.client.pulp_service.models.domain import Domain
# TODO update the JSON string below
json = "{}"
# create an instance of Domain from a JSON string
domain_instance = Domain.from_json(json)
# print the JSON string representation of the object
print(Domain.to_json())
# convert the object into a dict
domain_dict = domain_instance.to_dict()
# create an instance of Domain from a dict
domain_from_dict = Domain.from_dict(domain_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
# DomainResponse
Serializer for Domain.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**pulp_href** | **str** | | [optional] [readonly]
**prn** | **str** | The Pulp Resource Name (PRN). | [optional] [readonly]
**pulp_created** | **datetime** | Timestamp of creation. | [optional] [readonly]
**pulp_last_updated** | **datetime** | Timestamp of the last time this resource was updated. Note: for immutable resources - like content, repository versions, and publication - pulp_created and pulp_last_updated dates will be the same. | [optional] [readonly]
**name** | **str** | A name for this domain. |
**description** | **str** | An optional description. | [optional]
**pulp_labels** | **Dict[str, Optional[str]]** | | [optional]
**storage_class** | [**StorageClassEnum**](StorageClassEnum.md) | Backend storage class for domain. * `pulpcore.app.models.storage.FileSystem` - Use local filesystem as storage * `storages.backends.s3boto3.S3Boto3Storage` - Use Amazon S3 as storage * `storages.backends.azure_storage.AzureStorage` - Use Azure Blob as storage * `pulp_service.app.storage.OCIStorage` - Use OCI as storage |
**storage_settings** | **object** | Settings for storage class. |
**redirect_to_object_storage** | **bool** | Boolean to have the content app redirect to object storage. | [optional] [default to True]
**hide_guarded_distributions** | **bool** | Boolean to hide distributions with a content guard in the content app. | [optional] [default to False]
## Example
```python
from pulpcore.client.pulp_service.models.domain_response import DomainResponse
# TODO update the JSON string below
json = "{}"
# create an instance of DomainResponse from a JSON string
domain_response_instance = DomainResponse.from_json(json)
# print the JSON string representation of the object
print(DomainResponse.to_json())
# convert the object into a dict
domain_response_dict = domain_response_instance.to_dict()
# create an instance of DomainResponse from a dict
domain_response_from_dict = DomainResponse.from_dict(domain_response_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
# MyPermissionsResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**permissions** | **List[str]** | |
## Example
```python
from pulpcore.client.pulp_service.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]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
# 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 | Description | Notes
------------ | ------------- | ------------- | -------------
**users** | **List[str]** | | [optional] [default to []]
**groups** | **List[str]** | | [optional] [default to []]
**role** | **str** | |
## Example
```python
from pulpcore.client.pulp_service.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]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
# NestedRoleResponse
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 | Description | Notes
------------ | ------------- | ------------- | -------------
**users** | **List[str]** | | [optional] [default to []]
**groups** | **List[str]** | | [optional] [default to []]
**role** | **str** | |
## Example
```python
from pulpcore.client.pulp_service.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]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
# ObjectRolesResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**roles** | [**List[NestedRoleResponse]**](NestedRoleResponse.md) | |
## Example
```python
from pulpcore.client.pulp_service.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]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
# PaginatedserviceFeatureContentGuardResponseList
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**count** | **int** | |
**next** | **str** | | [optional]
**previous** | **str** | | [optional]
**results** | [**List[ServiceFeatureContentGuardResponse]**](ServiceFeatureContentGuardResponse.md) | |
## Example
```python
from pulpcore.client.pulp_service.models.paginatedservice_feature_content_guard_response_list import PaginatedserviceFeatureContentGuardResponseList
# TODO update the JSON string below
json = "{}"
# create an instance of PaginatedserviceFeatureContentGuardResponseList from a JSON string
paginatedservice_feature_content_guard_response_list_instance = PaginatedserviceFeatureContentGuardResponseList.from_json(json)
# print the JSON string representation of the object
print(PaginatedserviceFeatureContentGuardResponseList.to_json())
# convert the object into a dict
paginatedservice_feature_content_guard_response_list_dict = paginatedservice_feature_content_guard_response_list_instance.to_dict()
# create an instance of PaginatedserviceFeatureContentGuardResponseList from a dict
paginatedservice_feature_content_guard_response_list_from_dict = PaginatedserviceFeatureContentGuardResponseList.from_dict(paginatedservice_feature_content_guard_response_list_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
# PaginatedserviceVulnerabilityReportResponseList
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**count** | **int** | |
**next** | **str** | | [optional]
**previous** | **str** | | [optional]
**results** | [**List[ServiceVulnerabilityReportResponse]**](ServiceVulnerabilityReportResponse.md) | |
## Example
```python
from pulpcore.client.pulp_service.models.paginatedservice_vulnerability_report_response_list import PaginatedserviceVulnerabilityReportResponseList
# TODO update the JSON string below
json = "{}"
# create an instance of PaginatedserviceVulnerabilityReportResponseList from a JSON string
paginatedservice_vulnerability_report_response_list_instance = PaginatedserviceVulnerabilityReportResponseList.from_json(json)
# print the JSON string representation of the object
print(PaginatedserviceVulnerabilityReportResponseList.to_json())
# convert the object into a dict
paginatedservice_vulnerability_report_response_list_dict = paginatedservice_vulnerability_report_response_list_instance.to_dict()
# create an instance of PaginatedserviceVulnerabilityReportResponseList from a dict
paginatedservice_vulnerability_report_response_list_from_dict = PaginatedserviceVulnerabilityReportResponseList.from_dict(paginatedservice_vulnerability_report_response_list_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
# PaginatedTaskResponseList
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**count** | **int** | |
**next** | **str** | | [optional]
**previous** | **str** | | [optional]
**results** | [**List[TaskResponse]**](TaskResponse.md) | |
## Example
```python
from pulpcore.client.pulp_service.models.paginated_task_response_list import PaginatedTaskResponseList
# TODO update the JSON string below
json = "{}"
# create an instance of PaginatedTaskResponseList from a JSON string
paginated_task_response_list_instance = PaginatedTaskResponseList.from_json(json)
# print the JSON string representation of the object
print(PaginatedTaskResponseList.to_json())
# convert the object into a dict
paginated_task_response_list_dict = paginated_task_response_list_instance.to_dict()
# create an instance of PaginatedTaskResponseList from a dict
paginated_task_response_list_from_dict = PaginatedTaskResponseList.from_dict(paginated_task_response_list_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
# PatchedserviceFeatureContentGuard
A serializer for FeatureContentGuard.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | The unique name. | [optional]
**description** | **str** | An optional description. | [optional]
**header_name** | **str** | | [optional]
**jq_filter** | **str** | | [optional]
**features** | **List[str]** | The list of features required to access the content. | [optional]
## Example
```python
from pulpcore.client.pulp_service.models.patchedservice_feature_content_guard import PatchedserviceFeatureContentGuard
# TODO update the JSON string below
json = "{}"
# create an instance of PatchedserviceFeatureContentGuard from a JSON string
patchedservice_feature_content_guard_instance = PatchedserviceFeatureContentGuard.from_json(json)
# print the JSON string representation of the object
print(PatchedserviceFeatureContentGuard.to_json())
# convert the object into a dict
patchedservice_feature_content_guard_dict = patchedservice_feature_content_guard_instance.to_dict()
# create an instance of PatchedserviceFeatureContentGuard from a dict
patchedservice_feature_content_guard_from_dict = PatchedserviceFeatureContentGuard.from_dict(patchedservice_feature_content_guard_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
# ProgressReportResponse
Base serializer for use with [pulpcore.app.models.Model][] This ensures that all Serializers provide values for the 'pulp_href` field. The class provides a default for the ``ref_name`` attribute in the ModelSerializers's ``Meta`` class. This ensures that the OpenAPI definitions of plugins are namespaced properly.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**message** | **str** | The message shown to the user for the progress report. | [optional] [readonly]
**code** | **str** | Identifies the type of progress report'. | [optional] [readonly]
**state** | **str** | The current state of the progress report. The possible values are: 'waiting', 'skipped', 'running', 'completed', 'failed', 'canceled' and 'canceling'. The default is 'waiting'. | [optional] [readonly]
**total** | **int** | The total count of items. | [optional] [readonly]
**done** | **int** | The count of items already processed. Defaults to 0. | [optional] [readonly]
**suffix** | **str** | The suffix to be shown with the progress report. | [optional] [readonly]
## Example
```python
from pulpcore.client.pulp_service.models.progress_report_response import ProgressReportResponse
# TODO update the JSON string below
json = "{}"
# create an instance of ProgressReportResponse from a JSON string
progress_report_response_instance = ProgressReportResponse.from_json(json)
# print the JSON string representation of the object
print(ProgressReportResponse.to_json())
# convert the object into a dict
progress_report_response_dict = progress_report_response_instance.to_dict()
# create an instance of ProgressReportResponse from a dict
progress_report_response_from_dict = ProgressReportResponse.from_dict(progress_report_response_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
# ServiceFeatureContentGuard
A serializer for FeatureContentGuard.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | The unique name. |
**description** | **str** | An optional description. | [optional]
**header_name** | **str** | |
**jq_filter** | **str** | | [optional]
**features** | **List[str]** | The list of features required to access the content. |
## Example
```python
from pulpcore.client.pulp_service.models.service_feature_content_guard import ServiceFeatureContentGuard
# TODO update the JSON string below
json = "{}"
# create an instance of ServiceFeatureContentGuard from a JSON string
service_feature_content_guard_instance = ServiceFeatureContentGuard.from_json(json)
# print the JSON string representation of the object
print(ServiceFeatureContentGuard.to_json())
# convert the object into a dict
service_feature_content_guard_dict = service_feature_content_guard_instance.to_dict()
# create an instance of ServiceFeatureContentGuard from a dict
service_feature_content_guard_from_dict = ServiceFeatureContentGuard.from_dict(service_feature_content_guard_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
# ServiceFeatureContentGuardResponse
A serializer for FeatureContentGuard.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**pulp_href** | **str** | | [optional] [readonly]
**prn** | **str** | The Pulp Resource Name (PRN). | [optional] [readonly]
**pulp_created** | **datetime** | Timestamp of creation. | [optional] [readonly]
**pulp_last_updated** | **datetime** | Timestamp of the last time this resource was updated. Note: for immutable resources - like content, repository versions, and publication - pulp_created and pulp_last_updated dates will be the same. | [optional] [readonly]
**name** | **str** | The unique name. |
**description** | **str** | An optional description. | [optional]
**header_name** | **str** | |
**jq_filter** | **str** | | [optional]
**features** | **List[str]** | The list of features required to access the content. |
## Example
```python
from pulpcore.client.pulp_service.models.service_feature_content_guard_response import ServiceFeatureContentGuardResponse
# TODO update the JSON string below
json = "{}"
# create an instance of ServiceFeatureContentGuardResponse from a JSON string
service_feature_content_guard_response_instance = ServiceFeatureContentGuardResponse.from_json(json)
# print the JSON string representation of the object
print(ServiceFeatureContentGuardResponse.to_json())
# convert the object into a dict
service_feature_content_guard_response_dict = service_feature_content_guard_response_instance.to_dict()
# create an instance of ServiceFeatureContentGuardResponse from a dict
service_feature_content_guard_response_from_dict = ServiceFeatureContentGuardResponse.from_dict(service_feature_content_guard_response_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
# ServiceVulnerabilityReportResponse
A serializer for the VulnerabilityReport Model.
## 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]
**vulns** | **object** | |
## Example
```python
from pulpcore.client.pulp_service.models.service_vulnerability_report_response import ServiceVulnerabilityReportResponse
# TODO update the JSON string below
json = "{}"
# create an instance of ServiceVulnerabilityReportResponse from a JSON string
service_vulnerability_report_response_instance = ServiceVulnerabilityReportResponse.from_json(json)
# print the JSON string representation of the object
print(ServiceVulnerabilityReportResponse.to_json())
# convert the object into a dict
service_vulnerability_report_response_dict = service_vulnerability_report_response_instance.to_dict()
# create an instance of ServiceVulnerabilityReportResponse from a dict
service_vulnerability_report_response_from_dict = ServiceVulnerabilityReportResponse.from_dict(service_vulnerability_report_response_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
# StorageClassEnum
* `pulpcore.app.models.storage.FileSystem` - Use local filesystem as storage * `storages.backends.s3boto3.S3Boto3Storage` - Use Amazon S3 as storage * `storages.backends.azure_storage.AzureStorage` - Use Azure Blob as storage * `pulp_service.app.storage.OCIStorage` - Use OCI as storage
## Enum
* `PULPCORE_DOT_APP_DOT_MODELS_DOT_STORAGE_DOT_FILE_SYSTEM` (value: `'pulpcore.app.models.storage.FileSystem'`)
* `STORAGES_DOT_BACKENDS_DOT_S3BOTO3_DOT_S3_BOTO3_STORAGE` (value: `'storages.backends.s3boto3.S3Boto3Storage'`)
* `STORAGES_DOT_BACKENDS_DOT_AZURE_STORAGE_DOT_AZURE_STORAGE` (value: `'storages.backends.azure_storage.AzureStorage'`)
* `PULP_SERVICE_DOT_APP_DOT_STORAGE_DOT_OCI_STORAGE` (value: `'pulp_service.app.storage.OCIStorage'`)
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
# TaskResponse
Base serializer for use with [pulpcore.app.models.Model][] This ensures that all Serializers provide values for the 'pulp_href` field. The class provides a default for the ``ref_name`` attribute in the ModelSerializers's ``Meta`` class. This ensures that the OpenAPI definitions of plugins are namespaced properly.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**pulp_href** | **str** | | [optional] [readonly]
**prn** | **str** | The Pulp Resource Name (PRN). | [optional] [readonly]
**pulp_created** | **datetime** | Timestamp of creation. | [optional] [readonly]
**pulp_last_updated** | **datetime** | Timestamp of the last time this resource was updated. Note: for immutable resources - like content, repository versions, and publication - pulp_created and pulp_last_updated dates will be the same. | [optional] [readonly]
**state** | **str** | The current state of the task. The possible values include: 'waiting', 'skipped', 'running', 'completed', 'failed', 'canceled' and 'canceling'. | [optional] [readonly]
**name** | **str** | The name of task. |
**logging_cid** | **str** | The logging correlation id associated with this task |
**created_by** | **str** | User who dispatched this task. | [optional] [readonly]
**unblocked_at** | **datetime** | Timestamp of when this task was identified ready for pickup. | [optional] [readonly]
**started_at** | **datetime** | Timestamp of when this task started execution. | [optional] [readonly]
**finished_at** | **datetime** | Timestamp of when this task stopped execution. | [optional] [readonly]
**error** | **object** | A JSON Object of a fatal error encountered during the execution of this task. | [optional] [readonly]
**worker** | **str** | DEPRECATED - Always null | [optional] [readonly]
**parent_task** | **str** | The parent task that spawned this task. | [optional] [readonly]
**child_tasks** | **List[str]** | Any tasks spawned by this task. | [optional] [readonly]
**task_group** | **str** | The task group that this task is a member of. | [optional] [readonly]
**progress_reports** | [**List[ProgressReportResponse]**](ProgressReportResponse.md) | | [optional] [readonly]
**created_resources** | **List[str]** | Resources created by this task. | [optional] [readonly]
**reserved_resources_record** | **List[str]** | A list of resources required by that task. | [optional] [readonly]
**result** | **object** | The result of this task. | [optional] [readonly]
## Example
```python
from pulpcore.client.pulp_service.models.task_response import TaskResponse
# TODO update the JSON string below
json = "{}"
# create an instance of TaskResponse from a JSON string
task_response_instance = TaskResponse.from_json(json)
# print the JSON string representation of the object
print(TaskResponse.to_json())
# convert the object into a dict
task_response_dict = task_response_instance.to_dict()
# create an instance of TaskResponse from a dict
task_response_from_dict = TaskResponse.from_dict(task_response_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
# pulpcore.client.pulp_service.TasksApi
All URIs are relative to *https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com*
Method | HTTP request | Description
------------- | ------------- | -------------
[**admin_tasks**](TasksApi.md#admin_tasks) | **GET** /api/pulp/admin/tasks/ |
# **admin_tasks**
> PaginatedTaskResponseList admin_tasks(x_task_diagnostics=x_task_diagnostics, child_tasks=child_tasks, created_resources=created_resources, exclusive_resources=exclusive_resources, exclusive_resources__in=exclusive_resources__in, finished_at=finished_at, finished_at__gt=finished_at__gt, finished_at__gte=finished_at__gte, finished_at__isnull=finished_at__isnull, finished_at__lt=finished_at__lt, finished_at__lte=finished_at__lte, finished_at__range=finished_at__range, limit=limit, logging_cid=logging_cid, logging_cid__contains=logging_cid__contains, name=name, name__contains=name__contains, name__in=name__in, name__ne=name__ne, offset=offset, ordering=ordering, parent_task=parent_task, prn__in=prn__in, pulp_created=pulp_created, pulp_created__gt=pulp_created__gt, pulp_created__gte=pulp_created__gte, pulp_created__isnull=pulp_created__isnull, pulp_created__lt=pulp_created__lt, pulp_created__lte=pulp_created__lte, pulp_created__range=pulp_created__range, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, q=q, reserved_resources=reserved_resources, reserved_resources__in=reserved_resources__in, shared_resources=shared_resources, shared_resources__in=shared_resources__in, started_at=started_at, started_at__gt=started_at__gt, started_at__gte=started_at__gte, started_at__isnull=started_at__isnull, started_at__lt=started_at__lt, started_at__lte=started_at__lte, started_at__range=started_at__range, state=state, state__in=state__in, state__ne=state__ne, task_group=task_group, unblocked_at=unblocked_at, unblocked_at__gt=unblocked_at__gt, unblocked_at__gte=unblocked_at__gte, unblocked_at__isnull=unblocked_at__isnull, unblocked_at__lt=unblocked_at__lt, unblocked_at__lte=unblocked_at__lte, unblocked_at__range=unblocked_at__range, worker=worker, fields=fields, exclude_fields=exclude_fields)
A customized named ModelViewSet that knows how to register itself with the Pulp API router. This viewset is discoverable by its name. \"Normal\" Django Models and Master/Detail models are supported by the ``register_with`` method. Attributes: lookup_field (str): The name of the field by which an object should be looked up, in addition to any parent lookups if this ViewSet is nested. Defaults to 'pk' endpoint_name (str): The name of the final path segment that should identify the ViewSet's collection endpoint. nest_prefix (str): Optional prefix under which this ViewSet should be nested. This must correspond to the \"parent_prefix\" of a router with rest_framework_nested.NestedMixin. None indicates this ViewSet should not be nested. parent_lookup_kwargs (dict): Optional mapping of key names that would appear in self.kwargs to django model filter expressions that can be used with the corresponding value from self.kwargs, used only by a nested ViewSet to filter based on the parent object's identity. schema (DefaultSchema): The schema class to use by default in a viewset.
### Example
* OAuth Authentication (json_header_remote_authentication):
* Basic Authentication (basicAuth):
* Api Key Authentication (cookieAuth):
```python
import pulpcore.client.pulp_service
from pulpcore.client.pulp_service.models.paginated_task_response_list import PaginatedTaskResponseList
from pulpcore.client.pulp_service.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_service.Configuration(
host = "https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, 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_service.Configuration(
username = os.environ["USERNAME"],
password = os.environ["PASSWORD"]
)
# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) 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_service.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pulpcore.client.pulp_service.TasksApi(api_client)
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
child_tasks = 'child_tasks_example' # str | Filter results where child_tasks matches value (optional)
created_resources = 'created_resources_example' # str | (optional)
exclusive_resources = 'exclusive_resources_example' # str | (optional)
exclusive_resources__in = ['exclusive_resources__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
finished_at = '2013-10-20T19:20:30+01:00' # datetime | Filter results where finished_at matches value (optional)
finished_at__gt = '2013-10-20T19:20:30+01:00' # datetime | Filter results where finished_at is greater than value (optional)
finished_at__gte = '2013-10-20T19:20:30+01:00' # datetime | Filter results where finished_at is greater than or equal to value (optional)
finished_at__isnull = True # bool | Filter results where finished_at has a null value (optional)
finished_at__lt = '2013-10-20T19:20:30+01:00' # datetime | Filter results where finished_at is less than value (optional)
finished_at__lte = '2013-10-20T19:20:30+01:00' # datetime | Filter results where finished_at is less than or equal to value (optional)
finished_at__range = ['2013-10-20T19:20:30+01:00'] # List[datetime] | Filter results where finished_at is between two comma separated values (optional)
limit = 56 # int | Number of results to return per page. (optional)
logging_cid = 'logging_cid_example' # str | Filter results where logging_cid matches value (optional)
logging_cid__contains = 'logging_cid__contains_example' # str | Filter results where logging_cid contains value (optional)
name = 'name_example' # str | Filter results where name matches value (optional)
name__contains = 'name__contains_example' # str | Filter results where name contains value (optional)
name__in = ['name__in_example'] # List[str] | Filter results where name is in a comma-separated list of values (optional)
name__ne = 'name__ne_example' # str | Filter results where name not equal to value (optional)
offset = 56 # int | The initial index from which to return the results. (optional)
ordering = ['ordering_example'] # List[str] | Ordering * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `state` - State * `-state` - State (descending) * `name` - Name * `-name` - Name (descending) * `logging_cid` - Logging cid * `-logging_cid` - Logging cid (descending) * `unblocked_at` - Unblocked at * `-unblocked_at` - Unblocked at (descending) * `started_at` - Started at * `-started_at` - Started at (descending) * `finished_at` - Finished at * `-finished_at` - Finished at (descending) * `error` - Error * `-error` - Error (descending) * `enc_args` - Enc args * `-enc_args` - Enc args (descending) * `enc_kwargs` - Enc kwargs * `-enc_kwargs` - Enc kwargs (descending) * `reserved_resources_record` - Reserved resources record * `-reserved_resources_record` - Reserved resources record (descending) * `versions` - Versions * `-versions` - Versions (descending) * `profile_options` - Profile options * `-profile_options` - Profile options (descending) * `immediate` - Immediate * `-immediate` - Immediate (descending) * `deferred` - Deferred * `-deferred` - Deferred (descending) * `result` - Result * `-result` - Result (descending) * `pk` - Pk * `-pk` - Pk (descending) (optional)
parent_task = 'parent_task_example' # str | Filter results where parent_task matches value (optional)
prn__in = ['prn__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
pulp_created = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_created matches value (optional)
pulp_created__gt = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_created is greater than value (optional)
pulp_created__gte = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_created is greater than or equal to value (optional)
pulp_created__isnull = True # bool | Filter results where pulp_created has a null value (optional)
pulp_created__lt = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_created is less than value (optional)
pulp_created__lte = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_created is less than or equal to value (optional)
pulp_created__range = ['2013-10-20T19:20:30+01:00'] # List[datetime] | Filter results where pulp_created is between two comma separated values (optional)
pulp_href__in = ['pulp_href__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
pulp_id__in = ['pulp_id__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
q = 'q_example' # str | Filter results by using NOT, AND and OR operations on other filters (optional)
reserved_resources = 'reserved_resources_example' # str | (optional)
reserved_resources__in = ['reserved_resources__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
shared_resources = 'shared_resources_example' # str | (optional)
shared_resources__in = ['shared_resources__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
started_at = '2013-10-20T19:20:30+01:00' # datetime | Filter results where started_at matches value (optional)
started_at__gt = '2013-10-20T19:20:30+01:00' # datetime | Filter results where started_at is greater than value (optional)
started_at__gte = '2013-10-20T19:20:30+01:00' # datetime | Filter results where started_at is greater than or equal to value (optional)
started_at__isnull = True # bool | Filter results where started_at has a null value (optional)
started_at__lt = '2013-10-20T19:20:30+01:00' # datetime | Filter results where started_at is less than value (optional)
started_at__lte = '2013-10-20T19:20:30+01:00' # datetime | Filter results where started_at is less than or equal to value (optional)
started_at__range = ['2013-10-20T19:20:30+01:00'] # List[datetime] | Filter results where started_at is between two comma separated values (optional)
state = 'state_example' # str | Filter results where state matches value * `waiting` - Waiting * `skipped` - Skipped * `running` - Running * `completed` - Completed * `failed` - Failed * `canceled` - Canceled * `canceling` - Canceling (optional)
state__in = ['state__in_example'] # List[str] | Filter results where state is in a comma-separated list of values (optional)
state__ne = 'state__ne_example' # str | Filter results where state not equal to value (optional)
task_group = 'task_group_example' # str | Filter results where task_group matches value (optional)
unblocked_at = '2013-10-20T19:20:30+01:00' # datetime | Filter results where unblocked_at matches value (optional)
unblocked_at__gt = '2013-10-20T19:20:30+01:00' # datetime | Filter results where unblocked_at is greater than value (optional)
unblocked_at__gte = '2013-10-20T19:20:30+01:00' # datetime | Filter results where unblocked_at is greater than or equal to value (optional)
unblocked_at__isnull = True # bool | Filter results where unblocked_at has a null value (optional)
unblocked_at__lt = '2013-10-20T19:20:30+01:00' # datetime | Filter results where unblocked_at is less than value (optional)
unblocked_at__lte = '2013-10-20T19:20:30+01:00' # datetime | Filter results where unblocked_at is less than or equal to value (optional)
unblocked_at__range = ['2013-10-20T19:20:30+01:00'] # List[datetime] | Filter results where unblocked_at is between two comma separated values (optional)
worker = 'worker_example' # str | (optional)
fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)
try:
api_response = api_instance.admin_tasks(x_task_diagnostics=x_task_diagnostics, child_tasks=child_tasks, created_resources=created_resources, exclusive_resources=exclusive_resources, exclusive_resources__in=exclusive_resources__in, finished_at=finished_at, finished_at__gt=finished_at__gt, finished_at__gte=finished_at__gte, finished_at__isnull=finished_at__isnull, finished_at__lt=finished_at__lt, finished_at__lte=finished_at__lte, finished_at__range=finished_at__range, limit=limit, logging_cid=logging_cid, logging_cid__contains=logging_cid__contains, name=name, name__contains=name__contains, name__in=name__in, name__ne=name__ne, offset=offset, ordering=ordering, parent_task=parent_task, prn__in=prn__in, pulp_created=pulp_created, pulp_created__gt=pulp_created__gt, pulp_created__gte=pulp_created__gte, pulp_created__isnull=pulp_created__isnull, pulp_created__lt=pulp_created__lt, pulp_created__lte=pulp_created__lte, pulp_created__range=pulp_created__range, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, q=q, reserved_resources=reserved_resources, reserved_resources__in=reserved_resources__in, shared_resources=shared_resources, shared_resources__in=shared_resources__in, started_at=started_at, started_at__gt=started_at__gt, started_at__gte=started_at__gte, started_at__isnull=started_at__isnull, started_at__lt=started_at__lt, started_at__lte=started_at__lte, started_at__range=started_at__range, state=state, state__in=state__in, state__ne=state__ne, task_group=task_group, unblocked_at=unblocked_at, unblocked_at__gt=unblocked_at__gt, unblocked_at__gte=unblocked_at__gte, unblocked_at__isnull=unblocked_at__isnull, unblocked_at__lt=unblocked_at__lt, unblocked_at__lte=unblocked_at__lte, unblocked_at__range=unblocked_at__range, worker=worker, fields=fields, exclude_fields=exclude_fields)
print("The response of TasksApi->admin_tasks:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling TasksApi->admin_tasks: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
**child_tasks** | **str**| Filter results where child_tasks matches value | [optional]
**created_resources** | **str**| | [optional]
**exclusive_resources** | **str**| | [optional]
**exclusive_resources__in** | [**List[str]**](str.md)| Multiple values may be separated by commas. | [optional]
**finished_at** | **datetime**| Filter results where finished_at matches value | [optional]
**finished_at__gt** | **datetime**| Filter results where finished_at is greater than value | [optional]
**finished_at__gte** | **datetime**| Filter results where finished_at is greater than or equal to value | [optional]
**finished_at__isnull** | **bool**| Filter results where finished_at has a null value | [optional]
**finished_at__lt** | **datetime**| Filter results where finished_at is less than value | [optional]
**finished_at__lte** | **datetime**| Filter results where finished_at is less than or equal to value | [optional]
**finished_at__range** | [**List[datetime]**](datetime.md)| Filter results where finished_at is between two comma separated values | [optional]
**limit** | **int**| Number of results to return per page. | [optional]
**logging_cid** | **str**| Filter results where logging_cid matches value | [optional]
**logging_cid__contains** | **str**| Filter results where logging_cid contains value | [optional]
**name** | **str**| Filter results where name matches value | [optional]
**name__contains** | **str**| Filter results where name contains value | [optional]
**name__in** | [**List[str]**](str.md)| Filter results where name is in a comma-separated list of values | [optional]
**name__ne** | **str**| Filter results where name not equal to value | [optional]
**offset** | **int**| The initial index from which to return the results. | [optional]
**ordering** | [**List[str]**](str.md)| Ordering * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `state` - State * `-state` - State (descending) * `name` - Name * `-name` - Name (descending) * `logging_cid` - Logging cid * `-logging_cid` - Logging cid (descending) * `unblocked_at` - Unblocked at * `-unblocked_at` - Unblocked at (descending) * `started_at` - Started at * `-started_at` - Started at (descending) * `finished_at` - Finished at * `-finished_at` - Finished at (descending) * `error` - Error * `-error` - Error (descending) * `enc_args` - Enc args * `-enc_args` - Enc args (descending) * `enc_kwargs` - Enc kwargs * `-enc_kwargs` - Enc kwargs (descending) * `reserved_resources_record` - Reserved resources record * `-reserved_resources_record` - Reserved resources record (descending) * `versions` - Versions * `-versions` - Versions (descending) * `profile_options` - Profile options * `-profile_options` - Profile options (descending) * `immediate` - Immediate * `-immediate` - Immediate (descending) * `deferred` - Deferred * `-deferred` - Deferred (descending) * `result` - Result * `-result` - Result (descending) * `pk` - Pk * `-pk` - Pk (descending) | [optional]
**parent_task** | **str**| Filter results where parent_task matches value | [optional]
**prn__in** | [**List[str]**](str.md)| 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]**](datetime.md)| Filter results where pulp_created is between two comma separated values | [optional]
**pulp_href__in** | [**List[str]**](str.md)| Multiple values may be separated by commas. | [optional]
**pulp_id__in** | [**List[str]**](str.md)| Multiple values may be separated by commas. | [optional]
**q** | **str**| Filter results by using NOT, AND and OR operations on other filters | [optional]
**reserved_resources** | **str**| | [optional]
**reserved_resources__in** | [**List[str]**](str.md)| Multiple values may be separated by commas. | [optional]
**shared_resources** | **str**| | [optional]
**shared_resources__in** | [**List[str]**](str.md)| Multiple values may be separated by commas. | [optional]
**started_at** | **datetime**| Filter results where started_at matches value | [optional]
**started_at__gt** | **datetime**| Filter results where started_at is greater than value | [optional]
**started_at__gte** | **datetime**| Filter results where started_at is greater than or equal to value | [optional]
**started_at__isnull** | **bool**| Filter results where started_at has a null value | [optional]
**started_at__lt** | **datetime**| Filter results where started_at is less than value | [optional]
**started_at__lte** | **datetime**| Filter results where started_at is less than or equal to value | [optional]
**started_at__range** | [**List[datetime]**](datetime.md)| Filter results where started_at is between two comma separated values | [optional]
**state** | **str**| Filter results where state matches value * `waiting` - Waiting * `skipped` - Skipped * `running` - Running * `completed` - Completed * `failed` - Failed * `canceled` - Canceled * `canceling` - Canceling | [optional]
**state__in** | [**List[str]**](str.md)| Filter results where state is in a comma-separated list of values | [optional]
**state__ne** | **str**| Filter results where state not equal to value | [optional]
**task_group** | **str**| Filter results where task_group matches value | [optional]
**unblocked_at** | **datetime**| Filter results where unblocked_at matches value | [optional]
**unblocked_at__gt** | **datetime**| Filter results where unblocked_at is greater than value | [optional]
**unblocked_at__gte** | **datetime**| Filter results where unblocked_at is greater than or equal to value | [optional]
**unblocked_at__isnull** | **bool**| Filter results where unblocked_at has a null value | [optional]
**unblocked_at__lt** | **datetime**| Filter results where unblocked_at is less than value | [optional]
**unblocked_at__lte** | **datetime**| Filter results where unblocked_at is less than or equal to value | [optional]
**unblocked_at__range** | [**List[datetime]**](datetime.md)| Filter results where unblocked_at is between two comma separated values | [optional]
**worker** | **str**| | [optional]
**fields** | [**List[str]**](str.md)| A list of fields to include in the response. | [optional]
**exclude_fields** | [**List[str]**](str.md)| A list of fields to exclude from the response. | [optional]
### Return type
[**PaginatedTaskResponseList**](PaginatedTaskResponseList.md)
### Authorization
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#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]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# pulpcore.client.pulp_service.VulnReportServiceApi
All URIs are relative to *https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com*
Method | HTTP request | Description
------------- | ------------- | -------------
[**create**](VulnReportServiceApi.md#create) | **POST** /api/pulp/{pulp_domain}/api/v3/vuln_report_service/ | Generate vulnerability report
[**delete**](VulnReportServiceApi.md#delete) | **DELETE** {service_vulnerability_report_href} | Delete a vulnerability report
[**list**](VulnReportServiceApi.md#list) | **GET** /api/pulp/{pulp_domain}/api/v3/vuln_report_service/ | List vulnerability reports
[**read**](VulnReportServiceApi.md#read) | **GET** {service_vulnerability_report_href} | Inspect a vulnerability report
# **create**
> AsyncOperationResponse create(pulp_domain, x_task_diagnostics=x_task_diagnostics, repo_version=repo_version, package_json=package_json)
Generate vulnerability report
Trigger a task to generate the package vulnerability report
### Example
* OAuth Authentication (json_header_remote_authentication):
* Basic Authentication (basicAuth):
* Api Key Authentication (cookieAuth):
```python
import pulpcore.client.pulp_service
from pulpcore.client.pulp_service.models.async_operation_response import AsyncOperationResponse
from pulpcore.client.pulp_service.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_service.Configuration(
host = "https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, 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_service.Configuration(
username = os.environ["USERNAME"],
password = os.environ["PASSWORD"]
)
# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) 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_service.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pulpcore.client.pulp_service.VulnReportServiceApi(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)
repo_version = 'repo_version_example' # str | RepositoryVersion HREF with the packages to be checked. (optional)
package_json = None # bytearray | package-lock.json file with the definition of dependencies to be checked. (optional)
try:
# Generate vulnerability report
api_response = api_instance.create(pulp_domain, x_task_diagnostics=x_task_diagnostics, repo_version=repo_version, package_json=package_json)
print("The response of VulnReportServiceApi->create:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling VulnReportServiceApi->create: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**pulp_domain** | **str**| |
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
**repo_version** | **str**| RepositoryVersion HREF with the packages to be checked. | [optional]
**package_json** | **bytearray**| package-lock.json file with the definition of dependencies to be checked. | [optional]
### Return type
[**AsyncOperationResponse**](AsyncOperationResponse.md)
### Authorization
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
### HTTP request headers
- **Content-Type**: multipart/form-data, application/x-www-form-urlencoded
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**202** | | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **delete**
> delete(service_vulnerability_report_href, x_task_diagnostics=x_task_diagnostics)
Delete a vulnerability report
A customized named ModelViewSet that knows how to register itself with the Pulp API router. This viewset is discoverable by its name. \"Normal\" Django Models and Master/Detail models are supported by the ``register_with`` method. Attributes: lookup_field (str): The name of the field by which an object should be looked up, in addition to any parent lookups if this ViewSet is nested. Defaults to 'pk' endpoint_name (str): The name of the final path segment that should identify the ViewSet's collection endpoint. nest_prefix (str): Optional prefix under which this ViewSet should be nested. This must correspond to the \"parent_prefix\" of a router with rest_framework_nested.NestedMixin. None indicates this ViewSet should not be nested. parent_lookup_kwargs (dict): Optional mapping of key names that would appear in self.kwargs to django model filter expressions that can be used with the corresponding value from self.kwargs, used only by a nested ViewSet to filter based on the parent object's identity. schema (DefaultSchema): The schema class to use by default in a viewset.
### Example
* OAuth Authentication (json_header_remote_authentication):
* Basic Authentication (basicAuth):
* Api Key Authentication (cookieAuth):
```python
import pulpcore.client.pulp_service
from pulpcore.client.pulp_service.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_service.Configuration(
host = "https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, 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_service.Configuration(
username = os.environ["USERNAME"],
password = os.environ["PASSWORD"]
)
# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) 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_service.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pulpcore.client.pulp_service.VulnReportServiceApi(api_client)
service_vulnerability_report_href = 'service_vulnerability_report_href_example' # str |
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
try:
# Delete a vulnerability report
api_instance.delete(service_vulnerability_report_href, x_task_diagnostics=x_task_diagnostics)
except Exception as e:
print("Exception when calling VulnReportServiceApi->delete: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**service_vulnerability_report_href** | **str**| |
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
### Return type
void (empty response body)
### Authorization
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#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]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **list**
> PaginatedserviceVulnerabilityReportResponseList list(pulp_domain, x_task_diagnostics=x_task_diagnostics, limit=limit, offset=offset, fields=fields, exclude_fields=exclude_fields)
List vulnerability reports
A customized named ModelViewSet that knows how to register itself with the Pulp API router. This viewset is discoverable by its name. \"Normal\" Django Models and Master/Detail models are supported by the ``register_with`` method. Attributes: lookup_field (str): The name of the field by which an object should be looked up, in addition to any parent lookups if this ViewSet is nested. Defaults to 'pk' endpoint_name (str): The name of the final path segment that should identify the ViewSet's collection endpoint. nest_prefix (str): Optional prefix under which this ViewSet should be nested. This must correspond to the \"parent_prefix\" of a router with rest_framework_nested.NestedMixin. None indicates this ViewSet should not be nested. parent_lookup_kwargs (dict): Optional mapping of key names that would appear in self.kwargs to django model filter expressions that can be used with the corresponding value from self.kwargs, used only by a nested ViewSet to filter based on the parent object's identity. schema (DefaultSchema): The schema class to use by default in a viewset.
### Example
* OAuth Authentication (json_header_remote_authentication):
* Basic Authentication (basicAuth):
* Api Key Authentication (cookieAuth):
```python
import pulpcore.client.pulp_service
from pulpcore.client.pulp_service.models.paginatedservice_vulnerability_report_response_list import PaginatedserviceVulnerabilityReportResponseList
from pulpcore.client.pulp_service.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_service.Configuration(
host = "https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, 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_service.Configuration(
username = os.environ["USERNAME"],
password = os.environ["PASSWORD"]
)
# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) 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_service.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pulpcore.client.pulp_service.VulnReportServiceApi(api_client)
pulp_domain = 'pulp_domain_example' # str |
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
limit = 56 # int | Number of results to return per page. (optional)
offset = 56 # int | The initial index from which to return the results. (optional)
fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)
try:
# List vulnerability reports
api_response = api_instance.list(pulp_domain, x_task_diagnostics=x_task_diagnostics, limit=limit, offset=offset, fields=fields, exclude_fields=exclude_fields)
print("The response of VulnReportServiceApi->list:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling VulnReportServiceApi->list: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**pulp_domain** | **str**| |
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
**limit** | **int**| Number of results to return per page. | [optional]
**offset** | **int**| The initial index from which to return the results. | [optional]
**fields** | [**List[str]**](str.md)| A list of fields to include in the response. | [optional]
**exclude_fields** | [**List[str]**](str.md)| A list of fields to exclude from the response. | [optional]
### Return type
[**PaginatedserviceVulnerabilityReportResponseList**](PaginatedserviceVulnerabilityReportResponseList.md)
### Authorization
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#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]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **read**
> ServiceVulnerabilityReportResponse read(service_vulnerability_report_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
Inspect a vulnerability report
A customized named ModelViewSet that knows how to register itself with the Pulp API router. This viewset is discoverable by its name. \"Normal\" Django Models and Master/Detail models are supported by the ``register_with`` method. Attributes: lookup_field (str): The name of the field by which an object should be looked up, in addition to any parent lookups if this ViewSet is nested. Defaults to 'pk' endpoint_name (str): The name of the final path segment that should identify the ViewSet's collection endpoint. nest_prefix (str): Optional prefix under which this ViewSet should be nested. This must correspond to the \"parent_prefix\" of a router with rest_framework_nested.NestedMixin. None indicates this ViewSet should not be nested. parent_lookup_kwargs (dict): Optional mapping of key names that would appear in self.kwargs to django model filter expressions that can be used with the corresponding value from self.kwargs, used only by a nested ViewSet to filter based on the parent object's identity. schema (DefaultSchema): The schema class to use by default in a viewset.
### Example
* OAuth Authentication (json_header_remote_authentication):
* Basic Authentication (basicAuth):
* Api Key Authentication (cookieAuth):
```python
import pulpcore.client.pulp_service
from pulpcore.client.pulp_service.models.service_vulnerability_report_response import ServiceVulnerabilityReportResponse
from pulpcore.client.pulp_service.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_service.Configuration(
host = "https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, 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_service.Configuration(
username = os.environ["USERNAME"],
password = os.environ["PASSWORD"]
)
# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) 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_service.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pulpcore.client.pulp_service.VulnReportServiceApi(api_client)
service_vulnerability_report_href = 'service_vulnerability_report_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 vulnerability report
api_response = api_instance.read(service_vulnerability_report_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
print("The response of VulnReportServiceApi->read:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling VulnReportServiceApi->read: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**service_vulnerability_report_href** | **str**| |
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
**fields** | [**List[str]**](str.md)| A list of fields to include in the response. | [optional]
**exclude_fields** | [**List[str]**](str.md)| A list of fields to exclude from the response. | [optional]
### Return type
[**ServiceVulnerabilityReportResponse**](ServiceVulnerabilityReportResponse.md)
### Authorization
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#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]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
Raw data
{
"_id": null,
"home_page": null,
"name": "crc-pulp-service-client",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "pulp, pulpcore, client, Pulp 3 API",
"author": "Pulp Team",
"author_email": "pulp-list@redhat.com",
"download_url": "https://files.pythonhosted.org/packages/d7/56/89f20fea16f5bc45786412ebc6f6b12d814c4878afd2fc02e07b2021e19e/crc_pulp_service_client-20251030.1.tar.gz",
"platform": null,
"description": "# pulpcore.client.pulp_service.ApiCreateDomainApi\n\nAll URIs are relative to *https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com*\n\nMethod | HTTP request | Description\n------------- | ------------- | -------------\n[**post**](ApiCreateDomainApi.md#post) | **POST** /api/pulp/create-domain/ | Create domain\n\n\n# **post**\n> DomainResponse post(domain, x_task_diagnostics=x_task_diagnostics)\n\nCreate domain\n\nCreate a new domain for from S3 template domain, self-service path\n\n### Example\n\n* OAuth Authentication (json_header_remote_authentication):\n* Basic Authentication (basicAuth):\n* Api Key Authentication (cookieAuth):\n\n```python\nimport pulpcore.client.pulp_service\nfrom pulpcore.client.pulp_service.models.domain import Domain\nfrom pulpcore.client.pulp_service.models.domain_response import DomainResponse\nfrom pulpcore.client.pulp_service.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = pulpcore.client.pulp_service.Configuration(\n host = \"https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\nconfiguration.access_token = os.environ[\"ACCESS_TOKEN\"]\n\n# Configure HTTP basic authorization: basicAuth\nconfiguration = pulpcore.client.pulp_service.Configuration(\n username = os.environ[\"USERNAME\"],\n password = os.environ[\"PASSWORD\"]\n)\n\n# Configure API key authorization: cookieAuth\nconfiguration.api_key['cookieAuth'] = os.environ[\"API_KEY\"]\n\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['cookieAuth'] = 'Bearer'\n\n# Enter a context with an instance of the API client\nwith pulpcore.client.pulp_service.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = pulpcore.client.pulp_service.ApiCreateDomainApi(api_client)\n domain = pulpcore.client.pulp_service.Domain() # Domain | \n x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)\n\n try:\n # Create domain\n api_response = api_instance.post(domain, x_task_diagnostics=x_task_diagnostics)\n print(\"The response of ApiCreateDomainApi->post:\\n\")\n pprint(api_response)\n except Exception as e:\n print(\"Exception when calling ApiCreateDomainApi->post: %s\\n\" % e)\n```\n\n\n\n### Parameters\n\n\nName | Type | Description | Notes\n------------- | ------------- | ------------- | -------------\n **domain** | [**Domain**](Domain.md)| | \n **x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional] \n\n### Return type\n\n[**DomainResponse**](DomainResponse.md)\n\n### Authorization\n\n[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)\n\n### HTTP request headers\n\n - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data\n - **Accept**: application/json\n\n### HTTP response details\n\n| Status code | Description | Response headers |\n|-------------|-------------|------------------|\n**201** | | - |\n\n[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)\n\n# pulpcore.client.pulp_service.ApiDebugAuthHeaderApi\n\nAll URIs are relative to *https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com*\n\nMethod | HTTP request | Description\n------------- | ------------- | -------------\n[**get**](ApiDebugAuthHeaderApi.md#get) | **GET** /api/pulp/debug_auth_header/ | \n\n\n# **get**\n> get(x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)\n\n\n\nReturns the content of the authentication headers.\n\n### Example\n\n\n```python\nimport pulpcore.client.pulp_service\nfrom pulpcore.client.pulp_service.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = pulpcore.client.pulp_service.Configuration(\n host = \"https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\"\n)\n\n\n# Enter a context with an instance of the API client\nwith pulpcore.client.pulp_service.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = pulpcore.client.pulp_service.ApiDebugAuthHeaderApi(api_client)\n x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)\n fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)\n exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)\n\n try:\n api_instance.get(x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)\n except Exception as e:\n print(\"Exception when calling ApiDebugAuthHeaderApi->get: %s\\n\" % e)\n```\n\n\n\n### Parameters\n\n\nName | Type | Description | Notes\n------------- | ------------- | ------------- | -------------\n **x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional] \n **fields** | [**List[str]**](str.md)| A list of fields to include in the response. | [optional] \n **exclude_fields** | [**List[str]**](str.md)| A list of fields to exclude from the response. | [optional] \n\n### Return type\n\nvoid (empty response body)\n\n### Authorization\n\nNo authorization required\n\n### HTTP request headers\n\n - **Content-Type**: Not defined\n - **Accept**: Not defined\n\n### HTTP response details\n\n| Status code | Description | Response headers |\n|-------------|-------------|------------------|\n**200** | No response body | - |\n\n[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)\n\n# pulpcore.client.pulp_service.ApiTestRandomLockTasksApi\n\nAll URIs are relative to *https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com*\n\nMethod | HTTP request | Description\n------------- | ------------- | -------------\n[**get**](ApiTestRandomLockTasksApi.md#get) | **GET** /api/pulp/test/random_lock_tasks/ | \n\n\n# **get**\n> get(x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)\n\n\n\n### Example\n\n\n```python\nimport pulpcore.client.pulp_service\nfrom pulpcore.client.pulp_service.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = pulpcore.client.pulp_service.Configuration(\n host = \"https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\"\n)\n\n\n# Enter a context with an instance of the API client\nwith pulpcore.client.pulp_service.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = pulpcore.client.pulp_service.ApiTestRandomLockTasksApi(api_client)\n x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)\n fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)\n exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)\n\n try:\n api_instance.get(x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)\n except Exception as e:\n print(\"Exception when calling ApiTestRandomLockTasksApi->get: %s\\n\" % e)\n```\n\n\n\n### Parameters\n\n\nName | Type | Description | Notes\n------------- | ------------- | ------------- | -------------\n **x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional] \n **fields** | [**List[str]**](str.md)| A list of fields to include in the response. | [optional] \n **exclude_fields** | [**List[str]**](str.md)| A list of fields to exclude from the response. | [optional] \n\n### Return type\n\nvoid (empty response body)\n\n### Authorization\n\nNo authorization required\n\n### HTTP request headers\n\n - **Content-Type**: Not defined\n - **Accept**: Not defined\n\n### HTTP response details\n\n| Status code | Description | Response headers |\n|-------------|-------------|------------------|\n**200** | No response body | - |\n\n[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)\n\n# pulpcore.client.pulp_service.ApiTestTasksApi\n\nAll URIs are relative to *https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com*\n\nMethod | HTTP request | Description\n------------- | ------------- | -------------\n[**get**](ApiTestTasksApi.md#get) | **GET** /api/pulp/test/tasks/ | \n\n\n# **get**\n> get(x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)\n\n\n\n### Example\n\n\n```python\nimport pulpcore.client.pulp_service\nfrom pulpcore.client.pulp_service.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = pulpcore.client.pulp_service.Configuration(\n host = \"https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\"\n)\n\n\n# Enter a context with an instance of the API client\nwith pulpcore.client.pulp_service.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = pulpcore.client.pulp_service.ApiTestTasksApi(api_client)\n x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)\n fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)\n exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)\n\n try:\n api_instance.get(x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)\n except Exception as e:\n print(\"Exception when calling ApiTestTasksApi->get: %s\\n\" % e)\n```\n\n\n\n### Parameters\n\n\nName | Type | Description | Notes\n------------- | ------------- | ------------- | -------------\n **x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional] \n **fields** | [**List[str]**](str.md)| A list of fields to include in the response. | [optional] \n **exclude_fields** | [**List[str]**](str.md)| A list of fields to exclude from the response. | [optional] \n\n### Return type\n\nvoid (empty response body)\n\n### Authorization\n\nNo authorization required\n\n### HTTP request headers\n\n - **Content-Type**: Not defined\n - **Accept**: Not defined\n\n### HTTP response details\n\n| Status code | Description | Response headers |\n|-------------|-------------|------------------|\n**200** | No response body | - |\n\n[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)\n\n# AsyncOperationResponse\n\nSerializer for asynchronous operations.\n\n## Properties\n\nName | Type | Description | Notes\n------------ | ------------- | ------------- | -------------\n**task** | **str** | The href of the task. | \n\n## Example\n\n```python\nfrom pulpcore.client.pulp_service.models.async_operation_response import AsyncOperationResponse\n\n# TODO update the JSON string below\njson = \"{}\"\n# create an instance of AsyncOperationResponse from a JSON string\nasync_operation_response_instance = AsyncOperationResponse.from_json(json)\n# print the JSON string representation of the object\nprint(AsyncOperationResponse.to_json())\n\n# convert the object into a dict\nasync_operation_response_dict = async_operation_response_instance.to_dict()\n# create an instance of AsyncOperationResponse from a dict\nasync_operation_response_from_dict = AsyncOperationResponse.from_dict(async_operation_response_dict)\n```\n[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)\n\n\n# pulpcore.client.pulp_service.ContentguardsFeatureApi\n\nAll URIs are relative to *https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com*\n\nMethod | HTTP request | Description\n------------- | ------------- | -------------\n[**add_role**](ContentguardsFeatureApi.md#add_role) | **POST** {service_feature_content_guard_href}add_role/ | Add a role\n[**create**](ContentguardsFeatureApi.md#create) | **POST** /api/pulp/{pulp_domain}/api/v3/contentguards/service/feature/ | Create a feature content guard\n[**delete**](ContentguardsFeatureApi.md#delete) | **DELETE** {service_feature_content_guard_href} | Delete a feature content guard\n[**list**](ContentguardsFeatureApi.md#list) | **GET** /api/pulp/{pulp_domain}/api/v3/contentguards/service/feature/ | List feature content guards\n[**list_roles**](ContentguardsFeatureApi.md#list_roles) | **GET** {service_feature_content_guard_href}list_roles/ | List roles\n[**my_permissions**](ContentguardsFeatureApi.md#my_permissions) | **GET** {service_feature_content_guard_href}my_permissions/ | List user permissions\n[**partial_update**](ContentguardsFeatureApi.md#partial_update) | **PATCH** {service_feature_content_guard_href} | Update a feature content guard\n[**read**](ContentguardsFeatureApi.md#read) | **GET** {service_feature_content_guard_href} | Inspect a feature content guard\n[**remove_role**](ContentguardsFeatureApi.md#remove_role) | **POST** {service_feature_content_guard_href}remove_role/ | Remove a role\n[**update**](ContentguardsFeatureApi.md#update) | **PUT** {service_feature_content_guard_href} | Update a feature content guard\n\n\n# **add_role**\n> NestedRoleResponse add_role(service_feature_content_guard_href, nested_role, x_task_diagnostics=x_task_diagnostics)\n\nAdd a role\n\nAdd a role for this object to users/groups.\n\n### Example\n\n* OAuth Authentication (json_header_remote_authentication):\n* Basic Authentication (basicAuth):\n* Api Key Authentication (cookieAuth):\n\n```python\nimport pulpcore.client.pulp_service\nfrom pulpcore.client.pulp_service.models.nested_role import NestedRole\nfrom pulpcore.client.pulp_service.models.nested_role_response import NestedRoleResponse\nfrom pulpcore.client.pulp_service.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = pulpcore.client.pulp_service.Configuration(\n host = \"https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\nconfiguration.access_token = os.environ[\"ACCESS_TOKEN\"]\n\n# Configure HTTP basic authorization: basicAuth\nconfiguration = pulpcore.client.pulp_service.Configuration(\n username = os.environ[\"USERNAME\"],\n password = os.environ[\"PASSWORD\"]\n)\n\n# Configure API key authorization: cookieAuth\nconfiguration.api_key['cookieAuth'] = os.environ[\"API_KEY\"]\n\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['cookieAuth'] = 'Bearer'\n\n# Enter a context with an instance of the API client\nwith pulpcore.client.pulp_service.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = pulpcore.client.pulp_service.ContentguardsFeatureApi(api_client)\n service_feature_content_guard_href = 'service_feature_content_guard_href_example' # str | \n nested_role = pulpcore.client.pulp_service.NestedRole() # NestedRole | \n x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)\n\n try:\n # Add a role\n api_response = api_instance.add_role(service_feature_content_guard_href, nested_role, x_task_diagnostics=x_task_diagnostics)\n print(\"The response of ContentguardsFeatureApi->add_role:\\n\")\n pprint(api_response)\n except Exception as e:\n print(\"Exception when calling ContentguardsFeatureApi->add_role: %s\\n\" % e)\n```\n\n\n\n### Parameters\n\n\nName | Type | Description | Notes\n------------- | ------------- | ------------- | -------------\n **service_feature_content_guard_href** | **str**| | \n **nested_role** | [**NestedRole**](NestedRole.md)| | \n **x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional] \n\n### Return type\n\n[**NestedRoleResponse**](NestedRoleResponse.md)\n\n### Authorization\n\n[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)\n\n### HTTP request headers\n\n - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data\n - **Accept**: application/json\n\n### HTTP response details\n\n| Status code | Description | Response headers |\n|-------------|-------------|------------------|\n**201** | | - |\n\n[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)\n\n# **create**\n> ServiceFeatureContentGuardResponse create(pulp_domain, service_feature_content_guard, x_task_diagnostics=x_task_diagnostics)\n\nCreate a feature content guard\n\nContent guard to protect the content guarded by Subscription Features.\n\n### Example\n\n* OAuth Authentication (json_header_remote_authentication):\n* Basic Authentication (basicAuth):\n* Api Key Authentication (cookieAuth):\n\n```python\nimport pulpcore.client.pulp_service\nfrom pulpcore.client.pulp_service.models.service_feature_content_guard import ServiceFeatureContentGuard\nfrom pulpcore.client.pulp_service.models.service_feature_content_guard_response import ServiceFeatureContentGuardResponse\nfrom pulpcore.client.pulp_service.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = pulpcore.client.pulp_service.Configuration(\n host = \"https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\nconfiguration.access_token = os.environ[\"ACCESS_TOKEN\"]\n\n# Configure HTTP basic authorization: basicAuth\nconfiguration = pulpcore.client.pulp_service.Configuration(\n username = os.environ[\"USERNAME\"],\n password = os.environ[\"PASSWORD\"]\n)\n\n# Configure API key authorization: cookieAuth\nconfiguration.api_key['cookieAuth'] = os.environ[\"API_KEY\"]\n\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['cookieAuth'] = 'Bearer'\n\n# Enter a context with an instance of the API client\nwith pulpcore.client.pulp_service.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = pulpcore.client.pulp_service.ContentguardsFeatureApi(api_client)\n pulp_domain = 'pulp_domain_example' # str | \n service_feature_content_guard = pulpcore.client.pulp_service.ServiceFeatureContentGuard() # ServiceFeatureContentGuard | \n x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)\n\n try:\n # Create a feature content guard\n api_response = api_instance.create(pulp_domain, service_feature_content_guard, x_task_diagnostics=x_task_diagnostics)\n print(\"The response of ContentguardsFeatureApi->create:\\n\")\n pprint(api_response)\n except Exception as e:\n print(\"Exception when calling ContentguardsFeatureApi->create: %s\\n\" % e)\n```\n\n\n\n### Parameters\n\n\nName | Type | Description | Notes\n------------- | ------------- | ------------- | -------------\n **pulp_domain** | **str**| | \n **service_feature_content_guard** | [**ServiceFeatureContentGuard**](ServiceFeatureContentGuard.md)| | \n **x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional] \n\n### Return type\n\n[**ServiceFeatureContentGuardResponse**](ServiceFeatureContentGuardResponse.md)\n\n### Authorization\n\n[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)\n\n### HTTP request headers\n\n - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data\n - **Accept**: application/json\n\n### HTTP response details\n\n| Status code | Description | Response headers |\n|-------------|-------------|------------------|\n**201** | | - |\n\n[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)\n\n# **delete**\n> delete(service_feature_content_guard_href, x_task_diagnostics=x_task_diagnostics)\n\nDelete a feature content guard\n\nContent guard to protect the content guarded by Subscription Features.\n\n### Example\n\n* OAuth Authentication (json_header_remote_authentication):\n* Basic Authentication (basicAuth):\n* Api Key Authentication (cookieAuth):\n\n```python\nimport pulpcore.client.pulp_service\nfrom pulpcore.client.pulp_service.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = pulpcore.client.pulp_service.Configuration(\n host = \"https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\nconfiguration.access_token = os.environ[\"ACCESS_TOKEN\"]\n\n# Configure HTTP basic authorization: basicAuth\nconfiguration = pulpcore.client.pulp_service.Configuration(\n username = os.environ[\"USERNAME\"],\n password = os.environ[\"PASSWORD\"]\n)\n\n# Configure API key authorization: cookieAuth\nconfiguration.api_key['cookieAuth'] = os.environ[\"API_KEY\"]\n\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['cookieAuth'] = 'Bearer'\n\n# Enter a context with an instance of the API client\nwith pulpcore.client.pulp_service.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = pulpcore.client.pulp_service.ContentguardsFeatureApi(api_client)\n service_feature_content_guard_href = 'service_feature_content_guard_href_example' # str | \n x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)\n\n try:\n # Delete a feature content guard\n api_instance.delete(service_feature_content_guard_href, x_task_diagnostics=x_task_diagnostics)\n except Exception as e:\n print(\"Exception when calling ContentguardsFeatureApi->delete: %s\\n\" % e)\n```\n\n\n\n### Parameters\n\n\nName | Type | Description | Notes\n------------- | ------------- | ------------- | -------------\n **service_feature_content_guard_href** | **str**| | \n **x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional] \n\n### Return type\n\nvoid (empty response body)\n\n### Authorization\n\n[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)\n\n### HTTP request headers\n\n - **Content-Type**: Not defined\n - **Accept**: Not defined\n\n### HTTP response details\n\n| Status code | Description | Response headers |\n|-------------|-------------|------------------|\n**204** | No response body | - |\n\n[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)\n\n# **list**\n> PaginatedserviceFeatureContentGuardResponseList list(pulp_domain, x_task_diagnostics=x_task_diagnostics, limit=limit, name=name, name__contains=name__contains, name__icontains=name__icontains, name__iexact=name__iexact, name__in=name__in, name__iregex=name__iregex, name__istartswith=name__istartswith, name__regex=name__regex, name__startswith=name__startswith, offset=offset, ordering=ordering, prn__in=prn__in, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, q=q, fields=fields, exclude_fields=exclude_fields)\n\nList feature content guards\n\nContent guard to protect the content guarded by Subscription Features.\n\n### Example\n\n* OAuth Authentication (json_header_remote_authentication):\n* Basic Authentication (basicAuth):\n* Api Key Authentication (cookieAuth):\n\n```python\nimport pulpcore.client.pulp_service\nfrom pulpcore.client.pulp_service.models.paginatedservice_feature_content_guard_response_list import PaginatedserviceFeatureContentGuardResponseList\nfrom pulpcore.client.pulp_service.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = pulpcore.client.pulp_service.Configuration(\n host = \"https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\nconfiguration.access_token = os.environ[\"ACCESS_TOKEN\"]\n\n# Configure HTTP basic authorization: basicAuth\nconfiguration = pulpcore.client.pulp_service.Configuration(\n username = os.environ[\"USERNAME\"],\n password = os.environ[\"PASSWORD\"]\n)\n\n# Configure API key authorization: cookieAuth\nconfiguration.api_key['cookieAuth'] = os.environ[\"API_KEY\"]\n\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['cookieAuth'] = 'Bearer'\n\n# Enter a context with an instance of the API client\nwith pulpcore.client.pulp_service.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = pulpcore.client.pulp_service.ContentguardsFeatureApi(api_client)\n pulp_domain = 'pulp_domain_example' # str | \n x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)\n limit = 56 # int | Number of results to return per page. (optional)\n name = 'name_example' # str | Filter results where name matches value (optional)\n name__contains = 'name__contains_example' # str | Filter results where name contains value (optional)\n name__icontains = 'name__icontains_example' # str | Filter results where name contains value (optional)\n name__iexact = 'name__iexact_example' # str | Filter results where name matches value (optional)\n name__in = ['name__in_example'] # List[str] | Filter results where name is in a comma-separated list of values (optional)\n name__iregex = 'name__iregex_example' # str | Filter results where name matches regex value (optional)\n name__istartswith = 'name__istartswith_example' # str | Filter results where name starts with value (optional)\n name__regex = 'name__regex_example' # str | Filter results where name matches regex value (optional)\n name__startswith = 'name__startswith_example' # str | Filter results where name starts with value (optional)\n offset = 56 # int | The initial index from which to return the results. (optional)\n ordering = ['ordering_example'] # List[str] | Ordering * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `name` - Name * `-name` - Name (descending) * `description` - Description * `-description` - Description (descending) * `pk` - Pk * `-pk` - Pk (descending) (optional)\n prn__in = ['prn__in_example'] # List[str] | Multiple values may be separated by commas. (optional)\n pulp_href__in = ['pulp_href__in_example'] # List[str] | Multiple values may be separated by commas. (optional)\n pulp_id__in = ['pulp_id__in_example'] # List[str] | Multiple values may be separated by commas. (optional)\n q = 'q_example' # str | Filter results by using NOT, AND and OR operations on other filters (optional)\n fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)\n exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)\n\n try:\n # List feature content guards\n api_response = api_instance.list(pulp_domain, x_task_diagnostics=x_task_diagnostics, limit=limit, name=name, name__contains=name__contains, name__icontains=name__icontains, name__iexact=name__iexact, name__in=name__in, name__iregex=name__iregex, name__istartswith=name__istartswith, name__regex=name__regex, name__startswith=name__startswith, offset=offset, ordering=ordering, prn__in=prn__in, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, q=q, fields=fields, exclude_fields=exclude_fields)\n print(\"The response of ContentguardsFeatureApi->list:\\n\")\n pprint(api_response)\n except Exception as e:\n print(\"Exception when calling ContentguardsFeatureApi->list: %s\\n\" % e)\n```\n\n\n\n### Parameters\n\n\nName | Type | Description | Notes\n------------- | ------------- | ------------- | -------------\n **pulp_domain** | **str**| | \n **x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional] \n **limit** | **int**| Number of results to return per page. | [optional] \n **name** | **str**| Filter results where name matches value | [optional] \n **name__contains** | **str**| Filter results where name contains value | [optional] \n **name__icontains** | **str**| Filter results where name contains value | [optional] \n **name__iexact** | **str**| Filter results where name matches value | [optional] \n **name__in** | [**List[str]**](str.md)| Filter results where name is in a comma-separated list of values | [optional] \n **name__iregex** | **str**| Filter results where name matches regex value | [optional] \n **name__istartswith** | **str**| Filter results where name starts with value | [optional] \n **name__regex** | **str**| Filter results where name matches regex value | [optional] \n **name__startswith** | **str**| Filter results where name starts with value | [optional] \n **offset** | **int**| The initial index from which to return the results. | [optional] \n **ordering** | [**List[str]**](str.md)| Ordering * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `name` - Name * `-name` - Name (descending) * `description` - Description * `-description` - Description (descending) * `pk` - Pk * `-pk` - Pk (descending) | [optional] \n **prn__in** | [**List[str]**](str.md)| Multiple values may be separated by commas. | [optional] \n **pulp_href__in** | [**List[str]**](str.md)| Multiple values may be separated by commas. | [optional] \n **pulp_id__in** | [**List[str]**](str.md)| Multiple values may be separated by commas. | [optional] \n **q** | **str**| Filter results by using NOT, AND and OR operations on other filters | [optional] \n **fields** | [**List[str]**](str.md)| A list of fields to include in the response. | [optional] \n **exclude_fields** | [**List[str]**](str.md)| A list of fields to exclude from the response. | [optional] \n\n### Return type\n\n[**PaginatedserviceFeatureContentGuardResponseList**](PaginatedserviceFeatureContentGuardResponseList.md)\n\n### Authorization\n\n[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)\n\n### HTTP request headers\n\n - **Content-Type**: Not defined\n - **Accept**: application/json\n\n### HTTP response details\n\n| Status code | Description | Response headers |\n|-------------|-------------|------------------|\n**200** | | - |\n\n[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)\n\n# **list_roles**\n> ObjectRolesResponse list_roles(service_feature_content_guard_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)\n\nList roles\n\nList roles assigned to this object.\n\n### Example\n\n* OAuth Authentication (json_header_remote_authentication):\n* Basic Authentication (basicAuth):\n* Api Key Authentication (cookieAuth):\n\n```python\nimport pulpcore.client.pulp_service\nfrom pulpcore.client.pulp_service.models.object_roles_response import ObjectRolesResponse\nfrom pulpcore.client.pulp_service.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = pulpcore.client.pulp_service.Configuration(\n host = \"https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\nconfiguration.access_token = os.environ[\"ACCESS_TOKEN\"]\n\n# Configure HTTP basic authorization: basicAuth\nconfiguration = pulpcore.client.pulp_service.Configuration(\n username = os.environ[\"USERNAME\"],\n password = os.environ[\"PASSWORD\"]\n)\n\n# Configure API key authorization: cookieAuth\nconfiguration.api_key['cookieAuth'] = os.environ[\"API_KEY\"]\n\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['cookieAuth'] = 'Bearer'\n\n# Enter a context with an instance of the API client\nwith pulpcore.client.pulp_service.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = pulpcore.client.pulp_service.ContentguardsFeatureApi(api_client)\n service_feature_content_guard_href = 'service_feature_content_guard_href_example' # str | \n x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)\n fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)\n exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)\n\n try:\n # List roles\n api_response = api_instance.list_roles(service_feature_content_guard_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)\n print(\"The response of ContentguardsFeatureApi->list_roles:\\n\")\n pprint(api_response)\n except Exception as e:\n print(\"Exception when calling ContentguardsFeatureApi->list_roles: %s\\n\" % e)\n```\n\n\n\n### Parameters\n\n\nName | Type | Description | Notes\n------------- | ------------- | ------------- | -------------\n **service_feature_content_guard_href** | **str**| | \n **x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional] \n **fields** | [**List[str]**](str.md)| A list of fields to include in the response. | [optional] \n **exclude_fields** | [**List[str]**](str.md)| A list of fields to exclude from the response. | [optional] \n\n### Return type\n\n[**ObjectRolesResponse**](ObjectRolesResponse.md)\n\n### Authorization\n\n[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)\n\n### HTTP request headers\n\n - **Content-Type**: Not defined\n - **Accept**: application/json\n\n### HTTP response details\n\n| Status code | Description | Response headers |\n|-------------|-------------|------------------|\n**200** | | - |\n\n[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)\n\n# **my_permissions**\n> MyPermissionsResponse my_permissions(service_feature_content_guard_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)\n\nList user permissions\n\nList permissions available to the current user on this object.\n\n### Example\n\n* OAuth Authentication (json_header_remote_authentication):\n* Basic Authentication (basicAuth):\n* Api Key Authentication (cookieAuth):\n\n```python\nimport pulpcore.client.pulp_service\nfrom pulpcore.client.pulp_service.models.my_permissions_response import MyPermissionsResponse\nfrom pulpcore.client.pulp_service.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = pulpcore.client.pulp_service.Configuration(\n host = \"https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\nconfiguration.access_token = os.environ[\"ACCESS_TOKEN\"]\n\n# Configure HTTP basic authorization: basicAuth\nconfiguration = pulpcore.client.pulp_service.Configuration(\n username = os.environ[\"USERNAME\"],\n password = os.environ[\"PASSWORD\"]\n)\n\n# Configure API key authorization: cookieAuth\nconfiguration.api_key['cookieAuth'] = os.environ[\"API_KEY\"]\n\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['cookieAuth'] = 'Bearer'\n\n# Enter a context with an instance of the API client\nwith pulpcore.client.pulp_service.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = pulpcore.client.pulp_service.ContentguardsFeatureApi(api_client)\n service_feature_content_guard_href = 'service_feature_content_guard_href_example' # str | \n x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)\n fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)\n exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)\n\n try:\n # List user permissions\n api_response = api_instance.my_permissions(service_feature_content_guard_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)\n print(\"The response of ContentguardsFeatureApi->my_permissions:\\n\")\n pprint(api_response)\n except Exception as e:\n print(\"Exception when calling ContentguardsFeatureApi->my_permissions: %s\\n\" % e)\n```\n\n\n\n### Parameters\n\n\nName | Type | Description | Notes\n------------- | ------------- | ------------- | -------------\n **service_feature_content_guard_href** | **str**| | \n **x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional] \n **fields** | [**List[str]**](str.md)| A list of fields to include in the response. | [optional] \n **exclude_fields** | [**List[str]**](str.md)| A list of fields to exclude from the response. | [optional] \n\n### Return type\n\n[**MyPermissionsResponse**](MyPermissionsResponse.md)\n\n### Authorization\n\n[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)\n\n### HTTP request headers\n\n - **Content-Type**: Not defined\n - **Accept**: application/json\n\n### HTTP response details\n\n| Status code | Description | Response headers |\n|-------------|-------------|------------------|\n**200** | | - |\n\n[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)\n\n# **partial_update**\n> ServiceFeatureContentGuardResponse partial_update(service_feature_content_guard_href, patchedservice_feature_content_guard, x_task_diagnostics=x_task_diagnostics)\n\nUpdate a feature content guard\n\nContent guard to protect the content guarded by Subscription Features.\n\n### Example\n\n* OAuth Authentication (json_header_remote_authentication):\n* Basic Authentication (basicAuth):\n* Api Key Authentication (cookieAuth):\n\n```python\nimport pulpcore.client.pulp_service\nfrom pulpcore.client.pulp_service.models.patchedservice_feature_content_guard import PatchedserviceFeatureContentGuard\nfrom pulpcore.client.pulp_service.models.service_feature_content_guard_response import ServiceFeatureContentGuardResponse\nfrom pulpcore.client.pulp_service.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = pulpcore.client.pulp_service.Configuration(\n host = \"https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\nconfiguration.access_token = os.environ[\"ACCESS_TOKEN\"]\n\n# Configure HTTP basic authorization: basicAuth\nconfiguration = pulpcore.client.pulp_service.Configuration(\n username = os.environ[\"USERNAME\"],\n password = os.environ[\"PASSWORD\"]\n)\n\n# Configure API key authorization: cookieAuth\nconfiguration.api_key['cookieAuth'] = os.environ[\"API_KEY\"]\n\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['cookieAuth'] = 'Bearer'\n\n# Enter a context with an instance of the API client\nwith pulpcore.client.pulp_service.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = pulpcore.client.pulp_service.ContentguardsFeatureApi(api_client)\n service_feature_content_guard_href = 'service_feature_content_guard_href_example' # str | \n patchedservice_feature_content_guard = pulpcore.client.pulp_service.PatchedserviceFeatureContentGuard() # PatchedserviceFeatureContentGuard | \n x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)\n\n try:\n # Update a feature content guard\n api_response = api_instance.partial_update(service_feature_content_guard_href, patchedservice_feature_content_guard, x_task_diagnostics=x_task_diagnostics)\n print(\"The response of ContentguardsFeatureApi->partial_update:\\n\")\n pprint(api_response)\n except Exception as e:\n print(\"Exception when calling ContentguardsFeatureApi->partial_update: %s\\n\" % e)\n```\n\n\n\n### Parameters\n\n\nName | Type | Description | Notes\n------------- | ------------- | ------------- | -------------\n **service_feature_content_guard_href** | **str**| | \n **patchedservice_feature_content_guard** | [**PatchedserviceFeatureContentGuard**](PatchedserviceFeatureContentGuard.md)| | \n **x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional] \n\n### Return type\n\n[**ServiceFeatureContentGuardResponse**](ServiceFeatureContentGuardResponse.md)\n\n### Authorization\n\n[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)\n\n### HTTP request headers\n\n - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data\n - **Accept**: application/json\n\n### HTTP response details\n\n| Status code | Description | Response headers |\n|-------------|-------------|------------------|\n**200** | | - |\n\n[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)\n\n# **read**\n> ServiceFeatureContentGuardResponse read(service_feature_content_guard_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)\n\nInspect a feature content guard\n\nContent guard to protect the content guarded by Subscription Features.\n\n### Example\n\n* OAuth Authentication (json_header_remote_authentication):\n* Basic Authentication (basicAuth):\n* Api Key Authentication (cookieAuth):\n\n```python\nimport pulpcore.client.pulp_service\nfrom pulpcore.client.pulp_service.models.service_feature_content_guard_response import ServiceFeatureContentGuardResponse\nfrom pulpcore.client.pulp_service.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = pulpcore.client.pulp_service.Configuration(\n host = \"https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\nconfiguration.access_token = os.environ[\"ACCESS_TOKEN\"]\n\n# Configure HTTP basic authorization: basicAuth\nconfiguration = pulpcore.client.pulp_service.Configuration(\n username = os.environ[\"USERNAME\"],\n password = os.environ[\"PASSWORD\"]\n)\n\n# Configure API key authorization: cookieAuth\nconfiguration.api_key['cookieAuth'] = os.environ[\"API_KEY\"]\n\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['cookieAuth'] = 'Bearer'\n\n# Enter a context with an instance of the API client\nwith pulpcore.client.pulp_service.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = pulpcore.client.pulp_service.ContentguardsFeatureApi(api_client)\n service_feature_content_guard_href = 'service_feature_content_guard_href_example' # str | \n x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)\n fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)\n exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)\n\n try:\n # Inspect a feature content guard\n api_response = api_instance.read(service_feature_content_guard_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)\n print(\"The response of ContentguardsFeatureApi->read:\\n\")\n pprint(api_response)\n except Exception as e:\n print(\"Exception when calling ContentguardsFeatureApi->read: %s\\n\" % e)\n```\n\n\n\n### Parameters\n\n\nName | Type | Description | Notes\n------------- | ------------- | ------------- | -------------\n **service_feature_content_guard_href** | **str**| | \n **x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional] \n **fields** | [**List[str]**](str.md)| A list of fields to include in the response. | [optional] \n **exclude_fields** | [**List[str]**](str.md)| A list of fields to exclude from the response. | [optional] \n\n### Return type\n\n[**ServiceFeatureContentGuardResponse**](ServiceFeatureContentGuardResponse.md)\n\n### Authorization\n\n[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)\n\n### HTTP request headers\n\n - **Content-Type**: Not defined\n - **Accept**: application/json\n\n### HTTP response details\n\n| Status code | Description | Response headers |\n|-------------|-------------|------------------|\n**200** | | - |\n\n[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)\n\n# **remove_role**\n> NestedRoleResponse remove_role(service_feature_content_guard_href, nested_role, x_task_diagnostics=x_task_diagnostics)\n\nRemove a role\n\nRemove a role for this object from users/groups.\n\n### Example\n\n* OAuth Authentication (json_header_remote_authentication):\n* Basic Authentication (basicAuth):\n* Api Key Authentication (cookieAuth):\n\n```python\nimport pulpcore.client.pulp_service\nfrom pulpcore.client.pulp_service.models.nested_role import NestedRole\nfrom pulpcore.client.pulp_service.models.nested_role_response import NestedRoleResponse\nfrom pulpcore.client.pulp_service.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = pulpcore.client.pulp_service.Configuration(\n host = \"https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\nconfiguration.access_token = os.environ[\"ACCESS_TOKEN\"]\n\n# Configure HTTP basic authorization: basicAuth\nconfiguration = pulpcore.client.pulp_service.Configuration(\n username = os.environ[\"USERNAME\"],\n password = os.environ[\"PASSWORD\"]\n)\n\n# Configure API key authorization: cookieAuth\nconfiguration.api_key['cookieAuth'] = os.environ[\"API_KEY\"]\n\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['cookieAuth'] = 'Bearer'\n\n# Enter a context with an instance of the API client\nwith pulpcore.client.pulp_service.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = pulpcore.client.pulp_service.ContentguardsFeatureApi(api_client)\n service_feature_content_guard_href = 'service_feature_content_guard_href_example' # str | \n nested_role = pulpcore.client.pulp_service.NestedRole() # NestedRole | \n x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)\n\n try:\n # Remove a role\n api_response = api_instance.remove_role(service_feature_content_guard_href, nested_role, x_task_diagnostics=x_task_diagnostics)\n print(\"The response of ContentguardsFeatureApi->remove_role:\\n\")\n pprint(api_response)\n except Exception as e:\n print(\"Exception when calling ContentguardsFeatureApi->remove_role: %s\\n\" % e)\n```\n\n\n\n### Parameters\n\n\nName | Type | Description | Notes\n------------- | ------------- | ------------- | -------------\n **service_feature_content_guard_href** | **str**| | \n **nested_role** | [**NestedRole**](NestedRole.md)| | \n **x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional] \n\n### Return type\n\n[**NestedRoleResponse**](NestedRoleResponse.md)\n\n### Authorization\n\n[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)\n\n### HTTP request headers\n\n - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data\n - **Accept**: application/json\n\n### HTTP response details\n\n| Status code | Description | Response headers |\n|-------------|-------------|------------------|\n**201** | | - |\n\n[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)\n\n# **update**\n> ServiceFeatureContentGuardResponse update(service_feature_content_guard_href, service_feature_content_guard, x_task_diagnostics=x_task_diagnostics)\n\nUpdate a feature content guard\n\nContent guard to protect the content guarded by Subscription Features.\n\n### Example\n\n* OAuth Authentication (json_header_remote_authentication):\n* Basic Authentication (basicAuth):\n* Api Key Authentication (cookieAuth):\n\n```python\nimport pulpcore.client.pulp_service\nfrom pulpcore.client.pulp_service.models.service_feature_content_guard import ServiceFeatureContentGuard\nfrom pulpcore.client.pulp_service.models.service_feature_content_guard_response import ServiceFeatureContentGuardResponse\nfrom pulpcore.client.pulp_service.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = pulpcore.client.pulp_service.Configuration(\n host = \"https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\nconfiguration.access_token = os.environ[\"ACCESS_TOKEN\"]\n\n# Configure HTTP basic authorization: basicAuth\nconfiguration = pulpcore.client.pulp_service.Configuration(\n username = os.environ[\"USERNAME\"],\n password = os.environ[\"PASSWORD\"]\n)\n\n# Configure API key authorization: cookieAuth\nconfiguration.api_key['cookieAuth'] = os.environ[\"API_KEY\"]\n\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['cookieAuth'] = 'Bearer'\n\n# Enter a context with an instance of the API client\nwith pulpcore.client.pulp_service.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = pulpcore.client.pulp_service.ContentguardsFeatureApi(api_client)\n service_feature_content_guard_href = 'service_feature_content_guard_href_example' # str | \n service_feature_content_guard = pulpcore.client.pulp_service.ServiceFeatureContentGuard() # ServiceFeatureContentGuard | \n x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)\n\n try:\n # Update a feature content guard\n api_response = api_instance.update(service_feature_content_guard_href, service_feature_content_guard, x_task_diagnostics=x_task_diagnostics)\n print(\"The response of ContentguardsFeatureApi->update:\\n\")\n pprint(api_response)\n except Exception as e:\n print(\"Exception when calling ContentguardsFeatureApi->update: %s\\n\" % e)\n```\n\n\n\n### Parameters\n\n\nName | Type | Description | Notes\n------------- | ------------- | ------------- | -------------\n **service_feature_content_guard_href** | **str**| | \n **service_feature_content_guard** | [**ServiceFeatureContentGuard**](ServiceFeatureContentGuard.md)| | \n **x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional] \n\n### Return type\n\n[**ServiceFeatureContentGuardResponse**](ServiceFeatureContentGuardResponse.md)\n\n### Authorization\n\n[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)\n\n### HTTP request headers\n\n - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data\n - **Accept**: application/json\n\n### HTTP response details\n\n| Status code | Description | Response headers |\n|-------------|-------------|------------------|\n**200** | | - |\n\n[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)\n\n# Domain\n\nSerializer for Domain.\n\n## Properties\n\nName | Type | Description | Notes\n------------ | ------------- | ------------- | -------------\n**name** | **str** | A name for this domain. | \n**description** | **str** | An optional description. | [optional] \n**pulp_labels** | **Dict[str, Optional[str]]** | | [optional] \n**storage_class** | [**StorageClassEnum**](StorageClassEnum.md) | Backend storage class for domain. * `pulpcore.app.models.storage.FileSystem` - Use local filesystem as storage * `storages.backends.s3boto3.S3Boto3Storage` - Use Amazon S3 as storage * `storages.backends.azure_storage.AzureStorage` - Use Azure Blob as storage * `pulp_service.app.storage.OCIStorage` - Use OCI as storage | \n**storage_settings** | **object** | Settings for storage class. | \n**redirect_to_object_storage** | **bool** | Boolean to have the content app redirect to object storage. | [optional] [default to True]\n**hide_guarded_distributions** | **bool** | Boolean to hide distributions with a content guard in the content app. | [optional] [default to False]\n\n## Example\n\n```python\nfrom pulpcore.client.pulp_service.models.domain import Domain\n\n# TODO update the JSON string below\njson = \"{}\"\n# create an instance of Domain from a JSON string\ndomain_instance = Domain.from_json(json)\n# print the JSON string representation of the object\nprint(Domain.to_json())\n\n# convert the object into a dict\ndomain_dict = domain_instance.to_dict()\n# create an instance of Domain from a dict\ndomain_from_dict = Domain.from_dict(domain_dict)\n```\n[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)\n\n\n# DomainResponse\n\nSerializer for Domain.\n\n## Properties\n\nName | Type | Description | Notes\n------------ | ------------- | ------------- | -------------\n**pulp_href** | **str** | | [optional] [readonly] \n**prn** | **str** | The Pulp Resource Name (PRN). | [optional] [readonly] \n**pulp_created** | **datetime** | Timestamp of creation. | [optional] [readonly] \n**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] \n**name** | **str** | A name for this domain. | \n**description** | **str** | An optional description. | [optional] \n**pulp_labels** | **Dict[str, Optional[str]]** | | [optional] \n**storage_class** | [**StorageClassEnum**](StorageClassEnum.md) | Backend storage class for domain. * `pulpcore.app.models.storage.FileSystem` - Use local filesystem as storage * `storages.backends.s3boto3.S3Boto3Storage` - Use Amazon S3 as storage * `storages.backends.azure_storage.AzureStorage` - Use Azure Blob as storage * `pulp_service.app.storage.OCIStorage` - Use OCI as storage | \n**storage_settings** | **object** | Settings for storage class. | \n**redirect_to_object_storage** | **bool** | Boolean to have the content app redirect to object storage. | [optional] [default to True]\n**hide_guarded_distributions** | **bool** | Boolean to hide distributions with a content guard in the content app. | [optional] [default to False]\n\n## Example\n\n```python\nfrom pulpcore.client.pulp_service.models.domain_response import DomainResponse\n\n# TODO update the JSON string below\njson = \"{}\"\n# create an instance of DomainResponse from a JSON string\ndomain_response_instance = DomainResponse.from_json(json)\n# print the JSON string representation of the object\nprint(DomainResponse.to_json())\n\n# convert the object into a dict\ndomain_response_dict = domain_response_instance.to_dict()\n# create an instance of DomainResponse from a dict\ndomain_response_from_dict = DomainResponse.from_dict(domain_response_dict)\n```\n[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)\n\n\n# MyPermissionsResponse\n\n\n## Properties\n\nName | Type | Description | Notes\n------------ | ------------- | ------------- | -------------\n**permissions** | **List[str]** | | \n\n## Example\n\n```python\nfrom pulpcore.client.pulp_service.models.my_permissions_response import MyPermissionsResponse\n\n# TODO update the JSON string below\njson = \"{}\"\n# create an instance of MyPermissionsResponse from a JSON string\nmy_permissions_response_instance = MyPermissionsResponse.from_json(json)\n# print the JSON string representation of the object\nprint(MyPermissionsResponse.to_json())\n\n# convert the object into a dict\nmy_permissions_response_dict = my_permissions_response_instance.to_dict()\n# create an instance of MyPermissionsResponse from a dict\nmy_permissions_response_from_dict = MyPermissionsResponse.from_dict(my_permissions_response_dict)\n```\n[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)\n\n\n# NestedRole\n\nSerializer 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.\n\n## Properties\n\nName | Type | Description | Notes\n------------ | ------------- | ------------- | -------------\n**users** | **List[str]** | | [optional] [default to []]\n**groups** | **List[str]** | | [optional] [default to []]\n**role** | **str** | | \n\n## Example\n\n```python\nfrom pulpcore.client.pulp_service.models.nested_role import NestedRole\n\n# TODO update the JSON string below\njson = \"{}\"\n# create an instance of NestedRole from a JSON string\nnested_role_instance = NestedRole.from_json(json)\n# print the JSON string representation of the object\nprint(NestedRole.to_json())\n\n# convert the object into a dict\nnested_role_dict = nested_role_instance.to_dict()\n# create an instance of NestedRole from a dict\nnested_role_from_dict = NestedRole.from_dict(nested_role_dict)\n```\n[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)\n\n\n# NestedRoleResponse\n\nSerializer 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.\n\n## Properties\n\nName | Type | Description | Notes\n------------ | ------------- | ------------- | -------------\n**users** | **List[str]** | | [optional] [default to []]\n**groups** | **List[str]** | | [optional] [default to []]\n**role** | **str** | | \n\n## Example\n\n```python\nfrom pulpcore.client.pulp_service.models.nested_role_response import NestedRoleResponse\n\n# TODO update the JSON string below\njson = \"{}\"\n# create an instance of NestedRoleResponse from a JSON string\nnested_role_response_instance = NestedRoleResponse.from_json(json)\n# print the JSON string representation of the object\nprint(NestedRoleResponse.to_json())\n\n# convert the object into a dict\nnested_role_response_dict = nested_role_response_instance.to_dict()\n# create an instance of NestedRoleResponse from a dict\nnested_role_response_from_dict = NestedRoleResponse.from_dict(nested_role_response_dict)\n```\n[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)\n\n\n# ObjectRolesResponse\n\n\n## Properties\n\nName | Type | Description | Notes\n------------ | ------------- | ------------- | -------------\n**roles** | [**List[NestedRoleResponse]**](NestedRoleResponse.md) | | \n\n## Example\n\n```python\nfrom pulpcore.client.pulp_service.models.object_roles_response import ObjectRolesResponse\n\n# TODO update the JSON string below\njson = \"{}\"\n# create an instance of ObjectRolesResponse from a JSON string\nobject_roles_response_instance = ObjectRolesResponse.from_json(json)\n# print the JSON string representation of the object\nprint(ObjectRolesResponse.to_json())\n\n# convert the object into a dict\nobject_roles_response_dict = object_roles_response_instance.to_dict()\n# create an instance of ObjectRolesResponse from a dict\nobject_roles_response_from_dict = ObjectRolesResponse.from_dict(object_roles_response_dict)\n```\n[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)\n\n\n# PaginatedserviceFeatureContentGuardResponseList\n\n\n## Properties\n\nName | Type | Description | Notes\n------------ | ------------- | ------------- | -------------\n**count** | **int** | | \n**next** | **str** | | [optional] \n**previous** | **str** | | [optional] \n**results** | [**List[ServiceFeatureContentGuardResponse]**](ServiceFeatureContentGuardResponse.md) | | \n\n## Example\n\n```python\nfrom pulpcore.client.pulp_service.models.paginatedservice_feature_content_guard_response_list import PaginatedserviceFeatureContentGuardResponseList\n\n# TODO update the JSON string below\njson = \"{}\"\n# create an instance of PaginatedserviceFeatureContentGuardResponseList from a JSON string\npaginatedservice_feature_content_guard_response_list_instance = PaginatedserviceFeatureContentGuardResponseList.from_json(json)\n# print the JSON string representation of the object\nprint(PaginatedserviceFeatureContentGuardResponseList.to_json())\n\n# convert the object into a dict\npaginatedservice_feature_content_guard_response_list_dict = paginatedservice_feature_content_guard_response_list_instance.to_dict()\n# create an instance of PaginatedserviceFeatureContentGuardResponseList from a dict\npaginatedservice_feature_content_guard_response_list_from_dict = PaginatedserviceFeatureContentGuardResponseList.from_dict(paginatedservice_feature_content_guard_response_list_dict)\n```\n[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)\n\n\n# PaginatedserviceVulnerabilityReportResponseList\n\n\n## Properties\n\nName | Type | Description | Notes\n------------ | ------------- | ------------- | -------------\n**count** | **int** | | \n**next** | **str** | | [optional] \n**previous** | **str** | | [optional] \n**results** | [**List[ServiceVulnerabilityReportResponse]**](ServiceVulnerabilityReportResponse.md) | | \n\n## Example\n\n```python\nfrom pulpcore.client.pulp_service.models.paginatedservice_vulnerability_report_response_list import PaginatedserviceVulnerabilityReportResponseList\n\n# TODO update the JSON string below\njson = \"{}\"\n# create an instance of PaginatedserviceVulnerabilityReportResponseList from a JSON string\npaginatedservice_vulnerability_report_response_list_instance = PaginatedserviceVulnerabilityReportResponseList.from_json(json)\n# print the JSON string representation of the object\nprint(PaginatedserviceVulnerabilityReportResponseList.to_json())\n\n# convert the object into a dict\npaginatedservice_vulnerability_report_response_list_dict = paginatedservice_vulnerability_report_response_list_instance.to_dict()\n# create an instance of PaginatedserviceVulnerabilityReportResponseList from a dict\npaginatedservice_vulnerability_report_response_list_from_dict = PaginatedserviceVulnerabilityReportResponseList.from_dict(paginatedservice_vulnerability_report_response_list_dict)\n```\n[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)\n\n\n# PaginatedTaskResponseList\n\n\n## Properties\n\nName | Type | Description | Notes\n------------ | ------------- | ------------- | -------------\n**count** | **int** | | \n**next** | **str** | | [optional] \n**previous** | **str** | | [optional] \n**results** | [**List[TaskResponse]**](TaskResponse.md) | | \n\n## Example\n\n```python\nfrom pulpcore.client.pulp_service.models.paginated_task_response_list import PaginatedTaskResponseList\n\n# TODO update the JSON string below\njson = \"{}\"\n# create an instance of PaginatedTaskResponseList from a JSON string\npaginated_task_response_list_instance = PaginatedTaskResponseList.from_json(json)\n# print the JSON string representation of the object\nprint(PaginatedTaskResponseList.to_json())\n\n# convert the object into a dict\npaginated_task_response_list_dict = paginated_task_response_list_instance.to_dict()\n# create an instance of PaginatedTaskResponseList from a dict\npaginated_task_response_list_from_dict = PaginatedTaskResponseList.from_dict(paginated_task_response_list_dict)\n```\n[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)\n\n\n# PatchedserviceFeatureContentGuard\n\nA serializer for FeatureContentGuard.\n\n## Properties\n\nName | Type | Description | Notes\n------------ | ------------- | ------------- | -------------\n**name** | **str** | The unique name. | [optional] \n**description** | **str** | An optional description. | [optional] \n**header_name** | **str** | | [optional] \n**jq_filter** | **str** | | [optional] \n**features** | **List[str]** | The list of features required to access the content. | [optional] \n\n## Example\n\n```python\nfrom pulpcore.client.pulp_service.models.patchedservice_feature_content_guard import PatchedserviceFeatureContentGuard\n\n# TODO update the JSON string below\njson = \"{}\"\n# create an instance of PatchedserviceFeatureContentGuard from a JSON string\npatchedservice_feature_content_guard_instance = PatchedserviceFeatureContentGuard.from_json(json)\n# print the JSON string representation of the object\nprint(PatchedserviceFeatureContentGuard.to_json())\n\n# convert the object into a dict\npatchedservice_feature_content_guard_dict = patchedservice_feature_content_guard_instance.to_dict()\n# create an instance of PatchedserviceFeatureContentGuard from a dict\npatchedservice_feature_content_guard_from_dict = PatchedserviceFeatureContentGuard.from_dict(patchedservice_feature_content_guard_dict)\n```\n[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)\n\n\n# ProgressReportResponse\n\nBase serializer for use with [pulpcore.app.models.Model][] This ensures that all Serializers provide values for the 'pulp_href` field. The class provides a default for the ``ref_name`` attribute in the ModelSerializers's ``Meta`` class. This ensures that the OpenAPI definitions of plugins are namespaced properly.\n\n## Properties\n\nName | Type | Description | Notes\n------------ | ------------- | ------------- | -------------\n**message** | **str** | The message shown to the user for the progress report. | [optional] [readonly] \n**code** | **str** | Identifies the type of progress report'. | [optional] [readonly] \n**state** | **str** | The current state of the progress report. The possible values are: 'waiting', 'skipped', 'running', 'completed', 'failed', 'canceled' and 'canceling'. The default is 'waiting'. | [optional] [readonly] \n**total** | **int** | The total count of items. | [optional] [readonly] \n**done** | **int** | The count of items already processed. Defaults to 0. | [optional] [readonly] \n**suffix** | **str** | The suffix to be shown with the progress report. | [optional] [readonly] \n\n## Example\n\n```python\nfrom pulpcore.client.pulp_service.models.progress_report_response import ProgressReportResponse\n\n# TODO update the JSON string below\njson = \"{}\"\n# create an instance of ProgressReportResponse from a JSON string\nprogress_report_response_instance = ProgressReportResponse.from_json(json)\n# print the JSON string representation of the object\nprint(ProgressReportResponse.to_json())\n\n# convert the object into a dict\nprogress_report_response_dict = progress_report_response_instance.to_dict()\n# create an instance of ProgressReportResponse from a dict\nprogress_report_response_from_dict = ProgressReportResponse.from_dict(progress_report_response_dict)\n```\n[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)\n\n\n# ServiceFeatureContentGuard\n\nA serializer for FeatureContentGuard.\n\n## Properties\n\nName | Type | Description | Notes\n------------ | ------------- | ------------- | -------------\n**name** | **str** | The unique name. | \n**description** | **str** | An optional description. | [optional] \n**header_name** | **str** | | \n**jq_filter** | **str** | | [optional] \n**features** | **List[str]** | The list of features required to access the content. | \n\n## Example\n\n```python\nfrom pulpcore.client.pulp_service.models.service_feature_content_guard import ServiceFeatureContentGuard\n\n# TODO update the JSON string below\njson = \"{}\"\n# create an instance of ServiceFeatureContentGuard from a JSON string\nservice_feature_content_guard_instance = ServiceFeatureContentGuard.from_json(json)\n# print the JSON string representation of the object\nprint(ServiceFeatureContentGuard.to_json())\n\n# convert the object into a dict\nservice_feature_content_guard_dict = service_feature_content_guard_instance.to_dict()\n# create an instance of ServiceFeatureContentGuard from a dict\nservice_feature_content_guard_from_dict = ServiceFeatureContentGuard.from_dict(service_feature_content_guard_dict)\n```\n[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)\n\n\n# ServiceFeatureContentGuardResponse\n\nA serializer for FeatureContentGuard.\n\n## Properties\n\nName | Type | Description | Notes\n------------ | ------------- | ------------- | -------------\n**pulp_href** | **str** | | [optional] [readonly] \n**prn** | **str** | The Pulp Resource Name (PRN). | [optional] [readonly] \n**pulp_created** | **datetime** | Timestamp of creation. | [optional] [readonly] \n**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] \n**name** | **str** | The unique name. | \n**description** | **str** | An optional description. | [optional] \n**header_name** | **str** | | \n**jq_filter** | **str** | | [optional] \n**features** | **List[str]** | The list of features required to access the content. | \n\n## Example\n\n```python\nfrom pulpcore.client.pulp_service.models.service_feature_content_guard_response import ServiceFeatureContentGuardResponse\n\n# TODO update the JSON string below\njson = \"{}\"\n# create an instance of ServiceFeatureContentGuardResponse from a JSON string\nservice_feature_content_guard_response_instance = ServiceFeatureContentGuardResponse.from_json(json)\n# print the JSON string representation of the object\nprint(ServiceFeatureContentGuardResponse.to_json())\n\n# convert the object into a dict\nservice_feature_content_guard_response_dict = service_feature_content_guard_response_instance.to_dict()\n# create an instance of ServiceFeatureContentGuardResponse from a dict\nservice_feature_content_guard_response_from_dict = ServiceFeatureContentGuardResponse.from_dict(service_feature_content_guard_response_dict)\n```\n[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)\n\n\n# ServiceVulnerabilityReportResponse\n\nA serializer for the VulnerabilityReport Model.\n\n## Properties\n\nName | Type | Description | Notes\n------------ | ------------- | ------------- | -------------\n**pulp_href** | **str** | | [optional] [readonly] \n**prn** | **str** | The Pulp Resource Name (PRN). | [optional] [readonly] \n**pulp_created** | **datetime** | Timestamp of creation. | [optional] [readonly] \n**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] \n**vulns** | **object** | | \n\n## Example\n\n```python\nfrom pulpcore.client.pulp_service.models.service_vulnerability_report_response import ServiceVulnerabilityReportResponse\n\n# TODO update the JSON string below\njson = \"{}\"\n# create an instance of ServiceVulnerabilityReportResponse from a JSON string\nservice_vulnerability_report_response_instance = ServiceVulnerabilityReportResponse.from_json(json)\n# print the JSON string representation of the object\nprint(ServiceVulnerabilityReportResponse.to_json())\n\n# convert the object into a dict\nservice_vulnerability_report_response_dict = service_vulnerability_report_response_instance.to_dict()\n# create an instance of ServiceVulnerabilityReportResponse from a dict\nservice_vulnerability_report_response_from_dict = ServiceVulnerabilityReportResponse.from_dict(service_vulnerability_report_response_dict)\n```\n[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)\n\n\n# StorageClassEnum\n\n* `pulpcore.app.models.storage.FileSystem` - Use local filesystem as storage * `storages.backends.s3boto3.S3Boto3Storage` - Use Amazon S3 as storage * `storages.backends.azure_storage.AzureStorage` - Use Azure Blob as storage * `pulp_service.app.storage.OCIStorage` - Use OCI as storage\n\n## Enum\n\n* `PULPCORE_DOT_APP_DOT_MODELS_DOT_STORAGE_DOT_FILE_SYSTEM` (value: `'pulpcore.app.models.storage.FileSystem'`)\n\n* `STORAGES_DOT_BACKENDS_DOT_S3BOTO3_DOT_S3_BOTO3_STORAGE` (value: `'storages.backends.s3boto3.S3Boto3Storage'`)\n\n* `STORAGES_DOT_BACKENDS_DOT_AZURE_STORAGE_DOT_AZURE_STORAGE` (value: `'storages.backends.azure_storage.AzureStorage'`)\n\n* `PULP_SERVICE_DOT_APP_DOT_STORAGE_DOT_OCI_STORAGE` (value: `'pulp_service.app.storage.OCIStorage'`)\n\n[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)\n\n\n# TaskResponse\n\nBase serializer for use with [pulpcore.app.models.Model][] This ensures that all Serializers provide values for the 'pulp_href` field. The class provides a default for the ``ref_name`` attribute in the ModelSerializers's ``Meta`` class. This ensures that the OpenAPI definitions of plugins are namespaced properly.\n\n## Properties\n\nName | Type | Description | Notes\n------------ | ------------- | ------------- | -------------\n**pulp_href** | **str** | | [optional] [readonly] \n**prn** | **str** | The Pulp Resource Name (PRN). | [optional] [readonly] \n**pulp_created** | **datetime** | Timestamp of creation. | [optional] [readonly] \n**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] \n**state** | **str** | The current state of the task. The possible values include: 'waiting', 'skipped', 'running', 'completed', 'failed', 'canceled' and 'canceling'. | [optional] [readonly] \n**name** | **str** | The name of task. | \n**logging_cid** | **str** | The logging correlation id associated with this task | \n**created_by** | **str** | User who dispatched this task. | [optional] [readonly] \n**unblocked_at** | **datetime** | Timestamp of when this task was identified ready for pickup. | [optional] [readonly] \n**started_at** | **datetime** | Timestamp of when this task started execution. | [optional] [readonly] \n**finished_at** | **datetime** | Timestamp of when this task stopped execution. | [optional] [readonly] \n**error** | **object** | A JSON Object of a fatal error encountered during the execution of this task. | [optional] [readonly] \n**worker** | **str** | DEPRECATED - Always null | [optional] [readonly] \n**parent_task** | **str** | The parent task that spawned this task. | [optional] [readonly] \n**child_tasks** | **List[str]** | Any tasks spawned by this task. | [optional] [readonly] \n**task_group** | **str** | The task group that this task is a member of. | [optional] [readonly] \n**progress_reports** | [**List[ProgressReportResponse]**](ProgressReportResponse.md) | | [optional] [readonly] \n**created_resources** | **List[str]** | Resources created by this task. | [optional] [readonly] \n**reserved_resources_record** | **List[str]** | A list of resources required by that task. | [optional] [readonly] \n**result** | **object** | The result of this task. | [optional] [readonly] \n\n## Example\n\n```python\nfrom pulpcore.client.pulp_service.models.task_response import TaskResponse\n\n# TODO update the JSON string below\njson = \"{}\"\n# create an instance of TaskResponse from a JSON string\ntask_response_instance = TaskResponse.from_json(json)\n# print the JSON string representation of the object\nprint(TaskResponse.to_json())\n\n# convert the object into a dict\ntask_response_dict = task_response_instance.to_dict()\n# create an instance of TaskResponse from a dict\ntask_response_from_dict = TaskResponse.from_dict(task_response_dict)\n```\n[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)\n\n\n# pulpcore.client.pulp_service.TasksApi\n\nAll URIs are relative to *https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com*\n\nMethod | HTTP request | Description\n------------- | ------------- | -------------\n[**admin_tasks**](TasksApi.md#admin_tasks) | **GET** /api/pulp/admin/tasks/ | \n\n\n# **admin_tasks**\n> PaginatedTaskResponseList admin_tasks(x_task_diagnostics=x_task_diagnostics, child_tasks=child_tasks, created_resources=created_resources, exclusive_resources=exclusive_resources, exclusive_resources__in=exclusive_resources__in, finished_at=finished_at, finished_at__gt=finished_at__gt, finished_at__gte=finished_at__gte, finished_at__isnull=finished_at__isnull, finished_at__lt=finished_at__lt, finished_at__lte=finished_at__lte, finished_at__range=finished_at__range, limit=limit, logging_cid=logging_cid, logging_cid__contains=logging_cid__contains, name=name, name__contains=name__contains, name__in=name__in, name__ne=name__ne, offset=offset, ordering=ordering, parent_task=parent_task, prn__in=prn__in, pulp_created=pulp_created, pulp_created__gt=pulp_created__gt, pulp_created__gte=pulp_created__gte, pulp_created__isnull=pulp_created__isnull, pulp_created__lt=pulp_created__lt, pulp_created__lte=pulp_created__lte, pulp_created__range=pulp_created__range, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, q=q, reserved_resources=reserved_resources, reserved_resources__in=reserved_resources__in, shared_resources=shared_resources, shared_resources__in=shared_resources__in, started_at=started_at, started_at__gt=started_at__gt, started_at__gte=started_at__gte, started_at__isnull=started_at__isnull, started_at__lt=started_at__lt, started_at__lte=started_at__lte, started_at__range=started_at__range, state=state, state__in=state__in, state__ne=state__ne, task_group=task_group, unblocked_at=unblocked_at, unblocked_at__gt=unblocked_at__gt, unblocked_at__gte=unblocked_at__gte, unblocked_at__isnull=unblocked_at__isnull, unblocked_at__lt=unblocked_at__lt, unblocked_at__lte=unblocked_at__lte, unblocked_at__range=unblocked_at__range, worker=worker, fields=fields, exclude_fields=exclude_fields)\n\n\n\nA customized named ModelViewSet that knows how to register itself with the Pulp API router. This viewset is discoverable by its name. \\\"Normal\\\" Django Models and Master/Detail models are supported by the ``register_with`` method. Attributes: lookup_field (str): The name of the field by which an object should be looked up, in addition to any parent lookups if this ViewSet is nested. Defaults to 'pk' endpoint_name (str): The name of the final path segment that should identify the ViewSet's collection endpoint. nest_prefix (str): Optional prefix under which this ViewSet should be nested. This must correspond to the \\\"parent_prefix\\\" of a router with rest_framework_nested.NestedMixin. None indicates this ViewSet should not be nested. parent_lookup_kwargs (dict): Optional mapping of key names that would appear in self.kwargs to django model filter expressions that can be used with the corresponding value from self.kwargs, used only by a nested ViewSet to filter based on the parent object's identity. schema (DefaultSchema): The schema class to use by default in a viewset.\n\n### Example\n\n* OAuth Authentication (json_header_remote_authentication):\n* Basic Authentication (basicAuth):\n* Api Key Authentication (cookieAuth):\n\n```python\nimport pulpcore.client.pulp_service\nfrom pulpcore.client.pulp_service.models.paginated_task_response_list import PaginatedTaskResponseList\nfrom pulpcore.client.pulp_service.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = pulpcore.client.pulp_service.Configuration(\n host = \"https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\nconfiguration.access_token = os.environ[\"ACCESS_TOKEN\"]\n\n# Configure HTTP basic authorization: basicAuth\nconfiguration = pulpcore.client.pulp_service.Configuration(\n username = os.environ[\"USERNAME\"],\n password = os.environ[\"PASSWORD\"]\n)\n\n# Configure API key authorization: cookieAuth\nconfiguration.api_key['cookieAuth'] = os.environ[\"API_KEY\"]\n\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['cookieAuth'] = 'Bearer'\n\n# Enter a context with an instance of the API client\nwith pulpcore.client.pulp_service.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = pulpcore.client.pulp_service.TasksApi(api_client)\n x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)\n child_tasks = 'child_tasks_example' # str | Filter results where child_tasks matches value (optional)\n created_resources = 'created_resources_example' # str | (optional)\n exclusive_resources = 'exclusive_resources_example' # str | (optional)\n exclusive_resources__in = ['exclusive_resources__in_example'] # List[str] | Multiple values may be separated by commas. (optional)\n finished_at = '2013-10-20T19:20:30+01:00' # datetime | Filter results where finished_at matches value (optional)\n finished_at__gt = '2013-10-20T19:20:30+01:00' # datetime | Filter results where finished_at is greater than value (optional)\n finished_at__gte = '2013-10-20T19:20:30+01:00' # datetime | Filter results where finished_at is greater than or equal to value (optional)\n finished_at__isnull = True # bool | Filter results where finished_at has a null value (optional)\n finished_at__lt = '2013-10-20T19:20:30+01:00' # datetime | Filter results where finished_at is less than value (optional)\n finished_at__lte = '2013-10-20T19:20:30+01:00' # datetime | Filter results where finished_at is less than or equal to value (optional)\n finished_at__range = ['2013-10-20T19:20:30+01:00'] # List[datetime] | Filter results where finished_at is between two comma separated values (optional)\n limit = 56 # int | Number of results to return per page. (optional)\n logging_cid = 'logging_cid_example' # str | Filter results where logging_cid matches value (optional)\n logging_cid__contains = 'logging_cid__contains_example' # str | Filter results where logging_cid contains value (optional)\n name = 'name_example' # str | Filter results where name matches value (optional)\n name__contains = 'name__contains_example' # str | Filter results where name contains value (optional)\n name__in = ['name__in_example'] # List[str] | Filter results where name is in a comma-separated list of values (optional)\n name__ne = 'name__ne_example' # str | Filter results where name not equal to value (optional)\n offset = 56 # int | The initial index from which to return the results. (optional)\n ordering = ['ordering_example'] # List[str] | Ordering * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `state` - State * `-state` - State (descending) * `name` - Name * `-name` - Name (descending) * `logging_cid` - Logging cid * `-logging_cid` - Logging cid (descending) * `unblocked_at` - Unblocked at * `-unblocked_at` - Unblocked at (descending) * `started_at` - Started at * `-started_at` - Started at (descending) * `finished_at` - Finished at * `-finished_at` - Finished at (descending) * `error` - Error * `-error` - Error (descending) * `enc_args` - Enc args * `-enc_args` - Enc args (descending) * `enc_kwargs` - Enc kwargs * `-enc_kwargs` - Enc kwargs (descending) * `reserved_resources_record` - Reserved resources record * `-reserved_resources_record` - Reserved resources record (descending) * `versions` - Versions * `-versions` - Versions (descending) * `profile_options` - Profile options * `-profile_options` - Profile options (descending) * `immediate` - Immediate * `-immediate` - Immediate (descending) * `deferred` - Deferred * `-deferred` - Deferred (descending) * `result` - Result * `-result` - Result (descending) * `pk` - Pk * `-pk` - Pk (descending) (optional)\n parent_task = 'parent_task_example' # str | Filter results where parent_task matches value (optional)\n prn__in = ['prn__in_example'] # List[str] | Multiple values may be separated by commas. (optional)\n pulp_created = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_created matches value (optional)\n pulp_created__gt = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_created is greater than value (optional)\n pulp_created__gte = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_created is greater than or equal to value (optional)\n pulp_created__isnull = True # bool | Filter results where pulp_created has a null value (optional)\n pulp_created__lt = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_created is less than value (optional)\n pulp_created__lte = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_created is less than or equal to value (optional)\n pulp_created__range = ['2013-10-20T19:20:30+01:00'] # List[datetime] | Filter results where pulp_created is between two comma separated values (optional)\n pulp_href__in = ['pulp_href__in_example'] # List[str] | Multiple values may be separated by commas. (optional)\n pulp_id__in = ['pulp_id__in_example'] # List[str] | Multiple values may be separated by commas. (optional)\n q = 'q_example' # str | Filter results by using NOT, AND and OR operations on other filters (optional)\n reserved_resources = 'reserved_resources_example' # str | (optional)\n reserved_resources__in = ['reserved_resources__in_example'] # List[str] | Multiple values may be separated by commas. (optional)\n shared_resources = 'shared_resources_example' # str | (optional)\n shared_resources__in = ['shared_resources__in_example'] # List[str] | Multiple values may be separated by commas. (optional)\n started_at = '2013-10-20T19:20:30+01:00' # datetime | Filter results where started_at matches value (optional)\n started_at__gt = '2013-10-20T19:20:30+01:00' # datetime | Filter results where started_at is greater than value (optional)\n started_at__gte = '2013-10-20T19:20:30+01:00' # datetime | Filter results where started_at is greater than or equal to value (optional)\n started_at__isnull = True # bool | Filter results where started_at has a null value (optional)\n started_at__lt = '2013-10-20T19:20:30+01:00' # datetime | Filter results where started_at is less than value (optional)\n started_at__lte = '2013-10-20T19:20:30+01:00' # datetime | Filter results where started_at is less than or equal to value (optional)\n started_at__range = ['2013-10-20T19:20:30+01:00'] # List[datetime] | Filter results where started_at is between two comma separated values (optional)\n state = 'state_example' # str | Filter results where state matches value * `waiting` - Waiting * `skipped` - Skipped * `running` - Running * `completed` - Completed * `failed` - Failed * `canceled` - Canceled * `canceling` - Canceling (optional)\n state__in = ['state__in_example'] # List[str] | Filter results where state is in a comma-separated list of values (optional)\n state__ne = 'state__ne_example' # str | Filter results where state not equal to value (optional)\n task_group = 'task_group_example' # str | Filter results where task_group matches value (optional)\n unblocked_at = '2013-10-20T19:20:30+01:00' # datetime | Filter results where unblocked_at matches value (optional)\n unblocked_at__gt = '2013-10-20T19:20:30+01:00' # datetime | Filter results where unblocked_at is greater than value (optional)\n unblocked_at__gte = '2013-10-20T19:20:30+01:00' # datetime | Filter results where unblocked_at is greater than or equal to value (optional)\n unblocked_at__isnull = True # bool | Filter results where unblocked_at has a null value (optional)\n unblocked_at__lt = '2013-10-20T19:20:30+01:00' # datetime | Filter results where unblocked_at is less than value (optional)\n unblocked_at__lte = '2013-10-20T19:20:30+01:00' # datetime | Filter results where unblocked_at is less than or equal to value (optional)\n unblocked_at__range = ['2013-10-20T19:20:30+01:00'] # List[datetime] | Filter results where unblocked_at is between two comma separated values (optional)\n worker = 'worker_example' # str | (optional)\n fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)\n exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)\n\n try:\n api_response = api_instance.admin_tasks(x_task_diagnostics=x_task_diagnostics, child_tasks=child_tasks, created_resources=created_resources, exclusive_resources=exclusive_resources, exclusive_resources__in=exclusive_resources__in, finished_at=finished_at, finished_at__gt=finished_at__gt, finished_at__gte=finished_at__gte, finished_at__isnull=finished_at__isnull, finished_at__lt=finished_at__lt, finished_at__lte=finished_at__lte, finished_at__range=finished_at__range, limit=limit, logging_cid=logging_cid, logging_cid__contains=logging_cid__contains, name=name, name__contains=name__contains, name__in=name__in, name__ne=name__ne, offset=offset, ordering=ordering, parent_task=parent_task, prn__in=prn__in, pulp_created=pulp_created, pulp_created__gt=pulp_created__gt, pulp_created__gte=pulp_created__gte, pulp_created__isnull=pulp_created__isnull, pulp_created__lt=pulp_created__lt, pulp_created__lte=pulp_created__lte, pulp_created__range=pulp_created__range, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, q=q, reserved_resources=reserved_resources, reserved_resources__in=reserved_resources__in, shared_resources=shared_resources, shared_resources__in=shared_resources__in, started_at=started_at, started_at__gt=started_at__gt, started_at__gte=started_at__gte, started_at__isnull=started_at__isnull, started_at__lt=started_at__lt, started_at__lte=started_at__lte, started_at__range=started_at__range, state=state, state__in=state__in, state__ne=state__ne, task_group=task_group, unblocked_at=unblocked_at, unblocked_at__gt=unblocked_at__gt, unblocked_at__gte=unblocked_at__gte, unblocked_at__isnull=unblocked_at__isnull, unblocked_at__lt=unblocked_at__lt, unblocked_at__lte=unblocked_at__lte, unblocked_at__range=unblocked_at__range, worker=worker, fields=fields, exclude_fields=exclude_fields)\n print(\"The response of TasksApi->admin_tasks:\\n\")\n pprint(api_response)\n except Exception as e:\n print(\"Exception when calling TasksApi->admin_tasks: %s\\n\" % e)\n```\n\n\n\n### Parameters\n\n\nName | Type | Description | Notes\n------------- | ------------- | ------------- | -------------\n **x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional] \n **child_tasks** | **str**| Filter results where child_tasks matches value | [optional] \n **created_resources** | **str**| | [optional] \n **exclusive_resources** | **str**| | [optional] \n **exclusive_resources__in** | [**List[str]**](str.md)| Multiple values may be separated by commas. | [optional] \n **finished_at** | **datetime**| Filter results where finished_at matches value | [optional] \n **finished_at__gt** | **datetime**| Filter results where finished_at is greater than value | [optional] \n **finished_at__gte** | **datetime**| Filter results where finished_at is greater than or equal to value | [optional] \n **finished_at__isnull** | **bool**| Filter results where finished_at has a null value | [optional] \n **finished_at__lt** | **datetime**| Filter results where finished_at is less than value | [optional] \n **finished_at__lte** | **datetime**| Filter results where finished_at is less than or equal to value | [optional] \n **finished_at__range** | [**List[datetime]**](datetime.md)| Filter results where finished_at is between two comma separated values | [optional] \n **limit** | **int**| Number of results to return per page. | [optional] \n **logging_cid** | **str**| Filter results where logging_cid matches value | [optional] \n **logging_cid__contains** | **str**| Filter results where logging_cid contains value | [optional] \n **name** | **str**| Filter results where name matches value | [optional] \n **name__contains** | **str**| Filter results where name contains value | [optional] \n **name__in** | [**List[str]**](str.md)| Filter results where name is in a comma-separated list of values | [optional] \n **name__ne** | **str**| Filter results where name not equal to value | [optional] \n **offset** | **int**| The initial index from which to return the results. | [optional] \n **ordering** | [**List[str]**](str.md)| Ordering * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `state` - State * `-state` - State (descending) * `name` - Name * `-name` - Name (descending) * `logging_cid` - Logging cid * `-logging_cid` - Logging cid (descending) * `unblocked_at` - Unblocked at * `-unblocked_at` - Unblocked at (descending) * `started_at` - Started at * `-started_at` - Started at (descending) * `finished_at` - Finished at * `-finished_at` - Finished at (descending) * `error` - Error * `-error` - Error (descending) * `enc_args` - Enc args * `-enc_args` - Enc args (descending) * `enc_kwargs` - Enc kwargs * `-enc_kwargs` - Enc kwargs (descending) * `reserved_resources_record` - Reserved resources record * `-reserved_resources_record` - Reserved resources record (descending) * `versions` - Versions * `-versions` - Versions (descending) * `profile_options` - Profile options * `-profile_options` - Profile options (descending) * `immediate` - Immediate * `-immediate` - Immediate (descending) * `deferred` - Deferred * `-deferred` - Deferred (descending) * `result` - Result * `-result` - Result (descending) * `pk` - Pk * `-pk` - Pk (descending) | [optional] \n **parent_task** | **str**| Filter results where parent_task matches value | [optional] \n **prn__in** | [**List[str]**](str.md)| Multiple values may be separated by commas. | [optional] \n **pulp_created** | **datetime**| Filter results where pulp_created matches value | [optional] \n **pulp_created__gt** | **datetime**| Filter results where pulp_created is greater than value | [optional] \n **pulp_created__gte** | **datetime**| Filter results where pulp_created is greater than or equal to value | [optional] \n **pulp_created__isnull** | **bool**| Filter results where pulp_created has a null value | [optional] \n **pulp_created__lt** | **datetime**| Filter results where pulp_created is less than value | [optional] \n **pulp_created__lte** | **datetime**| Filter results where pulp_created is less than or equal to value | [optional] \n **pulp_created__range** | [**List[datetime]**](datetime.md)| Filter results where pulp_created is between two comma separated values | [optional] \n **pulp_href__in** | [**List[str]**](str.md)| Multiple values may be separated by commas. | [optional] \n **pulp_id__in** | [**List[str]**](str.md)| Multiple values may be separated by commas. | [optional] \n **q** | **str**| Filter results by using NOT, AND and OR operations on other filters | [optional] \n **reserved_resources** | **str**| | [optional] \n **reserved_resources__in** | [**List[str]**](str.md)| Multiple values may be separated by commas. | [optional] \n **shared_resources** | **str**| | [optional] \n **shared_resources__in** | [**List[str]**](str.md)| Multiple values may be separated by commas. | [optional] \n **started_at** | **datetime**| Filter results where started_at matches value | [optional] \n **started_at__gt** | **datetime**| Filter results where started_at is greater than value | [optional] \n **started_at__gte** | **datetime**| Filter results where started_at is greater than or equal to value | [optional] \n **started_at__isnull** | **bool**| Filter results where started_at has a null value | [optional] \n **started_at__lt** | **datetime**| Filter results where started_at is less than value | [optional] \n **started_at__lte** | **datetime**| Filter results where started_at is less than or equal to value | [optional] \n **started_at__range** | [**List[datetime]**](datetime.md)| Filter results where started_at is between two comma separated values | [optional] \n **state** | **str**| Filter results where state matches value * `waiting` - Waiting * `skipped` - Skipped * `running` - Running * `completed` - Completed * `failed` - Failed * `canceled` - Canceled * `canceling` - Canceling | [optional] \n **state__in** | [**List[str]**](str.md)| Filter results where state is in a comma-separated list of values | [optional] \n **state__ne** | **str**| Filter results where state not equal to value | [optional] \n **task_group** | **str**| Filter results where task_group matches value | [optional] \n **unblocked_at** | **datetime**| Filter results where unblocked_at matches value | [optional] \n **unblocked_at__gt** | **datetime**| Filter results where unblocked_at is greater than value | [optional] \n **unblocked_at__gte** | **datetime**| Filter results where unblocked_at is greater than or equal to value | [optional] \n **unblocked_at__isnull** | **bool**| Filter results where unblocked_at has a null value | [optional] \n **unblocked_at__lt** | **datetime**| Filter results where unblocked_at is less than value | [optional] \n **unblocked_at__lte** | **datetime**| Filter results where unblocked_at is less than or equal to value | [optional] \n **unblocked_at__range** | [**List[datetime]**](datetime.md)| Filter results where unblocked_at is between two comma separated values | [optional] \n **worker** | **str**| | [optional] \n **fields** | [**List[str]**](str.md)| A list of fields to include in the response. | [optional] \n **exclude_fields** | [**List[str]**](str.md)| A list of fields to exclude from the response. | [optional] \n\n### Return type\n\n[**PaginatedTaskResponseList**](PaginatedTaskResponseList.md)\n\n### Authorization\n\n[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)\n\n### HTTP request headers\n\n - **Content-Type**: Not defined\n - **Accept**: application/json\n\n### HTTP response details\n\n| Status code | Description | Response headers |\n|-------------|-------------|------------------|\n**200** | | - |\n\n[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)\n\n# pulpcore.client.pulp_service.VulnReportServiceApi\n\nAll URIs are relative to *https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com*\n\nMethod | HTTP request | Description\n------------- | ------------- | -------------\n[**create**](VulnReportServiceApi.md#create) | **POST** /api/pulp/{pulp_domain}/api/v3/vuln_report_service/ | Generate vulnerability report\n[**delete**](VulnReportServiceApi.md#delete) | **DELETE** {service_vulnerability_report_href} | Delete a vulnerability report\n[**list**](VulnReportServiceApi.md#list) | **GET** /api/pulp/{pulp_domain}/api/v3/vuln_report_service/ | List vulnerability reports\n[**read**](VulnReportServiceApi.md#read) | **GET** {service_vulnerability_report_href} | Inspect a vulnerability report\n\n\n# **create**\n> AsyncOperationResponse create(pulp_domain, x_task_diagnostics=x_task_diagnostics, repo_version=repo_version, package_json=package_json)\n\nGenerate vulnerability report\n\nTrigger a task to generate the package vulnerability report\n\n### Example\n\n* OAuth Authentication (json_header_remote_authentication):\n* Basic Authentication (basicAuth):\n* Api Key Authentication (cookieAuth):\n\n```python\nimport pulpcore.client.pulp_service\nfrom pulpcore.client.pulp_service.models.async_operation_response import AsyncOperationResponse\nfrom pulpcore.client.pulp_service.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = pulpcore.client.pulp_service.Configuration(\n host = \"https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\nconfiguration.access_token = os.environ[\"ACCESS_TOKEN\"]\n\n# Configure HTTP basic authorization: basicAuth\nconfiguration = pulpcore.client.pulp_service.Configuration(\n username = os.environ[\"USERNAME\"],\n password = os.environ[\"PASSWORD\"]\n)\n\n# Configure API key authorization: cookieAuth\nconfiguration.api_key['cookieAuth'] = os.environ[\"API_KEY\"]\n\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['cookieAuth'] = 'Bearer'\n\n# Enter a context with an instance of the API client\nwith pulpcore.client.pulp_service.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = pulpcore.client.pulp_service.VulnReportServiceApi(api_client)\n pulp_domain = 'pulp_domain_example' # str | \n x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)\n repo_version = 'repo_version_example' # str | RepositoryVersion HREF with the packages to be checked. (optional)\n package_json = None # bytearray | package-lock.json file with the definition of dependencies to be checked. (optional)\n\n try:\n # Generate vulnerability report\n api_response = api_instance.create(pulp_domain, x_task_diagnostics=x_task_diagnostics, repo_version=repo_version, package_json=package_json)\n print(\"The response of VulnReportServiceApi->create:\\n\")\n pprint(api_response)\n except Exception as e:\n print(\"Exception when calling VulnReportServiceApi->create: %s\\n\" % e)\n```\n\n\n\n### Parameters\n\n\nName | Type | Description | Notes\n------------- | ------------- | ------------- | -------------\n **pulp_domain** | **str**| | \n **x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional] \n **repo_version** | **str**| RepositoryVersion HREF with the packages to be checked. | [optional] \n **package_json** | **bytearray**| package-lock.json file with the definition of dependencies to be checked. | [optional] \n\n### Return type\n\n[**AsyncOperationResponse**](AsyncOperationResponse.md)\n\n### Authorization\n\n[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)\n\n### HTTP request headers\n\n - **Content-Type**: multipart/form-data, application/x-www-form-urlencoded\n - **Accept**: application/json\n\n### HTTP response details\n\n| Status code | Description | Response headers |\n|-------------|-------------|------------------|\n**202** | | - |\n\n[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)\n\n# **delete**\n> delete(service_vulnerability_report_href, x_task_diagnostics=x_task_diagnostics)\n\nDelete a vulnerability report\n\nA customized named ModelViewSet that knows how to register itself with the Pulp API router. This viewset is discoverable by its name. \\\"Normal\\\" Django Models and Master/Detail models are supported by the ``register_with`` method. Attributes: lookup_field (str): The name of the field by which an object should be looked up, in addition to any parent lookups if this ViewSet is nested. Defaults to 'pk' endpoint_name (str): The name of the final path segment that should identify the ViewSet's collection endpoint. nest_prefix (str): Optional prefix under which this ViewSet should be nested. This must correspond to the \\\"parent_prefix\\\" of a router with rest_framework_nested.NestedMixin. None indicates this ViewSet should not be nested. parent_lookup_kwargs (dict): Optional mapping of key names that would appear in self.kwargs to django model filter expressions that can be used with the corresponding value from self.kwargs, used only by a nested ViewSet to filter based on the parent object's identity. schema (DefaultSchema): The schema class to use by default in a viewset.\n\n### Example\n\n* OAuth Authentication (json_header_remote_authentication):\n* Basic Authentication (basicAuth):\n* Api Key Authentication (cookieAuth):\n\n```python\nimport pulpcore.client.pulp_service\nfrom pulpcore.client.pulp_service.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = pulpcore.client.pulp_service.Configuration(\n host = \"https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\nconfiguration.access_token = os.environ[\"ACCESS_TOKEN\"]\n\n# Configure HTTP basic authorization: basicAuth\nconfiguration = pulpcore.client.pulp_service.Configuration(\n username = os.environ[\"USERNAME\"],\n password = os.environ[\"PASSWORD\"]\n)\n\n# Configure API key authorization: cookieAuth\nconfiguration.api_key['cookieAuth'] = os.environ[\"API_KEY\"]\n\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['cookieAuth'] = 'Bearer'\n\n# Enter a context with an instance of the API client\nwith pulpcore.client.pulp_service.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = pulpcore.client.pulp_service.VulnReportServiceApi(api_client)\n service_vulnerability_report_href = 'service_vulnerability_report_href_example' # str | \n x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)\n\n try:\n # Delete a vulnerability report\n api_instance.delete(service_vulnerability_report_href, x_task_diagnostics=x_task_diagnostics)\n except Exception as e:\n print(\"Exception when calling VulnReportServiceApi->delete: %s\\n\" % e)\n```\n\n\n\n### Parameters\n\n\nName | Type | Description | Notes\n------------- | ------------- | ------------- | -------------\n **service_vulnerability_report_href** | **str**| | \n **x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional] \n\n### Return type\n\nvoid (empty response body)\n\n### Authorization\n\n[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)\n\n### HTTP request headers\n\n - **Content-Type**: Not defined\n - **Accept**: Not defined\n\n### HTTP response details\n\n| Status code | Description | Response headers |\n|-------------|-------------|------------------|\n**204** | No response body | - |\n\n[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)\n\n# **list**\n> PaginatedserviceVulnerabilityReportResponseList list(pulp_domain, x_task_diagnostics=x_task_diagnostics, limit=limit, offset=offset, fields=fields, exclude_fields=exclude_fields)\n\nList vulnerability reports\n\nA customized named ModelViewSet that knows how to register itself with the Pulp API router. This viewset is discoverable by its name. \\\"Normal\\\" Django Models and Master/Detail models are supported by the ``register_with`` method. Attributes: lookup_field (str): The name of the field by which an object should be looked up, in addition to any parent lookups if this ViewSet is nested. Defaults to 'pk' endpoint_name (str): The name of the final path segment that should identify the ViewSet's collection endpoint. nest_prefix (str): Optional prefix under which this ViewSet should be nested. This must correspond to the \\\"parent_prefix\\\" of a router with rest_framework_nested.NestedMixin. None indicates this ViewSet should not be nested. parent_lookup_kwargs (dict): Optional mapping of key names that would appear in self.kwargs to django model filter expressions that can be used with the corresponding value from self.kwargs, used only by a nested ViewSet to filter based on the parent object's identity. schema (DefaultSchema): The schema class to use by default in a viewset.\n\n### Example\n\n* OAuth Authentication (json_header_remote_authentication):\n* Basic Authentication (basicAuth):\n* Api Key Authentication (cookieAuth):\n\n```python\nimport pulpcore.client.pulp_service\nfrom pulpcore.client.pulp_service.models.paginatedservice_vulnerability_report_response_list import PaginatedserviceVulnerabilityReportResponseList\nfrom pulpcore.client.pulp_service.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = pulpcore.client.pulp_service.Configuration(\n host = \"https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\nconfiguration.access_token = os.environ[\"ACCESS_TOKEN\"]\n\n# Configure HTTP basic authorization: basicAuth\nconfiguration = pulpcore.client.pulp_service.Configuration(\n username = os.environ[\"USERNAME\"],\n password = os.environ[\"PASSWORD\"]\n)\n\n# Configure API key authorization: cookieAuth\nconfiguration.api_key['cookieAuth'] = os.environ[\"API_KEY\"]\n\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['cookieAuth'] = 'Bearer'\n\n# Enter a context with an instance of the API client\nwith pulpcore.client.pulp_service.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = pulpcore.client.pulp_service.VulnReportServiceApi(api_client)\n pulp_domain = 'pulp_domain_example' # str | \n x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)\n limit = 56 # int | Number of results to return per page. (optional)\n offset = 56 # int | The initial index from which to return the results. (optional)\n fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)\n exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)\n\n try:\n # List vulnerability reports\n api_response = api_instance.list(pulp_domain, x_task_diagnostics=x_task_diagnostics, limit=limit, offset=offset, fields=fields, exclude_fields=exclude_fields)\n print(\"The response of VulnReportServiceApi->list:\\n\")\n pprint(api_response)\n except Exception as e:\n print(\"Exception when calling VulnReportServiceApi->list: %s\\n\" % e)\n```\n\n\n\n### Parameters\n\n\nName | Type | Description | Notes\n------------- | ------------- | ------------- | -------------\n **pulp_domain** | **str**| | \n **x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional] \n **limit** | **int**| Number of results to return per page. | [optional] \n **offset** | **int**| The initial index from which to return the results. | [optional] \n **fields** | [**List[str]**](str.md)| A list of fields to include in the response. | [optional] \n **exclude_fields** | [**List[str]**](str.md)| A list of fields to exclude from the response. | [optional] \n\n### Return type\n\n[**PaginatedserviceVulnerabilityReportResponseList**](PaginatedserviceVulnerabilityReportResponseList.md)\n\n### Authorization\n\n[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)\n\n### HTTP request headers\n\n - **Content-Type**: Not defined\n - **Accept**: application/json\n\n### HTTP response details\n\n| Status code | Description | Response headers |\n|-------------|-------------|------------------|\n**200** | | - |\n\n[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)\n\n# **read**\n> ServiceVulnerabilityReportResponse read(service_vulnerability_report_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)\n\nInspect a vulnerability report\n\nA customized named ModelViewSet that knows how to register itself with the Pulp API router. This viewset is discoverable by its name. \\\"Normal\\\" Django Models and Master/Detail models are supported by the ``register_with`` method. Attributes: lookup_field (str): The name of the field by which an object should be looked up, in addition to any parent lookups if this ViewSet is nested. Defaults to 'pk' endpoint_name (str): The name of the final path segment that should identify the ViewSet's collection endpoint. nest_prefix (str): Optional prefix under which this ViewSet should be nested. This must correspond to the \\\"parent_prefix\\\" of a router with rest_framework_nested.NestedMixin. None indicates this ViewSet should not be nested. parent_lookup_kwargs (dict): Optional mapping of key names that would appear in self.kwargs to django model filter expressions that can be used with the corresponding value from self.kwargs, used only by a nested ViewSet to filter based on the parent object's identity. schema (DefaultSchema): The schema class to use by default in a viewset.\n\n### Example\n\n* OAuth Authentication (json_header_remote_authentication):\n* Basic Authentication (basicAuth):\n* Api Key Authentication (cookieAuth):\n\n```python\nimport pulpcore.client.pulp_service\nfrom pulpcore.client.pulp_service.models.service_vulnerability_report_response import ServiceVulnerabilityReportResponse\nfrom pulpcore.client.pulp_service.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = pulpcore.client.pulp_service.Configuration(\n host = \"https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\nconfiguration.access_token = os.environ[\"ACCESS_TOKEN\"]\n\n# Configure HTTP basic authorization: basicAuth\nconfiguration = pulpcore.client.pulp_service.Configuration(\n username = os.environ[\"USERNAME\"],\n password = os.environ[\"PASSWORD\"]\n)\n\n# Configure API key authorization: cookieAuth\nconfiguration.api_key['cookieAuth'] = os.environ[\"API_KEY\"]\n\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['cookieAuth'] = 'Bearer'\n\n# Enter a context with an instance of the API client\nwith pulpcore.client.pulp_service.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = pulpcore.client.pulp_service.VulnReportServiceApi(api_client)\n service_vulnerability_report_href = 'service_vulnerability_report_href_example' # str | \n x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)\n fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)\n exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)\n\n try:\n # Inspect a vulnerability report\n api_response = api_instance.read(service_vulnerability_report_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)\n print(\"The response of VulnReportServiceApi->read:\\n\")\n pprint(api_response)\n except Exception as e:\n print(\"Exception when calling VulnReportServiceApi->read: %s\\n\" % e)\n```\n\n\n\n### Parameters\n\n\nName | Type | Description | Notes\n------------- | ------------- | ------------- | -------------\n **service_vulnerability_report_href** | **str**| | \n **x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional] \n **fields** | [**List[str]**](str.md)| A list of fields to include in the response. | [optional] \n **exclude_fields** | [**List[str]**](str.md)| A list of fields to exclude from the response. | [optional] \n\n### Return type\n\n[**ServiceVulnerabilityReportResponse**](ServiceVulnerabilityReportResponse.md)\n\n### Authorization\n\n[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)\n\n### HTTP request headers\n\n - **Content-Type**: Not defined\n - **Accept**: application/json\n\n### HTTP response details\n\n| Status code | Description | Response headers |\n|-------------|-------------|------------------|\n**200** | | - |\n\n[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)\n\n",
"bugtrack_url": null,
"license": "GPLv2+",
"summary": "Pulp 3 API",
"version": "20251030.1",
"project_urls": null,
"split_keywords": [
"pulp",
" pulpcore",
" client",
" pulp 3 api"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "a020d3269c06642e65e35cf0966c71730655e64a02528d68bb0330fba9f6d043",
"md5": "b681bcf82870cd5932be686edb8d2c8b",
"sha256": "1f88e7584ca2e8f7551c97ec1bd5bea0872939478ccc2a75b93b83deb817983b"
},
"downloads": -1,
"filename": "crc_pulp_service_client-20251030.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b681bcf82870cd5932be686edb8d2c8b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 85606,
"upload_time": "2025-10-30T12:28:03",
"upload_time_iso_8601": "2025-10-30T12:28:03.537487Z",
"url": "https://files.pythonhosted.org/packages/a0/20/d3269c06642e65e35cf0966c71730655e64a02528d68bb0330fba9f6d043/crc_pulp_service_client-20251030.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "d75689f20fea16f5bc45786412ebc6f6b12d814c4878afd2fc02e07b2021e19e",
"md5": "2d026151ec79d8a51478d8a5db92c65d",
"sha256": "d1e0b8232db6c83d1a42ba96c8c66933cdc3e3d11f0faea21477069e0d2624ca"
},
"downloads": -1,
"filename": "crc_pulp_service_client-20251030.1.tar.gz",
"has_sig": false,
"md5_digest": "2d026151ec79d8a51478d8a5db92c65d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 66661,
"upload_time": "2025-10-30T12:28:05",
"upload_time_iso_8601": "2025-10-30T12:28:05.074031Z",
"url": "https://files.pythonhosted.org/packages/d7/56/89f20fea16f5bc45786412ebc6f6b12d814c4878afd2fc02e07b2021e19e/crc_pulp_service_client-20251030.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-30 12:28:05",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "crc-pulp-service-client"
}
JSON