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,2114 +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, field_validator
21
- from typing import List, Optional
22
- from typing_extensions import Annotated
23
- from services-pulpcore-client.models.my_permissions_response import MyPermissionsResponse
24
- from services-pulpcore-client.models.nested_role import NestedRole
25
- from services-pulpcore-client.models.nested_role_response import NestedRoleResponse
26
- from services-pulpcore-client.models.object_roles_response import ObjectRolesResponse
27
- from services-pulpcore-client.models.paginated_task_schedule_response_list import PaginatedTaskScheduleResponseList
28
- from services-pulpcore-client.models.task_schedule_response import TaskScheduleResponse
29
-
30
- from services-pulpcore-client.api_client import ApiClient, RequestSerialized
31
- from services-pulpcore-client.api_response import ApiResponse
32
- from services-pulpcore-client.rest import RESTResponseType
33
-
34
-
35
- class TaskSchedulesApi:
36
- """NOTE: This class is auto generated by OpenAPI Generator
37
- Ref: https://openapi-generator.tech
38
-
39
- Do not edit the class manually.
40
- """
41
-
42
- def __init__(self, api_client=None) -> None:
43
- if api_client is None:
44
- api_client = ApiClient.get_default()
45
- self.api_client = api_client
46
-
47
-
48
- @validate_call
49
- def add_role(
50
- self,
51
- task_schedule_href: StrictStr,
52
- nested_role: NestedRole,
53
- x_task_diagnostics: Annotated[Optional[List[StrictStr]], Field(description="List of profilers to use on tasks.")] = None,
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
- ) -> NestedRoleResponse:
67
- """Add a role
68
-
69
- Add a role for this object to users/groups.
70
-
71
- :param task_schedule_href: (required)
72
- :type task_schedule_href: str
73
- :param nested_role: (required)
74
- :type nested_role: NestedRole
75
- :param x_task_diagnostics: List of profilers to use on tasks.
76
- :type x_task_diagnostics: List[str]
77
- :param _request_timeout: timeout setting for this request. If one
78
- number provided, it will be total request
79
- timeout. It can also be a pair (tuple) of
80
- (connection, read) timeouts.
81
- :type _request_timeout: int, tuple(int, int), optional
82
- :param _request_auth: set to override the auth_settings for an a single
83
- request; this effectively ignores the
84
- authentication in the spec for a single request.
85
- :type _request_auth: dict, optional
86
- :param _content_type: force content-type for the request.
87
- :type _content_type: str, Optional
88
- :param _headers: set to override the headers for a single
89
- request; this effectively ignores the headers
90
- in the spec for a single request.
91
- :type _headers: dict, optional
92
- :param _host_index: set to override the host_index for a single
93
- request; this effectively ignores the host_index
94
- in the spec for a single request.
95
- :type _host_index: int, optional
96
- :return: Returns the result object.
97
- """ # noqa: E501
98
-
99
- _param = self._add_role_serialize(
100
- task_schedule_href=task_schedule_href,
101
- nested_role=nested_role,
102
- x_task_diagnostics=x_task_diagnostics,
103
- _request_auth=_request_auth,
104
- _content_type=_content_type,
105
- _headers=_headers,
106
- _host_index=_host_index
107
- )
108
-
109
- _response_types_map: Dict[str, Optional[str]] = {
110
- '201': "NestedRoleResponse",
111
- }
112
- response_data = self.api_client.call_api(
113
- *_param,
114
- _request_timeout=_request_timeout
115
- )
116
- response_data.read()
117
- return self.api_client.response_deserialize(
118
- response_data=response_data,
119
- response_types_map=_response_types_map,
120
- ).data
121
-
122
-
123
- @validate_call
124
- def add_role_with_http_info(
125
- self,
126
- task_schedule_href: StrictStr,
127
- nested_role: NestedRole,
128
- x_task_diagnostics: Annotated[Optional[List[StrictStr]], Field(description="List of profilers to use on tasks.")] = None,
129
- _request_timeout: Union[
130
- None,
131
- Annotated[StrictFloat, Field(gt=0)],
132
- Tuple[
133
- Annotated[StrictFloat, Field(gt=0)],
134
- Annotated[StrictFloat, Field(gt=0)]
135
- ]
136
- ] = None,
137
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
138
- _content_type: Optional[StrictStr] = None,
139
- _headers: Optional[Dict[StrictStr, Any]] = None,
140
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
141
- ) -> ApiResponse[NestedRoleResponse]:
142
- """Add a role
143
-
144
- Add a role for this object to users/groups.
145
-
146
- :param task_schedule_href: (required)
147
- :type task_schedule_href: str
148
- :param nested_role: (required)
149
- :type nested_role: NestedRole
150
- :param x_task_diagnostics: List of profilers to use on tasks.
151
- :type x_task_diagnostics: List[str]
152
- :param _request_timeout: timeout setting for this request. If one
153
- number provided, it will be total request
154
- timeout. It can also be a pair (tuple) of
155
- (connection, read) timeouts.
156
- :type _request_timeout: int, tuple(int, int), optional
157
- :param _request_auth: set to override the auth_settings for an a single
158
- request; this effectively ignores the
159
- authentication in the spec for a single request.
160
- :type _request_auth: dict, optional
161
- :param _content_type: force content-type for the request.
162
- :type _content_type: str, Optional
163
- :param _headers: set to override the headers for a single
164
- request; this effectively ignores the headers
165
- in the spec for a single request.
166
- :type _headers: dict, optional
167
- :param _host_index: set to override the host_index for a single
168
- request; this effectively ignores the host_index
169
- in the spec for a single request.
170
- :type _host_index: int, optional
171
- :return: Returns the result object.
172
- """ # noqa: E501
173
-
174
- _param = self._add_role_serialize(
175
- task_schedule_href=task_schedule_href,
176
- nested_role=nested_role,
177
- x_task_diagnostics=x_task_diagnostics,
178
- _request_auth=_request_auth,
179
- _content_type=_content_type,
180
- _headers=_headers,
181
- _host_index=_host_index
182
- )
183
-
184
- _response_types_map: Dict[str, Optional[str]] = {
185
- '201': "NestedRoleResponse",
186
- }
187
- response_data = self.api_client.call_api(
188
- *_param,
189
- _request_timeout=_request_timeout
190
- )
191
- response_data.read()
192
- return self.api_client.response_deserialize(
193
- response_data=response_data,
194
- response_types_map=_response_types_map,
195
- )
196
-
197
-
198
- @validate_call
199
- def add_role_without_preload_content(
200
- self,
201
- task_schedule_href: StrictStr,
202
- nested_role: NestedRole,
203
- x_task_diagnostics: Annotated[Optional[List[StrictStr]], Field(description="List of profilers to use on tasks.")] = None,
204
- _request_timeout: Union[
205
- None,
206
- Annotated[StrictFloat, Field(gt=0)],
207
- Tuple[
208
- Annotated[StrictFloat, Field(gt=0)],
209
- Annotated[StrictFloat, Field(gt=0)]
210
- ]
211
- ] = None,
212
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
213
- _content_type: Optional[StrictStr] = None,
214
- _headers: Optional[Dict[StrictStr, Any]] = None,
215
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
216
- ) -> RESTResponseType:
217
- """Add a role
218
-
219
- Add a role for this object to users/groups.
220
-
221
- :param task_schedule_href: (required)
222
- :type task_schedule_href: str
223
- :param nested_role: (required)
224
- :type nested_role: NestedRole
225
- :param x_task_diagnostics: List of profilers to use on tasks.
226
- :type x_task_diagnostics: List[str]
227
- :param _request_timeout: timeout setting for this request. If one
228
- number provided, it will be total request
229
- timeout. It can also be a pair (tuple) of
230
- (connection, read) timeouts.
231
- :type _request_timeout: int, tuple(int, int), optional
232
- :param _request_auth: set to override the auth_settings for an a single
233
- request; this effectively ignores the
234
- authentication in the spec for a single request.
235
- :type _request_auth: dict, optional
236
- :param _content_type: force content-type for the request.
237
- :type _content_type: str, Optional
238
- :param _headers: set to override the headers for a single
239
- request; this effectively ignores the headers
240
- in the spec for a single request.
241
- :type _headers: dict, optional
242
- :param _host_index: set to override the host_index for a single
243
- request; this effectively ignores the host_index
244
- in the spec for a single request.
245
- :type _host_index: int, optional
246
- :return: Returns the result object.
247
- """ # noqa: E501
248
-
249
- _param = self._add_role_serialize(
250
- task_schedule_href=task_schedule_href,
251
- nested_role=nested_role,
252
- x_task_diagnostics=x_task_diagnostics,
253
- _request_auth=_request_auth,
254
- _content_type=_content_type,
255
- _headers=_headers,
256
- _host_index=_host_index
257
- )
258
-
259
- _response_types_map: Dict[str, Optional[str]] = {
260
- '201': "NestedRoleResponse",
261
- }
262
- response_data = self.api_client.call_api(
263
- *_param,
264
- _request_timeout=_request_timeout
265
- )
266
- return response_data.response
267
-
268
-
269
- def _add_role_serialize(
270
- self,
271
- task_schedule_href,
272
- nested_role,
273
- x_task_diagnostics,
274
- _request_auth,
275
- _content_type,
276
- _headers,
277
- _host_index,
278
- ) -> RequestSerialized:
279
-
280
- _host = None
281
-
282
- _collection_formats: Dict[str, str] = {
283
- 'X-Task-Diagnostics': 'csv',
284
- }
285
-
286
- _path_params: Dict[str, str] = {}
287
- _query_params: List[Tuple[str, str]] = []
288
- _header_params: Dict[str, Optional[str]] = _headers or {}
289
- _form_params: List[Tuple[str, str]] = []
290
- _files: Dict[
291
- str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
292
- ] = {}
293
- _body_params: Optional[bytes] = None
294
-
295
- # process the path parameters
296
- if task_schedule_href is not None:
297
- _path_params['task_schedule_href'] = task_schedule_href
298
- # process the query parameters
299
- # process the header parameters
300
- if x_task_diagnostics is not None:
301
- _header_params['X-Task-Diagnostics'] = x_task_diagnostics
302
- # process the form parameters
303
- # process the body parameter
304
- if nested_role is not None:
305
- _body_params = nested_role
306
-
307
-
308
- # set the HTTP header `Accept`
309
- if 'Accept' not in _header_params:
310
- _header_params['Accept'] = self.api_client.select_header_accept(
311
- [
312
- 'application/json'
313
- ]
314
- )
315
-
316
- # set the HTTP header `Content-Type`
317
- if _content_type:
318
- _header_params['Content-Type'] = _content_type
319
- else:
320
- _default_content_type = (
321
- self.api_client.select_header_content_type(
322
- [
323
- 'application/json',
324
- 'application/x-www-form-urlencoded',
325
- 'multipart/form-data'
326
- ]
327
- )
328
- )
329
- if _default_content_type is not None:
330
- _header_params['Content-Type'] = _default_content_type
331
-
332
- # authentication setting
333
- _auth_settings: List[str] = [
334
- 'json_header_remote_authentication',
335
- 'basicAuth',
336
- 'cookieAuth'
337
- ]
338
-
339
- return self.api_client.param_serialize(
340
- method='POST',
341
- resource_path='{task_schedule_href}add_role/',
342
- path_params=_path_params,
343
- query_params=_query_params,
344
- header_params=_header_params,
345
- body=_body_params,
346
- post_params=_form_params,
347
- files=_files,
348
- auth_settings=_auth_settings,
349
- collection_formats=_collection_formats,
350
- _host=_host,
351
- _request_auth=_request_auth
352
- )
353
-
354
-
355
-
356
-
357
- @validate_call
358
- def list(
359
- self,
360
- x_task_diagnostics: Annotated[Optional[List[StrictStr]], Field(description="List of profilers to use on tasks.")] = None,
361
- limit: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
362
- name: Annotated[Optional[StrictStr], Field(description="Filter results where name matches value")] = None,
363
- name__contains: Annotated[Optional[StrictStr], Field(description="Filter results where name contains value")] = None,
364
- offset: Annotated[Optional[StrictInt], Field(description="The initial index from which to return the results.")] = None,
365
- 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) * `name` - Name * `-name` - Name (descending) * `next_dispatch` - Next dispatch * `-next_dispatch` - Next dispatch (descending) * `dispatch_interval` - Dispatch interval * `-dispatch_interval` - Dispatch interval (descending) * `task_name` - Task name * `-task_name` - Task name (descending) * `pk` - Pk * `-pk` - Pk (descending)")] = None,
366
- prn__in: Annotated[Optional[List[StrictStr]], Field(description="Multiple values may be separated by commas.")] = None,
367
- pulp_href__in: Annotated[Optional[List[StrictStr]], Field(description="Multiple values may be separated by commas.")] = None,
368
- pulp_id__in: Annotated[Optional[List[StrictStr]], Field(description="Multiple values may be separated by commas.")] = None,
369
- q: Annotated[Optional[StrictStr], Field(description="Filter results by using NOT, AND and OR operations on other filters")] = None,
370
- task_name: Annotated[Optional[StrictStr], Field(description="Filter results where task_name matches value")] = None,
371
- task_name__contains: Annotated[Optional[StrictStr], Field(description="Filter results where task_name contains value")] = None,
372
- fields: Annotated[Optional[List[StrictStr]], Field(description="A list of fields to include in the response.")] = None,
373
- exclude_fields: Annotated[Optional[List[StrictStr]], Field(description="A list of fields to exclude from the response.")] = None,
374
- pulp_domain: StrictStr = "default",
375
- _request_timeout: Union[
376
- None,
377
- Annotated[StrictFloat, Field(gt=0)],
378
- Tuple[
379
- Annotated[StrictFloat, Field(gt=0)],
380
- Annotated[StrictFloat, Field(gt=0)]
381
- ]
382
- ] = None,
383
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
384
- _content_type: Optional[StrictStr] = None,
385
- _headers: Optional[Dict[StrictStr, Any]] = None,
386
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
387
- ) -> PaginatedTaskScheduleResponseList:
388
- """List task schedules
389
-
390
- ViewSet to monitor task schedules.
391
-
392
- :param pulp_domain: (required)
393
- :type pulp_domain: str
394
- :param x_task_diagnostics: List of profilers to use on tasks.
395
- :type x_task_diagnostics: List[str]
396
- :param limit: Number of results to return per page.
397
- :type limit: int
398
- :param name: Filter results where name matches value
399
- :type name: str
400
- :param name__contains: Filter results where name contains value
401
- :type name__contains: str
402
- :param offset: The initial index from which to return the results.
403
- :type offset: int
404
- :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) * `name` - Name * `-name` - Name (descending) * `next_dispatch` - Next dispatch * `-next_dispatch` - Next dispatch (descending) * `dispatch_interval` - Dispatch interval * `-dispatch_interval` - Dispatch interval (descending) * `task_name` - Task name * `-task_name` - Task name (descending) * `pk` - Pk * `-pk` - Pk (descending)
405
- :type ordering: List[str]
406
- :param prn__in: Multiple values may be separated by commas.
407
- :type prn__in: List[str]
408
- :param pulp_href__in: Multiple values may be separated by commas.
409
- :type pulp_href__in: List[str]
410
- :param pulp_id__in: Multiple values may be separated by commas.
411
- :type pulp_id__in: List[str]
412
- :param q: Filter results by using NOT, AND and OR operations on other filters
413
- :type q: str
414
- :param task_name: Filter results where task_name matches value
415
- :type task_name: str
416
- :param task_name__contains: Filter results where task_name contains value
417
- :type task_name__contains: 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._list_serialize(
445
- pulp_domain=pulp_domain,
446
- x_task_diagnostics=x_task_diagnostics,
447
- limit=limit,
448
- name=name,
449
- name__contains=name__contains,
450
- offset=offset,
451
- ordering=ordering,
452
- prn__in=prn__in,
453
- pulp_href__in=pulp_href__in,
454
- pulp_id__in=pulp_id__in,
455
- q=q,
456
- task_name=task_name,
457
- task_name__contains=task_name__contains,
458
- fields=fields,
459
- exclude_fields=exclude_fields,
460
- _request_auth=_request_auth,
461
- _content_type=_content_type,
462
- _headers=_headers,
463
- _host_index=_host_index
464
- )
465
-
466
- _response_types_map: Dict[str, Optional[str]] = {
467
- '200': "PaginatedTaskScheduleResponseList",
468
- }
469
- response_data = self.api_client.call_api(
470
- *_param,
471
- _request_timeout=_request_timeout
472
- )
473
- response_data.read()
474
- return self.api_client.response_deserialize(
475
- response_data=response_data,
476
- response_types_map=_response_types_map,
477
- ).data
478
-
479
-
480
- @validate_call
481
- def list_with_http_info(
482
- self,
483
- x_task_diagnostics: Annotated[Optional[List[StrictStr]], Field(description="List of profilers to use on tasks.")] = None,
484
- limit: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
485
- name: Annotated[Optional[StrictStr], Field(description="Filter results where name matches value")] = None,
486
- name__contains: Annotated[Optional[StrictStr], Field(description="Filter results where name contains value")] = None,
487
- offset: Annotated[Optional[StrictInt], Field(description="The initial index from which to return the results.")] = None,
488
- 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) * `name` - Name * `-name` - Name (descending) * `next_dispatch` - Next dispatch * `-next_dispatch` - Next dispatch (descending) * `dispatch_interval` - Dispatch interval * `-dispatch_interval` - Dispatch interval (descending) * `task_name` - Task name * `-task_name` - Task name (descending) * `pk` - Pk * `-pk` - Pk (descending)")] = None,
489
- prn__in: Annotated[Optional[List[StrictStr]], Field(description="Multiple values may be separated by commas.")] = None,
490
- pulp_href__in: Annotated[Optional[List[StrictStr]], Field(description="Multiple values may be separated by commas.")] = None,
491
- pulp_id__in: Annotated[Optional[List[StrictStr]], Field(description="Multiple values may be separated by commas.")] = None,
492
- q: Annotated[Optional[StrictStr], Field(description="Filter results by using NOT, AND and OR operations on other filters")] = None,
493
- task_name: Annotated[Optional[StrictStr], Field(description="Filter results where task_name matches value")] = None,
494
- task_name__contains: Annotated[Optional[StrictStr], Field(description="Filter results where task_name contains value")] = None,
495
- fields: Annotated[Optional[List[StrictStr]], Field(description="A list of fields to include in the response.")] = None,
496
- exclude_fields: Annotated[Optional[List[StrictStr]], Field(description="A list of fields to exclude from the response.")] = None,
497
- pulp_domain: StrictStr = "default",
498
- _request_timeout: Union[
499
- None,
500
- Annotated[StrictFloat, Field(gt=0)],
501
- Tuple[
502
- Annotated[StrictFloat, Field(gt=0)],
503
- Annotated[StrictFloat, Field(gt=0)]
504
- ]
505
- ] = None,
506
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
507
- _content_type: Optional[StrictStr] = None,
508
- _headers: Optional[Dict[StrictStr, Any]] = None,
509
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
510
- ) -> ApiResponse[PaginatedTaskScheduleResponseList]:
511
- """List task schedules
512
-
513
- ViewSet to monitor task schedules.
514
-
515
- :param pulp_domain: (required)
516
- :type pulp_domain: str
517
- :param x_task_diagnostics: List of profilers to use on tasks.
518
- :type x_task_diagnostics: List[str]
519
- :param limit: Number of results to return per page.
520
- :type limit: int
521
- :param name: Filter results where name matches value
522
- :type name: str
523
- :param name__contains: Filter results where name contains value
524
- :type name__contains: str
525
- :param offset: The initial index from which to return the results.
526
- :type offset: int
527
- :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) * `name` - Name * `-name` - Name (descending) * `next_dispatch` - Next dispatch * `-next_dispatch` - Next dispatch (descending) * `dispatch_interval` - Dispatch interval * `-dispatch_interval` - Dispatch interval (descending) * `task_name` - Task name * `-task_name` - Task name (descending) * `pk` - Pk * `-pk` - Pk (descending)
528
- :type ordering: List[str]
529
- :param prn__in: Multiple values may be separated by commas.
530
- :type prn__in: List[str]
531
- :param pulp_href__in: Multiple values may be separated by commas.
532
- :type pulp_href__in: List[str]
533
- :param pulp_id__in: Multiple values may be separated by commas.
534
- :type pulp_id__in: List[str]
535
- :param q: Filter results by using NOT, AND and OR operations on other filters
536
- :type q: str
537
- :param task_name: Filter results where task_name matches value
538
- :type task_name: str
539
- :param task_name__contains: Filter results where task_name contains value
540
- :type task_name__contains: str
541
- :param fields: A list of fields to include in the response.
542
- :type fields: List[str]
543
- :param exclude_fields: A list of fields to exclude from the response.
544
- :type exclude_fields: List[str]
545
- :param _request_timeout: timeout setting for this request. If one
546
- number provided, it will be total request
547
- timeout. It can also be a pair (tuple) of
548
- (connection, read) timeouts.
549
- :type _request_timeout: int, tuple(int, int), optional
550
- :param _request_auth: set to override the auth_settings for an a single
551
- request; this effectively ignores the
552
- authentication in the spec for a single request.
553
- :type _request_auth: dict, optional
554
- :param _content_type: force content-type for the request.
555
- :type _content_type: str, Optional
556
- :param _headers: set to override the headers for a single
557
- request; this effectively ignores the headers
558
- in the spec for a single request.
559
- :type _headers: dict, optional
560
- :param _host_index: set to override the host_index for a single
561
- request; this effectively ignores the host_index
562
- in the spec for a single request.
563
- :type _host_index: int, optional
564
- :return: Returns the result object.
565
- """ # noqa: E501
566
-
567
- _param = self._list_serialize(
568
- pulp_domain=pulp_domain,
569
- x_task_diagnostics=x_task_diagnostics,
570
- limit=limit,
571
- name=name,
572
- name__contains=name__contains,
573
- offset=offset,
574
- ordering=ordering,
575
- prn__in=prn__in,
576
- pulp_href__in=pulp_href__in,
577
- pulp_id__in=pulp_id__in,
578
- q=q,
579
- task_name=task_name,
580
- task_name__contains=task_name__contains,
581
- fields=fields,
582
- exclude_fields=exclude_fields,
583
- _request_auth=_request_auth,
584
- _content_type=_content_type,
585
- _headers=_headers,
586
- _host_index=_host_index
587
- )
588
-
589
- _response_types_map: Dict[str, Optional[str]] = {
590
- '200': "PaginatedTaskScheduleResponseList",
591
- }
592
- response_data = self.api_client.call_api(
593
- *_param,
594
- _request_timeout=_request_timeout
595
- )
596
- response_data.read()
597
- return self.api_client.response_deserialize(
598
- response_data=response_data,
599
- response_types_map=_response_types_map,
600
- )
601
-
602
-
603
- @validate_call
604
- def list_without_preload_content(
605
- self,
606
- x_task_diagnostics: Annotated[Optional[List[StrictStr]], Field(description="List of profilers to use on tasks.")] = None,
607
- limit: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
608
- name: Annotated[Optional[StrictStr], Field(description="Filter results where name matches value")] = None,
609
- name__contains: Annotated[Optional[StrictStr], Field(description="Filter results where name contains value")] = None,
610
- offset: Annotated[Optional[StrictInt], Field(description="The initial index from which to return the results.")] = None,
611
- 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) * `name` - Name * `-name` - Name (descending) * `next_dispatch` - Next dispatch * `-next_dispatch` - Next dispatch (descending) * `dispatch_interval` - Dispatch interval * `-dispatch_interval` - Dispatch interval (descending) * `task_name` - Task name * `-task_name` - Task name (descending) * `pk` - Pk * `-pk` - Pk (descending)")] = None,
612
- prn__in: Annotated[Optional[List[StrictStr]], Field(description="Multiple values may be separated by commas.")] = None,
613
- pulp_href__in: Annotated[Optional[List[StrictStr]], Field(description="Multiple values may be separated by commas.")] = None,
614
- pulp_id__in: Annotated[Optional[List[StrictStr]], Field(description="Multiple values may be separated by commas.")] = None,
615
- q: Annotated[Optional[StrictStr], Field(description="Filter results by using NOT, AND and OR operations on other filters")] = None,
616
- task_name: Annotated[Optional[StrictStr], Field(description="Filter results where task_name matches value")] = None,
617
- task_name__contains: Annotated[Optional[StrictStr], Field(description="Filter results where task_name contains value")] = None,
618
- fields: Annotated[Optional[List[StrictStr]], Field(description="A list of fields to include in the response.")] = None,
619
- exclude_fields: Annotated[Optional[List[StrictStr]], Field(description="A list of fields to exclude from the response.")] = None,
620
- pulp_domain: StrictStr = "default",
621
- _request_timeout: Union[
622
- None,
623
- Annotated[StrictFloat, Field(gt=0)],
624
- Tuple[
625
- Annotated[StrictFloat, Field(gt=0)],
626
- Annotated[StrictFloat, Field(gt=0)]
627
- ]
628
- ] = None,
629
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
630
- _content_type: Optional[StrictStr] = None,
631
- _headers: Optional[Dict[StrictStr, Any]] = None,
632
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
633
- ) -> RESTResponseType:
634
- """List task schedules
635
-
636
- ViewSet to monitor task schedules.
637
-
638
- :param pulp_domain: (required)
639
- :type pulp_domain: str
640
- :param x_task_diagnostics: List of profilers to use on tasks.
641
- :type x_task_diagnostics: List[str]
642
- :param limit: Number of results to return per page.
643
- :type limit: int
644
- :param name: Filter results where name matches value
645
- :type name: str
646
- :param name__contains: Filter results where name contains value
647
- :type name__contains: str
648
- :param offset: The initial index from which to return the results.
649
- :type offset: int
650
- :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) * `name` - Name * `-name` - Name (descending) * `next_dispatch` - Next dispatch * `-next_dispatch` - Next dispatch (descending) * `dispatch_interval` - Dispatch interval * `-dispatch_interval` - Dispatch interval (descending) * `task_name` - Task name * `-task_name` - Task name (descending) * `pk` - Pk * `-pk` - Pk (descending)
651
- :type ordering: List[str]
652
- :param prn__in: Multiple values may be separated by commas.
653
- :type prn__in: List[str]
654
- :param pulp_href__in: Multiple values may be separated by commas.
655
- :type pulp_href__in: List[str]
656
- :param pulp_id__in: Multiple values may be separated by commas.
657
- :type pulp_id__in: List[str]
658
- :param q: Filter results by using NOT, AND and OR operations on other filters
659
- :type q: str
660
- :param task_name: Filter results where task_name matches value
661
- :type task_name: str
662
- :param task_name__contains: Filter results where task_name contains value
663
- :type task_name__contains: str
664
- :param fields: A list of fields to include in the response.
665
- :type fields: List[str]
666
- :param exclude_fields: A list of fields to exclude from the response.
667
- :type exclude_fields: List[str]
668
- :param _request_timeout: timeout setting for this request. If one
669
- number provided, it will be total request
670
- timeout. It can also be a pair (tuple) of
671
- (connection, read) timeouts.
672
- :type _request_timeout: int, tuple(int, int), optional
673
- :param _request_auth: set to override the auth_settings for an a single
674
- request; this effectively ignores the
675
- authentication in the spec for a single request.
676
- :type _request_auth: dict, optional
677
- :param _content_type: force content-type for the request.
678
- :type _content_type: str, Optional
679
- :param _headers: set to override the headers for a single
680
- request; this effectively ignores the headers
681
- in the spec for a single request.
682
- :type _headers: dict, optional
683
- :param _host_index: set to override the host_index for a single
684
- request; this effectively ignores the host_index
685
- in the spec for a single request.
686
- :type _host_index: int, optional
687
- :return: Returns the result object.
688
- """ # noqa: E501
689
-
690
- _param = self._list_serialize(
691
- pulp_domain=pulp_domain,
692
- x_task_diagnostics=x_task_diagnostics,
693
- limit=limit,
694
- name=name,
695
- name__contains=name__contains,
696
- offset=offset,
697
- ordering=ordering,
698
- prn__in=prn__in,
699
- pulp_href__in=pulp_href__in,
700
- pulp_id__in=pulp_id__in,
701
- q=q,
702
- task_name=task_name,
703
- task_name__contains=task_name__contains,
704
- fields=fields,
705
- exclude_fields=exclude_fields,
706
- _request_auth=_request_auth,
707
- _content_type=_content_type,
708
- _headers=_headers,
709
- _host_index=_host_index
710
- )
711
-
712
- _response_types_map: Dict[str, Optional[str]] = {
713
- '200': "PaginatedTaskScheduleResponseList",
714
- }
715
- response_data = self.api_client.call_api(
716
- *_param,
717
- _request_timeout=_request_timeout
718
- )
719
- return response_data.response
720
-
721
-
722
- def _list_serialize(
723
- self,
724
- pulp_domain,
725
- x_task_diagnostics,
726
- limit,
727
- name,
728
- name__contains,
729
- offset,
730
- ordering,
731
- prn__in,
732
- pulp_href__in,
733
- pulp_id__in,
734
- q,
735
- task_name,
736
- task_name__contains,
737
- fields,
738
- exclude_fields,
739
- _request_auth,
740
- _content_type,
741
- _headers,
742
- _host_index,
743
- ) -> RequestSerialized:
744
-
745
- _host = None
746
-
747
- _collection_formats: Dict[str, str] = {
748
- 'X-Task-Diagnostics': 'csv',
749
- 'ordering': 'csv',
750
- 'prn__in': 'csv',
751
- 'pulp_href__in': 'csv',
752
- 'pulp_id__in': 'csv',
753
- 'fields': 'multi',
754
- 'exclude_fields': 'multi',
755
- }
756
-
757
- _path_params: Dict[str, str] = {}
758
- _query_params: List[Tuple[str, str]] = []
759
- _header_params: Dict[str, Optional[str]] = _headers or {}
760
- _form_params: List[Tuple[str, str]] = []
761
- _files: Dict[
762
- str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
763
- ] = {}
764
- _body_params: Optional[bytes] = None
765
-
766
- # process the path parameters
767
- if pulp_domain is not None:
768
- _path_params['pulp_domain'] = pulp_domain
769
- # process the query parameters
770
- if limit is not None:
771
-
772
- _query_params.append(('limit', limit))
773
-
774
- if name is not None:
775
-
776
- _query_params.append(('name', name))
777
-
778
- if name__contains is not None:
779
-
780
- _query_params.append(('name__contains', name__contains))
781
-
782
- if offset is not None:
783
-
784
- _query_params.append(('offset', offset))
785
-
786
- if ordering is not None:
787
-
788
- _query_params.append(('ordering', ordering))
789
-
790
- if prn__in is not None:
791
-
792
- _query_params.append(('prn__in', prn__in))
793
-
794
- if pulp_href__in is not None:
795
-
796
- _query_params.append(('pulp_href__in', pulp_href__in))
797
-
798
- if pulp_id__in is not None:
799
-
800
- _query_params.append(('pulp_id__in', pulp_id__in))
801
-
802
- if q is not None:
803
-
804
- _query_params.append(('q', q))
805
-
806
- if task_name is not None:
807
-
808
- _query_params.append(('task_name', task_name))
809
-
810
- if task_name__contains is not None:
811
-
812
- _query_params.append(('task_name__contains', task_name__contains))
813
-
814
- if fields is not None:
815
-
816
- _query_params.append(('fields', fields))
817
-
818
- if exclude_fields is not None:
819
-
820
- _query_params.append(('exclude_fields', exclude_fields))
821
-
822
- # process the header parameters
823
- if x_task_diagnostics is not None:
824
- _header_params['X-Task-Diagnostics'] = x_task_diagnostics
825
- # process the form parameters
826
- # process the body parameter
827
-
828
-
829
- # set the HTTP header `Accept`
830
- if 'Accept' not in _header_params:
831
- _header_params['Accept'] = self.api_client.select_header_accept(
832
- [
833
- 'application/json'
834
- ]
835
- )
836
-
837
-
838
- # authentication setting
839
- _auth_settings: List[str] = [
840
- 'json_header_remote_authentication',
841
- 'basicAuth',
842
- 'cookieAuth'
843
- ]
844
-
845
- return self.api_client.param_serialize(
846
- method='GET',
847
- resource_path='/api/pulp/{pulp_domain}/api/v3/task-schedules/',
848
- path_params=_path_params,
849
- query_params=_query_params,
850
- header_params=_header_params,
851
- body=_body_params,
852
- post_params=_form_params,
853
- files=_files,
854
- auth_settings=_auth_settings,
855
- collection_formats=_collection_formats,
856
- _host=_host,
857
- _request_auth=_request_auth
858
- )
859
-
860
-
861
-
862
-
863
- @validate_call
864
- def list_roles(
865
- self,
866
- task_schedule_href: StrictStr,
867
- x_task_diagnostics: Annotated[Optional[List[StrictStr]], Field(description="List of profilers to use on tasks.")] = None,
868
- fields: Annotated[Optional[List[StrictStr]], Field(description="A list of fields to include in the response.")] = None,
869
- exclude_fields: Annotated[Optional[List[StrictStr]], Field(description="A list of fields to exclude from the response.")] = None,
870
- _request_timeout: Union[
871
- None,
872
- Annotated[StrictFloat, Field(gt=0)],
873
- Tuple[
874
- Annotated[StrictFloat, Field(gt=0)],
875
- Annotated[StrictFloat, Field(gt=0)]
876
- ]
877
- ] = None,
878
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
879
- _content_type: Optional[StrictStr] = None,
880
- _headers: Optional[Dict[StrictStr, Any]] = None,
881
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
882
- ) -> ObjectRolesResponse:
883
- """List roles
884
-
885
- List roles assigned to this object.
886
-
887
- :param task_schedule_href: (required)
888
- :type task_schedule_href: str
889
- :param x_task_diagnostics: List of profilers to use on tasks.
890
- :type x_task_diagnostics: List[str]
891
- :param fields: A list of fields to include in the response.
892
- :type fields: List[str]
893
- :param exclude_fields: A list of fields to exclude from the response.
894
- :type exclude_fields: List[str]
895
- :param _request_timeout: timeout setting for this request. If one
896
- number provided, it will be total request
897
- timeout. It can also be a pair (tuple) of
898
- (connection, read) timeouts.
899
- :type _request_timeout: int, tuple(int, int), optional
900
- :param _request_auth: set to override the auth_settings for an a single
901
- request; this effectively ignores the
902
- authentication in the spec for a single request.
903
- :type _request_auth: dict, optional
904
- :param _content_type: force content-type for the request.
905
- :type _content_type: str, Optional
906
- :param _headers: set to override the headers for a single
907
- request; this effectively ignores the headers
908
- in the spec for a single request.
909
- :type _headers: dict, optional
910
- :param _host_index: set to override the host_index for a single
911
- request; this effectively ignores the host_index
912
- in the spec for a single request.
913
- :type _host_index: int, optional
914
- :return: Returns the result object.
915
- """ # noqa: E501
916
-
917
- _param = self._list_roles_serialize(
918
- task_schedule_href=task_schedule_href,
919
- x_task_diagnostics=x_task_diagnostics,
920
- fields=fields,
921
- exclude_fields=exclude_fields,
922
- _request_auth=_request_auth,
923
- _content_type=_content_type,
924
- _headers=_headers,
925
- _host_index=_host_index
926
- )
927
-
928
- _response_types_map: Dict[str, Optional[str]] = {
929
- '200': "ObjectRolesResponse",
930
- }
931
- response_data = self.api_client.call_api(
932
- *_param,
933
- _request_timeout=_request_timeout
934
- )
935
- response_data.read()
936
- return self.api_client.response_deserialize(
937
- response_data=response_data,
938
- response_types_map=_response_types_map,
939
- ).data
940
-
941
-
942
- @validate_call
943
- def list_roles_with_http_info(
944
- self,
945
- task_schedule_href: StrictStr,
946
- x_task_diagnostics: Annotated[Optional[List[StrictStr]], Field(description="List of profilers to use on tasks.")] = None,
947
- fields: Annotated[Optional[List[StrictStr]], Field(description="A list of fields to include in the response.")] = None,
948
- exclude_fields: Annotated[Optional[List[StrictStr]], Field(description="A list of fields to exclude from the response.")] = None,
949
- _request_timeout: Union[
950
- None,
951
- Annotated[StrictFloat, Field(gt=0)],
952
- Tuple[
953
- Annotated[StrictFloat, Field(gt=0)],
954
- Annotated[StrictFloat, Field(gt=0)]
955
- ]
956
- ] = None,
957
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
958
- _content_type: Optional[StrictStr] = None,
959
- _headers: Optional[Dict[StrictStr, Any]] = None,
960
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
961
- ) -> ApiResponse[ObjectRolesResponse]:
962
- """List roles
963
-
964
- List roles assigned to this object.
965
-
966
- :param task_schedule_href: (required)
967
- :type task_schedule_href: str
968
- :param x_task_diagnostics: List of profilers to use on tasks.
969
- :type x_task_diagnostics: List[str]
970
- :param fields: A list of fields to include in the response.
971
- :type fields: List[str]
972
- :param exclude_fields: A list of fields to exclude from the response.
973
- :type exclude_fields: List[str]
974
- :param _request_timeout: timeout setting for this request. If one
975
- number provided, it will be total request
976
- timeout. It can also be a pair (tuple) of
977
- (connection, read) timeouts.
978
- :type _request_timeout: int, tuple(int, int), optional
979
- :param _request_auth: set to override the auth_settings for an a single
980
- request; this effectively ignores the
981
- authentication in the spec for a single request.
982
- :type _request_auth: dict, optional
983
- :param _content_type: force content-type for the request.
984
- :type _content_type: str, Optional
985
- :param _headers: set to override the headers for a single
986
- request; this effectively ignores the headers
987
- in the spec for a single request.
988
- :type _headers: dict, optional
989
- :param _host_index: set to override the host_index for a single
990
- request; this effectively ignores the host_index
991
- in the spec for a single request.
992
- :type _host_index: int, optional
993
- :return: Returns the result object.
994
- """ # noqa: E501
995
-
996
- _param = self._list_roles_serialize(
997
- task_schedule_href=task_schedule_href,
998
- x_task_diagnostics=x_task_diagnostics,
999
- fields=fields,
1000
- exclude_fields=exclude_fields,
1001
- _request_auth=_request_auth,
1002
- _content_type=_content_type,
1003
- _headers=_headers,
1004
- _host_index=_host_index
1005
- )
1006
-
1007
- _response_types_map: Dict[str, Optional[str]] = {
1008
- '200': "ObjectRolesResponse",
1009
- }
1010
- response_data = self.api_client.call_api(
1011
- *_param,
1012
- _request_timeout=_request_timeout
1013
- )
1014
- response_data.read()
1015
- return self.api_client.response_deserialize(
1016
- response_data=response_data,
1017
- response_types_map=_response_types_map,
1018
- )
1019
-
1020
-
1021
- @validate_call
1022
- def list_roles_without_preload_content(
1023
- self,
1024
- task_schedule_href: StrictStr,
1025
- x_task_diagnostics: Annotated[Optional[List[StrictStr]], Field(description="List of profilers to use on tasks.")] = None,
1026
- fields: Annotated[Optional[List[StrictStr]], Field(description="A list of fields to include in the response.")] = None,
1027
- exclude_fields: Annotated[Optional[List[StrictStr]], Field(description="A list of fields to exclude from the response.")] = None,
1028
- _request_timeout: Union[
1029
- None,
1030
- Annotated[StrictFloat, Field(gt=0)],
1031
- Tuple[
1032
- Annotated[StrictFloat, Field(gt=0)],
1033
- Annotated[StrictFloat, Field(gt=0)]
1034
- ]
1035
- ] = None,
1036
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
1037
- _content_type: Optional[StrictStr] = None,
1038
- _headers: Optional[Dict[StrictStr, Any]] = None,
1039
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1040
- ) -> RESTResponseType:
1041
- """List roles
1042
-
1043
- List roles assigned to this object.
1044
-
1045
- :param task_schedule_href: (required)
1046
- :type task_schedule_href: str
1047
- :param x_task_diagnostics: List of profilers to use on tasks.
1048
- :type x_task_diagnostics: List[str]
1049
- :param fields: A list of fields to include in the response.
1050
- :type fields: List[str]
1051
- :param exclude_fields: A list of fields to exclude from the response.
1052
- :type exclude_fields: List[str]
1053
- :param _request_timeout: timeout setting for this request. If one
1054
- number provided, it will be total request
1055
- timeout. It can also be a pair (tuple) of
1056
- (connection, read) timeouts.
1057
- :type _request_timeout: int, tuple(int, int), optional
1058
- :param _request_auth: set to override the auth_settings for an a single
1059
- request; this effectively ignores the
1060
- authentication in the spec for a single request.
1061
- :type _request_auth: dict, optional
1062
- :param _content_type: force content-type for the request.
1063
- :type _content_type: str, Optional
1064
- :param _headers: set to override the headers for a single
1065
- request; this effectively ignores the headers
1066
- in the spec for a single request.
1067
- :type _headers: dict, optional
1068
- :param _host_index: set to override the host_index for a single
1069
- request; this effectively ignores the host_index
1070
- in the spec for a single request.
1071
- :type _host_index: int, optional
1072
- :return: Returns the result object.
1073
- """ # noqa: E501
1074
-
1075
- _param = self._list_roles_serialize(
1076
- task_schedule_href=task_schedule_href,
1077
- x_task_diagnostics=x_task_diagnostics,
1078
- fields=fields,
1079
- exclude_fields=exclude_fields,
1080
- _request_auth=_request_auth,
1081
- _content_type=_content_type,
1082
- _headers=_headers,
1083
- _host_index=_host_index
1084
- )
1085
-
1086
- _response_types_map: Dict[str, Optional[str]] = {
1087
- '200': "ObjectRolesResponse",
1088
- }
1089
- response_data = self.api_client.call_api(
1090
- *_param,
1091
- _request_timeout=_request_timeout
1092
- )
1093
- return response_data.response
1094
-
1095
-
1096
- def _list_roles_serialize(
1097
- self,
1098
- task_schedule_href,
1099
- x_task_diagnostics,
1100
- fields,
1101
- exclude_fields,
1102
- _request_auth,
1103
- _content_type,
1104
- _headers,
1105
- _host_index,
1106
- ) -> RequestSerialized:
1107
-
1108
- _host = None
1109
-
1110
- _collection_formats: Dict[str, str] = {
1111
- 'X-Task-Diagnostics': 'csv',
1112
- 'fields': 'multi',
1113
- 'exclude_fields': 'multi',
1114
- }
1115
-
1116
- _path_params: Dict[str, str] = {}
1117
- _query_params: List[Tuple[str, str]] = []
1118
- _header_params: Dict[str, Optional[str]] = _headers or {}
1119
- _form_params: List[Tuple[str, str]] = []
1120
- _files: Dict[
1121
- str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1122
- ] = {}
1123
- _body_params: Optional[bytes] = None
1124
-
1125
- # process the path parameters
1126
- if task_schedule_href is not None:
1127
- _path_params['task_schedule_href'] = task_schedule_href
1128
- # process the query parameters
1129
- if fields is not None:
1130
-
1131
- _query_params.append(('fields', fields))
1132
-
1133
- if exclude_fields is not None:
1134
-
1135
- _query_params.append(('exclude_fields', exclude_fields))
1136
-
1137
- # process the header parameters
1138
- if x_task_diagnostics is not None:
1139
- _header_params['X-Task-Diagnostics'] = x_task_diagnostics
1140
- # process the form parameters
1141
- # process the body parameter
1142
-
1143
-
1144
- # set the HTTP header `Accept`
1145
- if 'Accept' not in _header_params:
1146
- _header_params['Accept'] = self.api_client.select_header_accept(
1147
- [
1148
- 'application/json'
1149
- ]
1150
- )
1151
-
1152
-
1153
- # authentication setting
1154
- _auth_settings: List[str] = [
1155
- 'json_header_remote_authentication',
1156
- 'basicAuth',
1157
- 'cookieAuth'
1158
- ]
1159
-
1160
- return self.api_client.param_serialize(
1161
- method='GET',
1162
- resource_path='{task_schedule_href}list_roles/',
1163
- path_params=_path_params,
1164
- query_params=_query_params,
1165
- header_params=_header_params,
1166
- body=_body_params,
1167
- post_params=_form_params,
1168
- files=_files,
1169
- auth_settings=_auth_settings,
1170
- collection_formats=_collection_formats,
1171
- _host=_host,
1172
- _request_auth=_request_auth
1173
- )
1174
-
1175
-
1176
-
1177
-
1178
- @validate_call
1179
- def my_permissions(
1180
- self,
1181
- task_schedule_href: StrictStr,
1182
- x_task_diagnostics: Annotated[Optional[List[StrictStr]], Field(description="List of profilers to use on tasks.")] = None,
1183
- fields: Annotated[Optional[List[StrictStr]], Field(description="A list of fields to include in the response.")] = None,
1184
- exclude_fields: Annotated[Optional[List[StrictStr]], Field(description="A list of fields to exclude from the response.")] = None,
1185
- _request_timeout: Union[
1186
- None,
1187
- Annotated[StrictFloat, Field(gt=0)],
1188
- Tuple[
1189
- Annotated[StrictFloat, Field(gt=0)],
1190
- Annotated[StrictFloat, Field(gt=0)]
1191
- ]
1192
- ] = None,
1193
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
1194
- _content_type: Optional[StrictStr] = None,
1195
- _headers: Optional[Dict[StrictStr, Any]] = None,
1196
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1197
- ) -> MyPermissionsResponse:
1198
- """List user permissions
1199
-
1200
- List permissions available to the current user on this object.
1201
-
1202
- :param task_schedule_href: (required)
1203
- :type task_schedule_href: str
1204
- :param x_task_diagnostics: List of profilers to use on tasks.
1205
- :type x_task_diagnostics: List[str]
1206
- :param fields: A list of fields to include in the response.
1207
- :type fields: List[str]
1208
- :param exclude_fields: A list of fields to exclude from the response.
1209
- :type exclude_fields: List[str]
1210
- :param _request_timeout: timeout setting for this request. If one
1211
- number provided, it will be total request
1212
- timeout. It can also be a pair (tuple) of
1213
- (connection, read) timeouts.
1214
- :type _request_timeout: int, tuple(int, int), optional
1215
- :param _request_auth: set to override the auth_settings for an a single
1216
- request; this effectively ignores the
1217
- authentication in the spec for a single request.
1218
- :type _request_auth: dict, optional
1219
- :param _content_type: force content-type for the request.
1220
- :type _content_type: str, Optional
1221
- :param _headers: set to override the headers for a single
1222
- request; this effectively ignores the headers
1223
- in the spec for a single request.
1224
- :type _headers: dict, optional
1225
- :param _host_index: set to override the host_index for a single
1226
- request; this effectively ignores the host_index
1227
- in the spec for a single request.
1228
- :type _host_index: int, optional
1229
- :return: Returns the result object.
1230
- """ # noqa: E501
1231
-
1232
- _param = self._my_permissions_serialize(
1233
- task_schedule_href=task_schedule_href,
1234
- x_task_diagnostics=x_task_diagnostics,
1235
- fields=fields,
1236
- exclude_fields=exclude_fields,
1237
- _request_auth=_request_auth,
1238
- _content_type=_content_type,
1239
- _headers=_headers,
1240
- _host_index=_host_index
1241
- )
1242
-
1243
- _response_types_map: Dict[str, Optional[str]] = {
1244
- '200': "MyPermissionsResponse",
1245
- }
1246
- response_data = self.api_client.call_api(
1247
- *_param,
1248
- _request_timeout=_request_timeout
1249
- )
1250
- response_data.read()
1251
- return self.api_client.response_deserialize(
1252
- response_data=response_data,
1253
- response_types_map=_response_types_map,
1254
- ).data
1255
-
1256
-
1257
- @validate_call
1258
- def my_permissions_with_http_info(
1259
- self,
1260
- task_schedule_href: StrictStr,
1261
- x_task_diagnostics: Annotated[Optional[List[StrictStr]], Field(description="List of profilers to use on tasks.")] = None,
1262
- fields: Annotated[Optional[List[StrictStr]], Field(description="A list of fields to include in the response.")] = None,
1263
- exclude_fields: Annotated[Optional[List[StrictStr]], Field(description="A list of fields to exclude from the response.")] = None,
1264
- _request_timeout: Union[
1265
- None,
1266
- Annotated[StrictFloat, Field(gt=0)],
1267
- Tuple[
1268
- Annotated[StrictFloat, Field(gt=0)],
1269
- Annotated[StrictFloat, Field(gt=0)]
1270
- ]
1271
- ] = None,
1272
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
1273
- _content_type: Optional[StrictStr] = None,
1274
- _headers: Optional[Dict[StrictStr, Any]] = None,
1275
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1276
- ) -> ApiResponse[MyPermissionsResponse]:
1277
- """List user permissions
1278
-
1279
- List permissions available to the current user on this object.
1280
-
1281
- :param task_schedule_href: (required)
1282
- :type task_schedule_href: str
1283
- :param x_task_diagnostics: List of profilers to use on tasks.
1284
- :type x_task_diagnostics: List[str]
1285
- :param fields: A list of fields to include in the response.
1286
- :type fields: List[str]
1287
- :param exclude_fields: A list of fields to exclude from the response.
1288
- :type exclude_fields: List[str]
1289
- :param _request_timeout: timeout setting for this request. If one
1290
- number provided, it will be total request
1291
- timeout. It can also be a pair (tuple) of
1292
- (connection, read) timeouts.
1293
- :type _request_timeout: int, tuple(int, int), optional
1294
- :param _request_auth: set to override the auth_settings for an a single
1295
- request; this effectively ignores the
1296
- authentication in the spec for a single request.
1297
- :type _request_auth: dict, optional
1298
- :param _content_type: force content-type for the request.
1299
- :type _content_type: str, Optional
1300
- :param _headers: set to override the headers for a single
1301
- request; this effectively ignores the headers
1302
- in the spec for a single request.
1303
- :type _headers: dict, optional
1304
- :param _host_index: set to override the host_index for a single
1305
- request; this effectively ignores the host_index
1306
- in the spec for a single request.
1307
- :type _host_index: int, optional
1308
- :return: Returns the result object.
1309
- """ # noqa: E501
1310
-
1311
- _param = self._my_permissions_serialize(
1312
- task_schedule_href=task_schedule_href,
1313
- x_task_diagnostics=x_task_diagnostics,
1314
- fields=fields,
1315
- exclude_fields=exclude_fields,
1316
- _request_auth=_request_auth,
1317
- _content_type=_content_type,
1318
- _headers=_headers,
1319
- _host_index=_host_index
1320
- )
1321
-
1322
- _response_types_map: Dict[str, Optional[str]] = {
1323
- '200': "MyPermissionsResponse",
1324
- }
1325
- response_data = self.api_client.call_api(
1326
- *_param,
1327
- _request_timeout=_request_timeout
1328
- )
1329
- response_data.read()
1330
- return self.api_client.response_deserialize(
1331
- response_data=response_data,
1332
- response_types_map=_response_types_map,
1333
- )
1334
-
1335
-
1336
- @validate_call
1337
- def my_permissions_without_preload_content(
1338
- self,
1339
- task_schedule_href: StrictStr,
1340
- x_task_diagnostics: Annotated[Optional[List[StrictStr]], Field(description="List of profilers to use on tasks.")] = None,
1341
- fields: Annotated[Optional[List[StrictStr]], Field(description="A list of fields to include in the response.")] = None,
1342
- exclude_fields: Annotated[Optional[List[StrictStr]], Field(description="A list of fields to exclude from the response.")] = None,
1343
- _request_timeout: Union[
1344
- None,
1345
- Annotated[StrictFloat, Field(gt=0)],
1346
- Tuple[
1347
- Annotated[StrictFloat, Field(gt=0)],
1348
- Annotated[StrictFloat, Field(gt=0)]
1349
- ]
1350
- ] = None,
1351
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
1352
- _content_type: Optional[StrictStr] = None,
1353
- _headers: Optional[Dict[StrictStr, Any]] = None,
1354
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1355
- ) -> RESTResponseType:
1356
- """List user permissions
1357
-
1358
- List permissions available to the current user on this object.
1359
-
1360
- :param task_schedule_href: (required)
1361
- :type task_schedule_href: str
1362
- :param x_task_diagnostics: List of profilers to use on tasks.
1363
- :type x_task_diagnostics: List[str]
1364
- :param fields: A list of fields to include in the response.
1365
- :type fields: List[str]
1366
- :param exclude_fields: A list of fields to exclude from the response.
1367
- :type exclude_fields: List[str]
1368
- :param _request_timeout: timeout setting for this request. If one
1369
- number provided, it will be total request
1370
- timeout. It can also be a pair (tuple) of
1371
- (connection, read) timeouts.
1372
- :type _request_timeout: int, tuple(int, int), optional
1373
- :param _request_auth: set to override the auth_settings for an a single
1374
- request; this effectively ignores the
1375
- authentication in the spec for a single request.
1376
- :type _request_auth: dict, optional
1377
- :param _content_type: force content-type for the request.
1378
- :type _content_type: str, Optional
1379
- :param _headers: set to override the headers for a single
1380
- request; this effectively ignores the headers
1381
- in the spec for a single request.
1382
- :type _headers: dict, optional
1383
- :param _host_index: set to override the host_index for a single
1384
- request; this effectively ignores the host_index
1385
- in the spec for a single request.
1386
- :type _host_index: int, optional
1387
- :return: Returns the result object.
1388
- """ # noqa: E501
1389
-
1390
- _param = self._my_permissions_serialize(
1391
- task_schedule_href=task_schedule_href,
1392
- x_task_diagnostics=x_task_diagnostics,
1393
- fields=fields,
1394
- exclude_fields=exclude_fields,
1395
- _request_auth=_request_auth,
1396
- _content_type=_content_type,
1397
- _headers=_headers,
1398
- _host_index=_host_index
1399
- )
1400
-
1401
- _response_types_map: Dict[str, Optional[str]] = {
1402
- '200': "MyPermissionsResponse",
1403
- }
1404
- response_data = self.api_client.call_api(
1405
- *_param,
1406
- _request_timeout=_request_timeout
1407
- )
1408
- return response_data.response
1409
-
1410
-
1411
- def _my_permissions_serialize(
1412
- self,
1413
- task_schedule_href,
1414
- x_task_diagnostics,
1415
- fields,
1416
- exclude_fields,
1417
- _request_auth,
1418
- _content_type,
1419
- _headers,
1420
- _host_index,
1421
- ) -> RequestSerialized:
1422
-
1423
- _host = None
1424
-
1425
- _collection_formats: Dict[str, str] = {
1426
- 'X-Task-Diagnostics': 'csv',
1427
- 'fields': 'multi',
1428
- 'exclude_fields': 'multi',
1429
- }
1430
-
1431
- _path_params: Dict[str, str] = {}
1432
- _query_params: List[Tuple[str, str]] = []
1433
- _header_params: Dict[str, Optional[str]] = _headers or {}
1434
- _form_params: List[Tuple[str, str]] = []
1435
- _files: Dict[
1436
- str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1437
- ] = {}
1438
- _body_params: Optional[bytes] = None
1439
-
1440
- # process the path parameters
1441
- if task_schedule_href is not None:
1442
- _path_params['task_schedule_href'] = task_schedule_href
1443
- # process the query parameters
1444
- if fields is not None:
1445
-
1446
- _query_params.append(('fields', fields))
1447
-
1448
- if exclude_fields is not None:
1449
-
1450
- _query_params.append(('exclude_fields', exclude_fields))
1451
-
1452
- # process the header parameters
1453
- if x_task_diagnostics is not None:
1454
- _header_params['X-Task-Diagnostics'] = x_task_diagnostics
1455
- # process the form parameters
1456
- # process the body parameter
1457
-
1458
-
1459
- # set the HTTP header `Accept`
1460
- if 'Accept' not in _header_params:
1461
- _header_params['Accept'] = self.api_client.select_header_accept(
1462
- [
1463
- 'application/json'
1464
- ]
1465
- )
1466
-
1467
-
1468
- # authentication setting
1469
- _auth_settings: List[str] = [
1470
- 'json_header_remote_authentication',
1471
- 'basicAuth',
1472
- 'cookieAuth'
1473
- ]
1474
-
1475
- return self.api_client.param_serialize(
1476
- method='GET',
1477
- resource_path='{task_schedule_href}my_permissions/',
1478
- path_params=_path_params,
1479
- query_params=_query_params,
1480
- header_params=_header_params,
1481
- body=_body_params,
1482
- post_params=_form_params,
1483
- files=_files,
1484
- auth_settings=_auth_settings,
1485
- collection_formats=_collection_formats,
1486
- _host=_host,
1487
- _request_auth=_request_auth
1488
- )
1489
-
1490
-
1491
-
1492
-
1493
- @validate_call
1494
- def read(
1495
- self,
1496
- task_schedule_href: StrictStr,
1497
- x_task_diagnostics: Annotated[Optional[List[StrictStr]], Field(description="List of profilers to use on tasks.")] = None,
1498
- fields: Annotated[Optional[List[StrictStr]], Field(description="A list of fields to include in the response.")] = None,
1499
- exclude_fields: Annotated[Optional[List[StrictStr]], Field(description="A list of fields to exclude from the response.")] = None,
1500
- _request_timeout: Union[
1501
- None,
1502
- Annotated[StrictFloat, Field(gt=0)],
1503
- Tuple[
1504
- Annotated[StrictFloat, Field(gt=0)],
1505
- Annotated[StrictFloat, Field(gt=0)]
1506
- ]
1507
- ] = None,
1508
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
1509
- _content_type: Optional[StrictStr] = None,
1510
- _headers: Optional[Dict[StrictStr, Any]] = None,
1511
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1512
- ) -> TaskScheduleResponse:
1513
- """Inspect a task schedule
1514
-
1515
- ViewSet to monitor task schedules.
1516
-
1517
- :param task_schedule_href: (required)
1518
- :type task_schedule_href: str
1519
- :param x_task_diagnostics: List of profilers to use on tasks.
1520
- :type x_task_diagnostics: List[str]
1521
- :param fields: A list of fields to include in the response.
1522
- :type fields: List[str]
1523
- :param exclude_fields: A list of fields to exclude from the response.
1524
- :type exclude_fields: List[str]
1525
- :param _request_timeout: timeout setting for this request. If one
1526
- number provided, it will be total request
1527
- timeout. It can also be a pair (tuple) of
1528
- (connection, read) timeouts.
1529
- :type _request_timeout: int, tuple(int, int), optional
1530
- :param _request_auth: set to override the auth_settings for an a single
1531
- request; this effectively ignores the
1532
- authentication in the spec for a single request.
1533
- :type _request_auth: dict, optional
1534
- :param _content_type: force content-type for the request.
1535
- :type _content_type: str, Optional
1536
- :param _headers: set to override the headers for a single
1537
- request; this effectively ignores the headers
1538
- in the spec for a single request.
1539
- :type _headers: dict, optional
1540
- :param _host_index: set to override the host_index for a single
1541
- request; this effectively ignores the host_index
1542
- in the spec for a single request.
1543
- :type _host_index: int, optional
1544
- :return: Returns the result object.
1545
- """ # noqa: E501
1546
-
1547
- _param = self._read_serialize(
1548
- task_schedule_href=task_schedule_href,
1549
- x_task_diagnostics=x_task_diagnostics,
1550
- fields=fields,
1551
- exclude_fields=exclude_fields,
1552
- _request_auth=_request_auth,
1553
- _content_type=_content_type,
1554
- _headers=_headers,
1555
- _host_index=_host_index
1556
- )
1557
-
1558
- _response_types_map: Dict[str, Optional[str]] = {
1559
- '200': "TaskScheduleResponse",
1560
- }
1561
- response_data = self.api_client.call_api(
1562
- *_param,
1563
- _request_timeout=_request_timeout
1564
- )
1565
- response_data.read()
1566
- return self.api_client.response_deserialize(
1567
- response_data=response_data,
1568
- response_types_map=_response_types_map,
1569
- ).data
1570
-
1571
-
1572
- @validate_call
1573
- def read_with_http_info(
1574
- self,
1575
- task_schedule_href: StrictStr,
1576
- x_task_diagnostics: Annotated[Optional[List[StrictStr]], Field(description="List of profilers to use on tasks.")] = None,
1577
- fields: Annotated[Optional[List[StrictStr]], Field(description="A list of fields to include in the response.")] = None,
1578
- exclude_fields: Annotated[Optional[List[StrictStr]], Field(description="A list of fields to exclude from the response.")] = None,
1579
- _request_timeout: Union[
1580
- None,
1581
- Annotated[StrictFloat, Field(gt=0)],
1582
- Tuple[
1583
- Annotated[StrictFloat, Field(gt=0)],
1584
- Annotated[StrictFloat, Field(gt=0)]
1585
- ]
1586
- ] = None,
1587
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
1588
- _content_type: Optional[StrictStr] = None,
1589
- _headers: Optional[Dict[StrictStr, Any]] = None,
1590
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1591
- ) -> ApiResponse[TaskScheduleResponse]:
1592
- """Inspect a task schedule
1593
-
1594
- ViewSet to monitor task schedules.
1595
-
1596
- :param task_schedule_href: (required)
1597
- :type task_schedule_href: str
1598
- :param x_task_diagnostics: List of profilers to use on tasks.
1599
- :type x_task_diagnostics: List[str]
1600
- :param fields: A list of fields to include in the response.
1601
- :type fields: List[str]
1602
- :param exclude_fields: A list of fields to exclude from the response.
1603
- :type exclude_fields: List[str]
1604
- :param _request_timeout: timeout setting for this request. If one
1605
- number provided, it will be total request
1606
- timeout. It can also be a pair (tuple) of
1607
- (connection, read) timeouts.
1608
- :type _request_timeout: int, tuple(int, int), optional
1609
- :param _request_auth: set to override the auth_settings for an a single
1610
- request; this effectively ignores the
1611
- authentication in the spec for a single request.
1612
- :type _request_auth: dict, optional
1613
- :param _content_type: force content-type for the request.
1614
- :type _content_type: str, Optional
1615
- :param _headers: set to override the headers for a single
1616
- request; this effectively ignores the headers
1617
- in the spec for a single request.
1618
- :type _headers: dict, optional
1619
- :param _host_index: set to override the host_index for a single
1620
- request; this effectively ignores the host_index
1621
- in the spec for a single request.
1622
- :type _host_index: int, optional
1623
- :return: Returns the result object.
1624
- """ # noqa: E501
1625
-
1626
- _param = self._read_serialize(
1627
- task_schedule_href=task_schedule_href,
1628
- x_task_diagnostics=x_task_diagnostics,
1629
- fields=fields,
1630
- exclude_fields=exclude_fields,
1631
- _request_auth=_request_auth,
1632
- _content_type=_content_type,
1633
- _headers=_headers,
1634
- _host_index=_host_index
1635
- )
1636
-
1637
- _response_types_map: Dict[str, Optional[str]] = {
1638
- '200': "TaskScheduleResponse",
1639
- }
1640
- response_data = self.api_client.call_api(
1641
- *_param,
1642
- _request_timeout=_request_timeout
1643
- )
1644
- response_data.read()
1645
- return self.api_client.response_deserialize(
1646
- response_data=response_data,
1647
- response_types_map=_response_types_map,
1648
- )
1649
-
1650
-
1651
- @validate_call
1652
- def read_without_preload_content(
1653
- self,
1654
- task_schedule_href: StrictStr,
1655
- x_task_diagnostics: Annotated[Optional[List[StrictStr]], Field(description="List of profilers to use on tasks.")] = None,
1656
- fields: Annotated[Optional[List[StrictStr]], Field(description="A list of fields to include in the response.")] = None,
1657
- exclude_fields: Annotated[Optional[List[StrictStr]], Field(description="A list of fields to exclude from the response.")] = None,
1658
- _request_timeout: Union[
1659
- None,
1660
- Annotated[StrictFloat, Field(gt=0)],
1661
- Tuple[
1662
- Annotated[StrictFloat, Field(gt=0)],
1663
- Annotated[StrictFloat, Field(gt=0)]
1664
- ]
1665
- ] = None,
1666
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
1667
- _content_type: Optional[StrictStr] = None,
1668
- _headers: Optional[Dict[StrictStr, Any]] = None,
1669
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1670
- ) -> RESTResponseType:
1671
- """Inspect a task schedule
1672
-
1673
- ViewSet to monitor task schedules.
1674
-
1675
- :param task_schedule_href: (required)
1676
- :type task_schedule_href: str
1677
- :param x_task_diagnostics: List of profilers to use on tasks.
1678
- :type x_task_diagnostics: List[str]
1679
- :param fields: A list of fields to include in the response.
1680
- :type fields: List[str]
1681
- :param exclude_fields: A list of fields to exclude from the response.
1682
- :type exclude_fields: List[str]
1683
- :param _request_timeout: timeout setting for this request. If one
1684
- number provided, it will be total request
1685
- timeout. It can also be a pair (tuple) of
1686
- (connection, read) timeouts.
1687
- :type _request_timeout: int, tuple(int, int), optional
1688
- :param _request_auth: set to override the auth_settings for an a single
1689
- request; this effectively ignores the
1690
- authentication in the spec for a single request.
1691
- :type _request_auth: dict, optional
1692
- :param _content_type: force content-type for the request.
1693
- :type _content_type: str, Optional
1694
- :param _headers: set to override the headers for a single
1695
- request; this effectively ignores the headers
1696
- in the spec for a single request.
1697
- :type _headers: dict, optional
1698
- :param _host_index: set to override the host_index for a single
1699
- request; this effectively ignores the host_index
1700
- in the spec for a single request.
1701
- :type _host_index: int, optional
1702
- :return: Returns the result object.
1703
- """ # noqa: E501
1704
-
1705
- _param = self._read_serialize(
1706
- task_schedule_href=task_schedule_href,
1707
- x_task_diagnostics=x_task_diagnostics,
1708
- fields=fields,
1709
- exclude_fields=exclude_fields,
1710
- _request_auth=_request_auth,
1711
- _content_type=_content_type,
1712
- _headers=_headers,
1713
- _host_index=_host_index
1714
- )
1715
-
1716
- _response_types_map: Dict[str, Optional[str]] = {
1717
- '200': "TaskScheduleResponse",
1718
- }
1719
- response_data = self.api_client.call_api(
1720
- *_param,
1721
- _request_timeout=_request_timeout
1722
- )
1723
- return response_data.response
1724
-
1725
-
1726
- def _read_serialize(
1727
- self,
1728
- task_schedule_href,
1729
- x_task_diagnostics,
1730
- fields,
1731
- exclude_fields,
1732
- _request_auth,
1733
- _content_type,
1734
- _headers,
1735
- _host_index,
1736
- ) -> RequestSerialized:
1737
-
1738
- _host = None
1739
-
1740
- _collection_formats: Dict[str, str] = {
1741
- 'X-Task-Diagnostics': 'csv',
1742
- 'fields': 'multi',
1743
- 'exclude_fields': 'multi',
1744
- }
1745
-
1746
- _path_params: Dict[str, str] = {}
1747
- _query_params: List[Tuple[str, str]] = []
1748
- _header_params: Dict[str, Optional[str]] = _headers or {}
1749
- _form_params: List[Tuple[str, str]] = []
1750
- _files: Dict[
1751
- str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1752
- ] = {}
1753
- _body_params: Optional[bytes] = None
1754
-
1755
- # process the path parameters
1756
- if task_schedule_href is not None:
1757
- _path_params['task_schedule_href'] = task_schedule_href
1758
- # process the query parameters
1759
- if fields is not None:
1760
-
1761
- _query_params.append(('fields', fields))
1762
-
1763
- if exclude_fields is not None:
1764
-
1765
- _query_params.append(('exclude_fields', exclude_fields))
1766
-
1767
- # process the header parameters
1768
- if x_task_diagnostics is not None:
1769
- _header_params['X-Task-Diagnostics'] = x_task_diagnostics
1770
- # process the form parameters
1771
- # process the body parameter
1772
-
1773
-
1774
- # set the HTTP header `Accept`
1775
- if 'Accept' not in _header_params:
1776
- _header_params['Accept'] = self.api_client.select_header_accept(
1777
- [
1778
- 'application/json'
1779
- ]
1780
- )
1781
-
1782
-
1783
- # authentication setting
1784
- _auth_settings: List[str] = [
1785
- 'json_header_remote_authentication',
1786
- 'basicAuth',
1787
- 'cookieAuth'
1788
- ]
1789
-
1790
- return self.api_client.param_serialize(
1791
- method='GET',
1792
- resource_path='{task_schedule_href}',
1793
- path_params=_path_params,
1794
- query_params=_query_params,
1795
- header_params=_header_params,
1796
- body=_body_params,
1797
- post_params=_form_params,
1798
- files=_files,
1799
- auth_settings=_auth_settings,
1800
- collection_formats=_collection_formats,
1801
- _host=_host,
1802
- _request_auth=_request_auth
1803
- )
1804
-
1805
-
1806
-
1807
-
1808
- @validate_call
1809
- def remove_role(
1810
- self,
1811
- task_schedule_href: StrictStr,
1812
- nested_role: NestedRole,
1813
- x_task_diagnostics: Annotated[Optional[List[StrictStr]], Field(description="List of profilers to use on tasks.")] = None,
1814
- _request_timeout: Union[
1815
- None,
1816
- Annotated[StrictFloat, Field(gt=0)],
1817
- Tuple[
1818
- Annotated[StrictFloat, Field(gt=0)],
1819
- Annotated[StrictFloat, Field(gt=0)]
1820
- ]
1821
- ] = None,
1822
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
1823
- _content_type: Optional[StrictStr] = None,
1824
- _headers: Optional[Dict[StrictStr, Any]] = None,
1825
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1826
- ) -> NestedRoleResponse:
1827
- """Remove a role
1828
-
1829
- Remove a role for this object from users/groups.
1830
-
1831
- :param task_schedule_href: (required)
1832
- :type task_schedule_href: str
1833
- :param nested_role: (required)
1834
- :type nested_role: NestedRole
1835
- :param x_task_diagnostics: List of profilers to use on tasks.
1836
- :type x_task_diagnostics: List[str]
1837
- :param _request_timeout: timeout setting for this request. If one
1838
- number provided, it will be total request
1839
- timeout. It can also be a pair (tuple) of
1840
- (connection, read) timeouts.
1841
- :type _request_timeout: int, tuple(int, int), optional
1842
- :param _request_auth: set to override the auth_settings for an a single
1843
- request; this effectively ignores the
1844
- authentication in the spec for a single request.
1845
- :type _request_auth: dict, optional
1846
- :param _content_type: force content-type for the request.
1847
- :type _content_type: str, Optional
1848
- :param _headers: set to override the headers for a single
1849
- request; this effectively ignores the headers
1850
- in the spec for a single request.
1851
- :type _headers: dict, optional
1852
- :param _host_index: set to override the host_index for a single
1853
- request; this effectively ignores the host_index
1854
- in the spec for a single request.
1855
- :type _host_index: int, optional
1856
- :return: Returns the result object.
1857
- """ # noqa: E501
1858
-
1859
- _param = self._remove_role_serialize(
1860
- task_schedule_href=task_schedule_href,
1861
- nested_role=nested_role,
1862
- x_task_diagnostics=x_task_diagnostics,
1863
- _request_auth=_request_auth,
1864
- _content_type=_content_type,
1865
- _headers=_headers,
1866
- _host_index=_host_index
1867
- )
1868
-
1869
- _response_types_map: Dict[str, Optional[str]] = {
1870
- '201': "NestedRoleResponse",
1871
- }
1872
- response_data = self.api_client.call_api(
1873
- *_param,
1874
- _request_timeout=_request_timeout
1875
- )
1876
- response_data.read()
1877
- return self.api_client.response_deserialize(
1878
- response_data=response_data,
1879
- response_types_map=_response_types_map,
1880
- ).data
1881
-
1882
-
1883
- @validate_call
1884
- def remove_role_with_http_info(
1885
- self,
1886
- task_schedule_href: StrictStr,
1887
- nested_role: NestedRole,
1888
- x_task_diagnostics: Annotated[Optional[List[StrictStr]], Field(description="List of profilers to use on tasks.")] = None,
1889
- _request_timeout: Union[
1890
- None,
1891
- Annotated[StrictFloat, Field(gt=0)],
1892
- Tuple[
1893
- Annotated[StrictFloat, Field(gt=0)],
1894
- Annotated[StrictFloat, Field(gt=0)]
1895
- ]
1896
- ] = None,
1897
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
1898
- _content_type: Optional[StrictStr] = None,
1899
- _headers: Optional[Dict[StrictStr, Any]] = None,
1900
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1901
- ) -> ApiResponse[NestedRoleResponse]:
1902
- """Remove a role
1903
-
1904
- Remove a role for this object from users/groups.
1905
-
1906
- :param task_schedule_href: (required)
1907
- :type task_schedule_href: str
1908
- :param nested_role: (required)
1909
- :type nested_role: NestedRole
1910
- :param x_task_diagnostics: List of profilers to use on tasks.
1911
- :type x_task_diagnostics: List[str]
1912
- :param _request_timeout: timeout setting for this request. If one
1913
- number provided, it will be total request
1914
- timeout. It can also be a pair (tuple) of
1915
- (connection, read) timeouts.
1916
- :type _request_timeout: int, tuple(int, int), optional
1917
- :param _request_auth: set to override the auth_settings for an a single
1918
- request; this effectively ignores the
1919
- authentication in the spec for a single request.
1920
- :type _request_auth: dict, optional
1921
- :param _content_type: force content-type for the request.
1922
- :type _content_type: str, Optional
1923
- :param _headers: set to override the headers for a single
1924
- request; this effectively ignores the headers
1925
- in the spec for a single request.
1926
- :type _headers: dict, optional
1927
- :param _host_index: set to override the host_index for a single
1928
- request; this effectively ignores the host_index
1929
- in the spec for a single request.
1930
- :type _host_index: int, optional
1931
- :return: Returns the result object.
1932
- """ # noqa: E501
1933
-
1934
- _param = self._remove_role_serialize(
1935
- task_schedule_href=task_schedule_href,
1936
- nested_role=nested_role,
1937
- x_task_diagnostics=x_task_diagnostics,
1938
- _request_auth=_request_auth,
1939
- _content_type=_content_type,
1940
- _headers=_headers,
1941
- _host_index=_host_index
1942
- )
1943
-
1944
- _response_types_map: Dict[str, Optional[str]] = {
1945
- '201': "NestedRoleResponse",
1946
- }
1947
- response_data = self.api_client.call_api(
1948
- *_param,
1949
- _request_timeout=_request_timeout
1950
- )
1951
- response_data.read()
1952
- return self.api_client.response_deserialize(
1953
- response_data=response_data,
1954
- response_types_map=_response_types_map,
1955
- )
1956
-
1957
-
1958
- @validate_call
1959
- def remove_role_without_preload_content(
1960
- self,
1961
- task_schedule_href: StrictStr,
1962
- nested_role: NestedRole,
1963
- x_task_diagnostics: Annotated[Optional[List[StrictStr]], Field(description="List of profilers to use on tasks.")] = None,
1964
- _request_timeout: Union[
1965
- None,
1966
- Annotated[StrictFloat, Field(gt=0)],
1967
- Tuple[
1968
- Annotated[StrictFloat, Field(gt=0)],
1969
- Annotated[StrictFloat, Field(gt=0)]
1970
- ]
1971
- ] = None,
1972
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
1973
- _content_type: Optional[StrictStr] = None,
1974
- _headers: Optional[Dict[StrictStr, Any]] = None,
1975
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1976
- ) -> RESTResponseType:
1977
- """Remove a role
1978
-
1979
- Remove a role for this object from users/groups.
1980
-
1981
- :param task_schedule_href: (required)
1982
- :type task_schedule_href: str
1983
- :param nested_role: (required)
1984
- :type nested_role: NestedRole
1985
- :param x_task_diagnostics: List of profilers to use on tasks.
1986
- :type x_task_diagnostics: List[str]
1987
- :param _request_timeout: timeout setting for this request. If one
1988
- number provided, it will be total request
1989
- timeout. It can also be a pair (tuple) of
1990
- (connection, read) timeouts.
1991
- :type _request_timeout: int, tuple(int, int), optional
1992
- :param _request_auth: set to override the auth_settings for an a single
1993
- request; this effectively ignores the
1994
- authentication in the spec for a single request.
1995
- :type _request_auth: dict, optional
1996
- :param _content_type: force content-type for the request.
1997
- :type _content_type: str, Optional
1998
- :param _headers: set to override the headers for a single
1999
- request; this effectively ignores the headers
2000
- in the spec for a single request.
2001
- :type _headers: dict, optional
2002
- :param _host_index: set to override the host_index for a single
2003
- request; this effectively ignores the host_index
2004
- in the spec for a single request.
2005
- :type _host_index: int, optional
2006
- :return: Returns the result object.
2007
- """ # noqa: E501
2008
-
2009
- _param = self._remove_role_serialize(
2010
- task_schedule_href=task_schedule_href,
2011
- nested_role=nested_role,
2012
- x_task_diagnostics=x_task_diagnostics,
2013
- _request_auth=_request_auth,
2014
- _content_type=_content_type,
2015
- _headers=_headers,
2016
- _host_index=_host_index
2017
- )
2018
-
2019
- _response_types_map: Dict[str, Optional[str]] = {
2020
- '201': "NestedRoleResponse",
2021
- }
2022
- response_data = self.api_client.call_api(
2023
- *_param,
2024
- _request_timeout=_request_timeout
2025
- )
2026
- return response_data.response
2027
-
2028
-
2029
- def _remove_role_serialize(
2030
- self,
2031
- task_schedule_href,
2032
- nested_role,
2033
- x_task_diagnostics,
2034
- _request_auth,
2035
- _content_type,
2036
- _headers,
2037
- _host_index,
2038
- ) -> RequestSerialized:
2039
-
2040
- _host = None
2041
-
2042
- _collection_formats: Dict[str, str] = {
2043
- 'X-Task-Diagnostics': 'csv',
2044
- }
2045
-
2046
- _path_params: Dict[str, str] = {}
2047
- _query_params: List[Tuple[str, str]] = []
2048
- _header_params: Dict[str, Optional[str]] = _headers or {}
2049
- _form_params: List[Tuple[str, str]] = []
2050
- _files: Dict[
2051
- str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
2052
- ] = {}
2053
- _body_params: Optional[bytes] = None
2054
-
2055
- # process the path parameters
2056
- if task_schedule_href is not None:
2057
- _path_params['task_schedule_href'] = task_schedule_href
2058
- # process the query parameters
2059
- # process the header parameters
2060
- if x_task_diagnostics is not None:
2061
- _header_params['X-Task-Diagnostics'] = x_task_diagnostics
2062
- # process the form parameters
2063
- # process the body parameter
2064
- if nested_role is not None:
2065
- _body_params = nested_role
2066
-
2067
-
2068
- # set the HTTP header `Accept`
2069
- if 'Accept' not in _header_params:
2070
- _header_params['Accept'] = self.api_client.select_header_accept(
2071
- [
2072
- 'application/json'
2073
- ]
2074
- )
2075
-
2076
- # set the HTTP header `Content-Type`
2077
- if _content_type:
2078
- _header_params['Content-Type'] = _content_type
2079
- else:
2080
- _default_content_type = (
2081
- self.api_client.select_header_content_type(
2082
- [
2083
- 'application/json',
2084
- 'application/x-www-form-urlencoded',
2085
- 'multipart/form-data'
2086
- ]
2087
- )
2088
- )
2089
- if _default_content_type is not None:
2090
- _header_params['Content-Type'] = _default_content_type
2091
-
2092
- # authentication setting
2093
- _auth_settings: List[str] = [
2094
- 'json_header_remote_authentication',
2095
- 'basicAuth',
2096
- 'cookieAuth'
2097
- ]
2098
-
2099
- return self.api_client.param_serialize(
2100
- method='POST',
2101
- resource_path='{task_schedule_href}remove_role/',
2102
- path_params=_path_params,
2103
- query_params=_query_params,
2104
- header_params=_header_params,
2105
- body=_body_params,
2106
- post_params=_form_params,
2107
- files=_files,
2108
- auth_settings=_auth_settings,
2109
- collection_formats=_collection_formats,
2110
- _host=_host,
2111
- _request_auth=_request_auth
2112
- )
2113
-
2114
-