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