crc-pulp-service-client 20260107.2__py3-none-any.whl

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.

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