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