crc-pulp-service-client 20251023.3__tar.gz → 20251023.4__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of crc-pulp-service-client might be problematic. Click here for more details.
- crc_pulp_service_client-20251023.4/PKG-INFO +2504 -0
- {crc_pulp_service_client-20251023.3 → crc_pulp_service_client-20251023.4}/README.md +4 -4
- crc_pulp_service_client-20251023.4/crc_pulp_service_client.egg-info/PKG-INFO +2504 -0
- {crc_pulp_service_client-20251023.3 → crc_pulp_service_client-20251023.4}/pulpcore/client/pulp_service/__init__.py +1 -1
- {crc_pulp_service_client-20251023.3 → crc_pulp_service_client-20251023.4}/pulpcore/client/pulp_service/configuration.py +3 -3
- {crc_pulp_service_client-20251023.3 → crc_pulp_service_client-20251023.4}/pyproject.toml +1 -1
- {crc_pulp_service_client-20251023.3 → crc_pulp_service_client-20251023.4}/setup.py +5 -4
- crc_pulp_service_client-20251023.3/PKG-INFO +0 -25
- crc_pulp_service_client-20251023.3/crc_pulp_service_client.egg-info/PKG-INFO +0 -25
- {crc_pulp_service_client-20251023.3 → crc_pulp_service_client-20251023.4}/crc_pulp_service_client.egg-info/SOURCES.txt +0 -0
- {crc_pulp_service_client-20251023.3 → crc_pulp_service_client-20251023.4}/crc_pulp_service_client.egg-info/dependency_links.txt +0 -0
- {crc_pulp_service_client-20251023.3 → crc_pulp_service_client-20251023.4}/crc_pulp_service_client.egg-info/requires.txt +0 -0
- {crc_pulp_service_client-20251023.3 → crc_pulp_service_client-20251023.4}/crc_pulp_service_client.egg-info/top_level.txt +0 -0
- {crc_pulp_service_client-20251023.3 → crc_pulp_service_client-20251023.4}/pulpcore/__init__.py +0 -0
- {crc_pulp_service_client-20251023.3 → crc_pulp_service_client-20251023.4}/pulpcore/client/__init__.py +0 -0
- {crc_pulp_service_client-20251023.3 → crc_pulp_service_client-20251023.4}/pulpcore/client/pulp_service/api/__init__.py +0 -0
- {crc_pulp_service_client-20251023.3 → crc_pulp_service_client-20251023.4}/pulpcore/client/pulp_service/api/api_create_domain_api.py +0 -0
- {crc_pulp_service_client-20251023.3 → crc_pulp_service_client-20251023.4}/pulpcore/client/pulp_service/api/api_debug_auth_header_api.py +0 -0
- {crc_pulp_service_client-20251023.3 → crc_pulp_service_client-20251023.4}/pulpcore/client/pulp_service/api/api_test_random_lock_tasks_api.py +0 -0
- {crc_pulp_service_client-20251023.3 → crc_pulp_service_client-20251023.4}/pulpcore/client/pulp_service/api/api_test_tasks_api.py +0 -0
- {crc_pulp_service_client-20251023.3 → crc_pulp_service_client-20251023.4}/pulpcore/client/pulp_service/api/contentguards_feature_api.py +0 -0
- {crc_pulp_service_client-20251023.3 → crc_pulp_service_client-20251023.4}/pulpcore/client/pulp_service/api/tasks_api.py +0 -0
- {crc_pulp_service_client-20251023.3 → crc_pulp_service_client-20251023.4}/pulpcore/client/pulp_service/api/vuln_report_service_api.py +0 -0
- {crc_pulp_service_client-20251023.3 → crc_pulp_service_client-20251023.4}/pulpcore/client/pulp_service/api_client.py +0 -0
- {crc_pulp_service_client-20251023.3 → crc_pulp_service_client-20251023.4}/pulpcore/client/pulp_service/api_response.py +0 -0
- {crc_pulp_service_client-20251023.3 → crc_pulp_service_client-20251023.4}/pulpcore/client/pulp_service/exceptions.py +0 -0
- {crc_pulp_service_client-20251023.3 → crc_pulp_service_client-20251023.4}/pulpcore/client/pulp_service/models/__init__.py +0 -0
- {crc_pulp_service_client-20251023.3 → crc_pulp_service_client-20251023.4}/pulpcore/client/pulp_service/models/async_operation_response.py +0 -0
- {crc_pulp_service_client-20251023.3 → crc_pulp_service_client-20251023.4}/pulpcore/client/pulp_service/models/domain.py +0 -0
- {crc_pulp_service_client-20251023.3 → crc_pulp_service_client-20251023.4}/pulpcore/client/pulp_service/models/domain_response.py +0 -0
- {crc_pulp_service_client-20251023.3 → crc_pulp_service_client-20251023.4}/pulpcore/client/pulp_service/models/my_permissions_response.py +0 -0
- {crc_pulp_service_client-20251023.3 → crc_pulp_service_client-20251023.4}/pulpcore/client/pulp_service/models/nested_role.py +0 -0
- {crc_pulp_service_client-20251023.3 → crc_pulp_service_client-20251023.4}/pulpcore/client/pulp_service/models/nested_role_response.py +0 -0
- {crc_pulp_service_client-20251023.3 → crc_pulp_service_client-20251023.4}/pulpcore/client/pulp_service/models/object_roles_response.py +0 -0
- {crc_pulp_service_client-20251023.3 → crc_pulp_service_client-20251023.4}/pulpcore/client/pulp_service/models/paginated_task_response_list.py +0 -0
- {crc_pulp_service_client-20251023.3 → crc_pulp_service_client-20251023.4}/pulpcore/client/pulp_service/models/paginatedservice_feature_content_guard_response_list.py +0 -0
- {crc_pulp_service_client-20251023.3 → crc_pulp_service_client-20251023.4}/pulpcore/client/pulp_service/models/paginatedservice_vulnerability_report_response_list.py +0 -0
- {crc_pulp_service_client-20251023.3 → crc_pulp_service_client-20251023.4}/pulpcore/client/pulp_service/models/patchedservice_feature_content_guard.py +0 -0
- {crc_pulp_service_client-20251023.3 → crc_pulp_service_client-20251023.4}/pulpcore/client/pulp_service/models/progress_report_response.py +0 -0
- {crc_pulp_service_client-20251023.3 → crc_pulp_service_client-20251023.4}/pulpcore/client/pulp_service/models/service_feature_content_guard.py +0 -0
- {crc_pulp_service_client-20251023.3 → crc_pulp_service_client-20251023.4}/pulpcore/client/pulp_service/models/service_feature_content_guard_response.py +0 -0
- {crc_pulp_service_client-20251023.3 → crc_pulp_service_client-20251023.4}/pulpcore/client/pulp_service/models/service_vulnerability_report_response.py +0 -0
- {crc_pulp_service_client-20251023.3 → crc_pulp_service_client-20251023.4}/pulpcore/client/pulp_service/models/storage_class_enum.py +0 -0
- {crc_pulp_service_client-20251023.3 → crc_pulp_service_client-20251023.4}/pulpcore/client/pulp_service/models/task_response.py +0 -0
- {crc_pulp_service_client-20251023.3 → crc_pulp_service_client-20251023.4}/pulpcore/client/pulp_service/py.typed +0 -0
- {crc_pulp_service_client-20251023.3 → crc_pulp_service_client-20251023.4}/pulpcore/client/pulp_service/rest.py +0 -0
- {crc_pulp_service_client-20251023.3 → crc_pulp_service_client-20251023.4}/setup.cfg +0 -0
- {crc_pulp_service_client-20251023.3 → crc_pulp_service_client-20251023.4}/test/test_api_create_domain_api.py +0 -0
- {crc_pulp_service_client-20251023.3 → crc_pulp_service_client-20251023.4}/test/test_api_debug_auth_header_api.py +0 -0
- {crc_pulp_service_client-20251023.3 → crc_pulp_service_client-20251023.4}/test/test_api_test_random_lock_tasks_api.py +0 -0
- {crc_pulp_service_client-20251023.3 → crc_pulp_service_client-20251023.4}/test/test_api_test_tasks_api.py +0 -0
- {crc_pulp_service_client-20251023.3 → crc_pulp_service_client-20251023.4}/test/test_async_operation_response.py +0 -0
- {crc_pulp_service_client-20251023.3 → crc_pulp_service_client-20251023.4}/test/test_contentguards_feature_api.py +0 -0
- {crc_pulp_service_client-20251023.3 → crc_pulp_service_client-20251023.4}/test/test_domain.py +0 -0
- {crc_pulp_service_client-20251023.3 → crc_pulp_service_client-20251023.4}/test/test_domain_response.py +0 -0
- {crc_pulp_service_client-20251023.3 → crc_pulp_service_client-20251023.4}/test/test_my_permissions_response.py +0 -0
- {crc_pulp_service_client-20251023.3 → crc_pulp_service_client-20251023.4}/test/test_nested_role.py +0 -0
- {crc_pulp_service_client-20251023.3 → crc_pulp_service_client-20251023.4}/test/test_nested_role_response.py +0 -0
- {crc_pulp_service_client-20251023.3 → crc_pulp_service_client-20251023.4}/test/test_object_roles_response.py +0 -0
- {crc_pulp_service_client-20251023.3 → crc_pulp_service_client-20251023.4}/test/test_paginated_task_response_list.py +0 -0
- {crc_pulp_service_client-20251023.3 → crc_pulp_service_client-20251023.4}/test/test_paginatedservice_feature_content_guard_response_list.py +0 -0
- {crc_pulp_service_client-20251023.3 → crc_pulp_service_client-20251023.4}/test/test_paginatedservice_vulnerability_report_response_list.py +0 -0
- {crc_pulp_service_client-20251023.3 → crc_pulp_service_client-20251023.4}/test/test_patchedservice_feature_content_guard.py +0 -0
- {crc_pulp_service_client-20251023.3 → crc_pulp_service_client-20251023.4}/test/test_progress_report_response.py +0 -0
- {crc_pulp_service_client-20251023.3 → crc_pulp_service_client-20251023.4}/test/test_service_feature_content_guard.py +0 -0
- {crc_pulp_service_client-20251023.3 → crc_pulp_service_client-20251023.4}/test/test_service_feature_content_guard_response.py +0 -0
- {crc_pulp_service_client-20251023.3 → crc_pulp_service_client-20251023.4}/test/test_service_vulnerability_report_response.py +0 -0
- {crc_pulp_service_client-20251023.3 → crc_pulp_service_client-20251023.4}/test/test_storage_class_enum.py +0 -0
- {crc_pulp_service_client-20251023.3 → crc_pulp_service_client-20251023.4}/test/test_task_response.py +0 -0
- {crc_pulp_service_client-20251023.3 → crc_pulp_service_client-20251023.4}/test/test_tasks_api.py +0 -0
- {crc_pulp_service_client-20251023.3 → crc_pulp_service_client-20251023.4}/test/test_vuln_report_service_api.py +0 -0
|
@@ -0,0 +1,2504 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: crc-pulp_service-client
|
|
3
|
+
Version: 20251023.4
|
|
4
|
+
Summary: Pulp 3 API
|
|
5
|
+
Home-page:
|
|
6
|
+
Author: Pulp Team
|
|
7
|
+
Author-email: pulp-list@redhat.com
|
|
8
|
+
License: GPLv2+
|
|
9
|
+
Keywords: pulp,pulpcore,client,Pulp 3 API
|
|
10
|
+
Description-Content-Type: text/markdown
|
|
11
|
+
Requires-Dist: urllib3<3.0.0,>=1.25.3
|
|
12
|
+
Requires-Dist: python-dateutil<2.10.0,>=2.8.1
|
|
13
|
+
Requires-Dist: pydantic>=2
|
|
14
|
+
Requires-Dist: typing-extensions>=4.7.1
|
|
15
|
+
Dynamic: author
|
|
16
|
+
Dynamic: author-email
|
|
17
|
+
Dynamic: description
|
|
18
|
+
Dynamic: description-content-type
|
|
19
|
+
Dynamic: keywords
|
|
20
|
+
Dynamic: license
|
|
21
|
+
Dynamic: requires-dist
|
|
22
|
+
Dynamic: summary
|
|
23
|
+
|
|
24
|
+
# pulpcore.client.pulp_service.ApiCreateDomainApi
|
|
25
|
+
|
|
26
|
+
All URIs are relative to *https://env-ephemeral-qfzgn7.apps.crc-eph.r9lp.p1.openshiftapps.com*
|
|
27
|
+
|
|
28
|
+
Method | HTTP request | Description
|
|
29
|
+
------------- | ------------- | -------------
|
|
30
|
+
[**post**](ApiCreateDomainApi.md#post) | **POST** /api/pulp/create-domain/ | Create domain
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
# **post**
|
|
34
|
+
> DomainResponse post(domain, x_task_diagnostics=x_task_diagnostics)
|
|
35
|
+
|
|
36
|
+
Create domain
|
|
37
|
+
|
|
38
|
+
Create a new domain for from S3 template domain, self-service path
|
|
39
|
+
|
|
40
|
+
### Example
|
|
41
|
+
|
|
42
|
+
* OAuth Authentication (json_header_remote_authentication):
|
|
43
|
+
* Basic Authentication (basicAuth):
|
|
44
|
+
* Api Key Authentication (cookieAuth):
|
|
45
|
+
|
|
46
|
+
```python
|
|
47
|
+
import pulpcore.client.pulp_service
|
|
48
|
+
from pulpcore.client.pulp_service.models.domain import Domain
|
|
49
|
+
from pulpcore.client.pulp_service.models.domain_response import DomainResponse
|
|
50
|
+
from pulpcore.client.pulp_service.rest import ApiException
|
|
51
|
+
from pprint import pprint
|
|
52
|
+
|
|
53
|
+
# Defining the host is optional and defaults to https://env-ephemeral-qfzgn7.apps.crc-eph.r9lp.p1.openshiftapps.com
|
|
54
|
+
# See configuration.py for a list of all supported configuration parameters.
|
|
55
|
+
configuration = pulpcore.client.pulp_service.Configuration(
|
|
56
|
+
host = "https://env-ephemeral-qfzgn7.apps.crc-eph.r9lp.p1.openshiftapps.com"
|
|
57
|
+
)
|
|
58
|
+
|
|
59
|
+
# The client must configure the authentication and authorization parameters
|
|
60
|
+
# in accordance with the API server security policy.
|
|
61
|
+
# Examples for each auth method are provided below, use the example that
|
|
62
|
+
# satisfies your auth use case.
|
|
63
|
+
|
|
64
|
+
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
65
|
+
|
|
66
|
+
# Configure HTTP basic authorization: basicAuth
|
|
67
|
+
configuration = pulpcore.client.pulp_service.Configuration(
|
|
68
|
+
username = os.environ["USERNAME"],
|
|
69
|
+
password = os.environ["PASSWORD"]
|
|
70
|
+
)
|
|
71
|
+
|
|
72
|
+
# Configure API key authorization: cookieAuth
|
|
73
|
+
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
|
|
74
|
+
|
|
75
|
+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
76
|
+
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
|
|
77
|
+
|
|
78
|
+
# Enter a context with an instance of the API client
|
|
79
|
+
with pulpcore.client.pulp_service.ApiClient(configuration) as api_client:
|
|
80
|
+
# Create an instance of the API class
|
|
81
|
+
api_instance = pulpcore.client.pulp_service.ApiCreateDomainApi(api_client)
|
|
82
|
+
domain = pulpcore.client.pulp_service.Domain() # Domain |
|
|
83
|
+
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
|
|
84
|
+
|
|
85
|
+
try:
|
|
86
|
+
# Create domain
|
|
87
|
+
api_response = api_instance.post(domain, x_task_diagnostics=x_task_diagnostics)
|
|
88
|
+
print("The response of ApiCreateDomainApi->post:\n")
|
|
89
|
+
pprint(api_response)
|
|
90
|
+
except Exception as e:
|
|
91
|
+
print("Exception when calling ApiCreateDomainApi->post: %s\n" % e)
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
### Parameters
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
Name | Type | Description | Notes
|
|
100
|
+
------------- | ------------- | ------------- | -------------
|
|
101
|
+
**domain** | [**Domain**](Domain.md)| |
|
|
102
|
+
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
|
|
103
|
+
|
|
104
|
+
### Return type
|
|
105
|
+
|
|
106
|
+
[**DomainResponse**](DomainResponse.md)
|
|
107
|
+
|
|
108
|
+
### Authorization
|
|
109
|
+
|
|
110
|
+
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
|
|
111
|
+
|
|
112
|
+
### HTTP request headers
|
|
113
|
+
|
|
114
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
|
115
|
+
- **Accept**: application/json
|
|
116
|
+
|
|
117
|
+
### HTTP response details
|
|
118
|
+
|
|
119
|
+
| Status code | Description | Response headers |
|
|
120
|
+
|-------------|-------------|------------------|
|
|
121
|
+
**201** | | - |
|
|
122
|
+
|
|
123
|
+
[[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)
|
|
124
|
+
|
|
125
|
+
# pulpcore.client.pulp_service.ApiDebugAuthHeaderApi
|
|
126
|
+
|
|
127
|
+
All URIs are relative to *https://env-ephemeral-qfzgn7.apps.crc-eph.r9lp.p1.openshiftapps.com*
|
|
128
|
+
|
|
129
|
+
Method | HTTP request | Description
|
|
130
|
+
------------- | ------------- | -------------
|
|
131
|
+
[**get**](ApiDebugAuthHeaderApi.md#get) | **GET** /api/pulp/debug_auth_header/ |
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
# **get**
|
|
135
|
+
> get(x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
|
|
136
|
+
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
Returns the content of the authentication headers.
|
|
140
|
+
|
|
141
|
+
### Example
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
```python
|
|
145
|
+
import pulpcore.client.pulp_service
|
|
146
|
+
from pulpcore.client.pulp_service.rest import ApiException
|
|
147
|
+
from pprint import pprint
|
|
148
|
+
|
|
149
|
+
# Defining the host is optional and defaults to https://env-ephemeral-qfzgn7.apps.crc-eph.r9lp.p1.openshiftapps.com
|
|
150
|
+
# See configuration.py for a list of all supported configuration parameters.
|
|
151
|
+
configuration = pulpcore.client.pulp_service.Configuration(
|
|
152
|
+
host = "https://env-ephemeral-qfzgn7.apps.crc-eph.r9lp.p1.openshiftapps.com"
|
|
153
|
+
)
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
# Enter a context with an instance of the API client
|
|
157
|
+
with pulpcore.client.pulp_service.ApiClient(configuration) as api_client:
|
|
158
|
+
# Create an instance of the API class
|
|
159
|
+
api_instance = pulpcore.client.pulp_service.ApiDebugAuthHeaderApi(api_client)
|
|
160
|
+
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
|
|
161
|
+
fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
|
|
162
|
+
exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)
|
|
163
|
+
|
|
164
|
+
try:
|
|
165
|
+
api_instance.get(x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
|
|
166
|
+
except Exception as e:
|
|
167
|
+
print("Exception when calling ApiDebugAuthHeaderApi->get: %s\n" % e)
|
|
168
|
+
```
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
### Parameters
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
Name | Type | Description | Notes
|
|
176
|
+
------------- | ------------- | ------------- | -------------
|
|
177
|
+
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
|
|
178
|
+
**fields** | [**List[str]**](str.md)| A list of fields to include in the response. | [optional]
|
|
179
|
+
**exclude_fields** | [**List[str]**](str.md)| A list of fields to exclude from the response. | [optional]
|
|
180
|
+
|
|
181
|
+
### Return type
|
|
182
|
+
|
|
183
|
+
void (empty response body)
|
|
184
|
+
|
|
185
|
+
### Authorization
|
|
186
|
+
|
|
187
|
+
No authorization required
|
|
188
|
+
|
|
189
|
+
### HTTP request headers
|
|
190
|
+
|
|
191
|
+
- **Content-Type**: Not defined
|
|
192
|
+
- **Accept**: Not defined
|
|
193
|
+
|
|
194
|
+
### HTTP response details
|
|
195
|
+
|
|
196
|
+
| Status code | Description | Response headers |
|
|
197
|
+
|-------------|-------------|------------------|
|
|
198
|
+
**200** | No response body | - |
|
|
199
|
+
|
|
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)
|
|
201
|
+
|
|
202
|
+
# pulpcore.client.pulp_service.ApiTestRandomLockTasksApi
|
|
203
|
+
|
|
204
|
+
All URIs are relative to *https://env-ephemeral-qfzgn7.apps.crc-eph.r9lp.p1.openshiftapps.com*
|
|
205
|
+
|
|
206
|
+
Method | HTTP request | Description
|
|
207
|
+
------------- | ------------- | -------------
|
|
208
|
+
[**get**](ApiTestRandomLockTasksApi.md#get) | **GET** /api/pulp/test/random_lock_tasks/ |
|
|
209
|
+
|
|
210
|
+
|
|
211
|
+
# **get**
|
|
212
|
+
> get(x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
|
|
213
|
+
|
|
214
|
+
|
|
215
|
+
|
|
216
|
+
### Example
|
|
217
|
+
|
|
218
|
+
|
|
219
|
+
```python
|
|
220
|
+
import pulpcore.client.pulp_service
|
|
221
|
+
from pulpcore.client.pulp_service.rest import ApiException
|
|
222
|
+
from pprint import pprint
|
|
223
|
+
|
|
224
|
+
# Defining the host is optional and defaults to https://env-ephemeral-qfzgn7.apps.crc-eph.r9lp.p1.openshiftapps.com
|
|
225
|
+
# See configuration.py for a list of all supported configuration parameters.
|
|
226
|
+
configuration = pulpcore.client.pulp_service.Configuration(
|
|
227
|
+
host = "https://env-ephemeral-qfzgn7.apps.crc-eph.r9lp.p1.openshiftapps.com"
|
|
228
|
+
)
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
# Enter a context with an instance of the API client
|
|
232
|
+
with pulpcore.client.pulp_service.ApiClient(configuration) as api_client:
|
|
233
|
+
# Create an instance of the API class
|
|
234
|
+
api_instance = pulpcore.client.pulp_service.ApiTestRandomLockTasksApi(api_client)
|
|
235
|
+
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
|
|
236
|
+
fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
|
|
237
|
+
exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)
|
|
238
|
+
|
|
239
|
+
try:
|
|
240
|
+
api_instance.get(x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
|
|
241
|
+
except Exception as e:
|
|
242
|
+
print("Exception when calling ApiTestRandomLockTasksApi->get: %s\n" % e)
|
|
243
|
+
```
|
|
244
|
+
|
|
245
|
+
|
|
246
|
+
|
|
247
|
+
### Parameters
|
|
248
|
+
|
|
249
|
+
|
|
250
|
+
Name | Type | Description | Notes
|
|
251
|
+
------------- | ------------- | ------------- | -------------
|
|
252
|
+
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
|
|
253
|
+
**fields** | [**List[str]**](str.md)| A list of fields to include in the response. | [optional]
|
|
254
|
+
**exclude_fields** | [**List[str]**](str.md)| A list of fields to exclude from the response. | [optional]
|
|
255
|
+
|
|
256
|
+
### Return type
|
|
257
|
+
|
|
258
|
+
void (empty response body)
|
|
259
|
+
|
|
260
|
+
### Authorization
|
|
261
|
+
|
|
262
|
+
No authorization required
|
|
263
|
+
|
|
264
|
+
### HTTP request headers
|
|
265
|
+
|
|
266
|
+
- **Content-Type**: Not defined
|
|
267
|
+
- **Accept**: Not defined
|
|
268
|
+
|
|
269
|
+
### HTTP response details
|
|
270
|
+
|
|
271
|
+
| Status code | Description | Response headers |
|
|
272
|
+
|-------------|-------------|------------------|
|
|
273
|
+
**200** | No response body | - |
|
|
274
|
+
|
|
275
|
+
[[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)
|
|
276
|
+
|
|
277
|
+
# pulpcore.client.pulp_service.ApiTestTasksApi
|
|
278
|
+
|
|
279
|
+
All URIs are relative to *https://env-ephemeral-qfzgn7.apps.crc-eph.r9lp.p1.openshiftapps.com*
|
|
280
|
+
|
|
281
|
+
Method | HTTP request | Description
|
|
282
|
+
------------- | ------------- | -------------
|
|
283
|
+
[**get**](ApiTestTasksApi.md#get) | **GET** /api/pulp/test/tasks/ |
|
|
284
|
+
|
|
285
|
+
|
|
286
|
+
# **get**
|
|
287
|
+
> get(x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
|
|
288
|
+
|
|
289
|
+
|
|
290
|
+
|
|
291
|
+
### Example
|
|
292
|
+
|
|
293
|
+
|
|
294
|
+
```python
|
|
295
|
+
import pulpcore.client.pulp_service
|
|
296
|
+
from pulpcore.client.pulp_service.rest import ApiException
|
|
297
|
+
from pprint import pprint
|
|
298
|
+
|
|
299
|
+
# Defining the host is optional and defaults to https://env-ephemeral-qfzgn7.apps.crc-eph.r9lp.p1.openshiftapps.com
|
|
300
|
+
# See configuration.py for a list of all supported configuration parameters.
|
|
301
|
+
configuration = pulpcore.client.pulp_service.Configuration(
|
|
302
|
+
host = "https://env-ephemeral-qfzgn7.apps.crc-eph.r9lp.p1.openshiftapps.com"
|
|
303
|
+
)
|
|
304
|
+
|
|
305
|
+
|
|
306
|
+
# Enter a context with an instance of the API client
|
|
307
|
+
with pulpcore.client.pulp_service.ApiClient(configuration) as api_client:
|
|
308
|
+
# Create an instance of the API class
|
|
309
|
+
api_instance = pulpcore.client.pulp_service.ApiTestTasksApi(api_client)
|
|
310
|
+
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
|
|
311
|
+
fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
|
|
312
|
+
exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)
|
|
313
|
+
|
|
314
|
+
try:
|
|
315
|
+
api_instance.get(x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
|
|
316
|
+
except Exception as e:
|
|
317
|
+
print("Exception when calling ApiTestTasksApi->get: %s\n" % e)
|
|
318
|
+
```
|
|
319
|
+
|
|
320
|
+
|
|
321
|
+
|
|
322
|
+
### Parameters
|
|
323
|
+
|
|
324
|
+
|
|
325
|
+
Name | Type | Description | Notes
|
|
326
|
+
------------- | ------------- | ------------- | -------------
|
|
327
|
+
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
|
|
328
|
+
**fields** | [**List[str]**](str.md)| A list of fields to include in the response. | [optional]
|
|
329
|
+
**exclude_fields** | [**List[str]**](str.md)| A list of fields to exclude from the response. | [optional]
|
|
330
|
+
|
|
331
|
+
### Return type
|
|
332
|
+
|
|
333
|
+
void (empty response body)
|
|
334
|
+
|
|
335
|
+
### Authorization
|
|
336
|
+
|
|
337
|
+
No authorization required
|
|
338
|
+
|
|
339
|
+
### HTTP request headers
|
|
340
|
+
|
|
341
|
+
- **Content-Type**: Not defined
|
|
342
|
+
- **Accept**: Not defined
|
|
343
|
+
|
|
344
|
+
### HTTP response details
|
|
345
|
+
|
|
346
|
+
| Status code | Description | Response headers |
|
|
347
|
+
|-------------|-------------|------------------|
|
|
348
|
+
**200** | No response body | - |
|
|
349
|
+
|
|
350
|
+
[[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)
|
|
351
|
+
|
|
352
|
+
# AsyncOperationResponse
|
|
353
|
+
|
|
354
|
+
Serializer for asynchronous operations.
|
|
355
|
+
|
|
356
|
+
## Properties
|
|
357
|
+
|
|
358
|
+
Name | Type | Description | Notes
|
|
359
|
+
------------ | ------------- | ------------- | -------------
|
|
360
|
+
**task** | **str** | The href of the task. |
|
|
361
|
+
|
|
362
|
+
## Example
|
|
363
|
+
|
|
364
|
+
```python
|
|
365
|
+
from pulpcore.client.pulp_service.models.async_operation_response import AsyncOperationResponse
|
|
366
|
+
|
|
367
|
+
# TODO update the JSON string below
|
|
368
|
+
json = "{}"
|
|
369
|
+
# create an instance of AsyncOperationResponse from a JSON string
|
|
370
|
+
async_operation_response_instance = AsyncOperationResponse.from_json(json)
|
|
371
|
+
# print the JSON string representation of the object
|
|
372
|
+
print(AsyncOperationResponse.to_json())
|
|
373
|
+
|
|
374
|
+
# convert the object into a dict
|
|
375
|
+
async_operation_response_dict = async_operation_response_instance.to_dict()
|
|
376
|
+
# create an instance of AsyncOperationResponse from a dict
|
|
377
|
+
async_operation_response_from_dict = AsyncOperationResponse.from_dict(async_operation_response_dict)
|
|
378
|
+
```
|
|
379
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
380
|
+
|
|
381
|
+
|
|
382
|
+
# pulpcore.client.pulp_service.ContentguardsFeatureApi
|
|
383
|
+
|
|
384
|
+
All URIs are relative to *https://env-ephemeral-qfzgn7.apps.crc-eph.r9lp.p1.openshiftapps.com*
|
|
385
|
+
|
|
386
|
+
Method | HTTP request | Description
|
|
387
|
+
------------- | ------------- | -------------
|
|
388
|
+
[**add_role**](ContentguardsFeatureApi.md#add_role) | **POST** {service_feature_content_guard_href}add_role/ | Add a role
|
|
389
|
+
[**create**](ContentguardsFeatureApi.md#create) | **POST** /api/pulp/{pulp_domain}/api/v3/contentguards/service/feature/ | Create a feature content guard
|
|
390
|
+
[**delete**](ContentguardsFeatureApi.md#delete) | **DELETE** {service_feature_content_guard_href} | Delete a feature content guard
|
|
391
|
+
[**list**](ContentguardsFeatureApi.md#list) | **GET** /api/pulp/{pulp_domain}/api/v3/contentguards/service/feature/ | List feature content guards
|
|
392
|
+
[**list_roles**](ContentguardsFeatureApi.md#list_roles) | **GET** {service_feature_content_guard_href}list_roles/ | List roles
|
|
393
|
+
[**my_permissions**](ContentguardsFeatureApi.md#my_permissions) | **GET** {service_feature_content_guard_href}my_permissions/ | List user permissions
|
|
394
|
+
[**partial_update**](ContentguardsFeatureApi.md#partial_update) | **PATCH** {service_feature_content_guard_href} | Update a feature content guard
|
|
395
|
+
[**read**](ContentguardsFeatureApi.md#read) | **GET** {service_feature_content_guard_href} | Inspect a feature content guard
|
|
396
|
+
[**remove_role**](ContentguardsFeatureApi.md#remove_role) | **POST** {service_feature_content_guard_href}remove_role/ | Remove a role
|
|
397
|
+
[**update**](ContentguardsFeatureApi.md#update) | **PUT** {service_feature_content_guard_href} | Update a feature content guard
|
|
398
|
+
|
|
399
|
+
|
|
400
|
+
# **add_role**
|
|
401
|
+
> NestedRoleResponse add_role(service_feature_content_guard_href, nested_role, x_task_diagnostics=x_task_diagnostics)
|
|
402
|
+
|
|
403
|
+
Add a role
|
|
404
|
+
|
|
405
|
+
Add a role for this object to users/groups.
|
|
406
|
+
|
|
407
|
+
### Example
|
|
408
|
+
|
|
409
|
+
* OAuth Authentication (json_header_remote_authentication):
|
|
410
|
+
* Basic Authentication (basicAuth):
|
|
411
|
+
* Api Key Authentication (cookieAuth):
|
|
412
|
+
|
|
413
|
+
```python
|
|
414
|
+
import pulpcore.client.pulp_service
|
|
415
|
+
from pulpcore.client.pulp_service.models.nested_role import NestedRole
|
|
416
|
+
from pulpcore.client.pulp_service.models.nested_role_response import NestedRoleResponse
|
|
417
|
+
from pulpcore.client.pulp_service.rest import ApiException
|
|
418
|
+
from pprint import pprint
|
|
419
|
+
|
|
420
|
+
# Defining the host is optional and defaults to https://env-ephemeral-qfzgn7.apps.crc-eph.r9lp.p1.openshiftapps.com
|
|
421
|
+
# See configuration.py for a list of all supported configuration parameters.
|
|
422
|
+
configuration = pulpcore.client.pulp_service.Configuration(
|
|
423
|
+
host = "https://env-ephemeral-qfzgn7.apps.crc-eph.r9lp.p1.openshiftapps.com"
|
|
424
|
+
)
|
|
425
|
+
|
|
426
|
+
# The client must configure the authentication and authorization parameters
|
|
427
|
+
# in accordance with the API server security policy.
|
|
428
|
+
# Examples for each auth method are provided below, use the example that
|
|
429
|
+
# satisfies your auth use case.
|
|
430
|
+
|
|
431
|
+
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
432
|
+
|
|
433
|
+
# Configure HTTP basic authorization: basicAuth
|
|
434
|
+
configuration = pulpcore.client.pulp_service.Configuration(
|
|
435
|
+
username = os.environ["USERNAME"],
|
|
436
|
+
password = os.environ["PASSWORD"]
|
|
437
|
+
)
|
|
438
|
+
|
|
439
|
+
# Configure API key authorization: cookieAuth
|
|
440
|
+
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
|
|
441
|
+
|
|
442
|
+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
443
|
+
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
|
|
444
|
+
|
|
445
|
+
# Enter a context with an instance of the API client
|
|
446
|
+
with pulpcore.client.pulp_service.ApiClient(configuration) as api_client:
|
|
447
|
+
# Create an instance of the API class
|
|
448
|
+
api_instance = pulpcore.client.pulp_service.ContentguardsFeatureApi(api_client)
|
|
449
|
+
service_feature_content_guard_href = 'service_feature_content_guard_href_example' # str |
|
|
450
|
+
nested_role = pulpcore.client.pulp_service.NestedRole() # NestedRole |
|
|
451
|
+
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
|
|
452
|
+
|
|
453
|
+
try:
|
|
454
|
+
# Add a role
|
|
455
|
+
api_response = api_instance.add_role(service_feature_content_guard_href, nested_role, x_task_diagnostics=x_task_diagnostics)
|
|
456
|
+
print("The response of ContentguardsFeatureApi->add_role:\n")
|
|
457
|
+
pprint(api_response)
|
|
458
|
+
except Exception as e:
|
|
459
|
+
print("Exception when calling ContentguardsFeatureApi->add_role: %s\n" % e)
|
|
460
|
+
```
|
|
461
|
+
|
|
462
|
+
|
|
463
|
+
|
|
464
|
+
### Parameters
|
|
465
|
+
|
|
466
|
+
|
|
467
|
+
Name | Type | Description | Notes
|
|
468
|
+
------------- | ------------- | ------------- | -------------
|
|
469
|
+
**service_feature_content_guard_href** | **str**| |
|
|
470
|
+
**nested_role** | [**NestedRole**](NestedRole.md)| |
|
|
471
|
+
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
|
|
472
|
+
|
|
473
|
+
### Return type
|
|
474
|
+
|
|
475
|
+
[**NestedRoleResponse**](NestedRoleResponse.md)
|
|
476
|
+
|
|
477
|
+
### Authorization
|
|
478
|
+
|
|
479
|
+
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
|
|
480
|
+
|
|
481
|
+
### HTTP request headers
|
|
482
|
+
|
|
483
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
|
484
|
+
- **Accept**: application/json
|
|
485
|
+
|
|
486
|
+
### HTTP response details
|
|
487
|
+
|
|
488
|
+
| Status code | Description | Response headers |
|
|
489
|
+
|-------------|-------------|------------------|
|
|
490
|
+
**201** | | - |
|
|
491
|
+
|
|
492
|
+
[[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)
|
|
493
|
+
|
|
494
|
+
# **create**
|
|
495
|
+
> ServiceFeatureContentGuardResponse create(pulp_domain, service_feature_content_guard, x_task_diagnostics=x_task_diagnostics)
|
|
496
|
+
|
|
497
|
+
Create a feature content guard
|
|
498
|
+
|
|
499
|
+
Content guard to protect the content guarded by Subscription Features.
|
|
500
|
+
|
|
501
|
+
### Example
|
|
502
|
+
|
|
503
|
+
* OAuth Authentication (json_header_remote_authentication):
|
|
504
|
+
* Basic Authentication (basicAuth):
|
|
505
|
+
* Api Key Authentication (cookieAuth):
|
|
506
|
+
|
|
507
|
+
```python
|
|
508
|
+
import pulpcore.client.pulp_service
|
|
509
|
+
from pulpcore.client.pulp_service.models.service_feature_content_guard import ServiceFeatureContentGuard
|
|
510
|
+
from pulpcore.client.pulp_service.models.service_feature_content_guard_response import ServiceFeatureContentGuardResponse
|
|
511
|
+
from pulpcore.client.pulp_service.rest import ApiException
|
|
512
|
+
from pprint import pprint
|
|
513
|
+
|
|
514
|
+
# Defining the host is optional and defaults to https://env-ephemeral-qfzgn7.apps.crc-eph.r9lp.p1.openshiftapps.com
|
|
515
|
+
# See configuration.py for a list of all supported configuration parameters.
|
|
516
|
+
configuration = pulpcore.client.pulp_service.Configuration(
|
|
517
|
+
host = "https://env-ephemeral-qfzgn7.apps.crc-eph.r9lp.p1.openshiftapps.com"
|
|
518
|
+
)
|
|
519
|
+
|
|
520
|
+
# The client must configure the authentication and authorization parameters
|
|
521
|
+
# in accordance with the API server security policy.
|
|
522
|
+
# Examples for each auth method are provided below, use the example that
|
|
523
|
+
# satisfies your auth use case.
|
|
524
|
+
|
|
525
|
+
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
526
|
+
|
|
527
|
+
# Configure HTTP basic authorization: basicAuth
|
|
528
|
+
configuration = pulpcore.client.pulp_service.Configuration(
|
|
529
|
+
username = os.environ["USERNAME"],
|
|
530
|
+
password = os.environ["PASSWORD"]
|
|
531
|
+
)
|
|
532
|
+
|
|
533
|
+
# Configure API key authorization: cookieAuth
|
|
534
|
+
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
|
|
535
|
+
|
|
536
|
+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
537
|
+
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
|
|
538
|
+
|
|
539
|
+
# Enter a context with an instance of the API client
|
|
540
|
+
with pulpcore.client.pulp_service.ApiClient(configuration) as api_client:
|
|
541
|
+
# Create an instance of the API class
|
|
542
|
+
api_instance = pulpcore.client.pulp_service.ContentguardsFeatureApi(api_client)
|
|
543
|
+
pulp_domain = 'pulp_domain_example' # str |
|
|
544
|
+
service_feature_content_guard = pulpcore.client.pulp_service.ServiceFeatureContentGuard() # ServiceFeatureContentGuard |
|
|
545
|
+
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
|
|
546
|
+
|
|
547
|
+
try:
|
|
548
|
+
# Create a feature content guard
|
|
549
|
+
api_response = api_instance.create(pulp_domain, service_feature_content_guard, x_task_diagnostics=x_task_diagnostics)
|
|
550
|
+
print("The response of ContentguardsFeatureApi->create:\n")
|
|
551
|
+
pprint(api_response)
|
|
552
|
+
except Exception as e:
|
|
553
|
+
print("Exception when calling ContentguardsFeatureApi->create: %s\n" % e)
|
|
554
|
+
```
|
|
555
|
+
|
|
556
|
+
|
|
557
|
+
|
|
558
|
+
### Parameters
|
|
559
|
+
|
|
560
|
+
|
|
561
|
+
Name | Type | Description | Notes
|
|
562
|
+
------------- | ------------- | ------------- | -------------
|
|
563
|
+
**pulp_domain** | **str**| |
|
|
564
|
+
**service_feature_content_guard** | [**ServiceFeatureContentGuard**](ServiceFeatureContentGuard.md)| |
|
|
565
|
+
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
|
|
566
|
+
|
|
567
|
+
### Return type
|
|
568
|
+
|
|
569
|
+
[**ServiceFeatureContentGuardResponse**](ServiceFeatureContentGuardResponse.md)
|
|
570
|
+
|
|
571
|
+
### Authorization
|
|
572
|
+
|
|
573
|
+
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
|
|
574
|
+
|
|
575
|
+
### HTTP request headers
|
|
576
|
+
|
|
577
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
|
578
|
+
- **Accept**: application/json
|
|
579
|
+
|
|
580
|
+
### HTTP response details
|
|
581
|
+
|
|
582
|
+
| Status code | Description | Response headers |
|
|
583
|
+
|-------------|-------------|------------------|
|
|
584
|
+
**201** | | - |
|
|
585
|
+
|
|
586
|
+
[[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)
|
|
587
|
+
|
|
588
|
+
# **delete**
|
|
589
|
+
> delete(service_feature_content_guard_href, x_task_diagnostics=x_task_diagnostics)
|
|
590
|
+
|
|
591
|
+
Delete a feature content guard
|
|
592
|
+
|
|
593
|
+
Content guard to protect the content guarded by Subscription Features.
|
|
594
|
+
|
|
595
|
+
### Example
|
|
596
|
+
|
|
597
|
+
* OAuth Authentication (json_header_remote_authentication):
|
|
598
|
+
* Basic Authentication (basicAuth):
|
|
599
|
+
* Api Key Authentication (cookieAuth):
|
|
600
|
+
|
|
601
|
+
```python
|
|
602
|
+
import pulpcore.client.pulp_service
|
|
603
|
+
from pulpcore.client.pulp_service.rest import ApiException
|
|
604
|
+
from pprint import pprint
|
|
605
|
+
|
|
606
|
+
# Defining the host is optional and defaults to https://env-ephemeral-qfzgn7.apps.crc-eph.r9lp.p1.openshiftapps.com
|
|
607
|
+
# See configuration.py for a list of all supported configuration parameters.
|
|
608
|
+
configuration = pulpcore.client.pulp_service.Configuration(
|
|
609
|
+
host = "https://env-ephemeral-qfzgn7.apps.crc-eph.r9lp.p1.openshiftapps.com"
|
|
610
|
+
)
|
|
611
|
+
|
|
612
|
+
# The client must configure the authentication and authorization parameters
|
|
613
|
+
# in accordance with the API server security policy.
|
|
614
|
+
# Examples for each auth method are provided below, use the example that
|
|
615
|
+
# satisfies your auth use case.
|
|
616
|
+
|
|
617
|
+
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
618
|
+
|
|
619
|
+
# Configure HTTP basic authorization: basicAuth
|
|
620
|
+
configuration = pulpcore.client.pulp_service.Configuration(
|
|
621
|
+
username = os.environ["USERNAME"],
|
|
622
|
+
password = os.environ["PASSWORD"]
|
|
623
|
+
)
|
|
624
|
+
|
|
625
|
+
# Configure API key authorization: cookieAuth
|
|
626
|
+
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
|
|
627
|
+
|
|
628
|
+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
629
|
+
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
|
|
630
|
+
|
|
631
|
+
# Enter a context with an instance of the API client
|
|
632
|
+
with pulpcore.client.pulp_service.ApiClient(configuration) as api_client:
|
|
633
|
+
# Create an instance of the API class
|
|
634
|
+
api_instance = pulpcore.client.pulp_service.ContentguardsFeatureApi(api_client)
|
|
635
|
+
service_feature_content_guard_href = 'service_feature_content_guard_href_example' # str |
|
|
636
|
+
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
|
|
637
|
+
|
|
638
|
+
try:
|
|
639
|
+
# Delete a feature content guard
|
|
640
|
+
api_instance.delete(service_feature_content_guard_href, x_task_diagnostics=x_task_diagnostics)
|
|
641
|
+
except Exception as e:
|
|
642
|
+
print("Exception when calling ContentguardsFeatureApi->delete: %s\n" % e)
|
|
643
|
+
```
|
|
644
|
+
|
|
645
|
+
|
|
646
|
+
|
|
647
|
+
### Parameters
|
|
648
|
+
|
|
649
|
+
|
|
650
|
+
Name | Type | Description | Notes
|
|
651
|
+
------------- | ------------- | ------------- | -------------
|
|
652
|
+
**service_feature_content_guard_href** | **str**| |
|
|
653
|
+
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
|
|
654
|
+
|
|
655
|
+
### Return type
|
|
656
|
+
|
|
657
|
+
void (empty response body)
|
|
658
|
+
|
|
659
|
+
### Authorization
|
|
660
|
+
|
|
661
|
+
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
|
|
662
|
+
|
|
663
|
+
### HTTP request headers
|
|
664
|
+
|
|
665
|
+
- **Content-Type**: Not defined
|
|
666
|
+
- **Accept**: Not defined
|
|
667
|
+
|
|
668
|
+
### HTTP response details
|
|
669
|
+
|
|
670
|
+
| Status code | Description | Response headers |
|
|
671
|
+
|-------------|-------------|------------------|
|
|
672
|
+
**204** | No response body | - |
|
|
673
|
+
|
|
674
|
+
[[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)
|
|
675
|
+
|
|
676
|
+
# **list**
|
|
677
|
+
> 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)
|
|
678
|
+
|
|
679
|
+
List feature content guards
|
|
680
|
+
|
|
681
|
+
Content guard to protect the content guarded by Subscription Features.
|
|
682
|
+
|
|
683
|
+
### Example
|
|
684
|
+
|
|
685
|
+
* OAuth Authentication (json_header_remote_authentication):
|
|
686
|
+
* Basic Authentication (basicAuth):
|
|
687
|
+
* Api Key Authentication (cookieAuth):
|
|
688
|
+
|
|
689
|
+
```python
|
|
690
|
+
import pulpcore.client.pulp_service
|
|
691
|
+
from pulpcore.client.pulp_service.models.paginatedservice_feature_content_guard_response_list import PaginatedserviceFeatureContentGuardResponseList
|
|
692
|
+
from pulpcore.client.pulp_service.rest import ApiException
|
|
693
|
+
from pprint import pprint
|
|
694
|
+
|
|
695
|
+
# Defining the host is optional and defaults to https://env-ephemeral-qfzgn7.apps.crc-eph.r9lp.p1.openshiftapps.com
|
|
696
|
+
# See configuration.py for a list of all supported configuration parameters.
|
|
697
|
+
configuration = pulpcore.client.pulp_service.Configuration(
|
|
698
|
+
host = "https://env-ephemeral-qfzgn7.apps.crc-eph.r9lp.p1.openshiftapps.com"
|
|
699
|
+
)
|
|
700
|
+
|
|
701
|
+
# The client must configure the authentication and authorization parameters
|
|
702
|
+
# in accordance with the API server security policy.
|
|
703
|
+
# Examples for each auth method are provided below, use the example that
|
|
704
|
+
# satisfies your auth use case.
|
|
705
|
+
|
|
706
|
+
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
707
|
+
|
|
708
|
+
# Configure HTTP basic authorization: basicAuth
|
|
709
|
+
configuration = pulpcore.client.pulp_service.Configuration(
|
|
710
|
+
username = os.environ["USERNAME"],
|
|
711
|
+
password = os.environ["PASSWORD"]
|
|
712
|
+
)
|
|
713
|
+
|
|
714
|
+
# Configure API key authorization: cookieAuth
|
|
715
|
+
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
|
|
716
|
+
|
|
717
|
+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
718
|
+
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
|
|
719
|
+
|
|
720
|
+
# Enter a context with an instance of the API client
|
|
721
|
+
with pulpcore.client.pulp_service.ApiClient(configuration) as api_client:
|
|
722
|
+
# Create an instance of the API class
|
|
723
|
+
api_instance = pulpcore.client.pulp_service.ContentguardsFeatureApi(api_client)
|
|
724
|
+
pulp_domain = 'pulp_domain_example' # str |
|
|
725
|
+
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
|
|
726
|
+
limit = 56 # int | Number of results to return per page. (optional)
|
|
727
|
+
name = 'name_example' # str | Filter results where name matches value (optional)
|
|
728
|
+
name__contains = 'name__contains_example' # str | Filter results where name contains value (optional)
|
|
729
|
+
name__icontains = 'name__icontains_example' # str | Filter results where name contains value (optional)
|
|
730
|
+
name__iexact = 'name__iexact_example' # str | Filter results where name matches value (optional)
|
|
731
|
+
name__in = ['name__in_example'] # List[str] | Filter results where name is in a comma-separated list of values (optional)
|
|
732
|
+
name__iregex = 'name__iregex_example' # str | Filter results where name matches regex value (optional)
|
|
733
|
+
name__istartswith = 'name__istartswith_example' # str | Filter results where name starts with value (optional)
|
|
734
|
+
name__regex = 'name__regex_example' # str | Filter results where name matches regex value (optional)
|
|
735
|
+
name__startswith = 'name__startswith_example' # str | Filter results where name starts with value (optional)
|
|
736
|
+
offset = 56 # int | The initial index from which to return the results. (optional)
|
|
737
|
+
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)
|
|
738
|
+
prn__in = ['prn__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
|
|
739
|
+
pulp_href__in = ['pulp_href__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
|
|
740
|
+
pulp_id__in = ['pulp_id__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
|
|
741
|
+
q = 'q_example' # str | Filter results by using NOT, AND and OR operations on other filters (optional)
|
|
742
|
+
fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
|
|
743
|
+
exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)
|
|
744
|
+
|
|
745
|
+
try:
|
|
746
|
+
# List feature content guards
|
|
747
|
+
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)
|
|
748
|
+
print("The response of ContentguardsFeatureApi->list:\n")
|
|
749
|
+
pprint(api_response)
|
|
750
|
+
except Exception as e:
|
|
751
|
+
print("Exception when calling ContentguardsFeatureApi->list: %s\n" % e)
|
|
752
|
+
```
|
|
753
|
+
|
|
754
|
+
|
|
755
|
+
|
|
756
|
+
### Parameters
|
|
757
|
+
|
|
758
|
+
|
|
759
|
+
Name | Type | Description | Notes
|
|
760
|
+
------------- | ------------- | ------------- | -------------
|
|
761
|
+
**pulp_domain** | **str**| |
|
|
762
|
+
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
|
|
763
|
+
**limit** | **int**| Number of results to return per page. | [optional]
|
|
764
|
+
**name** | **str**| Filter results where name matches value | [optional]
|
|
765
|
+
**name__contains** | **str**| Filter results where name contains value | [optional]
|
|
766
|
+
**name__icontains** | **str**| Filter results where name contains value | [optional]
|
|
767
|
+
**name__iexact** | **str**| Filter results where name matches value | [optional]
|
|
768
|
+
**name__in** | [**List[str]**](str.md)| Filter results where name is in a comma-separated list of values | [optional]
|
|
769
|
+
**name__iregex** | **str**| Filter results where name matches regex value | [optional]
|
|
770
|
+
**name__istartswith** | **str**| Filter results where name starts with value | [optional]
|
|
771
|
+
**name__regex** | **str**| Filter results where name matches regex value | [optional]
|
|
772
|
+
**name__startswith** | **str**| Filter results where name starts with value | [optional]
|
|
773
|
+
**offset** | **int**| The initial index from which to return the results. | [optional]
|
|
774
|
+
**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]
|
|
775
|
+
**prn__in** | [**List[str]**](str.md)| Multiple values may be separated by commas. | [optional]
|
|
776
|
+
**pulp_href__in** | [**List[str]**](str.md)| Multiple values may be separated by commas. | [optional]
|
|
777
|
+
**pulp_id__in** | [**List[str]**](str.md)| Multiple values may be separated by commas. | [optional]
|
|
778
|
+
**q** | **str**| Filter results by using NOT, AND and OR operations on other filters | [optional]
|
|
779
|
+
**fields** | [**List[str]**](str.md)| A list of fields to include in the response. | [optional]
|
|
780
|
+
**exclude_fields** | [**List[str]**](str.md)| A list of fields to exclude from the response. | [optional]
|
|
781
|
+
|
|
782
|
+
### Return type
|
|
783
|
+
|
|
784
|
+
[**PaginatedserviceFeatureContentGuardResponseList**](PaginatedserviceFeatureContentGuardResponseList.md)
|
|
785
|
+
|
|
786
|
+
### Authorization
|
|
787
|
+
|
|
788
|
+
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
|
|
789
|
+
|
|
790
|
+
### HTTP request headers
|
|
791
|
+
|
|
792
|
+
- **Content-Type**: Not defined
|
|
793
|
+
- **Accept**: application/json
|
|
794
|
+
|
|
795
|
+
### HTTP response details
|
|
796
|
+
|
|
797
|
+
| Status code | Description | Response headers |
|
|
798
|
+
|-------------|-------------|------------------|
|
|
799
|
+
**200** | | - |
|
|
800
|
+
|
|
801
|
+
[[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)
|
|
802
|
+
|
|
803
|
+
# **list_roles**
|
|
804
|
+
> ObjectRolesResponse list_roles(service_feature_content_guard_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
|
|
805
|
+
|
|
806
|
+
List roles
|
|
807
|
+
|
|
808
|
+
List roles assigned to this object.
|
|
809
|
+
|
|
810
|
+
### Example
|
|
811
|
+
|
|
812
|
+
* OAuth Authentication (json_header_remote_authentication):
|
|
813
|
+
* Basic Authentication (basicAuth):
|
|
814
|
+
* Api Key Authentication (cookieAuth):
|
|
815
|
+
|
|
816
|
+
```python
|
|
817
|
+
import pulpcore.client.pulp_service
|
|
818
|
+
from pulpcore.client.pulp_service.models.object_roles_response import ObjectRolesResponse
|
|
819
|
+
from pulpcore.client.pulp_service.rest import ApiException
|
|
820
|
+
from pprint import pprint
|
|
821
|
+
|
|
822
|
+
# Defining the host is optional and defaults to https://env-ephemeral-qfzgn7.apps.crc-eph.r9lp.p1.openshiftapps.com
|
|
823
|
+
# See configuration.py for a list of all supported configuration parameters.
|
|
824
|
+
configuration = pulpcore.client.pulp_service.Configuration(
|
|
825
|
+
host = "https://env-ephemeral-qfzgn7.apps.crc-eph.r9lp.p1.openshiftapps.com"
|
|
826
|
+
)
|
|
827
|
+
|
|
828
|
+
# The client must configure the authentication and authorization parameters
|
|
829
|
+
# in accordance with the API server security policy.
|
|
830
|
+
# Examples for each auth method are provided below, use the example that
|
|
831
|
+
# satisfies your auth use case.
|
|
832
|
+
|
|
833
|
+
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
834
|
+
|
|
835
|
+
# Configure HTTP basic authorization: basicAuth
|
|
836
|
+
configuration = pulpcore.client.pulp_service.Configuration(
|
|
837
|
+
username = os.environ["USERNAME"],
|
|
838
|
+
password = os.environ["PASSWORD"]
|
|
839
|
+
)
|
|
840
|
+
|
|
841
|
+
# Configure API key authorization: cookieAuth
|
|
842
|
+
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
|
|
843
|
+
|
|
844
|
+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
845
|
+
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
|
|
846
|
+
|
|
847
|
+
# Enter a context with an instance of the API client
|
|
848
|
+
with pulpcore.client.pulp_service.ApiClient(configuration) as api_client:
|
|
849
|
+
# Create an instance of the API class
|
|
850
|
+
api_instance = pulpcore.client.pulp_service.ContentguardsFeatureApi(api_client)
|
|
851
|
+
service_feature_content_guard_href = 'service_feature_content_guard_href_example' # str |
|
|
852
|
+
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
|
|
853
|
+
fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
|
|
854
|
+
exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)
|
|
855
|
+
|
|
856
|
+
try:
|
|
857
|
+
# List roles
|
|
858
|
+
api_response = api_instance.list_roles(service_feature_content_guard_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
|
|
859
|
+
print("The response of ContentguardsFeatureApi->list_roles:\n")
|
|
860
|
+
pprint(api_response)
|
|
861
|
+
except Exception as e:
|
|
862
|
+
print("Exception when calling ContentguardsFeatureApi->list_roles: %s\n" % e)
|
|
863
|
+
```
|
|
864
|
+
|
|
865
|
+
|
|
866
|
+
|
|
867
|
+
### Parameters
|
|
868
|
+
|
|
869
|
+
|
|
870
|
+
Name | Type | Description | Notes
|
|
871
|
+
------------- | ------------- | ------------- | -------------
|
|
872
|
+
**service_feature_content_guard_href** | **str**| |
|
|
873
|
+
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
|
|
874
|
+
**fields** | [**List[str]**](str.md)| A list of fields to include in the response. | [optional]
|
|
875
|
+
**exclude_fields** | [**List[str]**](str.md)| A list of fields to exclude from the response. | [optional]
|
|
876
|
+
|
|
877
|
+
### Return type
|
|
878
|
+
|
|
879
|
+
[**ObjectRolesResponse**](ObjectRolesResponse.md)
|
|
880
|
+
|
|
881
|
+
### Authorization
|
|
882
|
+
|
|
883
|
+
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
|
|
884
|
+
|
|
885
|
+
### HTTP request headers
|
|
886
|
+
|
|
887
|
+
- **Content-Type**: Not defined
|
|
888
|
+
- **Accept**: application/json
|
|
889
|
+
|
|
890
|
+
### HTTP response details
|
|
891
|
+
|
|
892
|
+
| Status code | Description | Response headers |
|
|
893
|
+
|-------------|-------------|------------------|
|
|
894
|
+
**200** | | - |
|
|
895
|
+
|
|
896
|
+
[[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)
|
|
897
|
+
|
|
898
|
+
# **my_permissions**
|
|
899
|
+
> MyPermissionsResponse my_permissions(service_feature_content_guard_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
|
|
900
|
+
|
|
901
|
+
List user permissions
|
|
902
|
+
|
|
903
|
+
List permissions available to the current user on this object.
|
|
904
|
+
|
|
905
|
+
### Example
|
|
906
|
+
|
|
907
|
+
* OAuth Authentication (json_header_remote_authentication):
|
|
908
|
+
* Basic Authentication (basicAuth):
|
|
909
|
+
* Api Key Authentication (cookieAuth):
|
|
910
|
+
|
|
911
|
+
```python
|
|
912
|
+
import pulpcore.client.pulp_service
|
|
913
|
+
from pulpcore.client.pulp_service.models.my_permissions_response import MyPermissionsResponse
|
|
914
|
+
from pulpcore.client.pulp_service.rest import ApiException
|
|
915
|
+
from pprint import pprint
|
|
916
|
+
|
|
917
|
+
# Defining the host is optional and defaults to https://env-ephemeral-qfzgn7.apps.crc-eph.r9lp.p1.openshiftapps.com
|
|
918
|
+
# See configuration.py for a list of all supported configuration parameters.
|
|
919
|
+
configuration = pulpcore.client.pulp_service.Configuration(
|
|
920
|
+
host = "https://env-ephemeral-qfzgn7.apps.crc-eph.r9lp.p1.openshiftapps.com"
|
|
921
|
+
)
|
|
922
|
+
|
|
923
|
+
# The client must configure the authentication and authorization parameters
|
|
924
|
+
# in accordance with the API server security policy.
|
|
925
|
+
# Examples for each auth method are provided below, use the example that
|
|
926
|
+
# satisfies your auth use case.
|
|
927
|
+
|
|
928
|
+
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
929
|
+
|
|
930
|
+
# Configure HTTP basic authorization: basicAuth
|
|
931
|
+
configuration = pulpcore.client.pulp_service.Configuration(
|
|
932
|
+
username = os.environ["USERNAME"],
|
|
933
|
+
password = os.environ["PASSWORD"]
|
|
934
|
+
)
|
|
935
|
+
|
|
936
|
+
# Configure API key authorization: cookieAuth
|
|
937
|
+
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
|
|
938
|
+
|
|
939
|
+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
940
|
+
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
|
|
941
|
+
|
|
942
|
+
# Enter a context with an instance of the API client
|
|
943
|
+
with pulpcore.client.pulp_service.ApiClient(configuration) as api_client:
|
|
944
|
+
# Create an instance of the API class
|
|
945
|
+
api_instance = pulpcore.client.pulp_service.ContentguardsFeatureApi(api_client)
|
|
946
|
+
service_feature_content_guard_href = 'service_feature_content_guard_href_example' # str |
|
|
947
|
+
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
|
|
948
|
+
fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
|
|
949
|
+
exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)
|
|
950
|
+
|
|
951
|
+
try:
|
|
952
|
+
# List user permissions
|
|
953
|
+
api_response = api_instance.my_permissions(service_feature_content_guard_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
|
|
954
|
+
print("The response of ContentguardsFeatureApi->my_permissions:\n")
|
|
955
|
+
pprint(api_response)
|
|
956
|
+
except Exception as e:
|
|
957
|
+
print("Exception when calling ContentguardsFeatureApi->my_permissions: %s\n" % e)
|
|
958
|
+
```
|
|
959
|
+
|
|
960
|
+
|
|
961
|
+
|
|
962
|
+
### Parameters
|
|
963
|
+
|
|
964
|
+
|
|
965
|
+
Name | Type | Description | Notes
|
|
966
|
+
------------- | ------------- | ------------- | -------------
|
|
967
|
+
**service_feature_content_guard_href** | **str**| |
|
|
968
|
+
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
|
|
969
|
+
**fields** | [**List[str]**](str.md)| A list of fields to include in the response. | [optional]
|
|
970
|
+
**exclude_fields** | [**List[str]**](str.md)| A list of fields to exclude from the response. | [optional]
|
|
971
|
+
|
|
972
|
+
### Return type
|
|
973
|
+
|
|
974
|
+
[**MyPermissionsResponse**](MyPermissionsResponse.md)
|
|
975
|
+
|
|
976
|
+
### Authorization
|
|
977
|
+
|
|
978
|
+
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
|
|
979
|
+
|
|
980
|
+
### HTTP request headers
|
|
981
|
+
|
|
982
|
+
- **Content-Type**: Not defined
|
|
983
|
+
- **Accept**: application/json
|
|
984
|
+
|
|
985
|
+
### HTTP response details
|
|
986
|
+
|
|
987
|
+
| Status code | Description | Response headers |
|
|
988
|
+
|-------------|-------------|------------------|
|
|
989
|
+
**200** | | - |
|
|
990
|
+
|
|
991
|
+
[[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)
|
|
992
|
+
|
|
993
|
+
# **partial_update**
|
|
994
|
+
> ServiceFeatureContentGuardResponse partial_update(service_feature_content_guard_href, patchedservice_feature_content_guard, x_task_diagnostics=x_task_diagnostics)
|
|
995
|
+
|
|
996
|
+
Update a feature content guard
|
|
997
|
+
|
|
998
|
+
Content guard to protect the content guarded by Subscription Features.
|
|
999
|
+
|
|
1000
|
+
### Example
|
|
1001
|
+
|
|
1002
|
+
* OAuth Authentication (json_header_remote_authentication):
|
|
1003
|
+
* Basic Authentication (basicAuth):
|
|
1004
|
+
* Api Key Authentication (cookieAuth):
|
|
1005
|
+
|
|
1006
|
+
```python
|
|
1007
|
+
import pulpcore.client.pulp_service
|
|
1008
|
+
from pulpcore.client.pulp_service.models.patchedservice_feature_content_guard import PatchedserviceFeatureContentGuard
|
|
1009
|
+
from pulpcore.client.pulp_service.models.service_feature_content_guard_response import ServiceFeatureContentGuardResponse
|
|
1010
|
+
from pulpcore.client.pulp_service.rest import ApiException
|
|
1011
|
+
from pprint import pprint
|
|
1012
|
+
|
|
1013
|
+
# Defining the host is optional and defaults to https://env-ephemeral-qfzgn7.apps.crc-eph.r9lp.p1.openshiftapps.com
|
|
1014
|
+
# See configuration.py for a list of all supported configuration parameters.
|
|
1015
|
+
configuration = pulpcore.client.pulp_service.Configuration(
|
|
1016
|
+
host = "https://env-ephemeral-qfzgn7.apps.crc-eph.r9lp.p1.openshiftapps.com"
|
|
1017
|
+
)
|
|
1018
|
+
|
|
1019
|
+
# The client must configure the authentication and authorization parameters
|
|
1020
|
+
# in accordance with the API server security policy.
|
|
1021
|
+
# Examples for each auth method are provided below, use the example that
|
|
1022
|
+
# satisfies your auth use case.
|
|
1023
|
+
|
|
1024
|
+
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
1025
|
+
|
|
1026
|
+
# Configure HTTP basic authorization: basicAuth
|
|
1027
|
+
configuration = pulpcore.client.pulp_service.Configuration(
|
|
1028
|
+
username = os.environ["USERNAME"],
|
|
1029
|
+
password = os.environ["PASSWORD"]
|
|
1030
|
+
)
|
|
1031
|
+
|
|
1032
|
+
# Configure API key authorization: cookieAuth
|
|
1033
|
+
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
|
|
1034
|
+
|
|
1035
|
+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
1036
|
+
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
|
|
1037
|
+
|
|
1038
|
+
# Enter a context with an instance of the API client
|
|
1039
|
+
with pulpcore.client.pulp_service.ApiClient(configuration) as api_client:
|
|
1040
|
+
# Create an instance of the API class
|
|
1041
|
+
api_instance = pulpcore.client.pulp_service.ContentguardsFeatureApi(api_client)
|
|
1042
|
+
service_feature_content_guard_href = 'service_feature_content_guard_href_example' # str |
|
|
1043
|
+
patchedservice_feature_content_guard = pulpcore.client.pulp_service.PatchedserviceFeatureContentGuard() # PatchedserviceFeatureContentGuard |
|
|
1044
|
+
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
|
|
1045
|
+
|
|
1046
|
+
try:
|
|
1047
|
+
# Update a feature content guard
|
|
1048
|
+
api_response = api_instance.partial_update(service_feature_content_guard_href, patchedservice_feature_content_guard, x_task_diagnostics=x_task_diagnostics)
|
|
1049
|
+
print("The response of ContentguardsFeatureApi->partial_update:\n")
|
|
1050
|
+
pprint(api_response)
|
|
1051
|
+
except Exception as e:
|
|
1052
|
+
print("Exception when calling ContentguardsFeatureApi->partial_update: %s\n" % e)
|
|
1053
|
+
```
|
|
1054
|
+
|
|
1055
|
+
|
|
1056
|
+
|
|
1057
|
+
### Parameters
|
|
1058
|
+
|
|
1059
|
+
|
|
1060
|
+
Name | Type | Description | Notes
|
|
1061
|
+
------------- | ------------- | ------------- | -------------
|
|
1062
|
+
**service_feature_content_guard_href** | **str**| |
|
|
1063
|
+
**patchedservice_feature_content_guard** | [**PatchedserviceFeatureContentGuard**](PatchedserviceFeatureContentGuard.md)| |
|
|
1064
|
+
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
|
|
1065
|
+
|
|
1066
|
+
### Return type
|
|
1067
|
+
|
|
1068
|
+
[**ServiceFeatureContentGuardResponse**](ServiceFeatureContentGuardResponse.md)
|
|
1069
|
+
|
|
1070
|
+
### Authorization
|
|
1071
|
+
|
|
1072
|
+
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
|
|
1073
|
+
|
|
1074
|
+
### HTTP request headers
|
|
1075
|
+
|
|
1076
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
|
1077
|
+
- **Accept**: application/json
|
|
1078
|
+
|
|
1079
|
+
### HTTP response details
|
|
1080
|
+
|
|
1081
|
+
| Status code | Description | Response headers |
|
|
1082
|
+
|-------------|-------------|------------------|
|
|
1083
|
+
**200** | | - |
|
|
1084
|
+
|
|
1085
|
+
[[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)
|
|
1086
|
+
|
|
1087
|
+
# **read**
|
|
1088
|
+
> ServiceFeatureContentGuardResponse read(service_feature_content_guard_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
|
|
1089
|
+
|
|
1090
|
+
Inspect a feature content guard
|
|
1091
|
+
|
|
1092
|
+
Content guard to protect the content guarded by Subscription Features.
|
|
1093
|
+
|
|
1094
|
+
### Example
|
|
1095
|
+
|
|
1096
|
+
* OAuth Authentication (json_header_remote_authentication):
|
|
1097
|
+
* Basic Authentication (basicAuth):
|
|
1098
|
+
* Api Key Authentication (cookieAuth):
|
|
1099
|
+
|
|
1100
|
+
```python
|
|
1101
|
+
import pulpcore.client.pulp_service
|
|
1102
|
+
from pulpcore.client.pulp_service.models.service_feature_content_guard_response import ServiceFeatureContentGuardResponse
|
|
1103
|
+
from pulpcore.client.pulp_service.rest import ApiException
|
|
1104
|
+
from pprint import pprint
|
|
1105
|
+
|
|
1106
|
+
# Defining the host is optional and defaults to https://env-ephemeral-qfzgn7.apps.crc-eph.r9lp.p1.openshiftapps.com
|
|
1107
|
+
# See configuration.py for a list of all supported configuration parameters.
|
|
1108
|
+
configuration = pulpcore.client.pulp_service.Configuration(
|
|
1109
|
+
host = "https://env-ephemeral-qfzgn7.apps.crc-eph.r9lp.p1.openshiftapps.com"
|
|
1110
|
+
)
|
|
1111
|
+
|
|
1112
|
+
# The client must configure the authentication and authorization parameters
|
|
1113
|
+
# in accordance with the API server security policy.
|
|
1114
|
+
# Examples for each auth method are provided below, use the example that
|
|
1115
|
+
# satisfies your auth use case.
|
|
1116
|
+
|
|
1117
|
+
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
1118
|
+
|
|
1119
|
+
# Configure HTTP basic authorization: basicAuth
|
|
1120
|
+
configuration = pulpcore.client.pulp_service.Configuration(
|
|
1121
|
+
username = os.environ["USERNAME"],
|
|
1122
|
+
password = os.environ["PASSWORD"]
|
|
1123
|
+
)
|
|
1124
|
+
|
|
1125
|
+
# Configure API key authorization: cookieAuth
|
|
1126
|
+
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
|
|
1127
|
+
|
|
1128
|
+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
1129
|
+
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
|
|
1130
|
+
|
|
1131
|
+
# Enter a context with an instance of the API client
|
|
1132
|
+
with pulpcore.client.pulp_service.ApiClient(configuration) as api_client:
|
|
1133
|
+
# Create an instance of the API class
|
|
1134
|
+
api_instance = pulpcore.client.pulp_service.ContentguardsFeatureApi(api_client)
|
|
1135
|
+
service_feature_content_guard_href = 'service_feature_content_guard_href_example' # str |
|
|
1136
|
+
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
|
|
1137
|
+
fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
|
|
1138
|
+
exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)
|
|
1139
|
+
|
|
1140
|
+
try:
|
|
1141
|
+
# Inspect a feature content guard
|
|
1142
|
+
api_response = api_instance.read(service_feature_content_guard_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
|
|
1143
|
+
print("The response of ContentguardsFeatureApi->read:\n")
|
|
1144
|
+
pprint(api_response)
|
|
1145
|
+
except Exception as e:
|
|
1146
|
+
print("Exception when calling ContentguardsFeatureApi->read: %s\n" % e)
|
|
1147
|
+
```
|
|
1148
|
+
|
|
1149
|
+
|
|
1150
|
+
|
|
1151
|
+
### Parameters
|
|
1152
|
+
|
|
1153
|
+
|
|
1154
|
+
Name | Type | Description | Notes
|
|
1155
|
+
------------- | ------------- | ------------- | -------------
|
|
1156
|
+
**service_feature_content_guard_href** | **str**| |
|
|
1157
|
+
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
|
|
1158
|
+
**fields** | [**List[str]**](str.md)| A list of fields to include in the response. | [optional]
|
|
1159
|
+
**exclude_fields** | [**List[str]**](str.md)| A list of fields to exclude from the response. | [optional]
|
|
1160
|
+
|
|
1161
|
+
### Return type
|
|
1162
|
+
|
|
1163
|
+
[**ServiceFeatureContentGuardResponse**](ServiceFeatureContentGuardResponse.md)
|
|
1164
|
+
|
|
1165
|
+
### Authorization
|
|
1166
|
+
|
|
1167
|
+
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
|
|
1168
|
+
|
|
1169
|
+
### HTTP request headers
|
|
1170
|
+
|
|
1171
|
+
- **Content-Type**: Not defined
|
|
1172
|
+
- **Accept**: application/json
|
|
1173
|
+
|
|
1174
|
+
### HTTP response details
|
|
1175
|
+
|
|
1176
|
+
| Status code | Description | Response headers |
|
|
1177
|
+
|-------------|-------------|------------------|
|
|
1178
|
+
**200** | | - |
|
|
1179
|
+
|
|
1180
|
+
[[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)
|
|
1181
|
+
|
|
1182
|
+
# **remove_role**
|
|
1183
|
+
> NestedRoleResponse remove_role(service_feature_content_guard_href, nested_role, x_task_diagnostics=x_task_diagnostics)
|
|
1184
|
+
|
|
1185
|
+
Remove a role
|
|
1186
|
+
|
|
1187
|
+
Remove a role for this object from users/groups.
|
|
1188
|
+
|
|
1189
|
+
### Example
|
|
1190
|
+
|
|
1191
|
+
* OAuth Authentication (json_header_remote_authentication):
|
|
1192
|
+
* Basic Authentication (basicAuth):
|
|
1193
|
+
* Api Key Authentication (cookieAuth):
|
|
1194
|
+
|
|
1195
|
+
```python
|
|
1196
|
+
import pulpcore.client.pulp_service
|
|
1197
|
+
from pulpcore.client.pulp_service.models.nested_role import NestedRole
|
|
1198
|
+
from pulpcore.client.pulp_service.models.nested_role_response import NestedRoleResponse
|
|
1199
|
+
from pulpcore.client.pulp_service.rest import ApiException
|
|
1200
|
+
from pprint import pprint
|
|
1201
|
+
|
|
1202
|
+
# Defining the host is optional and defaults to https://env-ephemeral-qfzgn7.apps.crc-eph.r9lp.p1.openshiftapps.com
|
|
1203
|
+
# See configuration.py for a list of all supported configuration parameters.
|
|
1204
|
+
configuration = pulpcore.client.pulp_service.Configuration(
|
|
1205
|
+
host = "https://env-ephemeral-qfzgn7.apps.crc-eph.r9lp.p1.openshiftapps.com"
|
|
1206
|
+
)
|
|
1207
|
+
|
|
1208
|
+
# The client must configure the authentication and authorization parameters
|
|
1209
|
+
# in accordance with the API server security policy.
|
|
1210
|
+
# Examples for each auth method are provided below, use the example that
|
|
1211
|
+
# satisfies your auth use case.
|
|
1212
|
+
|
|
1213
|
+
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
1214
|
+
|
|
1215
|
+
# Configure HTTP basic authorization: basicAuth
|
|
1216
|
+
configuration = pulpcore.client.pulp_service.Configuration(
|
|
1217
|
+
username = os.environ["USERNAME"],
|
|
1218
|
+
password = os.environ["PASSWORD"]
|
|
1219
|
+
)
|
|
1220
|
+
|
|
1221
|
+
# Configure API key authorization: cookieAuth
|
|
1222
|
+
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
|
|
1223
|
+
|
|
1224
|
+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
1225
|
+
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
|
|
1226
|
+
|
|
1227
|
+
# Enter a context with an instance of the API client
|
|
1228
|
+
with pulpcore.client.pulp_service.ApiClient(configuration) as api_client:
|
|
1229
|
+
# Create an instance of the API class
|
|
1230
|
+
api_instance = pulpcore.client.pulp_service.ContentguardsFeatureApi(api_client)
|
|
1231
|
+
service_feature_content_guard_href = 'service_feature_content_guard_href_example' # str |
|
|
1232
|
+
nested_role = pulpcore.client.pulp_service.NestedRole() # NestedRole |
|
|
1233
|
+
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
|
|
1234
|
+
|
|
1235
|
+
try:
|
|
1236
|
+
# Remove a role
|
|
1237
|
+
api_response = api_instance.remove_role(service_feature_content_guard_href, nested_role, x_task_diagnostics=x_task_diagnostics)
|
|
1238
|
+
print("The response of ContentguardsFeatureApi->remove_role:\n")
|
|
1239
|
+
pprint(api_response)
|
|
1240
|
+
except Exception as e:
|
|
1241
|
+
print("Exception when calling ContentguardsFeatureApi->remove_role: %s\n" % e)
|
|
1242
|
+
```
|
|
1243
|
+
|
|
1244
|
+
|
|
1245
|
+
|
|
1246
|
+
### Parameters
|
|
1247
|
+
|
|
1248
|
+
|
|
1249
|
+
Name | Type | Description | Notes
|
|
1250
|
+
------------- | ------------- | ------------- | -------------
|
|
1251
|
+
**service_feature_content_guard_href** | **str**| |
|
|
1252
|
+
**nested_role** | [**NestedRole**](NestedRole.md)| |
|
|
1253
|
+
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
|
|
1254
|
+
|
|
1255
|
+
### Return type
|
|
1256
|
+
|
|
1257
|
+
[**NestedRoleResponse**](NestedRoleResponse.md)
|
|
1258
|
+
|
|
1259
|
+
### Authorization
|
|
1260
|
+
|
|
1261
|
+
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
|
|
1262
|
+
|
|
1263
|
+
### HTTP request headers
|
|
1264
|
+
|
|
1265
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
|
1266
|
+
- **Accept**: application/json
|
|
1267
|
+
|
|
1268
|
+
### HTTP response details
|
|
1269
|
+
|
|
1270
|
+
| Status code | Description | Response headers |
|
|
1271
|
+
|-------------|-------------|------------------|
|
|
1272
|
+
**201** | | - |
|
|
1273
|
+
|
|
1274
|
+
[[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)
|
|
1275
|
+
|
|
1276
|
+
# **update**
|
|
1277
|
+
> ServiceFeatureContentGuardResponse update(service_feature_content_guard_href, service_feature_content_guard, x_task_diagnostics=x_task_diagnostics)
|
|
1278
|
+
|
|
1279
|
+
Update a feature content guard
|
|
1280
|
+
|
|
1281
|
+
Content guard to protect the content guarded by Subscription Features.
|
|
1282
|
+
|
|
1283
|
+
### Example
|
|
1284
|
+
|
|
1285
|
+
* OAuth Authentication (json_header_remote_authentication):
|
|
1286
|
+
* Basic Authentication (basicAuth):
|
|
1287
|
+
* Api Key Authentication (cookieAuth):
|
|
1288
|
+
|
|
1289
|
+
```python
|
|
1290
|
+
import pulpcore.client.pulp_service
|
|
1291
|
+
from pulpcore.client.pulp_service.models.service_feature_content_guard import ServiceFeatureContentGuard
|
|
1292
|
+
from pulpcore.client.pulp_service.models.service_feature_content_guard_response import ServiceFeatureContentGuardResponse
|
|
1293
|
+
from pulpcore.client.pulp_service.rest import ApiException
|
|
1294
|
+
from pprint import pprint
|
|
1295
|
+
|
|
1296
|
+
# Defining the host is optional and defaults to https://env-ephemeral-qfzgn7.apps.crc-eph.r9lp.p1.openshiftapps.com
|
|
1297
|
+
# See configuration.py for a list of all supported configuration parameters.
|
|
1298
|
+
configuration = pulpcore.client.pulp_service.Configuration(
|
|
1299
|
+
host = "https://env-ephemeral-qfzgn7.apps.crc-eph.r9lp.p1.openshiftapps.com"
|
|
1300
|
+
)
|
|
1301
|
+
|
|
1302
|
+
# The client must configure the authentication and authorization parameters
|
|
1303
|
+
# in accordance with the API server security policy.
|
|
1304
|
+
# Examples for each auth method are provided below, use the example that
|
|
1305
|
+
# satisfies your auth use case.
|
|
1306
|
+
|
|
1307
|
+
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
1308
|
+
|
|
1309
|
+
# Configure HTTP basic authorization: basicAuth
|
|
1310
|
+
configuration = pulpcore.client.pulp_service.Configuration(
|
|
1311
|
+
username = os.environ["USERNAME"],
|
|
1312
|
+
password = os.environ["PASSWORD"]
|
|
1313
|
+
)
|
|
1314
|
+
|
|
1315
|
+
# Configure API key authorization: cookieAuth
|
|
1316
|
+
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
|
|
1317
|
+
|
|
1318
|
+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
1319
|
+
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
|
|
1320
|
+
|
|
1321
|
+
# Enter a context with an instance of the API client
|
|
1322
|
+
with pulpcore.client.pulp_service.ApiClient(configuration) as api_client:
|
|
1323
|
+
# Create an instance of the API class
|
|
1324
|
+
api_instance = pulpcore.client.pulp_service.ContentguardsFeatureApi(api_client)
|
|
1325
|
+
service_feature_content_guard_href = 'service_feature_content_guard_href_example' # str |
|
|
1326
|
+
service_feature_content_guard = pulpcore.client.pulp_service.ServiceFeatureContentGuard() # ServiceFeatureContentGuard |
|
|
1327
|
+
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
|
|
1328
|
+
|
|
1329
|
+
try:
|
|
1330
|
+
# Update a feature content guard
|
|
1331
|
+
api_response = api_instance.update(service_feature_content_guard_href, service_feature_content_guard, x_task_diagnostics=x_task_diagnostics)
|
|
1332
|
+
print("The response of ContentguardsFeatureApi->update:\n")
|
|
1333
|
+
pprint(api_response)
|
|
1334
|
+
except Exception as e:
|
|
1335
|
+
print("Exception when calling ContentguardsFeatureApi->update: %s\n" % e)
|
|
1336
|
+
```
|
|
1337
|
+
|
|
1338
|
+
|
|
1339
|
+
|
|
1340
|
+
### Parameters
|
|
1341
|
+
|
|
1342
|
+
|
|
1343
|
+
Name | Type | Description | Notes
|
|
1344
|
+
------------- | ------------- | ------------- | -------------
|
|
1345
|
+
**service_feature_content_guard_href** | **str**| |
|
|
1346
|
+
**service_feature_content_guard** | [**ServiceFeatureContentGuard**](ServiceFeatureContentGuard.md)| |
|
|
1347
|
+
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
|
|
1348
|
+
|
|
1349
|
+
### Return type
|
|
1350
|
+
|
|
1351
|
+
[**ServiceFeatureContentGuardResponse**](ServiceFeatureContentGuardResponse.md)
|
|
1352
|
+
|
|
1353
|
+
### Authorization
|
|
1354
|
+
|
|
1355
|
+
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
|
|
1356
|
+
|
|
1357
|
+
### HTTP request headers
|
|
1358
|
+
|
|
1359
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
|
1360
|
+
- **Accept**: application/json
|
|
1361
|
+
|
|
1362
|
+
### HTTP response details
|
|
1363
|
+
|
|
1364
|
+
| Status code | Description | Response headers |
|
|
1365
|
+
|-------------|-------------|------------------|
|
|
1366
|
+
**200** | | - |
|
|
1367
|
+
|
|
1368
|
+
[[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)
|
|
1369
|
+
|
|
1370
|
+
# Domain
|
|
1371
|
+
|
|
1372
|
+
Serializer for Domain.
|
|
1373
|
+
|
|
1374
|
+
## Properties
|
|
1375
|
+
|
|
1376
|
+
Name | Type | Description | Notes
|
|
1377
|
+
------------ | ------------- | ------------- | -------------
|
|
1378
|
+
**name** | **str** | A name for this domain. |
|
|
1379
|
+
**description** | **str** | An optional description. | [optional]
|
|
1380
|
+
**pulp_labels** | **Dict[str, Optional[str]]** | | [optional]
|
|
1381
|
+
**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 |
|
|
1382
|
+
**storage_settings** | **object** | Settings for storage class. |
|
|
1383
|
+
**redirect_to_object_storage** | **bool** | Boolean to have the content app redirect to object storage. | [optional] [default to True]
|
|
1384
|
+
**hide_guarded_distributions** | **bool** | Boolean to hide distributions with a content guard in the content app. | [optional] [default to False]
|
|
1385
|
+
|
|
1386
|
+
## Example
|
|
1387
|
+
|
|
1388
|
+
```python
|
|
1389
|
+
from pulpcore.client.pulp_service.models.domain import Domain
|
|
1390
|
+
|
|
1391
|
+
# TODO update the JSON string below
|
|
1392
|
+
json = "{}"
|
|
1393
|
+
# create an instance of Domain from a JSON string
|
|
1394
|
+
domain_instance = Domain.from_json(json)
|
|
1395
|
+
# print the JSON string representation of the object
|
|
1396
|
+
print(Domain.to_json())
|
|
1397
|
+
|
|
1398
|
+
# convert the object into a dict
|
|
1399
|
+
domain_dict = domain_instance.to_dict()
|
|
1400
|
+
# create an instance of Domain from a dict
|
|
1401
|
+
domain_from_dict = Domain.from_dict(domain_dict)
|
|
1402
|
+
```
|
|
1403
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
1404
|
+
|
|
1405
|
+
|
|
1406
|
+
# DomainResponse
|
|
1407
|
+
|
|
1408
|
+
Serializer for Domain.
|
|
1409
|
+
|
|
1410
|
+
## Properties
|
|
1411
|
+
|
|
1412
|
+
Name | Type | Description | Notes
|
|
1413
|
+
------------ | ------------- | ------------- | -------------
|
|
1414
|
+
**pulp_href** | **str** | | [optional] [readonly]
|
|
1415
|
+
**prn** | **str** | The Pulp Resource Name (PRN). | [optional] [readonly]
|
|
1416
|
+
**pulp_created** | **datetime** | Timestamp of creation. | [optional] [readonly]
|
|
1417
|
+
**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]
|
|
1418
|
+
**name** | **str** | A name for this domain. |
|
|
1419
|
+
**description** | **str** | An optional description. | [optional]
|
|
1420
|
+
**pulp_labels** | **Dict[str, Optional[str]]** | | [optional]
|
|
1421
|
+
**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 |
|
|
1422
|
+
**storage_settings** | **object** | Settings for storage class. |
|
|
1423
|
+
**redirect_to_object_storage** | **bool** | Boolean to have the content app redirect to object storage. | [optional] [default to True]
|
|
1424
|
+
**hide_guarded_distributions** | **bool** | Boolean to hide distributions with a content guard in the content app. | [optional] [default to False]
|
|
1425
|
+
|
|
1426
|
+
## Example
|
|
1427
|
+
|
|
1428
|
+
```python
|
|
1429
|
+
from pulpcore.client.pulp_service.models.domain_response import DomainResponse
|
|
1430
|
+
|
|
1431
|
+
# TODO update the JSON string below
|
|
1432
|
+
json = "{}"
|
|
1433
|
+
# create an instance of DomainResponse from a JSON string
|
|
1434
|
+
domain_response_instance = DomainResponse.from_json(json)
|
|
1435
|
+
# print the JSON string representation of the object
|
|
1436
|
+
print(DomainResponse.to_json())
|
|
1437
|
+
|
|
1438
|
+
# convert the object into a dict
|
|
1439
|
+
domain_response_dict = domain_response_instance.to_dict()
|
|
1440
|
+
# create an instance of DomainResponse from a dict
|
|
1441
|
+
domain_response_from_dict = DomainResponse.from_dict(domain_response_dict)
|
|
1442
|
+
```
|
|
1443
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
1444
|
+
|
|
1445
|
+
|
|
1446
|
+
# MyPermissionsResponse
|
|
1447
|
+
|
|
1448
|
+
|
|
1449
|
+
## Properties
|
|
1450
|
+
|
|
1451
|
+
Name | Type | Description | Notes
|
|
1452
|
+
------------ | ------------- | ------------- | -------------
|
|
1453
|
+
**permissions** | **List[str]** | |
|
|
1454
|
+
|
|
1455
|
+
## Example
|
|
1456
|
+
|
|
1457
|
+
```python
|
|
1458
|
+
from pulpcore.client.pulp_service.models.my_permissions_response import MyPermissionsResponse
|
|
1459
|
+
|
|
1460
|
+
# TODO update the JSON string below
|
|
1461
|
+
json = "{}"
|
|
1462
|
+
# create an instance of MyPermissionsResponse from a JSON string
|
|
1463
|
+
my_permissions_response_instance = MyPermissionsResponse.from_json(json)
|
|
1464
|
+
# print the JSON string representation of the object
|
|
1465
|
+
print(MyPermissionsResponse.to_json())
|
|
1466
|
+
|
|
1467
|
+
# convert the object into a dict
|
|
1468
|
+
my_permissions_response_dict = my_permissions_response_instance.to_dict()
|
|
1469
|
+
# create an instance of MyPermissionsResponse from a dict
|
|
1470
|
+
my_permissions_response_from_dict = MyPermissionsResponse.from_dict(my_permissions_response_dict)
|
|
1471
|
+
```
|
|
1472
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
1473
|
+
|
|
1474
|
+
|
|
1475
|
+
# NestedRole
|
|
1476
|
+
|
|
1477
|
+
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.
|
|
1478
|
+
|
|
1479
|
+
## Properties
|
|
1480
|
+
|
|
1481
|
+
Name | Type | Description | Notes
|
|
1482
|
+
------------ | ------------- | ------------- | -------------
|
|
1483
|
+
**users** | **List[str]** | | [optional] [default to []]
|
|
1484
|
+
**groups** | **List[str]** | | [optional] [default to []]
|
|
1485
|
+
**role** | **str** | |
|
|
1486
|
+
|
|
1487
|
+
## Example
|
|
1488
|
+
|
|
1489
|
+
```python
|
|
1490
|
+
from pulpcore.client.pulp_service.models.nested_role import NestedRole
|
|
1491
|
+
|
|
1492
|
+
# TODO update the JSON string below
|
|
1493
|
+
json = "{}"
|
|
1494
|
+
# create an instance of NestedRole from a JSON string
|
|
1495
|
+
nested_role_instance = NestedRole.from_json(json)
|
|
1496
|
+
# print the JSON string representation of the object
|
|
1497
|
+
print(NestedRole.to_json())
|
|
1498
|
+
|
|
1499
|
+
# convert the object into a dict
|
|
1500
|
+
nested_role_dict = nested_role_instance.to_dict()
|
|
1501
|
+
# create an instance of NestedRole from a dict
|
|
1502
|
+
nested_role_from_dict = NestedRole.from_dict(nested_role_dict)
|
|
1503
|
+
```
|
|
1504
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
1505
|
+
|
|
1506
|
+
|
|
1507
|
+
# NestedRoleResponse
|
|
1508
|
+
|
|
1509
|
+
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.
|
|
1510
|
+
|
|
1511
|
+
## Properties
|
|
1512
|
+
|
|
1513
|
+
Name | Type | Description | Notes
|
|
1514
|
+
------------ | ------------- | ------------- | -------------
|
|
1515
|
+
**users** | **List[str]** | | [optional] [default to []]
|
|
1516
|
+
**groups** | **List[str]** | | [optional] [default to []]
|
|
1517
|
+
**role** | **str** | |
|
|
1518
|
+
|
|
1519
|
+
## Example
|
|
1520
|
+
|
|
1521
|
+
```python
|
|
1522
|
+
from pulpcore.client.pulp_service.models.nested_role_response import NestedRoleResponse
|
|
1523
|
+
|
|
1524
|
+
# TODO update the JSON string below
|
|
1525
|
+
json = "{}"
|
|
1526
|
+
# create an instance of NestedRoleResponse from a JSON string
|
|
1527
|
+
nested_role_response_instance = NestedRoleResponse.from_json(json)
|
|
1528
|
+
# print the JSON string representation of the object
|
|
1529
|
+
print(NestedRoleResponse.to_json())
|
|
1530
|
+
|
|
1531
|
+
# convert the object into a dict
|
|
1532
|
+
nested_role_response_dict = nested_role_response_instance.to_dict()
|
|
1533
|
+
# create an instance of NestedRoleResponse from a dict
|
|
1534
|
+
nested_role_response_from_dict = NestedRoleResponse.from_dict(nested_role_response_dict)
|
|
1535
|
+
```
|
|
1536
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
1537
|
+
|
|
1538
|
+
|
|
1539
|
+
# ObjectRolesResponse
|
|
1540
|
+
|
|
1541
|
+
|
|
1542
|
+
## Properties
|
|
1543
|
+
|
|
1544
|
+
Name | Type | Description | Notes
|
|
1545
|
+
------------ | ------------- | ------------- | -------------
|
|
1546
|
+
**roles** | [**List[NestedRoleResponse]**](NestedRoleResponse.md) | |
|
|
1547
|
+
|
|
1548
|
+
## Example
|
|
1549
|
+
|
|
1550
|
+
```python
|
|
1551
|
+
from pulpcore.client.pulp_service.models.object_roles_response import ObjectRolesResponse
|
|
1552
|
+
|
|
1553
|
+
# TODO update the JSON string below
|
|
1554
|
+
json = "{}"
|
|
1555
|
+
# create an instance of ObjectRolesResponse from a JSON string
|
|
1556
|
+
object_roles_response_instance = ObjectRolesResponse.from_json(json)
|
|
1557
|
+
# print the JSON string representation of the object
|
|
1558
|
+
print(ObjectRolesResponse.to_json())
|
|
1559
|
+
|
|
1560
|
+
# convert the object into a dict
|
|
1561
|
+
object_roles_response_dict = object_roles_response_instance.to_dict()
|
|
1562
|
+
# create an instance of ObjectRolesResponse from a dict
|
|
1563
|
+
object_roles_response_from_dict = ObjectRolesResponse.from_dict(object_roles_response_dict)
|
|
1564
|
+
```
|
|
1565
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
1566
|
+
|
|
1567
|
+
|
|
1568
|
+
# PaginatedserviceFeatureContentGuardResponseList
|
|
1569
|
+
|
|
1570
|
+
|
|
1571
|
+
## Properties
|
|
1572
|
+
|
|
1573
|
+
Name | Type | Description | Notes
|
|
1574
|
+
------------ | ------------- | ------------- | -------------
|
|
1575
|
+
**count** | **int** | |
|
|
1576
|
+
**next** | **str** | | [optional]
|
|
1577
|
+
**previous** | **str** | | [optional]
|
|
1578
|
+
**results** | [**List[ServiceFeatureContentGuardResponse]**](ServiceFeatureContentGuardResponse.md) | |
|
|
1579
|
+
|
|
1580
|
+
## Example
|
|
1581
|
+
|
|
1582
|
+
```python
|
|
1583
|
+
from pulpcore.client.pulp_service.models.paginatedservice_feature_content_guard_response_list import PaginatedserviceFeatureContentGuardResponseList
|
|
1584
|
+
|
|
1585
|
+
# TODO update the JSON string below
|
|
1586
|
+
json = "{}"
|
|
1587
|
+
# create an instance of PaginatedserviceFeatureContentGuardResponseList from a JSON string
|
|
1588
|
+
paginatedservice_feature_content_guard_response_list_instance = PaginatedserviceFeatureContentGuardResponseList.from_json(json)
|
|
1589
|
+
# print the JSON string representation of the object
|
|
1590
|
+
print(PaginatedserviceFeatureContentGuardResponseList.to_json())
|
|
1591
|
+
|
|
1592
|
+
# convert the object into a dict
|
|
1593
|
+
paginatedservice_feature_content_guard_response_list_dict = paginatedservice_feature_content_guard_response_list_instance.to_dict()
|
|
1594
|
+
# create an instance of PaginatedserviceFeatureContentGuardResponseList from a dict
|
|
1595
|
+
paginatedservice_feature_content_guard_response_list_from_dict = PaginatedserviceFeatureContentGuardResponseList.from_dict(paginatedservice_feature_content_guard_response_list_dict)
|
|
1596
|
+
```
|
|
1597
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
1598
|
+
|
|
1599
|
+
|
|
1600
|
+
# PaginatedserviceVulnerabilityReportResponseList
|
|
1601
|
+
|
|
1602
|
+
|
|
1603
|
+
## Properties
|
|
1604
|
+
|
|
1605
|
+
Name | Type | Description | Notes
|
|
1606
|
+
------------ | ------------- | ------------- | -------------
|
|
1607
|
+
**count** | **int** | |
|
|
1608
|
+
**next** | **str** | | [optional]
|
|
1609
|
+
**previous** | **str** | | [optional]
|
|
1610
|
+
**results** | [**List[ServiceVulnerabilityReportResponse]**](ServiceVulnerabilityReportResponse.md) | |
|
|
1611
|
+
|
|
1612
|
+
## Example
|
|
1613
|
+
|
|
1614
|
+
```python
|
|
1615
|
+
from pulpcore.client.pulp_service.models.paginatedservice_vulnerability_report_response_list import PaginatedserviceVulnerabilityReportResponseList
|
|
1616
|
+
|
|
1617
|
+
# TODO update the JSON string below
|
|
1618
|
+
json = "{}"
|
|
1619
|
+
# create an instance of PaginatedserviceVulnerabilityReportResponseList from a JSON string
|
|
1620
|
+
paginatedservice_vulnerability_report_response_list_instance = PaginatedserviceVulnerabilityReportResponseList.from_json(json)
|
|
1621
|
+
# print the JSON string representation of the object
|
|
1622
|
+
print(PaginatedserviceVulnerabilityReportResponseList.to_json())
|
|
1623
|
+
|
|
1624
|
+
# convert the object into a dict
|
|
1625
|
+
paginatedservice_vulnerability_report_response_list_dict = paginatedservice_vulnerability_report_response_list_instance.to_dict()
|
|
1626
|
+
# create an instance of PaginatedserviceVulnerabilityReportResponseList from a dict
|
|
1627
|
+
paginatedservice_vulnerability_report_response_list_from_dict = PaginatedserviceVulnerabilityReportResponseList.from_dict(paginatedservice_vulnerability_report_response_list_dict)
|
|
1628
|
+
```
|
|
1629
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
1630
|
+
|
|
1631
|
+
|
|
1632
|
+
# PaginatedTaskResponseList
|
|
1633
|
+
|
|
1634
|
+
|
|
1635
|
+
## Properties
|
|
1636
|
+
|
|
1637
|
+
Name | Type | Description | Notes
|
|
1638
|
+
------------ | ------------- | ------------- | -------------
|
|
1639
|
+
**count** | **int** | |
|
|
1640
|
+
**next** | **str** | | [optional]
|
|
1641
|
+
**previous** | **str** | | [optional]
|
|
1642
|
+
**results** | [**List[TaskResponse]**](TaskResponse.md) | |
|
|
1643
|
+
|
|
1644
|
+
## Example
|
|
1645
|
+
|
|
1646
|
+
```python
|
|
1647
|
+
from pulpcore.client.pulp_service.models.paginated_task_response_list import PaginatedTaskResponseList
|
|
1648
|
+
|
|
1649
|
+
# TODO update the JSON string below
|
|
1650
|
+
json = "{}"
|
|
1651
|
+
# create an instance of PaginatedTaskResponseList from a JSON string
|
|
1652
|
+
paginated_task_response_list_instance = PaginatedTaskResponseList.from_json(json)
|
|
1653
|
+
# print the JSON string representation of the object
|
|
1654
|
+
print(PaginatedTaskResponseList.to_json())
|
|
1655
|
+
|
|
1656
|
+
# convert the object into a dict
|
|
1657
|
+
paginated_task_response_list_dict = paginated_task_response_list_instance.to_dict()
|
|
1658
|
+
# create an instance of PaginatedTaskResponseList from a dict
|
|
1659
|
+
paginated_task_response_list_from_dict = PaginatedTaskResponseList.from_dict(paginated_task_response_list_dict)
|
|
1660
|
+
```
|
|
1661
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
1662
|
+
|
|
1663
|
+
|
|
1664
|
+
# PatchedserviceFeatureContentGuard
|
|
1665
|
+
|
|
1666
|
+
A serializer for FeatureContentGuard.
|
|
1667
|
+
|
|
1668
|
+
## Properties
|
|
1669
|
+
|
|
1670
|
+
Name | Type | Description | Notes
|
|
1671
|
+
------------ | ------------- | ------------- | -------------
|
|
1672
|
+
**name** | **str** | The unique name. | [optional]
|
|
1673
|
+
**description** | **str** | An optional description. | [optional]
|
|
1674
|
+
**header_name** | **str** | | [optional]
|
|
1675
|
+
**jq_filter** | **str** | | [optional]
|
|
1676
|
+
**features** | **List[str]** | The list of features required to access the content. | [optional]
|
|
1677
|
+
|
|
1678
|
+
## Example
|
|
1679
|
+
|
|
1680
|
+
```python
|
|
1681
|
+
from pulpcore.client.pulp_service.models.patchedservice_feature_content_guard import PatchedserviceFeatureContentGuard
|
|
1682
|
+
|
|
1683
|
+
# TODO update the JSON string below
|
|
1684
|
+
json = "{}"
|
|
1685
|
+
# create an instance of PatchedserviceFeatureContentGuard from a JSON string
|
|
1686
|
+
patchedservice_feature_content_guard_instance = PatchedserviceFeatureContentGuard.from_json(json)
|
|
1687
|
+
# print the JSON string representation of the object
|
|
1688
|
+
print(PatchedserviceFeatureContentGuard.to_json())
|
|
1689
|
+
|
|
1690
|
+
# convert the object into a dict
|
|
1691
|
+
patchedservice_feature_content_guard_dict = patchedservice_feature_content_guard_instance.to_dict()
|
|
1692
|
+
# create an instance of PatchedserviceFeatureContentGuard from a dict
|
|
1693
|
+
patchedservice_feature_content_guard_from_dict = PatchedserviceFeatureContentGuard.from_dict(patchedservice_feature_content_guard_dict)
|
|
1694
|
+
```
|
|
1695
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
1696
|
+
|
|
1697
|
+
|
|
1698
|
+
# ProgressReportResponse
|
|
1699
|
+
|
|
1700
|
+
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.
|
|
1701
|
+
|
|
1702
|
+
## Properties
|
|
1703
|
+
|
|
1704
|
+
Name | Type | Description | Notes
|
|
1705
|
+
------------ | ------------- | ------------- | -------------
|
|
1706
|
+
**message** | **str** | The message shown to the user for the progress report. | [optional] [readonly]
|
|
1707
|
+
**code** | **str** | Identifies the type of progress report'. | [optional] [readonly]
|
|
1708
|
+
**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]
|
|
1709
|
+
**total** | **int** | The total count of items. | [optional] [readonly]
|
|
1710
|
+
**done** | **int** | The count of items already processed. Defaults to 0. | [optional] [readonly]
|
|
1711
|
+
**suffix** | **str** | The suffix to be shown with the progress report. | [optional] [readonly]
|
|
1712
|
+
|
|
1713
|
+
## Example
|
|
1714
|
+
|
|
1715
|
+
```python
|
|
1716
|
+
from pulpcore.client.pulp_service.models.progress_report_response import ProgressReportResponse
|
|
1717
|
+
|
|
1718
|
+
# TODO update the JSON string below
|
|
1719
|
+
json = "{}"
|
|
1720
|
+
# create an instance of ProgressReportResponse from a JSON string
|
|
1721
|
+
progress_report_response_instance = ProgressReportResponse.from_json(json)
|
|
1722
|
+
# print the JSON string representation of the object
|
|
1723
|
+
print(ProgressReportResponse.to_json())
|
|
1724
|
+
|
|
1725
|
+
# convert the object into a dict
|
|
1726
|
+
progress_report_response_dict = progress_report_response_instance.to_dict()
|
|
1727
|
+
# create an instance of ProgressReportResponse from a dict
|
|
1728
|
+
progress_report_response_from_dict = ProgressReportResponse.from_dict(progress_report_response_dict)
|
|
1729
|
+
```
|
|
1730
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
1731
|
+
|
|
1732
|
+
|
|
1733
|
+
# ServiceFeatureContentGuard
|
|
1734
|
+
|
|
1735
|
+
A serializer for FeatureContentGuard.
|
|
1736
|
+
|
|
1737
|
+
## Properties
|
|
1738
|
+
|
|
1739
|
+
Name | Type | Description | Notes
|
|
1740
|
+
------------ | ------------- | ------------- | -------------
|
|
1741
|
+
**name** | **str** | The unique name. |
|
|
1742
|
+
**description** | **str** | An optional description. | [optional]
|
|
1743
|
+
**header_name** | **str** | |
|
|
1744
|
+
**jq_filter** | **str** | | [optional]
|
|
1745
|
+
**features** | **List[str]** | The list of features required to access the content. |
|
|
1746
|
+
|
|
1747
|
+
## Example
|
|
1748
|
+
|
|
1749
|
+
```python
|
|
1750
|
+
from pulpcore.client.pulp_service.models.service_feature_content_guard import ServiceFeatureContentGuard
|
|
1751
|
+
|
|
1752
|
+
# TODO update the JSON string below
|
|
1753
|
+
json = "{}"
|
|
1754
|
+
# create an instance of ServiceFeatureContentGuard from a JSON string
|
|
1755
|
+
service_feature_content_guard_instance = ServiceFeatureContentGuard.from_json(json)
|
|
1756
|
+
# print the JSON string representation of the object
|
|
1757
|
+
print(ServiceFeatureContentGuard.to_json())
|
|
1758
|
+
|
|
1759
|
+
# convert the object into a dict
|
|
1760
|
+
service_feature_content_guard_dict = service_feature_content_guard_instance.to_dict()
|
|
1761
|
+
# create an instance of ServiceFeatureContentGuard from a dict
|
|
1762
|
+
service_feature_content_guard_from_dict = ServiceFeatureContentGuard.from_dict(service_feature_content_guard_dict)
|
|
1763
|
+
```
|
|
1764
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
1765
|
+
|
|
1766
|
+
|
|
1767
|
+
# ServiceFeatureContentGuardResponse
|
|
1768
|
+
|
|
1769
|
+
A serializer for FeatureContentGuard.
|
|
1770
|
+
|
|
1771
|
+
## Properties
|
|
1772
|
+
|
|
1773
|
+
Name | Type | Description | Notes
|
|
1774
|
+
------------ | ------------- | ------------- | -------------
|
|
1775
|
+
**pulp_href** | **str** | | [optional] [readonly]
|
|
1776
|
+
**prn** | **str** | The Pulp Resource Name (PRN). | [optional] [readonly]
|
|
1777
|
+
**pulp_created** | **datetime** | Timestamp of creation. | [optional] [readonly]
|
|
1778
|
+
**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]
|
|
1779
|
+
**name** | **str** | The unique name. |
|
|
1780
|
+
**description** | **str** | An optional description. | [optional]
|
|
1781
|
+
**header_name** | **str** | |
|
|
1782
|
+
**jq_filter** | **str** | | [optional]
|
|
1783
|
+
**features** | **List[str]** | The list of features required to access the content. |
|
|
1784
|
+
|
|
1785
|
+
## Example
|
|
1786
|
+
|
|
1787
|
+
```python
|
|
1788
|
+
from pulpcore.client.pulp_service.models.service_feature_content_guard_response import ServiceFeatureContentGuardResponse
|
|
1789
|
+
|
|
1790
|
+
# TODO update the JSON string below
|
|
1791
|
+
json = "{}"
|
|
1792
|
+
# create an instance of ServiceFeatureContentGuardResponse from a JSON string
|
|
1793
|
+
service_feature_content_guard_response_instance = ServiceFeatureContentGuardResponse.from_json(json)
|
|
1794
|
+
# print the JSON string representation of the object
|
|
1795
|
+
print(ServiceFeatureContentGuardResponse.to_json())
|
|
1796
|
+
|
|
1797
|
+
# convert the object into a dict
|
|
1798
|
+
service_feature_content_guard_response_dict = service_feature_content_guard_response_instance.to_dict()
|
|
1799
|
+
# create an instance of ServiceFeatureContentGuardResponse from a dict
|
|
1800
|
+
service_feature_content_guard_response_from_dict = ServiceFeatureContentGuardResponse.from_dict(service_feature_content_guard_response_dict)
|
|
1801
|
+
```
|
|
1802
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
1803
|
+
|
|
1804
|
+
|
|
1805
|
+
# ServiceVulnerabilityReportResponse
|
|
1806
|
+
|
|
1807
|
+
A serializer for the VulnerabilityReport Model.
|
|
1808
|
+
|
|
1809
|
+
## Properties
|
|
1810
|
+
|
|
1811
|
+
Name | Type | Description | Notes
|
|
1812
|
+
------------ | ------------- | ------------- | -------------
|
|
1813
|
+
**pulp_href** | **str** | | [optional] [readonly]
|
|
1814
|
+
**prn** | **str** | The Pulp Resource Name (PRN). | [optional] [readonly]
|
|
1815
|
+
**pulp_created** | **datetime** | Timestamp of creation. | [optional] [readonly]
|
|
1816
|
+
**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]
|
|
1817
|
+
**vulns** | **object** | |
|
|
1818
|
+
|
|
1819
|
+
## Example
|
|
1820
|
+
|
|
1821
|
+
```python
|
|
1822
|
+
from pulpcore.client.pulp_service.models.service_vulnerability_report_response import ServiceVulnerabilityReportResponse
|
|
1823
|
+
|
|
1824
|
+
# TODO update the JSON string below
|
|
1825
|
+
json = "{}"
|
|
1826
|
+
# create an instance of ServiceVulnerabilityReportResponse from a JSON string
|
|
1827
|
+
service_vulnerability_report_response_instance = ServiceVulnerabilityReportResponse.from_json(json)
|
|
1828
|
+
# print the JSON string representation of the object
|
|
1829
|
+
print(ServiceVulnerabilityReportResponse.to_json())
|
|
1830
|
+
|
|
1831
|
+
# convert the object into a dict
|
|
1832
|
+
service_vulnerability_report_response_dict = service_vulnerability_report_response_instance.to_dict()
|
|
1833
|
+
# create an instance of ServiceVulnerabilityReportResponse from a dict
|
|
1834
|
+
service_vulnerability_report_response_from_dict = ServiceVulnerabilityReportResponse.from_dict(service_vulnerability_report_response_dict)
|
|
1835
|
+
```
|
|
1836
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
1837
|
+
|
|
1838
|
+
|
|
1839
|
+
# StorageClassEnum
|
|
1840
|
+
|
|
1841
|
+
* `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
|
|
1842
|
+
|
|
1843
|
+
## Enum
|
|
1844
|
+
|
|
1845
|
+
* `PULPCORE_DOT_APP_DOT_MODELS_DOT_STORAGE_DOT_FILE_SYSTEM` (value: `'pulpcore.app.models.storage.FileSystem'`)
|
|
1846
|
+
|
|
1847
|
+
* `STORAGES_DOT_BACKENDS_DOT_S3BOTO3_DOT_S3_BOTO3_STORAGE` (value: `'storages.backends.s3boto3.S3Boto3Storage'`)
|
|
1848
|
+
|
|
1849
|
+
* `STORAGES_DOT_BACKENDS_DOT_AZURE_STORAGE_DOT_AZURE_STORAGE` (value: `'storages.backends.azure_storage.AzureStorage'`)
|
|
1850
|
+
|
|
1851
|
+
* `PULP_SERVICE_DOT_APP_DOT_STORAGE_DOT_OCI_STORAGE` (value: `'pulp_service.app.storage.OCIStorage'`)
|
|
1852
|
+
|
|
1853
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
1854
|
+
|
|
1855
|
+
|
|
1856
|
+
# TaskResponse
|
|
1857
|
+
|
|
1858
|
+
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.
|
|
1859
|
+
|
|
1860
|
+
## Properties
|
|
1861
|
+
|
|
1862
|
+
Name | Type | Description | Notes
|
|
1863
|
+
------------ | ------------- | ------------- | -------------
|
|
1864
|
+
**pulp_href** | **str** | | [optional] [readonly]
|
|
1865
|
+
**prn** | **str** | The Pulp Resource Name (PRN). | [optional] [readonly]
|
|
1866
|
+
**pulp_created** | **datetime** | Timestamp of creation. | [optional] [readonly]
|
|
1867
|
+
**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]
|
|
1868
|
+
**state** | **str** | The current state of the task. The possible values include: 'waiting', 'skipped', 'running', 'completed', 'failed', 'canceled' and 'canceling'. | [optional] [readonly]
|
|
1869
|
+
**name** | **str** | The name of task. |
|
|
1870
|
+
**logging_cid** | **str** | The logging correlation id associated with this task |
|
|
1871
|
+
**created_by** | **str** | User who dispatched this task. | [optional] [readonly]
|
|
1872
|
+
**unblocked_at** | **datetime** | Timestamp of when this task was identified ready for pickup. | [optional] [readonly]
|
|
1873
|
+
**started_at** | **datetime** | Timestamp of when this task started execution. | [optional] [readonly]
|
|
1874
|
+
**finished_at** | **datetime** | Timestamp of when this task stopped execution. | [optional] [readonly]
|
|
1875
|
+
**error** | **object** | A JSON Object of a fatal error encountered during the execution of this task. | [optional] [readonly]
|
|
1876
|
+
**worker** | **str** | DEPRECATED - Always null | [optional] [readonly]
|
|
1877
|
+
**parent_task** | **str** | The parent task that spawned this task. | [optional] [readonly]
|
|
1878
|
+
**child_tasks** | **List[str]** | Any tasks spawned by this task. | [optional] [readonly]
|
|
1879
|
+
**task_group** | **str** | The task group that this task is a member of. | [optional] [readonly]
|
|
1880
|
+
**progress_reports** | [**List[ProgressReportResponse]**](ProgressReportResponse.md) | | [optional] [readonly]
|
|
1881
|
+
**created_resources** | **List[str]** | Resources created by this task. | [optional] [readonly]
|
|
1882
|
+
**reserved_resources_record** | **List[str]** | A list of resources required by that task. | [optional] [readonly]
|
|
1883
|
+
**result** | **object** | The result of this task. | [optional] [readonly]
|
|
1884
|
+
|
|
1885
|
+
## Example
|
|
1886
|
+
|
|
1887
|
+
```python
|
|
1888
|
+
from pulpcore.client.pulp_service.models.task_response import TaskResponse
|
|
1889
|
+
|
|
1890
|
+
# TODO update the JSON string below
|
|
1891
|
+
json = "{}"
|
|
1892
|
+
# create an instance of TaskResponse from a JSON string
|
|
1893
|
+
task_response_instance = TaskResponse.from_json(json)
|
|
1894
|
+
# print the JSON string representation of the object
|
|
1895
|
+
print(TaskResponse.to_json())
|
|
1896
|
+
|
|
1897
|
+
# convert the object into a dict
|
|
1898
|
+
task_response_dict = task_response_instance.to_dict()
|
|
1899
|
+
# create an instance of TaskResponse from a dict
|
|
1900
|
+
task_response_from_dict = TaskResponse.from_dict(task_response_dict)
|
|
1901
|
+
```
|
|
1902
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
1903
|
+
|
|
1904
|
+
|
|
1905
|
+
# pulpcore.client.pulp_service.TasksApi
|
|
1906
|
+
|
|
1907
|
+
All URIs are relative to *https://env-ephemeral-qfzgn7.apps.crc-eph.r9lp.p1.openshiftapps.com*
|
|
1908
|
+
|
|
1909
|
+
Method | HTTP request | Description
|
|
1910
|
+
------------- | ------------- | -------------
|
|
1911
|
+
[**admin_tasks**](TasksApi.md#admin_tasks) | **GET** /api/pulp/admin/tasks/ |
|
|
1912
|
+
|
|
1913
|
+
|
|
1914
|
+
# **admin_tasks**
|
|
1915
|
+
> 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)
|
|
1916
|
+
|
|
1917
|
+
|
|
1918
|
+
|
|
1919
|
+
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.
|
|
1920
|
+
|
|
1921
|
+
### Example
|
|
1922
|
+
|
|
1923
|
+
* OAuth Authentication (json_header_remote_authentication):
|
|
1924
|
+
* Basic Authentication (basicAuth):
|
|
1925
|
+
* Api Key Authentication (cookieAuth):
|
|
1926
|
+
|
|
1927
|
+
```python
|
|
1928
|
+
import pulpcore.client.pulp_service
|
|
1929
|
+
from pulpcore.client.pulp_service.models.paginated_task_response_list import PaginatedTaskResponseList
|
|
1930
|
+
from pulpcore.client.pulp_service.rest import ApiException
|
|
1931
|
+
from pprint import pprint
|
|
1932
|
+
|
|
1933
|
+
# Defining the host is optional and defaults to https://env-ephemeral-qfzgn7.apps.crc-eph.r9lp.p1.openshiftapps.com
|
|
1934
|
+
# See configuration.py for a list of all supported configuration parameters.
|
|
1935
|
+
configuration = pulpcore.client.pulp_service.Configuration(
|
|
1936
|
+
host = "https://env-ephemeral-qfzgn7.apps.crc-eph.r9lp.p1.openshiftapps.com"
|
|
1937
|
+
)
|
|
1938
|
+
|
|
1939
|
+
# The client must configure the authentication and authorization parameters
|
|
1940
|
+
# in accordance with the API server security policy.
|
|
1941
|
+
# Examples for each auth method are provided below, use the example that
|
|
1942
|
+
# satisfies your auth use case.
|
|
1943
|
+
|
|
1944
|
+
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
1945
|
+
|
|
1946
|
+
# Configure HTTP basic authorization: basicAuth
|
|
1947
|
+
configuration = pulpcore.client.pulp_service.Configuration(
|
|
1948
|
+
username = os.environ["USERNAME"],
|
|
1949
|
+
password = os.environ["PASSWORD"]
|
|
1950
|
+
)
|
|
1951
|
+
|
|
1952
|
+
# Configure API key authorization: cookieAuth
|
|
1953
|
+
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
|
|
1954
|
+
|
|
1955
|
+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
1956
|
+
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
|
|
1957
|
+
|
|
1958
|
+
# Enter a context with an instance of the API client
|
|
1959
|
+
with pulpcore.client.pulp_service.ApiClient(configuration) as api_client:
|
|
1960
|
+
# Create an instance of the API class
|
|
1961
|
+
api_instance = pulpcore.client.pulp_service.TasksApi(api_client)
|
|
1962
|
+
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
|
|
1963
|
+
child_tasks = 'child_tasks_example' # str | Filter results where child_tasks matches value (optional)
|
|
1964
|
+
created_resources = 'created_resources_example' # str | (optional)
|
|
1965
|
+
exclusive_resources = 'exclusive_resources_example' # str | (optional)
|
|
1966
|
+
exclusive_resources__in = ['exclusive_resources__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
|
|
1967
|
+
finished_at = '2013-10-20T19:20:30+01:00' # datetime | Filter results where finished_at matches value (optional)
|
|
1968
|
+
finished_at__gt = '2013-10-20T19:20:30+01:00' # datetime | Filter results where finished_at is greater than value (optional)
|
|
1969
|
+
finished_at__gte = '2013-10-20T19:20:30+01:00' # datetime | Filter results where finished_at is greater than or equal to value (optional)
|
|
1970
|
+
finished_at__isnull = True # bool | Filter results where finished_at has a null value (optional)
|
|
1971
|
+
finished_at__lt = '2013-10-20T19:20:30+01:00' # datetime | Filter results where finished_at is less than value (optional)
|
|
1972
|
+
finished_at__lte = '2013-10-20T19:20:30+01:00' # datetime | Filter results where finished_at is less than or equal to value (optional)
|
|
1973
|
+
finished_at__range = ['2013-10-20T19:20:30+01:00'] # List[datetime] | Filter results where finished_at is between two comma separated values (optional)
|
|
1974
|
+
limit = 56 # int | Number of results to return per page. (optional)
|
|
1975
|
+
logging_cid = 'logging_cid_example' # str | Filter results where logging_cid matches value (optional)
|
|
1976
|
+
logging_cid__contains = 'logging_cid__contains_example' # str | Filter results where logging_cid contains value (optional)
|
|
1977
|
+
name = 'name_example' # str | Filter results where name matches value (optional)
|
|
1978
|
+
name__contains = 'name__contains_example' # str | Filter results where name contains value (optional)
|
|
1979
|
+
name__in = ['name__in_example'] # List[str] | Filter results where name is in a comma-separated list of values (optional)
|
|
1980
|
+
name__ne = 'name__ne_example' # str | Filter results where name not equal to value (optional)
|
|
1981
|
+
offset = 56 # int | The initial index from which to return the results. (optional)
|
|
1982
|
+
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)
|
|
1983
|
+
parent_task = 'parent_task_example' # str | Filter results where parent_task matches value (optional)
|
|
1984
|
+
prn__in = ['prn__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
|
|
1985
|
+
pulp_created = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_created matches value (optional)
|
|
1986
|
+
pulp_created__gt = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_created is greater than value (optional)
|
|
1987
|
+
pulp_created__gte = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_created is greater than or equal to value (optional)
|
|
1988
|
+
pulp_created__isnull = True # bool | Filter results where pulp_created has a null value (optional)
|
|
1989
|
+
pulp_created__lt = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_created is less than value (optional)
|
|
1990
|
+
pulp_created__lte = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_created is less than or equal to value (optional)
|
|
1991
|
+
pulp_created__range = ['2013-10-20T19:20:30+01:00'] # List[datetime] | Filter results where pulp_created is between two comma separated values (optional)
|
|
1992
|
+
pulp_href__in = ['pulp_href__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
|
|
1993
|
+
pulp_id__in = ['pulp_id__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
|
|
1994
|
+
q = 'q_example' # str | Filter results by using NOT, AND and OR operations on other filters (optional)
|
|
1995
|
+
reserved_resources = 'reserved_resources_example' # str | (optional)
|
|
1996
|
+
reserved_resources__in = ['reserved_resources__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
|
|
1997
|
+
shared_resources = 'shared_resources_example' # str | (optional)
|
|
1998
|
+
shared_resources__in = ['shared_resources__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
|
|
1999
|
+
started_at = '2013-10-20T19:20:30+01:00' # datetime | Filter results where started_at matches value (optional)
|
|
2000
|
+
started_at__gt = '2013-10-20T19:20:30+01:00' # datetime | Filter results where started_at is greater than value (optional)
|
|
2001
|
+
started_at__gte = '2013-10-20T19:20:30+01:00' # datetime | Filter results where started_at is greater than or equal to value (optional)
|
|
2002
|
+
started_at__isnull = True # bool | Filter results where started_at has a null value (optional)
|
|
2003
|
+
started_at__lt = '2013-10-20T19:20:30+01:00' # datetime | Filter results where started_at is less than value (optional)
|
|
2004
|
+
started_at__lte = '2013-10-20T19:20:30+01:00' # datetime | Filter results where started_at is less than or equal to value (optional)
|
|
2005
|
+
started_at__range = ['2013-10-20T19:20:30+01:00'] # List[datetime] | Filter results where started_at is between two comma separated values (optional)
|
|
2006
|
+
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)
|
|
2007
|
+
state__in = ['state__in_example'] # List[str] | Filter results where state is in a comma-separated list of values (optional)
|
|
2008
|
+
state__ne = 'state__ne_example' # str | Filter results where state not equal to value (optional)
|
|
2009
|
+
task_group = 'task_group_example' # str | Filter results where task_group matches value (optional)
|
|
2010
|
+
unblocked_at = '2013-10-20T19:20:30+01:00' # datetime | Filter results where unblocked_at matches value (optional)
|
|
2011
|
+
unblocked_at__gt = '2013-10-20T19:20:30+01:00' # datetime | Filter results where unblocked_at is greater than value (optional)
|
|
2012
|
+
unblocked_at__gte = '2013-10-20T19:20:30+01:00' # datetime | Filter results where unblocked_at is greater than or equal to value (optional)
|
|
2013
|
+
unblocked_at__isnull = True # bool | Filter results where unblocked_at has a null value (optional)
|
|
2014
|
+
unblocked_at__lt = '2013-10-20T19:20:30+01:00' # datetime | Filter results where unblocked_at is less than value (optional)
|
|
2015
|
+
unblocked_at__lte = '2013-10-20T19:20:30+01:00' # datetime | Filter results where unblocked_at is less than or equal to value (optional)
|
|
2016
|
+
unblocked_at__range = ['2013-10-20T19:20:30+01:00'] # List[datetime] | Filter results where unblocked_at is between two comma separated values (optional)
|
|
2017
|
+
worker = 'worker_example' # str | (optional)
|
|
2018
|
+
fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
|
|
2019
|
+
exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)
|
|
2020
|
+
|
|
2021
|
+
try:
|
|
2022
|
+
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)
|
|
2023
|
+
print("The response of TasksApi->admin_tasks:\n")
|
|
2024
|
+
pprint(api_response)
|
|
2025
|
+
except Exception as e:
|
|
2026
|
+
print("Exception when calling TasksApi->admin_tasks: %s\n" % e)
|
|
2027
|
+
```
|
|
2028
|
+
|
|
2029
|
+
|
|
2030
|
+
|
|
2031
|
+
### Parameters
|
|
2032
|
+
|
|
2033
|
+
|
|
2034
|
+
Name | Type | Description | Notes
|
|
2035
|
+
------------- | ------------- | ------------- | -------------
|
|
2036
|
+
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
|
|
2037
|
+
**child_tasks** | **str**| Filter results where child_tasks matches value | [optional]
|
|
2038
|
+
**created_resources** | **str**| | [optional]
|
|
2039
|
+
**exclusive_resources** | **str**| | [optional]
|
|
2040
|
+
**exclusive_resources__in** | [**List[str]**](str.md)| Multiple values may be separated by commas. | [optional]
|
|
2041
|
+
**finished_at** | **datetime**| Filter results where finished_at matches value | [optional]
|
|
2042
|
+
**finished_at__gt** | **datetime**| Filter results where finished_at is greater than value | [optional]
|
|
2043
|
+
**finished_at__gte** | **datetime**| Filter results where finished_at is greater than or equal to value | [optional]
|
|
2044
|
+
**finished_at__isnull** | **bool**| Filter results where finished_at has a null value | [optional]
|
|
2045
|
+
**finished_at__lt** | **datetime**| Filter results where finished_at is less than value | [optional]
|
|
2046
|
+
**finished_at__lte** | **datetime**| Filter results where finished_at is less than or equal to value | [optional]
|
|
2047
|
+
**finished_at__range** | [**List[datetime]**](datetime.md)| Filter results where finished_at is between two comma separated values | [optional]
|
|
2048
|
+
**limit** | **int**| Number of results to return per page. | [optional]
|
|
2049
|
+
**logging_cid** | **str**| Filter results where logging_cid matches value | [optional]
|
|
2050
|
+
**logging_cid__contains** | **str**| Filter results where logging_cid contains value | [optional]
|
|
2051
|
+
**name** | **str**| Filter results where name matches value | [optional]
|
|
2052
|
+
**name__contains** | **str**| Filter results where name contains value | [optional]
|
|
2053
|
+
**name__in** | [**List[str]**](str.md)| Filter results where name is in a comma-separated list of values | [optional]
|
|
2054
|
+
**name__ne** | **str**| Filter results where name not equal to value | [optional]
|
|
2055
|
+
**offset** | **int**| The initial index from which to return the results. | [optional]
|
|
2056
|
+
**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]
|
|
2057
|
+
**parent_task** | **str**| Filter results where parent_task matches value | [optional]
|
|
2058
|
+
**prn__in** | [**List[str]**](str.md)| Multiple values may be separated by commas. | [optional]
|
|
2059
|
+
**pulp_created** | **datetime**| Filter results where pulp_created matches value | [optional]
|
|
2060
|
+
**pulp_created__gt** | **datetime**| Filter results where pulp_created is greater than value | [optional]
|
|
2061
|
+
**pulp_created__gte** | **datetime**| Filter results where pulp_created is greater than or equal to value | [optional]
|
|
2062
|
+
**pulp_created__isnull** | **bool**| Filter results where pulp_created has a null value | [optional]
|
|
2063
|
+
**pulp_created__lt** | **datetime**| Filter results where pulp_created is less than value | [optional]
|
|
2064
|
+
**pulp_created__lte** | **datetime**| Filter results where pulp_created is less than or equal to value | [optional]
|
|
2065
|
+
**pulp_created__range** | [**List[datetime]**](datetime.md)| Filter results where pulp_created is between two comma separated values | [optional]
|
|
2066
|
+
**pulp_href__in** | [**List[str]**](str.md)| Multiple values may be separated by commas. | [optional]
|
|
2067
|
+
**pulp_id__in** | [**List[str]**](str.md)| Multiple values may be separated by commas. | [optional]
|
|
2068
|
+
**q** | **str**| Filter results by using NOT, AND and OR operations on other filters | [optional]
|
|
2069
|
+
**reserved_resources** | **str**| | [optional]
|
|
2070
|
+
**reserved_resources__in** | [**List[str]**](str.md)| Multiple values may be separated by commas. | [optional]
|
|
2071
|
+
**shared_resources** | **str**| | [optional]
|
|
2072
|
+
**shared_resources__in** | [**List[str]**](str.md)| Multiple values may be separated by commas. | [optional]
|
|
2073
|
+
**started_at** | **datetime**| Filter results where started_at matches value | [optional]
|
|
2074
|
+
**started_at__gt** | **datetime**| Filter results where started_at is greater than value | [optional]
|
|
2075
|
+
**started_at__gte** | **datetime**| Filter results where started_at is greater than or equal to value | [optional]
|
|
2076
|
+
**started_at__isnull** | **bool**| Filter results where started_at has a null value | [optional]
|
|
2077
|
+
**started_at__lt** | **datetime**| Filter results where started_at is less than value | [optional]
|
|
2078
|
+
**started_at__lte** | **datetime**| Filter results where started_at is less than or equal to value | [optional]
|
|
2079
|
+
**started_at__range** | [**List[datetime]**](datetime.md)| Filter results where started_at is between two comma separated values | [optional]
|
|
2080
|
+
**state** | **str**| Filter results where state matches value * `waiting` - Waiting * `skipped` - Skipped * `running` - Running * `completed` - Completed * `failed` - Failed * `canceled` - Canceled * `canceling` - Canceling | [optional]
|
|
2081
|
+
**state__in** | [**List[str]**](str.md)| Filter results where state is in a comma-separated list of values | [optional]
|
|
2082
|
+
**state__ne** | **str**| Filter results where state not equal to value | [optional]
|
|
2083
|
+
**task_group** | **str**| Filter results where task_group matches value | [optional]
|
|
2084
|
+
**unblocked_at** | **datetime**| Filter results where unblocked_at matches value | [optional]
|
|
2085
|
+
**unblocked_at__gt** | **datetime**| Filter results where unblocked_at is greater than value | [optional]
|
|
2086
|
+
**unblocked_at__gte** | **datetime**| Filter results where unblocked_at is greater than or equal to value | [optional]
|
|
2087
|
+
**unblocked_at__isnull** | **bool**| Filter results where unblocked_at has a null value | [optional]
|
|
2088
|
+
**unblocked_at__lt** | **datetime**| Filter results where unblocked_at is less than value | [optional]
|
|
2089
|
+
**unblocked_at__lte** | **datetime**| Filter results where unblocked_at is less than or equal to value | [optional]
|
|
2090
|
+
**unblocked_at__range** | [**List[datetime]**](datetime.md)| Filter results where unblocked_at is between two comma separated values | [optional]
|
|
2091
|
+
**worker** | **str**| | [optional]
|
|
2092
|
+
**fields** | [**List[str]**](str.md)| A list of fields to include in the response. | [optional]
|
|
2093
|
+
**exclude_fields** | [**List[str]**](str.md)| A list of fields to exclude from the response. | [optional]
|
|
2094
|
+
|
|
2095
|
+
### Return type
|
|
2096
|
+
|
|
2097
|
+
[**PaginatedTaskResponseList**](PaginatedTaskResponseList.md)
|
|
2098
|
+
|
|
2099
|
+
### Authorization
|
|
2100
|
+
|
|
2101
|
+
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
|
|
2102
|
+
|
|
2103
|
+
### HTTP request headers
|
|
2104
|
+
|
|
2105
|
+
- **Content-Type**: Not defined
|
|
2106
|
+
- **Accept**: application/json
|
|
2107
|
+
|
|
2108
|
+
### HTTP response details
|
|
2109
|
+
|
|
2110
|
+
| Status code | Description | Response headers |
|
|
2111
|
+
|-------------|-------------|------------------|
|
|
2112
|
+
**200** | | - |
|
|
2113
|
+
|
|
2114
|
+
[[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)
|
|
2115
|
+
|
|
2116
|
+
# pulpcore.client.pulp_service.VulnReportServiceApi
|
|
2117
|
+
|
|
2118
|
+
All URIs are relative to *https://env-ephemeral-qfzgn7.apps.crc-eph.r9lp.p1.openshiftapps.com*
|
|
2119
|
+
|
|
2120
|
+
Method | HTTP request | Description
|
|
2121
|
+
------------- | ------------- | -------------
|
|
2122
|
+
[**create**](VulnReportServiceApi.md#create) | **POST** /api/pulp/{pulp_domain}/api/v3/vuln_report_service/ | Generate vulnerability report
|
|
2123
|
+
[**delete**](VulnReportServiceApi.md#delete) | **DELETE** {service_vulnerability_report_href} | Delete a vulnerability report
|
|
2124
|
+
[**list**](VulnReportServiceApi.md#list) | **GET** /api/pulp/{pulp_domain}/api/v3/vuln_report_service/ | List vulnerability reports
|
|
2125
|
+
[**read**](VulnReportServiceApi.md#read) | **GET** {service_vulnerability_report_href} | Inspect a vulnerability report
|
|
2126
|
+
|
|
2127
|
+
|
|
2128
|
+
# **create**
|
|
2129
|
+
> AsyncOperationResponse create(pulp_domain, x_task_diagnostics=x_task_diagnostics, repo_version=repo_version, package_json=package_json)
|
|
2130
|
+
|
|
2131
|
+
Generate vulnerability report
|
|
2132
|
+
|
|
2133
|
+
Trigger a task to generate the package vulnerability report
|
|
2134
|
+
|
|
2135
|
+
### Example
|
|
2136
|
+
|
|
2137
|
+
* OAuth Authentication (json_header_remote_authentication):
|
|
2138
|
+
* Basic Authentication (basicAuth):
|
|
2139
|
+
* Api Key Authentication (cookieAuth):
|
|
2140
|
+
|
|
2141
|
+
```python
|
|
2142
|
+
import pulpcore.client.pulp_service
|
|
2143
|
+
from pulpcore.client.pulp_service.models.async_operation_response import AsyncOperationResponse
|
|
2144
|
+
from pulpcore.client.pulp_service.rest import ApiException
|
|
2145
|
+
from pprint import pprint
|
|
2146
|
+
|
|
2147
|
+
# Defining the host is optional and defaults to https://env-ephemeral-qfzgn7.apps.crc-eph.r9lp.p1.openshiftapps.com
|
|
2148
|
+
# See configuration.py for a list of all supported configuration parameters.
|
|
2149
|
+
configuration = pulpcore.client.pulp_service.Configuration(
|
|
2150
|
+
host = "https://env-ephemeral-qfzgn7.apps.crc-eph.r9lp.p1.openshiftapps.com"
|
|
2151
|
+
)
|
|
2152
|
+
|
|
2153
|
+
# The client must configure the authentication and authorization parameters
|
|
2154
|
+
# in accordance with the API server security policy.
|
|
2155
|
+
# Examples for each auth method are provided below, use the example that
|
|
2156
|
+
# satisfies your auth use case.
|
|
2157
|
+
|
|
2158
|
+
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
2159
|
+
|
|
2160
|
+
# Configure HTTP basic authorization: basicAuth
|
|
2161
|
+
configuration = pulpcore.client.pulp_service.Configuration(
|
|
2162
|
+
username = os.environ["USERNAME"],
|
|
2163
|
+
password = os.environ["PASSWORD"]
|
|
2164
|
+
)
|
|
2165
|
+
|
|
2166
|
+
# Configure API key authorization: cookieAuth
|
|
2167
|
+
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
|
|
2168
|
+
|
|
2169
|
+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
2170
|
+
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
|
|
2171
|
+
|
|
2172
|
+
# Enter a context with an instance of the API client
|
|
2173
|
+
with pulpcore.client.pulp_service.ApiClient(configuration) as api_client:
|
|
2174
|
+
# Create an instance of the API class
|
|
2175
|
+
api_instance = pulpcore.client.pulp_service.VulnReportServiceApi(api_client)
|
|
2176
|
+
pulp_domain = 'pulp_domain_example' # str |
|
|
2177
|
+
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
|
|
2178
|
+
repo_version = 'repo_version_example' # str | RepositoryVersion HREF with the packages to be checked. (optional)
|
|
2179
|
+
package_json = None # bytearray | package-lock.json file with the definition of dependencies to be checked. (optional)
|
|
2180
|
+
|
|
2181
|
+
try:
|
|
2182
|
+
# Generate vulnerability report
|
|
2183
|
+
api_response = api_instance.create(pulp_domain, x_task_diagnostics=x_task_diagnostics, repo_version=repo_version, package_json=package_json)
|
|
2184
|
+
print("The response of VulnReportServiceApi->create:\n")
|
|
2185
|
+
pprint(api_response)
|
|
2186
|
+
except Exception as e:
|
|
2187
|
+
print("Exception when calling VulnReportServiceApi->create: %s\n" % e)
|
|
2188
|
+
```
|
|
2189
|
+
|
|
2190
|
+
|
|
2191
|
+
|
|
2192
|
+
### Parameters
|
|
2193
|
+
|
|
2194
|
+
|
|
2195
|
+
Name | Type | Description | Notes
|
|
2196
|
+
------------- | ------------- | ------------- | -------------
|
|
2197
|
+
**pulp_domain** | **str**| |
|
|
2198
|
+
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
|
|
2199
|
+
**repo_version** | **str**| RepositoryVersion HREF with the packages to be checked. | [optional]
|
|
2200
|
+
**package_json** | **bytearray**| package-lock.json file with the definition of dependencies to be checked. | [optional]
|
|
2201
|
+
|
|
2202
|
+
### Return type
|
|
2203
|
+
|
|
2204
|
+
[**AsyncOperationResponse**](AsyncOperationResponse.md)
|
|
2205
|
+
|
|
2206
|
+
### Authorization
|
|
2207
|
+
|
|
2208
|
+
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
|
|
2209
|
+
|
|
2210
|
+
### HTTP request headers
|
|
2211
|
+
|
|
2212
|
+
- **Content-Type**: multipart/form-data, application/x-www-form-urlencoded
|
|
2213
|
+
- **Accept**: application/json
|
|
2214
|
+
|
|
2215
|
+
### HTTP response details
|
|
2216
|
+
|
|
2217
|
+
| Status code | Description | Response headers |
|
|
2218
|
+
|-------------|-------------|------------------|
|
|
2219
|
+
**202** | | - |
|
|
2220
|
+
|
|
2221
|
+
[[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)
|
|
2222
|
+
|
|
2223
|
+
# **delete**
|
|
2224
|
+
> delete(service_vulnerability_report_href, x_task_diagnostics=x_task_diagnostics)
|
|
2225
|
+
|
|
2226
|
+
Delete a vulnerability report
|
|
2227
|
+
|
|
2228
|
+
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.
|
|
2229
|
+
|
|
2230
|
+
### Example
|
|
2231
|
+
|
|
2232
|
+
* OAuth Authentication (json_header_remote_authentication):
|
|
2233
|
+
* Basic Authentication (basicAuth):
|
|
2234
|
+
* Api Key Authentication (cookieAuth):
|
|
2235
|
+
|
|
2236
|
+
```python
|
|
2237
|
+
import pulpcore.client.pulp_service
|
|
2238
|
+
from pulpcore.client.pulp_service.rest import ApiException
|
|
2239
|
+
from pprint import pprint
|
|
2240
|
+
|
|
2241
|
+
# Defining the host is optional and defaults to https://env-ephemeral-qfzgn7.apps.crc-eph.r9lp.p1.openshiftapps.com
|
|
2242
|
+
# See configuration.py for a list of all supported configuration parameters.
|
|
2243
|
+
configuration = pulpcore.client.pulp_service.Configuration(
|
|
2244
|
+
host = "https://env-ephemeral-qfzgn7.apps.crc-eph.r9lp.p1.openshiftapps.com"
|
|
2245
|
+
)
|
|
2246
|
+
|
|
2247
|
+
# The client must configure the authentication and authorization parameters
|
|
2248
|
+
# in accordance with the API server security policy.
|
|
2249
|
+
# Examples for each auth method are provided below, use the example that
|
|
2250
|
+
# satisfies your auth use case.
|
|
2251
|
+
|
|
2252
|
+
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
2253
|
+
|
|
2254
|
+
# Configure HTTP basic authorization: basicAuth
|
|
2255
|
+
configuration = pulpcore.client.pulp_service.Configuration(
|
|
2256
|
+
username = os.environ["USERNAME"],
|
|
2257
|
+
password = os.environ["PASSWORD"]
|
|
2258
|
+
)
|
|
2259
|
+
|
|
2260
|
+
# Configure API key authorization: cookieAuth
|
|
2261
|
+
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
|
|
2262
|
+
|
|
2263
|
+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
2264
|
+
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
|
|
2265
|
+
|
|
2266
|
+
# Enter a context with an instance of the API client
|
|
2267
|
+
with pulpcore.client.pulp_service.ApiClient(configuration) as api_client:
|
|
2268
|
+
# Create an instance of the API class
|
|
2269
|
+
api_instance = pulpcore.client.pulp_service.VulnReportServiceApi(api_client)
|
|
2270
|
+
service_vulnerability_report_href = 'service_vulnerability_report_href_example' # str |
|
|
2271
|
+
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
|
|
2272
|
+
|
|
2273
|
+
try:
|
|
2274
|
+
# Delete a vulnerability report
|
|
2275
|
+
api_instance.delete(service_vulnerability_report_href, x_task_diagnostics=x_task_diagnostics)
|
|
2276
|
+
except Exception as e:
|
|
2277
|
+
print("Exception when calling VulnReportServiceApi->delete: %s\n" % e)
|
|
2278
|
+
```
|
|
2279
|
+
|
|
2280
|
+
|
|
2281
|
+
|
|
2282
|
+
### Parameters
|
|
2283
|
+
|
|
2284
|
+
|
|
2285
|
+
Name | Type | Description | Notes
|
|
2286
|
+
------------- | ------------- | ------------- | -------------
|
|
2287
|
+
**service_vulnerability_report_href** | **str**| |
|
|
2288
|
+
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
|
|
2289
|
+
|
|
2290
|
+
### Return type
|
|
2291
|
+
|
|
2292
|
+
void (empty response body)
|
|
2293
|
+
|
|
2294
|
+
### Authorization
|
|
2295
|
+
|
|
2296
|
+
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
|
|
2297
|
+
|
|
2298
|
+
### HTTP request headers
|
|
2299
|
+
|
|
2300
|
+
- **Content-Type**: Not defined
|
|
2301
|
+
- **Accept**: Not defined
|
|
2302
|
+
|
|
2303
|
+
### HTTP response details
|
|
2304
|
+
|
|
2305
|
+
| Status code | Description | Response headers |
|
|
2306
|
+
|-------------|-------------|------------------|
|
|
2307
|
+
**204** | No response body | - |
|
|
2308
|
+
|
|
2309
|
+
[[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)
|
|
2310
|
+
|
|
2311
|
+
# **list**
|
|
2312
|
+
> PaginatedserviceVulnerabilityReportResponseList list(pulp_domain, x_task_diagnostics=x_task_diagnostics, limit=limit, offset=offset, fields=fields, exclude_fields=exclude_fields)
|
|
2313
|
+
|
|
2314
|
+
List vulnerability reports
|
|
2315
|
+
|
|
2316
|
+
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.
|
|
2317
|
+
|
|
2318
|
+
### Example
|
|
2319
|
+
|
|
2320
|
+
* OAuth Authentication (json_header_remote_authentication):
|
|
2321
|
+
* Basic Authentication (basicAuth):
|
|
2322
|
+
* Api Key Authentication (cookieAuth):
|
|
2323
|
+
|
|
2324
|
+
```python
|
|
2325
|
+
import pulpcore.client.pulp_service
|
|
2326
|
+
from pulpcore.client.pulp_service.models.paginatedservice_vulnerability_report_response_list import PaginatedserviceVulnerabilityReportResponseList
|
|
2327
|
+
from pulpcore.client.pulp_service.rest import ApiException
|
|
2328
|
+
from pprint import pprint
|
|
2329
|
+
|
|
2330
|
+
# Defining the host is optional and defaults to https://env-ephemeral-qfzgn7.apps.crc-eph.r9lp.p1.openshiftapps.com
|
|
2331
|
+
# See configuration.py for a list of all supported configuration parameters.
|
|
2332
|
+
configuration = pulpcore.client.pulp_service.Configuration(
|
|
2333
|
+
host = "https://env-ephemeral-qfzgn7.apps.crc-eph.r9lp.p1.openshiftapps.com"
|
|
2334
|
+
)
|
|
2335
|
+
|
|
2336
|
+
# The client must configure the authentication and authorization parameters
|
|
2337
|
+
# in accordance with the API server security policy.
|
|
2338
|
+
# Examples for each auth method are provided below, use the example that
|
|
2339
|
+
# satisfies your auth use case.
|
|
2340
|
+
|
|
2341
|
+
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
2342
|
+
|
|
2343
|
+
# Configure HTTP basic authorization: basicAuth
|
|
2344
|
+
configuration = pulpcore.client.pulp_service.Configuration(
|
|
2345
|
+
username = os.environ["USERNAME"],
|
|
2346
|
+
password = os.environ["PASSWORD"]
|
|
2347
|
+
)
|
|
2348
|
+
|
|
2349
|
+
# Configure API key authorization: cookieAuth
|
|
2350
|
+
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
|
|
2351
|
+
|
|
2352
|
+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
2353
|
+
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
|
|
2354
|
+
|
|
2355
|
+
# Enter a context with an instance of the API client
|
|
2356
|
+
with pulpcore.client.pulp_service.ApiClient(configuration) as api_client:
|
|
2357
|
+
# Create an instance of the API class
|
|
2358
|
+
api_instance = pulpcore.client.pulp_service.VulnReportServiceApi(api_client)
|
|
2359
|
+
pulp_domain = 'pulp_domain_example' # str |
|
|
2360
|
+
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
|
|
2361
|
+
limit = 56 # int | Number of results to return per page. (optional)
|
|
2362
|
+
offset = 56 # int | The initial index from which to return the results. (optional)
|
|
2363
|
+
fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
|
|
2364
|
+
exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)
|
|
2365
|
+
|
|
2366
|
+
try:
|
|
2367
|
+
# List vulnerability reports
|
|
2368
|
+
api_response = api_instance.list(pulp_domain, x_task_diagnostics=x_task_diagnostics, limit=limit, offset=offset, fields=fields, exclude_fields=exclude_fields)
|
|
2369
|
+
print("The response of VulnReportServiceApi->list:\n")
|
|
2370
|
+
pprint(api_response)
|
|
2371
|
+
except Exception as e:
|
|
2372
|
+
print("Exception when calling VulnReportServiceApi->list: %s\n" % e)
|
|
2373
|
+
```
|
|
2374
|
+
|
|
2375
|
+
|
|
2376
|
+
|
|
2377
|
+
### Parameters
|
|
2378
|
+
|
|
2379
|
+
|
|
2380
|
+
Name | Type | Description | Notes
|
|
2381
|
+
------------- | ------------- | ------------- | -------------
|
|
2382
|
+
**pulp_domain** | **str**| |
|
|
2383
|
+
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
|
|
2384
|
+
**limit** | **int**| Number of results to return per page. | [optional]
|
|
2385
|
+
**offset** | **int**| The initial index from which to return the results. | [optional]
|
|
2386
|
+
**fields** | [**List[str]**](str.md)| A list of fields to include in the response. | [optional]
|
|
2387
|
+
**exclude_fields** | [**List[str]**](str.md)| A list of fields to exclude from the response. | [optional]
|
|
2388
|
+
|
|
2389
|
+
### Return type
|
|
2390
|
+
|
|
2391
|
+
[**PaginatedserviceVulnerabilityReportResponseList**](PaginatedserviceVulnerabilityReportResponseList.md)
|
|
2392
|
+
|
|
2393
|
+
### Authorization
|
|
2394
|
+
|
|
2395
|
+
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
|
|
2396
|
+
|
|
2397
|
+
### HTTP request headers
|
|
2398
|
+
|
|
2399
|
+
- **Content-Type**: Not defined
|
|
2400
|
+
- **Accept**: application/json
|
|
2401
|
+
|
|
2402
|
+
### HTTP response details
|
|
2403
|
+
|
|
2404
|
+
| Status code | Description | Response headers |
|
|
2405
|
+
|-------------|-------------|------------------|
|
|
2406
|
+
**200** | | - |
|
|
2407
|
+
|
|
2408
|
+
[[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)
|
|
2409
|
+
|
|
2410
|
+
# **read**
|
|
2411
|
+
> ServiceVulnerabilityReportResponse read(service_vulnerability_report_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
|
|
2412
|
+
|
|
2413
|
+
Inspect a vulnerability report
|
|
2414
|
+
|
|
2415
|
+
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.
|
|
2416
|
+
|
|
2417
|
+
### Example
|
|
2418
|
+
|
|
2419
|
+
* OAuth Authentication (json_header_remote_authentication):
|
|
2420
|
+
* Basic Authentication (basicAuth):
|
|
2421
|
+
* Api Key Authentication (cookieAuth):
|
|
2422
|
+
|
|
2423
|
+
```python
|
|
2424
|
+
import pulpcore.client.pulp_service
|
|
2425
|
+
from pulpcore.client.pulp_service.models.service_vulnerability_report_response import ServiceVulnerabilityReportResponse
|
|
2426
|
+
from pulpcore.client.pulp_service.rest import ApiException
|
|
2427
|
+
from pprint import pprint
|
|
2428
|
+
|
|
2429
|
+
# Defining the host is optional and defaults to https://env-ephemeral-qfzgn7.apps.crc-eph.r9lp.p1.openshiftapps.com
|
|
2430
|
+
# See configuration.py for a list of all supported configuration parameters.
|
|
2431
|
+
configuration = pulpcore.client.pulp_service.Configuration(
|
|
2432
|
+
host = "https://env-ephemeral-qfzgn7.apps.crc-eph.r9lp.p1.openshiftapps.com"
|
|
2433
|
+
)
|
|
2434
|
+
|
|
2435
|
+
# The client must configure the authentication and authorization parameters
|
|
2436
|
+
# in accordance with the API server security policy.
|
|
2437
|
+
# Examples for each auth method are provided below, use the example that
|
|
2438
|
+
# satisfies your auth use case.
|
|
2439
|
+
|
|
2440
|
+
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
2441
|
+
|
|
2442
|
+
# Configure HTTP basic authorization: basicAuth
|
|
2443
|
+
configuration = pulpcore.client.pulp_service.Configuration(
|
|
2444
|
+
username = os.environ["USERNAME"],
|
|
2445
|
+
password = os.environ["PASSWORD"]
|
|
2446
|
+
)
|
|
2447
|
+
|
|
2448
|
+
# Configure API key authorization: cookieAuth
|
|
2449
|
+
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
|
|
2450
|
+
|
|
2451
|
+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
2452
|
+
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
|
|
2453
|
+
|
|
2454
|
+
# Enter a context with an instance of the API client
|
|
2455
|
+
with pulpcore.client.pulp_service.ApiClient(configuration) as api_client:
|
|
2456
|
+
# Create an instance of the API class
|
|
2457
|
+
api_instance = pulpcore.client.pulp_service.VulnReportServiceApi(api_client)
|
|
2458
|
+
service_vulnerability_report_href = 'service_vulnerability_report_href_example' # str |
|
|
2459
|
+
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
|
|
2460
|
+
fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
|
|
2461
|
+
exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)
|
|
2462
|
+
|
|
2463
|
+
try:
|
|
2464
|
+
# Inspect a vulnerability report
|
|
2465
|
+
api_response = api_instance.read(service_vulnerability_report_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
|
|
2466
|
+
print("The response of VulnReportServiceApi->read:\n")
|
|
2467
|
+
pprint(api_response)
|
|
2468
|
+
except Exception as e:
|
|
2469
|
+
print("Exception when calling VulnReportServiceApi->read: %s\n" % e)
|
|
2470
|
+
```
|
|
2471
|
+
|
|
2472
|
+
|
|
2473
|
+
|
|
2474
|
+
### Parameters
|
|
2475
|
+
|
|
2476
|
+
|
|
2477
|
+
Name | Type | Description | Notes
|
|
2478
|
+
------------- | ------------- | ------------- | -------------
|
|
2479
|
+
**service_vulnerability_report_href** | **str**| |
|
|
2480
|
+
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
|
|
2481
|
+
**fields** | [**List[str]**](str.md)| A list of fields to include in the response. | [optional]
|
|
2482
|
+
**exclude_fields** | [**List[str]**](str.md)| A list of fields to exclude from the response. | [optional]
|
|
2483
|
+
|
|
2484
|
+
### Return type
|
|
2485
|
+
|
|
2486
|
+
[**ServiceVulnerabilityReportResponse**](ServiceVulnerabilityReportResponse.md)
|
|
2487
|
+
|
|
2488
|
+
### Authorization
|
|
2489
|
+
|
|
2490
|
+
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
|
|
2491
|
+
|
|
2492
|
+
### HTTP request headers
|
|
2493
|
+
|
|
2494
|
+
- **Content-Type**: Not defined
|
|
2495
|
+
- **Accept**: application/json
|
|
2496
|
+
|
|
2497
|
+
### HTTP response details
|
|
2498
|
+
|
|
2499
|
+
| Status code | Description | Response headers |
|
|
2500
|
+
|-------------|-------------|------------------|
|
|
2501
|
+
**200** | | - |
|
|
2502
|
+
|
|
2503
|
+
[[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)
|
|
2504
|
+
|