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