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