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,1012 +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 pydantic import Field, StrictInt, StrictStr
21
- from typing import List, Optional
22
- from typing_extensions import Annotated
23
- from services-pulpcore-client.models.paginated_task_group_response_list import PaginatedTaskGroupResponseList
24
- from services-pulpcore-client.models.patched_task_cancel import PatchedTaskCancel
25
- from services-pulpcore-client.models.task_group_response import TaskGroupResponse
26
-
27
- from services-pulpcore-client.api_client import ApiClient, RequestSerialized
28
- from services-pulpcore-client.api_response import ApiResponse
29
- from services-pulpcore-client.rest import RESTResponseType
30
-
31
-
32
- class TaskGroupsApi:
33
- """NOTE: This class is auto generated by OpenAPI Generator
34
- Ref: https://openapi-generator.tech
35
-
36
- Do not edit the class manually.
37
- """
38
-
39
- def __init__(self, api_client=None) -> None:
40
- if api_client is None:
41
- api_client = ApiClient.get_default()
42
- self.api_client = api_client
43
-
44
-
45
- @validate_call
46
- def list(
47
- self,
48
- x_task_diagnostics: Annotated[Optional[List[StrictStr]], Field(description="List of profilers to use on tasks.")] = None,
49
- limit: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
50
- offset: Annotated[Optional[StrictInt], Field(description="The initial index from which to return the results.")] = None,
51
- fields: Annotated[Optional[List[StrictStr]], Field(description="A list of fields to include in the response.")] = None,
52
- exclude_fields: Annotated[Optional[List[StrictStr]], Field(description="A list of fields to exclude from the response.")] = None,
53
- pulp_domain: StrictStr = "default",
54
- _request_timeout: Union[
55
- None,
56
- Annotated[StrictFloat, Field(gt=0)],
57
- Tuple[
58
- Annotated[StrictFloat, Field(gt=0)],
59
- Annotated[StrictFloat, Field(gt=0)]
60
- ]
61
- ] = None,
62
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
63
- _content_type: Optional[StrictStr] = None,
64
- _headers: Optional[Dict[StrictStr, Any]] = None,
65
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
66
- ) -> PaginatedTaskGroupResponseList:
67
- """List task groups
68
-
69
-
70
- :param pulp_domain: (required)
71
- :type pulp_domain: str
72
- :param x_task_diagnostics: List of profilers to use on tasks.
73
- :type x_task_diagnostics: List[str]
74
- :param limit: Number of results to return per page.
75
- :type limit: int
76
- :param offset: The initial index from which to return the results.
77
- :type offset: int
78
- :param fields: A list of fields to include in the response.
79
- :type fields: List[str]
80
- :param exclude_fields: A list of fields to exclude from the response.
81
- :type exclude_fields: 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._list_serialize(
105
- pulp_domain=pulp_domain,
106
- x_task_diagnostics=x_task_diagnostics,
107
- limit=limit,
108
- offset=offset,
109
- fields=fields,
110
- exclude_fields=exclude_fields,
111
- _request_auth=_request_auth,
112
- _content_type=_content_type,
113
- _headers=_headers,
114
- _host_index=_host_index
115
- )
116
-
117
- _response_types_map: Dict[str, Optional[str]] = {
118
- '200': "PaginatedTaskGroupResponseList",
119
- }
120
- response_data = self.api_client.call_api(
121
- *_param,
122
- _request_timeout=_request_timeout
123
- )
124
- response_data.read()
125
- return self.api_client.response_deserialize(
126
- response_data=response_data,
127
- response_types_map=_response_types_map,
128
- ).data
129
-
130
-
131
- @validate_call
132
- def list_with_http_info(
133
- self,
134
- x_task_diagnostics: Annotated[Optional[List[StrictStr]], Field(description="List of profilers to use on tasks.")] = None,
135
- limit: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
136
- offset: Annotated[Optional[StrictInt], Field(description="The initial index from which to return the results.")] = None,
137
- fields: Annotated[Optional[List[StrictStr]], Field(description="A list of fields to include in the response.")] = None,
138
- exclude_fields: Annotated[Optional[List[StrictStr]], Field(description="A list of fields to exclude from the response.")] = None,
139
- pulp_domain: StrictStr = "default",
140
- _request_timeout: Union[
141
- None,
142
- Annotated[StrictFloat, Field(gt=0)],
143
- Tuple[
144
- Annotated[StrictFloat, Field(gt=0)],
145
- Annotated[StrictFloat, Field(gt=0)]
146
- ]
147
- ] = None,
148
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
149
- _content_type: Optional[StrictStr] = None,
150
- _headers: Optional[Dict[StrictStr, Any]] = None,
151
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
152
- ) -> ApiResponse[PaginatedTaskGroupResponseList]:
153
- """List task groups
154
-
155
-
156
- :param pulp_domain: (required)
157
- :type pulp_domain: str
158
- :param x_task_diagnostics: List of profilers to use on tasks.
159
- :type x_task_diagnostics: List[str]
160
- :param limit: Number of results to return per page.
161
- :type limit: int
162
- :param offset: The initial index from which to return the results.
163
- :type offset: int
164
- :param fields: A list of fields to include in the response.
165
- :type fields: List[str]
166
- :param exclude_fields: A list of fields to exclude from the response.
167
- :type exclude_fields: List[str]
168
- :param _request_timeout: timeout setting for this request. If one
169
- number provided, it will be total request
170
- timeout. It can also be a pair (tuple) of
171
- (connection, read) timeouts.
172
- :type _request_timeout: int, tuple(int, int), optional
173
- :param _request_auth: set to override the auth_settings for an a single
174
- request; this effectively ignores the
175
- authentication in the spec for a single request.
176
- :type _request_auth: dict, optional
177
- :param _content_type: force content-type for the request.
178
- :type _content_type: str, Optional
179
- :param _headers: set to override the headers for a single
180
- request; this effectively ignores the headers
181
- in the spec for a single request.
182
- :type _headers: dict, optional
183
- :param _host_index: set to override the host_index for a single
184
- request; this effectively ignores the host_index
185
- in the spec for a single request.
186
- :type _host_index: int, optional
187
- :return: Returns the result object.
188
- """ # noqa: E501
189
-
190
- _param = self._list_serialize(
191
- pulp_domain=pulp_domain,
192
- x_task_diagnostics=x_task_diagnostics,
193
- limit=limit,
194
- offset=offset,
195
- fields=fields,
196
- exclude_fields=exclude_fields,
197
- _request_auth=_request_auth,
198
- _content_type=_content_type,
199
- _headers=_headers,
200
- _host_index=_host_index
201
- )
202
-
203
- _response_types_map: Dict[str, Optional[str]] = {
204
- '200': "PaginatedTaskGroupResponseList",
205
- }
206
- response_data = self.api_client.call_api(
207
- *_param,
208
- _request_timeout=_request_timeout
209
- )
210
- response_data.read()
211
- return self.api_client.response_deserialize(
212
- response_data=response_data,
213
- response_types_map=_response_types_map,
214
- )
215
-
216
-
217
- @validate_call
218
- def list_without_preload_content(
219
- self,
220
- x_task_diagnostics: Annotated[Optional[List[StrictStr]], Field(description="List of profilers to use on tasks.")] = None,
221
- limit: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
222
- offset: Annotated[Optional[StrictInt], Field(description="The initial index from which to return the results.")] = None,
223
- fields: Annotated[Optional[List[StrictStr]], Field(description="A list of fields to include in the response.")] = None,
224
- exclude_fields: Annotated[Optional[List[StrictStr]], Field(description="A list of fields to exclude from the response.")] = None,
225
- pulp_domain: StrictStr = "default",
226
- _request_timeout: Union[
227
- None,
228
- Annotated[StrictFloat, Field(gt=0)],
229
- Tuple[
230
- Annotated[StrictFloat, Field(gt=0)],
231
- Annotated[StrictFloat, Field(gt=0)]
232
- ]
233
- ] = None,
234
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
235
- _content_type: Optional[StrictStr] = None,
236
- _headers: Optional[Dict[StrictStr, Any]] = None,
237
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
238
- ) -> RESTResponseType:
239
- """List task groups
240
-
241
-
242
- :param pulp_domain: (required)
243
- :type pulp_domain: str
244
- :param x_task_diagnostics: List of profilers to use on tasks.
245
- :type x_task_diagnostics: List[str]
246
- :param limit: Number of results to return per page.
247
- :type limit: int
248
- :param offset: The initial index from which to return the results.
249
- :type offset: int
250
- :param fields: A list of fields to include in the response.
251
- :type fields: List[str]
252
- :param exclude_fields: A list of fields to exclude from the response.
253
- :type exclude_fields: List[str]
254
- :param _request_timeout: timeout setting for this request. If one
255
- number provided, it will be total request
256
- timeout. It can also be a pair (tuple) of
257
- (connection, read) timeouts.
258
- :type _request_timeout: int, tuple(int, int), optional
259
- :param _request_auth: set to override the auth_settings for an a single
260
- request; this effectively ignores the
261
- authentication in the spec for a single request.
262
- :type _request_auth: dict, optional
263
- :param _content_type: force content-type for the request.
264
- :type _content_type: str, Optional
265
- :param _headers: set to override the headers for a single
266
- request; this effectively ignores the headers
267
- in the spec for a single request.
268
- :type _headers: dict, optional
269
- :param _host_index: set to override the host_index for a single
270
- request; this effectively ignores the host_index
271
- in the spec for a single request.
272
- :type _host_index: int, optional
273
- :return: Returns the result object.
274
- """ # noqa: E501
275
-
276
- _param = self._list_serialize(
277
- pulp_domain=pulp_domain,
278
- x_task_diagnostics=x_task_diagnostics,
279
- limit=limit,
280
- offset=offset,
281
- fields=fields,
282
- exclude_fields=exclude_fields,
283
- _request_auth=_request_auth,
284
- _content_type=_content_type,
285
- _headers=_headers,
286
- _host_index=_host_index
287
- )
288
-
289
- _response_types_map: Dict[str, Optional[str]] = {
290
- '200': "PaginatedTaskGroupResponseList",
291
- }
292
- response_data = self.api_client.call_api(
293
- *_param,
294
- _request_timeout=_request_timeout
295
- )
296
- return response_data.response
297
-
298
-
299
- def _list_serialize(
300
- self,
301
- pulp_domain,
302
- x_task_diagnostics,
303
- limit,
304
- offset,
305
- fields,
306
- exclude_fields,
307
- _request_auth,
308
- _content_type,
309
- _headers,
310
- _host_index,
311
- ) -> RequestSerialized:
312
-
313
- _host = None
314
-
315
- _collection_formats: Dict[str, str] = {
316
- 'X-Task-Diagnostics': 'csv',
317
- 'fields': 'multi',
318
- 'exclude_fields': 'multi',
319
- }
320
-
321
- _path_params: Dict[str, str] = {}
322
- _query_params: List[Tuple[str, str]] = []
323
- _header_params: Dict[str, Optional[str]] = _headers or {}
324
- _form_params: List[Tuple[str, str]] = []
325
- _files: Dict[
326
- str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
327
- ] = {}
328
- _body_params: Optional[bytes] = None
329
-
330
- # process the path parameters
331
- if pulp_domain is not None:
332
- _path_params['pulp_domain'] = pulp_domain
333
- # process the query parameters
334
- if limit is not None:
335
-
336
- _query_params.append(('limit', limit))
337
-
338
- if offset is not None:
339
-
340
- _query_params.append(('offset', offset))
341
-
342
- if fields is not None:
343
-
344
- _query_params.append(('fields', fields))
345
-
346
- if exclude_fields is not None:
347
-
348
- _query_params.append(('exclude_fields', exclude_fields))
349
-
350
- # process the header parameters
351
- if x_task_diagnostics is not None:
352
- _header_params['X-Task-Diagnostics'] = x_task_diagnostics
353
- # process the form parameters
354
- # process the body parameter
355
-
356
-
357
- # set the HTTP header `Accept`
358
- if 'Accept' not in _header_params:
359
- _header_params['Accept'] = self.api_client.select_header_accept(
360
- [
361
- 'application/json'
362
- ]
363
- )
364
-
365
-
366
- # authentication setting
367
- _auth_settings: List[str] = [
368
- 'json_header_remote_authentication',
369
- 'basicAuth',
370
- 'cookieAuth'
371
- ]
372
-
373
- return self.api_client.param_serialize(
374
- method='GET',
375
- resource_path='/api/pulp/{pulp_domain}/api/v3/task-groups/',
376
- path_params=_path_params,
377
- query_params=_query_params,
378
- header_params=_header_params,
379
- body=_body_params,
380
- post_params=_form_params,
381
- files=_files,
382
- auth_settings=_auth_settings,
383
- collection_formats=_collection_formats,
384
- _host=_host,
385
- _request_auth=_request_auth
386
- )
387
-
388
-
389
-
390
-
391
- @validate_call
392
- def read(
393
- self,
394
- task_group_href: StrictStr,
395
- x_task_diagnostics: Annotated[Optional[List[StrictStr]], Field(description="List of profilers to use on tasks.")] = None,
396
- fields: Annotated[Optional[List[StrictStr]], Field(description="A list of fields to include in the response.")] = None,
397
- exclude_fields: Annotated[Optional[List[StrictStr]], Field(description="A list of fields to exclude from the response.")] = None,
398
- _request_timeout: Union[
399
- None,
400
- Annotated[StrictFloat, Field(gt=0)],
401
- Tuple[
402
- Annotated[StrictFloat, Field(gt=0)],
403
- Annotated[StrictFloat, Field(gt=0)]
404
- ]
405
- ] = None,
406
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
407
- _content_type: Optional[StrictStr] = None,
408
- _headers: Optional[Dict[StrictStr, Any]] = None,
409
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
410
- ) -> TaskGroupResponse:
411
- """Inspect a task group
412
-
413
-
414
- :param task_group_href: (required)
415
- :type task_group_href: str
416
- :param x_task_diagnostics: List of profilers to use on tasks.
417
- :type x_task_diagnostics: List[str]
418
- :param fields: A list of fields to include in the response.
419
- :type fields: List[str]
420
- :param exclude_fields: A list of fields to exclude from the response.
421
- :type exclude_fields: List[str]
422
- :param _request_timeout: timeout setting for this request. If one
423
- number provided, it will be total request
424
- timeout. It can also be a pair (tuple) of
425
- (connection, read) timeouts.
426
- :type _request_timeout: int, tuple(int, int), optional
427
- :param _request_auth: set to override the auth_settings for an a single
428
- request; this effectively ignores the
429
- authentication in the spec for a single request.
430
- :type _request_auth: dict, optional
431
- :param _content_type: force content-type for the request.
432
- :type _content_type: str, Optional
433
- :param _headers: set to override the headers for a single
434
- request; this effectively ignores the headers
435
- in the spec for a single request.
436
- :type _headers: dict, optional
437
- :param _host_index: set to override the host_index for a single
438
- request; this effectively ignores the host_index
439
- in the spec for a single request.
440
- :type _host_index: int, optional
441
- :return: Returns the result object.
442
- """ # noqa: E501
443
-
444
- _param = self._read_serialize(
445
- task_group_href=task_group_href,
446
- x_task_diagnostics=x_task_diagnostics,
447
- fields=fields,
448
- exclude_fields=exclude_fields,
449
- _request_auth=_request_auth,
450
- _content_type=_content_type,
451
- _headers=_headers,
452
- _host_index=_host_index
453
- )
454
-
455
- _response_types_map: Dict[str, Optional[str]] = {
456
- '200': "TaskGroupResponse",
457
- }
458
- response_data = self.api_client.call_api(
459
- *_param,
460
- _request_timeout=_request_timeout
461
- )
462
- response_data.read()
463
- return self.api_client.response_deserialize(
464
- response_data=response_data,
465
- response_types_map=_response_types_map,
466
- ).data
467
-
468
-
469
- @validate_call
470
- def read_with_http_info(
471
- self,
472
- task_group_href: StrictStr,
473
- x_task_diagnostics: Annotated[Optional[List[StrictStr]], Field(description="List of profilers to use on tasks.")] = None,
474
- fields: Annotated[Optional[List[StrictStr]], Field(description="A list of fields to include in the response.")] = None,
475
- exclude_fields: Annotated[Optional[List[StrictStr]], Field(description="A list of fields to exclude from the response.")] = None,
476
- _request_timeout: Union[
477
- None,
478
- Annotated[StrictFloat, Field(gt=0)],
479
- Tuple[
480
- Annotated[StrictFloat, Field(gt=0)],
481
- Annotated[StrictFloat, Field(gt=0)]
482
- ]
483
- ] = None,
484
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
485
- _content_type: Optional[StrictStr] = None,
486
- _headers: Optional[Dict[StrictStr, Any]] = None,
487
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
488
- ) -> ApiResponse[TaskGroupResponse]:
489
- """Inspect a task group
490
-
491
-
492
- :param task_group_href: (required)
493
- :type task_group_href: str
494
- :param x_task_diagnostics: List of profilers to use on tasks.
495
- :type x_task_diagnostics: List[str]
496
- :param fields: A list of fields to include in the response.
497
- :type fields: List[str]
498
- :param exclude_fields: A list of fields to exclude from the response.
499
- :type exclude_fields: List[str]
500
- :param _request_timeout: timeout setting for this request. If one
501
- number provided, it will be total request
502
- timeout. It can also be a pair (tuple) of
503
- (connection, read) timeouts.
504
- :type _request_timeout: int, tuple(int, int), optional
505
- :param _request_auth: set to override the auth_settings for an a single
506
- request; this effectively ignores the
507
- authentication in the spec for a single request.
508
- :type _request_auth: dict, optional
509
- :param _content_type: force content-type for the request.
510
- :type _content_type: str, Optional
511
- :param _headers: set to override the headers for a single
512
- request; this effectively ignores the headers
513
- in the spec for a single request.
514
- :type _headers: dict, optional
515
- :param _host_index: set to override the host_index for a single
516
- request; this effectively ignores the host_index
517
- in the spec for a single request.
518
- :type _host_index: int, optional
519
- :return: Returns the result object.
520
- """ # noqa: E501
521
-
522
- _param = self._read_serialize(
523
- task_group_href=task_group_href,
524
- x_task_diagnostics=x_task_diagnostics,
525
- fields=fields,
526
- exclude_fields=exclude_fields,
527
- _request_auth=_request_auth,
528
- _content_type=_content_type,
529
- _headers=_headers,
530
- _host_index=_host_index
531
- )
532
-
533
- _response_types_map: Dict[str, Optional[str]] = {
534
- '200': "TaskGroupResponse",
535
- }
536
- response_data = self.api_client.call_api(
537
- *_param,
538
- _request_timeout=_request_timeout
539
- )
540
- response_data.read()
541
- return self.api_client.response_deserialize(
542
- response_data=response_data,
543
- response_types_map=_response_types_map,
544
- )
545
-
546
-
547
- @validate_call
548
- def read_without_preload_content(
549
- self,
550
- task_group_href: StrictStr,
551
- x_task_diagnostics: Annotated[Optional[List[StrictStr]], Field(description="List of profilers to use on tasks.")] = None,
552
- fields: Annotated[Optional[List[StrictStr]], Field(description="A list of fields to include in the response.")] = None,
553
- exclude_fields: Annotated[Optional[List[StrictStr]], Field(description="A list of fields to exclude from the response.")] = None,
554
- _request_timeout: Union[
555
- None,
556
- Annotated[StrictFloat, Field(gt=0)],
557
- Tuple[
558
- Annotated[StrictFloat, Field(gt=0)],
559
- Annotated[StrictFloat, Field(gt=0)]
560
- ]
561
- ] = None,
562
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
563
- _content_type: Optional[StrictStr] = None,
564
- _headers: Optional[Dict[StrictStr, Any]] = None,
565
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
566
- ) -> RESTResponseType:
567
- """Inspect a task group
568
-
569
-
570
- :param task_group_href: (required)
571
- :type task_group_href: str
572
- :param x_task_diagnostics: List of profilers to use on tasks.
573
- :type x_task_diagnostics: List[str]
574
- :param fields: A list of fields to include in the response.
575
- :type fields: List[str]
576
- :param exclude_fields: A list of fields to exclude from the response.
577
- :type exclude_fields: List[str]
578
- :param _request_timeout: timeout setting for this request. If one
579
- number provided, it will be total request
580
- timeout. It can also be a pair (tuple) of
581
- (connection, read) timeouts.
582
- :type _request_timeout: int, tuple(int, int), optional
583
- :param _request_auth: set to override the auth_settings for an a single
584
- request; this effectively ignores the
585
- authentication in the spec for a single request.
586
- :type _request_auth: dict, optional
587
- :param _content_type: force content-type for the request.
588
- :type _content_type: str, Optional
589
- :param _headers: set to override the headers for a single
590
- request; this effectively ignores the headers
591
- in the spec for a single request.
592
- :type _headers: dict, optional
593
- :param _host_index: set to override the host_index for a single
594
- request; this effectively ignores the host_index
595
- in the spec for a single request.
596
- :type _host_index: int, optional
597
- :return: Returns the result object.
598
- """ # noqa: E501
599
-
600
- _param = self._read_serialize(
601
- task_group_href=task_group_href,
602
- x_task_diagnostics=x_task_diagnostics,
603
- fields=fields,
604
- exclude_fields=exclude_fields,
605
- _request_auth=_request_auth,
606
- _content_type=_content_type,
607
- _headers=_headers,
608
- _host_index=_host_index
609
- )
610
-
611
- _response_types_map: Dict[str, Optional[str]] = {
612
- '200': "TaskGroupResponse",
613
- }
614
- response_data = self.api_client.call_api(
615
- *_param,
616
- _request_timeout=_request_timeout
617
- )
618
- return response_data.response
619
-
620
-
621
- def _read_serialize(
622
- self,
623
- task_group_href,
624
- x_task_diagnostics,
625
- fields,
626
- exclude_fields,
627
- _request_auth,
628
- _content_type,
629
- _headers,
630
- _host_index,
631
- ) -> RequestSerialized:
632
-
633
- _host = None
634
-
635
- _collection_formats: Dict[str, str] = {
636
- 'X-Task-Diagnostics': 'csv',
637
- 'fields': 'multi',
638
- 'exclude_fields': 'multi',
639
- }
640
-
641
- _path_params: Dict[str, str] = {}
642
- _query_params: List[Tuple[str, str]] = []
643
- _header_params: Dict[str, Optional[str]] = _headers or {}
644
- _form_params: List[Tuple[str, str]] = []
645
- _files: Dict[
646
- str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
647
- ] = {}
648
- _body_params: Optional[bytes] = None
649
-
650
- # process the path parameters
651
- if task_group_href is not None:
652
- _path_params['task_group_href'] = task_group_href
653
- # process the query parameters
654
- if fields is not None:
655
-
656
- _query_params.append(('fields', fields))
657
-
658
- if exclude_fields is not None:
659
-
660
- _query_params.append(('exclude_fields', exclude_fields))
661
-
662
- # process the header parameters
663
- if x_task_diagnostics is not None:
664
- _header_params['X-Task-Diagnostics'] = x_task_diagnostics
665
- # process the form parameters
666
- # process the body parameter
667
-
668
-
669
- # set the HTTP header `Accept`
670
- if 'Accept' not in _header_params:
671
- _header_params['Accept'] = self.api_client.select_header_accept(
672
- [
673
- 'application/json'
674
- ]
675
- )
676
-
677
-
678
- # authentication setting
679
- _auth_settings: List[str] = [
680
- 'json_header_remote_authentication',
681
- 'basicAuth',
682
- 'cookieAuth'
683
- ]
684
-
685
- return self.api_client.param_serialize(
686
- method='GET',
687
- resource_path='{task_group_href}',
688
- path_params=_path_params,
689
- query_params=_query_params,
690
- header_params=_header_params,
691
- body=_body_params,
692
- post_params=_form_params,
693
- files=_files,
694
- auth_settings=_auth_settings,
695
- collection_formats=_collection_formats,
696
- _host=_host,
697
- _request_auth=_request_auth
698
- )
699
-
700
-
701
-
702
-
703
- @validate_call
704
- def task_groups_cancel(
705
- self,
706
- task_group_href: StrictStr,
707
- patched_task_cancel: PatchedTaskCancel,
708
- x_task_diagnostics: Annotated[Optional[List[StrictStr]], Field(description="List of profilers to use on tasks.")] = None,
709
- _request_timeout: Union[
710
- None,
711
- Annotated[StrictFloat, Field(gt=0)],
712
- Tuple[
713
- Annotated[StrictFloat, Field(gt=0)],
714
- Annotated[StrictFloat, Field(gt=0)]
715
- ]
716
- ] = None,
717
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
718
- _content_type: Optional[StrictStr] = None,
719
- _headers: Optional[Dict[StrictStr, Any]] = None,
720
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
721
- ) -> TaskGroupResponse:
722
- """Cancel a task group
723
-
724
- This operation cancels a task group.
725
-
726
- :param task_group_href: (required)
727
- :type task_group_href: str
728
- :param patched_task_cancel: (required)
729
- :type patched_task_cancel: PatchedTaskCancel
730
- :param x_task_diagnostics: List of profilers to use on tasks.
731
- :type x_task_diagnostics: List[str]
732
- :param _request_timeout: timeout setting for this request. If one
733
- number provided, it will be total request
734
- timeout. It can also be a pair (tuple) of
735
- (connection, read) timeouts.
736
- :type _request_timeout: int, tuple(int, int), optional
737
- :param _request_auth: set to override the auth_settings for an a single
738
- request; this effectively ignores the
739
- authentication in the spec for a single request.
740
- :type _request_auth: dict, optional
741
- :param _content_type: force content-type for the request.
742
- :type _content_type: str, Optional
743
- :param _headers: set to override the headers for a single
744
- request; this effectively ignores the headers
745
- in the spec for a single request.
746
- :type _headers: dict, optional
747
- :param _host_index: set to override the host_index for a single
748
- request; this effectively ignores the host_index
749
- in the spec for a single request.
750
- :type _host_index: int, optional
751
- :return: Returns the result object.
752
- """ # noqa: E501
753
-
754
- _param = self._task_groups_cancel_serialize(
755
- task_group_href=task_group_href,
756
- patched_task_cancel=patched_task_cancel,
757
- x_task_diagnostics=x_task_diagnostics,
758
- _request_auth=_request_auth,
759
- _content_type=_content_type,
760
- _headers=_headers,
761
- _host_index=_host_index
762
- )
763
-
764
- _response_types_map: Dict[str, Optional[str]] = {
765
- '200': "TaskGroupResponse",
766
- '409': "TaskGroupResponse",
767
- }
768
- response_data = self.api_client.call_api(
769
- *_param,
770
- _request_timeout=_request_timeout
771
- )
772
- response_data.read()
773
- return self.api_client.response_deserialize(
774
- response_data=response_data,
775
- response_types_map=_response_types_map,
776
- ).data
777
-
778
-
779
- @validate_call
780
- def task_groups_cancel_with_http_info(
781
- self,
782
- task_group_href: StrictStr,
783
- patched_task_cancel: PatchedTaskCancel,
784
- x_task_diagnostics: Annotated[Optional[List[StrictStr]], Field(description="List of profilers to use on tasks.")] = None,
785
- _request_timeout: Union[
786
- None,
787
- Annotated[StrictFloat, Field(gt=0)],
788
- Tuple[
789
- Annotated[StrictFloat, Field(gt=0)],
790
- Annotated[StrictFloat, Field(gt=0)]
791
- ]
792
- ] = None,
793
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
794
- _content_type: Optional[StrictStr] = None,
795
- _headers: Optional[Dict[StrictStr, Any]] = None,
796
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
797
- ) -> ApiResponse[TaskGroupResponse]:
798
- """Cancel a task group
799
-
800
- This operation cancels a task group.
801
-
802
- :param task_group_href: (required)
803
- :type task_group_href: str
804
- :param patched_task_cancel: (required)
805
- :type patched_task_cancel: PatchedTaskCancel
806
- :param x_task_diagnostics: List of profilers to use on tasks.
807
- :type x_task_diagnostics: List[str]
808
- :param _request_timeout: timeout setting for this request. If one
809
- number provided, it will be total request
810
- timeout. It can also be a pair (tuple) of
811
- (connection, read) timeouts.
812
- :type _request_timeout: int, tuple(int, int), optional
813
- :param _request_auth: set to override the auth_settings for an a single
814
- request; this effectively ignores the
815
- authentication in the spec for a single request.
816
- :type _request_auth: dict, optional
817
- :param _content_type: force content-type for the request.
818
- :type _content_type: str, Optional
819
- :param _headers: set to override the headers for a single
820
- request; this effectively ignores the headers
821
- in the spec for a single request.
822
- :type _headers: dict, optional
823
- :param _host_index: set to override the host_index for a single
824
- request; this effectively ignores the host_index
825
- in the spec for a single request.
826
- :type _host_index: int, optional
827
- :return: Returns the result object.
828
- """ # noqa: E501
829
-
830
- _param = self._task_groups_cancel_serialize(
831
- task_group_href=task_group_href,
832
- patched_task_cancel=patched_task_cancel,
833
- x_task_diagnostics=x_task_diagnostics,
834
- _request_auth=_request_auth,
835
- _content_type=_content_type,
836
- _headers=_headers,
837
- _host_index=_host_index
838
- )
839
-
840
- _response_types_map: Dict[str, Optional[str]] = {
841
- '200': "TaskGroupResponse",
842
- '409': "TaskGroupResponse",
843
- }
844
- response_data = self.api_client.call_api(
845
- *_param,
846
- _request_timeout=_request_timeout
847
- )
848
- response_data.read()
849
- return self.api_client.response_deserialize(
850
- response_data=response_data,
851
- response_types_map=_response_types_map,
852
- )
853
-
854
-
855
- @validate_call
856
- def task_groups_cancel_without_preload_content(
857
- self,
858
- task_group_href: StrictStr,
859
- patched_task_cancel: PatchedTaskCancel,
860
- x_task_diagnostics: Annotated[Optional[List[StrictStr]], Field(description="List of profilers to use on tasks.")] = None,
861
- _request_timeout: Union[
862
- None,
863
- Annotated[StrictFloat, Field(gt=0)],
864
- Tuple[
865
- Annotated[StrictFloat, Field(gt=0)],
866
- Annotated[StrictFloat, Field(gt=0)]
867
- ]
868
- ] = None,
869
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
870
- _content_type: Optional[StrictStr] = None,
871
- _headers: Optional[Dict[StrictStr, Any]] = None,
872
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
873
- ) -> RESTResponseType:
874
- """Cancel a task group
875
-
876
- This operation cancels a task group.
877
-
878
- :param task_group_href: (required)
879
- :type task_group_href: str
880
- :param patched_task_cancel: (required)
881
- :type patched_task_cancel: PatchedTaskCancel
882
- :param x_task_diagnostics: List of profilers to use on tasks.
883
- :type x_task_diagnostics: List[str]
884
- :param _request_timeout: timeout setting for this request. If one
885
- number provided, it will be total request
886
- timeout. It can also be a pair (tuple) of
887
- (connection, read) timeouts.
888
- :type _request_timeout: int, tuple(int, int), optional
889
- :param _request_auth: set to override the auth_settings for an a single
890
- request; this effectively ignores the
891
- authentication in the spec for a single request.
892
- :type _request_auth: dict, optional
893
- :param _content_type: force content-type for the request.
894
- :type _content_type: str, Optional
895
- :param _headers: set to override the headers for a single
896
- request; this effectively ignores the headers
897
- in the spec for a single request.
898
- :type _headers: dict, optional
899
- :param _host_index: set to override the host_index for a single
900
- request; this effectively ignores the host_index
901
- in the spec for a single request.
902
- :type _host_index: int, optional
903
- :return: Returns the result object.
904
- """ # noqa: E501
905
-
906
- _param = self._task_groups_cancel_serialize(
907
- task_group_href=task_group_href,
908
- patched_task_cancel=patched_task_cancel,
909
- x_task_diagnostics=x_task_diagnostics,
910
- _request_auth=_request_auth,
911
- _content_type=_content_type,
912
- _headers=_headers,
913
- _host_index=_host_index
914
- )
915
-
916
- _response_types_map: Dict[str, Optional[str]] = {
917
- '200': "TaskGroupResponse",
918
- '409': "TaskGroupResponse",
919
- }
920
- response_data = self.api_client.call_api(
921
- *_param,
922
- _request_timeout=_request_timeout
923
- )
924
- return response_data.response
925
-
926
-
927
- def _task_groups_cancel_serialize(
928
- self,
929
- task_group_href,
930
- patched_task_cancel,
931
- x_task_diagnostics,
932
- _request_auth,
933
- _content_type,
934
- _headers,
935
- _host_index,
936
- ) -> RequestSerialized:
937
-
938
- _host = None
939
-
940
- _collection_formats: Dict[str, str] = {
941
- 'X-Task-Diagnostics': 'csv',
942
- }
943
-
944
- _path_params: Dict[str, str] = {}
945
- _query_params: List[Tuple[str, str]] = []
946
- _header_params: Dict[str, Optional[str]] = _headers or {}
947
- _form_params: List[Tuple[str, str]] = []
948
- _files: Dict[
949
- str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
950
- ] = {}
951
- _body_params: Optional[bytes] = None
952
-
953
- # process the path parameters
954
- if task_group_href is not None:
955
- _path_params['task_group_href'] = task_group_href
956
- # process the query parameters
957
- # process the header parameters
958
- if x_task_diagnostics is not None:
959
- _header_params['X-Task-Diagnostics'] = x_task_diagnostics
960
- # process the form parameters
961
- # process the body parameter
962
- if patched_task_cancel is not None:
963
- _body_params = patched_task_cancel
964
-
965
-
966
- # set the HTTP header `Accept`
967
- if 'Accept' not in _header_params:
968
- _header_params['Accept'] = self.api_client.select_header_accept(
969
- [
970
- 'application/json'
971
- ]
972
- )
973
-
974
- # set the HTTP header `Content-Type`
975
- if _content_type:
976
- _header_params['Content-Type'] = _content_type
977
- else:
978
- _default_content_type = (
979
- self.api_client.select_header_content_type(
980
- [
981
- 'application/json',
982
- 'application/x-www-form-urlencoded',
983
- 'multipart/form-data'
984
- ]
985
- )
986
- )
987
- if _default_content_type is not None:
988
- _header_params['Content-Type'] = _default_content_type
989
-
990
- # authentication setting
991
- _auth_settings: List[str] = [
992
- 'json_header_remote_authentication',
993
- 'basicAuth',
994
- 'cookieAuth'
995
- ]
996
-
997
- return self.api_client.param_serialize(
998
- method='PATCH',
999
- resource_path='{task_group_href}',
1000
- path_params=_path_params,
1001
- query_params=_query_params,
1002
- header_params=_header_params,
1003
- body=_body_params,
1004
- post_params=_form_params,
1005
- files=_files,
1006
- auth_settings=_auth_settings,
1007
- collection_formats=_collection_formats,
1008
- _host=_host,
1009
- _request_auth=_request_auth
1010
- )
1011
-
1012
-