graphscope-flex 0.27.0__py2.py3-none-any.whl → 0.28.0a20240919__py2.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 (95) hide show
  1. graphscope/flex/rest/__init__.py +59 -44
  2. graphscope/flex/rest/api/__init__.py +2 -4
  3. graphscope/flex/rest/api/alert_api.py +721 -394
  4. graphscope/flex/rest/api/{legacy_api.py → data_source_api.py} +260 -189
  5. graphscope/flex/rest/api/deployment_api.py +388 -138
  6. graphscope/flex/rest/api/graph_api.py +858 -260
  7. graphscope/flex/rest/api/job_api.py +286 -203
  8. graphscope/flex/rest/api/service_api.py +320 -39
  9. graphscope/flex/rest/api/{procedure_api.py → stored_procedure_api.py} +296 -237
  10. graphscope/flex/rest/api/utils_api.py +18 -13
  11. graphscope/flex/rest/api_client.py +60 -30
  12. graphscope/flex/rest/configuration.py +19 -5
  13. graphscope/flex/rest/exceptions.py +2 -2
  14. graphscope/flex/rest/models/__init__.py +57 -40
  15. graphscope/flex/rest/models/{vertex_type.py → base_edge_type.py} +25 -25
  16. graphscope/flex/rest/models/{edge_type_vertex_type_pair_relations_inner.py → base_edge_type_vertex_type_pair_relations_inner.py} +17 -17
  17. graphscope/flex/rest/models/{edge_type_vertex_type_pair_relations_inner_x_csr_params.py → base_edge_type_vertex_type_pair_relations_inner_x_csr_params.py} +11 -11
  18. graphscope/flex/rest/models/{model_property.py → base_property_meta.py} +28 -19
  19. graphscope/flex/rest/models/base_vertex_type.py +96 -0
  20. graphscope/flex/rest/models/{groot_edge_type_relations_inner.py → base_vertex_type_x_csr_params.py} +15 -17
  21. graphscope/flex/rest/models/column_mapping.py +13 -13
  22. graphscope/flex/rest/models/{edge_mapping_source_vertex_mappings_inner_column.py → column_mapping_column.py} +12 -12
  23. graphscope/flex/rest/models/{schema_mapping_loading_config_data_source.py → create_alert_receiver_request.py} +29 -24
  24. graphscope/flex/rest/models/{alert_rule.py → create_alert_rule_request.py} +19 -25
  25. graphscope/flex/rest/models/create_dataloading_job_response.py +88 -0
  26. graphscope/flex/rest/models/create_edge_type.py +114 -0
  27. graphscope/flex/rest/models/{data_source.py → create_graph_request.py} +32 -32
  28. graphscope/flex/rest/models/create_graph_response.py +88 -0
  29. graphscope/flex/rest/models/{model_schema.py → create_graph_schema_request.py} +25 -25
  30. graphscope/flex/rest/models/{groot_vertex_type.py → create_property_meta.py} +32 -25
  31. graphscope/flex/rest/models/{graph_stored_procedures.py → create_stored_proc_request.py} +26 -23
  32. graphscope/flex/rest/models/create_stored_proc_response.py +88 -0
  33. graphscope/flex/rest/models/create_vertex_type.py +108 -0
  34. graphscope/flex/rest/models/{groot_dataloading_job_config.py → dataloading_job_config.py} +45 -21
  35. graphscope/flex/rest/models/{groot_dataloading_job_config_edges_inner.py → dataloading_job_config_edges_inner.py} +12 -12
  36. graphscope/flex/rest/models/{schema_mapping_loading_config.py → dataloading_job_config_loading_config.py} +16 -22
  37. graphscope/flex/rest/models/{schema_mapping_loading_config_format.py → dataloading_job_config_loading_config_format.py} +12 -12
  38. graphscope/flex/rest/models/dataloading_job_config_vertices_inner.py +88 -0
  39. graphscope/flex/rest/models/dataloading_mr_job_config.py +88 -0
  40. graphscope/flex/rest/models/date_type.py +88 -0
  41. graphscope/flex/rest/models/edge_mapping.py +23 -25
  42. graphscope/flex/rest/models/edge_mapping_type_triplet.py +12 -12
  43. graphscope/flex/rest/models/error.py +90 -0
  44. graphscope/flex/rest/models/{alert_message.py → get_alert_message_response.py} +23 -32
  45. graphscope/flex/rest/models/{alert_receiver.py → get_alert_receiver_response.py} +22 -25
  46. graphscope/flex/rest/models/{connection_status.py → get_alert_rule_response.py} +37 -33
  47. graphscope/flex/rest/models/{edge_type.py → get_edge_type.py} +33 -27
  48. graphscope/flex/rest/models/{graph.py → get_graph_response.py} +36 -22
  49. graphscope/flex/rest/models/{groot_schema.py → get_graph_schema_response.py} +32 -32
  50. graphscope/flex/rest/models/get_pod_log_response.py +88 -0
  51. graphscope/flex/rest/models/{edge_mapping_destination_vertex_mappings_inner.py → get_property_meta.py} +34 -19
  52. graphscope/flex/rest/models/get_resource_usage_response.py +105 -0
  53. graphscope/flex/rest/models/get_storage_usage_response.py +88 -0
  54. graphscope/flex/rest/models/{procedure.py → get_stored_proc_response.py} +35 -36
  55. graphscope/flex/rest/models/{groot_edge_type.py → get_vertex_type.py} +33 -31
  56. graphscope/flex/rest/models/gs_data_type.py +152 -0
  57. graphscope/flex/rest/models/job_status.py +14 -17
  58. graphscope/flex/rest/models/{connection.py → long_text.py} +20 -15
  59. graphscope/flex/rest/models/node_status.py +15 -15
  60. graphscope/flex/rest/models/{procedure_params_inner.py → parameter.py} +20 -16
  61. graphscope/flex/rest/models/{deployment_info_graphs_info_value.py → pod_status.py} +34 -20
  62. graphscope/flex/rest/models/{property_property_type.py → primitive_type.py} +16 -19
  63. graphscope/flex/rest/models/resource_usage.py +92 -0
  64. graphscope/flex/rest/models/{deployment_info.py → running_deployment_info.py} +42 -45
  65. graphscope/flex/rest/models/running_deployment_status.py +124 -0
  66. graphscope/flex/rest/models/schema_mapping.py +18 -26
  67. graphscope/flex/rest/models/service_status.py +22 -13
  68. graphscope/flex/rest/models/service_status_sdk_endpoints.py +8 -8
  69. graphscope/flex/rest/models/start_service_request.py +11 -11
  70. graphscope/flex/rest/models/{groot_graph.py → stored_procedure_meta.py} +44 -36
  71. graphscope/flex/rest/models/string_type.py +92 -0
  72. graphscope/flex/rest/models/string_type_string.py +124 -0
  73. graphscope/flex/rest/models/temporal_type.py +92 -0
  74. graphscope/flex/rest/models/temporal_type_temporal.py +138 -0
  75. graphscope/flex/rest/models/time_stamp_type.py +88 -0
  76. graphscope/flex/rest/models/update_alert_message_status_request.py +97 -0
  77. graphscope/flex/rest/models/update_stored_proc_request.py +88 -0
  78. graphscope/flex/rest/models/upload_file_response.py +90 -0
  79. graphscope/flex/rest/models/vertex_mapping.py +13 -13
  80. graphscope/flex/rest/rest.py +4 -2
  81. graphscope_flex-0.28.0a20240919.dist-info/METADATA +19 -0
  82. graphscope_flex-0.28.0a20240919.dist-info/RECORD +86 -0
  83. {graphscope_flex-0.27.0.dist-info → graphscope_flex-0.28.0a20240919.dist-info}/WHEEL +1 -1
  84. graphscope/flex/rest/api/connection_api.py +0 -550
  85. graphscope/flex/rest/api/datasource_api.py +0 -2308
  86. graphscope/flex/rest/models/deployment_status.py +0 -108
  87. graphscope/flex/rest/models/edge_data_source.py +0 -112
  88. graphscope/flex/rest/models/edge_mapping_source_vertex_mappings_inner.py +0 -92
  89. graphscope/flex/rest/models/groot_graph_gremlin_interface.py +0 -94
  90. graphscope/flex/rest/models/groot_property.py +0 -104
  91. graphscope/flex/rest/models/update_alert_messages_request.py +0 -110
  92. graphscope/flex/rest/models/vertex_data_source.py +0 -104
  93. graphscope_flex-0.27.0.dist-info/METADATA +0 -17
  94. graphscope_flex-0.27.0.dist-info/RECORD +0 -71
  95. {graphscope_flex-0.27.0.dist-info → graphscope_flex-0.28.0a20240919.dist-info}/top_level.txt +0 -0
@@ -1,550 +0,0 @@
1
- # coding: utf-8
2
-
3
- """
4
- GraphScope FLEX HTTP SERVICE API
5
-
6
- This is a specification for GraphScope FLEX HTTP service based on the OpenAPI 3.0 specification. You can find out more details about specification at [doc](https://swagger.io/specification/v3/). Some useful links: - [GraphScope Repository](https://github.com/alibaba/GraphScope) - [The Source API definition for GraphScope Interactive](https://github.com/GraphScope/portal/tree/main/httpservice)
7
-
8
- The version of the OpenAPI document: 0.9.1
9
- Contact: graphscope@alibaba-inc.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 graphscope.flex.rest.models.connection import Connection
21
- from graphscope.flex.rest.models.connection_status import ConnectionStatus
22
-
23
- from graphscope.flex.rest.api_client import ApiClient, RequestSerialized
24
- from graphscope.flex.rest.api_response import ApiResponse
25
- from graphscope.flex.rest.rest import RESTResponseType
26
-
27
-
28
- class ConnectionApi:
29
- """NOTE: This class is auto generated by OpenAPI Generator
30
- Ref: https://openapi-generator.tech
31
-
32
- Do not edit the class manually.
33
- """
34
-
35
- def __init__(self, api_client=None) -> None:
36
- if api_client is None:
37
- api_client = ApiClient.get_default()
38
- self.api_client = api_client
39
-
40
-
41
- @validate_call
42
- def close(
43
- self,
44
- _request_timeout: Union[
45
- None,
46
- Annotated[StrictFloat, Field(gt=0)],
47
- Tuple[
48
- Annotated[StrictFloat, Field(gt=0)],
49
- Annotated[StrictFloat, Field(gt=0)]
50
- ]
51
- ] = None,
52
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
53
- _content_type: Optional[StrictStr] = None,
54
- _headers: Optional[Dict[StrictStr, Any]] = None,
55
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
56
- ) -> str:
57
- """close
58
-
59
- Close the connection with coordinator
60
-
61
- :param _request_timeout: timeout setting for this request. If one
62
- number provided, it will be total request
63
- timeout. It can also be a pair (tuple) of
64
- (connection, read) timeouts.
65
- :type _request_timeout: int, tuple(int, int), optional
66
- :param _request_auth: set to override the auth_settings for an a single
67
- request; this effectively ignores the
68
- authentication in the spec for a single request.
69
- :type _request_auth: dict, optional
70
- :param _content_type: force content-type for the request.
71
- :type _content_type: str, Optional
72
- :param _headers: set to override the headers for a single
73
- request; this effectively ignores the headers
74
- in the spec for a single request.
75
- :type _headers: dict, optional
76
- :param _host_index: set to override the host_index for a single
77
- request; this effectively ignores the host_index
78
- in the spec for a single request.
79
- :type _host_index: int, optional
80
- :return: Returns the result object.
81
- """ # noqa: E501
82
-
83
- _param = self._close_serialize(
84
- _request_auth=_request_auth,
85
- _content_type=_content_type,
86
- _headers=_headers,
87
- _host_index=_host_index
88
- )
89
-
90
- _response_types_map: Dict[str, Optional[str]] = {
91
- '200': "str",
92
- }
93
- response_data = self.api_client.call_api(
94
- *_param,
95
- _request_timeout=_request_timeout
96
- )
97
- response_data.read()
98
- return self.api_client.response_deserialize(
99
- response_data=response_data,
100
- response_types_map=_response_types_map,
101
- ).data
102
-
103
-
104
- @validate_call
105
- def close_with_http_info(
106
- self,
107
- _request_timeout: Union[
108
- None,
109
- Annotated[StrictFloat, Field(gt=0)],
110
- Tuple[
111
- Annotated[StrictFloat, Field(gt=0)],
112
- Annotated[StrictFloat, Field(gt=0)]
113
- ]
114
- ] = None,
115
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
116
- _content_type: Optional[StrictStr] = None,
117
- _headers: Optional[Dict[StrictStr, Any]] = None,
118
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
119
- ) -> ApiResponse[str]:
120
- """close
121
-
122
- Close the connection with coordinator
123
-
124
- :param _request_timeout: timeout setting for this request. If one
125
- number provided, it will be total request
126
- timeout. It can also be a pair (tuple) of
127
- (connection, read) timeouts.
128
- :type _request_timeout: int, tuple(int, int), optional
129
- :param _request_auth: set to override the auth_settings for an a single
130
- request; this effectively ignores the
131
- authentication in the spec for a single request.
132
- :type _request_auth: dict, optional
133
- :param _content_type: force content-type for the request.
134
- :type _content_type: str, Optional
135
- :param _headers: set to override the headers for a single
136
- request; this effectively ignores the headers
137
- in the spec for a single request.
138
- :type _headers: dict, optional
139
- :param _host_index: set to override the host_index for a single
140
- request; this effectively ignores the host_index
141
- in the spec for a single request.
142
- :type _host_index: int, optional
143
- :return: Returns the result object.
144
- """ # noqa: E501
145
-
146
- _param = self._close_serialize(
147
- _request_auth=_request_auth,
148
- _content_type=_content_type,
149
- _headers=_headers,
150
- _host_index=_host_index
151
- )
152
-
153
- _response_types_map: Dict[str, Optional[str]] = {
154
- '200': "str",
155
- }
156
- response_data = self.api_client.call_api(
157
- *_param,
158
- _request_timeout=_request_timeout
159
- )
160
- response_data.read()
161
- return self.api_client.response_deserialize(
162
- response_data=response_data,
163
- response_types_map=_response_types_map,
164
- )
165
-
166
-
167
- @validate_call
168
- def close_without_preload_content(
169
- self,
170
- _request_timeout: Union[
171
- None,
172
- Annotated[StrictFloat, Field(gt=0)],
173
- Tuple[
174
- Annotated[StrictFloat, Field(gt=0)],
175
- Annotated[StrictFloat, Field(gt=0)]
176
- ]
177
- ] = None,
178
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
179
- _content_type: Optional[StrictStr] = None,
180
- _headers: Optional[Dict[StrictStr, Any]] = None,
181
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
182
- ) -> RESTResponseType:
183
- """close
184
-
185
- Close the connection with coordinator
186
-
187
- :param _request_timeout: timeout setting for this request. If one
188
- number provided, it will be total request
189
- timeout. It can also be a pair (tuple) of
190
- (connection, read) timeouts.
191
- :type _request_timeout: int, tuple(int, int), optional
192
- :param _request_auth: set to override the auth_settings for an a single
193
- request; this effectively ignores the
194
- authentication in the spec for a single request.
195
- :type _request_auth: dict, optional
196
- :param _content_type: force content-type for the request.
197
- :type _content_type: str, Optional
198
- :param _headers: set to override the headers for a single
199
- request; this effectively ignores the headers
200
- in the spec for a single request.
201
- :type _headers: dict, optional
202
- :param _host_index: set to override the host_index for a single
203
- request; this effectively ignores the host_index
204
- in the spec for a single request.
205
- :type _host_index: int, optional
206
- :return: Returns the result object.
207
- """ # noqa: E501
208
-
209
- _param = self._close_serialize(
210
- _request_auth=_request_auth,
211
- _content_type=_content_type,
212
- _headers=_headers,
213
- _host_index=_host_index
214
- )
215
-
216
- _response_types_map: Dict[str, Optional[str]] = {
217
- '200': "str",
218
- }
219
- response_data = self.api_client.call_api(
220
- *_param,
221
- _request_timeout=_request_timeout
222
- )
223
- return response_data.response
224
-
225
-
226
- def _close_serialize(
227
- self,
228
- _request_auth,
229
- _content_type,
230
- _headers,
231
- _host_index,
232
- ) -> RequestSerialized:
233
-
234
- _host = None
235
-
236
- _collection_formats: Dict[str, str] = {
237
- }
238
-
239
- _path_params: Dict[str, str] = {}
240
- _query_params: List[Tuple[str, str]] = []
241
- _header_params: Dict[str, Optional[str]] = _headers or {}
242
- _form_params: List[Tuple[str, str]] = []
243
- _files: Dict[str, str] = {}
244
- _body_params: Optional[bytes] = None
245
-
246
- # process the path parameters
247
- # process the query parameters
248
- # process the header parameters
249
- # process the form parameters
250
- # process the body parameter
251
-
252
-
253
- # set the HTTP header `Accept`
254
- _header_params['Accept'] = self.api_client.select_header_accept(
255
- [
256
- 'application/json'
257
- ]
258
- )
259
-
260
-
261
- # authentication setting
262
- _auth_settings: List[str] = [
263
- ]
264
-
265
- return self.api_client.param_serialize(
266
- method='DELETE',
267
- resource_path='/api/v1/connection',
268
- path_params=_path_params,
269
- query_params=_query_params,
270
- header_params=_header_params,
271
- body=_body_params,
272
- post_params=_form_params,
273
- files=_files,
274
- auth_settings=_auth_settings,
275
- collection_formats=_collection_formats,
276
- _host=_host,
277
- _request_auth=_request_auth
278
- )
279
-
280
-
281
-
282
-
283
- @validate_call
284
- def connect(
285
- self,
286
- connection: Connection,
287
- _request_timeout: Union[
288
- None,
289
- Annotated[StrictFloat, Field(gt=0)],
290
- Tuple[
291
- Annotated[StrictFloat, Field(gt=0)],
292
- Annotated[StrictFloat, Field(gt=0)]
293
- ]
294
- ] = None,
295
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
296
- _content_type: Optional[StrictStr] = None,
297
- _headers: Optional[Dict[StrictStr, Any]] = None,
298
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
299
- ) -> ConnectionStatus:
300
- """connect
301
-
302
- Connect to coordinator service
303
-
304
- :param connection: (required)
305
- :type connection: Connection
306
- :param _request_timeout: timeout setting for this request. If one
307
- number provided, it will be total request
308
- timeout. It can also be a pair (tuple) of
309
- (connection, read) timeouts.
310
- :type _request_timeout: int, tuple(int, int), optional
311
- :param _request_auth: set to override the auth_settings for an a single
312
- request; this effectively ignores the
313
- authentication in the spec for a single request.
314
- :type _request_auth: dict, optional
315
- :param _content_type: force content-type for the request.
316
- :type _content_type: str, Optional
317
- :param _headers: set to override the headers for a single
318
- request; this effectively ignores the headers
319
- in the spec for a single request.
320
- :type _headers: dict, optional
321
- :param _host_index: set to override the host_index for a single
322
- request; this effectively ignores the host_index
323
- in the spec for a single request.
324
- :type _host_index: int, optional
325
- :return: Returns the result object.
326
- """ # noqa: E501
327
-
328
- _param = self._connect_serialize(
329
- connection=connection,
330
- _request_auth=_request_auth,
331
- _content_type=_content_type,
332
- _headers=_headers,
333
- _host_index=_host_index
334
- )
335
-
336
- _response_types_map: Dict[str, Optional[str]] = {
337
- '200': "ConnectionStatus",
338
- }
339
- response_data = self.api_client.call_api(
340
- *_param,
341
- _request_timeout=_request_timeout
342
- )
343
- response_data.read()
344
- return self.api_client.response_deserialize(
345
- response_data=response_data,
346
- response_types_map=_response_types_map,
347
- ).data
348
-
349
-
350
- @validate_call
351
- def connect_with_http_info(
352
- self,
353
- connection: Connection,
354
- _request_timeout: Union[
355
- None,
356
- Annotated[StrictFloat, Field(gt=0)],
357
- Tuple[
358
- Annotated[StrictFloat, Field(gt=0)],
359
- Annotated[StrictFloat, Field(gt=0)]
360
- ]
361
- ] = None,
362
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
363
- _content_type: Optional[StrictStr] = None,
364
- _headers: Optional[Dict[StrictStr, Any]] = None,
365
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
366
- ) -> ApiResponse[ConnectionStatus]:
367
- """connect
368
-
369
- Connect to coordinator service
370
-
371
- :param connection: (required)
372
- :type connection: Connection
373
- :param _request_timeout: timeout setting for this request. If one
374
- number provided, it will be total request
375
- timeout. It can also be a pair (tuple) of
376
- (connection, read) timeouts.
377
- :type _request_timeout: int, tuple(int, int), optional
378
- :param _request_auth: set to override the auth_settings for an a single
379
- request; this effectively ignores the
380
- authentication in the spec for a single request.
381
- :type _request_auth: dict, optional
382
- :param _content_type: force content-type for the request.
383
- :type _content_type: str, Optional
384
- :param _headers: set to override the headers for a single
385
- request; this effectively ignores the headers
386
- in the spec for a single request.
387
- :type _headers: dict, optional
388
- :param _host_index: set to override the host_index for a single
389
- request; this effectively ignores the host_index
390
- in the spec for a single request.
391
- :type _host_index: int, optional
392
- :return: Returns the result object.
393
- """ # noqa: E501
394
-
395
- _param = self._connect_serialize(
396
- connection=connection,
397
- _request_auth=_request_auth,
398
- _content_type=_content_type,
399
- _headers=_headers,
400
- _host_index=_host_index
401
- )
402
-
403
- _response_types_map: Dict[str, Optional[str]] = {
404
- '200': "ConnectionStatus",
405
- }
406
- response_data = self.api_client.call_api(
407
- *_param,
408
- _request_timeout=_request_timeout
409
- )
410
- response_data.read()
411
- return self.api_client.response_deserialize(
412
- response_data=response_data,
413
- response_types_map=_response_types_map,
414
- )
415
-
416
-
417
- @validate_call
418
- def connect_without_preload_content(
419
- self,
420
- connection: Connection,
421
- _request_timeout: Union[
422
- None,
423
- Annotated[StrictFloat, Field(gt=0)],
424
- Tuple[
425
- Annotated[StrictFloat, Field(gt=0)],
426
- Annotated[StrictFloat, Field(gt=0)]
427
- ]
428
- ] = None,
429
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
430
- _content_type: Optional[StrictStr] = None,
431
- _headers: Optional[Dict[StrictStr, Any]] = None,
432
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
433
- ) -> RESTResponseType:
434
- """connect
435
-
436
- Connect to coordinator service
437
-
438
- :param connection: (required)
439
- :type connection: Connection
440
- :param _request_timeout: timeout setting for this request. If one
441
- number provided, it will be total request
442
- timeout. It can also be a pair (tuple) of
443
- (connection, read) timeouts.
444
- :type _request_timeout: int, tuple(int, int), optional
445
- :param _request_auth: set to override the auth_settings for an a single
446
- request; this effectively ignores the
447
- authentication in the spec for a single request.
448
- :type _request_auth: dict, optional
449
- :param _content_type: force content-type for the request.
450
- :type _content_type: str, Optional
451
- :param _headers: set to override the headers for a single
452
- request; this effectively ignores the headers
453
- in the spec for a single request.
454
- :type _headers: dict, optional
455
- :param _host_index: set to override the host_index for a single
456
- request; this effectively ignores the host_index
457
- in the spec for a single request.
458
- :type _host_index: int, optional
459
- :return: Returns the result object.
460
- """ # noqa: E501
461
-
462
- _param = self._connect_serialize(
463
- connection=connection,
464
- _request_auth=_request_auth,
465
- _content_type=_content_type,
466
- _headers=_headers,
467
- _host_index=_host_index
468
- )
469
-
470
- _response_types_map: Dict[str, Optional[str]] = {
471
- '200': "ConnectionStatus",
472
- }
473
- response_data = self.api_client.call_api(
474
- *_param,
475
- _request_timeout=_request_timeout
476
- )
477
- return response_data.response
478
-
479
-
480
- def _connect_serialize(
481
- self,
482
- connection,
483
- _request_auth,
484
- _content_type,
485
- _headers,
486
- _host_index,
487
- ) -> RequestSerialized:
488
-
489
- _host = None
490
-
491
- _collection_formats: Dict[str, str] = {
492
- }
493
-
494
- _path_params: Dict[str, str] = {}
495
- _query_params: List[Tuple[str, str]] = []
496
- _header_params: Dict[str, Optional[str]] = _headers or {}
497
- _form_params: List[Tuple[str, str]] = []
498
- _files: Dict[str, str] = {}
499
- _body_params: Optional[bytes] = None
500
-
501
- # process the path parameters
502
- # process the query parameters
503
- # process the header parameters
504
- # process the form parameters
505
- # process the body parameter
506
- if connection is not None:
507
- _body_params = connection
508
-
509
-
510
- # set the HTTP header `Accept`
511
- _header_params['Accept'] = self.api_client.select_header_accept(
512
- [
513
- 'application/json'
514
- ]
515
- )
516
-
517
- # set the HTTP header `Content-Type`
518
- if _content_type:
519
- _header_params['Content-Type'] = _content_type
520
- else:
521
- _default_content_type = (
522
- self.api_client.select_header_content_type(
523
- [
524
- 'application/json'
525
- ]
526
- )
527
- )
528
- if _default_content_type is not None:
529
- _header_params['Content-Type'] = _default_content_type
530
-
531
- # authentication setting
532
- _auth_settings: List[str] = [
533
- ]
534
-
535
- return self.api_client.param_serialize(
536
- method='POST',
537
- resource_path='/api/v1/connection',
538
- path_params=_path_params,
539
- query_params=_query_params,
540
- header_params=_header_params,
541
- body=_body_params,
542
- post_params=_form_params,
543
- files=_files,
544
- auth_settings=_auth_settings,
545
- collection_formats=_collection_formats,
546
- _host=_host,
547
- _request_auth=_request_auth
548
- )
549
-
550
-