crc-pulpcore-client 20250819.1__py3-none-any.whl → 20250820.1__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of crc-pulpcore-client might be problematic. Click here for more details.

Files changed (239) hide show
  1. crc-pulpcore-client/api_client.py +1 -1
  2. crc-pulpcore-client/configuration.py +3 -3
  3. crc-pulpcore-client/models/artifact_distribution_response.py +17 -17
  4. {crc_pulpcore_client-20250819.1.dist-info → crc_pulpcore_client-20250820.1.dist-info}/METADATA +1 -1
  5. crc_pulpcore_client-20250820.1.dist-info/RECORD +234 -0
  6. crc_pulpcore_client-20250820.1.dist-info/top_level.txt +1 -0
  7. crc_pulpcore_client-20250819.1.dist-info/RECORD +0 -464
  8. crc_pulpcore_client-20250819.1.dist-info/top_level.txt +0 -2
  9. services-pulpcore-client/__init__.py +0 -2
  10. services-pulpcore-client/api/__init__.py +0 -53
  11. services-pulpcore-client/api/access_policies_api.py +0 -1864
  12. services-pulpcore-client/api/artifacts_api.py +0 -1615
  13. services-pulpcore-client/api/content_api.py +0 -598
  14. services-pulpcore-client/api/content_openpgp_publickey_api.py +0 -1887
  15. services-pulpcore-client/api/content_openpgp_publicsubkey_api.py +0 -1518
  16. services-pulpcore-client/api/content_openpgp_signature_api.py +0 -1518
  17. services-pulpcore-client/api/content_openpgp_userattribute_api.py +0 -1518
  18. services-pulpcore-client/api/content_openpgp_userid_api.py +0 -1655
  19. services-pulpcore-client/api/contentguards_api.py +0 -667
  20. services-pulpcore-client/api/contentguards_composite_api.py +0 -3401
  21. services-pulpcore-client/api/contentguards_content_redirect_api.py +0 -3401
  22. services-pulpcore-client/api/contentguards_header_api.py +0 -3401
  23. services-pulpcore-client/api/contentguards_rbac_api.py +0 -3401
  24. services-pulpcore-client/api/distributions_api.py +0 -822
  25. services-pulpcore-client/api/distributions_artifacts_api.py +0 -1103
  26. services-pulpcore-client/api/distributions_openpgp_api.py +0 -2676
  27. services-pulpcore-client/api/domains_api.py +0 -3106
  28. services-pulpcore-client/api/exporters_filesystem_api.py +0 -2157
  29. services-pulpcore-client/api/exporters_filesystem_exports_api.py +0 -1288
  30. services-pulpcore-client/api/exporters_pulp_api.py +0 -2157
  31. services-pulpcore-client/api/exporters_pulp_exports_api.py +0 -1288
  32. services-pulpcore-client/api/groups_api.py +0 -3368
  33. services-pulpcore-client/api/groups_roles_api.py +0 -1496
  34. services-pulpcore-client/api/groups_users_api.py +0 -972
  35. services-pulpcore-client/api/importers_pulp_api.py +0 -2149
  36. services-pulpcore-client/api/importers_pulp_import_check_api.py +0 -350
  37. services-pulpcore-client/api/importers_pulp_imports_api.py +0 -1288
  38. services-pulpcore-client/api/livez_api.py +0 -329
  39. services-pulpcore-client/api/login_api.py +0 -897
  40. services-pulpcore-client/api/orphans_api.py +0 -319
  41. services-pulpcore-client/api/orphans_cleanup_api.py +0 -350
  42. services-pulpcore-client/api/publications_api.py +0 -765
  43. services-pulpcore-client/api/remotes_api.py +0 -850
  44. services-pulpcore-client/api/repair_api.py +0 -350
  45. services-pulpcore-client/api/repositories_api.py +0 -872
  46. services-pulpcore-client/api/repositories_openpgp_keyring_api.py +0 -4546
  47. services-pulpcore-client/api/repositories_reclaim_space_api.py +0 -350
  48. services-pulpcore-client/api/repository_versions_api.py +0 -764
  49. services-pulpcore-client/api/roles_api.py +0 -2269
  50. services-pulpcore-client/api/signing_services_api.py +0 -811
  51. services-pulpcore-client/api/status_api.py +0 -337
  52. services-pulpcore-client/api/task_groups_api.py +0 -1012
  53. services-pulpcore-client/api/task_schedules_api.py +0 -2114
  54. services-pulpcore-client/api/tasks_api.py +0 -4299
  55. services-pulpcore-client/api/uploads_api.py +0 -3346
  56. services-pulpcore-client/api/upstream_pulps_api.py +0 -4001
  57. services-pulpcore-client/api/users_api.py +0 -2373
  58. services-pulpcore-client/api/users_roles_api.py +0 -1496
  59. services-pulpcore-client/api/workers_api.py +0 -1148
  60. services-pulpcore-client/api_client.py +0 -798
  61. services-pulpcore-client/api_response.py +0 -21
  62. services-pulpcore-client/configuration.py +0 -628
  63. services-pulpcore-client/exceptions.py +0 -200
  64. services-pulpcore-client/models/__init__.py +0 -189
  65. services-pulpcore-client/models/access_policy.py +0 -94
  66. services-pulpcore-client/models/access_policy_response.py +0 -119
  67. services-pulpcore-client/models/api_app_status_response.py +0 -99
  68. services-pulpcore-client/models/artifact_distribution_response.py +0 -126
  69. services-pulpcore-client/models/artifact_response.py +0 -149
  70. services-pulpcore-client/models/async_operation_response.py +0 -88
  71. services-pulpcore-client/models/composite_content_guard.py +0 -98
  72. services-pulpcore-client/models/composite_content_guard_response.py +0 -114
  73. services-pulpcore-client/models/content_app_status_response.py +0 -99
  74. services-pulpcore-client/models/content_guard_response.py +0 -112
  75. services-pulpcore-client/models/content_redirect_content_guard.py +0 -96
  76. services-pulpcore-client/models/content_redirect_content_guard_response.py +0 -112
  77. services-pulpcore-client/models/content_settings_response.py +0 -95
  78. services-pulpcore-client/models/content_summary_response.py +0 -92
  79. services-pulpcore-client/models/database_connection_response.py +0 -88
  80. services-pulpcore-client/models/distribution_response.py +0 -133
  81. services-pulpcore-client/models/domain.py +0 -114
  82. services-pulpcore-client/models/domain_backend_migrator.py +0 -91
  83. services-pulpcore-client/models/domain_response.py +0 -131
  84. services-pulpcore-client/models/evaluation_response.py +0 -92
  85. services-pulpcore-client/models/filesystem_export.py +0 -99
  86. services-pulpcore-client/models/filesystem_export_response.py +0 -118
  87. services-pulpcore-client/models/filesystem_exporter.py +0 -94
  88. services-pulpcore-client/models/filesystem_exporter_response.py +0 -110
  89. services-pulpcore-client/models/generic_remote_response.py +0 -199
  90. services-pulpcore-client/models/generic_remote_response_hidden_fields_inner.py +0 -90
  91. services-pulpcore-client/models/generic_remote_response_policy_enum.py +0 -39
  92. services-pulpcore-client/models/group.py +0 -89
  93. services-pulpcore-client/models/group_progress_report_response.py +0 -111
  94. services-pulpcore-client/models/group_response.py +0 -101
  95. services-pulpcore-client/models/group_role.py +0 -110
  96. services-pulpcore-client/models/group_role_response.py +0 -134
  97. services-pulpcore-client/models/group_user.py +0 -89
  98. services-pulpcore-client/models/group_user_response.py +0 -97
  99. services-pulpcore-client/models/header_content_guard.py +0 -107
  100. services-pulpcore-client/models/header_content_guard_response.py +0 -123
  101. services-pulpcore-client/models/import_response.py +0 -107
  102. services-pulpcore-client/models/login_response.py +0 -98
  103. services-pulpcore-client/models/method_enum.py +0 -39
  104. services-pulpcore-client/models/minimal_task_response.py +0 -125
  105. services-pulpcore-client/models/multiple_artifact_content_response.py +0 -107
  106. services-pulpcore-client/models/my_permissions_response.py +0 -88
  107. services-pulpcore-client/models/nested_open_pgp_public_subkey.py +0 -92
  108. services-pulpcore-client/models/nested_open_pgp_public_subkey_response.py +0 -104
  109. services-pulpcore-client/models/nested_open_pgp_signature.py +0 -120
  110. services-pulpcore-client/models/nested_open_pgp_signature_response.py +0 -124
  111. services-pulpcore-client/models/nested_open_pgp_user_attribute.py +0 -89
  112. services-pulpcore-client/models/nested_open_pgp_user_attribute_response.py +0 -101
  113. services-pulpcore-client/models/nested_open_pgp_user_id.py +0 -89
  114. services-pulpcore-client/models/nested_open_pgp_user_id_response.py +0 -100
  115. services-pulpcore-client/models/nested_role.py +0 -93
  116. services-pulpcore-client/models/nested_role_response.py +0 -92
  117. services-pulpcore-client/models/object_roles_response.py +0 -96
  118. services-pulpcore-client/models/open_pgp_distribution.py +0 -116
  119. services-pulpcore-client/models/open_pgp_distribution_response.py +0 -140
  120. services-pulpcore-client/models/open_pgp_keyring.py +0 -112
  121. services-pulpcore-client/models/open_pgp_keyring_response.py +0 -137
  122. services-pulpcore-client/models/open_pgp_public_key_response.py +0 -150
  123. services-pulpcore-client/models/open_pgp_public_subkey_response.py +0 -126
  124. services-pulpcore-client/models/open_pgp_signature_response.py +0 -146
  125. services-pulpcore-client/models/open_pgp_user_attribute_response.py +0 -124
  126. services-pulpcore-client/models/open_pgp_user_id_response.py +0 -123
  127. services-pulpcore-client/models/orphans_cleanup.py +0 -96
  128. services-pulpcore-client/models/paginated_access_policy_response_list.py +0 -112
  129. services-pulpcore-client/models/paginated_artifact_distribution_response_list.py +0 -112
  130. services-pulpcore-client/models/paginated_artifact_response_list.py +0 -112
  131. services-pulpcore-client/models/paginated_composite_content_guard_response_list.py +0 -112
  132. services-pulpcore-client/models/paginated_content_guard_response_list.py +0 -112
  133. services-pulpcore-client/models/paginated_content_redirect_content_guard_response_list.py +0 -112
  134. services-pulpcore-client/models/paginated_distribution_response_list.py +0 -112
  135. services-pulpcore-client/models/paginated_domain_response_list.py +0 -112
  136. services-pulpcore-client/models/paginated_filesystem_export_response_list.py +0 -112
  137. services-pulpcore-client/models/paginated_filesystem_exporter_response_list.py +0 -112
  138. services-pulpcore-client/models/paginated_generic_remote_response_list.py +0 -112
  139. services-pulpcore-client/models/paginated_group_response_list.py +0 -112
  140. services-pulpcore-client/models/paginated_group_role_response_list.py +0 -112
  141. services-pulpcore-client/models/paginated_group_user_response_list.py +0 -112
  142. services-pulpcore-client/models/paginated_header_content_guard_response_list.py +0 -112
  143. services-pulpcore-client/models/paginated_import_response_list.py +0 -112
  144. services-pulpcore-client/models/paginated_multiple_artifact_content_response_list.py +0 -112
  145. services-pulpcore-client/models/paginated_open_pgp_distribution_response_list.py +0 -112
  146. services-pulpcore-client/models/paginated_open_pgp_keyring_response_list.py +0 -112
  147. services-pulpcore-client/models/paginated_open_pgp_public_key_response_list.py +0 -112
  148. services-pulpcore-client/models/paginated_open_pgp_public_subkey_response_list.py +0 -112
  149. services-pulpcore-client/models/paginated_open_pgp_signature_response_list.py +0 -112
  150. services-pulpcore-client/models/paginated_open_pgp_user_attribute_response_list.py +0 -112
  151. services-pulpcore-client/models/paginated_open_pgp_user_id_response_list.py +0 -112
  152. services-pulpcore-client/models/paginated_publication_response_list.py +0 -112
  153. services-pulpcore-client/models/paginated_pulp_export_response_list.py +0 -112
  154. services-pulpcore-client/models/paginated_pulp_exporter_response_list.py +0 -112
  155. services-pulpcore-client/models/paginated_pulp_importer_response_list.py +0 -112
  156. services-pulpcore-client/models/paginated_rbac_content_guard_response_list.py +0 -112
  157. services-pulpcore-client/models/paginated_repository_response_list.py +0 -112
  158. services-pulpcore-client/models/paginated_repository_version_response_list.py +0 -112
  159. services-pulpcore-client/models/paginated_role_response_list.py +0 -112
  160. services-pulpcore-client/models/paginated_signing_service_response_list.py +0 -112
  161. services-pulpcore-client/models/paginated_task_group_response_list.py +0 -112
  162. services-pulpcore-client/models/paginated_task_response_list.py +0 -112
  163. services-pulpcore-client/models/paginated_task_schedule_response_list.py +0 -112
  164. services-pulpcore-client/models/paginated_upload_response_list.py +0 -112
  165. services-pulpcore-client/models/paginated_upstream_pulp_response_list.py +0 -112
  166. services-pulpcore-client/models/paginated_user_response_list.py +0 -112
  167. services-pulpcore-client/models/paginated_user_role_response_list.py +0 -112
  168. services-pulpcore-client/models/paginated_worker_response_list.py +0 -112
  169. services-pulpcore-client/models/patched_access_policy.py +0 -94
  170. services-pulpcore-client/models/patched_composite_content_guard.py +0 -98
  171. services-pulpcore-client/models/patched_content_redirect_content_guard.py +0 -96
  172. services-pulpcore-client/models/patched_domain.py +0 -117
  173. services-pulpcore-client/models/patched_filesystem_exporter.py +0 -94
  174. services-pulpcore-client/models/patched_group.py +0 -89
  175. services-pulpcore-client/models/patched_header_content_guard.py +0 -107
  176. services-pulpcore-client/models/patched_open_pgp_distribution.py +0 -116
  177. services-pulpcore-client/models/patched_open_pgp_keyring.py +0 -112
  178. services-pulpcore-client/models/patched_pulp_exporter.py +0 -100
  179. services-pulpcore-client/models/patched_pulp_importer.py +0 -91
  180. services-pulpcore-client/models/patched_rbac_content_guard.py +0 -96
  181. services-pulpcore-client/models/patched_role.py +0 -98
  182. services-pulpcore-client/models/patched_task_cancel.py +0 -89
  183. services-pulpcore-client/models/patched_upstream_pulp.py +0 -147
  184. services-pulpcore-client/models/patched_user.py +0 -106
  185. services-pulpcore-client/models/policy357_enum.py +0 -39
  186. services-pulpcore-client/models/profile_artifact_response.py +0 -88
  187. services-pulpcore-client/models/progress_report_response.py +0 -115
  188. services-pulpcore-client/models/publication_response.py +0 -107
  189. services-pulpcore-client/models/pulp_export.py +0 -104
  190. services-pulpcore-client/models/pulp_export_response.py +0 -126
  191. services-pulpcore-client/models/pulp_exporter.py +0 -100
  192. services-pulpcore-client/models/pulp_exporter_response.py +0 -116
  193. services-pulpcore-client/models/pulp_import.py +0 -93
  194. services-pulpcore-client/models/pulp_import_check.py +0 -93
  195. services-pulpcore-client/models/pulp_import_check_response.py +0 -102
  196. services-pulpcore-client/models/pulp_importer.py +0 -91
  197. services-pulpcore-client/models/pulp_importer_response.py +0 -107
  198. services-pulpcore-client/models/purge.py +0 -92
  199. services-pulpcore-client/models/rbac_content_guard.py +0 -96
  200. services-pulpcore-client/models/rbac_content_guard_response.py +0 -136
  201. services-pulpcore-client/models/reclaim_space.py +0 -90
  202. services-pulpcore-client/models/redis_connection_response.py +0 -88
  203. services-pulpcore-client/models/repair.py +0 -88
  204. services-pulpcore-client/models/repository_add_remove_content.py +0 -93
  205. services-pulpcore-client/models/repository_response.py +0 -137
  206. services-pulpcore-client/models/repository_version_response.py +0 -121
  207. services-pulpcore-client/models/role.py +0 -98
  208. services-pulpcore-client/models/role_response.py +0 -118
  209. services-pulpcore-client/models/set_label.py +0 -103
  210. services-pulpcore-client/models/set_label_response.py +0 -103
  211. services-pulpcore-client/models/signing_service_response.py +0 -111
  212. services-pulpcore-client/models/states_enum.py +0 -40
  213. services-pulpcore-client/models/status_response.py +0 -152
  214. services-pulpcore-client/models/storage_class_enum.py +0 -40
  215. services-pulpcore-client/models/storage_response.py +0 -108
  216. services-pulpcore-client/models/task_group_operation_response.py +0 -88
  217. services-pulpcore-client/models/task_group_response.py +0 -150
  218. services-pulpcore-client/models/task_response.py +0 -167
  219. services-pulpcore-client/models/task_schedule_response.py +0 -127
  220. services-pulpcore-client/models/unset_label.py +0 -96
  221. services-pulpcore-client/models/unset_label_response.py +0 -100
  222. services-pulpcore-client/models/upload.py +0 -88
  223. services-pulpcore-client/models/upload_chunk_response.py +0 -94
  224. services-pulpcore-client/models/upload_commit.py +0 -89
  225. services-pulpcore-client/models/upload_detail_response.py +0 -121
  226. services-pulpcore-client/models/upload_response.py +0 -109
  227. services-pulpcore-client/models/upstream_pulp.py +0 -147
  228. services-pulpcore-client/models/upstream_pulp_response.py +0 -158
  229. services-pulpcore-client/models/user.py +0 -106
  230. services-pulpcore-client/models/user_group.py +0 -89
  231. services-pulpcore-client/models/user_group_response.py +0 -97
  232. services-pulpcore-client/models/user_response.py +0 -140
  233. services-pulpcore-client/models/user_role.py +0 -110
  234. services-pulpcore-client/models/user_role_response.py +0 -134
  235. services-pulpcore-client/models/version_response.py +0 -96
  236. services-pulpcore-client/models/worker_response.py +0 -119
  237. services-pulpcore-client/py.typed +0 -0
  238. services-pulpcore-client/rest.py +0 -258
  239. {crc_pulpcore_client-20250819.1.dist-info → crc_pulpcore_client-20250820.1.dist-info}/WHEEL +0 -0
@@ -1,4299 +0,0 @@
1
- # coding: utf-8
2
-
3
- """
4
- Pulp 3 API
5
-
6
- Fetch, Upload, Organize, and Distribute Software Packages
7
-
8
- The version of the OpenAPI document: v3
9
- Contact: pulp-list@redhat.com
10
- Generated by OpenAPI Generator (https://openapi-generator.tech)
11
-
12
- Do not edit the class manually.
13
- """ # noqa: E501
14
-
15
- import warnings
16
- from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
17
- from typing import Any, Dict, List, Optional, Tuple, Union
18
- from typing_extensions import Annotated
19
-
20
- from datetime import datetime
21
- from pydantic import Field, StrictBool, StrictInt, StrictStr, field_validator
22
- from typing import List, Optional
23
- from typing_extensions import Annotated
24
- from services-pulpcore-client.models.async_operation_response import AsyncOperationResponse
25
- from services-pulpcore-client.models.my_permissions_response import MyPermissionsResponse
26
- from services-pulpcore-client.models.nested_role import NestedRole
27
- from services-pulpcore-client.models.nested_role_response import NestedRoleResponse
28
- from services-pulpcore-client.models.object_roles_response import ObjectRolesResponse
29
- from services-pulpcore-client.models.paginated_task_response_list import PaginatedTaskResponseList
30
- from services-pulpcore-client.models.patched_task_cancel import PatchedTaskCancel
31
- from services-pulpcore-client.models.profile_artifact_response import ProfileArtifactResponse
32
- from services-pulpcore-client.models.purge import Purge
33
- from services-pulpcore-client.models.task_response import TaskResponse
34
-
35
- from services-pulpcore-client.api_client import ApiClient, RequestSerialized
36
- from services-pulpcore-client.api_response import ApiResponse
37
- from services-pulpcore-client.rest import RESTResponseType
38
-
39
-
40
- class TasksApi:
41
- """NOTE: This class is auto generated by OpenAPI Generator
42
- Ref: https://openapi-generator.tech
43
-
44
- Do not edit the class manually.
45
- """
46
-
47
- def __init__(self, api_client=None) -> None:
48
- if api_client is None:
49
- api_client = ApiClient.get_default()
50
- self.api_client = api_client
51
-
52
-
53
- @validate_call
54
- def add_role(
55
- self,
56
- task_href: StrictStr,
57
- nested_role: NestedRole,
58
- x_task_diagnostics: Annotated[Optional[List[StrictStr]], Field(description="List of profilers to use on tasks.")] = None,
59
- _request_timeout: Union[
60
- None,
61
- Annotated[StrictFloat, Field(gt=0)],
62
- Tuple[
63
- Annotated[StrictFloat, Field(gt=0)],
64
- Annotated[StrictFloat, Field(gt=0)]
65
- ]
66
- ] = None,
67
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
68
- _content_type: Optional[StrictStr] = None,
69
- _headers: Optional[Dict[StrictStr, Any]] = None,
70
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
71
- ) -> NestedRoleResponse:
72
- """Add a role
73
-
74
- Add a role for this object to users/groups.
75
-
76
- :param task_href: (required)
77
- :type task_href: str
78
- :param nested_role: (required)
79
- :type nested_role: NestedRole
80
- :param x_task_diagnostics: List of profilers to use on tasks.
81
- :type x_task_diagnostics: List[str]
82
- :param _request_timeout: timeout setting for this request. If one
83
- number provided, it will be total request
84
- timeout. It can also be a pair (tuple) of
85
- (connection, read) timeouts.
86
- :type _request_timeout: int, tuple(int, int), optional
87
- :param _request_auth: set to override the auth_settings for an a single
88
- request; this effectively ignores the
89
- authentication in the spec for a single request.
90
- :type _request_auth: dict, optional
91
- :param _content_type: force content-type for the request.
92
- :type _content_type: str, Optional
93
- :param _headers: set to override the headers for a single
94
- request; this effectively ignores the headers
95
- in the spec for a single request.
96
- :type _headers: dict, optional
97
- :param _host_index: set to override the host_index for a single
98
- request; this effectively ignores the host_index
99
- in the spec for a single request.
100
- :type _host_index: int, optional
101
- :return: Returns the result object.
102
- """ # noqa: E501
103
-
104
- _param = self._add_role_serialize(
105
- task_href=task_href,
106
- nested_role=nested_role,
107
- x_task_diagnostics=x_task_diagnostics,
108
- _request_auth=_request_auth,
109
- _content_type=_content_type,
110
- _headers=_headers,
111
- _host_index=_host_index
112
- )
113
-
114
- _response_types_map: Dict[str, Optional[str]] = {
115
- '201': "NestedRoleResponse",
116
- }
117
- response_data = self.api_client.call_api(
118
- *_param,
119
- _request_timeout=_request_timeout
120
- )
121
- response_data.read()
122
- return self.api_client.response_deserialize(
123
- response_data=response_data,
124
- response_types_map=_response_types_map,
125
- ).data
126
-
127
-
128
- @validate_call
129
- def add_role_with_http_info(
130
- self,
131
- task_href: StrictStr,
132
- nested_role: NestedRole,
133
- x_task_diagnostics: Annotated[Optional[List[StrictStr]], Field(description="List of profilers to use on tasks.")] = None,
134
- _request_timeout: Union[
135
- None,
136
- Annotated[StrictFloat, Field(gt=0)],
137
- Tuple[
138
- Annotated[StrictFloat, Field(gt=0)],
139
- Annotated[StrictFloat, Field(gt=0)]
140
- ]
141
- ] = None,
142
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
143
- _content_type: Optional[StrictStr] = None,
144
- _headers: Optional[Dict[StrictStr, Any]] = None,
145
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
146
- ) -> ApiResponse[NestedRoleResponse]:
147
- """Add a role
148
-
149
- Add a role for this object to users/groups.
150
-
151
- :param task_href: (required)
152
- :type task_href: str
153
- :param nested_role: (required)
154
- :type nested_role: NestedRole
155
- :param x_task_diagnostics: List of profilers to use on tasks.
156
- :type x_task_diagnostics: List[str]
157
- :param _request_timeout: timeout setting for this request. If one
158
- number provided, it will be total request
159
- timeout. It can also be a pair (tuple) of
160
- (connection, read) timeouts.
161
- :type _request_timeout: int, tuple(int, int), optional
162
- :param _request_auth: set to override the auth_settings for an a single
163
- request; this effectively ignores the
164
- authentication in the spec for a single request.
165
- :type _request_auth: dict, optional
166
- :param _content_type: force content-type for the request.
167
- :type _content_type: str, Optional
168
- :param _headers: set to override the headers for a single
169
- request; this effectively ignores the headers
170
- in the spec for a single request.
171
- :type _headers: dict, optional
172
- :param _host_index: set to override the host_index for a single
173
- request; this effectively ignores the host_index
174
- in the spec for a single request.
175
- :type _host_index: int, optional
176
- :return: Returns the result object.
177
- """ # noqa: E501
178
-
179
- _param = self._add_role_serialize(
180
- task_href=task_href,
181
- nested_role=nested_role,
182
- x_task_diagnostics=x_task_diagnostics,
183
- _request_auth=_request_auth,
184
- _content_type=_content_type,
185
- _headers=_headers,
186
- _host_index=_host_index
187
- )
188
-
189
- _response_types_map: Dict[str, Optional[str]] = {
190
- '201': "NestedRoleResponse",
191
- }
192
- response_data = self.api_client.call_api(
193
- *_param,
194
- _request_timeout=_request_timeout
195
- )
196
- response_data.read()
197
- return self.api_client.response_deserialize(
198
- response_data=response_data,
199
- response_types_map=_response_types_map,
200
- )
201
-
202
-
203
- @validate_call
204
- def add_role_without_preload_content(
205
- self,
206
- task_href: StrictStr,
207
- nested_role: NestedRole,
208
- x_task_diagnostics: Annotated[Optional[List[StrictStr]], Field(description="List of profilers to use on tasks.")] = None,
209
- _request_timeout: Union[
210
- None,
211
- Annotated[StrictFloat, Field(gt=0)],
212
- Tuple[
213
- Annotated[StrictFloat, Field(gt=0)],
214
- Annotated[StrictFloat, Field(gt=0)]
215
- ]
216
- ] = None,
217
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
218
- _content_type: Optional[StrictStr] = None,
219
- _headers: Optional[Dict[StrictStr, Any]] = None,
220
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
221
- ) -> RESTResponseType:
222
- """Add a role
223
-
224
- Add a role for this object to users/groups.
225
-
226
- :param task_href: (required)
227
- :type task_href: str
228
- :param nested_role: (required)
229
- :type nested_role: NestedRole
230
- :param x_task_diagnostics: List of profilers to use on tasks.
231
- :type x_task_diagnostics: List[str]
232
- :param _request_timeout: timeout setting for this request. If one
233
- number provided, it will be total request
234
- timeout. It can also be a pair (tuple) of
235
- (connection, read) timeouts.
236
- :type _request_timeout: int, tuple(int, int), optional
237
- :param _request_auth: set to override the auth_settings for an a single
238
- request; this effectively ignores the
239
- authentication in the spec for a single request.
240
- :type _request_auth: dict, optional
241
- :param _content_type: force content-type for the request.
242
- :type _content_type: str, Optional
243
- :param _headers: set to override the headers for a single
244
- request; this effectively ignores the headers
245
- in the spec for a single request.
246
- :type _headers: dict, optional
247
- :param _host_index: set to override the host_index for a single
248
- request; this effectively ignores the host_index
249
- in the spec for a single request.
250
- :type _host_index: int, optional
251
- :return: Returns the result object.
252
- """ # noqa: E501
253
-
254
- _param = self._add_role_serialize(
255
- task_href=task_href,
256
- nested_role=nested_role,
257
- x_task_diagnostics=x_task_diagnostics,
258
- _request_auth=_request_auth,
259
- _content_type=_content_type,
260
- _headers=_headers,
261
- _host_index=_host_index
262
- )
263
-
264
- _response_types_map: Dict[str, Optional[str]] = {
265
- '201': "NestedRoleResponse",
266
- }
267
- response_data = self.api_client.call_api(
268
- *_param,
269
- _request_timeout=_request_timeout
270
- )
271
- return response_data.response
272
-
273
-
274
- def _add_role_serialize(
275
- self,
276
- task_href,
277
- nested_role,
278
- x_task_diagnostics,
279
- _request_auth,
280
- _content_type,
281
- _headers,
282
- _host_index,
283
- ) -> RequestSerialized:
284
-
285
- _host = None
286
-
287
- _collection_formats: Dict[str, str] = {
288
- 'X-Task-Diagnostics': 'csv',
289
- }
290
-
291
- _path_params: Dict[str, str] = {}
292
- _query_params: List[Tuple[str, str]] = []
293
- _header_params: Dict[str, Optional[str]] = _headers or {}
294
- _form_params: List[Tuple[str, str]] = []
295
- _files: Dict[
296
- str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
297
- ] = {}
298
- _body_params: Optional[bytes] = None
299
-
300
- # process the path parameters
301
- if task_href is not None:
302
- _path_params['task_href'] = task_href
303
- # process the query parameters
304
- # process the header parameters
305
- if x_task_diagnostics is not None:
306
- _header_params['X-Task-Diagnostics'] = x_task_diagnostics
307
- # process the form parameters
308
- # process the body parameter
309
- if nested_role is not None:
310
- _body_params = nested_role
311
-
312
-
313
- # set the HTTP header `Accept`
314
- if 'Accept' not in _header_params:
315
- _header_params['Accept'] = self.api_client.select_header_accept(
316
- [
317
- 'application/json'
318
- ]
319
- )
320
-
321
- # set the HTTP header `Content-Type`
322
- if _content_type:
323
- _header_params['Content-Type'] = _content_type
324
- else:
325
- _default_content_type = (
326
- self.api_client.select_header_content_type(
327
- [
328
- 'application/json',
329
- 'application/x-www-form-urlencoded',
330
- 'multipart/form-data'
331
- ]
332
- )
333
- )
334
- if _default_content_type is not None:
335
- _header_params['Content-Type'] = _default_content_type
336
-
337
- # authentication setting
338
- _auth_settings: List[str] = [
339
- 'json_header_remote_authentication',
340
- 'basicAuth',
341
- 'cookieAuth'
342
- ]
343
-
344
- return self.api_client.param_serialize(
345
- method='POST',
346
- resource_path='{task_href}add_role/',
347
- path_params=_path_params,
348
- query_params=_query_params,
349
- header_params=_header_params,
350
- body=_body_params,
351
- post_params=_form_params,
352
- files=_files,
353
- auth_settings=_auth_settings,
354
- collection_formats=_collection_formats,
355
- _host=_host,
356
- _request_auth=_request_auth
357
- )
358
-
359
-
360
-
361
-
362
- @validate_call
363
- def delete(
364
- self,
365
- task_href: StrictStr,
366
- x_task_diagnostics: Annotated[Optional[List[StrictStr]], Field(description="List of profilers to use on tasks.")] = None,
367
- _request_timeout: Union[
368
- None,
369
- Annotated[StrictFloat, Field(gt=0)],
370
- Tuple[
371
- Annotated[StrictFloat, Field(gt=0)],
372
- Annotated[StrictFloat, Field(gt=0)]
373
- ]
374
- ] = None,
375
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
376
- _content_type: Optional[StrictStr] = None,
377
- _headers: Optional[Dict[StrictStr, Any]] = None,
378
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
379
- ) -> None:
380
- """Delete a task
381
-
382
- 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.
383
-
384
- :param task_href: (required)
385
- :type task_href: str
386
- :param x_task_diagnostics: List of profilers to use on tasks.
387
- :type x_task_diagnostics: List[str]
388
- :param _request_timeout: timeout setting for this request. If one
389
- number provided, it will be total request
390
- timeout. It can also be a pair (tuple) of
391
- (connection, read) timeouts.
392
- :type _request_timeout: int, tuple(int, int), optional
393
- :param _request_auth: set to override the auth_settings for an a single
394
- request; this effectively ignores the
395
- authentication in the spec for a single request.
396
- :type _request_auth: dict, optional
397
- :param _content_type: force content-type for the request.
398
- :type _content_type: str, Optional
399
- :param _headers: set to override the headers for a single
400
- request; this effectively ignores the headers
401
- in the spec for a single request.
402
- :type _headers: dict, optional
403
- :param _host_index: set to override the host_index for a single
404
- request; this effectively ignores the host_index
405
- in the spec for a single request.
406
- :type _host_index: int, optional
407
- :return: Returns the result object.
408
- """ # noqa: E501
409
-
410
- _param = self._delete_serialize(
411
- task_href=task_href,
412
- x_task_diagnostics=x_task_diagnostics,
413
- _request_auth=_request_auth,
414
- _content_type=_content_type,
415
- _headers=_headers,
416
- _host_index=_host_index
417
- )
418
-
419
- _response_types_map: Dict[str, Optional[str]] = {
420
- '204': None,
421
- }
422
- response_data = self.api_client.call_api(
423
- *_param,
424
- _request_timeout=_request_timeout
425
- )
426
- response_data.read()
427
- return self.api_client.response_deserialize(
428
- response_data=response_data,
429
- response_types_map=_response_types_map,
430
- ).data
431
-
432
-
433
- @validate_call
434
- def delete_with_http_info(
435
- self,
436
- task_href: StrictStr,
437
- x_task_diagnostics: Annotated[Optional[List[StrictStr]], Field(description="List of profilers to use on tasks.")] = None,
438
- _request_timeout: Union[
439
- None,
440
- Annotated[StrictFloat, Field(gt=0)],
441
- Tuple[
442
- Annotated[StrictFloat, Field(gt=0)],
443
- Annotated[StrictFloat, Field(gt=0)]
444
- ]
445
- ] = None,
446
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
447
- _content_type: Optional[StrictStr] = None,
448
- _headers: Optional[Dict[StrictStr, Any]] = None,
449
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
450
- ) -> ApiResponse[None]:
451
- """Delete a task
452
-
453
- 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.
454
-
455
- :param task_href: (required)
456
- :type task_href: str
457
- :param x_task_diagnostics: List of profilers to use on tasks.
458
- :type x_task_diagnostics: List[str]
459
- :param _request_timeout: timeout setting for this request. If one
460
- number provided, it will be total request
461
- timeout. It can also be a pair (tuple) of
462
- (connection, read) timeouts.
463
- :type _request_timeout: int, tuple(int, int), optional
464
- :param _request_auth: set to override the auth_settings for an a single
465
- request; this effectively ignores the
466
- authentication in the spec for a single request.
467
- :type _request_auth: dict, optional
468
- :param _content_type: force content-type for the request.
469
- :type _content_type: str, Optional
470
- :param _headers: set to override the headers for a single
471
- request; this effectively ignores the headers
472
- in the spec for a single request.
473
- :type _headers: dict, optional
474
- :param _host_index: set to override the host_index for a single
475
- request; this effectively ignores the host_index
476
- in the spec for a single request.
477
- :type _host_index: int, optional
478
- :return: Returns the result object.
479
- """ # noqa: E501
480
-
481
- _param = self._delete_serialize(
482
- task_href=task_href,
483
- x_task_diagnostics=x_task_diagnostics,
484
- _request_auth=_request_auth,
485
- _content_type=_content_type,
486
- _headers=_headers,
487
- _host_index=_host_index
488
- )
489
-
490
- _response_types_map: Dict[str, Optional[str]] = {
491
- '204': None,
492
- }
493
- response_data = self.api_client.call_api(
494
- *_param,
495
- _request_timeout=_request_timeout
496
- )
497
- response_data.read()
498
- return self.api_client.response_deserialize(
499
- response_data=response_data,
500
- response_types_map=_response_types_map,
501
- )
502
-
503
-
504
- @validate_call
505
- def delete_without_preload_content(
506
- self,
507
- task_href: StrictStr,
508
- x_task_diagnostics: Annotated[Optional[List[StrictStr]], Field(description="List of profilers to use on tasks.")] = None,
509
- _request_timeout: Union[
510
- None,
511
- Annotated[StrictFloat, Field(gt=0)],
512
- Tuple[
513
- Annotated[StrictFloat, Field(gt=0)],
514
- Annotated[StrictFloat, Field(gt=0)]
515
- ]
516
- ] = None,
517
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
518
- _content_type: Optional[StrictStr] = None,
519
- _headers: Optional[Dict[StrictStr, Any]] = None,
520
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
521
- ) -> RESTResponseType:
522
- """Delete a task
523
-
524
- 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.
525
-
526
- :param task_href: (required)
527
- :type task_href: str
528
- :param x_task_diagnostics: List of profilers to use on tasks.
529
- :type x_task_diagnostics: List[str]
530
- :param _request_timeout: timeout setting for this request. If one
531
- number provided, it will be total request
532
- timeout. It can also be a pair (tuple) of
533
- (connection, read) timeouts.
534
- :type _request_timeout: int, tuple(int, int), optional
535
- :param _request_auth: set to override the auth_settings for an a single
536
- request; this effectively ignores the
537
- authentication in the spec for a single request.
538
- :type _request_auth: dict, optional
539
- :param _content_type: force content-type for the request.
540
- :type _content_type: str, Optional
541
- :param _headers: set to override the headers for a single
542
- request; this effectively ignores the headers
543
- in the spec for a single request.
544
- :type _headers: dict, optional
545
- :param _host_index: set to override the host_index for a single
546
- request; this effectively ignores the host_index
547
- in the spec for a single request.
548
- :type _host_index: int, optional
549
- :return: Returns the result object.
550
- """ # noqa: E501
551
-
552
- _param = self._delete_serialize(
553
- task_href=task_href,
554
- x_task_diagnostics=x_task_diagnostics,
555
- _request_auth=_request_auth,
556
- _content_type=_content_type,
557
- _headers=_headers,
558
- _host_index=_host_index
559
- )
560
-
561
- _response_types_map: Dict[str, Optional[str]] = {
562
- '204': None,
563
- }
564
- response_data = self.api_client.call_api(
565
- *_param,
566
- _request_timeout=_request_timeout
567
- )
568
- return response_data.response
569
-
570
-
571
- def _delete_serialize(
572
- self,
573
- task_href,
574
- x_task_diagnostics,
575
- _request_auth,
576
- _content_type,
577
- _headers,
578
- _host_index,
579
- ) -> RequestSerialized:
580
-
581
- _host = None
582
-
583
- _collection_formats: Dict[str, str] = {
584
- 'X-Task-Diagnostics': 'csv',
585
- }
586
-
587
- _path_params: Dict[str, str] = {}
588
- _query_params: List[Tuple[str, str]] = []
589
- _header_params: Dict[str, Optional[str]] = _headers or {}
590
- _form_params: List[Tuple[str, str]] = []
591
- _files: Dict[
592
- str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
593
- ] = {}
594
- _body_params: Optional[bytes] = None
595
-
596
- # process the path parameters
597
- if task_href is not None:
598
- _path_params['task_href'] = task_href
599
- # process the query parameters
600
- # process the header parameters
601
- if x_task_diagnostics is not None:
602
- _header_params['X-Task-Diagnostics'] = x_task_diagnostics
603
- # process the form parameters
604
- # process the body parameter
605
-
606
-
607
-
608
-
609
- # authentication setting
610
- _auth_settings: List[str] = [
611
- 'json_header_remote_authentication',
612
- 'basicAuth',
613
- 'cookieAuth'
614
- ]
615
-
616
- return self.api_client.param_serialize(
617
- method='DELETE',
618
- resource_path='{task_href}',
619
- path_params=_path_params,
620
- query_params=_query_params,
621
- header_params=_header_params,
622
- body=_body_params,
623
- post_params=_form_params,
624
- files=_files,
625
- auth_settings=_auth_settings,
626
- collection_formats=_collection_formats,
627
- _host=_host,
628
- _request_auth=_request_auth
629
- )
630
-
631
-
632
-
633
-
634
- @validate_call
635
- def list(
636
- self,
637
- x_task_diagnostics: Annotated[Optional[List[StrictStr]], Field(description="List of profilers to use on tasks.")] = None,
638
- child_tasks: Annotated[Optional[StrictStr], Field(description="Filter results where child_tasks matches value")] = None,
639
- created_resources: Optional[StrictStr] = None,
640
- exclusive_resources: Optional[StrictStr] = None,
641
- exclusive_resources__in: Annotated[Optional[List[StrictStr]], Field(description="Multiple values may be separated by commas.")] = None,
642
- finished_at: Annotated[Optional[datetime], Field(description="Filter results where finished_at matches value")] = None,
643
- finished_at__gt: Annotated[Optional[datetime], Field(description="Filter results where finished_at is greater than value")] = None,
644
- finished_at__gte: Annotated[Optional[datetime], Field(description="Filter results where finished_at is greater than or equal to value")] = None,
645
- finished_at__isnull: Annotated[Optional[StrictBool], Field(description="Filter results where finished_at has a null value")] = None,
646
- finished_at__lt: Annotated[Optional[datetime], Field(description="Filter results where finished_at is less than value")] = None,
647
- finished_at__lte: Annotated[Optional[datetime], Field(description="Filter results where finished_at is less than or equal to value")] = None,
648
- finished_at__range: Annotated[Optional[List[datetime]], Field(description="Filter results where finished_at is between two comma separated values")] = None,
649
- limit: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
650
- logging_cid: Annotated[Optional[StrictStr], Field(description="Filter results where logging_cid matches value")] = None,
651
- logging_cid__contains: Annotated[Optional[StrictStr], Field(description="Filter results where logging_cid contains value")] = None,
652
- name: Annotated[Optional[StrictStr], Field(description="Filter results where name matches value")] = None,
653
- name__contains: Annotated[Optional[StrictStr], Field(description="Filter results where name contains value")] = None,
654
- name__in: Annotated[Optional[List[StrictStr]], Field(description="Filter results where name is in a comma-separated list of values")] = None,
655
- name__ne: Annotated[Optional[StrictStr], Field(description="Filter results where name not equal to value")] = None,
656
- offset: Annotated[Optional[StrictInt], Field(description="The initial index from which to return the results.")] = None,
657
- ordering: Annotated[Optional[List[StrictStr]], Field(description="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) * `pk` - Pk * `-pk` - Pk (descending)")] = None,
658
- parent_task: Annotated[Optional[StrictStr], Field(description="Filter results where parent_task matches value")] = None,
659
- prn__in: Annotated[Optional[List[StrictStr]], Field(description="Multiple values may be separated by commas.")] = None,
660
- pulp_created: Annotated[Optional[datetime], Field(description="Filter results where pulp_created matches value")] = None,
661
- pulp_created__gt: Annotated[Optional[datetime], Field(description="Filter results where pulp_created is greater than value")] = None,
662
- pulp_created__gte: Annotated[Optional[datetime], Field(description="Filter results where pulp_created is greater than or equal to value")] = None,
663
- pulp_created__isnull: Annotated[Optional[StrictBool], Field(description="Filter results where pulp_created has a null value")] = None,
664
- pulp_created__lt: Annotated[Optional[datetime], Field(description="Filter results where pulp_created is less than value")] = None,
665
- pulp_created__lte: Annotated[Optional[datetime], Field(description="Filter results where pulp_created is less than or equal to value")] = None,
666
- pulp_created__range: Annotated[Optional[List[datetime]], Field(description="Filter results where pulp_created is between two comma separated values")] = None,
667
- pulp_href__in: Annotated[Optional[List[StrictStr]], Field(description="Multiple values may be separated by commas.")] = None,
668
- pulp_id__in: Annotated[Optional[List[StrictStr]], Field(description="Multiple values may be separated by commas.")] = None,
669
- q: Annotated[Optional[StrictStr], Field(description="Filter results by using NOT, AND and OR operations on other filters")] = None,
670
- reserved_resources: Optional[StrictStr] = None,
671
- reserved_resources__in: Annotated[Optional[List[StrictStr]], Field(description="Multiple values may be separated by commas.")] = None,
672
- shared_resources: Optional[StrictStr] = None,
673
- shared_resources__in: Annotated[Optional[List[StrictStr]], Field(description="Multiple values may be separated by commas.")] = None,
674
- started_at: Annotated[Optional[datetime], Field(description="Filter results where started_at matches value")] = None,
675
- started_at__gt: Annotated[Optional[datetime], Field(description="Filter results where started_at is greater than value")] = None,
676
- started_at__gte: Annotated[Optional[datetime], Field(description="Filter results where started_at is greater than or equal to value")] = None,
677
- started_at__isnull: Annotated[Optional[StrictBool], Field(description="Filter results where started_at has a null value")] = None,
678
- started_at__lt: Annotated[Optional[datetime], Field(description="Filter results where started_at is less than value")] = None,
679
- started_at__lte: Annotated[Optional[datetime], Field(description="Filter results where started_at is less than or equal to value")] = None,
680
- started_at__range: Annotated[Optional[List[datetime]], Field(description="Filter results where started_at is between two comma separated values")] = None,
681
- state: Annotated[Optional[StrictStr], Field(description="Filter results where state matches value * `waiting` - Waiting * `skipped` - Skipped * `running` - Running * `completed` - Completed * `failed` - Failed * `canceled` - Canceled * `canceling` - Canceling")] = None,
682
- state__in: Annotated[Optional[List[StrictStr]], Field(description="Filter results where state is in a comma-separated list of values")] = None,
683
- state__ne: Annotated[Optional[StrictStr], Field(description="Filter results where state not equal to value")] = None,
684
- task_group: Annotated[Optional[StrictStr], Field(description="Filter results where task_group matches value")] = None,
685
- unblocked_at: Annotated[Optional[datetime], Field(description="Filter results where unblocked_at matches value")] = None,
686
- unblocked_at__gt: Annotated[Optional[datetime], Field(description="Filter results where unblocked_at is greater than value")] = None,
687
- unblocked_at__gte: Annotated[Optional[datetime], Field(description="Filter results where unblocked_at is greater than or equal to value")] = None,
688
- unblocked_at__isnull: Annotated[Optional[StrictBool], Field(description="Filter results where unblocked_at has a null value")] = None,
689
- unblocked_at__lt: Annotated[Optional[datetime], Field(description="Filter results where unblocked_at is less than value")] = None,
690
- unblocked_at__lte: Annotated[Optional[datetime], Field(description="Filter results where unblocked_at is less than or equal to value")] = None,
691
- unblocked_at__range: Annotated[Optional[List[datetime]], Field(description="Filter results where unblocked_at is between two comma separated values")] = None,
692
- worker: Annotated[Optional[StrictStr], Field(description="Filter results where worker matches value")] = None,
693
- worker__in: Annotated[Optional[List[StrictStr]], Field(description="Filter results where worker is in a comma-separated list of values")] = None,
694
- worker__isnull: Annotated[Optional[StrictBool], Field(description="Filter results where worker has a null value")] = None,
695
- fields: Annotated[Optional[List[StrictStr]], Field(description="A list of fields to include in the response.")] = None,
696
- exclude_fields: Annotated[Optional[List[StrictStr]], Field(description="A list of fields to exclude from the response.")] = None,
697
- pulp_domain: StrictStr = "default",
698
- _request_timeout: Union[
699
- None,
700
- Annotated[StrictFloat, Field(gt=0)],
701
- Tuple[
702
- Annotated[StrictFloat, Field(gt=0)],
703
- Annotated[StrictFloat, Field(gt=0)]
704
- ]
705
- ] = None,
706
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
707
- _content_type: Optional[StrictStr] = None,
708
- _headers: Optional[Dict[StrictStr, Any]] = None,
709
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
710
- ) -> PaginatedTaskResponseList:
711
- """List tasks
712
-
713
- 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.
714
-
715
- :param pulp_domain: (required)
716
- :type pulp_domain: str
717
- :param x_task_diagnostics: List of profilers to use on tasks.
718
- :type x_task_diagnostics: List[str]
719
- :param child_tasks: Filter results where child_tasks matches value
720
- :type child_tasks: str
721
- :param created_resources:
722
- :type created_resources: str
723
- :param exclusive_resources:
724
- :type exclusive_resources: str
725
- :param exclusive_resources__in: Multiple values may be separated by commas.
726
- :type exclusive_resources__in: List[str]
727
- :param finished_at: Filter results where finished_at matches value
728
- :type finished_at: datetime
729
- :param finished_at__gt: Filter results where finished_at is greater than value
730
- :type finished_at__gt: datetime
731
- :param finished_at__gte: Filter results where finished_at is greater than or equal to value
732
- :type finished_at__gte: datetime
733
- :param finished_at__isnull: Filter results where finished_at has a null value
734
- :type finished_at__isnull: bool
735
- :param finished_at__lt: Filter results where finished_at is less than value
736
- :type finished_at__lt: datetime
737
- :param finished_at__lte: Filter results where finished_at is less than or equal to value
738
- :type finished_at__lte: datetime
739
- :param finished_at__range: Filter results where finished_at is between two comma separated values
740
- :type finished_at__range: List[datetime]
741
- :param limit: Number of results to return per page.
742
- :type limit: int
743
- :param logging_cid: Filter results where logging_cid matches value
744
- :type logging_cid: str
745
- :param logging_cid__contains: Filter results where logging_cid contains value
746
- :type logging_cid__contains: str
747
- :param name: Filter results where name matches value
748
- :type name: str
749
- :param name__contains: Filter results where name contains value
750
- :type name__contains: str
751
- :param name__in: Filter results where name is in a comma-separated list of values
752
- :type name__in: List[str]
753
- :param name__ne: Filter results where name not equal to value
754
- :type name__ne: str
755
- :param offset: The initial index from which to return the results.
756
- :type offset: int
757
- :param ordering: 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) * `pk` - Pk * `-pk` - Pk (descending)
758
- :type ordering: List[str]
759
- :param parent_task: Filter results where parent_task matches value
760
- :type parent_task: str
761
- :param prn__in: Multiple values may be separated by commas.
762
- :type prn__in: List[str]
763
- :param pulp_created: Filter results where pulp_created matches value
764
- :type pulp_created: datetime
765
- :param pulp_created__gt: Filter results where pulp_created is greater than value
766
- :type pulp_created__gt: datetime
767
- :param pulp_created__gte: Filter results where pulp_created is greater than or equal to value
768
- :type pulp_created__gte: datetime
769
- :param pulp_created__isnull: Filter results where pulp_created has a null value
770
- :type pulp_created__isnull: bool
771
- :param pulp_created__lt: Filter results where pulp_created is less than value
772
- :type pulp_created__lt: datetime
773
- :param pulp_created__lte: Filter results where pulp_created is less than or equal to value
774
- :type pulp_created__lte: datetime
775
- :param pulp_created__range: Filter results where pulp_created is between two comma separated values
776
- :type pulp_created__range: List[datetime]
777
- :param pulp_href__in: Multiple values may be separated by commas.
778
- :type pulp_href__in: List[str]
779
- :param pulp_id__in: Multiple values may be separated by commas.
780
- :type pulp_id__in: List[str]
781
- :param q: Filter results by using NOT, AND and OR operations on other filters
782
- :type q: str
783
- :param reserved_resources:
784
- :type reserved_resources: str
785
- :param reserved_resources__in: Multiple values may be separated by commas.
786
- :type reserved_resources__in: List[str]
787
- :param shared_resources:
788
- :type shared_resources: str
789
- :param shared_resources__in: Multiple values may be separated by commas.
790
- :type shared_resources__in: List[str]
791
- :param started_at: Filter results where started_at matches value
792
- :type started_at: datetime
793
- :param started_at__gt: Filter results where started_at is greater than value
794
- :type started_at__gt: datetime
795
- :param started_at__gte: Filter results where started_at is greater than or equal to value
796
- :type started_at__gte: datetime
797
- :param started_at__isnull: Filter results where started_at has a null value
798
- :type started_at__isnull: bool
799
- :param started_at__lt: Filter results where started_at is less than value
800
- :type started_at__lt: datetime
801
- :param started_at__lte: Filter results where started_at is less than or equal to value
802
- :type started_at__lte: datetime
803
- :param started_at__range: Filter results where started_at is between two comma separated values
804
- :type started_at__range: List[datetime]
805
- :param state: Filter results where state matches value * `waiting` - Waiting * `skipped` - Skipped * `running` - Running * `completed` - Completed * `failed` - Failed * `canceled` - Canceled * `canceling` - Canceling
806
- :type state: str
807
- :param state__in: Filter results where state is in a comma-separated list of values
808
- :type state__in: List[str]
809
- :param state__ne: Filter results where state not equal to value
810
- :type state__ne: str
811
- :param task_group: Filter results where task_group matches value
812
- :type task_group: str
813
- :param unblocked_at: Filter results where unblocked_at matches value
814
- :type unblocked_at: datetime
815
- :param unblocked_at__gt: Filter results where unblocked_at is greater than value
816
- :type unblocked_at__gt: datetime
817
- :param unblocked_at__gte: Filter results where unblocked_at is greater than or equal to value
818
- :type unblocked_at__gte: datetime
819
- :param unblocked_at__isnull: Filter results where unblocked_at has a null value
820
- :type unblocked_at__isnull: bool
821
- :param unblocked_at__lt: Filter results where unblocked_at is less than value
822
- :type unblocked_at__lt: datetime
823
- :param unblocked_at__lte: Filter results where unblocked_at is less than or equal to value
824
- :type unblocked_at__lte: datetime
825
- :param unblocked_at__range: Filter results where unblocked_at is between two comma separated values
826
- :type unblocked_at__range: List[datetime]
827
- :param worker: Filter results where worker matches value
828
- :type worker: str
829
- :param worker__in: Filter results where worker is in a comma-separated list of values
830
- :type worker__in: List[str]
831
- :param worker__isnull: Filter results where worker has a null value
832
- :type worker__isnull: bool
833
- :param fields: A list of fields to include in the response.
834
- :type fields: List[str]
835
- :param exclude_fields: A list of fields to exclude from the response.
836
- :type exclude_fields: List[str]
837
- :param _request_timeout: timeout setting for this request. If one
838
- number provided, it will be total request
839
- timeout. It can also be a pair (tuple) of
840
- (connection, read) timeouts.
841
- :type _request_timeout: int, tuple(int, int), optional
842
- :param _request_auth: set to override the auth_settings for an a single
843
- request; this effectively ignores the
844
- authentication in the spec for a single request.
845
- :type _request_auth: dict, optional
846
- :param _content_type: force content-type for the request.
847
- :type _content_type: str, Optional
848
- :param _headers: set to override the headers for a single
849
- request; this effectively ignores the headers
850
- in the spec for a single request.
851
- :type _headers: dict, optional
852
- :param _host_index: set to override the host_index for a single
853
- request; this effectively ignores the host_index
854
- in the spec for a single request.
855
- :type _host_index: int, optional
856
- :return: Returns the result object.
857
- """ # noqa: E501
858
-
859
- _param = self._list_serialize(
860
- pulp_domain=pulp_domain,
861
- x_task_diagnostics=x_task_diagnostics,
862
- child_tasks=child_tasks,
863
- created_resources=created_resources,
864
- exclusive_resources=exclusive_resources,
865
- exclusive_resources__in=exclusive_resources__in,
866
- finished_at=finished_at,
867
- finished_at__gt=finished_at__gt,
868
- finished_at__gte=finished_at__gte,
869
- finished_at__isnull=finished_at__isnull,
870
- finished_at__lt=finished_at__lt,
871
- finished_at__lte=finished_at__lte,
872
- finished_at__range=finished_at__range,
873
- limit=limit,
874
- logging_cid=logging_cid,
875
- logging_cid__contains=logging_cid__contains,
876
- name=name,
877
- name__contains=name__contains,
878
- name__in=name__in,
879
- name__ne=name__ne,
880
- offset=offset,
881
- ordering=ordering,
882
- parent_task=parent_task,
883
- prn__in=prn__in,
884
- pulp_created=pulp_created,
885
- pulp_created__gt=pulp_created__gt,
886
- pulp_created__gte=pulp_created__gte,
887
- pulp_created__isnull=pulp_created__isnull,
888
- pulp_created__lt=pulp_created__lt,
889
- pulp_created__lte=pulp_created__lte,
890
- pulp_created__range=pulp_created__range,
891
- pulp_href__in=pulp_href__in,
892
- pulp_id__in=pulp_id__in,
893
- q=q,
894
- reserved_resources=reserved_resources,
895
- reserved_resources__in=reserved_resources__in,
896
- shared_resources=shared_resources,
897
- shared_resources__in=shared_resources__in,
898
- started_at=started_at,
899
- started_at__gt=started_at__gt,
900
- started_at__gte=started_at__gte,
901
- started_at__isnull=started_at__isnull,
902
- started_at__lt=started_at__lt,
903
- started_at__lte=started_at__lte,
904
- started_at__range=started_at__range,
905
- state=state,
906
- state__in=state__in,
907
- state__ne=state__ne,
908
- task_group=task_group,
909
- unblocked_at=unblocked_at,
910
- unblocked_at__gt=unblocked_at__gt,
911
- unblocked_at__gte=unblocked_at__gte,
912
- unblocked_at__isnull=unblocked_at__isnull,
913
- unblocked_at__lt=unblocked_at__lt,
914
- unblocked_at__lte=unblocked_at__lte,
915
- unblocked_at__range=unblocked_at__range,
916
- worker=worker,
917
- worker__in=worker__in,
918
- worker__isnull=worker__isnull,
919
- fields=fields,
920
- exclude_fields=exclude_fields,
921
- _request_auth=_request_auth,
922
- _content_type=_content_type,
923
- _headers=_headers,
924
- _host_index=_host_index
925
- )
926
-
927
- _response_types_map: Dict[str, Optional[str]] = {
928
- '200': "PaginatedTaskResponseList",
929
- }
930
- response_data = self.api_client.call_api(
931
- *_param,
932
- _request_timeout=_request_timeout
933
- )
934
- response_data.read()
935
- return self.api_client.response_deserialize(
936
- response_data=response_data,
937
- response_types_map=_response_types_map,
938
- ).data
939
-
940
-
941
- @validate_call
942
- def list_with_http_info(
943
- self,
944
- x_task_diagnostics: Annotated[Optional[List[StrictStr]], Field(description="List of profilers to use on tasks.")] = None,
945
- child_tasks: Annotated[Optional[StrictStr], Field(description="Filter results where child_tasks matches value")] = None,
946
- created_resources: Optional[StrictStr] = None,
947
- exclusive_resources: Optional[StrictStr] = None,
948
- exclusive_resources__in: Annotated[Optional[List[StrictStr]], Field(description="Multiple values may be separated by commas.")] = None,
949
- finished_at: Annotated[Optional[datetime], Field(description="Filter results where finished_at matches value")] = None,
950
- finished_at__gt: Annotated[Optional[datetime], Field(description="Filter results where finished_at is greater than value")] = None,
951
- finished_at__gte: Annotated[Optional[datetime], Field(description="Filter results where finished_at is greater than or equal to value")] = None,
952
- finished_at__isnull: Annotated[Optional[StrictBool], Field(description="Filter results where finished_at has a null value")] = None,
953
- finished_at__lt: Annotated[Optional[datetime], Field(description="Filter results where finished_at is less than value")] = None,
954
- finished_at__lte: Annotated[Optional[datetime], Field(description="Filter results where finished_at is less than or equal to value")] = None,
955
- finished_at__range: Annotated[Optional[List[datetime]], Field(description="Filter results where finished_at is between two comma separated values")] = None,
956
- limit: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
957
- logging_cid: Annotated[Optional[StrictStr], Field(description="Filter results where logging_cid matches value")] = None,
958
- logging_cid__contains: Annotated[Optional[StrictStr], Field(description="Filter results where logging_cid contains value")] = None,
959
- name: Annotated[Optional[StrictStr], Field(description="Filter results where name matches value")] = None,
960
- name__contains: Annotated[Optional[StrictStr], Field(description="Filter results where name contains value")] = None,
961
- name__in: Annotated[Optional[List[StrictStr]], Field(description="Filter results where name is in a comma-separated list of values")] = None,
962
- name__ne: Annotated[Optional[StrictStr], Field(description="Filter results where name not equal to value")] = None,
963
- offset: Annotated[Optional[StrictInt], Field(description="The initial index from which to return the results.")] = None,
964
- ordering: Annotated[Optional[List[StrictStr]], Field(description="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) * `pk` - Pk * `-pk` - Pk (descending)")] = None,
965
- parent_task: Annotated[Optional[StrictStr], Field(description="Filter results where parent_task matches value")] = None,
966
- prn__in: Annotated[Optional[List[StrictStr]], Field(description="Multiple values may be separated by commas.")] = None,
967
- pulp_created: Annotated[Optional[datetime], Field(description="Filter results where pulp_created matches value")] = None,
968
- pulp_created__gt: Annotated[Optional[datetime], Field(description="Filter results where pulp_created is greater than value")] = None,
969
- pulp_created__gte: Annotated[Optional[datetime], Field(description="Filter results where pulp_created is greater than or equal to value")] = None,
970
- pulp_created__isnull: Annotated[Optional[StrictBool], Field(description="Filter results where pulp_created has a null value")] = None,
971
- pulp_created__lt: Annotated[Optional[datetime], Field(description="Filter results where pulp_created is less than value")] = None,
972
- pulp_created__lte: Annotated[Optional[datetime], Field(description="Filter results where pulp_created is less than or equal to value")] = None,
973
- pulp_created__range: Annotated[Optional[List[datetime]], Field(description="Filter results where pulp_created is between two comma separated values")] = None,
974
- pulp_href__in: Annotated[Optional[List[StrictStr]], Field(description="Multiple values may be separated by commas.")] = None,
975
- pulp_id__in: Annotated[Optional[List[StrictStr]], Field(description="Multiple values may be separated by commas.")] = None,
976
- q: Annotated[Optional[StrictStr], Field(description="Filter results by using NOT, AND and OR operations on other filters")] = None,
977
- reserved_resources: Optional[StrictStr] = None,
978
- reserved_resources__in: Annotated[Optional[List[StrictStr]], Field(description="Multiple values may be separated by commas.")] = None,
979
- shared_resources: Optional[StrictStr] = None,
980
- shared_resources__in: Annotated[Optional[List[StrictStr]], Field(description="Multiple values may be separated by commas.")] = None,
981
- started_at: Annotated[Optional[datetime], Field(description="Filter results where started_at matches value")] = None,
982
- started_at__gt: Annotated[Optional[datetime], Field(description="Filter results where started_at is greater than value")] = None,
983
- started_at__gte: Annotated[Optional[datetime], Field(description="Filter results where started_at is greater than or equal to value")] = None,
984
- started_at__isnull: Annotated[Optional[StrictBool], Field(description="Filter results where started_at has a null value")] = None,
985
- started_at__lt: Annotated[Optional[datetime], Field(description="Filter results where started_at is less than value")] = None,
986
- started_at__lte: Annotated[Optional[datetime], Field(description="Filter results where started_at is less than or equal to value")] = None,
987
- started_at__range: Annotated[Optional[List[datetime]], Field(description="Filter results where started_at is between two comma separated values")] = None,
988
- state: Annotated[Optional[StrictStr], Field(description="Filter results where state matches value * `waiting` - Waiting * `skipped` - Skipped * `running` - Running * `completed` - Completed * `failed` - Failed * `canceled` - Canceled * `canceling` - Canceling")] = None,
989
- state__in: Annotated[Optional[List[StrictStr]], Field(description="Filter results where state is in a comma-separated list of values")] = None,
990
- state__ne: Annotated[Optional[StrictStr], Field(description="Filter results where state not equal to value")] = None,
991
- task_group: Annotated[Optional[StrictStr], Field(description="Filter results where task_group matches value")] = None,
992
- unblocked_at: Annotated[Optional[datetime], Field(description="Filter results where unblocked_at matches value")] = None,
993
- unblocked_at__gt: Annotated[Optional[datetime], Field(description="Filter results where unblocked_at is greater than value")] = None,
994
- unblocked_at__gte: Annotated[Optional[datetime], Field(description="Filter results where unblocked_at is greater than or equal to value")] = None,
995
- unblocked_at__isnull: Annotated[Optional[StrictBool], Field(description="Filter results where unblocked_at has a null value")] = None,
996
- unblocked_at__lt: Annotated[Optional[datetime], Field(description="Filter results where unblocked_at is less than value")] = None,
997
- unblocked_at__lte: Annotated[Optional[datetime], Field(description="Filter results where unblocked_at is less than or equal to value")] = None,
998
- unblocked_at__range: Annotated[Optional[List[datetime]], Field(description="Filter results where unblocked_at is between two comma separated values")] = None,
999
- worker: Annotated[Optional[StrictStr], Field(description="Filter results where worker matches value")] = None,
1000
- worker__in: Annotated[Optional[List[StrictStr]], Field(description="Filter results where worker is in a comma-separated list of values")] = None,
1001
- worker__isnull: Annotated[Optional[StrictBool], Field(description="Filter results where worker has a null value")] = None,
1002
- fields: Annotated[Optional[List[StrictStr]], Field(description="A list of fields to include in the response.")] = None,
1003
- exclude_fields: Annotated[Optional[List[StrictStr]], Field(description="A list of fields to exclude from the response.")] = None,
1004
- pulp_domain: StrictStr = "default",
1005
- _request_timeout: Union[
1006
- None,
1007
- Annotated[StrictFloat, Field(gt=0)],
1008
- Tuple[
1009
- Annotated[StrictFloat, Field(gt=0)],
1010
- Annotated[StrictFloat, Field(gt=0)]
1011
- ]
1012
- ] = None,
1013
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
1014
- _content_type: Optional[StrictStr] = None,
1015
- _headers: Optional[Dict[StrictStr, Any]] = None,
1016
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1017
- ) -> ApiResponse[PaginatedTaskResponseList]:
1018
- """List tasks
1019
-
1020
- 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.
1021
-
1022
- :param pulp_domain: (required)
1023
- :type pulp_domain: str
1024
- :param x_task_diagnostics: List of profilers to use on tasks.
1025
- :type x_task_diagnostics: List[str]
1026
- :param child_tasks: Filter results where child_tasks matches value
1027
- :type child_tasks: str
1028
- :param created_resources:
1029
- :type created_resources: str
1030
- :param exclusive_resources:
1031
- :type exclusive_resources: str
1032
- :param exclusive_resources__in: Multiple values may be separated by commas.
1033
- :type exclusive_resources__in: List[str]
1034
- :param finished_at: Filter results where finished_at matches value
1035
- :type finished_at: datetime
1036
- :param finished_at__gt: Filter results where finished_at is greater than value
1037
- :type finished_at__gt: datetime
1038
- :param finished_at__gte: Filter results where finished_at is greater than or equal to value
1039
- :type finished_at__gte: datetime
1040
- :param finished_at__isnull: Filter results where finished_at has a null value
1041
- :type finished_at__isnull: bool
1042
- :param finished_at__lt: Filter results where finished_at is less than value
1043
- :type finished_at__lt: datetime
1044
- :param finished_at__lte: Filter results where finished_at is less than or equal to value
1045
- :type finished_at__lte: datetime
1046
- :param finished_at__range: Filter results where finished_at is between two comma separated values
1047
- :type finished_at__range: List[datetime]
1048
- :param limit: Number of results to return per page.
1049
- :type limit: int
1050
- :param logging_cid: Filter results where logging_cid matches value
1051
- :type logging_cid: str
1052
- :param logging_cid__contains: Filter results where logging_cid contains value
1053
- :type logging_cid__contains: str
1054
- :param name: Filter results where name matches value
1055
- :type name: str
1056
- :param name__contains: Filter results where name contains value
1057
- :type name__contains: str
1058
- :param name__in: Filter results where name is in a comma-separated list of values
1059
- :type name__in: List[str]
1060
- :param name__ne: Filter results where name not equal to value
1061
- :type name__ne: str
1062
- :param offset: The initial index from which to return the results.
1063
- :type offset: int
1064
- :param ordering: 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) * `pk` - Pk * `-pk` - Pk (descending)
1065
- :type ordering: List[str]
1066
- :param parent_task: Filter results where parent_task matches value
1067
- :type parent_task: str
1068
- :param prn__in: Multiple values may be separated by commas.
1069
- :type prn__in: List[str]
1070
- :param pulp_created: Filter results where pulp_created matches value
1071
- :type pulp_created: datetime
1072
- :param pulp_created__gt: Filter results where pulp_created is greater than value
1073
- :type pulp_created__gt: datetime
1074
- :param pulp_created__gte: Filter results where pulp_created is greater than or equal to value
1075
- :type pulp_created__gte: datetime
1076
- :param pulp_created__isnull: Filter results where pulp_created has a null value
1077
- :type pulp_created__isnull: bool
1078
- :param pulp_created__lt: Filter results where pulp_created is less than value
1079
- :type pulp_created__lt: datetime
1080
- :param pulp_created__lte: Filter results where pulp_created is less than or equal to value
1081
- :type pulp_created__lte: datetime
1082
- :param pulp_created__range: Filter results where pulp_created is between two comma separated values
1083
- :type pulp_created__range: List[datetime]
1084
- :param pulp_href__in: Multiple values may be separated by commas.
1085
- :type pulp_href__in: List[str]
1086
- :param pulp_id__in: Multiple values may be separated by commas.
1087
- :type pulp_id__in: List[str]
1088
- :param q: Filter results by using NOT, AND and OR operations on other filters
1089
- :type q: str
1090
- :param reserved_resources:
1091
- :type reserved_resources: str
1092
- :param reserved_resources__in: Multiple values may be separated by commas.
1093
- :type reserved_resources__in: List[str]
1094
- :param shared_resources:
1095
- :type shared_resources: str
1096
- :param shared_resources__in: Multiple values may be separated by commas.
1097
- :type shared_resources__in: List[str]
1098
- :param started_at: Filter results where started_at matches value
1099
- :type started_at: datetime
1100
- :param started_at__gt: Filter results where started_at is greater than value
1101
- :type started_at__gt: datetime
1102
- :param started_at__gte: Filter results where started_at is greater than or equal to value
1103
- :type started_at__gte: datetime
1104
- :param started_at__isnull: Filter results where started_at has a null value
1105
- :type started_at__isnull: bool
1106
- :param started_at__lt: Filter results where started_at is less than value
1107
- :type started_at__lt: datetime
1108
- :param started_at__lte: Filter results where started_at is less than or equal to value
1109
- :type started_at__lte: datetime
1110
- :param started_at__range: Filter results where started_at is between two comma separated values
1111
- :type started_at__range: List[datetime]
1112
- :param state: Filter results where state matches value * `waiting` - Waiting * `skipped` - Skipped * `running` - Running * `completed` - Completed * `failed` - Failed * `canceled` - Canceled * `canceling` - Canceling
1113
- :type state: str
1114
- :param state__in: Filter results where state is in a comma-separated list of values
1115
- :type state__in: List[str]
1116
- :param state__ne: Filter results where state not equal to value
1117
- :type state__ne: str
1118
- :param task_group: Filter results where task_group matches value
1119
- :type task_group: str
1120
- :param unblocked_at: Filter results where unblocked_at matches value
1121
- :type unblocked_at: datetime
1122
- :param unblocked_at__gt: Filter results where unblocked_at is greater than value
1123
- :type unblocked_at__gt: datetime
1124
- :param unblocked_at__gte: Filter results where unblocked_at is greater than or equal to value
1125
- :type unblocked_at__gte: datetime
1126
- :param unblocked_at__isnull: Filter results where unblocked_at has a null value
1127
- :type unblocked_at__isnull: bool
1128
- :param unblocked_at__lt: Filter results where unblocked_at is less than value
1129
- :type unblocked_at__lt: datetime
1130
- :param unblocked_at__lte: Filter results where unblocked_at is less than or equal to value
1131
- :type unblocked_at__lte: datetime
1132
- :param unblocked_at__range: Filter results where unblocked_at is between two comma separated values
1133
- :type unblocked_at__range: List[datetime]
1134
- :param worker: Filter results where worker matches value
1135
- :type worker: str
1136
- :param worker__in: Filter results where worker is in a comma-separated list of values
1137
- :type worker__in: List[str]
1138
- :param worker__isnull: Filter results where worker has a null value
1139
- :type worker__isnull: bool
1140
- :param fields: A list of fields to include in the response.
1141
- :type fields: List[str]
1142
- :param exclude_fields: A list of fields to exclude from the response.
1143
- :type exclude_fields: List[str]
1144
- :param _request_timeout: timeout setting for this request. If one
1145
- number provided, it will be total request
1146
- timeout. It can also be a pair (tuple) of
1147
- (connection, read) timeouts.
1148
- :type _request_timeout: int, tuple(int, int), optional
1149
- :param _request_auth: set to override the auth_settings for an a single
1150
- request; this effectively ignores the
1151
- authentication in the spec for a single request.
1152
- :type _request_auth: dict, optional
1153
- :param _content_type: force content-type for the request.
1154
- :type _content_type: str, Optional
1155
- :param _headers: set to override the headers for a single
1156
- request; this effectively ignores the headers
1157
- in the spec for a single request.
1158
- :type _headers: dict, optional
1159
- :param _host_index: set to override the host_index for a single
1160
- request; this effectively ignores the host_index
1161
- in the spec for a single request.
1162
- :type _host_index: int, optional
1163
- :return: Returns the result object.
1164
- """ # noqa: E501
1165
-
1166
- _param = self._list_serialize(
1167
- pulp_domain=pulp_domain,
1168
- x_task_diagnostics=x_task_diagnostics,
1169
- child_tasks=child_tasks,
1170
- created_resources=created_resources,
1171
- exclusive_resources=exclusive_resources,
1172
- exclusive_resources__in=exclusive_resources__in,
1173
- finished_at=finished_at,
1174
- finished_at__gt=finished_at__gt,
1175
- finished_at__gte=finished_at__gte,
1176
- finished_at__isnull=finished_at__isnull,
1177
- finished_at__lt=finished_at__lt,
1178
- finished_at__lte=finished_at__lte,
1179
- finished_at__range=finished_at__range,
1180
- limit=limit,
1181
- logging_cid=logging_cid,
1182
- logging_cid__contains=logging_cid__contains,
1183
- name=name,
1184
- name__contains=name__contains,
1185
- name__in=name__in,
1186
- name__ne=name__ne,
1187
- offset=offset,
1188
- ordering=ordering,
1189
- parent_task=parent_task,
1190
- prn__in=prn__in,
1191
- pulp_created=pulp_created,
1192
- pulp_created__gt=pulp_created__gt,
1193
- pulp_created__gte=pulp_created__gte,
1194
- pulp_created__isnull=pulp_created__isnull,
1195
- pulp_created__lt=pulp_created__lt,
1196
- pulp_created__lte=pulp_created__lte,
1197
- pulp_created__range=pulp_created__range,
1198
- pulp_href__in=pulp_href__in,
1199
- pulp_id__in=pulp_id__in,
1200
- q=q,
1201
- reserved_resources=reserved_resources,
1202
- reserved_resources__in=reserved_resources__in,
1203
- shared_resources=shared_resources,
1204
- shared_resources__in=shared_resources__in,
1205
- started_at=started_at,
1206
- started_at__gt=started_at__gt,
1207
- started_at__gte=started_at__gte,
1208
- started_at__isnull=started_at__isnull,
1209
- started_at__lt=started_at__lt,
1210
- started_at__lte=started_at__lte,
1211
- started_at__range=started_at__range,
1212
- state=state,
1213
- state__in=state__in,
1214
- state__ne=state__ne,
1215
- task_group=task_group,
1216
- unblocked_at=unblocked_at,
1217
- unblocked_at__gt=unblocked_at__gt,
1218
- unblocked_at__gte=unblocked_at__gte,
1219
- unblocked_at__isnull=unblocked_at__isnull,
1220
- unblocked_at__lt=unblocked_at__lt,
1221
- unblocked_at__lte=unblocked_at__lte,
1222
- unblocked_at__range=unblocked_at__range,
1223
- worker=worker,
1224
- worker__in=worker__in,
1225
- worker__isnull=worker__isnull,
1226
- fields=fields,
1227
- exclude_fields=exclude_fields,
1228
- _request_auth=_request_auth,
1229
- _content_type=_content_type,
1230
- _headers=_headers,
1231
- _host_index=_host_index
1232
- )
1233
-
1234
- _response_types_map: Dict[str, Optional[str]] = {
1235
- '200': "PaginatedTaskResponseList",
1236
- }
1237
- response_data = self.api_client.call_api(
1238
- *_param,
1239
- _request_timeout=_request_timeout
1240
- )
1241
- response_data.read()
1242
- return self.api_client.response_deserialize(
1243
- response_data=response_data,
1244
- response_types_map=_response_types_map,
1245
- )
1246
-
1247
-
1248
- @validate_call
1249
- def list_without_preload_content(
1250
- self,
1251
- x_task_diagnostics: Annotated[Optional[List[StrictStr]], Field(description="List of profilers to use on tasks.")] = None,
1252
- child_tasks: Annotated[Optional[StrictStr], Field(description="Filter results where child_tasks matches value")] = None,
1253
- created_resources: Optional[StrictStr] = None,
1254
- exclusive_resources: Optional[StrictStr] = None,
1255
- exclusive_resources__in: Annotated[Optional[List[StrictStr]], Field(description="Multiple values may be separated by commas.")] = None,
1256
- finished_at: Annotated[Optional[datetime], Field(description="Filter results where finished_at matches value")] = None,
1257
- finished_at__gt: Annotated[Optional[datetime], Field(description="Filter results where finished_at is greater than value")] = None,
1258
- finished_at__gte: Annotated[Optional[datetime], Field(description="Filter results where finished_at is greater than or equal to value")] = None,
1259
- finished_at__isnull: Annotated[Optional[StrictBool], Field(description="Filter results where finished_at has a null value")] = None,
1260
- finished_at__lt: Annotated[Optional[datetime], Field(description="Filter results where finished_at is less than value")] = None,
1261
- finished_at__lte: Annotated[Optional[datetime], Field(description="Filter results where finished_at is less than or equal to value")] = None,
1262
- finished_at__range: Annotated[Optional[List[datetime]], Field(description="Filter results where finished_at is between two comma separated values")] = None,
1263
- limit: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
1264
- logging_cid: Annotated[Optional[StrictStr], Field(description="Filter results where logging_cid matches value")] = None,
1265
- logging_cid__contains: Annotated[Optional[StrictStr], Field(description="Filter results where logging_cid contains value")] = None,
1266
- name: Annotated[Optional[StrictStr], Field(description="Filter results where name matches value")] = None,
1267
- name__contains: Annotated[Optional[StrictStr], Field(description="Filter results where name contains value")] = None,
1268
- name__in: Annotated[Optional[List[StrictStr]], Field(description="Filter results where name is in a comma-separated list of values")] = None,
1269
- name__ne: Annotated[Optional[StrictStr], Field(description="Filter results where name not equal to value")] = None,
1270
- offset: Annotated[Optional[StrictInt], Field(description="The initial index from which to return the results.")] = None,
1271
- ordering: Annotated[Optional[List[StrictStr]], Field(description="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) * `pk` - Pk * `-pk` - Pk (descending)")] = None,
1272
- parent_task: Annotated[Optional[StrictStr], Field(description="Filter results where parent_task matches value")] = None,
1273
- prn__in: Annotated[Optional[List[StrictStr]], Field(description="Multiple values may be separated by commas.")] = None,
1274
- pulp_created: Annotated[Optional[datetime], Field(description="Filter results where pulp_created matches value")] = None,
1275
- pulp_created__gt: Annotated[Optional[datetime], Field(description="Filter results where pulp_created is greater than value")] = None,
1276
- pulp_created__gte: Annotated[Optional[datetime], Field(description="Filter results where pulp_created is greater than or equal to value")] = None,
1277
- pulp_created__isnull: Annotated[Optional[StrictBool], Field(description="Filter results where pulp_created has a null value")] = None,
1278
- pulp_created__lt: Annotated[Optional[datetime], Field(description="Filter results where pulp_created is less than value")] = None,
1279
- pulp_created__lte: Annotated[Optional[datetime], Field(description="Filter results where pulp_created is less than or equal to value")] = None,
1280
- pulp_created__range: Annotated[Optional[List[datetime]], Field(description="Filter results where pulp_created is between two comma separated values")] = None,
1281
- pulp_href__in: Annotated[Optional[List[StrictStr]], Field(description="Multiple values may be separated by commas.")] = None,
1282
- pulp_id__in: Annotated[Optional[List[StrictStr]], Field(description="Multiple values may be separated by commas.")] = None,
1283
- q: Annotated[Optional[StrictStr], Field(description="Filter results by using NOT, AND and OR operations on other filters")] = None,
1284
- reserved_resources: Optional[StrictStr] = None,
1285
- reserved_resources__in: Annotated[Optional[List[StrictStr]], Field(description="Multiple values may be separated by commas.")] = None,
1286
- shared_resources: Optional[StrictStr] = None,
1287
- shared_resources__in: Annotated[Optional[List[StrictStr]], Field(description="Multiple values may be separated by commas.")] = None,
1288
- started_at: Annotated[Optional[datetime], Field(description="Filter results where started_at matches value")] = None,
1289
- started_at__gt: Annotated[Optional[datetime], Field(description="Filter results where started_at is greater than value")] = None,
1290
- started_at__gte: Annotated[Optional[datetime], Field(description="Filter results where started_at is greater than or equal to value")] = None,
1291
- started_at__isnull: Annotated[Optional[StrictBool], Field(description="Filter results where started_at has a null value")] = None,
1292
- started_at__lt: Annotated[Optional[datetime], Field(description="Filter results where started_at is less than value")] = None,
1293
- started_at__lte: Annotated[Optional[datetime], Field(description="Filter results where started_at is less than or equal to value")] = None,
1294
- started_at__range: Annotated[Optional[List[datetime]], Field(description="Filter results where started_at is between two comma separated values")] = None,
1295
- state: Annotated[Optional[StrictStr], Field(description="Filter results where state matches value * `waiting` - Waiting * `skipped` - Skipped * `running` - Running * `completed` - Completed * `failed` - Failed * `canceled` - Canceled * `canceling` - Canceling")] = None,
1296
- state__in: Annotated[Optional[List[StrictStr]], Field(description="Filter results where state is in a comma-separated list of values")] = None,
1297
- state__ne: Annotated[Optional[StrictStr], Field(description="Filter results where state not equal to value")] = None,
1298
- task_group: Annotated[Optional[StrictStr], Field(description="Filter results where task_group matches value")] = None,
1299
- unblocked_at: Annotated[Optional[datetime], Field(description="Filter results where unblocked_at matches value")] = None,
1300
- unblocked_at__gt: Annotated[Optional[datetime], Field(description="Filter results where unblocked_at is greater than value")] = None,
1301
- unblocked_at__gte: Annotated[Optional[datetime], Field(description="Filter results where unblocked_at is greater than or equal to value")] = None,
1302
- unblocked_at__isnull: Annotated[Optional[StrictBool], Field(description="Filter results where unblocked_at has a null value")] = None,
1303
- unblocked_at__lt: Annotated[Optional[datetime], Field(description="Filter results where unblocked_at is less than value")] = None,
1304
- unblocked_at__lte: Annotated[Optional[datetime], Field(description="Filter results where unblocked_at is less than or equal to value")] = None,
1305
- unblocked_at__range: Annotated[Optional[List[datetime]], Field(description="Filter results where unblocked_at is between two comma separated values")] = None,
1306
- worker: Annotated[Optional[StrictStr], Field(description="Filter results where worker matches value")] = None,
1307
- worker__in: Annotated[Optional[List[StrictStr]], Field(description="Filter results where worker is in a comma-separated list of values")] = None,
1308
- worker__isnull: Annotated[Optional[StrictBool], Field(description="Filter results where worker has a null value")] = None,
1309
- fields: Annotated[Optional[List[StrictStr]], Field(description="A list of fields to include in the response.")] = None,
1310
- exclude_fields: Annotated[Optional[List[StrictStr]], Field(description="A list of fields to exclude from the response.")] = None,
1311
- pulp_domain: StrictStr = "default",
1312
- _request_timeout: Union[
1313
- None,
1314
- Annotated[StrictFloat, Field(gt=0)],
1315
- Tuple[
1316
- Annotated[StrictFloat, Field(gt=0)],
1317
- Annotated[StrictFloat, Field(gt=0)]
1318
- ]
1319
- ] = None,
1320
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
1321
- _content_type: Optional[StrictStr] = None,
1322
- _headers: Optional[Dict[StrictStr, Any]] = None,
1323
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1324
- ) -> RESTResponseType:
1325
- """List tasks
1326
-
1327
- 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.
1328
-
1329
- :param pulp_domain: (required)
1330
- :type pulp_domain: str
1331
- :param x_task_diagnostics: List of profilers to use on tasks.
1332
- :type x_task_diagnostics: List[str]
1333
- :param child_tasks: Filter results where child_tasks matches value
1334
- :type child_tasks: str
1335
- :param created_resources:
1336
- :type created_resources: str
1337
- :param exclusive_resources:
1338
- :type exclusive_resources: str
1339
- :param exclusive_resources__in: Multiple values may be separated by commas.
1340
- :type exclusive_resources__in: List[str]
1341
- :param finished_at: Filter results where finished_at matches value
1342
- :type finished_at: datetime
1343
- :param finished_at__gt: Filter results where finished_at is greater than value
1344
- :type finished_at__gt: datetime
1345
- :param finished_at__gte: Filter results where finished_at is greater than or equal to value
1346
- :type finished_at__gte: datetime
1347
- :param finished_at__isnull: Filter results where finished_at has a null value
1348
- :type finished_at__isnull: bool
1349
- :param finished_at__lt: Filter results where finished_at is less than value
1350
- :type finished_at__lt: datetime
1351
- :param finished_at__lte: Filter results where finished_at is less than or equal to value
1352
- :type finished_at__lte: datetime
1353
- :param finished_at__range: Filter results where finished_at is between two comma separated values
1354
- :type finished_at__range: List[datetime]
1355
- :param limit: Number of results to return per page.
1356
- :type limit: int
1357
- :param logging_cid: Filter results where logging_cid matches value
1358
- :type logging_cid: str
1359
- :param logging_cid__contains: Filter results where logging_cid contains value
1360
- :type logging_cid__contains: str
1361
- :param name: Filter results where name matches value
1362
- :type name: str
1363
- :param name__contains: Filter results where name contains value
1364
- :type name__contains: str
1365
- :param name__in: Filter results where name is in a comma-separated list of values
1366
- :type name__in: List[str]
1367
- :param name__ne: Filter results where name not equal to value
1368
- :type name__ne: str
1369
- :param offset: The initial index from which to return the results.
1370
- :type offset: int
1371
- :param ordering: 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) * `pk` - Pk * `-pk` - Pk (descending)
1372
- :type ordering: List[str]
1373
- :param parent_task: Filter results where parent_task matches value
1374
- :type parent_task: str
1375
- :param prn__in: Multiple values may be separated by commas.
1376
- :type prn__in: List[str]
1377
- :param pulp_created: Filter results where pulp_created matches value
1378
- :type pulp_created: datetime
1379
- :param pulp_created__gt: Filter results where pulp_created is greater than value
1380
- :type pulp_created__gt: datetime
1381
- :param pulp_created__gte: Filter results where pulp_created is greater than or equal to value
1382
- :type pulp_created__gte: datetime
1383
- :param pulp_created__isnull: Filter results where pulp_created has a null value
1384
- :type pulp_created__isnull: bool
1385
- :param pulp_created__lt: Filter results where pulp_created is less than value
1386
- :type pulp_created__lt: datetime
1387
- :param pulp_created__lte: Filter results where pulp_created is less than or equal to value
1388
- :type pulp_created__lte: datetime
1389
- :param pulp_created__range: Filter results where pulp_created is between two comma separated values
1390
- :type pulp_created__range: List[datetime]
1391
- :param pulp_href__in: Multiple values may be separated by commas.
1392
- :type pulp_href__in: List[str]
1393
- :param pulp_id__in: Multiple values may be separated by commas.
1394
- :type pulp_id__in: List[str]
1395
- :param q: Filter results by using NOT, AND and OR operations on other filters
1396
- :type q: str
1397
- :param reserved_resources:
1398
- :type reserved_resources: str
1399
- :param reserved_resources__in: Multiple values may be separated by commas.
1400
- :type reserved_resources__in: List[str]
1401
- :param shared_resources:
1402
- :type shared_resources: str
1403
- :param shared_resources__in: Multiple values may be separated by commas.
1404
- :type shared_resources__in: List[str]
1405
- :param started_at: Filter results where started_at matches value
1406
- :type started_at: datetime
1407
- :param started_at__gt: Filter results where started_at is greater than value
1408
- :type started_at__gt: datetime
1409
- :param started_at__gte: Filter results where started_at is greater than or equal to value
1410
- :type started_at__gte: datetime
1411
- :param started_at__isnull: Filter results where started_at has a null value
1412
- :type started_at__isnull: bool
1413
- :param started_at__lt: Filter results where started_at is less than value
1414
- :type started_at__lt: datetime
1415
- :param started_at__lte: Filter results where started_at is less than or equal to value
1416
- :type started_at__lte: datetime
1417
- :param started_at__range: Filter results where started_at is between two comma separated values
1418
- :type started_at__range: List[datetime]
1419
- :param state: Filter results where state matches value * `waiting` - Waiting * `skipped` - Skipped * `running` - Running * `completed` - Completed * `failed` - Failed * `canceled` - Canceled * `canceling` - Canceling
1420
- :type state: str
1421
- :param state__in: Filter results where state is in a comma-separated list of values
1422
- :type state__in: List[str]
1423
- :param state__ne: Filter results where state not equal to value
1424
- :type state__ne: str
1425
- :param task_group: Filter results where task_group matches value
1426
- :type task_group: str
1427
- :param unblocked_at: Filter results where unblocked_at matches value
1428
- :type unblocked_at: datetime
1429
- :param unblocked_at__gt: Filter results where unblocked_at is greater than value
1430
- :type unblocked_at__gt: datetime
1431
- :param unblocked_at__gte: Filter results where unblocked_at is greater than or equal to value
1432
- :type unblocked_at__gte: datetime
1433
- :param unblocked_at__isnull: Filter results where unblocked_at has a null value
1434
- :type unblocked_at__isnull: bool
1435
- :param unblocked_at__lt: Filter results where unblocked_at is less than value
1436
- :type unblocked_at__lt: datetime
1437
- :param unblocked_at__lte: Filter results where unblocked_at is less than or equal to value
1438
- :type unblocked_at__lte: datetime
1439
- :param unblocked_at__range: Filter results where unblocked_at is between two comma separated values
1440
- :type unblocked_at__range: List[datetime]
1441
- :param worker: Filter results where worker matches value
1442
- :type worker: str
1443
- :param worker__in: Filter results where worker is in a comma-separated list of values
1444
- :type worker__in: List[str]
1445
- :param worker__isnull: Filter results where worker has a null value
1446
- :type worker__isnull: bool
1447
- :param fields: A list of fields to include in the response.
1448
- :type fields: List[str]
1449
- :param exclude_fields: A list of fields to exclude from the response.
1450
- :type exclude_fields: List[str]
1451
- :param _request_timeout: timeout setting for this request. If one
1452
- number provided, it will be total request
1453
- timeout. It can also be a pair (tuple) of
1454
- (connection, read) timeouts.
1455
- :type _request_timeout: int, tuple(int, int), optional
1456
- :param _request_auth: set to override the auth_settings for an a single
1457
- request; this effectively ignores the
1458
- authentication in the spec for a single request.
1459
- :type _request_auth: dict, optional
1460
- :param _content_type: force content-type for the request.
1461
- :type _content_type: str, Optional
1462
- :param _headers: set to override the headers for a single
1463
- request; this effectively ignores the headers
1464
- in the spec for a single request.
1465
- :type _headers: dict, optional
1466
- :param _host_index: set to override the host_index for a single
1467
- request; this effectively ignores the host_index
1468
- in the spec for a single request.
1469
- :type _host_index: int, optional
1470
- :return: Returns the result object.
1471
- """ # noqa: E501
1472
-
1473
- _param = self._list_serialize(
1474
- pulp_domain=pulp_domain,
1475
- x_task_diagnostics=x_task_diagnostics,
1476
- child_tasks=child_tasks,
1477
- created_resources=created_resources,
1478
- exclusive_resources=exclusive_resources,
1479
- exclusive_resources__in=exclusive_resources__in,
1480
- finished_at=finished_at,
1481
- finished_at__gt=finished_at__gt,
1482
- finished_at__gte=finished_at__gte,
1483
- finished_at__isnull=finished_at__isnull,
1484
- finished_at__lt=finished_at__lt,
1485
- finished_at__lte=finished_at__lte,
1486
- finished_at__range=finished_at__range,
1487
- limit=limit,
1488
- logging_cid=logging_cid,
1489
- logging_cid__contains=logging_cid__contains,
1490
- name=name,
1491
- name__contains=name__contains,
1492
- name__in=name__in,
1493
- name__ne=name__ne,
1494
- offset=offset,
1495
- ordering=ordering,
1496
- parent_task=parent_task,
1497
- prn__in=prn__in,
1498
- pulp_created=pulp_created,
1499
- pulp_created__gt=pulp_created__gt,
1500
- pulp_created__gte=pulp_created__gte,
1501
- pulp_created__isnull=pulp_created__isnull,
1502
- pulp_created__lt=pulp_created__lt,
1503
- pulp_created__lte=pulp_created__lte,
1504
- pulp_created__range=pulp_created__range,
1505
- pulp_href__in=pulp_href__in,
1506
- pulp_id__in=pulp_id__in,
1507
- q=q,
1508
- reserved_resources=reserved_resources,
1509
- reserved_resources__in=reserved_resources__in,
1510
- shared_resources=shared_resources,
1511
- shared_resources__in=shared_resources__in,
1512
- started_at=started_at,
1513
- started_at__gt=started_at__gt,
1514
- started_at__gte=started_at__gte,
1515
- started_at__isnull=started_at__isnull,
1516
- started_at__lt=started_at__lt,
1517
- started_at__lte=started_at__lte,
1518
- started_at__range=started_at__range,
1519
- state=state,
1520
- state__in=state__in,
1521
- state__ne=state__ne,
1522
- task_group=task_group,
1523
- unblocked_at=unblocked_at,
1524
- unblocked_at__gt=unblocked_at__gt,
1525
- unblocked_at__gte=unblocked_at__gte,
1526
- unblocked_at__isnull=unblocked_at__isnull,
1527
- unblocked_at__lt=unblocked_at__lt,
1528
- unblocked_at__lte=unblocked_at__lte,
1529
- unblocked_at__range=unblocked_at__range,
1530
- worker=worker,
1531
- worker__in=worker__in,
1532
- worker__isnull=worker__isnull,
1533
- fields=fields,
1534
- exclude_fields=exclude_fields,
1535
- _request_auth=_request_auth,
1536
- _content_type=_content_type,
1537
- _headers=_headers,
1538
- _host_index=_host_index
1539
- )
1540
-
1541
- _response_types_map: Dict[str, Optional[str]] = {
1542
- '200': "PaginatedTaskResponseList",
1543
- }
1544
- response_data = self.api_client.call_api(
1545
- *_param,
1546
- _request_timeout=_request_timeout
1547
- )
1548
- return response_data.response
1549
-
1550
-
1551
- def _list_serialize(
1552
- self,
1553
- pulp_domain,
1554
- x_task_diagnostics,
1555
- child_tasks,
1556
- created_resources,
1557
- exclusive_resources,
1558
- exclusive_resources__in,
1559
- finished_at,
1560
- finished_at__gt,
1561
- finished_at__gte,
1562
- finished_at__isnull,
1563
- finished_at__lt,
1564
- finished_at__lte,
1565
- finished_at__range,
1566
- limit,
1567
- logging_cid,
1568
- logging_cid__contains,
1569
- name,
1570
- name__contains,
1571
- name__in,
1572
- name__ne,
1573
- offset,
1574
- ordering,
1575
- parent_task,
1576
- prn__in,
1577
- pulp_created,
1578
- pulp_created__gt,
1579
- pulp_created__gte,
1580
- pulp_created__isnull,
1581
- pulp_created__lt,
1582
- pulp_created__lte,
1583
- pulp_created__range,
1584
- pulp_href__in,
1585
- pulp_id__in,
1586
- q,
1587
- reserved_resources,
1588
- reserved_resources__in,
1589
- shared_resources,
1590
- shared_resources__in,
1591
- started_at,
1592
- started_at__gt,
1593
- started_at__gte,
1594
- started_at__isnull,
1595
- started_at__lt,
1596
- started_at__lte,
1597
- started_at__range,
1598
- state,
1599
- state__in,
1600
- state__ne,
1601
- task_group,
1602
- unblocked_at,
1603
- unblocked_at__gt,
1604
- unblocked_at__gte,
1605
- unblocked_at__isnull,
1606
- unblocked_at__lt,
1607
- unblocked_at__lte,
1608
- unblocked_at__range,
1609
- worker,
1610
- worker__in,
1611
- worker__isnull,
1612
- fields,
1613
- exclude_fields,
1614
- _request_auth,
1615
- _content_type,
1616
- _headers,
1617
- _host_index,
1618
- ) -> RequestSerialized:
1619
-
1620
- _host = None
1621
-
1622
- _collection_formats: Dict[str, str] = {
1623
- 'X-Task-Diagnostics': 'csv',
1624
- 'exclusive_resources__in': 'csv',
1625
- 'finished_at__range': 'csv',
1626
- 'name__in': 'csv',
1627
- 'ordering': 'csv',
1628
- 'prn__in': 'csv',
1629
- 'pulp_created__range': 'csv',
1630
- 'pulp_href__in': 'csv',
1631
- 'pulp_id__in': 'csv',
1632
- 'reserved_resources__in': 'csv',
1633
- 'shared_resources__in': 'csv',
1634
- 'started_at__range': 'csv',
1635
- 'state__in': 'csv',
1636
- 'unblocked_at__range': 'csv',
1637
- 'worker__in': 'csv',
1638
- 'fields': 'multi',
1639
- 'exclude_fields': 'multi',
1640
- }
1641
-
1642
- _path_params: Dict[str, str] = {}
1643
- _query_params: List[Tuple[str, str]] = []
1644
- _header_params: Dict[str, Optional[str]] = _headers or {}
1645
- _form_params: List[Tuple[str, str]] = []
1646
- _files: Dict[
1647
- str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1648
- ] = {}
1649
- _body_params: Optional[bytes] = None
1650
-
1651
- # process the path parameters
1652
- if pulp_domain is not None:
1653
- _path_params['pulp_domain'] = pulp_domain
1654
- # process the query parameters
1655
- if child_tasks is not None:
1656
-
1657
- _query_params.append(('child_tasks', child_tasks))
1658
-
1659
- if created_resources is not None:
1660
-
1661
- _query_params.append(('created_resources', created_resources))
1662
-
1663
- if exclusive_resources is not None:
1664
-
1665
- _query_params.append(('exclusive_resources', exclusive_resources))
1666
-
1667
- if exclusive_resources__in is not None:
1668
-
1669
- _query_params.append(('exclusive_resources__in', exclusive_resources__in))
1670
-
1671
- if finished_at is not None:
1672
- if isinstance(finished_at, datetime):
1673
- _query_params.append(
1674
- (
1675
- 'finished_at',
1676
- finished_at.strftime(
1677
- self.api_client.configuration.datetime_format
1678
- )
1679
- )
1680
- )
1681
- else:
1682
- _query_params.append(('finished_at', finished_at))
1683
-
1684
- if finished_at__gt is not None:
1685
- if isinstance(finished_at__gt, datetime):
1686
- _query_params.append(
1687
- (
1688
- 'finished_at__gt',
1689
- finished_at__gt.strftime(
1690
- self.api_client.configuration.datetime_format
1691
- )
1692
- )
1693
- )
1694
- else:
1695
- _query_params.append(('finished_at__gt', finished_at__gt))
1696
-
1697
- if finished_at__gte is not None:
1698
- if isinstance(finished_at__gte, datetime):
1699
- _query_params.append(
1700
- (
1701
- 'finished_at__gte',
1702
- finished_at__gte.strftime(
1703
- self.api_client.configuration.datetime_format
1704
- )
1705
- )
1706
- )
1707
- else:
1708
- _query_params.append(('finished_at__gte', finished_at__gte))
1709
-
1710
- if finished_at__isnull is not None:
1711
-
1712
- _query_params.append(('finished_at__isnull', finished_at__isnull))
1713
-
1714
- if finished_at__lt is not None:
1715
- if isinstance(finished_at__lt, datetime):
1716
- _query_params.append(
1717
- (
1718
- 'finished_at__lt',
1719
- finished_at__lt.strftime(
1720
- self.api_client.configuration.datetime_format
1721
- )
1722
- )
1723
- )
1724
- else:
1725
- _query_params.append(('finished_at__lt', finished_at__lt))
1726
-
1727
- if finished_at__lte is not None:
1728
- if isinstance(finished_at__lte, datetime):
1729
- _query_params.append(
1730
- (
1731
- 'finished_at__lte',
1732
- finished_at__lte.strftime(
1733
- self.api_client.configuration.datetime_format
1734
- )
1735
- )
1736
- )
1737
- else:
1738
- _query_params.append(('finished_at__lte', finished_at__lte))
1739
-
1740
- if finished_at__range is not None:
1741
-
1742
- _query_params.append(('finished_at__range', finished_at__range))
1743
-
1744
- if limit is not None:
1745
-
1746
- _query_params.append(('limit', limit))
1747
-
1748
- if logging_cid is not None:
1749
-
1750
- _query_params.append(('logging_cid', logging_cid))
1751
-
1752
- if logging_cid__contains is not None:
1753
-
1754
- _query_params.append(('logging_cid__contains', logging_cid__contains))
1755
-
1756
- if name is not None:
1757
-
1758
- _query_params.append(('name', name))
1759
-
1760
- if name__contains is not None:
1761
-
1762
- _query_params.append(('name__contains', name__contains))
1763
-
1764
- if name__in is not None:
1765
-
1766
- _query_params.append(('name__in', name__in))
1767
-
1768
- if name__ne is not None:
1769
-
1770
- _query_params.append(('name__ne', name__ne))
1771
-
1772
- if offset is not None:
1773
-
1774
- _query_params.append(('offset', offset))
1775
-
1776
- if ordering is not None:
1777
-
1778
- _query_params.append(('ordering', ordering))
1779
-
1780
- if parent_task is not None:
1781
-
1782
- _query_params.append(('parent_task', parent_task))
1783
-
1784
- if prn__in is not None:
1785
-
1786
- _query_params.append(('prn__in', prn__in))
1787
-
1788
- if pulp_created is not None:
1789
- if isinstance(pulp_created, datetime):
1790
- _query_params.append(
1791
- (
1792
- 'pulp_created',
1793
- pulp_created.strftime(
1794
- self.api_client.configuration.datetime_format
1795
- )
1796
- )
1797
- )
1798
- else:
1799
- _query_params.append(('pulp_created', pulp_created))
1800
-
1801
- if pulp_created__gt is not None:
1802
- if isinstance(pulp_created__gt, datetime):
1803
- _query_params.append(
1804
- (
1805
- 'pulp_created__gt',
1806
- pulp_created__gt.strftime(
1807
- self.api_client.configuration.datetime_format
1808
- )
1809
- )
1810
- )
1811
- else:
1812
- _query_params.append(('pulp_created__gt', pulp_created__gt))
1813
-
1814
- if pulp_created__gte is not None:
1815
- if isinstance(pulp_created__gte, datetime):
1816
- _query_params.append(
1817
- (
1818
- 'pulp_created__gte',
1819
- pulp_created__gte.strftime(
1820
- self.api_client.configuration.datetime_format
1821
- )
1822
- )
1823
- )
1824
- else:
1825
- _query_params.append(('pulp_created__gte', pulp_created__gte))
1826
-
1827
- if pulp_created__isnull is not None:
1828
-
1829
- _query_params.append(('pulp_created__isnull', pulp_created__isnull))
1830
-
1831
- if pulp_created__lt is not None:
1832
- if isinstance(pulp_created__lt, datetime):
1833
- _query_params.append(
1834
- (
1835
- 'pulp_created__lt',
1836
- pulp_created__lt.strftime(
1837
- self.api_client.configuration.datetime_format
1838
- )
1839
- )
1840
- )
1841
- else:
1842
- _query_params.append(('pulp_created__lt', pulp_created__lt))
1843
-
1844
- if pulp_created__lte is not None:
1845
- if isinstance(pulp_created__lte, datetime):
1846
- _query_params.append(
1847
- (
1848
- 'pulp_created__lte',
1849
- pulp_created__lte.strftime(
1850
- self.api_client.configuration.datetime_format
1851
- )
1852
- )
1853
- )
1854
- else:
1855
- _query_params.append(('pulp_created__lte', pulp_created__lte))
1856
-
1857
- if pulp_created__range is not None:
1858
-
1859
- _query_params.append(('pulp_created__range', pulp_created__range))
1860
-
1861
- if pulp_href__in is not None:
1862
-
1863
- _query_params.append(('pulp_href__in', pulp_href__in))
1864
-
1865
- if pulp_id__in is not None:
1866
-
1867
- _query_params.append(('pulp_id__in', pulp_id__in))
1868
-
1869
- if q is not None:
1870
-
1871
- _query_params.append(('q', q))
1872
-
1873
- if reserved_resources is not None:
1874
-
1875
- _query_params.append(('reserved_resources', reserved_resources))
1876
-
1877
- if reserved_resources__in is not None:
1878
-
1879
- _query_params.append(('reserved_resources__in', reserved_resources__in))
1880
-
1881
- if shared_resources is not None:
1882
-
1883
- _query_params.append(('shared_resources', shared_resources))
1884
-
1885
- if shared_resources__in is not None:
1886
-
1887
- _query_params.append(('shared_resources__in', shared_resources__in))
1888
-
1889
- if started_at is not None:
1890
- if isinstance(started_at, datetime):
1891
- _query_params.append(
1892
- (
1893
- 'started_at',
1894
- started_at.strftime(
1895
- self.api_client.configuration.datetime_format
1896
- )
1897
- )
1898
- )
1899
- else:
1900
- _query_params.append(('started_at', started_at))
1901
-
1902
- if started_at__gt is not None:
1903
- if isinstance(started_at__gt, datetime):
1904
- _query_params.append(
1905
- (
1906
- 'started_at__gt',
1907
- started_at__gt.strftime(
1908
- self.api_client.configuration.datetime_format
1909
- )
1910
- )
1911
- )
1912
- else:
1913
- _query_params.append(('started_at__gt', started_at__gt))
1914
-
1915
- if started_at__gte is not None:
1916
- if isinstance(started_at__gte, datetime):
1917
- _query_params.append(
1918
- (
1919
- 'started_at__gte',
1920
- started_at__gte.strftime(
1921
- self.api_client.configuration.datetime_format
1922
- )
1923
- )
1924
- )
1925
- else:
1926
- _query_params.append(('started_at__gte', started_at__gte))
1927
-
1928
- if started_at__isnull is not None:
1929
-
1930
- _query_params.append(('started_at__isnull', started_at__isnull))
1931
-
1932
- if started_at__lt is not None:
1933
- if isinstance(started_at__lt, datetime):
1934
- _query_params.append(
1935
- (
1936
- 'started_at__lt',
1937
- started_at__lt.strftime(
1938
- self.api_client.configuration.datetime_format
1939
- )
1940
- )
1941
- )
1942
- else:
1943
- _query_params.append(('started_at__lt', started_at__lt))
1944
-
1945
- if started_at__lte is not None:
1946
- if isinstance(started_at__lte, datetime):
1947
- _query_params.append(
1948
- (
1949
- 'started_at__lte',
1950
- started_at__lte.strftime(
1951
- self.api_client.configuration.datetime_format
1952
- )
1953
- )
1954
- )
1955
- else:
1956
- _query_params.append(('started_at__lte', started_at__lte))
1957
-
1958
- if started_at__range is not None:
1959
-
1960
- _query_params.append(('started_at__range', started_at__range))
1961
-
1962
- if state is not None:
1963
-
1964
- _query_params.append(('state', state))
1965
-
1966
- if state__in is not None:
1967
-
1968
- _query_params.append(('state__in', state__in))
1969
-
1970
- if state__ne is not None:
1971
-
1972
- _query_params.append(('state__ne', state__ne))
1973
-
1974
- if task_group is not None:
1975
-
1976
- _query_params.append(('task_group', task_group))
1977
-
1978
- if unblocked_at is not None:
1979
- if isinstance(unblocked_at, datetime):
1980
- _query_params.append(
1981
- (
1982
- 'unblocked_at',
1983
- unblocked_at.strftime(
1984
- self.api_client.configuration.datetime_format
1985
- )
1986
- )
1987
- )
1988
- else:
1989
- _query_params.append(('unblocked_at', unblocked_at))
1990
-
1991
- if unblocked_at__gt is not None:
1992
- if isinstance(unblocked_at__gt, datetime):
1993
- _query_params.append(
1994
- (
1995
- 'unblocked_at__gt',
1996
- unblocked_at__gt.strftime(
1997
- self.api_client.configuration.datetime_format
1998
- )
1999
- )
2000
- )
2001
- else:
2002
- _query_params.append(('unblocked_at__gt', unblocked_at__gt))
2003
-
2004
- if unblocked_at__gte is not None:
2005
- if isinstance(unblocked_at__gte, datetime):
2006
- _query_params.append(
2007
- (
2008
- 'unblocked_at__gte',
2009
- unblocked_at__gte.strftime(
2010
- self.api_client.configuration.datetime_format
2011
- )
2012
- )
2013
- )
2014
- else:
2015
- _query_params.append(('unblocked_at__gte', unblocked_at__gte))
2016
-
2017
- if unblocked_at__isnull is not None:
2018
-
2019
- _query_params.append(('unblocked_at__isnull', unblocked_at__isnull))
2020
-
2021
- if unblocked_at__lt is not None:
2022
- if isinstance(unblocked_at__lt, datetime):
2023
- _query_params.append(
2024
- (
2025
- 'unblocked_at__lt',
2026
- unblocked_at__lt.strftime(
2027
- self.api_client.configuration.datetime_format
2028
- )
2029
- )
2030
- )
2031
- else:
2032
- _query_params.append(('unblocked_at__lt', unblocked_at__lt))
2033
-
2034
- if unblocked_at__lte is not None:
2035
- if isinstance(unblocked_at__lte, datetime):
2036
- _query_params.append(
2037
- (
2038
- 'unblocked_at__lte',
2039
- unblocked_at__lte.strftime(
2040
- self.api_client.configuration.datetime_format
2041
- )
2042
- )
2043
- )
2044
- else:
2045
- _query_params.append(('unblocked_at__lte', unblocked_at__lte))
2046
-
2047
- if unblocked_at__range is not None:
2048
-
2049
- _query_params.append(('unblocked_at__range', unblocked_at__range))
2050
-
2051
- if worker is not None:
2052
-
2053
- _query_params.append(('worker', worker))
2054
-
2055
- if worker__in is not None:
2056
-
2057
- _query_params.append(('worker__in', worker__in))
2058
-
2059
- if worker__isnull is not None:
2060
-
2061
- _query_params.append(('worker__isnull', worker__isnull))
2062
-
2063
- if fields is not None:
2064
-
2065
- _query_params.append(('fields', fields))
2066
-
2067
- if exclude_fields is not None:
2068
-
2069
- _query_params.append(('exclude_fields', exclude_fields))
2070
-
2071
- # process the header parameters
2072
- if x_task_diagnostics is not None:
2073
- _header_params['X-Task-Diagnostics'] = x_task_diagnostics
2074
- # process the form parameters
2075
- # process the body parameter
2076
-
2077
-
2078
- # set the HTTP header `Accept`
2079
- if 'Accept' not in _header_params:
2080
- _header_params['Accept'] = self.api_client.select_header_accept(
2081
- [
2082
- 'application/json'
2083
- ]
2084
- )
2085
-
2086
-
2087
- # authentication setting
2088
- _auth_settings: List[str] = [
2089
- 'json_header_remote_authentication',
2090
- 'basicAuth',
2091
- 'cookieAuth'
2092
- ]
2093
-
2094
- return self.api_client.param_serialize(
2095
- method='GET',
2096
- resource_path='/api/pulp/{pulp_domain}/api/v3/tasks/',
2097
- path_params=_path_params,
2098
- query_params=_query_params,
2099
- header_params=_header_params,
2100
- body=_body_params,
2101
- post_params=_form_params,
2102
- files=_files,
2103
- auth_settings=_auth_settings,
2104
- collection_formats=_collection_formats,
2105
- _host=_host,
2106
- _request_auth=_request_auth
2107
- )
2108
-
2109
-
2110
-
2111
-
2112
- @validate_call
2113
- def list_roles(
2114
- self,
2115
- task_href: StrictStr,
2116
- x_task_diagnostics: Annotated[Optional[List[StrictStr]], Field(description="List of profilers to use on tasks.")] = None,
2117
- fields: Annotated[Optional[List[StrictStr]], Field(description="A list of fields to include in the response.")] = None,
2118
- exclude_fields: Annotated[Optional[List[StrictStr]], Field(description="A list of fields to exclude from the response.")] = None,
2119
- _request_timeout: Union[
2120
- None,
2121
- Annotated[StrictFloat, Field(gt=0)],
2122
- Tuple[
2123
- Annotated[StrictFloat, Field(gt=0)],
2124
- Annotated[StrictFloat, Field(gt=0)]
2125
- ]
2126
- ] = None,
2127
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
2128
- _content_type: Optional[StrictStr] = None,
2129
- _headers: Optional[Dict[StrictStr, Any]] = None,
2130
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2131
- ) -> ObjectRolesResponse:
2132
- """List roles
2133
-
2134
- List roles assigned to this object.
2135
-
2136
- :param task_href: (required)
2137
- :type task_href: str
2138
- :param x_task_diagnostics: List of profilers to use on tasks.
2139
- :type x_task_diagnostics: List[str]
2140
- :param fields: A list of fields to include in the response.
2141
- :type fields: List[str]
2142
- :param exclude_fields: A list of fields to exclude from the response.
2143
- :type exclude_fields: List[str]
2144
- :param _request_timeout: timeout setting for this request. If one
2145
- number provided, it will be total request
2146
- timeout. It can also be a pair (tuple) of
2147
- (connection, read) timeouts.
2148
- :type _request_timeout: int, tuple(int, int), optional
2149
- :param _request_auth: set to override the auth_settings for an a single
2150
- request; this effectively ignores the
2151
- authentication in the spec for a single request.
2152
- :type _request_auth: dict, optional
2153
- :param _content_type: force content-type for the request.
2154
- :type _content_type: str, Optional
2155
- :param _headers: set to override the headers for a single
2156
- request; this effectively ignores the headers
2157
- in the spec for a single request.
2158
- :type _headers: dict, optional
2159
- :param _host_index: set to override the host_index for a single
2160
- request; this effectively ignores the host_index
2161
- in the spec for a single request.
2162
- :type _host_index: int, optional
2163
- :return: Returns the result object.
2164
- """ # noqa: E501
2165
-
2166
- _param = self._list_roles_serialize(
2167
- task_href=task_href,
2168
- x_task_diagnostics=x_task_diagnostics,
2169
- fields=fields,
2170
- exclude_fields=exclude_fields,
2171
- _request_auth=_request_auth,
2172
- _content_type=_content_type,
2173
- _headers=_headers,
2174
- _host_index=_host_index
2175
- )
2176
-
2177
- _response_types_map: Dict[str, Optional[str]] = {
2178
- '200': "ObjectRolesResponse",
2179
- }
2180
- response_data = self.api_client.call_api(
2181
- *_param,
2182
- _request_timeout=_request_timeout
2183
- )
2184
- response_data.read()
2185
- return self.api_client.response_deserialize(
2186
- response_data=response_data,
2187
- response_types_map=_response_types_map,
2188
- ).data
2189
-
2190
-
2191
- @validate_call
2192
- def list_roles_with_http_info(
2193
- self,
2194
- task_href: StrictStr,
2195
- x_task_diagnostics: Annotated[Optional[List[StrictStr]], Field(description="List of profilers to use on tasks.")] = None,
2196
- fields: Annotated[Optional[List[StrictStr]], Field(description="A list of fields to include in the response.")] = None,
2197
- exclude_fields: Annotated[Optional[List[StrictStr]], Field(description="A list of fields to exclude from the response.")] = None,
2198
- _request_timeout: Union[
2199
- None,
2200
- Annotated[StrictFloat, Field(gt=0)],
2201
- Tuple[
2202
- Annotated[StrictFloat, Field(gt=0)],
2203
- Annotated[StrictFloat, Field(gt=0)]
2204
- ]
2205
- ] = None,
2206
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
2207
- _content_type: Optional[StrictStr] = None,
2208
- _headers: Optional[Dict[StrictStr, Any]] = None,
2209
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2210
- ) -> ApiResponse[ObjectRolesResponse]:
2211
- """List roles
2212
-
2213
- List roles assigned to this object.
2214
-
2215
- :param task_href: (required)
2216
- :type task_href: str
2217
- :param x_task_diagnostics: List of profilers to use on tasks.
2218
- :type x_task_diagnostics: List[str]
2219
- :param fields: A list of fields to include in the response.
2220
- :type fields: List[str]
2221
- :param exclude_fields: A list of fields to exclude from the response.
2222
- :type exclude_fields: List[str]
2223
- :param _request_timeout: timeout setting for this request. If one
2224
- number provided, it will be total request
2225
- timeout. It can also be a pair (tuple) of
2226
- (connection, read) timeouts.
2227
- :type _request_timeout: int, tuple(int, int), optional
2228
- :param _request_auth: set to override the auth_settings for an a single
2229
- request; this effectively ignores the
2230
- authentication in the spec for a single request.
2231
- :type _request_auth: dict, optional
2232
- :param _content_type: force content-type for the request.
2233
- :type _content_type: str, Optional
2234
- :param _headers: set to override the headers for a single
2235
- request; this effectively ignores the headers
2236
- in the spec for a single request.
2237
- :type _headers: dict, optional
2238
- :param _host_index: set to override the host_index for a single
2239
- request; this effectively ignores the host_index
2240
- in the spec for a single request.
2241
- :type _host_index: int, optional
2242
- :return: Returns the result object.
2243
- """ # noqa: E501
2244
-
2245
- _param = self._list_roles_serialize(
2246
- task_href=task_href,
2247
- x_task_diagnostics=x_task_diagnostics,
2248
- fields=fields,
2249
- exclude_fields=exclude_fields,
2250
- _request_auth=_request_auth,
2251
- _content_type=_content_type,
2252
- _headers=_headers,
2253
- _host_index=_host_index
2254
- )
2255
-
2256
- _response_types_map: Dict[str, Optional[str]] = {
2257
- '200': "ObjectRolesResponse",
2258
- }
2259
- response_data = self.api_client.call_api(
2260
- *_param,
2261
- _request_timeout=_request_timeout
2262
- )
2263
- response_data.read()
2264
- return self.api_client.response_deserialize(
2265
- response_data=response_data,
2266
- response_types_map=_response_types_map,
2267
- )
2268
-
2269
-
2270
- @validate_call
2271
- def list_roles_without_preload_content(
2272
- self,
2273
- task_href: StrictStr,
2274
- x_task_diagnostics: Annotated[Optional[List[StrictStr]], Field(description="List of profilers to use on tasks.")] = None,
2275
- fields: Annotated[Optional[List[StrictStr]], Field(description="A list of fields to include in the response.")] = None,
2276
- exclude_fields: Annotated[Optional[List[StrictStr]], Field(description="A list of fields to exclude from the response.")] = None,
2277
- _request_timeout: Union[
2278
- None,
2279
- Annotated[StrictFloat, Field(gt=0)],
2280
- Tuple[
2281
- Annotated[StrictFloat, Field(gt=0)],
2282
- Annotated[StrictFloat, Field(gt=0)]
2283
- ]
2284
- ] = None,
2285
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
2286
- _content_type: Optional[StrictStr] = None,
2287
- _headers: Optional[Dict[StrictStr, Any]] = None,
2288
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2289
- ) -> RESTResponseType:
2290
- """List roles
2291
-
2292
- List roles assigned to this object.
2293
-
2294
- :param task_href: (required)
2295
- :type task_href: str
2296
- :param x_task_diagnostics: List of profilers to use on tasks.
2297
- :type x_task_diagnostics: List[str]
2298
- :param fields: A list of fields to include in the response.
2299
- :type fields: List[str]
2300
- :param exclude_fields: A list of fields to exclude from the response.
2301
- :type exclude_fields: List[str]
2302
- :param _request_timeout: timeout setting for this request. If one
2303
- number provided, it will be total request
2304
- timeout. It can also be a pair (tuple) of
2305
- (connection, read) timeouts.
2306
- :type _request_timeout: int, tuple(int, int), optional
2307
- :param _request_auth: set to override the auth_settings for an a single
2308
- request; this effectively ignores the
2309
- authentication in the spec for a single request.
2310
- :type _request_auth: dict, optional
2311
- :param _content_type: force content-type for the request.
2312
- :type _content_type: str, Optional
2313
- :param _headers: set to override the headers for a single
2314
- request; this effectively ignores the headers
2315
- in the spec for a single request.
2316
- :type _headers: dict, optional
2317
- :param _host_index: set to override the host_index for a single
2318
- request; this effectively ignores the host_index
2319
- in the spec for a single request.
2320
- :type _host_index: int, optional
2321
- :return: Returns the result object.
2322
- """ # noqa: E501
2323
-
2324
- _param = self._list_roles_serialize(
2325
- task_href=task_href,
2326
- x_task_diagnostics=x_task_diagnostics,
2327
- fields=fields,
2328
- exclude_fields=exclude_fields,
2329
- _request_auth=_request_auth,
2330
- _content_type=_content_type,
2331
- _headers=_headers,
2332
- _host_index=_host_index
2333
- )
2334
-
2335
- _response_types_map: Dict[str, Optional[str]] = {
2336
- '200': "ObjectRolesResponse",
2337
- }
2338
- response_data = self.api_client.call_api(
2339
- *_param,
2340
- _request_timeout=_request_timeout
2341
- )
2342
- return response_data.response
2343
-
2344
-
2345
- def _list_roles_serialize(
2346
- self,
2347
- task_href,
2348
- x_task_diagnostics,
2349
- fields,
2350
- exclude_fields,
2351
- _request_auth,
2352
- _content_type,
2353
- _headers,
2354
- _host_index,
2355
- ) -> RequestSerialized:
2356
-
2357
- _host = None
2358
-
2359
- _collection_formats: Dict[str, str] = {
2360
- 'X-Task-Diagnostics': 'csv',
2361
- 'fields': 'multi',
2362
- 'exclude_fields': 'multi',
2363
- }
2364
-
2365
- _path_params: Dict[str, str] = {}
2366
- _query_params: List[Tuple[str, str]] = []
2367
- _header_params: Dict[str, Optional[str]] = _headers or {}
2368
- _form_params: List[Tuple[str, str]] = []
2369
- _files: Dict[
2370
- str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
2371
- ] = {}
2372
- _body_params: Optional[bytes] = None
2373
-
2374
- # process the path parameters
2375
- if task_href is not None:
2376
- _path_params['task_href'] = task_href
2377
- # process the query parameters
2378
- if fields is not None:
2379
-
2380
- _query_params.append(('fields', fields))
2381
-
2382
- if exclude_fields is not None:
2383
-
2384
- _query_params.append(('exclude_fields', exclude_fields))
2385
-
2386
- # process the header parameters
2387
- if x_task_diagnostics is not None:
2388
- _header_params['X-Task-Diagnostics'] = x_task_diagnostics
2389
- # process the form parameters
2390
- # process the body parameter
2391
-
2392
-
2393
- # set the HTTP header `Accept`
2394
- if 'Accept' not in _header_params:
2395
- _header_params['Accept'] = self.api_client.select_header_accept(
2396
- [
2397
- 'application/json'
2398
- ]
2399
- )
2400
-
2401
-
2402
- # authentication setting
2403
- _auth_settings: List[str] = [
2404
- 'json_header_remote_authentication',
2405
- 'basicAuth',
2406
- 'cookieAuth'
2407
- ]
2408
-
2409
- return self.api_client.param_serialize(
2410
- method='GET',
2411
- resource_path='{task_href}list_roles/',
2412
- path_params=_path_params,
2413
- query_params=_query_params,
2414
- header_params=_header_params,
2415
- body=_body_params,
2416
- post_params=_form_params,
2417
- files=_files,
2418
- auth_settings=_auth_settings,
2419
- collection_formats=_collection_formats,
2420
- _host=_host,
2421
- _request_auth=_request_auth
2422
- )
2423
-
2424
-
2425
-
2426
-
2427
- @validate_call
2428
- def my_permissions(
2429
- self,
2430
- task_href: StrictStr,
2431
- x_task_diagnostics: Annotated[Optional[List[StrictStr]], Field(description="List of profilers to use on tasks.")] = None,
2432
- fields: Annotated[Optional[List[StrictStr]], Field(description="A list of fields to include in the response.")] = None,
2433
- exclude_fields: Annotated[Optional[List[StrictStr]], Field(description="A list of fields to exclude from the response.")] = None,
2434
- _request_timeout: Union[
2435
- None,
2436
- Annotated[StrictFloat, Field(gt=0)],
2437
- Tuple[
2438
- Annotated[StrictFloat, Field(gt=0)],
2439
- Annotated[StrictFloat, Field(gt=0)]
2440
- ]
2441
- ] = None,
2442
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
2443
- _content_type: Optional[StrictStr] = None,
2444
- _headers: Optional[Dict[StrictStr, Any]] = None,
2445
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2446
- ) -> MyPermissionsResponse:
2447
- """List user permissions
2448
-
2449
- List permissions available to the current user on this object.
2450
-
2451
- :param task_href: (required)
2452
- :type task_href: str
2453
- :param x_task_diagnostics: List of profilers to use on tasks.
2454
- :type x_task_diagnostics: List[str]
2455
- :param fields: A list of fields to include in the response.
2456
- :type fields: List[str]
2457
- :param exclude_fields: A list of fields to exclude from the response.
2458
- :type exclude_fields: List[str]
2459
- :param _request_timeout: timeout setting for this request. If one
2460
- number provided, it will be total request
2461
- timeout. It can also be a pair (tuple) of
2462
- (connection, read) timeouts.
2463
- :type _request_timeout: int, tuple(int, int), optional
2464
- :param _request_auth: set to override the auth_settings for an a single
2465
- request; this effectively ignores the
2466
- authentication in the spec for a single request.
2467
- :type _request_auth: dict, optional
2468
- :param _content_type: force content-type for the request.
2469
- :type _content_type: str, Optional
2470
- :param _headers: set to override the headers for a single
2471
- request; this effectively ignores the headers
2472
- in the spec for a single request.
2473
- :type _headers: dict, optional
2474
- :param _host_index: set to override the host_index for a single
2475
- request; this effectively ignores the host_index
2476
- in the spec for a single request.
2477
- :type _host_index: int, optional
2478
- :return: Returns the result object.
2479
- """ # noqa: E501
2480
-
2481
- _param = self._my_permissions_serialize(
2482
- task_href=task_href,
2483
- x_task_diagnostics=x_task_diagnostics,
2484
- fields=fields,
2485
- exclude_fields=exclude_fields,
2486
- _request_auth=_request_auth,
2487
- _content_type=_content_type,
2488
- _headers=_headers,
2489
- _host_index=_host_index
2490
- )
2491
-
2492
- _response_types_map: Dict[str, Optional[str]] = {
2493
- '200': "MyPermissionsResponse",
2494
- }
2495
- response_data = self.api_client.call_api(
2496
- *_param,
2497
- _request_timeout=_request_timeout
2498
- )
2499
- response_data.read()
2500
- return self.api_client.response_deserialize(
2501
- response_data=response_data,
2502
- response_types_map=_response_types_map,
2503
- ).data
2504
-
2505
-
2506
- @validate_call
2507
- def my_permissions_with_http_info(
2508
- self,
2509
- task_href: StrictStr,
2510
- x_task_diagnostics: Annotated[Optional[List[StrictStr]], Field(description="List of profilers to use on tasks.")] = None,
2511
- fields: Annotated[Optional[List[StrictStr]], Field(description="A list of fields to include in the response.")] = None,
2512
- exclude_fields: Annotated[Optional[List[StrictStr]], Field(description="A list of fields to exclude from the response.")] = None,
2513
- _request_timeout: Union[
2514
- None,
2515
- Annotated[StrictFloat, Field(gt=0)],
2516
- Tuple[
2517
- Annotated[StrictFloat, Field(gt=0)],
2518
- Annotated[StrictFloat, Field(gt=0)]
2519
- ]
2520
- ] = None,
2521
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
2522
- _content_type: Optional[StrictStr] = None,
2523
- _headers: Optional[Dict[StrictStr, Any]] = None,
2524
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2525
- ) -> ApiResponse[MyPermissionsResponse]:
2526
- """List user permissions
2527
-
2528
- List permissions available to the current user on this object.
2529
-
2530
- :param task_href: (required)
2531
- :type task_href: str
2532
- :param x_task_diagnostics: List of profilers to use on tasks.
2533
- :type x_task_diagnostics: List[str]
2534
- :param fields: A list of fields to include in the response.
2535
- :type fields: List[str]
2536
- :param exclude_fields: A list of fields to exclude from the response.
2537
- :type exclude_fields: List[str]
2538
- :param _request_timeout: timeout setting for this request. If one
2539
- number provided, it will be total request
2540
- timeout. It can also be a pair (tuple) of
2541
- (connection, read) timeouts.
2542
- :type _request_timeout: int, tuple(int, int), optional
2543
- :param _request_auth: set to override the auth_settings for an a single
2544
- request; this effectively ignores the
2545
- authentication in the spec for a single request.
2546
- :type _request_auth: dict, optional
2547
- :param _content_type: force content-type for the request.
2548
- :type _content_type: str, Optional
2549
- :param _headers: set to override the headers for a single
2550
- request; this effectively ignores the headers
2551
- in the spec for a single request.
2552
- :type _headers: dict, optional
2553
- :param _host_index: set to override the host_index for a single
2554
- request; this effectively ignores the host_index
2555
- in the spec for a single request.
2556
- :type _host_index: int, optional
2557
- :return: Returns the result object.
2558
- """ # noqa: E501
2559
-
2560
- _param = self._my_permissions_serialize(
2561
- task_href=task_href,
2562
- x_task_diagnostics=x_task_diagnostics,
2563
- fields=fields,
2564
- exclude_fields=exclude_fields,
2565
- _request_auth=_request_auth,
2566
- _content_type=_content_type,
2567
- _headers=_headers,
2568
- _host_index=_host_index
2569
- )
2570
-
2571
- _response_types_map: Dict[str, Optional[str]] = {
2572
- '200': "MyPermissionsResponse",
2573
- }
2574
- response_data = self.api_client.call_api(
2575
- *_param,
2576
- _request_timeout=_request_timeout
2577
- )
2578
- response_data.read()
2579
- return self.api_client.response_deserialize(
2580
- response_data=response_data,
2581
- response_types_map=_response_types_map,
2582
- )
2583
-
2584
-
2585
- @validate_call
2586
- def my_permissions_without_preload_content(
2587
- self,
2588
- task_href: StrictStr,
2589
- x_task_diagnostics: Annotated[Optional[List[StrictStr]], Field(description="List of profilers to use on tasks.")] = None,
2590
- fields: Annotated[Optional[List[StrictStr]], Field(description="A list of fields to include in the response.")] = None,
2591
- exclude_fields: Annotated[Optional[List[StrictStr]], Field(description="A list of fields to exclude from the response.")] = None,
2592
- _request_timeout: Union[
2593
- None,
2594
- Annotated[StrictFloat, Field(gt=0)],
2595
- Tuple[
2596
- Annotated[StrictFloat, Field(gt=0)],
2597
- Annotated[StrictFloat, Field(gt=0)]
2598
- ]
2599
- ] = None,
2600
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
2601
- _content_type: Optional[StrictStr] = None,
2602
- _headers: Optional[Dict[StrictStr, Any]] = None,
2603
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2604
- ) -> RESTResponseType:
2605
- """List user permissions
2606
-
2607
- List permissions available to the current user on this object.
2608
-
2609
- :param task_href: (required)
2610
- :type task_href: str
2611
- :param x_task_diagnostics: List of profilers to use on tasks.
2612
- :type x_task_diagnostics: List[str]
2613
- :param fields: A list of fields to include in the response.
2614
- :type fields: List[str]
2615
- :param exclude_fields: A list of fields to exclude from the response.
2616
- :type exclude_fields: List[str]
2617
- :param _request_timeout: timeout setting for this request. If one
2618
- number provided, it will be total request
2619
- timeout. It can also be a pair (tuple) of
2620
- (connection, read) timeouts.
2621
- :type _request_timeout: int, tuple(int, int), optional
2622
- :param _request_auth: set to override the auth_settings for an a single
2623
- request; this effectively ignores the
2624
- authentication in the spec for a single request.
2625
- :type _request_auth: dict, optional
2626
- :param _content_type: force content-type for the request.
2627
- :type _content_type: str, Optional
2628
- :param _headers: set to override the headers for a single
2629
- request; this effectively ignores the headers
2630
- in the spec for a single request.
2631
- :type _headers: dict, optional
2632
- :param _host_index: set to override the host_index for a single
2633
- request; this effectively ignores the host_index
2634
- in the spec for a single request.
2635
- :type _host_index: int, optional
2636
- :return: Returns the result object.
2637
- """ # noqa: E501
2638
-
2639
- _param = self._my_permissions_serialize(
2640
- task_href=task_href,
2641
- x_task_diagnostics=x_task_diagnostics,
2642
- fields=fields,
2643
- exclude_fields=exclude_fields,
2644
- _request_auth=_request_auth,
2645
- _content_type=_content_type,
2646
- _headers=_headers,
2647
- _host_index=_host_index
2648
- )
2649
-
2650
- _response_types_map: Dict[str, Optional[str]] = {
2651
- '200': "MyPermissionsResponse",
2652
- }
2653
- response_data = self.api_client.call_api(
2654
- *_param,
2655
- _request_timeout=_request_timeout
2656
- )
2657
- return response_data.response
2658
-
2659
-
2660
- def _my_permissions_serialize(
2661
- self,
2662
- task_href,
2663
- x_task_diagnostics,
2664
- fields,
2665
- exclude_fields,
2666
- _request_auth,
2667
- _content_type,
2668
- _headers,
2669
- _host_index,
2670
- ) -> RequestSerialized:
2671
-
2672
- _host = None
2673
-
2674
- _collection_formats: Dict[str, str] = {
2675
- 'X-Task-Diagnostics': 'csv',
2676
- 'fields': 'multi',
2677
- 'exclude_fields': 'multi',
2678
- }
2679
-
2680
- _path_params: Dict[str, str] = {}
2681
- _query_params: List[Tuple[str, str]] = []
2682
- _header_params: Dict[str, Optional[str]] = _headers or {}
2683
- _form_params: List[Tuple[str, str]] = []
2684
- _files: Dict[
2685
- str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
2686
- ] = {}
2687
- _body_params: Optional[bytes] = None
2688
-
2689
- # process the path parameters
2690
- if task_href is not None:
2691
- _path_params['task_href'] = task_href
2692
- # process the query parameters
2693
- if fields is not None:
2694
-
2695
- _query_params.append(('fields', fields))
2696
-
2697
- if exclude_fields is not None:
2698
-
2699
- _query_params.append(('exclude_fields', exclude_fields))
2700
-
2701
- # process the header parameters
2702
- if x_task_diagnostics is not None:
2703
- _header_params['X-Task-Diagnostics'] = x_task_diagnostics
2704
- # process the form parameters
2705
- # process the body parameter
2706
-
2707
-
2708
- # set the HTTP header `Accept`
2709
- if 'Accept' not in _header_params:
2710
- _header_params['Accept'] = self.api_client.select_header_accept(
2711
- [
2712
- 'application/json'
2713
- ]
2714
- )
2715
-
2716
-
2717
- # authentication setting
2718
- _auth_settings: List[str] = [
2719
- 'json_header_remote_authentication',
2720
- 'basicAuth',
2721
- 'cookieAuth'
2722
- ]
2723
-
2724
- return self.api_client.param_serialize(
2725
- method='GET',
2726
- resource_path='{task_href}my_permissions/',
2727
- path_params=_path_params,
2728
- query_params=_query_params,
2729
- header_params=_header_params,
2730
- body=_body_params,
2731
- post_params=_form_params,
2732
- files=_files,
2733
- auth_settings=_auth_settings,
2734
- collection_formats=_collection_formats,
2735
- _host=_host,
2736
- _request_auth=_request_auth
2737
- )
2738
-
2739
-
2740
-
2741
-
2742
- @validate_call
2743
- def profile_artifacts(
2744
- self,
2745
- task_href: StrictStr,
2746
- x_task_diagnostics: Annotated[Optional[List[StrictStr]], Field(description="List of profilers to use on tasks.")] = None,
2747
- fields: Annotated[Optional[List[StrictStr]], Field(description="A list of fields to include in the response.")] = None,
2748
- exclude_fields: Annotated[Optional[List[StrictStr]], Field(description="A list of fields to exclude from the response.")] = None,
2749
- _request_timeout: Union[
2750
- None,
2751
- Annotated[StrictFloat, Field(gt=0)],
2752
- Tuple[
2753
- Annotated[StrictFloat, Field(gt=0)],
2754
- Annotated[StrictFloat, Field(gt=0)]
2755
- ]
2756
- ] = None,
2757
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
2758
- _content_type: Optional[StrictStr] = None,
2759
- _headers: Optional[Dict[StrictStr, Any]] = None,
2760
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2761
- ) -> ProfileArtifactResponse:
2762
- """Fetch downloadable links for profile artifacts
2763
-
2764
- Return pre-signed URLs used for downloading raw profile artifacts.
2765
-
2766
- :param task_href: (required)
2767
- :type task_href: str
2768
- :param x_task_diagnostics: List of profilers to use on tasks.
2769
- :type x_task_diagnostics: List[str]
2770
- :param fields: A list of fields to include in the response.
2771
- :type fields: List[str]
2772
- :param exclude_fields: A list of fields to exclude from the response.
2773
- :type exclude_fields: List[str]
2774
- :param _request_timeout: timeout setting for this request. If one
2775
- number provided, it will be total request
2776
- timeout. It can also be a pair (tuple) of
2777
- (connection, read) timeouts.
2778
- :type _request_timeout: int, tuple(int, int), optional
2779
- :param _request_auth: set to override the auth_settings for an a single
2780
- request; this effectively ignores the
2781
- authentication in the spec for a single request.
2782
- :type _request_auth: dict, optional
2783
- :param _content_type: force content-type for the request.
2784
- :type _content_type: str, Optional
2785
- :param _headers: set to override the headers for a single
2786
- request; this effectively ignores the headers
2787
- in the spec for a single request.
2788
- :type _headers: dict, optional
2789
- :param _host_index: set to override the host_index for a single
2790
- request; this effectively ignores the host_index
2791
- in the spec for a single request.
2792
- :type _host_index: int, optional
2793
- :return: Returns the result object.
2794
- """ # noqa: E501
2795
-
2796
- _param = self._profile_artifacts_serialize(
2797
- task_href=task_href,
2798
- x_task_diagnostics=x_task_diagnostics,
2799
- fields=fields,
2800
- exclude_fields=exclude_fields,
2801
- _request_auth=_request_auth,
2802
- _content_type=_content_type,
2803
- _headers=_headers,
2804
- _host_index=_host_index
2805
- )
2806
-
2807
- _response_types_map: Dict[str, Optional[str]] = {
2808
- '200': "ProfileArtifactResponse",
2809
- }
2810
- response_data = self.api_client.call_api(
2811
- *_param,
2812
- _request_timeout=_request_timeout
2813
- )
2814
- response_data.read()
2815
- return self.api_client.response_deserialize(
2816
- response_data=response_data,
2817
- response_types_map=_response_types_map,
2818
- ).data
2819
-
2820
-
2821
- @validate_call
2822
- def profile_artifacts_with_http_info(
2823
- self,
2824
- task_href: StrictStr,
2825
- x_task_diagnostics: Annotated[Optional[List[StrictStr]], Field(description="List of profilers to use on tasks.")] = None,
2826
- fields: Annotated[Optional[List[StrictStr]], Field(description="A list of fields to include in the response.")] = None,
2827
- exclude_fields: Annotated[Optional[List[StrictStr]], Field(description="A list of fields to exclude from the response.")] = None,
2828
- _request_timeout: Union[
2829
- None,
2830
- Annotated[StrictFloat, Field(gt=0)],
2831
- Tuple[
2832
- Annotated[StrictFloat, Field(gt=0)],
2833
- Annotated[StrictFloat, Field(gt=0)]
2834
- ]
2835
- ] = None,
2836
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
2837
- _content_type: Optional[StrictStr] = None,
2838
- _headers: Optional[Dict[StrictStr, Any]] = None,
2839
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2840
- ) -> ApiResponse[ProfileArtifactResponse]:
2841
- """Fetch downloadable links for profile artifacts
2842
-
2843
- Return pre-signed URLs used for downloading raw profile artifacts.
2844
-
2845
- :param task_href: (required)
2846
- :type task_href: str
2847
- :param x_task_diagnostics: List of profilers to use on tasks.
2848
- :type x_task_diagnostics: List[str]
2849
- :param fields: A list of fields to include in the response.
2850
- :type fields: List[str]
2851
- :param exclude_fields: A list of fields to exclude from the response.
2852
- :type exclude_fields: List[str]
2853
- :param _request_timeout: timeout setting for this request. If one
2854
- number provided, it will be total request
2855
- timeout. It can also be a pair (tuple) of
2856
- (connection, read) timeouts.
2857
- :type _request_timeout: int, tuple(int, int), optional
2858
- :param _request_auth: set to override the auth_settings for an a single
2859
- request; this effectively ignores the
2860
- authentication in the spec for a single request.
2861
- :type _request_auth: dict, optional
2862
- :param _content_type: force content-type for the request.
2863
- :type _content_type: str, Optional
2864
- :param _headers: set to override the headers for a single
2865
- request; this effectively ignores the headers
2866
- in the spec for a single request.
2867
- :type _headers: dict, optional
2868
- :param _host_index: set to override the host_index for a single
2869
- request; this effectively ignores the host_index
2870
- in the spec for a single request.
2871
- :type _host_index: int, optional
2872
- :return: Returns the result object.
2873
- """ # noqa: E501
2874
-
2875
- _param = self._profile_artifacts_serialize(
2876
- task_href=task_href,
2877
- x_task_diagnostics=x_task_diagnostics,
2878
- fields=fields,
2879
- exclude_fields=exclude_fields,
2880
- _request_auth=_request_auth,
2881
- _content_type=_content_type,
2882
- _headers=_headers,
2883
- _host_index=_host_index
2884
- )
2885
-
2886
- _response_types_map: Dict[str, Optional[str]] = {
2887
- '200': "ProfileArtifactResponse",
2888
- }
2889
- response_data = self.api_client.call_api(
2890
- *_param,
2891
- _request_timeout=_request_timeout
2892
- )
2893
- response_data.read()
2894
- return self.api_client.response_deserialize(
2895
- response_data=response_data,
2896
- response_types_map=_response_types_map,
2897
- )
2898
-
2899
-
2900
- @validate_call
2901
- def profile_artifacts_without_preload_content(
2902
- self,
2903
- task_href: StrictStr,
2904
- x_task_diagnostics: Annotated[Optional[List[StrictStr]], Field(description="List of profilers to use on tasks.")] = None,
2905
- fields: Annotated[Optional[List[StrictStr]], Field(description="A list of fields to include in the response.")] = None,
2906
- exclude_fields: Annotated[Optional[List[StrictStr]], Field(description="A list of fields to exclude from the response.")] = None,
2907
- _request_timeout: Union[
2908
- None,
2909
- Annotated[StrictFloat, Field(gt=0)],
2910
- Tuple[
2911
- Annotated[StrictFloat, Field(gt=0)],
2912
- Annotated[StrictFloat, Field(gt=0)]
2913
- ]
2914
- ] = None,
2915
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
2916
- _content_type: Optional[StrictStr] = None,
2917
- _headers: Optional[Dict[StrictStr, Any]] = None,
2918
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2919
- ) -> RESTResponseType:
2920
- """Fetch downloadable links for profile artifacts
2921
-
2922
- Return pre-signed URLs used for downloading raw profile artifacts.
2923
-
2924
- :param task_href: (required)
2925
- :type task_href: str
2926
- :param x_task_diagnostics: List of profilers to use on tasks.
2927
- :type x_task_diagnostics: List[str]
2928
- :param fields: A list of fields to include in the response.
2929
- :type fields: List[str]
2930
- :param exclude_fields: A list of fields to exclude from the response.
2931
- :type exclude_fields: List[str]
2932
- :param _request_timeout: timeout setting for this request. If one
2933
- number provided, it will be total request
2934
- timeout. It can also be a pair (tuple) of
2935
- (connection, read) timeouts.
2936
- :type _request_timeout: int, tuple(int, int), optional
2937
- :param _request_auth: set to override the auth_settings for an a single
2938
- request; this effectively ignores the
2939
- authentication in the spec for a single request.
2940
- :type _request_auth: dict, optional
2941
- :param _content_type: force content-type for the request.
2942
- :type _content_type: str, Optional
2943
- :param _headers: set to override the headers for a single
2944
- request; this effectively ignores the headers
2945
- in the spec for a single request.
2946
- :type _headers: dict, optional
2947
- :param _host_index: set to override the host_index for a single
2948
- request; this effectively ignores the host_index
2949
- in the spec for a single request.
2950
- :type _host_index: int, optional
2951
- :return: Returns the result object.
2952
- """ # noqa: E501
2953
-
2954
- _param = self._profile_artifacts_serialize(
2955
- task_href=task_href,
2956
- x_task_diagnostics=x_task_diagnostics,
2957
- fields=fields,
2958
- exclude_fields=exclude_fields,
2959
- _request_auth=_request_auth,
2960
- _content_type=_content_type,
2961
- _headers=_headers,
2962
- _host_index=_host_index
2963
- )
2964
-
2965
- _response_types_map: Dict[str, Optional[str]] = {
2966
- '200': "ProfileArtifactResponse",
2967
- }
2968
- response_data = self.api_client.call_api(
2969
- *_param,
2970
- _request_timeout=_request_timeout
2971
- )
2972
- return response_data.response
2973
-
2974
-
2975
- def _profile_artifacts_serialize(
2976
- self,
2977
- task_href,
2978
- x_task_diagnostics,
2979
- fields,
2980
- exclude_fields,
2981
- _request_auth,
2982
- _content_type,
2983
- _headers,
2984
- _host_index,
2985
- ) -> RequestSerialized:
2986
-
2987
- _host = None
2988
-
2989
- _collection_formats: Dict[str, str] = {
2990
- 'X-Task-Diagnostics': 'csv',
2991
- 'fields': 'multi',
2992
- 'exclude_fields': 'multi',
2993
- }
2994
-
2995
- _path_params: Dict[str, str] = {}
2996
- _query_params: List[Tuple[str, str]] = []
2997
- _header_params: Dict[str, Optional[str]] = _headers or {}
2998
- _form_params: List[Tuple[str, str]] = []
2999
- _files: Dict[
3000
- str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
3001
- ] = {}
3002
- _body_params: Optional[bytes] = None
3003
-
3004
- # process the path parameters
3005
- if task_href is not None:
3006
- _path_params['task_href'] = task_href
3007
- # process the query parameters
3008
- if fields is not None:
3009
-
3010
- _query_params.append(('fields', fields))
3011
-
3012
- if exclude_fields is not None:
3013
-
3014
- _query_params.append(('exclude_fields', exclude_fields))
3015
-
3016
- # process the header parameters
3017
- if x_task_diagnostics is not None:
3018
- _header_params['X-Task-Diagnostics'] = x_task_diagnostics
3019
- # process the form parameters
3020
- # process the body parameter
3021
-
3022
-
3023
- # set the HTTP header `Accept`
3024
- if 'Accept' not in _header_params:
3025
- _header_params['Accept'] = self.api_client.select_header_accept(
3026
- [
3027
- 'application/json'
3028
- ]
3029
- )
3030
-
3031
-
3032
- # authentication setting
3033
- _auth_settings: List[str] = [
3034
- 'json_header_remote_authentication',
3035
- 'basicAuth',
3036
- 'cookieAuth'
3037
- ]
3038
-
3039
- return self.api_client.param_serialize(
3040
- method='GET',
3041
- resource_path='{task_href}profile_artifacts/',
3042
- path_params=_path_params,
3043
- query_params=_query_params,
3044
- header_params=_header_params,
3045
- body=_body_params,
3046
- post_params=_form_params,
3047
- files=_files,
3048
- auth_settings=_auth_settings,
3049
- collection_formats=_collection_formats,
3050
- _host=_host,
3051
- _request_auth=_request_auth
3052
- )
3053
-
3054
-
3055
-
3056
-
3057
- @validate_call
3058
- def purge(
3059
- self,
3060
- purge: Purge,
3061
- x_task_diagnostics: Annotated[Optional[List[StrictStr]], Field(description="List of profilers to use on tasks.")] = None,
3062
- pulp_domain: StrictStr = "default",
3063
- _request_timeout: Union[
3064
- None,
3065
- Annotated[StrictFloat, Field(gt=0)],
3066
- Tuple[
3067
- Annotated[StrictFloat, Field(gt=0)],
3068
- Annotated[StrictFloat, Field(gt=0)]
3069
- ]
3070
- ] = None,
3071
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
3072
- _content_type: Optional[StrictStr] = None,
3073
- _headers: Optional[Dict[StrictStr, Any]] = None,
3074
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3075
- ) -> AsyncOperationResponse:
3076
- """Purge Completed Tasks
3077
-
3078
- Trigger an asynchronous task that deletes completed tasks that finished prior to a specified timestamp.
3079
-
3080
- :param pulp_domain: (required)
3081
- :type pulp_domain: str
3082
- :param purge: (required)
3083
- :type purge: Purge
3084
- :param x_task_diagnostics: List of profilers to use on tasks.
3085
- :type x_task_diagnostics: List[str]
3086
- :param _request_timeout: timeout setting for this request. If one
3087
- number provided, it will be total request
3088
- timeout. It can also be a pair (tuple) of
3089
- (connection, read) timeouts.
3090
- :type _request_timeout: int, tuple(int, int), optional
3091
- :param _request_auth: set to override the auth_settings for an a single
3092
- request; this effectively ignores the
3093
- authentication in the spec for a single request.
3094
- :type _request_auth: dict, optional
3095
- :param _content_type: force content-type for the request.
3096
- :type _content_type: str, Optional
3097
- :param _headers: set to override the headers for a single
3098
- request; this effectively ignores the headers
3099
- in the spec for a single request.
3100
- :type _headers: dict, optional
3101
- :param _host_index: set to override the host_index for a single
3102
- request; this effectively ignores the host_index
3103
- in the spec for a single request.
3104
- :type _host_index: int, optional
3105
- :return: Returns the result object.
3106
- """ # noqa: E501
3107
-
3108
- _param = self._purge_serialize(
3109
- pulp_domain=pulp_domain,
3110
- purge=purge,
3111
- x_task_diagnostics=x_task_diagnostics,
3112
- _request_auth=_request_auth,
3113
- _content_type=_content_type,
3114
- _headers=_headers,
3115
- _host_index=_host_index
3116
- )
3117
-
3118
- _response_types_map: Dict[str, Optional[str]] = {
3119
- '202': "AsyncOperationResponse",
3120
- }
3121
- response_data = self.api_client.call_api(
3122
- *_param,
3123
- _request_timeout=_request_timeout
3124
- )
3125
- response_data.read()
3126
- return self.api_client.response_deserialize(
3127
- response_data=response_data,
3128
- response_types_map=_response_types_map,
3129
- ).data
3130
-
3131
-
3132
- @validate_call
3133
- def purge_with_http_info(
3134
- self,
3135
- purge: Purge,
3136
- x_task_diagnostics: Annotated[Optional[List[StrictStr]], Field(description="List of profilers to use on tasks.")] = None,
3137
- pulp_domain: StrictStr = "default",
3138
- _request_timeout: Union[
3139
- None,
3140
- Annotated[StrictFloat, Field(gt=0)],
3141
- Tuple[
3142
- Annotated[StrictFloat, Field(gt=0)],
3143
- Annotated[StrictFloat, Field(gt=0)]
3144
- ]
3145
- ] = None,
3146
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
3147
- _content_type: Optional[StrictStr] = None,
3148
- _headers: Optional[Dict[StrictStr, Any]] = None,
3149
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3150
- ) -> ApiResponse[AsyncOperationResponse]:
3151
- """Purge Completed Tasks
3152
-
3153
- Trigger an asynchronous task that deletes completed tasks that finished prior to a specified timestamp.
3154
-
3155
- :param pulp_domain: (required)
3156
- :type pulp_domain: str
3157
- :param purge: (required)
3158
- :type purge: Purge
3159
- :param x_task_diagnostics: List of profilers to use on tasks.
3160
- :type x_task_diagnostics: List[str]
3161
- :param _request_timeout: timeout setting for this request. If one
3162
- number provided, it will be total request
3163
- timeout. It can also be a pair (tuple) of
3164
- (connection, read) timeouts.
3165
- :type _request_timeout: int, tuple(int, int), optional
3166
- :param _request_auth: set to override the auth_settings for an a single
3167
- request; this effectively ignores the
3168
- authentication in the spec for a single request.
3169
- :type _request_auth: dict, optional
3170
- :param _content_type: force content-type for the request.
3171
- :type _content_type: str, Optional
3172
- :param _headers: set to override the headers for a single
3173
- request; this effectively ignores the headers
3174
- in the spec for a single request.
3175
- :type _headers: dict, optional
3176
- :param _host_index: set to override the host_index for a single
3177
- request; this effectively ignores the host_index
3178
- in the spec for a single request.
3179
- :type _host_index: int, optional
3180
- :return: Returns the result object.
3181
- """ # noqa: E501
3182
-
3183
- _param = self._purge_serialize(
3184
- pulp_domain=pulp_domain,
3185
- purge=purge,
3186
- x_task_diagnostics=x_task_diagnostics,
3187
- _request_auth=_request_auth,
3188
- _content_type=_content_type,
3189
- _headers=_headers,
3190
- _host_index=_host_index
3191
- )
3192
-
3193
- _response_types_map: Dict[str, Optional[str]] = {
3194
- '202': "AsyncOperationResponse",
3195
- }
3196
- response_data = self.api_client.call_api(
3197
- *_param,
3198
- _request_timeout=_request_timeout
3199
- )
3200
- response_data.read()
3201
- return self.api_client.response_deserialize(
3202
- response_data=response_data,
3203
- response_types_map=_response_types_map,
3204
- )
3205
-
3206
-
3207
- @validate_call
3208
- def purge_without_preload_content(
3209
- self,
3210
- purge: Purge,
3211
- x_task_diagnostics: Annotated[Optional[List[StrictStr]], Field(description="List of profilers to use on tasks.")] = None,
3212
- pulp_domain: StrictStr = "default",
3213
- _request_timeout: Union[
3214
- None,
3215
- Annotated[StrictFloat, Field(gt=0)],
3216
- Tuple[
3217
- Annotated[StrictFloat, Field(gt=0)],
3218
- Annotated[StrictFloat, Field(gt=0)]
3219
- ]
3220
- ] = None,
3221
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
3222
- _content_type: Optional[StrictStr] = None,
3223
- _headers: Optional[Dict[StrictStr, Any]] = None,
3224
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3225
- ) -> RESTResponseType:
3226
- """Purge Completed Tasks
3227
-
3228
- Trigger an asynchronous task that deletes completed tasks that finished prior to a specified timestamp.
3229
-
3230
- :param pulp_domain: (required)
3231
- :type pulp_domain: str
3232
- :param purge: (required)
3233
- :type purge: Purge
3234
- :param x_task_diagnostics: List of profilers to use on tasks.
3235
- :type x_task_diagnostics: List[str]
3236
- :param _request_timeout: timeout setting for this request. If one
3237
- number provided, it will be total request
3238
- timeout. It can also be a pair (tuple) of
3239
- (connection, read) timeouts.
3240
- :type _request_timeout: int, tuple(int, int), optional
3241
- :param _request_auth: set to override the auth_settings for an a single
3242
- request; this effectively ignores the
3243
- authentication in the spec for a single request.
3244
- :type _request_auth: dict, optional
3245
- :param _content_type: force content-type for the request.
3246
- :type _content_type: str, Optional
3247
- :param _headers: set to override the headers for a single
3248
- request; this effectively ignores the headers
3249
- in the spec for a single request.
3250
- :type _headers: dict, optional
3251
- :param _host_index: set to override the host_index for a single
3252
- request; this effectively ignores the host_index
3253
- in the spec for a single request.
3254
- :type _host_index: int, optional
3255
- :return: Returns the result object.
3256
- """ # noqa: E501
3257
-
3258
- _param = self._purge_serialize(
3259
- pulp_domain=pulp_domain,
3260
- purge=purge,
3261
- x_task_diagnostics=x_task_diagnostics,
3262
- _request_auth=_request_auth,
3263
- _content_type=_content_type,
3264
- _headers=_headers,
3265
- _host_index=_host_index
3266
- )
3267
-
3268
- _response_types_map: Dict[str, Optional[str]] = {
3269
- '202': "AsyncOperationResponse",
3270
- }
3271
- response_data = self.api_client.call_api(
3272
- *_param,
3273
- _request_timeout=_request_timeout
3274
- )
3275
- return response_data.response
3276
-
3277
-
3278
- def _purge_serialize(
3279
- self,
3280
- pulp_domain,
3281
- purge,
3282
- x_task_diagnostics,
3283
- _request_auth,
3284
- _content_type,
3285
- _headers,
3286
- _host_index,
3287
- ) -> RequestSerialized:
3288
-
3289
- _host = None
3290
-
3291
- _collection_formats: Dict[str, str] = {
3292
- 'X-Task-Diagnostics': 'csv',
3293
- }
3294
-
3295
- _path_params: Dict[str, str] = {}
3296
- _query_params: List[Tuple[str, str]] = []
3297
- _header_params: Dict[str, Optional[str]] = _headers or {}
3298
- _form_params: List[Tuple[str, str]] = []
3299
- _files: Dict[
3300
- str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
3301
- ] = {}
3302
- _body_params: Optional[bytes] = None
3303
-
3304
- # process the path parameters
3305
- if pulp_domain is not None:
3306
- _path_params['pulp_domain'] = pulp_domain
3307
- # process the query parameters
3308
- # process the header parameters
3309
- if x_task_diagnostics is not None:
3310
- _header_params['X-Task-Diagnostics'] = x_task_diagnostics
3311
- # process the form parameters
3312
- # process the body parameter
3313
- if purge is not None:
3314
- _body_params = purge
3315
-
3316
-
3317
- # set the HTTP header `Accept`
3318
- if 'Accept' not in _header_params:
3319
- _header_params['Accept'] = self.api_client.select_header_accept(
3320
- [
3321
- 'application/json'
3322
- ]
3323
- )
3324
-
3325
- # set the HTTP header `Content-Type`
3326
- if _content_type:
3327
- _header_params['Content-Type'] = _content_type
3328
- else:
3329
- _default_content_type = (
3330
- self.api_client.select_header_content_type(
3331
- [
3332
- 'application/json',
3333
- 'application/x-www-form-urlencoded',
3334
- 'multipart/form-data'
3335
- ]
3336
- )
3337
- )
3338
- if _default_content_type is not None:
3339
- _header_params['Content-Type'] = _default_content_type
3340
-
3341
- # authentication setting
3342
- _auth_settings: List[str] = [
3343
- 'json_header_remote_authentication',
3344
- 'basicAuth',
3345
- 'cookieAuth'
3346
- ]
3347
-
3348
- return self.api_client.param_serialize(
3349
- method='POST',
3350
- resource_path='/api/pulp/{pulp_domain}/api/v3/tasks/purge/',
3351
- path_params=_path_params,
3352
- query_params=_query_params,
3353
- header_params=_header_params,
3354
- body=_body_params,
3355
- post_params=_form_params,
3356
- files=_files,
3357
- auth_settings=_auth_settings,
3358
- collection_formats=_collection_formats,
3359
- _host=_host,
3360
- _request_auth=_request_auth
3361
- )
3362
-
3363
-
3364
-
3365
-
3366
- @validate_call
3367
- def read(
3368
- self,
3369
- task_href: StrictStr,
3370
- x_task_diagnostics: Annotated[Optional[List[StrictStr]], Field(description="List of profilers to use on tasks.")] = None,
3371
- fields: Annotated[Optional[List[StrictStr]], Field(description="A list of fields to include in the response.")] = None,
3372
- exclude_fields: Annotated[Optional[List[StrictStr]], Field(description="A list of fields to exclude from the response.")] = None,
3373
- _request_timeout: Union[
3374
- None,
3375
- Annotated[StrictFloat, Field(gt=0)],
3376
- Tuple[
3377
- Annotated[StrictFloat, Field(gt=0)],
3378
- Annotated[StrictFloat, Field(gt=0)]
3379
- ]
3380
- ] = None,
3381
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
3382
- _content_type: Optional[StrictStr] = None,
3383
- _headers: Optional[Dict[StrictStr, Any]] = None,
3384
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3385
- ) -> TaskResponse:
3386
- """Inspect a task
3387
-
3388
- 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.
3389
-
3390
- :param task_href: (required)
3391
- :type task_href: str
3392
- :param x_task_diagnostics: List of profilers to use on tasks.
3393
- :type x_task_diagnostics: List[str]
3394
- :param fields: A list of fields to include in the response.
3395
- :type fields: List[str]
3396
- :param exclude_fields: A list of fields to exclude from the response.
3397
- :type exclude_fields: List[str]
3398
- :param _request_timeout: timeout setting for this request. If one
3399
- number provided, it will be total request
3400
- timeout. It can also be a pair (tuple) of
3401
- (connection, read) timeouts.
3402
- :type _request_timeout: int, tuple(int, int), optional
3403
- :param _request_auth: set to override the auth_settings for an a single
3404
- request; this effectively ignores the
3405
- authentication in the spec for a single request.
3406
- :type _request_auth: dict, optional
3407
- :param _content_type: force content-type for the request.
3408
- :type _content_type: str, Optional
3409
- :param _headers: set to override the headers for a single
3410
- request; this effectively ignores the headers
3411
- in the spec for a single request.
3412
- :type _headers: dict, optional
3413
- :param _host_index: set to override the host_index for a single
3414
- request; this effectively ignores the host_index
3415
- in the spec for a single request.
3416
- :type _host_index: int, optional
3417
- :return: Returns the result object.
3418
- """ # noqa: E501
3419
-
3420
- _param = self._read_serialize(
3421
- task_href=task_href,
3422
- x_task_diagnostics=x_task_diagnostics,
3423
- fields=fields,
3424
- exclude_fields=exclude_fields,
3425
- _request_auth=_request_auth,
3426
- _content_type=_content_type,
3427
- _headers=_headers,
3428
- _host_index=_host_index
3429
- )
3430
-
3431
- _response_types_map: Dict[str, Optional[str]] = {
3432
- '200': "TaskResponse",
3433
- }
3434
- response_data = self.api_client.call_api(
3435
- *_param,
3436
- _request_timeout=_request_timeout
3437
- )
3438
- response_data.read()
3439
- return self.api_client.response_deserialize(
3440
- response_data=response_data,
3441
- response_types_map=_response_types_map,
3442
- ).data
3443
-
3444
-
3445
- @validate_call
3446
- def read_with_http_info(
3447
- self,
3448
- task_href: StrictStr,
3449
- x_task_diagnostics: Annotated[Optional[List[StrictStr]], Field(description="List of profilers to use on tasks.")] = None,
3450
- fields: Annotated[Optional[List[StrictStr]], Field(description="A list of fields to include in the response.")] = None,
3451
- exclude_fields: Annotated[Optional[List[StrictStr]], Field(description="A list of fields to exclude from the response.")] = None,
3452
- _request_timeout: Union[
3453
- None,
3454
- Annotated[StrictFloat, Field(gt=0)],
3455
- Tuple[
3456
- Annotated[StrictFloat, Field(gt=0)],
3457
- Annotated[StrictFloat, Field(gt=0)]
3458
- ]
3459
- ] = None,
3460
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
3461
- _content_type: Optional[StrictStr] = None,
3462
- _headers: Optional[Dict[StrictStr, Any]] = None,
3463
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3464
- ) -> ApiResponse[TaskResponse]:
3465
- """Inspect a task
3466
-
3467
- 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.
3468
-
3469
- :param task_href: (required)
3470
- :type task_href: str
3471
- :param x_task_diagnostics: List of profilers to use on tasks.
3472
- :type x_task_diagnostics: List[str]
3473
- :param fields: A list of fields to include in the response.
3474
- :type fields: List[str]
3475
- :param exclude_fields: A list of fields to exclude from the response.
3476
- :type exclude_fields: List[str]
3477
- :param _request_timeout: timeout setting for this request. If one
3478
- number provided, it will be total request
3479
- timeout. It can also be a pair (tuple) of
3480
- (connection, read) timeouts.
3481
- :type _request_timeout: int, tuple(int, int), optional
3482
- :param _request_auth: set to override the auth_settings for an a single
3483
- request; this effectively ignores the
3484
- authentication in the spec for a single request.
3485
- :type _request_auth: dict, optional
3486
- :param _content_type: force content-type for the request.
3487
- :type _content_type: str, Optional
3488
- :param _headers: set to override the headers for a single
3489
- request; this effectively ignores the headers
3490
- in the spec for a single request.
3491
- :type _headers: dict, optional
3492
- :param _host_index: set to override the host_index for a single
3493
- request; this effectively ignores the host_index
3494
- in the spec for a single request.
3495
- :type _host_index: int, optional
3496
- :return: Returns the result object.
3497
- """ # noqa: E501
3498
-
3499
- _param = self._read_serialize(
3500
- task_href=task_href,
3501
- x_task_diagnostics=x_task_diagnostics,
3502
- fields=fields,
3503
- exclude_fields=exclude_fields,
3504
- _request_auth=_request_auth,
3505
- _content_type=_content_type,
3506
- _headers=_headers,
3507
- _host_index=_host_index
3508
- )
3509
-
3510
- _response_types_map: Dict[str, Optional[str]] = {
3511
- '200': "TaskResponse",
3512
- }
3513
- response_data = self.api_client.call_api(
3514
- *_param,
3515
- _request_timeout=_request_timeout
3516
- )
3517
- response_data.read()
3518
- return self.api_client.response_deserialize(
3519
- response_data=response_data,
3520
- response_types_map=_response_types_map,
3521
- )
3522
-
3523
-
3524
- @validate_call
3525
- def read_without_preload_content(
3526
- self,
3527
- task_href: StrictStr,
3528
- x_task_diagnostics: Annotated[Optional[List[StrictStr]], Field(description="List of profilers to use on tasks.")] = None,
3529
- fields: Annotated[Optional[List[StrictStr]], Field(description="A list of fields to include in the response.")] = None,
3530
- exclude_fields: Annotated[Optional[List[StrictStr]], Field(description="A list of fields to exclude from the response.")] = None,
3531
- _request_timeout: Union[
3532
- None,
3533
- Annotated[StrictFloat, Field(gt=0)],
3534
- Tuple[
3535
- Annotated[StrictFloat, Field(gt=0)],
3536
- Annotated[StrictFloat, Field(gt=0)]
3537
- ]
3538
- ] = None,
3539
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
3540
- _content_type: Optional[StrictStr] = None,
3541
- _headers: Optional[Dict[StrictStr, Any]] = None,
3542
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3543
- ) -> RESTResponseType:
3544
- """Inspect a task
3545
-
3546
- 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.
3547
-
3548
- :param task_href: (required)
3549
- :type task_href: str
3550
- :param x_task_diagnostics: List of profilers to use on tasks.
3551
- :type x_task_diagnostics: List[str]
3552
- :param fields: A list of fields to include in the response.
3553
- :type fields: List[str]
3554
- :param exclude_fields: A list of fields to exclude from the response.
3555
- :type exclude_fields: List[str]
3556
- :param _request_timeout: timeout setting for this request. If one
3557
- number provided, it will be total request
3558
- timeout. It can also be a pair (tuple) of
3559
- (connection, read) timeouts.
3560
- :type _request_timeout: int, tuple(int, int), optional
3561
- :param _request_auth: set to override the auth_settings for an a single
3562
- request; this effectively ignores the
3563
- authentication in the spec for a single request.
3564
- :type _request_auth: dict, optional
3565
- :param _content_type: force content-type for the request.
3566
- :type _content_type: str, Optional
3567
- :param _headers: set to override the headers for a single
3568
- request; this effectively ignores the headers
3569
- in the spec for a single request.
3570
- :type _headers: dict, optional
3571
- :param _host_index: set to override the host_index for a single
3572
- request; this effectively ignores the host_index
3573
- in the spec for a single request.
3574
- :type _host_index: int, optional
3575
- :return: Returns the result object.
3576
- """ # noqa: E501
3577
-
3578
- _param = self._read_serialize(
3579
- task_href=task_href,
3580
- x_task_diagnostics=x_task_diagnostics,
3581
- fields=fields,
3582
- exclude_fields=exclude_fields,
3583
- _request_auth=_request_auth,
3584
- _content_type=_content_type,
3585
- _headers=_headers,
3586
- _host_index=_host_index
3587
- )
3588
-
3589
- _response_types_map: Dict[str, Optional[str]] = {
3590
- '200': "TaskResponse",
3591
- }
3592
- response_data = self.api_client.call_api(
3593
- *_param,
3594
- _request_timeout=_request_timeout
3595
- )
3596
- return response_data.response
3597
-
3598
-
3599
- def _read_serialize(
3600
- self,
3601
- task_href,
3602
- x_task_diagnostics,
3603
- fields,
3604
- exclude_fields,
3605
- _request_auth,
3606
- _content_type,
3607
- _headers,
3608
- _host_index,
3609
- ) -> RequestSerialized:
3610
-
3611
- _host = None
3612
-
3613
- _collection_formats: Dict[str, str] = {
3614
- 'X-Task-Diagnostics': 'csv',
3615
- 'fields': 'multi',
3616
- 'exclude_fields': 'multi',
3617
- }
3618
-
3619
- _path_params: Dict[str, str] = {}
3620
- _query_params: List[Tuple[str, str]] = []
3621
- _header_params: Dict[str, Optional[str]] = _headers or {}
3622
- _form_params: List[Tuple[str, str]] = []
3623
- _files: Dict[
3624
- str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
3625
- ] = {}
3626
- _body_params: Optional[bytes] = None
3627
-
3628
- # process the path parameters
3629
- if task_href is not None:
3630
- _path_params['task_href'] = task_href
3631
- # process the query parameters
3632
- if fields is not None:
3633
-
3634
- _query_params.append(('fields', fields))
3635
-
3636
- if exclude_fields is not None:
3637
-
3638
- _query_params.append(('exclude_fields', exclude_fields))
3639
-
3640
- # process the header parameters
3641
- if x_task_diagnostics is not None:
3642
- _header_params['X-Task-Diagnostics'] = x_task_diagnostics
3643
- # process the form parameters
3644
- # process the body parameter
3645
-
3646
-
3647
- # set the HTTP header `Accept`
3648
- if 'Accept' not in _header_params:
3649
- _header_params['Accept'] = self.api_client.select_header_accept(
3650
- [
3651
- 'application/json'
3652
- ]
3653
- )
3654
-
3655
-
3656
- # authentication setting
3657
- _auth_settings: List[str] = [
3658
- 'json_header_remote_authentication',
3659
- 'basicAuth',
3660
- 'cookieAuth'
3661
- ]
3662
-
3663
- return self.api_client.param_serialize(
3664
- method='GET',
3665
- resource_path='{task_href}',
3666
- path_params=_path_params,
3667
- query_params=_query_params,
3668
- header_params=_header_params,
3669
- body=_body_params,
3670
- post_params=_form_params,
3671
- files=_files,
3672
- auth_settings=_auth_settings,
3673
- collection_formats=_collection_formats,
3674
- _host=_host,
3675
- _request_auth=_request_auth
3676
- )
3677
-
3678
-
3679
-
3680
-
3681
- @validate_call
3682
- def remove_role(
3683
- self,
3684
- task_href: StrictStr,
3685
- nested_role: NestedRole,
3686
- x_task_diagnostics: Annotated[Optional[List[StrictStr]], Field(description="List of profilers to use on tasks.")] = None,
3687
- _request_timeout: Union[
3688
- None,
3689
- Annotated[StrictFloat, Field(gt=0)],
3690
- Tuple[
3691
- Annotated[StrictFloat, Field(gt=0)],
3692
- Annotated[StrictFloat, Field(gt=0)]
3693
- ]
3694
- ] = None,
3695
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
3696
- _content_type: Optional[StrictStr] = None,
3697
- _headers: Optional[Dict[StrictStr, Any]] = None,
3698
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3699
- ) -> NestedRoleResponse:
3700
- """Remove a role
3701
-
3702
- Remove a role for this object from users/groups.
3703
-
3704
- :param task_href: (required)
3705
- :type task_href: str
3706
- :param nested_role: (required)
3707
- :type nested_role: NestedRole
3708
- :param x_task_diagnostics: List of profilers to use on tasks.
3709
- :type x_task_diagnostics: List[str]
3710
- :param _request_timeout: timeout setting for this request. If one
3711
- number provided, it will be total request
3712
- timeout. It can also be a pair (tuple) of
3713
- (connection, read) timeouts.
3714
- :type _request_timeout: int, tuple(int, int), optional
3715
- :param _request_auth: set to override the auth_settings for an a single
3716
- request; this effectively ignores the
3717
- authentication in the spec for a single request.
3718
- :type _request_auth: dict, optional
3719
- :param _content_type: force content-type for the request.
3720
- :type _content_type: str, Optional
3721
- :param _headers: set to override the headers for a single
3722
- request; this effectively ignores the headers
3723
- in the spec for a single request.
3724
- :type _headers: dict, optional
3725
- :param _host_index: set to override the host_index for a single
3726
- request; this effectively ignores the host_index
3727
- in the spec for a single request.
3728
- :type _host_index: int, optional
3729
- :return: Returns the result object.
3730
- """ # noqa: E501
3731
-
3732
- _param = self._remove_role_serialize(
3733
- task_href=task_href,
3734
- nested_role=nested_role,
3735
- x_task_diagnostics=x_task_diagnostics,
3736
- _request_auth=_request_auth,
3737
- _content_type=_content_type,
3738
- _headers=_headers,
3739
- _host_index=_host_index
3740
- )
3741
-
3742
- _response_types_map: Dict[str, Optional[str]] = {
3743
- '201': "NestedRoleResponse",
3744
- }
3745
- response_data = self.api_client.call_api(
3746
- *_param,
3747
- _request_timeout=_request_timeout
3748
- )
3749
- response_data.read()
3750
- return self.api_client.response_deserialize(
3751
- response_data=response_data,
3752
- response_types_map=_response_types_map,
3753
- ).data
3754
-
3755
-
3756
- @validate_call
3757
- def remove_role_with_http_info(
3758
- self,
3759
- task_href: StrictStr,
3760
- nested_role: NestedRole,
3761
- x_task_diagnostics: Annotated[Optional[List[StrictStr]], Field(description="List of profilers to use on tasks.")] = None,
3762
- _request_timeout: Union[
3763
- None,
3764
- Annotated[StrictFloat, Field(gt=0)],
3765
- Tuple[
3766
- Annotated[StrictFloat, Field(gt=0)],
3767
- Annotated[StrictFloat, Field(gt=0)]
3768
- ]
3769
- ] = None,
3770
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
3771
- _content_type: Optional[StrictStr] = None,
3772
- _headers: Optional[Dict[StrictStr, Any]] = None,
3773
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3774
- ) -> ApiResponse[NestedRoleResponse]:
3775
- """Remove a role
3776
-
3777
- Remove a role for this object from users/groups.
3778
-
3779
- :param task_href: (required)
3780
- :type task_href: str
3781
- :param nested_role: (required)
3782
- :type nested_role: NestedRole
3783
- :param x_task_diagnostics: List of profilers to use on tasks.
3784
- :type x_task_diagnostics: List[str]
3785
- :param _request_timeout: timeout setting for this request. If one
3786
- number provided, it will be total request
3787
- timeout. It can also be a pair (tuple) of
3788
- (connection, read) timeouts.
3789
- :type _request_timeout: int, tuple(int, int), optional
3790
- :param _request_auth: set to override the auth_settings for an a single
3791
- request; this effectively ignores the
3792
- authentication in the spec for a single request.
3793
- :type _request_auth: dict, optional
3794
- :param _content_type: force content-type for the request.
3795
- :type _content_type: str, Optional
3796
- :param _headers: set to override the headers for a single
3797
- request; this effectively ignores the headers
3798
- in the spec for a single request.
3799
- :type _headers: dict, optional
3800
- :param _host_index: set to override the host_index for a single
3801
- request; this effectively ignores the host_index
3802
- in the spec for a single request.
3803
- :type _host_index: int, optional
3804
- :return: Returns the result object.
3805
- """ # noqa: E501
3806
-
3807
- _param = self._remove_role_serialize(
3808
- task_href=task_href,
3809
- nested_role=nested_role,
3810
- x_task_diagnostics=x_task_diagnostics,
3811
- _request_auth=_request_auth,
3812
- _content_type=_content_type,
3813
- _headers=_headers,
3814
- _host_index=_host_index
3815
- )
3816
-
3817
- _response_types_map: Dict[str, Optional[str]] = {
3818
- '201': "NestedRoleResponse",
3819
- }
3820
- response_data = self.api_client.call_api(
3821
- *_param,
3822
- _request_timeout=_request_timeout
3823
- )
3824
- response_data.read()
3825
- return self.api_client.response_deserialize(
3826
- response_data=response_data,
3827
- response_types_map=_response_types_map,
3828
- )
3829
-
3830
-
3831
- @validate_call
3832
- def remove_role_without_preload_content(
3833
- self,
3834
- task_href: StrictStr,
3835
- nested_role: NestedRole,
3836
- x_task_diagnostics: Annotated[Optional[List[StrictStr]], Field(description="List of profilers to use on tasks.")] = None,
3837
- _request_timeout: Union[
3838
- None,
3839
- Annotated[StrictFloat, Field(gt=0)],
3840
- Tuple[
3841
- Annotated[StrictFloat, Field(gt=0)],
3842
- Annotated[StrictFloat, Field(gt=0)]
3843
- ]
3844
- ] = None,
3845
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
3846
- _content_type: Optional[StrictStr] = None,
3847
- _headers: Optional[Dict[StrictStr, Any]] = None,
3848
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3849
- ) -> RESTResponseType:
3850
- """Remove a role
3851
-
3852
- Remove a role for this object from users/groups.
3853
-
3854
- :param task_href: (required)
3855
- :type task_href: str
3856
- :param nested_role: (required)
3857
- :type nested_role: NestedRole
3858
- :param x_task_diagnostics: List of profilers to use on tasks.
3859
- :type x_task_diagnostics: List[str]
3860
- :param _request_timeout: timeout setting for this request. If one
3861
- number provided, it will be total request
3862
- timeout. It can also be a pair (tuple) of
3863
- (connection, read) timeouts.
3864
- :type _request_timeout: int, tuple(int, int), optional
3865
- :param _request_auth: set to override the auth_settings for an a single
3866
- request; this effectively ignores the
3867
- authentication in the spec for a single request.
3868
- :type _request_auth: dict, optional
3869
- :param _content_type: force content-type for the request.
3870
- :type _content_type: str, Optional
3871
- :param _headers: set to override the headers for a single
3872
- request; this effectively ignores the headers
3873
- in the spec for a single request.
3874
- :type _headers: dict, optional
3875
- :param _host_index: set to override the host_index for a single
3876
- request; this effectively ignores the host_index
3877
- in the spec for a single request.
3878
- :type _host_index: int, optional
3879
- :return: Returns the result object.
3880
- """ # noqa: E501
3881
-
3882
- _param = self._remove_role_serialize(
3883
- task_href=task_href,
3884
- nested_role=nested_role,
3885
- x_task_diagnostics=x_task_diagnostics,
3886
- _request_auth=_request_auth,
3887
- _content_type=_content_type,
3888
- _headers=_headers,
3889
- _host_index=_host_index
3890
- )
3891
-
3892
- _response_types_map: Dict[str, Optional[str]] = {
3893
- '201': "NestedRoleResponse",
3894
- }
3895
- response_data = self.api_client.call_api(
3896
- *_param,
3897
- _request_timeout=_request_timeout
3898
- )
3899
- return response_data.response
3900
-
3901
-
3902
- def _remove_role_serialize(
3903
- self,
3904
- task_href,
3905
- nested_role,
3906
- x_task_diagnostics,
3907
- _request_auth,
3908
- _content_type,
3909
- _headers,
3910
- _host_index,
3911
- ) -> RequestSerialized:
3912
-
3913
- _host = None
3914
-
3915
- _collection_formats: Dict[str, str] = {
3916
- 'X-Task-Diagnostics': 'csv',
3917
- }
3918
-
3919
- _path_params: Dict[str, str] = {}
3920
- _query_params: List[Tuple[str, str]] = []
3921
- _header_params: Dict[str, Optional[str]] = _headers or {}
3922
- _form_params: List[Tuple[str, str]] = []
3923
- _files: Dict[
3924
- str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
3925
- ] = {}
3926
- _body_params: Optional[bytes] = None
3927
-
3928
- # process the path parameters
3929
- if task_href is not None:
3930
- _path_params['task_href'] = task_href
3931
- # process the query parameters
3932
- # process the header parameters
3933
- if x_task_diagnostics is not None:
3934
- _header_params['X-Task-Diagnostics'] = x_task_diagnostics
3935
- # process the form parameters
3936
- # process the body parameter
3937
- if nested_role is not None:
3938
- _body_params = nested_role
3939
-
3940
-
3941
- # set the HTTP header `Accept`
3942
- if 'Accept' not in _header_params:
3943
- _header_params['Accept'] = self.api_client.select_header_accept(
3944
- [
3945
- 'application/json'
3946
- ]
3947
- )
3948
-
3949
- # set the HTTP header `Content-Type`
3950
- if _content_type:
3951
- _header_params['Content-Type'] = _content_type
3952
- else:
3953
- _default_content_type = (
3954
- self.api_client.select_header_content_type(
3955
- [
3956
- 'application/json',
3957
- 'application/x-www-form-urlencoded',
3958
- 'multipart/form-data'
3959
- ]
3960
- )
3961
- )
3962
- if _default_content_type is not None:
3963
- _header_params['Content-Type'] = _default_content_type
3964
-
3965
- # authentication setting
3966
- _auth_settings: List[str] = [
3967
- 'json_header_remote_authentication',
3968
- 'basicAuth',
3969
- 'cookieAuth'
3970
- ]
3971
-
3972
- return self.api_client.param_serialize(
3973
- method='POST',
3974
- resource_path='{task_href}remove_role/',
3975
- path_params=_path_params,
3976
- query_params=_query_params,
3977
- header_params=_header_params,
3978
- body=_body_params,
3979
- post_params=_form_params,
3980
- files=_files,
3981
- auth_settings=_auth_settings,
3982
- collection_formats=_collection_formats,
3983
- _host=_host,
3984
- _request_auth=_request_auth
3985
- )
3986
-
3987
-
3988
-
3989
-
3990
- @validate_call
3991
- def tasks_cancel(
3992
- self,
3993
- task_href: StrictStr,
3994
- patched_task_cancel: PatchedTaskCancel,
3995
- x_task_diagnostics: Annotated[Optional[List[StrictStr]], Field(description="List of profilers to use on tasks.")] = None,
3996
- _request_timeout: Union[
3997
- None,
3998
- Annotated[StrictFloat, Field(gt=0)],
3999
- Tuple[
4000
- Annotated[StrictFloat, Field(gt=0)],
4001
- Annotated[StrictFloat, Field(gt=0)]
4002
- ]
4003
- ] = None,
4004
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
4005
- _content_type: Optional[StrictStr] = None,
4006
- _headers: Optional[Dict[StrictStr, Any]] = None,
4007
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
4008
- ) -> TaskResponse:
4009
- """Cancel a task
4010
-
4011
- This operation cancels a task.
4012
-
4013
- :param task_href: (required)
4014
- :type task_href: str
4015
- :param patched_task_cancel: (required)
4016
- :type patched_task_cancel: PatchedTaskCancel
4017
- :param x_task_diagnostics: List of profilers to use on tasks.
4018
- :type x_task_diagnostics: List[str]
4019
- :param _request_timeout: timeout setting for this request. If one
4020
- number provided, it will be total request
4021
- timeout. It can also be a pair (tuple) of
4022
- (connection, read) timeouts.
4023
- :type _request_timeout: int, tuple(int, int), optional
4024
- :param _request_auth: set to override the auth_settings for an a single
4025
- request; this effectively ignores the
4026
- authentication in the spec for a single request.
4027
- :type _request_auth: dict, optional
4028
- :param _content_type: force content-type for the request.
4029
- :type _content_type: str, Optional
4030
- :param _headers: set to override the headers for a single
4031
- request; this effectively ignores the headers
4032
- in the spec for a single request.
4033
- :type _headers: dict, optional
4034
- :param _host_index: set to override the host_index for a single
4035
- request; this effectively ignores the host_index
4036
- in the spec for a single request.
4037
- :type _host_index: int, optional
4038
- :return: Returns the result object.
4039
- """ # noqa: E501
4040
-
4041
- _param = self._tasks_cancel_serialize(
4042
- task_href=task_href,
4043
- patched_task_cancel=patched_task_cancel,
4044
- x_task_diagnostics=x_task_diagnostics,
4045
- _request_auth=_request_auth,
4046
- _content_type=_content_type,
4047
- _headers=_headers,
4048
- _host_index=_host_index
4049
- )
4050
-
4051
- _response_types_map: Dict[str, Optional[str]] = {
4052
- '200': "TaskResponse",
4053
- '409': "TaskResponse",
4054
- }
4055
- response_data = self.api_client.call_api(
4056
- *_param,
4057
- _request_timeout=_request_timeout
4058
- )
4059
- response_data.read()
4060
- return self.api_client.response_deserialize(
4061
- response_data=response_data,
4062
- response_types_map=_response_types_map,
4063
- ).data
4064
-
4065
-
4066
- @validate_call
4067
- def tasks_cancel_with_http_info(
4068
- self,
4069
- task_href: StrictStr,
4070
- patched_task_cancel: PatchedTaskCancel,
4071
- x_task_diagnostics: Annotated[Optional[List[StrictStr]], Field(description="List of profilers to use on tasks.")] = None,
4072
- _request_timeout: Union[
4073
- None,
4074
- Annotated[StrictFloat, Field(gt=0)],
4075
- Tuple[
4076
- Annotated[StrictFloat, Field(gt=0)],
4077
- Annotated[StrictFloat, Field(gt=0)]
4078
- ]
4079
- ] = None,
4080
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
4081
- _content_type: Optional[StrictStr] = None,
4082
- _headers: Optional[Dict[StrictStr, Any]] = None,
4083
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
4084
- ) -> ApiResponse[TaskResponse]:
4085
- """Cancel a task
4086
-
4087
- This operation cancels a task.
4088
-
4089
- :param task_href: (required)
4090
- :type task_href: str
4091
- :param patched_task_cancel: (required)
4092
- :type patched_task_cancel: PatchedTaskCancel
4093
- :param x_task_diagnostics: List of profilers to use on tasks.
4094
- :type x_task_diagnostics: List[str]
4095
- :param _request_timeout: timeout setting for this request. If one
4096
- number provided, it will be total request
4097
- timeout. It can also be a pair (tuple) of
4098
- (connection, read) timeouts.
4099
- :type _request_timeout: int, tuple(int, int), optional
4100
- :param _request_auth: set to override the auth_settings for an a single
4101
- request; this effectively ignores the
4102
- authentication in the spec for a single request.
4103
- :type _request_auth: dict, optional
4104
- :param _content_type: force content-type for the request.
4105
- :type _content_type: str, Optional
4106
- :param _headers: set to override the headers for a single
4107
- request; this effectively ignores the headers
4108
- in the spec for a single request.
4109
- :type _headers: dict, optional
4110
- :param _host_index: set to override the host_index for a single
4111
- request; this effectively ignores the host_index
4112
- in the spec for a single request.
4113
- :type _host_index: int, optional
4114
- :return: Returns the result object.
4115
- """ # noqa: E501
4116
-
4117
- _param = self._tasks_cancel_serialize(
4118
- task_href=task_href,
4119
- patched_task_cancel=patched_task_cancel,
4120
- x_task_diagnostics=x_task_diagnostics,
4121
- _request_auth=_request_auth,
4122
- _content_type=_content_type,
4123
- _headers=_headers,
4124
- _host_index=_host_index
4125
- )
4126
-
4127
- _response_types_map: Dict[str, Optional[str]] = {
4128
- '200': "TaskResponse",
4129
- '409': "TaskResponse",
4130
- }
4131
- response_data = self.api_client.call_api(
4132
- *_param,
4133
- _request_timeout=_request_timeout
4134
- )
4135
- response_data.read()
4136
- return self.api_client.response_deserialize(
4137
- response_data=response_data,
4138
- response_types_map=_response_types_map,
4139
- )
4140
-
4141
-
4142
- @validate_call
4143
- def tasks_cancel_without_preload_content(
4144
- self,
4145
- task_href: StrictStr,
4146
- patched_task_cancel: PatchedTaskCancel,
4147
- x_task_diagnostics: Annotated[Optional[List[StrictStr]], Field(description="List of profilers to use on tasks.")] = None,
4148
- _request_timeout: Union[
4149
- None,
4150
- Annotated[StrictFloat, Field(gt=0)],
4151
- Tuple[
4152
- Annotated[StrictFloat, Field(gt=0)],
4153
- Annotated[StrictFloat, Field(gt=0)]
4154
- ]
4155
- ] = None,
4156
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
4157
- _content_type: Optional[StrictStr] = None,
4158
- _headers: Optional[Dict[StrictStr, Any]] = None,
4159
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
4160
- ) -> RESTResponseType:
4161
- """Cancel a task
4162
-
4163
- This operation cancels a task.
4164
-
4165
- :param task_href: (required)
4166
- :type task_href: str
4167
- :param patched_task_cancel: (required)
4168
- :type patched_task_cancel: PatchedTaskCancel
4169
- :param x_task_diagnostics: List of profilers to use on tasks.
4170
- :type x_task_diagnostics: List[str]
4171
- :param _request_timeout: timeout setting for this request. If one
4172
- number provided, it will be total request
4173
- timeout. It can also be a pair (tuple) of
4174
- (connection, read) timeouts.
4175
- :type _request_timeout: int, tuple(int, int), optional
4176
- :param _request_auth: set to override the auth_settings for an a single
4177
- request; this effectively ignores the
4178
- authentication in the spec for a single request.
4179
- :type _request_auth: dict, optional
4180
- :param _content_type: force content-type for the request.
4181
- :type _content_type: str, Optional
4182
- :param _headers: set to override the headers for a single
4183
- request; this effectively ignores the headers
4184
- in the spec for a single request.
4185
- :type _headers: dict, optional
4186
- :param _host_index: set to override the host_index for a single
4187
- request; this effectively ignores the host_index
4188
- in the spec for a single request.
4189
- :type _host_index: int, optional
4190
- :return: Returns the result object.
4191
- """ # noqa: E501
4192
-
4193
- _param = self._tasks_cancel_serialize(
4194
- task_href=task_href,
4195
- patched_task_cancel=patched_task_cancel,
4196
- x_task_diagnostics=x_task_diagnostics,
4197
- _request_auth=_request_auth,
4198
- _content_type=_content_type,
4199
- _headers=_headers,
4200
- _host_index=_host_index
4201
- )
4202
-
4203
- _response_types_map: Dict[str, Optional[str]] = {
4204
- '200': "TaskResponse",
4205
- '409': "TaskResponse",
4206
- }
4207
- response_data = self.api_client.call_api(
4208
- *_param,
4209
- _request_timeout=_request_timeout
4210
- )
4211
- return response_data.response
4212
-
4213
-
4214
- def _tasks_cancel_serialize(
4215
- self,
4216
- task_href,
4217
- patched_task_cancel,
4218
- x_task_diagnostics,
4219
- _request_auth,
4220
- _content_type,
4221
- _headers,
4222
- _host_index,
4223
- ) -> RequestSerialized:
4224
-
4225
- _host = None
4226
-
4227
- _collection_formats: Dict[str, str] = {
4228
- 'X-Task-Diagnostics': 'csv',
4229
- }
4230
-
4231
- _path_params: Dict[str, str] = {}
4232
- _query_params: List[Tuple[str, str]] = []
4233
- _header_params: Dict[str, Optional[str]] = _headers or {}
4234
- _form_params: List[Tuple[str, str]] = []
4235
- _files: Dict[
4236
- str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
4237
- ] = {}
4238
- _body_params: Optional[bytes] = None
4239
-
4240
- # process the path parameters
4241
- if task_href is not None:
4242
- _path_params['task_href'] = task_href
4243
- # process the query parameters
4244
- # process the header parameters
4245
- if x_task_diagnostics is not None:
4246
- _header_params['X-Task-Diagnostics'] = x_task_diagnostics
4247
- # process the form parameters
4248
- # process the body parameter
4249
- if patched_task_cancel is not None:
4250
- _body_params = patched_task_cancel
4251
-
4252
-
4253
- # set the HTTP header `Accept`
4254
- if 'Accept' not in _header_params:
4255
- _header_params['Accept'] = self.api_client.select_header_accept(
4256
- [
4257
- 'application/json'
4258
- ]
4259
- )
4260
-
4261
- # set the HTTP header `Content-Type`
4262
- if _content_type:
4263
- _header_params['Content-Type'] = _content_type
4264
- else:
4265
- _default_content_type = (
4266
- self.api_client.select_header_content_type(
4267
- [
4268
- 'application/json',
4269
- 'application/x-www-form-urlencoded',
4270
- 'multipart/form-data'
4271
- ]
4272
- )
4273
- )
4274
- if _default_content_type is not None:
4275
- _header_params['Content-Type'] = _default_content_type
4276
-
4277
- # authentication setting
4278
- _auth_settings: List[str] = [
4279
- 'json_header_remote_authentication',
4280
- 'basicAuth',
4281
- 'cookieAuth'
4282
- ]
4283
-
4284
- return self.api_client.param_serialize(
4285
- method='PATCH',
4286
- resource_path='{task_href}',
4287
- path_params=_path_params,
4288
- query_params=_query_params,
4289
- header_params=_header_params,
4290
- body=_body_params,
4291
- post_params=_form_params,
4292
- files=_files,
4293
- auth_settings=_auth_settings,
4294
- collection_formats=_collection_formats,
4295
- _host=_host,
4296
- _request_auth=_request_auth
4297
- )
4298
-
4299
-