cosmotech-api 3.1.1__py3-none-any.whl → 3.2.0.post1__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 (244) hide show
  1. cosmotech_api/__init__.py +134 -9
  2. cosmotech_api/api/__init__.py +14 -3
  3. cosmotech_api/api/connector_api.py +1313 -641
  4. cosmotech_api/api/dataset_api.py +8974 -4465
  5. cosmotech_api/api/organization_api.py +4633 -2269
  6. cosmotech_api/api/run_api.py +2174 -778
  7. cosmotech_api/api/runner_api.py +4483 -2280
  8. cosmotech_api/api/scenario_api.py +6544 -3265
  9. cosmotech_api/api/scenariorun_api.py +4007 -1960
  10. cosmotech_api/api/scenariorunresult_api.py +659 -341
  11. cosmotech_api/api/solution_api.py +6341 -3140
  12. cosmotech_api/api/twingraph_api.py +4134 -2077
  13. cosmotech_api/api/validator_api.py +2501 -1249
  14. cosmotech_api/api/workspace_api.py +5999 -2977
  15. cosmotech_api/api_client.py +529 -637
  16. cosmotech_api/configuration.py +63 -73
  17. cosmotech_api/exceptions.py +71 -31
  18. cosmotech_api/model/component_role_permissions.py +1 -1
  19. cosmotech_api/model/connector.py +1 -1
  20. cosmotech_api/model/connector_parameter.py +1 -1
  21. cosmotech_api/model/connector_parameter_group.py +1 -1
  22. cosmotech_api/model/container_resource_size_info.py +1 -1
  23. cosmotech_api/model/container_resource_sizing.py +1 -1
  24. cosmotech_api/model/dataset.py +1 -1
  25. cosmotech_api/model/dataset_access_control.py +1 -1
  26. cosmotech_api/model/dataset_compatibility.py +1 -1
  27. cosmotech_api/model/dataset_connector.py +1 -1
  28. cosmotech_api/model/dataset_copy_parameters.py +1 -1
  29. cosmotech_api/model/dataset_role.py +1 -1
  30. cosmotech_api/model/dataset_search.py +1 -1
  31. cosmotech_api/model/dataset_security.py +1 -1
  32. cosmotech_api/model/dataset_source_type.py +1 -1
  33. cosmotech_api/model/dataset_twin_graph_hash.py +1 -1
  34. cosmotech_api/model/dataset_twin_graph_info.py +1 -1
  35. cosmotech_api/model/dataset_twin_graph_query.py +1 -1
  36. cosmotech_api/model/delete_historical_data.py +1 -1
  37. cosmotech_api/model/file_upload_metadata.py +1 -1
  38. cosmotech_api/model/file_upload_validation.py +1 -1
  39. cosmotech_api/model/graph_properties.py +1 -1
  40. cosmotech_api/model/organization.py +1 -1
  41. cosmotech_api/model/organization_access_control.py +1 -1
  42. cosmotech_api/model/organization_role.py +1 -1
  43. cosmotech_api/model/organization_security.py +1 -1
  44. cosmotech_api/model/organization_service.py +1 -1
  45. cosmotech_api/model/organization_services.py +1 -1
  46. cosmotech_api/model/resource_size_info.py +1 -1
  47. cosmotech_api/model/run.py +1 -1
  48. cosmotech_api/model/run_container.py +1 -1
  49. cosmotech_api/model/run_container_artifact.py +1 -1
  50. cosmotech_api/model/run_container_logs.py +1 -1
  51. cosmotech_api/model/run_logs.py +1 -1
  52. cosmotech_api/model/run_resource_requested.py +1 -1
  53. cosmotech_api/model/run_search.py +1 -1
  54. cosmotech_api/model/run_start_containers.py +1 -1
  55. cosmotech_api/model/run_state.py +1 -1
  56. cosmotech_api/model/run_status.py +1 -1
  57. cosmotech_api/model/run_status_node.py +1 -1
  58. cosmotech_api/model/run_template.py +1 -1
  59. cosmotech_api/model/run_template_handler_id.py +1 -1
  60. cosmotech_api/model/run_template_orchestrator.py +1 -1
  61. cosmotech_api/model/run_template_parameter.py +1 -1
  62. cosmotech_api/model/run_template_parameter_group.py +1 -1
  63. cosmotech_api/model/run_template_parameter_value.py +1 -1
  64. cosmotech_api/model/run_template_resource_sizing.py +1 -1
  65. cosmotech_api/model/run_template_step_source.py +1 -1
  66. cosmotech_api/model/runner.py +1 -1
  67. cosmotech_api/model/runner_access_control.py +1 -1
  68. cosmotech_api/model/runner_changed_parameter_value.py +1 -1
  69. cosmotech_api/model/runner_comparison_result.py +1 -1
  70. cosmotech_api/model/runner_data_download_info.py +1 -1
  71. cosmotech_api/model/runner_data_download_job.py +1 -1
  72. cosmotech_api/model/runner_job_state.py +1 -1
  73. cosmotech_api/model/runner_last_run.py +1 -1
  74. cosmotech_api/model/runner_resource_sizing.py +1 -1
  75. cosmotech_api/model/runner_role.py +1 -1
  76. cosmotech_api/model/runner_run_template_parameter_value.py +1 -1
  77. cosmotech_api/model/runner_security.py +1 -1
  78. cosmotech_api/model/runner_validation_status.py +1 -1
  79. cosmotech_api/model/scenario.py +1 -1
  80. cosmotech_api/model/scenario_access_control.py +1 -1
  81. cosmotech_api/model/scenario_changed_parameter_value.py +1 -1
  82. cosmotech_api/model/scenario_comparison_result.py +1 -1
  83. cosmotech_api/model/scenario_data_download_info.py +1 -1
  84. cosmotech_api/model/scenario_data_download_job.py +1 -1
  85. cosmotech_api/model/scenario_job_state.py +1 -1
  86. cosmotech_api/model/scenario_last_run.py +1 -1
  87. cosmotech_api/model/scenario_resource_sizing.py +1 -1
  88. cosmotech_api/model/scenario_role.py +1 -1
  89. cosmotech_api/model/scenario_run.py +1 -1
  90. cosmotech_api/model/scenario_run_container.py +1 -1
  91. cosmotech_api/model/scenario_run_container_artifact.py +1 -1
  92. cosmotech_api/model/scenario_run_container_logs.py +1 -1
  93. cosmotech_api/model/scenario_run_logs.py +1 -1
  94. cosmotech_api/model/scenario_run_resource_requested.py +1 -1
  95. cosmotech_api/model/scenario_run_result.py +1 -1
  96. cosmotech_api/model/scenario_run_search.py +1 -1
  97. cosmotech_api/model/scenario_run_start_containers.py +1 -1
  98. cosmotech_api/model/scenario_run_state.py +1 -1
  99. cosmotech_api/model/scenario_run_status.py +1 -1
  100. cosmotech_api/model/scenario_run_status_node.py +1 -1
  101. cosmotech_api/model/scenario_run_template_parameter_value.py +1 -1
  102. cosmotech_api/model/scenario_security.py +1 -1
  103. cosmotech_api/model/scenario_validation_status.py +1 -1
  104. cosmotech_api/model/solution.py +1 -1
  105. cosmotech_api/model/solution_access_control.py +1 -1
  106. cosmotech_api/model/solution_role.py +1 -1
  107. cosmotech_api/model/solution_security.py +1 -1
  108. cosmotech_api/model/source_info.py +1 -1
  109. cosmotech_api/model/sub_dataset_graph_query.py +1 -1
  110. cosmotech_api/model/translated_labels.py +1 -1
  111. cosmotech_api/model/twin_graph_batch_result.py +1 -1
  112. cosmotech_api/model/twin_graph_hash.py +1 -1
  113. cosmotech_api/model/twin_graph_import.py +1 -1
  114. cosmotech_api/model/twin_graph_import_info.py +1 -1
  115. cosmotech_api/model/twin_graph_query.py +1 -1
  116. cosmotech_api/model/validator.py +1 -1
  117. cosmotech_api/model/validator_run.py +1 -1
  118. cosmotech_api/model/workspace.py +1 -1
  119. cosmotech_api/model/workspace_access_control.py +1 -1
  120. cosmotech_api/model/workspace_file.py +1 -1
  121. cosmotech_api/model/workspace_role.py +1 -1
  122. cosmotech_api/model/workspace_secret.py +1 -1
  123. cosmotech_api/model/workspace_security.py +1 -1
  124. cosmotech_api/model/workspace_solution.py +1 -1
  125. cosmotech_api/model/workspace_web_app.py +1 -1
  126. cosmotech_api/model_utils.py +1 -1
  127. cosmotech_api/models/__init__.py +124 -114
  128. cosmotech_api/models/component_role_permissions.py +1 -1
  129. cosmotech_api/models/connector.py +1 -1
  130. cosmotech_api/models/connector_parameter.py +1 -1
  131. cosmotech_api/models/connector_parameter_group.py +1 -1
  132. cosmotech_api/models/container_resource_size_info.py +1 -1
  133. cosmotech_api/models/container_resource_sizing.py +1 -1
  134. cosmotech_api/models/dataset.py +1 -1
  135. cosmotech_api/models/dataset_access_control.py +1 -1
  136. cosmotech_api/models/dataset_compatibility.py +1 -1
  137. cosmotech_api/models/dataset_connector.py +1 -1
  138. cosmotech_api/models/dataset_copy_parameters.py +1 -1
  139. cosmotech_api/models/dataset_role.py +1 -1
  140. cosmotech_api/models/dataset_search.py +1 -1
  141. cosmotech_api/models/dataset_security.py +1 -1
  142. cosmotech_api/models/dataset_source_type.py +1 -1
  143. cosmotech_api/models/dataset_twin_graph_hash.py +1 -1
  144. cosmotech_api/models/dataset_twin_graph_info.py +1 -1
  145. cosmotech_api/models/dataset_twin_graph_query.py +1 -1
  146. cosmotech_api/models/delete_historical_data.py +1 -1
  147. cosmotech_api/models/file_upload_metadata.py +1 -1
  148. cosmotech_api/models/file_upload_validation.py +1 -1
  149. cosmotech_api/models/graph_properties.py +1 -1
  150. cosmotech_api/models/organization.py +1 -1
  151. cosmotech_api/models/organization_access_control.py +1 -1
  152. cosmotech_api/models/organization_role.py +1 -1
  153. cosmotech_api/models/organization_security.py +1 -1
  154. cosmotech_api/models/organization_service.py +1 -1
  155. cosmotech_api/models/organization_services.py +1 -1
  156. cosmotech_api/models/query_result.py +88 -0
  157. cosmotech_api/models/resource_size_info.py +1 -1
  158. cosmotech_api/models/run.py +1 -1
  159. cosmotech_api/models/run_container.py +1 -1
  160. cosmotech_api/models/run_container_artifact.py +1 -1
  161. cosmotech_api/models/run_container_logs.py +1 -1
  162. cosmotech_api/models/run_data.py +92 -0
  163. cosmotech_api/models/run_data_query.py +88 -0
  164. cosmotech_api/models/run_logs.py +1 -1
  165. cosmotech_api/models/run_resource_requested.py +1 -1
  166. cosmotech_api/models/run_search.py +1 -1
  167. cosmotech_api/models/run_start_containers.py +1 -1
  168. cosmotech_api/models/run_state.py +1 -1
  169. cosmotech_api/models/run_status.py +1 -1
  170. cosmotech_api/models/run_status_node.py +1 -1
  171. cosmotech_api/models/run_template.py +1 -1
  172. cosmotech_api/models/run_template_handler_id.py +1 -1
  173. cosmotech_api/models/run_template_orchestrator.py +1 -1
  174. cosmotech_api/models/run_template_parameter.py +1 -1
  175. cosmotech_api/models/run_template_parameter_group.py +1 -1
  176. cosmotech_api/models/run_template_parameter_value.py +1 -1
  177. cosmotech_api/models/run_template_resource_sizing.py +1 -1
  178. cosmotech_api/models/run_template_step_source.py +1 -1
  179. cosmotech_api/models/runner.py +1 -1
  180. cosmotech_api/models/runner_access_control.py +1 -1
  181. cosmotech_api/models/runner_changed_parameter_value.py +1 -1
  182. cosmotech_api/models/runner_comparison_result.py +1 -1
  183. cosmotech_api/models/runner_data_download_info.py +1 -1
  184. cosmotech_api/models/runner_data_download_job.py +1 -1
  185. cosmotech_api/models/runner_job_state.py +1 -1
  186. cosmotech_api/models/runner_last_run.py +1 -1
  187. cosmotech_api/models/runner_parent_last_run.py +1 -1
  188. cosmotech_api/models/runner_resource_sizing.py +1 -1
  189. cosmotech_api/models/runner_role.py +1 -1
  190. cosmotech_api/models/runner_root_last_run.py +1 -1
  191. cosmotech_api/models/runner_run_template_parameter_value.py +1 -1
  192. cosmotech_api/models/runner_security.py +1 -1
  193. cosmotech_api/models/runner_validation_status.py +1 -1
  194. cosmotech_api/models/scenario.py +1 -1
  195. cosmotech_api/models/scenario_access_control.py +1 -1
  196. cosmotech_api/models/scenario_changed_parameter_value.py +1 -1
  197. cosmotech_api/models/scenario_comparison_result.py +1 -1
  198. cosmotech_api/models/scenario_data_download_info.py +1 -1
  199. cosmotech_api/models/scenario_data_download_job.py +1 -1
  200. cosmotech_api/models/scenario_job_state.py +1 -1
  201. cosmotech_api/models/scenario_last_run.py +1 -1
  202. cosmotech_api/models/scenario_resource_sizing.py +1 -1
  203. cosmotech_api/models/scenario_role.py +1 -1
  204. cosmotech_api/models/scenario_run.py +1 -1
  205. cosmotech_api/models/scenario_run_container.py +1 -1
  206. cosmotech_api/models/scenario_run_container_artifact.py +1 -1
  207. cosmotech_api/models/scenario_run_container_logs.py +1 -1
  208. cosmotech_api/models/scenario_run_logs.py +1 -1
  209. cosmotech_api/models/scenario_run_resource_requested.py +1 -1
  210. cosmotech_api/models/scenario_run_search.py +1 -1
  211. cosmotech_api/models/scenario_run_start_containers.py +1 -1
  212. cosmotech_api/models/scenario_run_state.py +1 -1
  213. cosmotech_api/models/scenario_run_status.py +1 -1
  214. cosmotech_api/models/scenario_run_status_node.py +1 -1
  215. cosmotech_api/models/scenario_run_template_parameter_value.py +1 -1
  216. cosmotech_api/models/scenario_security.py +1 -1
  217. cosmotech_api/models/scenario_validation_status.py +1 -1
  218. cosmotech_api/models/send_run_data_request.py +90 -0
  219. cosmotech_api/models/solution.py +1 -1
  220. cosmotech_api/models/solution_access_control.py +1 -1
  221. cosmotech_api/models/solution_role.py +1 -1
  222. cosmotech_api/models/solution_security.py +1 -1
  223. cosmotech_api/models/source_info.py +1 -1
  224. cosmotech_api/models/sub_dataset_graph_query.py +1 -1
  225. cosmotech_api/models/twin_graph_batch_result.py +1 -1
  226. cosmotech_api/models/twin_graph_hash.py +1 -1
  227. cosmotech_api/models/twin_graph_query.py +1 -1
  228. cosmotech_api/models/validator.py +1 -1
  229. cosmotech_api/models/validator_run.py +1 -1
  230. cosmotech_api/models/workspace.py +1 -1
  231. cosmotech_api/models/workspace_access_control.py +1 -1
  232. cosmotech_api/models/workspace_file.py +1 -1
  233. cosmotech_api/models/workspace_role.py +1 -1
  234. cosmotech_api/models/workspace_secret.py +1 -1
  235. cosmotech_api/models/workspace_security.py +1 -1
  236. cosmotech_api/models/workspace_solution.py +1 -1
  237. cosmotech_api/models/workspace_web_app.py +1 -1
  238. cosmotech_api/rest.py +139 -230
  239. {cosmotech_api-3.1.1.dist-info → cosmotech_api-3.2.0.post1.dist-info}/METADATA +6 -4
  240. cosmotech_api-3.2.0.post1.dist-info/RECORD +255 -0
  241. cosmotech_api-3.1.1.dist-info/RECORD +0 -251
  242. {cosmotech_api-3.1.1.dist-info → cosmotech_api-3.2.0.post1.dist-info}/LICENSE +0 -0
  243. {cosmotech_api-3.1.1.dist-info → cosmotech_api-3.2.0.post1.dist-info}/WHEEL +0 -0
  244. {cosmotech_api-3.1.1.dist-info → cosmotech_api-3.2.0.post1.dist-info}/top_level.txt +0 -0
@@ -1,831 +1,2227 @@
1
+ # coding: utf-8
2
+
1
3
  """
2
4
  Cosmo Tech Platform API
3
5
 
4
- Cosmo Tech Platform API # noqa: E501
6
+ Cosmo Tech Platform API
5
7
 
6
- The version of the OpenAPI document: 3.1.1
8
+ The version of the OpenAPI document: 3.2.0
7
9
  Contact: platform@cosmotech.com
8
- Generated by: https://openapi-generator.tech
9
- """
10
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
11
+
12
+ Do not edit the class manually.
13
+ """ # noqa: E501
10
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
11
19
 
12
- import re # noqa: F401
13
- import sys # noqa: F401
20
+ from pydantic import Field, StrictInt, StrictStr
21
+ from typing import Optional
22
+ from typing_extensions import Annotated
23
+ from cosmotech_api.models.query_result import QueryResult
24
+ from cosmotech_api.models.run import Run
25
+ from cosmotech_api.models.run_data import RunData
26
+ from cosmotech_api.models.run_data_query import RunDataQuery
27
+ from cosmotech_api.models.run_logs import RunLogs
28
+ from cosmotech_api.models.run_status import RunStatus
29
+ from cosmotech_api.models.send_run_data_request import SendRunDataRequest
14
30
 
15
- from cosmotech_api.api_client import ApiClient, Endpoint as _Endpoint
16
- from cosmotech_api.model_utils import ( # noqa: F401
17
- check_allowed_values,
18
- check_validations,
19
- date,
20
- datetime,
21
- file_type,
22
- none_type,
23
- validate_and_convert_types
24
- )
25
- from cosmotech_api.model.run import Run
26
- from cosmotech_api.model.run_logs import RunLogs
27
- from cosmotech_api.model.run_status import RunStatus
31
+ from cosmotech_api.api_client import ApiClient, RequestSerialized
32
+ from cosmotech_api.api_response import ApiResponse
33
+ from cosmotech_api.rest import RESTResponseType
28
34
 
29
35
 
30
- class RunApi(object):
36
+ class RunApi:
31
37
  """NOTE: This class is auto generated by OpenAPI Generator
32
38
  Ref: https://openapi-generator.tech
33
39
 
34
40
  Do not edit the class manually.
35
41
  """
36
42
 
37
- def __init__(self, api_client=None):
43
+ def __init__(self, api_client=None) -> None:
38
44
  if api_client is None:
39
- api_client = ApiClient()
45
+ api_client = ApiClient.get_default()
40
46
  self.api_client = api_client
41
- self.delete_run_endpoint = _Endpoint(
42
- settings={
43
- 'response_type': None,
44
- 'auth': [
45
- 'oAuth2AuthCode'
46
- ],
47
- 'endpoint_path': '/organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs/{run_id}',
48
- 'operation_id': 'delete_run',
49
- 'http_method': 'DELETE',
50
- 'servers': None,
51
- },
52
- params_map={
53
- 'all': [
54
- 'organization_id',
55
- 'workspace_id',
56
- 'runner_id',
57
- 'run_id',
58
- ],
59
- 'required': [
60
- 'organization_id',
61
- 'workspace_id',
62
- 'runner_id',
63
- 'run_id',
64
- ],
65
- 'nullable': [
66
- ],
67
- 'enum': [
68
- ],
69
- 'validation': [
70
- ]
71
- },
72
- root_map={
73
- 'validations': {
74
- },
75
- 'allowed_values': {
76
- },
77
- 'openapi_types': {
78
- 'organization_id':
79
- (str,),
80
- 'workspace_id':
81
- (str,),
82
- 'runner_id':
83
- (str,),
84
- 'run_id':
85
- (str,),
86
- },
87
- 'attribute_map': {
88
- 'organization_id': 'organization_id',
89
- 'workspace_id': 'workspace_id',
90
- 'runner_id': 'runner_id',
91
- 'run_id': 'run_id',
92
- },
93
- 'location_map': {
94
- 'organization_id': 'path',
95
- 'workspace_id': 'path',
96
- 'runner_id': 'path',
97
- 'run_id': 'path',
98
- },
99
- 'collection_format_map': {
100
- }
101
- },
102
- headers_map={
103
- 'accept': [],
104
- 'content_type': [],
105
- },
106
- api_client=api_client
107
- )
108
- self.get_run_endpoint = _Endpoint(
109
- settings={
110
- 'response_type': (Run,),
111
- 'auth': [
112
- 'oAuth2AuthCode'
113
- ],
114
- 'endpoint_path': '/organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs/{run_id}',
115
- 'operation_id': 'get_run',
116
- 'http_method': 'GET',
117
- 'servers': None,
118
- },
119
- params_map={
120
- 'all': [
121
- 'organization_id',
122
- 'workspace_id',
123
- 'runner_id',
124
- 'run_id',
125
- ],
126
- 'required': [
127
- 'organization_id',
128
- 'workspace_id',
129
- 'runner_id',
130
- 'run_id',
131
- ],
132
- 'nullable': [
133
- ],
134
- 'enum': [
135
- ],
136
- 'validation': [
137
- ]
138
- },
139
- root_map={
140
- 'validations': {
141
- },
142
- 'allowed_values': {
143
- },
144
- 'openapi_types': {
145
- 'organization_id':
146
- (str,),
147
- 'workspace_id':
148
- (str,),
149
- 'runner_id':
150
- (str,),
151
- 'run_id':
152
- (str,),
153
- },
154
- 'attribute_map': {
155
- 'organization_id': 'organization_id',
156
- 'workspace_id': 'workspace_id',
157
- 'runner_id': 'runner_id',
158
- 'run_id': 'run_id',
159
- },
160
- 'location_map': {
161
- 'organization_id': 'path',
162
- 'workspace_id': 'path',
163
- 'runner_id': 'path',
164
- 'run_id': 'path',
165
- },
166
- 'collection_format_map': {
167
- }
168
- },
169
- headers_map={
170
- 'accept': [
171
- 'application/json'
172
- ],
173
- 'content_type': [],
174
- },
175
- api_client=api_client
176
- )
177
- self.get_run_logs_endpoint = _Endpoint(
178
- settings={
179
- 'response_type': (RunLogs,),
180
- 'auth': [
181
- 'oAuth2AuthCode'
182
- ],
183
- 'endpoint_path': '/organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs/{run_id}/logs',
184
- 'operation_id': 'get_run_logs',
185
- 'http_method': 'GET',
186
- 'servers': None,
187
- },
188
- params_map={
189
- 'all': [
190
- 'organization_id',
191
- 'workspace_id',
192
- 'runner_id',
193
- 'run_id',
194
- ],
195
- 'required': [
196
- 'organization_id',
197
- 'workspace_id',
198
- 'runner_id',
199
- 'run_id',
200
- ],
201
- 'nullable': [
202
- ],
203
- 'enum': [
204
- ],
205
- 'validation': [
206
- ]
207
- },
208
- root_map={
209
- 'validations': {
210
- },
211
- 'allowed_values': {
212
- },
213
- 'openapi_types': {
214
- 'organization_id':
215
- (str,),
216
- 'workspace_id':
217
- (str,),
218
- 'runner_id':
219
- (str,),
220
- 'run_id':
221
- (str,),
222
- },
223
- 'attribute_map': {
224
- 'organization_id': 'organization_id',
225
- 'workspace_id': 'workspace_id',
226
- 'runner_id': 'runner_id',
227
- 'run_id': 'run_id',
228
- },
229
- 'location_map': {
230
- 'organization_id': 'path',
231
- 'workspace_id': 'path',
232
- 'runner_id': 'path',
233
- 'run_id': 'path',
234
- },
235
- 'collection_format_map': {
236
- }
237
- },
238
- headers_map={
239
- 'accept': [
240
- 'application/json'
241
- ],
242
- 'content_type': [],
243
- },
244
- api_client=api_client
245
- )
246
- self.get_run_status_endpoint = _Endpoint(
247
- settings={
248
- 'response_type': (RunStatus,),
249
- 'auth': [
250
- 'oAuth2AuthCode'
251
- ],
252
- 'endpoint_path': '/organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs/{run_id}/status',
253
- 'operation_id': 'get_run_status',
254
- 'http_method': 'GET',
255
- 'servers': None,
256
- },
257
- params_map={
258
- 'all': [
259
- 'organization_id',
260
- 'workspace_id',
261
- 'runner_id',
262
- 'run_id',
263
- ],
264
- 'required': [
265
- 'organization_id',
266
- 'workspace_id',
267
- 'runner_id',
268
- 'run_id',
269
- ],
270
- 'nullable': [
271
- ],
272
- 'enum': [
273
- ],
274
- 'validation': [
275
- ]
276
- },
277
- root_map={
278
- 'validations': {
279
- },
280
- 'allowed_values': {
281
- },
282
- 'openapi_types': {
283
- 'organization_id':
284
- (str,),
285
- 'workspace_id':
286
- (str,),
287
- 'runner_id':
288
- (str,),
289
- 'run_id':
290
- (str,),
291
- },
292
- 'attribute_map': {
293
- 'organization_id': 'organization_id',
294
- 'workspace_id': 'workspace_id',
295
- 'runner_id': 'runner_id',
296
- 'run_id': 'run_id',
297
- },
298
- 'location_map': {
299
- 'organization_id': 'path',
300
- 'workspace_id': 'path',
301
- 'runner_id': 'path',
302
- 'run_id': 'path',
303
- },
304
- 'collection_format_map': {
305
- }
306
- },
307
- headers_map={
308
- 'accept': [
309
- 'application/json'
310
- ],
311
- 'content_type': [],
312
- },
313
- api_client=api_client
314
- )
315
- self.list_runs_endpoint = _Endpoint(
316
- settings={
317
- 'response_type': ([Run],),
318
- 'auth': [
319
- 'oAuth2AuthCode'
320
- ],
321
- 'endpoint_path': '/organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs',
322
- 'operation_id': 'list_runs',
323
- 'http_method': 'GET',
324
- 'servers': None,
325
- },
326
- params_map={
327
- 'all': [
328
- 'organization_id',
329
- 'workspace_id',
330
- 'runner_id',
331
- 'page',
332
- 'size',
333
- ],
334
- 'required': [
335
- 'organization_id',
336
- 'workspace_id',
337
- 'runner_id',
338
- ],
339
- 'nullable': [
340
- ],
341
- 'enum': [
342
- ],
343
- 'validation': [
344
- ]
345
- },
346
- root_map={
347
- 'validations': {
348
- },
349
- 'allowed_values': {
350
- },
351
- 'openapi_types': {
352
- 'organization_id':
353
- (str,),
354
- 'workspace_id':
355
- (str,),
356
- 'runner_id':
357
- (str,),
358
- 'page':
359
- (int,),
360
- 'size':
361
- (int,),
362
- },
363
- 'attribute_map': {
364
- 'organization_id': 'organization_id',
365
- 'workspace_id': 'workspace_id',
366
- 'runner_id': 'runner_id',
367
- 'page': 'page',
368
- 'size': 'size',
369
- },
370
- 'location_map': {
371
- 'organization_id': 'path',
372
- 'workspace_id': 'path',
373
- 'runner_id': 'path',
374
- 'page': 'query',
375
- 'size': 'query',
376
- },
377
- 'collection_format_map': {
378
- }
379
- },
380
- headers_map={
381
- 'accept': [
382
- 'application/json'
383
- ],
384
- 'content_type': [],
385
- },
386
- api_client=api_client
387
- )
388
47
 
48
+
49
+ @validate_call
389
50
  def delete_run(
51
+ self,
52
+ organization_id: Annotated[StrictStr, Field(description="the Organization identifier")],
53
+ workspace_id: Annotated[StrictStr, Field(description="the Workspace identifier")],
54
+ runner_id: Annotated[StrictStr, Field(description="the Runner identifier")],
55
+ run_id: Annotated[StrictStr, Field(description="the Run identifier")],
56
+ _request_timeout: Union[
57
+ None,
58
+ Annotated[StrictFloat, Field(gt=0)],
59
+ Tuple[
60
+ Annotated[StrictFloat, Field(gt=0)],
61
+ Annotated[StrictFloat, Field(gt=0)]
62
+ ]
63
+ ] = None,
64
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
65
+ _content_type: Optional[StrictStr] = None,
66
+ _headers: Optional[Dict[StrictStr, Any]] = None,
67
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
68
+ ) -> None:
69
+ """Delete a run
70
+
71
+
72
+ :param organization_id: the Organization identifier (required)
73
+ :type organization_id: str
74
+ :param workspace_id: the Workspace identifier (required)
75
+ :type workspace_id: str
76
+ :param runner_id: the Runner identifier (required)
77
+ :type runner_id: str
78
+ :param run_id: the Run identifier (required)
79
+ :type run_id: str
80
+ :param _request_timeout: timeout setting for this request. If one
81
+ number provided, it will be total request
82
+ timeout. It can also be a pair (tuple) of
83
+ (connection, read) timeouts.
84
+ :type _request_timeout: int, tuple(int, int), optional
85
+ :param _request_auth: set to override the auth_settings for an a single
86
+ request; this effectively ignores the
87
+ authentication in the spec for a single request.
88
+ :type _request_auth: dict, optional
89
+ :param _content_type: force content-type for the request.
90
+ :type _content_type: str, Optional
91
+ :param _headers: set to override the headers for a single
92
+ request; this effectively ignores the headers
93
+ in the spec for a single request.
94
+ :type _headers: dict, optional
95
+ :param _host_index: set to override the host_index for a single
96
+ request; this effectively ignores the host_index
97
+ in the spec for a single request.
98
+ :type _host_index: int, optional
99
+ :return: Returns the result object.
100
+ """ # noqa: E501
101
+
102
+ _param = self._delete_run_serialize(
103
+ organization_id=organization_id,
104
+ workspace_id=workspace_id,
105
+ runner_id=runner_id,
106
+ run_id=run_id,
107
+ _request_auth=_request_auth,
108
+ _content_type=_content_type,
109
+ _headers=_headers,
110
+ _host_index=_host_index
111
+ )
112
+
113
+ _response_types_map: Dict[str, Optional[str]] = {
114
+ '204': None,
115
+ '400': None,
116
+ '404': None,
117
+ }
118
+ response_data = self.api_client.call_api(
119
+ *_param,
120
+ _request_timeout=_request_timeout
121
+ )
122
+ response_data.read()
123
+ return self.api_client.response_deserialize(
124
+ response_data=response_data,
125
+ response_types_map=_response_types_map,
126
+ ).data
127
+
128
+
129
+ @validate_call
130
+ def delete_run_with_http_info(
131
+ self,
132
+ organization_id: Annotated[StrictStr, Field(description="the Organization identifier")],
133
+ workspace_id: Annotated[StrictStr, Field(description="the Workspace identifier")],
134
+ runner_id: Annotated[StrictStr, Field(description="the Runner identifier")],
135
+ run_id: Annotated[StrictStr, Field(description="the Run identifier")],
136
+ _request_timeout: Union[
137
+ None,
138
+ Annotated[StrictFloat, Field(gt=0)],
139
+ Tuple[
140
+ Annotated[StrictFloat, Field(gt=0)],
141
+ Annotated[StrictFloat, Field(gt=0)]
142
+ ]
143
+ ] = None,
144
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
145
+ _content_type: Optional[StrictStr] = None,
146
+ _headers: Optional[Dict[StrictStr, Any]] = None,
147
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
148
+ ) -> ApiResponse[None]:
149
+ """Delete a run
150
+
151
+
152
+ :param organization_id: the Organization identifier (required)
153
+ :type organization_id: str
154
+ :param workspace_id: the Workspace identifier (required)
155
+ :type workspace_id: str
156
+ :param runner_id: the Runner identifier (required)
157
+ :type runner_id: str
158
+ :param run_id: the Run identifier (required)
159
+ :type run_id: 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._delete_run_serialize(
183
+ organization_id=organization_id,
184
+ workspace_id=workspace_id,
185
+ runner_id=runner_id,
186
+ run_id=run_id,
187
+ _request_auth=_request_auth,
188
+ _content_type=_content_type,
189
+ _headers=_headers,
190
+ _host_index=_host_index
191
+ )
192
+
193
+ _response_types_map: Dict[str, Optional[str]] = {
194
+ '204': None,
195
+ '400': None,
196
+ '404': None,
197
+ }
198
+ response_data = self.api_client.call_api(
199
+ *_param,
200
+ _request_timeout=_request_timeout
201
+ )
202
+ response_data.read()
203
+ return self.api_client.response_deserialize(
204
+ response_data=response_data,
205
+ response_types_map=_response_types_map,
206
+ )
207
+
208
+
209
+ @validate_call
210
+ def delete_run_without_preload_content(
211
+ self,
212
+ organization_id: Annotated[StrictStr, Field(description="the Organization identifier")],
213
+ workspace_id: Annotated[StrictStr, Field(description="the Workspace identifier")],
214
+ runner_id: Annotated[StrictStr, Field(description="the Runner identifier")],
215
+ run_id: Annotated[StrictStr, Field(description="the Run identifier")],
216
+ _request_timeout: Union[
217
+ None,
218
+ Annotated[StrictFloat, Field(gt=0)],
219
+ Tuple[
220
+ Annotated[StrictFloat, Field(gt=0)],
221
+ Annotated[StrictFloat, Field(gt=0)]
222
+ ]
223
+ ] = None,
224
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
225
+ _content_type: Optional[StrictStr] = None,
226
+ _headers: Optional[Dict[StrictStr, Any]] = None,
227
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
228
+ ) -> RESTResponseType:
229
+ """Delete a run
230
+
231
+
232
+ :param organization_id: the Organization identifier (required)
233
+ :type organization_id: str
234
+ :param workspace_id: the Workspace identifier (required)
235
+ :type workspace_id: str
236
+ :param runner_id: the Runner identifier (required)
237
+ :type runner_id: str
238
+ :param run_id: the Run identifier (required)
239
+ :type run_id: str
240
+ :param _request_timeout: timeout setting for this request. If one
241
+ number provided, it will be total request
242
+ timeout. It can also be a pair (tuple) of
243
+ (connection, read) timeouts.
244
+ :type _request_timeout: int, tuple(int, int), optional
245
+ :param _request_auth: set to override the auth_settings for an a single
246
+ request; this effectively ignores the
247
+ authentication in the spec for a single request.
248
+ :type _request_auth: dict, optional
249
+ :param _content_type: force content-type for the request.
250
+ :type _content_type: str, Optional
251
+ :param _headers: set to override the headers for a single
252
+ request; this effectively ignores the headers
253
+ in the spec for a single request.
254
+ :type _headers: dict, optional
255
+ :param _host_index: set to override the host_index for a single
256
+ request; this effectively ignores the host_index
257
+ in the spec for a single request.
258
+ :type _host_index: int, optional
259
+ :return: Returns the result object.
260
+ """ # noqa: E501
261
+
262
+ _param = self._delete_run_serialize(
263
+ organization_id=organization_id,
264
+ workspace_id=workspace_id,
265
+ runner_id=runner_id,
266
+ run_id=run_id,
267
+ _request_auth=_request_auth,
268
+ _content_type=_content_type,
269
+ _headers=_headers,
270
+ _host_index=_host_index
271
+ )
272
+
273
+ _response_types_map: Dict[str, Optional[str]] = {
274
+ '204': None,
275
+ '400': None,
276
+ '404': None,
277
+ }
278
+ response_data = self.api_client.call_api(
279
+ *_param,
280
+ _request_timeout=_request_timeout
281
+ )
282
+ return response_data.response
283
+
284
+
285
+ def _delete_run_serialize(
390
286
  self,
391
287
  organization_id,
392
288
  workspace_id,
393
289
  runner_id,
394
290
  run_id,
395
- **kwargs
396
- ):
397
- """Delete a run # noqa: E501
398
-
399
- This method makes a synchronous HTTP request by default. To make an
400
- asynchronous HTTP request, please pass async_req=True
401
-
402
- >>> thread = api.delete_run(organization_id, workspace_id, runner_id, run_id, async_req=True)
403
- >>> result = thread.get()
404
-
405
- Args:
406
- organization_id (str): the Organization identifier
407
- workspace_id (str): the Workspace identifier
408
- runner_id (str): the Runner identifier
409
- run_id (str): the Run identifier
410
-
411
- Keyword Args:
412
- _return_http_data_only (bool): response data without head status
413
- code and headers. Default is True.
414
- _preload_content (bool): if False, the urllib3.HTTPResponse object
415
- will be returned without reading/decoding response data.
416
- Default is True.
417
- _request_timeout (int/float/tuple): timeout setting for this request. If
418
- one number provided, it will be total request timeout. It can also
419
- be a pair (tuple) of (connection, read) timeouts.
420
- Default is None.
421
- _check_input_type (bool): specifies if type checking
422
- should be done one the data sent to the server.
423
- Default is True.
424
- _check_return_type (bool): specifies if type checking
425
- should be done one the data received from the server.
426
- Default is True.
427
- _spec_property_naming (bool): True if the variable names in the input data
428
- are serialized names, as specified in the OpenAPI document.
429
- False if the variable names in the input data
430
- are pythonic names, e.g. snake case (default)
431
- _content_type (str/None): force body content-type.
432
- Default is None and content-type will be predicted by allowed
433
- content-types and body.
434
- _host_index (int/None): specifies the index of the server
435
- that we want to use.
436
- Default is read from the configuration.
437
- async_req (bool): execute request asynchronously
438
-
439
- Returns:
440
- None
441
- If the method is called asynchronously, returns the request
442
- thread.
443
- """
444
- kwargs['async_req'] = kwargs.get(
445
- 'async_req', False
446
- )
447
- kwargs['_return_http_data_only'] = kwargs.get(
448
- '_return_http_data_only', True
449
- )
450
- kwargs['_preload_content'] = kwargs.get(
451
- '_preload_content', True
452
- )
453
- kwargs['_request_timeout'] = kwargs.get(
454
- '_request_timeout', None
455
- )
456
- kwargs['_check_input_type'] = kwargs.get(
457
- '_check_input_type', True
458
- )
459
- kwargs['_check_return_type'] = kwargs.get(
460
- '_check_return_type', True
461
- )
462
- kwargs['_spec_property_naming'] = kwargs.get(
463
- '_spec_property_naming', False
464
- )
465
- kwargs['_content_type'] = kwargs.get(
466
- '_content_type')
467
- kwargs['_host_index'] = kwargs.get('_host_index')
468
- kwargs['organization_id'] = \
469
- organization_id
470
- kwargs['workspace_id'] = \
471
- workspace_id
472
- kwargs['runner_id'] = \
473
- runner_id
474
- kwargs['run_id'] = \
475
- run_id
476
- return self.delete_run_endpoint.call_with_http_info(**kwargs)
291
+ _request_auth,
292
+ _content_type,
293
+ _headers,
294
+ _host_index,
295
+ ) -> RequestSerialized:
296
+
297
+ _host = None
298
+
299
+ _collection_formats: Dict[str, str] = {
300
+ }
301
+
302
+ _path_params: Dict[str, str] = {}
303
+ _query_params: List[Tuple[str, str]] = []
304
+ _header_params: Dict[str, Optional[str]] = _headers or {}
305
+ _form_params: List[Tuple[str, str]] = []
306
+ _files: Dict[str, str] = {}
307
+ _body_params: Optional[bytes] = None
308
+
309
+ # process the path parameters
310
+ if organization_id is not None:
311
+ _path_params['organization_id'] = organization_id
312
+ if workspace_id is not None:
313
+ _path_params['workspace_id'] = workspace_id
314
+ if runner_id is not None:
315
+ _path_params['runner_id'] = runner_id
316
+ if run_id is not None:
317
+ _path_params['run_id'] = run_id
318
+ # process the query parameters
319
+ # process the header parameters
320
+ # process the form parameters
321
+ # process the body parameter
477
322
 
323
+
324
+
325
+
326
+ # authentication setting
327
+ _auth_settings: List[str] = [
328
+ 'oAuth2AuthCode'
329
+ ]
330
+
331
+ return self.api_client.param_serialize(
332
+ method='DELETE',
333
+ resource_path='/organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs/{run_id}',
334
+ path_params=_path_params,
335
+ query_params=_query_params,
336
+ header_params=_header_params,
337
+ body=_body_params,
338
+ post_params=_form_params,
339
+ files=_files,
340
+ auth_settings=_auth_settings,
341
+ collection_formats=_collection_formats,
342
+ _host=_host,
343
+ _request_auth=_request_auth
344
+ )
345
+
346
+
347
+
348
+
349
+ @validate_call
478
350
  def get_run(
351
+ self,
352
+ organization_id: Annotated[StrictStr, Field(description="the Organization identifier")],
353
+ workspace_id: Annotated[StrictStr, Field(description="the Workspace identifier")],
354
+ runner_id: Annotated[StrictStr, Field(description="the Runner identifier")],
355
+ run_id: Annotated[StrictStr, Field(description="the Run identifier")],
356
+ _request_timeout: Union[
357
+ None,
358
+ Annotated[StrictFloat, Field(gt=0)],
359
+ Tuple[
360
+ Annotated[StrictFloat, Field(gt=0)],
361
+ Annotated[StrictFloat, Field(gt=0)]
362
+ ]
363
+ ] = None,
364
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
365
+ _content_type: Optional[StrictStr] = None,
366
+ _headers: Optional[Dict[StrictStr, Any]] = None,
367
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
368
+ ) -> Run:
369
+ """Get the details of a run
370
+
371
+
372
+ :param organization_id: the Organization identifier (required)
373
+ :type organization_id: str
374
+ :param workspace_id: the Workspace identifier (required)
375
+ :type workspace_id: str
376
+ :param runner_id: the Runner identifier (required)
377
+ :type runner_id: str
378
+ :param run_id: the Run identifier (required)
379
+ :type run_id: str
380
+ :param _request_timeout: timeout setting for this request. If one
381
+ number provided, it will be total request
382
+ timeout. It can also be a pair (tuple) of
383
+ (connection, read) timeouts.
384
+ :type _request_timeout: int, tuple(int, int), optional
385
+ :param _request_auth: set to override the auth_settings for an a single
386
+ request; this effectively ignores the
387
+ authentication in the spec for a single request.
388
+ :type _request_auth: dict, optional
389
+ :param _content_type: force content-type for the request.
390
+ :type _content_type: str, Optional
391
+ :param _headers: set to override the headers for a single
392
+ request; this effectively ignores the headers
393
+ in the spec for a single request.
394
+ :type _headers: dict, optional
395
+ :param _host_index: set to override the host_index for a single
396
+ request; this effectively ignores the host_index
397
+ in the spec for a single request.
398
+ :type _host_index: int, optional
399
+ :return: Returns the result object.
400
+ """ # noqa: E501
401
+
402
+ _param = self._get_run_serialize(
403
+ organization_id=organization_id,
404
+ workspace_id=workspace_id,
405
+ runner_id=runner_id,
406
+ run_id=run_id,
407
+ _request_auth=_request_auth,
408
+ _content_type=_content_type,
409
+ _headers=_headers,
410
+ _host_index=_host_index
411
+ )
412
+
413
+ _response_types_map: Dict[str, Optional[str]] = {
414
+ '200': "Run",
415
+ '404': None,
416
+ }
417
+ response_data = self.api_client.call_api(
418
+ *_param,
419
+ _request_timeout=_request_timeout
420
+ )
421
+ response_data.read()
422
+ return self.api_client.response_deserialize(
423
+ response_data=response_data,
424
+ response_types_map=_response_types_map,
425
+ ).data
426
+
427
+
428
+ @validate_call
429
+ def get_run_with_http_info(
430
+ self,
431
+ organization_id: Annotated[StrictStr, Field(description="the Organization identifier")],
432
+ workspace_id: Annotated[StrictStr, Field(description="the Workspace identifier")],
433
+ runner_id: Annotated[StrictStr, Field(description="the Runner identifier")],
434
+ run_id: Annotated[StrictStr, Field(description="the Run identifier")],
435
+ _request_timeout: Union[
436
+ None,
437
+ Annotated[StrictFloat, Field(gt=0)],
438
+ Tuple[
439
+ Annotated[StrictFloat, Field(gt=0)],
440
+ Annotated[StrictFloat, Field(gt=0)]
441
+ ]
442
+ ] = None,
443
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
444
+ _content_type: Optional[StrictStr] = None,
445
+ _headers: Optional[Dict[StrictStr, Any]] = None,
446
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
447
+ ) -> ApiResponse[Run]:
448
+ """Get the details of a run
449
+
450
+
451
+ :param organization_id: the Organization identifier (required)
452
+ :type organization_id: str
453
+ :param workspace_id: the Workspace identifier (required)
454
+ :type workspace_id: str
455
+ :param runner_id: the Runner identifier (required)
456
+ :type runner_id: str
457
+ :param run_id: the Run identifier (required)
458
+ :type run_id: str
459
+ :param _request_timeout: timeout setting for this request. If one
460
+ number provided, it will be total request
461
+ timeout. It can also be a pair (tuple) of
462
+ (connection, read) timeouts.
463
+ :type _request_timeout: int, tuple(int, int), optional
464
+ :param _request_auth: set to override the auth_settings for an a single
465
+ request; this effectively ignores the
466
+ authentication in the spec for a single request.
467
+ :type _request_auth: dict, optional
468
+ :param _content_type: force content-type for the request.
469
+ :type _content_type: str, Optional
470
+ :param _headers: set to override the headers for a single
471
+ request; this effectively ignores the headers
472
+ in the spec for a single request.
473
+ :type _headers: dict, optional
474
+ :param _host_index: set to override the host_index for a single
475
+ request; this effectively ignores the host_index
476
+ in the spec for a single request.
477
+ :type _host_index: int, optional
478
+ :return: Returns the result object.
479
+ """ # noqa: E501
480
+
481
+ _param = self._get_run_serialize(
482
+ organization_id=organization_id,
483
+ workspace_id=workspace_id,
484
+ runner_id=runner_id,
485
+ run_id=run_id,
486
+ _request_auth=_request_auth,
487
+ _content_type=_content_type,
488
+ _headers=_headers,
489
+ _host_index=_host_index
490
+ )
491
+
492
+ _response_types_map: Dict[str, Optional[str]] = {
493
+ '200': "Run",
494
+ '404': None,
495
+ }
496
+ response_data = self.api_client.call_api(
497
+ *_param,
498
+ _request_timeout=_request_timeout
499
+ )
500
+ response_data.read()
501
+ return self.api_client.response_deserialize(
502
+ response_data=response_data,
503
+ response_types_map=_response_types_map,
504
+ )
505
+
506
+
507
+ @validate_call
508
+ def get_run_without_preload_content(
509
+ self,
510
+ organization_id: Annotated[StrictStr, Field(description="the Organization identifier")],
511
+ workspace_id: Annotated[StrictStr, Field(description="the Workspace identifier")],
512
+ runner_id: Annotated[StrictStr, Field(description="the Runner identifier")],
513
+ run_id: Annotated[StrictStr, Field(description="the Run identifier")],
514
+ _request_timeout: Union[
515
+ None,
516
+ Annotated[StrictFloat, Field(gt=0)],
517
+ Tuple[
518
+ Annotated[StrictFloat, Field(gt=0)],
519
+ Annotated[StrictFloat, Field(gt=0)]
520
+ ]
521
+ ] = None,
522
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
523
+ _content_type: Optional[StrictStr] = None,
524
+ _headers: Optional[Dict[StrictStr, Any]] = None,
525
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
526
+ ) -> RESTResponseType:
527
+ """Get the details of a run
528
+
529
+
530
+ :param organization_id: the Organization identifier (required)
531
+ :type organization_id: str
532
+ :param workspace_id: the Workspace identifier (required)
533
+ :type workspace_id: str
534
+ :param runner_id: the Runner identifier (required)
535
+ :type runner_id: str
536
+ :param run_id: the Run identifier (required)
537
+ :type run_id: str
538
+ :param _request_timeout: timeout setting for this request. If one
539
+ number provided, it will be total request
540
+ timeout. It can also be a pair (tuple) of
541
+ (connection, read) timeouts.
542
+ :type _request_timeout: int, tuple(int, int), optional
543
+ :param _request_auth: set to override the auth_settings for an a single
544
+ request; this effectively ignores the
545
+ authentication in the spec for a single request.
546
+ :type _request_auth: dict, optional
547
+ :param _content_type: force content-type for the request.
548
+ :type _content_type: str, Optional
549
+ :param _headers: set to override the headers for a single
550
+ request; this effectively ignores the headers
551
+ in the spec for a single request.
552
+ :type _headers: dict, optional
553
+ :param _host_index: set to override the host_index for a single
554
+ request; this effectively ignores the host_index
555
+ in the spec for a single request.
556
+ :type _host_index: int, optional
557
+ :return: Returns the result object.
558
+ """ # noqa: E501
559
+
560
+ _param = self._get_run_serialize(
561
+ organization_id=organization_id,
562
+ workspace_id=workspace_id,
563
+ runner_id=runner_id,
564
+ run_id=run_id,
565
+ _request_auth=_request_auth,
566
+ _content_type=_content_type,
567
+ _headers=_headers,
568
+ _host_index=_host_index
569
+ )
570
+
571
+ _response_types_map: Dict[str, Optional[str]] = {
572
+ '200': "Run",
573
+ '404': None,
574
+ }
575
+ response_data = self.api_client.call_api(
576
+ *_param,
577
+ _request_timeout=_request_timeout
578
+ )
579
+ return response_data.response
580
+
581
+
582
+ def _get_run_serialize(
479
583
  self,
480
584
  organization_id,
481
585
  workspace_id,
482
586
  runner_id,
483
587
  run_id,
484
- **kwargs
485
- ):
486
- """Get the details of a run # noqa: E501
487
-
488
- This method makes a synchronous HTTP request by default. To make an
489
- asynchronous HTTP request, please pass async_req=True
490
-
491
- >>> thread = api.get_run(organization_id, workspace_id, runner_id, run_id, async_req=True)
492
- >>> result = thread.get()
493
-
494
- Args:
495
- organization_id (str): the Organization identifier
496
- workspace_id (str): the Workspace identifier
497
- runner_id (str): the Runner identifier
498
- run_id (str): the Run identifier
499
-
500
- Keyword Args:
501
- _return_http_data_only (bool): response data without head status
502
- code and headers. Default is True.
503
- _preload_content (bool): if False, the urllib3.HTTPResponse object
504
- will be returned without reading/decoding response data.
505
- Default is True.
506
- _request_timeout (int/float/tuple): timeout setting for this request. If
507
- one number provided, it will be total request timeout. It can also
508
- be a pair (tuple) of (connection, read) timeouts.
509
- Default is None.
510
- _check_input_type (bool): specifies if type checking
511
- should be done one the data sent to the server.
512
- Default is True.
513
- _check_return_type (bool): specifies if type checking
514
- should be done one the data received from the server.
515
- Default is True.
516
- _spec_property_naming (bool): True if the variable names in the input data
517
- are serialized names, as specified in the OpenAPI document.
518
- False if the variable names in the input data
519
- are pythonic names, e.g. snake case (default)
520
- _content_type (str/None): force body content-type.
521
- Default is None and content-type will be predicted by allowed
522
- content-types and body.
523
- _host_index (int/None): specifies the index of the server
524
- that we want to use.
525
- Default is read from the configuration.
526
- async_req (bool): execute request asynchronously
527
-
528
- Returns:
529
- Run
530
- If the method is called asynchronously, returns the request
531
- thread.
532
- """
533
- kwargs['async_req'] = kwargs.get(
534
- 'async_req', False
535
- )
536
- kwargs['_return_http_data_only'] = kwargs.get(
537
- '_return_http_data_only', True
538
- )
539
- kwargs['_preload_content'] = kwargs.get(
540
- '_preload_content', True
541
- )
542
- kwargs['_request_timeout'] = kwargs.get(
543
- '_request_timeout', None
544
- )
545
- kwargs['_check_input_type'] = kwargs.get(
546
- '_check_input_type', True
547
- )
548
- kwargs['_check_return_type'] = kwargs.get(
549
- '_check_return_type', True
550
- )
551
- kwargs['_spec_property_naming'] = kwargs.get(
552
- '_spec_property_naming', False
553
- )
554
- kwargs['_content_type'] = kwargs.get(
555
- '_content_type')
556
- kwargs['_host_index'] = kwargs.get('_host_index')
557
- kwargs['organization_id'] = \
558
- organization_id
559
- kwargs['workspace_id'] = \
560
- workspace_id
561
- kwargs['runner_id'] = \
562
- runner_id
563
- kwargs['run_id'] = \
564
- run_id
565
- return self.get_run_endpoint.call_with_http_info(**kwargs)
588
+ _request_auth,
589
+ _content_type,
590
+ _headers,
591
+ _host_index,
592
+ ) -> RequestSerialized:
593
+
594
+ _host = None
595
+
596
+ _collection_formats: Dict[str, str] = {
597
+ }
566
598
 
599
+ _path_params: Dict[str, str] = {}
600
+ _query_params: List[Tuple[str, str]] = []
601
+ _header_params: Dict[str, Optional[str]] = _headers or {}
602
+ _form_params: List[Tuple[str, str]] = []
603
+ _files: Dict[str, str] = {}
604
+ _body_params: Optional[bytes] = None
605
+
606
+ # process the path parameters
607
+ if organization_id is not None:
608
+ _path_params['organization_id'] = organization_id
609
+ if workspace_id is not None:
610
+ _path_params['workspace_id'] = workspace_id
611
+ if runner_id is not None:
612
+ _path_params['runner_id'] = runner_id
613
+ if run_id is not None:
614
+ _path_params['run_id'] = run_id
615
+ # process the query parameters
616
+ # process the header parameters
617
+ # process the form parameters
618
+ # process the body parameter
619
+
620
+
621
+ # set the HTTP header `Accept`
622
+ _header_params['Accept'] = self.api_client.select_header_accept(
623
+ [
624
+ 'application/json'
625
+ ]
626
+ )
627
+
628
+
629
+ # authentication setting
630
+ _auth_settings: List[str] = [
631
+ 'oAuth2AuthCode'
632
+ ]
633
+
634
+ return self.api_client.param_serialize(
635
+ method='GET',
636
+ resource_path='/organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs/{run_id}',
637
+ path_params=_path_params,
638
+ query_params=_query_params,
639
+ header_params=_header_params,
640
+ body=_body_params,
641
+ post_params=_form_params,
642
+ files=_files,
643
+ auth_settings=_auth_settings,
644
+ collection_formats=_collection_formats,
645
+ _host=_host,
646
+ _request_auth=_request_auth
647
+ )
648
+
649
+
650
+
651
+
652
+ @validate_call
567
653
  def get_run_logs(
654
+ self,
655
+ organization_id: Annotated[StrictStr, Field(description="the Organization identifier")],
656
+ workspace_id: Annotated[StrictStr, Field(description="the Workspace identifier")],
657
+ runner_id: Annotated[StrictStr, Field(description="the Runner identifier")],
658
+ run_id: Annotated[StrictStr, Field(description="the Run identifier")],
659
+ _request_timeout: Union[
660
+ None,
661
+ Annotated[StrictFloat, Field(gt=0)],
662
+ Tuple[
663
+ Annotated[StrictFloat, Field(gt=0)],
664
+ Annotated[StrictFloat, Field(gt=0)]
665
+ ]
666
+ ] = None,
667
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
668
+ _content_type: Optional[StrictStr] = None,
669
+ _headers: Optional[Dict[StrictStr, Any]] = None,
670
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
671
+ ) -> RunLogs:
672
+ """get the logs for the Run
673
+
674
+
675
+ :param organization_id: the Organization identifier (required)
676
+ :type organization_id: str
677
+ :param workspace_id: the Workspace identifier (required)
678
+ :type workspace_id: str
679
+ :param runner_id: the Runner identifier (required)
680
+ :type runner_id: str
681
+ :param run_id: the Run identifier (required)
682
+ :type run_id: str
683
+ :param _request_timeout: timeout setting for this request. If one
684
+ number provided, it will be total request
685
+ timeout. It can also be a pair (tuple) of
686
+ (connection, read) timeouts.
687
+ :type _request_timeout: int, tuple(int, int), optional
688
+ :param _request_auth: set to override the auth_settings for an a single
689
+ request; this effectively ignores the
690
+ authentication in the spec for a single request.
691
+ :type _request_auth: dict, optional
692
+ :param _content_type: force content-type for the request.
693
+ :type _content_type: str, Optional
694
+ :param _headers: set to override the headers for a single
695
+ request; this effectively ignores the headers
696
+ in the spec for a single request.
697
+ :type _headers: dict, optional
698
+ :param _host_index: set to override the host_index for a single
699
+ request; this effectively ignores the host_index
700
+ in the spec for a single request.
701
+ :type _host_index: int, optional
702
+ :return: Returns the result object.
703
+ """ # noqa: E501
704
+
705
+ _param = self._get_run_logs_serialize(
706
+ organization_id=organization_id,
707
+ workspace_id=workspace_id,
708
+ runner_id=runner_id,
709
+ run_id=run_id,
710
+ _request_auth=_request_auth,
711
+ _content_type=_content_type,
712
+ _headers=_headers,
713
+ _host_index=_host_index
714
+ )
715
+
716
+ _response_types_map: Dict[str, Optional[str]] = {
717
+ '200': "RunLogs",
718
+ }
719
+ response_data = self.api_client.call_api(
720
+ *_param,
721
+ _request_timeout=_request_timeout
722
+ )
723
+ response_data.read()
724
+ return self.api_client.response_deserialize(
725
+ response_data=response_data,
726
+ response_types_map=_response_types_map,
727
+ ).data
728
+
729
+
730
+ @validate_call
731
+ def get_run_logs_with_http_info(
732
+ self,
733
+ organization_id: Annotated[StrictStr, Field(description="the Organization identifier")],
734
+ workspace_id: Annotated[StrictStr, Field(description="the Workspace identifier")],
735
+ runner_id: Annotated[StrictStr, Field(description="the Runner identifier")],
736
+ run_id: Annotated[StrictStr, Field(description="the Run identifier")],
737
+ _request_timeout: Union[
738
+ None,
739
+ Annotated[StrictFloat, Field(gt=0)],
740
+ Tuple[
741
+ Annotated[StrictFloat, Field(gt=0)],
742
+ Annotated[StrictFloat, Field(gt=0)]
743
+ ]
744
+ ] = None,
745
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
746
+ _content_type: Optional[StrictStr] = None,
747
+ _headers: Optional[Dict[StrictStr, Any]] = None,
748
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
749
+ ) -> ApiResponse[RunLogs]:
750
+ """get the logs for the Run
751
+
752
+
753
+ :param organization_id: the Organization identifier (required)
754
+ :type organization_id: str
755
+ :param workspace_id: the Workspace identifier (required)
756
+ :type workspace_id: str
757
+ :param runner_id: the Runner identifier (required)
758
+ :type runner_id: str
759
+ :param run_id: the Run identifier (required)
760
+ :type run_id: str
761
+ :param _request_timeout: timeout setting for this request. If one
762
+ number provided, it will be total request
763
+ timeout. It can also be a pair (tuple) of
764
+ (connection, read) timeouts.
765
+ :type _request_timeout: int, tuple(int, int), optional
766
+ :param _request_auth: set to override the auth_settings for an a single
767
+ request; this effectively ignores the
768
+ authentication in the spec for a single request.
769
+ :type _request_auth: dict, optional
770
+ :param _content_type: force content-type for the request.
771
+ :type _content_type: str, Optional
772
+ :param _headers: set to override the headers for a single
773
+ request; this effectively ignores the headers
774
+ in the spec for a single request.
775
+ :type _headers: dict, optional
776
+ :param _host_index: set to override the host_index for a single
777
+ request; this effectively ignores the host_index
778
+ in the spec for a single request.
779
+ :type _host_index: int, optional
780
+ :return: Returns the result object.
781
+ """ # noqa: E501
782
+
783
+ _param = self._get_run_logs_serialize(
784
+ organization_id=organization_id,
785
+ workspace_id=workspace_id,
786
+ runner_id=runner_id,
787
+ run_id=run_id,
788
+ _request_auth=_request_auth,
789
+ _content_type=_content_type,
790
+ _headers=_headers,
791
+ _host_index=_host_index
792
+ )
793
+
794
+ _response_types_map: Dict[str, Optional[str]] = {
795
+ '200': "RunLogs",
796
+ }
797
+ response_data = self.api_client.call_api(
798
+ *_param,
799
+ _request_timeout=_request_timeout
800
+ )
801
+ response_data.read()
802
+ return self.api_client.response_deserialize(
803
+ response_data=response_data,
804
+ response_types_map=_response_types_map,
805
+ )
806
+
807
+
808
+ @validate_call
809
+ def get_run_logs_without_preload_content(
810
+ self,
811
+ organization_id: Annotated[StrictStr, Field(description="the Organization identifier")],
812
+ workspace_id: Annotated[StrictStr, Field(description="the Workspace identifier")],
813
+ runner_id: Annotated[StrictStr, Field(description="the Runner identifier")],
814
+ run_id: Annotated[StrictStr, Field(description="the Run identifier")],
815
+ _request_timeout: Union[
816
+ None,
817
+ Annotated[StrictFloat, Field(gt=0)],
818
+ Tuple[
819
+ Annotated[StrictFloat, Field(gt=0)],
820
+ Annotated[StrictFloat, Field(gt=0)]
821
+ ]
822
+ ] = None,
823
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
824
+ _content_type: Optional[StrictStr] = None,
825
+ _headers: Optional[Dict[StrictStr, Any]] = None,
826
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
827
+ ) -> RESTResponseType:
828
+ """get the logs for the Run
829
+
830
+
831
+ :param organization_id: the Organization identifier (required)
832
+ :type organization_id: str
833
+ :param workspace_id: the Workspace identifier (required)
834
+ :type workspace_id: str
835
+ :param runner_id: the Runner identifier (required)
836
+ :type runner_id: str
837
+ :param run_id: the Run identifier (required)
838
+ :type run_id: str
839
+ :param _request_timeout: timeout setting for this request. If one
840
+ number provided, it will be total request
841
+ timeout. It can also be a pair (tuple) of
842
+ (connection, read) timeouts.
843
+ :type _request_timeout: int, tuple(int, int), optional
844
+ :param _request_auth: set to override the auth_settings for an a single
845
+ request; this effectively ignores the
846
+ authentication in the spec for a single request.
847
+ :type _request_auth: dict, optional
848
+ :param _content_type: force content-type for the request.
849
+ :type _content_type: str, Optional
850
+ :param _headers: set to override the headers for a single
851
+ request; this effectively ignores the headers
852
+ in the spec for a single request.
853
+ :type _headers: dict, optional
854
+ :param _host_index: set to override the host_index for a single
855
+ request; this effectively ignores the host_index
856
+ in the spec for a single request.
857
+ :type _host_index: int, optional
858
+ :return: Returns the result object.
859
+ """ # noqa: E501
860
+
861
+ _param = self._get_run_logs_serialize(
862
+ organization_id=organization_id,
863
+ workspace_id=workspace_id,
864
+ runner_id=runner_id,
865
+ run_id=run_id,
866
+ _request_auth=_request_auth,
867
+ _content_type=_content_type,
868
+ _headers=_headers,
869
+ _host_index=_host_index
870
+ )
871
+
872
+ _response_types_map: Dict[str, Optional[str]] = {
873
+ '200': "RunLogs",
874
+ }
875
+ response_data = self.api_client.call_api(
876
+ *_param,
877
+ _request_timeout=_request_timeout
878
+ )
879
+ return response_data.response
880
+
881
+
882
+ def _get_run_logs_serialize(
568
883
  self,
569
884
  organization_id,
570
885
  workspace_id,
571
886
  runner_id,
572
887
  run_id,
573
- **kwargs
574
- ):
575
- """get the logs for the Run # noqa: E501
576
-
577
- This method makes a synchronous HTTP request by default. To make an
578
- asynchronous HTTP request, please pass async_req=True
579
-
580
- >>> thread = api.get_run_logs(organization_id, workspace_id, runner_id, run_id, async_req=True)
581
- >>> result = thread.get()
582
-
583
- Args:
584
- organization_id (str): the Organization identifier
585
- workspace_id (str): the Workspace identifier
586
- runner_id (str): the Runner identifier
587
- run_id (str): the Run identifier
588
-
589
- Keyword Args:
590
- _return_http_data_only (bool): response data without head status
591
- code and headers. Default is True.
592
- _preload_content (bool): if False, the urllib3.HTTPResponse object
593
- will be returned without reading/decoding response data.
594
- Default is True.
595
- _request_timeout (int/float/tuple): timeout setting for this request. If
596
- one number provided, it will be total request timeout. It can also
597
- be a pair (tuple) of (connection, read) timeouts.
598
- Default is None.
599
- _check_input_type (bool): specifies if type checking
600
- should be done one the data sent to the server.
601
- Default is True.
602
- _check_return_type (bool): specifies if type checking
603
- should be done one the data received from the server.
604
- Default is True.
605
- _spec_property_naming (bool): True if the variable names in the input data
606
- are serialized names, as specified in the OpenAPI document.
607
- False if the variable names in the input data
608
- are pythonic names, e.g. snake case (default)
609
- _content_type (str/None): force body content-type.
610
- Default is None and content-type will be predicted by allowed
611
- content-types and body.
612
- _host_index (int/None): specifies the index of the server
613
- that we want to use.
614
- Default is read from the configuration.
615
- async_req (bool): execute request asynchronously
616
-
617
- Returns:
618
- RunLogs
619
- If the method is called asynchronously, returns the request
620
- thread.
621
- """
622
- kwargs['async_req'] = kwargs.get(
623
- 'async_req', False
624
- )
625
- kwargs['_return_http_data_only'] = kwargs.get(
626
- '_return_http_data_only', True
627
- )
628
- kwargs['_preload_content'] = kwargs.get(
629
- '_preload_content', True
630
- )
631
- kwargs['_request_timeout'] = kwargs.get(
632
- '_request_timeout', None
633
- )
634
- kwargs['_check_input_type'] = kwargs.get(
635
- '_check_input_type', True
636
- )
637
- kwargs['_check_return_type'] = kwargs.get(
638
- '_check_return_type', True
639
- )
640
- kwargs['_spec_property_naming'] = kwargs.get(
641
- '_spec_property_naming', False
642
- )
643
- kwargs['_content_type'] = kwargs.get(
644
- '_content_type')
645
- kwargs['_host_index'] = kwargs.get('_host_index')
646
- kwargs['organization_id'] = \
647
- organization_id
648
- kwargs['workspace_id'] = \
649
- workspace_id
650
- kwargs['runner_id'] = \
651
- runner_id
652
- kwargs['run_id'] = \
653
- run_id
654
- return self.get_run_logs_endpoint.call_with_http_info(**kwargs)
888
+ _request_auth,
889
+ _content_type,
890
+ _headers,
891
+ _host_index,
892
+ ) -> RequestSerialized:
893
+
894
+ _host = None
895
+
896
+ _collection_formats: Dict[str, str] = {
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[str, str] = {}
904
+ _body_params: Optional[bytes] = None
905
+
906
+ # process the path parameters
907
+ if organization_id is not None:
908
+ _path_params['organization_id'] = organization_id
909
+ if workspace_id is not None:
910
+ _path_params['workspace_id'] = workspace_id
911
+ if runner_id is not None:
912
+ _path_params['runner_id'] = runner_id
913
+ if run_id is not None:
914
+ _path_params['run_id'] = run_id
915
+ # process the query parameters
916
+ # process the header parameters
917
+ # process the form parameters
918
+ # process the body parameter
919
+
920
+
921
+ # set the HTTP header `Accept`
922
+ _header_params['Accept'] = self.api_client.select_header_accept(
923
+ [
924
+ 'application/json'
925
+ ]
926
+ )
927
+
928
+
929
+ # authentication setting
930
+ _auth_settings: List[str] = [
931
+ 'oAuth2AuthCode'
932
+ ]
655
933
 
934
+ return self.api_client.param_serialize(
935
+ method='GET',
936
+ resource_path='/organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs/{run_id}/logs',
937
+ path_params=_path_params,
938
+ query_params=_query_params,
939
+ header_params=_header_params,
940
+ body=_body_params,
941
+ post_params=_form_params,
942
+ files=_files,
943
+ auth_settings=_auth_settings,
944
+ collection_formats=_collection_formats,
945
+ _host=_host,
946
+ _request_auth=_request_auth
947
+ )
948
+
949
+
950
+
951
+
952
+ @validate_call
656
953
  def get_run_status(
954
+ self,
955
+ organization_id: Annotated[StrictStr, Field(description="the Organization identifier")],
956
+ workspace_id: Annotated[StrictStr, Field(description="the Workspace identifier")],
957
+ runner_id: Annotated[StrictStr, Field(description="the Runner identifier")],
958
+ run_id: Annotated[StrictStr, Field(description="the Run identifier")],
959
+ _request_timeout: Union[
960
+ None,
961
+ Annotated[StrictFloat, Field(gt=0)],
962
+ Tuple[
963
+ Annotated[StrictFloat, Field(gt=0)],
964
+ Annotated[StrictFloat, Field(gt=0)]
965
+ ]
966
+ ] = None,
967
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
968
+ _content_type: Optional[StrictStr] = None,
969
+ _headers: Optional[Dict[StrictStr, Any]] = None,
970
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
971
+ ) -> RunStatus:
972
+ """get the status for the Run
973
+
974
+
975
+ :param organization_id: the Organization identifier (required)
976
+ :type organization_id: str
977
+ :param workspace_id: the Workspace identifier (required)
978
+ :type workspace_id: str
979
+ :param runner_id: the Runner identifier (required)
980
+ :type runner_id: str
981
+ :param run_id: the Run identifier (required)
982
+ :type run_id: str
983
+ :param _request_timeout: timeout setting for this request. If one
984
+ number provided, it will be total request
985
+ timeout. It can also be a pair (tuple) of
986
+ (connection, read) timeouts.
987
+ :type _request_timeout: int, tuple(int, int), optional
988
+ :param _request_auth: set to override the auth_settings for an a single
989
+ request; this effectively ignores the
990
+ authentication in the spec for a single request.
991
+ :type _request_auth: dict, optional
992
+ :param _content_type: force content-type for the request.
993
+ :type _content_type: str, Optional
994
+ :param _headers: set to override the headers for a single
995
+ request; this effectively ignores the headers
996
+ in the spec for a single request.
997
+ :type _headers: dict, optional
998
+ :param _host_index: set to override the host_index for a single
999
+ request; this effectively ignores the host_index
1000
+ in the spec for a single request.
1001
+ :type _host_index: int, optional
1002
+ :return: Returns the result object.
1003
+ """ # noqa: E501
1004
+
1005
+ _param = self._get_run_status_serialize(
1006
+ organization_id=organization_id,
1007
+ workspace_id=workspace_id,
1008
+ runner_id=runner_id,
1009
+ run_id=run_id,
1010
+ _request_auth=_request_auth,
1011
+ _content_type=_content_type,
1012
+ _headers=_headers,
1013
+ _host_index=_host_index
1014
+ )
1015
+
1016
+ _response_types_map: Dict[str, Optional[str]] = {
1017
+ '200': "RunStatus",
1018
+ }
1019
+ response_data = self.api_client.call_api(
1020
+ *_param,
1021
+ _request_timeout=_request_timeout
1022
+ )
1023
+ response_data.read()
1024
+ return self.api_client.response_deserialize(
1025
+ response_data=response_data,
1026
+ response_types_map=_response_types_map,
1027
+ ).data
1028
+
1029
+
1030
+ @validate_call
1031
+ def get_run_status_with_http_info(
1032
+ self,
1033
+ organization_id: Annotated[StrictStr, Field(description="the Organization identifier")],
1034
+ workspace_id: Annotated[StrictStr, Field(description="the Workspace identifier")],
1035
+ runner_id: Annotated[StrictStr, Field(description="the Runner identifier")],
1036
+ run_id: Annotated[StrictStr, Field(description="the Run identifier")],
1037
+ _request_timeout: Union[
1038
+ None,
1039
+ Annotated[StrictFloat, Field(gt=0)],
1040
+ Tuple[
1041
+ Annotated[StrictFloat, Field(gt=0)],
1042
+ Annotated[StrictFloat, Field(gt=0)]
1043
+ ]
1044
+ ] = None,
1045
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1046
+ _content_type: Optional[StrictStr] = None,
1047
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1048
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1049
+ ) -> ApiResponse[RunStatus]:
1050
+ """get the status for the Run
1051
+
1052
+
1053
+ :param organization_id: the Organization identifier (required)
1054
+ :type organization_id: str
1055
+ :param workspace_id: the Workspace identifier (required)
1056
+ :type workspace_id: str
1057
+ :param runner_id: the Runner identifier (required)
1058
+ :type runner_id: str
1059
+ :param run_id: the Run identifier (required)
1060
+ :type run_id: str
1061
+ :param _request_timeout: timeout setting for this request. If one
1062
+ number provided, it will be total request
1063
+ timeout. It can also be a pair (tuple) of
1064
+ (connection, read) timeouts.
1065
+ :type _request_timeout: int, tuple(int, int), optional
1066
+ :param _request_auth: set to override the auth_settings for an a single
1067
+ request; this effectively ignores the
1068
+ authentication in the spec for a single request.
1069
+ :type _request_auth: dict, optional
1070
+ :param _content_type: force content-type for the request.
1071
+ :type _content_type: str, Optional
1072
+ :param _headers: set to override the headers for a single
1073
+ request; this effectively ignores the headers
1074
+ in the spec for a single request.
1075
+ :type _headers: dict, optional
1076
+ :param _host_index: set to override the host_index for a single
1077
+ request; this effectively ignores the host_index
1078
+ in the spec for a single request.
1079
+ :type _host_index: int, optional
1080
+ :return: Returns the result object.
1081
+ """ # noqa: E501
1082
+
1083
+ _param = self._get_run_status_serialize(
1084
+ organization_id=organization_id,
1085
+ workspace_id=workspace_id,
1086
+ runner_id=runner_id,
1087
+ run_id=run_id,
1088
+ _request_auth=_request_auth,
1089
+ _content_type=_content_type,
1090
+ _headers=_headers,
1091
+ _host_index=_host_index
1092
+ )
1093
+
1094
+ _response_types_map: Dict[str, Optional[str]] = {
1095
+ '200': "RunStatus",
1096
+ }
1097
+ response_data = self.api_client.call_api(
1098
+ *_param,
1099
+ _request_timeout=_request_timeout
1100
+ )
1101
+ response_data.read()
1102
+ return self.api_client.response_deserialize(
1103
+ response_data=response_data,
1104
+ response_types_map=_response_types_map,
1105
+ )
1106
+
1107
+
1108
+ @validate_call
1109
+ def get_run_status_without_preload_content(
1110
+ self,
1111
+ organization_id: Annotated[StrictStr, Field(description="the Organization identifier")],
1112
+ workspace_id: Annotated[StrictStr, Field(description="the Workspace identifier")],
1113
+ runner_id: Annotated[StrictStr, Field(description="the Runner identifier")],
1114
+ run_id: Annotated[StrictStr, Field(description="the Run identifier")],
1115
+ _request_timeout: Union[
1116
+ None,
1117
+ Annotated[StrictFloat, Field(gt=0)],
1118
+ Tuple[
1119
+ Annotated[StrictFloat, Field(gt=0)],
1120
+ Annotated[StrictFloat, Field(gt=0)]
1121
+ ]
1122
+ ] = None,
1123
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1124
+ _content_type: Optional[StrictStr] = None,
1125
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1126
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1127
+ ) -> RESTResponseType:
1128
+ """get the status for the Run
1129
+
1130
+
1131
+ :param organization_id: the Organization identifier (required)
1132
+ :type organization_id: str
1133
+ :param workspace_id: the Workspace identifier (required)
1134
+ :type workspace_id: str
1135
+ :param runner_id: the Runner identifier (required)
1136
+ :type runner_id: str
1137
+ :param run_id: the Run identifier (required)
1138
+ :type run_id: str
1139
+ :param _request_timeout: timeout setting for this request. If one
1140
+ number provided, it will be total request
1141
+ timeout. It can also be a pair (tuple) of
1142
+ (connection, read) timeouts.
1143
+ :type _request_timeout: int, tuple(int, int), optional
1144
+ :param _request_auth: set to override the auth_settings for an a single
1145
+ request; this effectively ignores the
1146
+ authentication in the spec for a single request.
1147
+ :type _request_auth: dict, optional
1148
+ :param _content_type: force content-type for the request.
1149
+ :type _content_type: str, Optional
1150
+ :param _headers: set to override the headers for a single
1151
+ request; this effectively ignores the headers
1152
+ in the spec for a single request.
1153
+ :type _headers: dict, optional
1154
+ :param _host_index: set to override the host_index for a single
1155
+ request; this effectively ignores the host_index
1156
+ in the spec for a single request.
1157
+ :type _host_index: int, optional
1158
+ :return: Returns the result object.
1159
+ """ # noqa: E501
1160
+
1161
+ _param = self._get_run_status_serialize(
1162
+ organization_id=organization_id,
1163
+ workspace_id=workspace_id,
1164
+ runner_id=runner_id,
1165
+ run_id=run_id,
1166
+ _request_auth=_request_auth,
1167
+ _content_type=_content_type,
1168
+ _headers=_headers,
1169
+ _host_index=_host_index
1170
+ )
1171
+
1172
+ _response_types_map: Dict[str, Optional[str]] = {
1173
+ '200': "RunStatus",
1174
+ }
1175
+ response_data = self.api_client.call_api(
1176
+ *_param,
1177
+ _request_timeout=_request_timeout
1178
+ )
1179
+ return response_data.response
1180
+
1181
+
1182
+ def _get_run_status_serialize(
657
1183
  self,
658
1184
  organization_id,
659
1185
  workspace_id,
660
1186
  runner_id,
661
1187
  run_id,
662
- **kwargs
663
- ):
664
- """get the status for the Run # noqa: E501
665
-
666
- This method makes a synchronous HTTP request by default. To make an
667
- asynchronous HTTP request, please pass async_req=True
668
-
669
- >>> thread = api.get_run_status(organization_id, workspace_id, runner_id, run_id, async_req=True)
670
- >>> result = thread.get()
671
-
672
- Args:
673
- organization_id (str): the Organization identifier
674
- workspace_id (str): the Workspace identifier
675
- runner_id (str): the Runner identifier
676
- run_id (str): the Run identifier
677
-
678
- Keyword Args:
679
- _return_http_data_only (bool): response data without head status
680
- code and headers. Default is True.
681
- _preload_content (bool): if False, the urllib3.HTTPResponse object
682
- will be returned without reading/decoding response data.
683
- Default is True.
684
- _request_timeout (int/float/tuple): timeout setting for this request. If
685
- one number provided, it will be total request timeout. It can also
686
- be a pair (tuple) of (connection, read) timeouts.
687
- Default is None.
688
- _check_input_type (bool): specifies if type checking
689
- should be done one the data sent to the server.
690
- Default is True.
691
- _check_return_type (bool): specifies if type checking
692
- should be done one the data received from the server.
693
- Default is True.
694
- _spec_property_naming (bool): True if the variable names in the input data
695
- are serialized names, as specified in the OpenAPI document.
696
- False if the variable names in the input data
697
- are pythonic names, e.g. snake case (default)
698
- _content_type (str/None): force body content-type.
699
- Default is None and content-type will be predicted by allowed
700
- content-types and body.
701
- _host_index (int/None): specifies the index of the server
702
- that we want to use.
703
- Default is read from the configuration.
704
- async_req (bool): execute request asynchronously
705
-
706
- Returns:
707
- RunStatus
708
- If the method is called asynchronously, returns the request
709
- thread.
710
- """
711
- kwargs['async_req'] = kwargs.get(
712
- 'async_req', False
713
- )
714
- kwargs['_return_http_data_only'] = kwargs.get(
715
- '_return_http_data_only', True
716
- )
717
- kwargs['_preload_content'] = kwargs.get(
718
- '_preload_content', True
719
- )
720
- kwargs['_request_timeout'] = kwargs.get(
721
- '_request_timeout', None
722
- )
723
- kwargs['_check_input_type'] = kwargs.get(
724
- '_check_input_type', True
725
- )
726
- kwargs['_check_return_type'] = kwargs.get(
727
- '_check_return_type', True
728
- )
729
- kwargs['_spec_property_naming'] = kwargs.get(
730
- '_spec_property_naming', False
731
- )
732
- kwargs['_content_type'] = kwargs.get(
733
- '_content_type')
734
- kwargs['_host_index'] = kwargs.get('_host_index')
735
- kwargs['organization_id'] = \
736
- organization_id
737
- kwargs['workspace_id'] = \
738
- workspace_id
739
- kwargs['runner_id'] = \
740
- runner_id
741
- kwargs['run_id'] = \
742
- run_id
743
- return self.get_run_status_endpoint.call_with_http_info(**kwargs)
1188
+ _request_auth,
1189
+ _content_type,
1190
+ _headers,
1191
+ _host_index,
1192
+ ) -> RequestSerialized:
1193
+
1194
+ _host = None
1195
+
1196
+ _collection_formats: Dict[str, str] = {
1197
+ }
1198
+
1199
+ _path_params: Dict[str, str] = {}
1200
+ _query_params: List[Tuple[str, str]] = []
1201
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1202
+ _form_params: List[Tuple[str, str]] = []
1203
+ _files: Dict[str, str] = {}
1204
+ _body_params: Optional[bytes] = None
1205
+
1206
+ # process the path parameters
1207
+ if organization_id is not None:
1208
+ _path_params['organization_id'] = organization_id
1209
+ if workspace_id is not None:
1210
+ _path_params['workspace_id'] = workspace_id
1211
+ if runner_id is not None:
1212
+ _path_params['runner_id'] = runner_id
1213
+ if run_id is not None:
1214
+ _path_params['run_id'] = run_id
1215
+ # process the query parameters
1216
+ # process the header parameters
1217
+ # process the form parameters
1218
+ # process the body parameter
1219
+
744
1220
 
1221
+ # set the HTTP header `Accept`
1222
+ _header_params['Accept'] = self.api_client.select_header_accept(
1223
+ [
1224
+ 'application/json'
1225
+ ]
1226
+ )
1227
+
1228
+
1229
+ # authentication setting
1230
+ _auth_settings: List[str] = [
1231
+ 'oAuth2AuthCode'
1232
+ ]
1233
+
1234
+ return self.api_client.param_serialize(
1235
+ method='GET',
1236
+ resource_path='/organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs/{run_id}/status',
1237
+ path_params=_path_params,
1238
+ query_params=_query_params,
1239
+ header_params=_header_params,
1240
+ body=_body_params,
1241
+ post_params=_form_params,
1242
+ files=_files,
1243
+ auth_settings=_auth_settings,
1244
+ collection_formats=_collection_formats,
1245
+ _host=_host,
1246
+ _request_auth=_request_auth
1247
+ )
1248
+
1249
+
1250
+
1251
+
1252
+ @validate_call
745
1253
  def list_runs(
1254
+ self,
1255
+ organization_id: Annotated[StrictStr, Field(description="the Organization identifier")],
1256
+ workspace_id: Annotated[StrictStr, Field(description="the Workspace identifier")],
1257
+ runner_id: Annotated[StrictStr, Field(description="the Runner identifier")],
1258
+ page: Annotated[Optional[StrictInt], Field(description="page number to query")] = None,
1259
+ size: Annotated[Optional[StrictInt], Field(description="amount of result by page")] = None,
1260
+ _request_timeout: Union[
1261
+ None,
1262
+ Annotated[StrictFloat, Field(gt=0)],
1263
+ Tuple[
1264
+ Annotated[StrictFloat, Field(gt=0)],
1265
+ Annotated[StrictFloat, Field(gt=0)]
1266
+ ]
1267
+ ] = None,
1268
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1269
+ _content_type: Optional[StrictStr] = None,
1270
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1271
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1272
+ ) -> List[Run]:
1273
+ """get the list of Runs for the Runner
1274
+
1275
+
1276
+ :param organization_id: the Organization identifier (required)
1277
+ :type organization_id: str
1278
+ :param workspace_id: the Workspace identifier (required)
1279
+ :type workspace_id: str
1280
+ :param runner_id: the Runner identifier (required)
1281
+ :type runner_id: str
1282
+ :param page: page number to query
1283
+ :type page: int
1284
+ :param size: amount of result by page
1285
+ :type size: int
1286
+ :param _request_timeout: timeout setting for this request. If one
1287
+ number provided, it will be total request
1288
+ timeout. It can also be a pair (tuple) of
1289
+ (connection, read) timeouts.
1290
+ :type _request_timeout: int, tuple(int, int), optional
1291
+ :param _request_auth: set to override the auth_settings for an a single
1292
+ request; this effectively ignores the
1293
+ authentication in the spec for a single request.
1294
+ :type _request_auth: dict, optional
1295
+ :param _content_type: force content-type for the request.
1296
+ :type _content_type: str, Optional
1297
+ :param _headers: set to override the headers for a single
1298
+ request; this effectively ignores the headers
1299
+ in the spec for a single request.
1300
+ :type _headers: dict, optional
1301
+ :param _host_index: set to override the host_index for a single
1302
+ request; this effectively ignores the host_index
1303
+ in the spec for a single request.
1304
+ :type _host_index: int, optional
1305
+ :return: Returns the result object.
1306
+ """ # noqa: E501
1307
+
1308
+ _param = self._list_runs_serialize(
1309
+ organization_id=organization_id,
1310
+ workspace_id=workspace_id,
1311
+ runner_id=runner_id,
1312
+ page=page,
1313
+ size=size,
1314
+ _request_auth=_request_auth,
1315
+ _content_type=_content_type,
1316
+ _headers=_headers,
1317
+ _host_index=_host_index
1318
+ )
1319
+
1320
+ _response_types_map: Dict[str, Optional[str]] = {
1321
+ '200': "List[Run]",
1322
+ }
1323
+ response_data = self.api_client.call_api(
1324
+ *_param,
1325
+ _request_timeout=_request_timeout
1326
+ )
1327
+ response_data.read()
1328
+ return self.api_client.response_deserialize(
1329
+ response_data=response_data,
1330
+ response_types_map=_response_types_map,
1331
+ ).data
1332
+
1333
+
1334
+ @validate_call
1335
+ def list_runs_with_http_info(
1336
+ self,
1337
+ organization_id: Annotated[StrictStr, Field(description="the Organization identifier")],
1338
+ workspace_id: Annotated[StrictStr, Field(description="the Workspace identifier")],
1339
+ runner_id: Annotated[StrictStr, Field(description="the Runner identifier")],
1340
+ page: Annotated[Optional[StrictInt], Field(description="page number to query")] = None,
1341
+ size: Annotated[Optional[StrictInt], Field(description="amount of result by page")] = None,
1342
+ _request_timeout: Union[
1343
+ None,
1344
+ Annotated[StrictFloat, Field(gt=0)],
1345
+ Tuple[
1346
+ Annotated[StrictFloat, Field(gt=0)],
1347
+ Annotated[StrictFloat, Field(gt=0)]
1348
+ ]
1349
+ ] = None,
1350
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1351
+ _content_type: Optional[StrictStr] = None,
1352
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1353
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1354
+ ) -> ApiResponse[List[Run]]:
1355
+ """get the list of Runs for the Runner
1356
+
1357
+
1358
+ :param organization_id: the Organization identifier (required)
1359
+ :type organization_id: str
1360
+ :param workspace_id: the Workspace identifier (required)
1361
+ :type workspace_id: str
1362
+ :param runner_id: the Runner identifier (required)
1363
+ :type runner_id: str
1364
+ :param page: page number to query
1365
+ :type page: int
1366
+ :param size: amount of result by page
1367
+ :type size: int
1368
+ :param _request_timeout: timeout setting for this request. If one
1369
+ number provided, it will be total request
1370
+ timeout. It can also be a pair (tuple) of
1371
+ (connection, read) timeouts.
1372
+ :type _request_timeout: int, tuple(int, int), optional
1373
+ :param _request_auth: set to override the auth_settings for an a single
1374
+ request; this effectively ignores the
1375
+ authentication in the spec for a single request.
1376
+ :type _request_auth: dict, optional
1377
+ :param _content_type: force content-type for the request.
1378
+ :type _content_type: str, Optional
1379
+ :param _headers: set to override the headers for a single
1380
+ request; this effectively ignores the headers
1381
+ in the spec for a single request.
1382
+ :type _headers: dict, optional
1383
+ :param _host_index: set to override the host_index for a single
1384
+ request; this effectively ignores the host_index
1385
+ in the spec for a single request.
1386
+ :type _host_index: int, optional
1387
+ :return: Returns the result object.
1388
+ """ # noqa: E501
1389
+
1390
+ _param = self._list_runs_serialize(
1391
+ organization_id=organization_id,
1392
+ workspace_id=workspace_id,
1393
+ runner_id=runner_id,
1394
+ page=page,
1395
+ size=size,
1396
+ _request_auth=_request_auth,
1397
+ _content_type=_content_type,
1398
+ _headers=_headers,
1399
+ _host_index=_host_index
1400
+ )
1401
+
1402
+ _response_types_map: Dict[str, Optional[str]] = {
1403
+ '200': "List[Run]",
1404
+ }
1405
+ response_data = self.api_client.call_api(
1406
+ *_param,
1407
+ _request_timeout=_request_timeout
1408
+ )
1409
+ response_data.read()
1410
+ return self.api_client.response_deserialize(
1411
+ response_data=response_data,
1412
+ response_types_map=_response_types_map,
1413
+ )
1414
+
1415
+
1416
+ @validate_call
1417
+ def list_runs_without_preload_content(
1418
+ self,
1419
+ organization_id: Annotated[StrictStr, Field(description="the Organization identifier")],
1420
+ workspace_id: Annotated[StrictStr, Field(description="the Workspace identifier")],
1421
+ runner_id: Annotated[StrictStr, Field(description="the Runner identifier")],
1422
+ page: Annotated[Optional[StrictInt], Field(description="page number to query")] = None,
1423
+ size: Annotated[Optional[StrictInt], Field(description="amount of result by page")] = None,
1424
+ _request_timeout: Union[
1425
+ None,
1426
+ Annotated[StrictFloat, Field(gt=0)],
1427
+ Tuple[
1428
+ Annotated[StrictFloat, Field(gt=0)],
1429
+ Annotated[StrictFloat, Field(gt=0)]
1430
+ ]
1431
+ ] = None,
1432
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1433
+ _content_type: Optional[StrictStr] = None,
1434
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1435
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1436
+ ) -> RESTResponseType:
1437
+ """get the list of Runs for the Runner
1438
+
1439
+
1440
+ :param organization_id: the Organization identifier (required)
1441
+ :type organization_id: str
1442
+ :param workspace_id: the Workspace identifier (required)
1443
+ :type workspace_id: str
1444
+ :param runner_id: the Runner identifier (required)
1445
+ :type runner_id: str
1446
+ :param page: page number to query
1447
+ :type page: int
1448
+ :param size: amount of result by page
1449
+ :type size: int
1450
+ :param _request_timeout: timeout setting for this request. If one
1451
+ number provided, it will be total request
1452
+ timeout. It can also be a pair (tuple) of
1453
+ (connection, read) timeouts.
1454
+ :type _request_timeout: int, tuple(int, int), optional
1455
+ :param _request_auth: set to override the auth_settings for an a single
1456
+ request; this effectively ignores the
1457
+ authentication in the spec for a single request.
1458
+ :type _request_auth: dict, optional
1459
+ :param _content_type: force content-type for the request.
1460
+ :type _content_type: str, Optional
1461
+ :param _headers: set to override the headers for a single
1462
+ request; this effectively ignores the headers
1463
+ in the spec for a single request.
1464
+ :type _headers: dict, optional
1465
+ :param _host_index: set to override the host_index for a single
1466
+ request; this effectively ignores the host_index
1467
+ in the spec for a single request.
1468
+ :type _host_index: int, optional
1469
+ :return: Returns the result object.
1470
+ """ # noqa: E501
1471
+
1472
+ _param = self._list_runs_serialize(
1473
+ organization_id=organization_id,
1474
+ workspace_id=workspace_id,
1475
+ runner_id=runner_id,
1476
+ page=page,
1477
+ size=size,
1478
+ _request_auth=_request_auth,
1479
+ _content_type=_content_type,
1480
+ _headers=_headers,
1481
+ _host_index=_host_index
1482
+ )
1483
+
1484
+ _response_types_map: Dict[str, Optional[str]] = {
1485
+ '200': "List[Run]",
1486
+ }
1487
+ response_data = self.api_client.call_api(
1488
+ *_param,
1489
+ _request_timeout=_request_timeout
1490
+ )
1491
+ return response_data.response
1492
+
1493
+
1494
+ def _list_runs_serialize(
746
1495
  self,
747
1496
  organization_id,
748
1497
  workspace_id,
749
1498
  runner_id,
750
- **kwargs
751
- ):
752
- """get the list of Runs for the Runner # noqa: E501
753
-
754
- This method makes a synchronous HTTP request by default. To make an
755
- asynchronous HTTP request, please pass async_req=True
756
-
757
- >>> thread = api.list_runs(organization_id, workspace_id, runner_id, async_req=True)
758
- >>> result = thread.get()
759
-
760
- Args:
761
- organization_id (str): the Organization identifier
762
- workspace_id (str): the Workspace identifier
763
- runner_id (str): the Runner identifier
764
-
765
- Keyword Args:
766
- page (int): page number to query. [optional]
767
- size (int): amount of result by page. [optional]
768
- _return_http_data_only (bool): response data without head status
769
- code and headers. Default is True.
770
- _preload_content (bool): if False, the urllib3.HTTPResponse object
771
- will be returned without reading/decoding response data.
772
- Default is True.
773
- _request_timeout (int/float/tuple): timeout setting for this request. If
774
- one number provided, it will be total request timeout. It can also
775
- be a pair (tuple) of (connection, read) timeouts.
776
- Default is None.
777
- _check_input_type (bool): specifies if type checking
778
- should be done one the data sent to the server.
779
- Default is True.
780
- _check_return_type (bool): specifies if type checking
781
- should be done one the data received from the server.
782
- Default is True.
783
- _spec_property_naming (bool): True if the variable names in the input data
784
- are serialized names, as specified in the OpenAPI document.
785
- False if the variable names in the input data
786
- are pythonic names, e.g. snake case (default)
787
- _content_type (str/None): force body content-type.
788
- Default is None and content-type will be predicted by allowed
789
- content-types and body.
790
- _host_index (int/None): specifies the index of the server
791
- that we want to use.
792
- Default is read from the configuration.
793
- async_req (bool): execute request asynchronously
794
-
795
- Returns:
796
- [Run]
797
- If the method is called asynchronously, returns the request
798
- thread.
799
- """
800
- kwargs['async_req'] = kwargs.get(
801
- 'async_req', False
802
- )
803
- kwargs['_return_http_data_only'] = kwargs.get(
804
- '_return_http_data_only', True
805
- )
806
- kwargs['_preload_content'] = kwargs.get(
807
- '_preload_content', True
808
- )
809
- kwargs['_request_timeout'] = kwargs.get(
810
- '_request_timeout', None
811
- )
812
- kwargs['_check_input_type'] = kwargs.get(
813
- '_check_input_type', True
814
- )
815
- kwargs['_check_return_type'] = kwargs.get(
816
- '_check_return_type', True
817
- )
818
- kwargs['_spec_property_naming'] = kwargs.get(
819
- '_spec_property_naming', False
820
- )
821
- kwargs['_content_type'] = kwargs.get(
822
- '_content_type')
823
- kwargs['_host_index'] = kwargs.get('_host_index')
824
- kwargs['organization_id'] = \
825
- organization_id
826
- kwargs['workspace_id'] = \
827
- workspace_id
828
- kwargs['runner_id'] = \
829
- runner_id
830
- return self.list_runs_endpoint.call_with_http_info(**kwargs)
1499
+ page,
1500
+ size,
1501
+ _request_auth,
1502
+ _content_type,
1503
+ _headers,
1504
+ _host_index,
1505
+ ) -> RequestSerialized:
1506
+
1507
+ _host = None
1508
+
1509
+ _collection_formats: Dict[str, str] = {
1510
+ }
1511
+
1512
+ _path_params: Dict[str, str] = {}
1513
+ _query_params: List[Tuple[str, str]] = []
1514
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1515
+ _form_params: List[Tuple[str, str]] = []
1516
+ _files: Dict[str, str] = {}
1517
+ _body_params: Optional[bytes] = None
1518
+
1519
+ # process the path parameters
1520
+ if organization_id is not None:
1521
+ _path_params['organization_id'] = organization_id
1522
+ if workspace_id is not None:
1523
+ _path_params['workspace_id'] = workspace_id
1524
+ if runner_id is not None:
1525
+ _path_params['runner_id'] = runner_id
1526
+ # process the query parameters
1527
+ if page is not None:
1528
+
1529
+ _query_params.append(('page', page))
1530
+
1531
+ if size is not None:
1532
+
1533
+ _query_params.append(('size', size))
1534
+
1535
+ # process the header parameters
1536
+ # process the form parameters
1537
+ # process the body parameter
1538
+
1539
+
1540
+ # set the HTTP header `Accept`
1541
+ _header_params['Accept'] = self.api_client.select_header_accept(
1542
+ [
1543
+ 'application/json'
1544
+ ]
1545
+ )
1546
+
1547
+
1548
+ # authentication setting
1549
+ _auth_settings: List[str] = [
1550
+ 'oAuth2AuthCode'
1551
+ ]
1552
+
1553
+ return self.api_client.param_serialize(
1554
+ method='GET',
1555
+ resource_path='/organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs',
1556
+ path_params=_path_params,
1557
+ query_params=_query_params,
1558
+ header_params=_header_params,
1559
+ body=_body_params,
1560
+ post_params=_form_params,
1561
+ files=_files,
1562
+ auth_settings=_auth_settings,
1563
+ collection_formats=_collection_formats,
1564
+ _host=_host,
1565
+ _request_auth=_request_auth
1566
+ )
1567
+
1568
+
1569
+
1570
+
1571
+ @validate_call
1572
+ def query_run_data(
1573
+ self,
1574
+ organization_id: Annotated[StrictStr, Field(description="the Organization identifier")],
1575
+ workspace_id: Annotated[StrictStr, Field(description="the Workspace identifier")],
1576
+ runner_id: Annotated[StrictStr, Field(description="the Runner identifier")],
1577
+ run_id: Annotated[StrictStr, Field(description="the Run identifier")],
1578
+ run_data_query: Annotated[RunDataQuery, Field(description="the query to run")],
1579
+ _request_timeout: Union[
1580
+ None,
1581
+ Annotated[StrictFloat, Field(gt=0)],
1582
+ Tuple[
1583
+ Annotated[StrictFloat, Field(gt=0)],
1584
+ Annotated[StrictFloat, Field(gt=0)]
1585
+ ]
1586
+ ] = None,
1587
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1588
+ _content_type: Optional[StrictStr] = None,
1589
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1590
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1591
+ ) -> QueryResult:
1592
+ """query the run data
1593
+
1594
+
1595
+ :param organization_id: the Organization identifier (required)
1596
+ :type organization_id: str
1597
+ :param workspace_id: the Workspace identifier (required)
1598
+ :type workspace_id: str
1599
+ :param runner_id: the Runner identifier (required)
1600
+ :type runner_id: str
1601
+ :param run_id: the Run identifier (required)
1602
+ :type run_id: str
1603
+ :param run_data_query: the query to run (required)
1604
+ :type run_data_query: RunDataQuery
1605
+ :param _request_timeout: timeout setting for this request. If one
1606
+ number provided, it will be total request
1607
+ timeout. It can also be a pair (tuple) of
1608
+ (connection, read) timeouts.
1609
+ :type _request_timeout: int, tuple(int, int), optional
1610
+ :param _request_auth: set to override the auth_settings for an a single
1611
+ request; this effectively ignores the
1612
+ authentication in the spec for a single request.
1613
+ :type _request_auth: dict, optional
1614
+ :param _content_type: force content-type for the request.
1615
+ :type _content_type: str, Optional
1616
+ :param _headers: set to override the headers for a single
1617
+ request; this effectively ignores the headers
1618
+ in the spec for a single request.
1619
+ :type _headers: dict, optional
1620
+ :param _host_index: set to override the host_index for a single
1621
+ request; this effectively ignores the host_index
1622
+ in the spec for a single request.
1623
+ :type _host_index: int, optional
1624
+ :return: Returns the result object.
1625
+ """ # noqa: E501
1626
+
1627
+ _param = self._query_run_data_serialize(
1628
+ organization_id=organization_id,
1629
+ workspace_id=workspace_id,
1630
+ runner_id=runner_id,
1631
+ run_id=run_id,
1632
+ run_data_query=run_data_query,
1633
+ _request_auth=_request_auth,
1634
+ _content_type=_content_type,
1635
+ _headers=_headers,
1636
+ _host_index=_host_index
1637
+ )
1638
+
1639
+ _response_types_map: Dict[str, Optional[str]] = {
1640
+ '200': "QueryResult",
1641
+ }
1642
+ response_data = self.api_client.call_api(
1643
+ *_param,
1644
+ _request_timeout=_request_timeout
1645
+ )
1646
+ response_data.read()
1647
+ return self.api_client.response_deserialize(
1648
+ response_data=response_data,
1649
+ response_types_map=_response_types_map,
1650
+ ).data
1651
+
1652
+
1653
+ @validate_call
1654
+ def query_run_data_with_http_info(
1655
+ self,
1656
+ organization_id: Annotated[StrictStr, Field(description="the Organization identifier")],
1657
+ workspace_id: Annotated[StrictStr, Field(description="the Workspace identifier")],
1658
+ runner_id: Annotated[StrictStr, Field(description="the Runner identifier")],
1659
+ run_id: Annotated[StrictStr, Field(description="the Run identifier")],
1660
+ run_data_query: Annotated[RunDataQuery, Field(description="the query to run")],
1661
+ _request_timeout: Union[
1662
+ None,
1663
+ Annotated[StrictFloat, Field(gt=0)],
1664
+ Tuple[
1665
+ Annotated[StrictFloat, Field(gt=0)],
1666
+ Annotated[StrictFloat, Field(gt=0)]
1667
+ ]
1668
+ ] = None,
1669
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1670
+ _content_type: Optional[StrictStr] = None,
1671
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1672
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1673
+ ) -> ApiResponse[QueryResult]:
1674
+ """query the run data
1675
+
1676
+
1677
+ :param organization_id: the Organization identifier (required)
1678
+ :type organization_id: str
1679
+ :param workspace_id: the Workspace identifier (required)
1680
+ :type workspace_id: str
1681
+ :param runner_id: the Runner identifier (required)
1682
+ :type runner_id: str
1683
+ :param run_id: the Run identifier (required)
1684
+ :type run_id: str
1685
+ :param run_data_query: the query to run (required)
1686
+ :type run_data_query: RunDataQuery
1687
+ :param _request_timeout: timeout setting for this request. If one
1688
+ number provided, it will be total request
1689
+ timeout. It can also be a pair (tuple) of
1690
+ (connection, read) timeouts.
1691
+ :type _request_timeout: int, tuple(int, int), optional
1692
+ :param _request_auth: set to override the auth_settings for an a single
1693
+ request; this effectively ignores the
1694
+ authentication in the spec for a single request.
1695
+ :type _request_auth: dict, optional
1696
+ :param _content_type: force content-type for the request.
1697
+ :type _content_type: str, Optional
1698
+ :param _headers: set to override the headers for a single
1699
+ request; this effectively ignores the headers
1700
+ in the spec for a single request.
1701
+ :type _headers: dict, optional
1702
+ :param _host_index: set to override the host_index for a single
1703
+ request; this effectively ignores the host_index
1704
+ in the spec for a single request.
1705
+ :type _host_index: int, optional
1706
+ :return: Returns the result object.
1707
+ """ # noqa: E501
1708
+
1709
+ _param = self._query_run_data_serialize(
1710
+ organization_id=organization_id,
1711
+ workspace_id=workspace_id,
1712
+ runner_id=runner_id,
1713
+ run_id=run_id,
1714
+ run_data_query=run_data_query,
1715
+ _request_auth=_request_auth,
1716
+ _content_type=_content_type,
1717
+ _headers=_headers,
1718
+ _host_index=_host_index
1719
+ )
1720
+
1721
+ _response_types_map: Dict[str, Optional[str]] = {
1722
+ '200': "QueryResult",
1723
+ }
1724
+ response_data = self.api_client.call_api(
1725
+ *_param,
1726
+ _request_timeout=_request_timeout
1727
+ )
1728
+ response_data.read()
1729
+ return self.api_client.response_deserialize(
1730
+ response_data=response_data,
1731
+ response_types_map=_response_types_map,
1732
+ )
1733
+
1734
+
1735
+ @validate_call
1736
+ def query_run_data_without_preload_content(
1737
+ self,
1738
+ organization_id: Annotated[StrictStr, Field(description="the Organization identifier")],
1739
+ workspace_id: Annotated[StrictStr, Field(description="the Workspace identifier")],
1740
+ runner_id: Annotated[StrictStr, Field(description="the Runner identifier")],
1741
+ run_id: Annotated[StrictStr, Field(description="the Run identifier")],
1742
+ run_data_query: Annotated[RunDataQuery, Field(description="the query to run")],
1743
+ _request_timeout: Union[
1744
+ None,
1745
+ Annotated[StrictFloat, Field(gt=0)],
1746
+ Tuple[
1747
+ Annotated[StrictFloat, Field(gt=0)],
1748
+ Annotated[StrictFloat, Field(gt=0)]
1749
+ ]
1750
+ ] = None,
1751
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1752
+ _content_type: Optional[StrictStr] = None,
1753
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1754
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1755
+ ) -> RESTResponseType:
1756
+ """query the run data
1757
+
1758
+
1759
+ :param organization_id: the Organization identifier (required)
1760
+ :type organization_id: str
1761
+ :param workspace_id: the Workspace identifier (required)
1762
+ :type workspace_id: str
1763
+ :param runner_id: the Runner identifier (required)
1764
+ :type runner_id: str
1765
+ :param run_id: the Run identifier (required)
1766
+ :type run_id: str
1767
+ :param run_data_query: the query to run (required)
1768
+ :type run_data_query: RunDataQuery
1769
+ :param _request_timeout: timeout setting for this request. If one
1770
+ number provided, it will be total request
1771
+ timeout. It can also be a pair (tuple) of
1772
+ (connection, read) timeouts.
1773
+ :type _request_timeout: int, tuple(int, int), optional
1774
+ :param _request_auth: set to override the auth_settings for an a single
1775
+ request; this effectively ignores the
1776
+ authentication in the spec for a single request.
1777
+ :type _request_auth: dict, optional
1778
+ :param _content_type: force content-type for the request.
1779
+ :type _content_type: str, Optional
1780
+ :param _headers: set to override the headers for a single
1781
+ request; this effectively ignores the headers
1782
+ in the spec for a single request.
1783
+ :type _headers: dict, optional
1784
+ :param _host_index: set to override the host_index for a single
1785
+ request; this effectively ignores the host_index
1786
+ in the spec for a single request.
1787
+ :type _host_index: int, optional
1788
+ :return: Returns the result object.
1789
+ """ # noqa: E501
1790
+
1791
+ _param = self._query_run_data_serialize(
1792
+ organization_id=organization_id,
1793
+ workspace_id=workspace_id,
1794
+ runner_id=runner_id,
1795
+ run_id=run_id,
1796
+ run_data_query=run_data_query,
1797
+ _request_auth=_request_auth,
1798
+ _content_type=_content_type,
1799
+ _headers=_headers,
1800
+ _host_index=_host_index
1801
+ )
1802
+
1803
+ _response_types_map: Dict[str, Optional[str]] = {
1804
+ '200': "QueryResult",
1805
+ }
1806
+ response_data = self.api_client.call_api(
1807
+ *_param,
1808
+ _request_timeout=_request_timeout
1809
+ )
1810
+ return response_data.response
1811
+
1812
+
1813
+ def _query_run_data_serialize(
1814
+ self,
1815
+ organization_id,
1816
+ workspace_id,
1817
+ runner_id,
1818
+ run_id,
1819
+ run_data_query,
1820
+ _request_auth,
1821
+ _content_type,
1822
+ _headers,
1823
+ _host_index,
1824
+ ) -> RequestSerialized:
1825
+
1826
+ _host = None
1827
+
1828
+ _collection_formats: Dict[str, str] = {
1829
+ }
1830
+
1831
+ _path_params: Dict[str, str] = {}
1832
+ _query_params: List[Tuple[str, str]] = []
1833
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1834
+ _form_params: List[Tuple[str, str]] = []
1835
+ _files: Dict[str, str] = {}
1836
+ _body_params: Optional[bytes] = None
1837
+
1838
+ # process the path parameters
1839
+ if organization_id is not None:
1840
+ _path_params['organization_id'] = organization_id
1841
+ if workspace_id is not None:
1842
+ _path_params['workspace_id'] = workspace_id
1843
+ if runner_id is not None:
1844
+ _path_params['runner_id'] = runner_id
1845
+ if run_id is not None:
1846
+ _path_params['run_id'] = run_id
1847
+ # process the query parameters
1848
+ # process the header parameters
1849
+ # process the form parameters
1850
+ # process the body parameter
1851
+ if run_data_query is not None:
1852
+ _body_params = run_data_query
1853
+
1854
+
1855
+ # set the HTTP header `Accept`
1856
+ _header_params['Accept'] = self.api_client.select_header_accept(
1857
+ [
1858
+ 'application/json'
1859
+ ]
1860
+ )
1861
+
1862
+ # set the HTTP header `Content-Type`
1863
+ if _content_type:
1864
+ _header_params['Content-Type'] = _content_type
1865
+ else:
1866
+ _default_content_type = (
1867
+ self.api_client.select_header_content_type(
1868
+ [
1869
+ 'application/json'
1870
+ ]
1871
+ )
1872
+ )
1873
+ if _default_content_type is not None:
1874
+ _header_params['Content-Type'] = _default_content_type
1875
+
1876
+ # authentication setting
1877
+ _auth_settings: List[str] = [
1878
+ 'oAuth2AuthCode'
1879
+ ]
1880
+
1881
+ return self.api_client.param_serialize(
1882
+ method='POST',
1883
+ resource_path='/organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs/{run_id}/data/query',
1884
+ path_params=_path_params,
1885
+ query_params=_query_params,
1886
+ header_params=_header_params,
1887
+ body=_body_params,
1888
+ post_params=_form_params,
1889
+ files=_files,
1890
+ auth_settings=_auth_settings,
1891
+ collection_formats=_collection_formats,
1892
+ _host=_host,
1893
+ _request_auth=_request_auth
1894
+ )
1895
+
1896
+
1897
+
1898
+
1899
+ @validate_call
1900
+ def send_run_data(
1901
+ self,
1902
+ organization_id: Annotated[StrictStr, Field(description="the Organization identifier")],
1903
+ workspace_id: Annotated[StrictStr, Field(description="the Workspace identifier")],
1904
+ runner_id: Annotated[StrictStr, Field(description="the Runner identifier")],
1905
+ run_id: Annotated[StrictStr, Field(description="the Run identifier")],
1906
+ send_run_data_request: Annotated[SendRunDataRequest, Field(description="Custom data to register")],
1907
+ _request_timeout: Union[
1908
+ None,
1909
+ Annotated[StrictFloat, Field(gt=0)],
1910
+ Tuple[
1911
+ Annotated[StrictFloat, Field(gt=0)],
1912
+ Annotated[StrictFloat, Field(gt=0)]
1913
+ ]
1914
+ ] = None,
1915
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1916
+ _content_type: Optional[StrictStr] = None,
1917
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1918
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1919
+ ) -> RunData:
1920
+ """Send data associated to a run
1921
+
1922
+
1923
+ :param organization_id: the Organization identifier (required)
1924
+ :type organization_id: str
1925
+ :param workspace_id: the Workspace identifier (required)
1926
+ :type workspace_id: str
1927
+ :param runner_id: the Runner identifier (required)
1928
+ :type runner_id: str
1929
+ :param run_id: the Run identifier (required)
1930
+ :type run_id: str
1931
+ :param send_run_data_request: Custom data to register (required)
1932
+ :type send_run_data_request: SendRunDataRequest
1933
+ :param _request_timeout: timeout setting for this request. If one
1934
+ number provided, it will be total request
1935
+ timeout. It can also be a pair (tuple) of
1936
+ (connection, read) timeouts.
1937
+ :type _request_timeout: int, tuple(int, int), optional
1938
+ :param _request_auth: set to override the auth_settings for an a single
1939
+ request; this effectively ignores the
1940
+ authentication in the spec for a single request.
1941
+ :type _request_auth: dict, optional
1942
+ :param _content_type: force content-type for the request.
1943
+ :type _content_type: str, Optional
1944
+ :param _headers: set to override the headers for a single
1945
+ request; this effectively ignores the headers
1946
+ in the spec for a single request.
1947
+ :type _headers: dict, optional
1948
+ :param _host_index: set to override the host_index for a single
1949
+ request; this effectively ignores the host_index
1950
+ in the spec for a single request.
1951
+ :type _host_index: int, optional
1952
+ :return: Returns the result object.
1953
+ """ # noqa: E501
1954
+
1955
+ _param = self._send_run_data_serialize(
1956
+ organization_id=organization_id,
1957
+ workspace_id=workspace_id,
1958
+ runner_id=runner_id,
1959
+ run_id=run_id,
1960
+ send_run_data_request=send_run_data_request,
1961
+ _request_auth=_request_auth,
1962
+ _content_type=_content_type,
1963
+ _headers=_headers,
1964
+ _host_index=_host_index
1965
+ )
1966
+
1967
+ _response_types_map: Dict[str, Optional[str]] = {
1968
+ '201': "RunData",
1969
+ '400': None,
1970
+ }
1971
+ response_data = self.api_client.call_api(
1972
+ *_param,
1973
+ _request_timeout=_request_timeout
1974
+ )
1975
+ response_data.read()
1976
+ return self.api_client.response_deserialize(
1977
+ response_data=response_data,
1978
+ response_types_map=_response_types_map,
1979
+ ).data
1980
+
1981
+
1982
+ @validate_call
1983
+ def send_run_data_with_http_info(
1984
+ self,
1985
+ organization_id: Annotated[StrictStr, Field(description="the Organization identifier")],
1986
+ workspace_id: Annotated[StrictStr, Field(description="the Workspace identifier")],
1987
+ runner_id: Annotated[StrictStr, Field(description="the Runner identifier")],
1988
+ run_id: Annotated[StrictStr, Field(description="the Run identifier")],
1989
+ send_run_data_request: Annotated[SendRunDataRequest, Field(description="Custom data to register")],
1990
+ _request_timeout: Union[
1991
+ None,
1992
+ Annotated[StrictFloat, Field(gt=0)],
1993
+ Tuple[
1994
+ Annotated[StrictFloat, Field(gt=0)],
1995
+ Annotated[StrictFloat, Field(gt=0)]
1996
+ ]
1997
+ ] = None,
1998
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1999
+ _content_type: Optional[StrictStr] = None,
2000
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2001
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2002
+ ) -> ApiResponse[RunData]:
2003
+ """Send data associated to a run
2004
+
2005
+
2006
+ :param organization_id: the Organization identifier (required)
2007
+ :type organization_id: str
2008
+ :param workspace_id: the Workspace identifier (required)
2009
+ :type workspace_id: str
2010
+ :param runner_id: the Runner identifier (required)
2011
+ :type runner_id: str
2012
+ :param run_id: the Run identifier (required)
2013
+ :type run_id: str
2014
+ :param send_run_data_request: Custom data to register (required)
2015
+ :type send_run_data_request: SendRunDataRequest
2016
+ :param _request_timeout: timeout setting for this request. If one
2017
+ number provided, it will be total request
2018
+ timeout. It can also be a pair (tuple) of
2019
+ (connection, read) timeouts.
2020
+ :type _request_timeout: int, tuple(int, int), optional
2021
+ :param _request_auth: set to override the auth_settings for an a single
2022
+ request; this effectively ignores the
2023
+ authentication in the spec for a single request.
2024
+ :type _request_auth: dict, optional
2025
+ :param _content_type: force content-type for the request.
2026
+ :type _content_type: str, Optional
2027
+ :param _headers: set to override the headers for a single
2028
+ request; this effectively ignores the headers
2029
+ in the spec for a single request.
2030
+ :type _headers: dict, optional
2031
+ :param _host_index: set to override the host_index for a single
2032
+ request; this effectively ignores the host_index
2033
+ in the spec for a single request.
2034
+ :type _host_index: int, optional
2035
+ :return: Returns the result object.
2036
+ """ # noqa: E501
2037
+
2038
+ _param = self._send_run_data_serialize(
2039
+ organization_id=organization_id,
2040
+ workspace_id=workspace_id,
2041
+ runner_id=runner_id,
2042
+ run_id=run_id,
2043
+ send_run_data_request=send_run_data_request,
2044
+ _request_auth=_request_auth,
2045
+ _content_type=_content_type,
2046
+ _headers=_headers,
2047
+ _host_index=_host_index
2048
+ )
2049
+
2050
+ _response_types_map: Dict[str, Optional[str]] = {
2051
+ '201': "RunData",
2052
+ '400': None,
2053
+ }
2054
+ response_data = self.api_client.call_api(
2055
+ *_param,
2056
+ _request_timeout=_request_timeout
2057
+ )
2058
+ response_data.read()
2059
+ return self.api_client.response_deserialize(
2060
+ response_data=response_data,
2061
+ response_types_map=_response_types_map,
2062
+ )
2063
+
2064
+
2065
+ @validate_call
2066
+ def send_run_data_without_preload_content(
2067
+ self,
2068
+ organization_id: Annotated[StrictStr, Field(description="the Organization identifier")],
2069
+ workspace_id: Annotated[StrictStr, Field(description="the Workspace identifier")],
2070
+ runner_id: Annotated[StrictStr, Field(description="the Runner identifier")],
2071
+ run_id: Annotated[StrictStr, Field(description="the Run identifier")],
2072
+ send_run_data_request: Annotated[SendRunDataRequest, Field(description="Custom data to register")],
2073
+ _request_timeout: Union[
2074
+ None,
2075
+ Annotated[StrictFloat, Field(gt=0)],
2076
+ Tuple[
2077
+ Annotated[StrictFloat, Field(gt=0)],
2078
+ Annotated[StrictFloat, Field(gt=0)]
2079
+ ]
2080
+ ] = None,
2081
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2082
+ _content_type: Optional[StrictStr] = None,
2083
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2084
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2085
+ ) -> RESTResponseType:
2086
+ """Send data associated to a run
2087
+
2088
+
2089
+ :param organization_id: the Organization identifier (required)
2090
+ :type organization_id: str
2091
+ :param workspace_id: the Workspace identifier (required)
2092
+ :type workspace_id: str
2093
+ :param runner_id: the Runner identifier (required)
2094
+ :type runner_id: str
2095
+ :param run_id: the Run identifier (required)
2096
+ :type run_id: str
2097
+ :param send_run_data_request: Custom data to register (required)
2098
+ :type send_run_data_request: SendRunDataRequest
2099
+ :param _request_timeout: timeout setting for this request. If one
2100
+ number provided, it will be total request
2101
+ timeout. It can also be a pair (tuple) of
2102
+ (connection, read) timeouts.
2103
+ :type _request_timeout: int, tuple(int, int), optional
2104
+ :param _request_auth: set to override the auth_settings for an a single
2105
+ request; this effectively ignores the
2106
+ authentication in the spec for a single request.
2107
+ :type _request_auth: dict, optional
2108
+ :param _content_type: force content-type for the request.
2109
+ :type _content_type: str, Optional
2110
+ :param _headers: set to override the headers for a single
2111
+ request; this effectively ignores the headers
2112
+ in the spec for a single request.
2113
+ :type _headers: dict, optional
2114
+ :param _host_index: set to override the host_index for a single
2115
+ request; this effectively ignores the host_index
2116
+ in the spec for a single request.
2117
+ :type _host_index: int, optional
2118
+ :return: Returns the result object.
2119
+ """ # noqa: E501
2120
+
2121
+ _param = self._send_run_data_serialize(
2122
+ organization_id=organization_id,
2123
+ workspace_id=workspace_id,
2124
+ runner_id=runner_id,
2125
+ run_id=run_id,
2126
+ send_run_data_request=send_run_data_request,
2127
+ _request_auth=_request_auth,
2128
+ _content_type=_content_type,
2129
+ _headers=_headers,
2130
+ _host_index=_host_index
2131
+ )
2132
+
2133
+ _response_types_map: Dict[str, Optional[str]] = {
2134
+ '201': "RunData",
2135
+ '400': None,
2136
+ }
2137
+ response_data = self.api_client.call_api(
2138
+ *_param,
2139
+ _request_timeout=_request_timeout
2140
+ )
2141
+ return response_data.response
2142
+
2143
+
2144
+ def _send_run_data_serialize(
2145
+ self,
2146
+ organization_id,
2147
+ workspace_id,
2148
+ runner_id,
2149
+ run_id,
2150
+ send_run_data_request,
2151
+ _request_auth,
2152
+ _content_type,
2153
+ _headers,
2154
+ _host_index,
2155
+ ) -> RequestSerialized:
2156
+
2157
+ _host = None
2158
+
2159
+ _collection_formats: Dict[str, str] = {
2160
+ }
2161
+
2162
+ _path_params: Dict[str, str] = {}
2163
+ _query_params: List[Tuple[str, str]] = []
2164
+ _header_params: Dict[str, Optional[str]] = _headers or {}
2165
+ _form_params: List[Tuple[str, str]] = []
2166
+ _files: Dict[str, str] = {}
2167
+ _body_params: Optional[bytes] = None
2168
+
2169
+ # process the path parameters
2170
+ if organization_id is not None:
2171
+ _path_params['organization_id'] = organization_id
2172
+ if workspace_id is not None:
2173
+ _path_params['workspace_id'] = workspace_id
2174
+ if runner_id is not None:
2175
+ _path_params['runner_id'] = runner_id
2176
+ if run_id is not None:
2177
+ _path_params['run_id'] = run_id
2178
+ # process the query parameters
2179
+ # process the header parameters
2180
+ # process the form parameters
2181
+ # process the body parameter
2182
+ if send_run_data_request is not None:
2183
+ _body_params = send_run_data_request
2184
+
2185
+
2186
+ # set the HTTP header `Accept`
2187
+ _header_params['Accept'] = self.api_client.select_header_accept(
2188
+ [
2189
+ 'application/json'
2190
+ ]
2191
+ )
2192
+
2193
+ # set the HTTP header `Content-Type`
2194
+ if _content_type:
2195
+ _header_params['Content-Type'] = _content_type
2196
+ else:
2197
+ _default_content_type = (
2198
+ self.api_client.select_header_content_type(
2199
+ [
2200
+ 'application/json'
2201
+ ]
2202
+ )
2203
+ )
2204
+ if _default_content_type is not None:
2205
+ _header_params['Content-Type'] = _default_content_type
2206
+
2207
+ # authentication setting
2208
+ _auth_settings: List[str] = [
2209
+ 'oAuth2AuthCode'
2210
+ ]
2211
+
2212
+ return self.api_client.param_serialize(
2213
+ method='POST',
2214
+ resource_path='/organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs/{run_id}/data/send',
2215
+ path_params=_path_params,
2216
+ query_params=_query_params,
2217
+ header_params=_header_params,
2218
+ body=_body_params,
2219
+ post_params=_form_params,
2220
+ files=_files,
2221
+ auth_settings=_auth_settings,
2222
+ collection_formats=_collection_formats,
2223
+ _host=_host,
2224
+ _request_auth=_request_auth
2225
+ )
2226
+
831
2227