terra-scientific-pipelines-service-api-client 0.1.28__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of terra-scientific-pipelines-service-api-client might be problematic. Click here for more details.

Files changed (44) hide show
  1. teaspoons_client/__init__.py +63 -0
  2. teaspoons_client/api/__init__.py +10 -0
  3. teaspoons_client/api/admin_api.py +1229 -0
  4. teaspoons_client/api/jobs_api.py +592 -0
  5. teaspoons_client/api/pipeline_runs_api.py +1166 -0
  6. teaspoons_client/api/pipelines_api.py +581 -0
  7. teaspoons_client/api/public_api.py +532 -0
  8. teaspoons_client/api/quotas_api.py +303 -0
  9. teaspoons_client/api_client.py +797 -0
  10. teaspoons_client/api_response.py +21 -0
  11. teaspoons_client/configuration.py +465 -0
  12. teaspoons_client/exceptions.py +199 -0
  13. teaspoons_client/models/__init__.py +41 -0
  14. teaspoons_client/models/admin_pipeline.py +103 -0
  15. teaspoons_client/models/admin_quota.py +93 -0
  16. teaspoons_client/models/async_pipeline_run_response.py +103 -0
  17. teaspoons_client/models/error_report.py +91 -0
  18. teaspoons_client/models/get_jobs_response.py +99 -0
  19. teaspoons_client/models/get_pipeline_details_request_body.py +87 -0
  20. teaspoons_client/models/get_pipeline_runs_response.py +97 -0
  21. teaspoons_client/models/get_pipelines_result.py +95 -0
  22. teaspoons_client/models/job_control.py +87 -0
  23. teaspoons_client/models/job_report.py +106 -0
  24. teaspoons_client/models/job_result.py +97 -0
  25. teaspoons_client/models/pipeline.py +93 -0
  26. teaspoons_client/models/pipeline_run.py +97 -0
  27. teaspoons_client/models/pipeline_run_report.py +93 -0
  28. teaspoons_client/models/pipeline_user_provided_input_definition.py +91 -0
  29. teaspoons_client/models/pipeline_with_details.py +105 -0
  30. teaspoons_client/models/prepare_pipeline_run_request_body.py +95 -0
  31. teaspoons_client/models/prepare_pipeline_run_response.py +89 -0
  32. teaspoons_client/models/quota_with_details.py +91 -0
  33. teaspoons_client/models/start_pipeline_run_request_body.py +91 -0
  34. teaspoons_client/models/system_status.py +102 -0
  35. teaspoons_client/models/system_status_systems_value.py +89 -0
  36. teaspoons_client/models/update_pipeline_request_body.py +91 -0
  37. teaspoons_client/models/update_quota_limit_request_body.py +87 -0
  38. teaspoons_client/models/version_properties.py +93 -0
  39. teaspoons_client/py.typed +0 -0
  40. teaspoons_client/rest.py +257 -0
  41. terra_scientific_pipelines_service_api_client-0.1.28.dist-info/METADATA +23 -0
  42. terra_scientific_pipelines_service_api_client-0.1.28.dist-info/RECORD +44 -0
  43. terra_scientific_pipelines_service_api_client-0.1.28.dist-info/WHEEL +5 -0
  44. terra_scientific_pipelines_service_api_client-0.1.28.dist-info/top_level.txt +1 -0
@@ -0,0 +1,1166 @@
1
+ # coding: utf-8
2
+
3
+ """
4
+ Terra Scientific Pipelines Service
5
+
6
+ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
7
+
8
+ The version of the OpenAPI document: 1.0.0
9
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
10
+
11
+ Do not edit the class manually.
12
+ """ # noqa: E501
13
+
14
+ import warnings
15
+ from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
16
+ from typing import Any, Dict, List, Optional, Tuple, Union
17
+ from typing_extensions import Annotated
18
+
19
+ from pydantic import Field, StrictStr
20
+ from typing import Optional
21
+ from typing_extensions import Annotated
22
+ from teaspoons_client.models.async_pipeline_run_response import AsyncPipelineRunResponse
23
+ from teaspoons_client.models.get_pipeline_runs_response import GetPipelineRunsResponse
24
+ from teaspoons_client.models.prepare_pipeline_run_request_body import PreparePipelineRunRequestBody
25
+ from teaspoons_client.models.prepare_pipeline_run_response import PreparePipelineRunResponse
26
+ from teaspoons_client.models.start_pipeline_run_request_body import StartPipelineRunRequestBody
27
+
28
+ from teaspoons_client.api_client import ApiClient, RequestSerialized
29
+ from teaspoons_client.api_response import ApiResponse
30
+ from teaspoons_client.rest import RESTResponseType
31
+
32
+
33
+ class PipelineRunsApi:
34
+ """NOTE: This class is auto generated by OpenAPI Generator
35
+ Ref: https://openapi-generator.tech
36
+
37
+ Do not edit the class manually.
38
+ """
39
+
40
+ def __init__(self, api_client=None) -> None:
41
+ if api_client is None:
42
+ api_client = ApiClient.get_default()
43
+ self.api_client = api_client
44
+
45
+
46
+ @validate_call
47
+ def get_all_pipeline_runs(
48
+ self,
49
+ limit: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="The maximum number of items to return. Default 10. Max 100.")] = None,
50
+ page_token: Annotated[Optional[StrictStr], Field(description="A previously returned page token describing where to resume an enumeration.")] = None,
51
+ _request_timeout: Union[
52
+ None,
53
+ Annotated[StrictFloat, Field(gt=0)],
54
+ Tuple[
55
+ Annotated[StrictFloat, Field(gt=0)],
56
+ Annotated[StrictFloat, Field(gt=0)]
57
+ ]
58
+ ] = None,
59
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
60
+ _content_type: Optional[StrictStr] = None,
61
+ _headers: Optional[Dict[StrictStr, Any]] = None,
62
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
63
+ ) -> GetPipelineRunsResponse:
64
+ """Return a paginated list of all pipeline runs the caller has access to
65
+
66
+
67
+ :param limit: The maximum number of items to return. Default 10. Max 100.
68
+ :type limit: int
69
+ :param page_token: A previously returned page token describing where to resume an enumeration.
70
+ :type page_token: str
71
+ :param _request_timeout: timeout setting for this request. If one
72
+ number provided, it will be total request
73
+ timeout. It can also be a pair (tuple) of
74
+ (connection, read) timeouts.
75
+ :type _request_timeout: int, tuple(int, int), optional
76
+ :param _request_auth: set to override the auth_settings for an a single
77
+ request; this effectively ignores the
78
+ authentication in the spec for a single request.
79
+ :type _request_auth: dict, optional
80
+ :param _content_type: force content-type for the request.
81
+ :type _content_type: str, Optional
82
+ :param _headers: set to override the headers for a single
83
+ request; this effectively ignores the headers
84
+ in the spec for a single request.
85
+ :type _headers: dict, optional
86
+ :param _host_index: set to override the host_index for a single
87
+ request; this effectively ignores the host_index
88
+ in the spec for a single request.
89
+ :type _host_index: int, optional
90
+ :return: Returns the result object.
91
+ """ # noqa: E501
92
+
93
+ _param = self._get_all_pipeline_runs_serialize(
94
+ limit=limit,
95
+ page_token=page_token,
96
+ _request_auth=_request_auth,
97
+ _content_type=_content_type,
98
+ _headers=_headers,
99
+ _host_index=_host_index
100
+ )
101
+
102
+ _response_types_map: Dict[str, Optional[str]] = {
103
+ '200': "GetPipelineRunsResponse",
104
+ '500': "ErrorReport",
105
+ }
106
+ response_data = self.api_client.call_api(
107
+ *_param,
108
+ _request_timeout=_request_timeout
109
+ )
110
+ response_data.read()
111
+ return self.api_client.response_deserialize(
112
+ response_data=response_data,
113
+ response_types_map=_response_types_map,
114
+ ).data
115
+
116
+
117
+ @validate_call
118
+ def get_all_pipeline_runs_with_http_info(
119
+ self,
120
+ limit: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="The maximum number of items to return. Default 10. Max 100.")] = None,
121
+ page_token: Annotated[Optional[StrictStr], Field(description="A previously returned page token describing where to resume an enumeration.")] = None,
122
+ _request_timeout: Union[
123
+ None,
124
+ Annotated[StrictFloat, Field(gt=0)],
125
+ Tuple[
126
+ Annotated[StrictFloat, Field(gt=0)],
127
+ Annotated[StrictFloat, Field(gt=0)]
128
+ ]
129
+ ] = None,
130
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
131
+ _content_type: Optional[StrictStr] = None,
132
+ _headers: Optional[Dict[StrictStr, Any]] = None,
133
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
134
+ ) -> ApiResponse[GetPipelineRunsResponse]:
135
+ """Return a paginated list of all pipeline runs the caller has access to
136
+
137
+
138
+ :param limit: The maximum number of items to return. Default 10. Max 100.
139
+ :type limit: int
140
+ :param page_token: A previously returned page token describing where to resume an enumeration.
141
+ :type page_token: str
142
+ :param _request_timeout: timeout setting for this request. If one
143
+ number provided, it will be total request
144
+ timeout. It can also be a pair (tuple) of
145
+ (connection, read) timeouts.
146
+ :type _request_timeout: int, tuple(int, int), optional
147
+ :param _request_auth: set to override the auth_settings for an a single
148
+ request; this effectively ignores the
149
+ authentication in the spec for a single request.
150
+ :type _request_auth: dict, optional
151
+ :param _content_type: force content-type for the request.
152
+ :type _content_type: str, Optional
153
+ :param _headers: set to override the headers for a single
154
+ request; this effectively ignores the headers
155
+ in the spec for a single request.
156
+ :type _headers: dict, optional
157
+ :param _host_index: set to override the host_index for a single
158
+ request; this effectively ignores the host_index
159
+ in the spec for a single request.
160
+ :type _host_index: int, optional
161
+ :return: Returns the result object.
162
+ """ # noqa: E501
163
+
164
+ _param = self._get_all_pipeline_runs_serialize(
165
+ limit=limit,
166
+ page_token=page_token,
167
+ _request_auth=_request_auth,
168
+ _content_type=_content_type,
169
+ _headers=_headers,
170
+ _host_index=_host_index
171
+ )
172
+
173
+ _response_types_map: Dict[str, Optional[str]] = {
174
+ '200': "GetPipelineRunsResponse",
175
+ '500': "ErrorReport",
176
+ }
177
+ response_data = self.api_client.call_api(
178
+ *_param,
179
+ _request_timeout=_request_timeout
180
+ )
181
+ response_data.read()
182
+ return self.api_client.response_deserialize(
183
+ response_data=response_data,
184
+ response_types_map=_response_types_map,
185
+ )
186
+
187
+
188
+ @validate_call
189
+ def get_all_pipeline_runs_without_preload_content(
190
+ self,
191
+ limit: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="The maximum number of items to return. Default 10. Max 100.")] = None,
192
+ page_token: Annotated[Optional[StrictStr], Field(description="A previously returned page token describing where to resume an enumeration.")] = None,
193
+ _request_timeout: Union[
194
+ None,
195
+ Annotated[StrictFloat, Field(gt=0)],
196
+ Tuple[
197
+ Annotated[StrictFloat, Field(gt=0)],
198
+ Annotated[StrictFloat, Field(gt=0)]
199
+ ]
200
+ ] = None,
201
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
202
+ _content_type: Optional[StrictStr] = None,
203
+ _headers: Optional[Dict[StrictStr, Any]] = None,
204
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
205
+ ) -> RESTResponseType:
206
+ """Return a paginated list of all pipeline runs the caller has access to
207
+
208
+
209
+ :param limit: The maximum number of items to return. Default 10. Max 100.
210
+ :type limit: int
211
+ :param page_token: A previously returned page token describing where to resume an enumeration.
212
+ :type page_token: str
213
+ :param _request_timeout: timeout setting for this request. If one
214
+ number provided, it will be total request
215
+ timeout. It can also be a pair (tuple) of
216
+ (connection, read) timeouts.
217
+ :type _request_timeout: int, tuple(int, int), optional
218
+ :param _request_auth: set to override the auth_settings for an a single
219
+ request; this effectively ignores the
220
+ authentication in the spec for a single request.
221
+ :type _request_auth: dict, optional
222
+ :param _content_type: force content-type for the request.
223
+ :type _content_type: str, Optional
224
+ :param _headers: set to override the headers for a single
225
+ request; this effectively ignores the headers
226
+ in the spec for a single request.
227
+ :type _headers: dict, optional
228
+ :param _host_index: set to override the host_index for a single
229
+ request; this effectively ignores the host_index
230
+ in the spec for a single request.
231
+ :type _host_index: int, optional
232
+ :return: Returns the result object.
233
+ """ # noqa: E501
234
+
235
+ _param = self._get_all_pipeline_runs_serialize(
236
+ limit=limit,
237
+ page_token=page_token,
238
+ _request_auth=_request_auth,
239
+ _content_type=_content_type,
240
+ _headers=_headers,
241
+ _host_index=_host_index
242
+ )
243
+
244
+ _response_types_map: Dict[str, Optional[str]] = {
245
+ '200': "GetPipelineRunsResponse",
246
+ '500': "ErrorReport",
247
+ }
248
+ response_data = self.api_client.call_api(
249
+ *_param,
250
+ _request_timeout=_request_timeout
251
+ )
252
+ return response_data.response
253
+
254
+
255
+ def _get_all_pipeline_runs_serialize(
256
+ self,
257
+ limit,
258
+ page_token,
259
+ _request_auth,
260
+ _content_type,
261
+ _headers,
262
+ _host_index,
263
+ ) -> RequestSerialized:
264
+
265
+ _host = None
266
+
267
+ _collection_formats: Dict[str, str] = {
268
+ }
269
+
270
+ _path_params: Dict[str, str] = {}
271
+ _query_params: List[Tuple[str, str]] = []
272
+ _header_params: Dict[str, Optional[str]] = _headers or {}
273
+ _form_params: List[Tuple[str, str]] = []
274
+ _files: Dict[
275
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
276
+ ] = {}
277
+ _body_params: Optional[bytes] = None
278
+
279
+ # process the path parameters
280
+ # process the query parameters
281
+ if limit is not None:
282
+
283
+ _query_params.append(('limit', limit))
284
+
285
+ if page_token is not None:
286
+
287
+ _query_params.append(('pageToken', page_token))
288
+
289
+ # process the header parameters
290
+ # process the form parameters
291
+ # process the body parameter
292
+
293
+
294
+ # set the HTTP header `Accept`
295
+ if 'Accept' not in _header_params:
296
+ _header_params['Accept'] = self.api_client.select_header_accept(
297
+ [
298
+ 'application/json'
299
+ ]
300
+ )
301
+
302
+
303
+ # authentication setting
304
+ _auth_settings: List[str] = [
305
+ 'oidc',
306
+ 'bearerAuth'
307
+ ]
308
+
309
+ return self.api_client.param_serialize(
310
+ method='GET',
311
+ resource_path='/api/pipelineruns/v1/pipelineruns',
312
+ path_params=_path_params,
313
+ query_params=_query_params,
314
+ header_params=_header_params,
315
+ body=_body_params,
316
+ post_params=_form_params,
317
+ files=_files,
318
+ auth_settings=_auth_settings,
319
+ collection_formats=_collection_formats,
320
+ _host=_host,
321
+ _request_auth=_request_auth
322
+ )
323
+
324
+
325
+
326
+
327
+ @validate_call
328
+ def get_pipeline_run_result(
329
+ self,
330
+ job_id: Annotated[StrictStr, Field(description="A UUID identifier for a pipelines job")],
331
+ _request_timeout: Union[
332
+ None,
333
+ Annotated[StrictFloat, Field(gt=0)],
334
+ Tuple[
335
+ Annotated[StrictFloat, Field(gt=0)],
336
+ Annotated[StrictFloat, Field(gt=0)]
337
+ ]
338
+ ] = None,
339
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
340
+ _content_type: Optional[StrictStr] = None,
341
+ _headers: Optional[Dict[StrictStr, Any]] = None,
342
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
343
+ ) -> AsyncPipelineRunResponse:
344
+ """Retrieve result for a specified pipeline run
345
+
346
+
347
+ :param job_id: A UUID identifier for a pipelines job (required)
348
+ :type job_id: str
349
+ :param _request_timeout: timeout setting for this request. If one
350
+ number provided, it will be total request
351
+ timeout. It can also be a pair (tuple) of
352
+ (connection, read) timeouts.
353
+ :type _request_timeout: int, tuple(int, int), optional
354
+ :param _request_auth: set to override the auth_settings for an a single
355
+ request; this effectively ignores the
356
+ authentication in the spec for a single request.
357
+ :type _request_auth: dict, optional
358
+ :param _content_type: force content-type for the request.
359
+ :type _content_type: str, Optional
360
+ :param _headers: set to override the headers for a single
361
+ request; this effectively ignores the headers
362
+ in the spec for a single request.
363
+ :type _headers: dict, optional
364
+ :param _host_index: set to override the host_index for a single
365
+ request; this effectively ignores the host_index
366
+ in the spec for a single request.
367
+ :type _host_index: int, optional
368
+ :return: Returns the result object.
369
+ """ # noqa: E501
370
+
371
+ _param = self._get_pipeline_run_result_serialize(
372
+ job_id=job_id,
373
+ _request_auth=_request_auth,
374
+ _content_type=_content_type,
375
+ _headers=_headers,
376
+ _host_index=_host_index
377
+ )
378
+
379
+ _response_types_map: Dict[str, Optional[str]] = {
380
+ '200': "AsyncPipelineRunResponse",
381
+ '202': "AsyncPipelineRunResponse",
382
+ '400': "ErrorReport",
383
+ '403': "ErrorReport",
384
+ '404': "ErrorReport",
385
+ '500': "ErrorReport",
386
+ }
387
+ response_data = self.api_client.call_api(
388
+ *_param,
389
+ _request_timeout=_request_timeout
390
+ )
391
+ response_data.read()
392
+ return self.api_client.response_deserialize(
393
+ response_data=response_data,
394
+ response_types_map=_response_types_map,
395
+ ).data
396
+
397
+
398
+ @validate_call
399
+ def get_pipeline_run_result_with_http_info(
400
+ self,
401
+ job_id: Annotated[StrictStr, Field(description="A UUID identifier for a pipelines job")],
402
+ _request_timeout: Union[
403
+ None,
404
+ Annotated[StrictFloat, Field(gt=0)],
405
+ Tuple[
406
+ Annotated[StrictFloat, Field(gt=0)],
407
+ Annotated[StrictFloat, Field(gt=0)]
408
+ ]
409
+ ] = None,
410
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
411
+ _content_type: Optional[StrictStr] = None,
412
+ _headers: Optional[Dict[StrictStr, Any]] = None,
413
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
414
+ ) -> ApiResponse[AsyncPipelineRunResponse]:
415
+ """Retrieve result for a specified pipeline run
416
+
417
+
418
+ :param job_id: A UUID identifier for a pipelines job (required)
419
+ :type job_id: str
420
+ :param _request_timeout: timeout setting for this request. If one
421
+ number provided, it will be total request
422
+ timeout. It can also be a pair (tuple) of
423
+ (connection, read) timeouts.
424
+ :type _request_timeout: int, tuple(int, int), optional
425
+ :param _request_auth: set to override the auth_settings for an a single
426
+ request; this effectively ignores the
427
+ authentication in the spec for a single request.
428
+ :type _request_auth: dict, optional
429
+ :param _content_type: force content-type for the request.
430
+ :type _content_type: str, Optional
431
+ :param _headers: set to override the headers for a single
432
+ request; this effectively ignores the headers
433
+ in the spec for a single request.
434
+ :type _headers: dict, optional
435
+ :param _host_index: set to override the host_index for a single
436
+ request; this effectively ignores the host_index
437
+ in the spec for a single request.
438
+ :type _host_index: int, optional
439
+ :return: Returns the result object.
440
+ """ # noqa: E501
441
+
442
+ _param = self._get_pipeline_run_result_serialize(
443
+ job_id=job_id,
444
+ _request_auth=_request_auth,
445
+ _content_type=_content_type,
446
+ _headers=_headers,
447
+ _host_index=_host_index
448
+ )
449
+
450
+ _response_types_map: Dict[str, Optional[str]] = {
451
+ '200': "AsyncPipelineRunResponse",
452
+ '202': "AsyncPipelineRunResponse",
453
+ '400': "ErrorReport",
454
+ '403': "ErrorReport",
455
+ '404': "ErrorReport",
456
+ '500': "ErrorReport",
457
+ }
458
+ response_data = self.api_client.call_api(
459
+ *_param,
460
+ _request_timeout=_request_timeout
461
+ )
462
+ response_data.read()
463
+ return self.api_client.response_deserialize(
464
+ response_data=response_data,
465
+ response_types_map=_response_types_map,
466
+ )
467
+
468
+
469
+ @validate_call
470
+ def get_pipeline_run_result_without_preload_content(
471
+ self,
472
+ job_id: Annotated[StrictStr, Field(description="A UUID identifier for a pipelines job")],
473
+ _request_timeout: Union[
474
+ None,
475
+ Annotated[StrictFloat, Field(gt=0)],
476
+ Tuple[
477
+ Annotated[StrictFloat, Field(gt=0)],
478
+ Annotated[StrictFloat, Field(gt=0)]
479
+ ]
480
+ ] = None,
481
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
482
+ _content_type: Optional[StrictStr] = None,
483
+ _headers: Optional[Dict[StrictStr, Any]] = None,
484
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
485
+ ) -> RESTResponseType:
486
+ """Retrieve result for a specified pipeline run
487
+
488
+
489
+ :param job_id: A UUID identifier for a pipelines job (required)
490
+ :type job_id: str
491
+ :param _request_timeout: timeout setting for this request. If one
492
+ number provided, it will be total request
493
+ timeout. It can also be a pair (tuple) of
494
+ (connection, read) timeouts.
495
+ :type _request_timeout: int, tuple(int, int), optional
496
+ :param _request_auth: set to override the auth_settings for an a single
497
+ request; this effectively ignores the
498
+ authentication in the spec for a single request.
499
+ :type _request_auth: dict, optional
500
+ :param _content_type: force content-type for the request.
501
+ :type _content_type: str, Optional
502
+ :param _headers: set to override the headers for a single
503
+ request; this effectively ignores the headers
504
+ in the spec for a single request.
505
+ :type _headers: dict, optional
506
+ :param _host_index: set to override the host_index for a single
507
+ request; this effectively ignores the host_index
508
+ in the spec for a single request.
509
+ :type _host_index: int, optional
510
+ :return: Returns the result object.
511
+ """ # noqa: E501
512
+
513
+ _param = self._get_pipeline_run_result_serialize(
514
+ job_id=job_id,
515
+ _request_auth=_request_auth,
516
+ _content_type=_content_type,
517
+ _headers=_headers,
518
+ _host_index=_host_index
519
+ )
520
+
521
+ _response_types_map: Dict[str, Optional[str]] = {
522
+ '200': "AsyncPipelineRunResponse",
523
+ '202': "AsyncPipelineRunResponse",
524
+ '400': "ErrorReport",
525
+ '403': "ErrorReport",
526
+ '404': "ErrorReport",
527
+ '500': "ErrorReport",
528
+ }
529
+ response_data = self.api_client.call_api(
530
+ *_param,
531
+ _request_timeout=_request_timeout
532
+ )
533
+ return response_data.response
534
+
535
+
536
+ def _get_pipeline_run_result_serialize(
537
+ self,
538
+ job_id,
539
+ _request_auth,
540
+ _content_type,
541
+ _headers,
542
+ _host_index,
543
+ ) -> RequestSerialized:
544
+
545
+ _host = None
546
+
547
+ _collection_formats: Dict[str, str] = {
548
+ }
549
+
550
+ _path_params: Dict[str, str] = {}
551
+ _query_params: List[Tuple[str, str]] = []
552
+ _header_params: Dict[str, Optional[str]] = _headers or {}
553
+ _form_params: List[Tuple[str, str]] = []
554
+ _files: Dict[
555
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
556
+ ] = {}
557
+ _body_params: Optional[bytes] = None
558
+
559
+ # process the path parameters
560
+ if job_id is not None:
561
+ _path_params['jobId'] = job_id
562
+ # process the query parameters
563
+ # process the header parameters
564
+ # process the form parameters
565
+ # process the body parameter
566
+
567
+
568
+ # set the HTTP header `Accept`
569
+ if 'Accept' not in _header_params:
570
+ _header_params['Accept'] = self.api_client.select_header_accept(
571
+ [
572
+ 'application/json'
573
+ ]
574
+ )
575
+
576
+
577
+ # authentication setting
578
+ _auth_settings: List[str] = [
579
+ 'oidc',
580
+ 'bearerAuth'
581
+ ]
582
+
583
+ return self.api_client.param_serialize(
584
+ method='GET',
585
+ resource_path='/api/pipelineruns/v1/result/{jobId}',
586
+ path_params=_path_params,
587
+ query_params=_query_params,
588
+ header_params=_header_params,
589
+ body=_body_params,
590
+ post_params=_form_params,
591
+ files=_files,
592
+ auth_settings=_auth_settings,
593
+ collection_formats=_collection_formats,
594
+ _host=_host,
595
+ _request_auth=_request_auth
596
+ )
597
+
598
+
599
+
600
+
601
+ @validate_call
602
+ def prepare_pipeline_run(
603
+ self,
604
+ prepare_pipeline_run_request_body: PreparePipelineRunRequestBody,
605
+ _request_timeout: Union[
606
+ None,
607
+ Annotated[StrictFloat, Field(gt=0)],
608
+ Tuple[
609
+ Annotated[StrictFloat, Field(gt=0)],
610
+ Annotated[StrictFloat, Field(gt=0)]
611
+ ]
612
+ ] = None,
613
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
614
+ _content_type: Optional[StrictStr] = None,
615
+ _headers: Optional[Dict[StrictStr, Any]] = None,
616
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
617
+ ) -> PreparePipelineRunResponse:
618
+ """Prepare a new pipeline run
619
+
620
+
621
+ :param prepare_pipeline_run_request_body: (required)
622
+ :type prepare_pipeline_run_request_body: PreparePipelineRunRequestBody
623
+ :param _request_timeout: timeout setting for this request. If one
624
+ number provided, it will be total request
625
+ timeout. It can also be a pair (tuple) of
626
+ (connection, read) timeouts.
627
+ :type _request_timeout: int, tuple(int, int), optional
628
+ :param _request_auth: set to override the auth_settings for an a single
629
+ request; this effectively ignores the
630
+ authentication in the spec for a single request.
631
+ :type _request_auth: dict, optional
632
+ :param _content_type: force content-type for the request.
633
+ :type _content_type: str, Optional
634
+ :param _headers: set to override the headers for a single
635
+ request; this effectively ignores the headers
636
+ in the spec for a single request.
637
+ :type _headers: dict, optional
638
+ :param _host_index: set to override the host_index for a single
639
+ request; this effectively ignores the host_index
640
+ in the spec for a single request.
641
+ :type _host_index: int, optional
642
+ :return: Returns the result object.
643
+ """ # noqa: E501
644
+
645
+ _param = self._prepare_pipeline_run_serialize(
646
+ prepare_pipeline_run_request_body=prepare_pipeline_run_request_body,
647
+ _request_auth=_request_auth,
648
+ _content_type=_content_type,
649
+ _headers=_headers,
650
+ _host_index=_host_index
651
+ )
652
+
653
+ _response_types_map: Dict[str, Optional[str]] = {
654
+ '200': "PreparePipelineRunResponse",
655
+ '400': "ErrorReport",
656
+ '404': "ErrorReport",
657
+ '500': "ErrorReport",
658
+ }
659
+ response_data = self.api_client.call_api(
660
+ *_param,
661
+ _request_timeout=_request_timeout
662
+ )
663
+ response_data.read()
664
+ return self.api_client.response_deserialize(
665
+ response_data=response_data,
666
+ response_types_map=_response_types_map,
667
+ ).data
668
+
669
+
670
+ @validate_call
671
+ def prepare_pipeline_run_with_http_info(
672
+ self,
673
+ prepare_pipeline_run_request_body: PreparePipelineRunRequestBody,
674
+ _request_timeout: Union[
675
+ None,
676
+ Annotated[StrictFloat, Field(gt=0)],
677
+ Tuple[
678
+ Annotated[StrictFloat, Field(gt=0)],
679
+ Annotated[StrictFloat, Field(gt=0)]
680
+ ]
681
+ ] = None,
682
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
683
+ _content_type: Optional[StrictStr] = None,
684
+ _headers: Optional[Dict[StrictStr, Any]] = None,
685
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
686
+ ) -> ApiResponse[PreparePipelineRunResponse]:
687
+ """Prepare a new pipeline run
688
+
689
+
690
+ :param prepare_pipeline_run_request_body: (required)
691
+ :type prepare_pipeline_run_request_body: PreparePipelineRunRequestBody
692
+ :param _request_timeout: timeout setting for this request. If one
693
+ number provided, it will be total request
694
+ timeout. It can also be a pair (tuple) of
695
+ (connection, read) timeouts.
696
+ :type _request_timeout: int, tuple(int, int), optional
697
+ :param _request_auth: set to override the auth_settings for an a single
698
+ request; this effectively ignores the
699
+ authentication in the spec for a single request.
700
+ :type _request_auth: dict, optional
701
+ :param _content_type: force content-type for the request.
702
+ :type _content_type: str, Optional
703
+ :param _headers: set to override the headers for a single
704
+ request; this effectively ignores the headers
705
+ in the spec for a single request.
706
+ :type _headers: dict, optional
707
+ :param _host_index: set to override the host_index for a single
708
+ request; this effectively ignores the host_index
709
+ in the spec for a single request.
710
+ :type _host_index: int, optional
711
+ :return: Returns the result object.
712
+ """ # noqa: E501
713
+
714
+ _param = self._prepare_pipeline_run_serialize(
715
+ prepare_pipeline_run_request_body=prepare_pipeline_run_request_body,
716
+ _request_auth=_request_auth,
717
+ _content_type=_content_type,
718
+ _headers=_headers,
719
+ _host_index=_host_index
720
+ )
721
+
722
+ _response_types_map: Dict[str, Optional[str]] = {
723
+ '200': "PreparePipelineRunResponse",
724
+ '400': "ErrorReport",
725
+ '404': "ErrorReport",
726
+ '500': "ErrorReport",
727
+ }
728
+ response_data = self.api_client.call_api(
729
+ *_param,
730
+ _request_timeout=_request_timeout
731
+ )
732
+ response_data.read()
733
+ return self.api_client.response_deserialize(
734
+ response_data=response_data,
735
+ response_types_map=_response_types_map,
736
+ )
737
+
738
+
739
+ @validate_call
740
+ def prepare_pipeline_run_without_preload_content(
741
+ self,
742
+ prepare_pipeline_run_request_body: PreparePipelineRunRequestBody,
743
+ _request_timeout: Union[
744
+ None,
745
+ Annotated[StrictFloat, Field(gt=0)],
746
+ Tuple[
747
+ Annotated[StrictFloat, Field(gt=0)],
748
+ Annotated[StrictFloat, Field(gt=0)]
749
+ ]
750
+ ] = None,
751
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
752
+ _content_type: Optional[StrictStr] = None,
753
+ _headers: Optional[Dict[StrictStr, Any]] = None,
754
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
755
+ ) -> RESTResponseType:
756
+ """Prepare a new pipeline run
757
+
758
+
759
+ :param prepare_pipeline_run_request_body: (required)
760
+ :type prepare_pipeline_run_request_body: PreparePipelineRunRequestBody
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._prepare_pipeline_run_serialize(
784
+ prepare_pipeline_run_request_body=prepare_pipeline_run_request_body,
785
+ _request_auth=_request_auth,
786
+ _content_type=_content_type,
787
+ _headers=_headers,
788
+ _host_index=_host_index
789
+ )
790
+
791
+ _response_types_map: Dict[str, Optional[str]] = {
792
+ '200': "PreparePipelineRunResponse",
793
+ '400': "ErrorReport",
794
+ '404': "ErrorReport",
795
+ '500': "ErrorReport",
796
+ }
797
+ response_data = self.api_client.call_api(
798
+ *_param,
799
+ _request_timeout=_request_timeout
800
+ )
801
+ return response_data.response
802
+
803
+
804
+ def _prepare_pipeline_run_serialize(
805
+ self,
806
+ prepare_pipeline_run_request_body,
807
+ _request_auth,
808
+ _content_type,
809
+ _headers,
810
+ _host_index,
811
+ ) -> RequestSerialized:
812
+
813
+ _host = None
814
+
815
+ _collection_formats: Dict[str, str] = {
816
+ }
817
+
818
+ _path_params: Dict[str, str] = {}
819
+ _query_params: List[Tuple[str, str]] = []
820
+ _header_params: Dict[str, Optional[str]] = _headers or {}
821
+ _form_params: List[Tuple[str, str]] = []
822
+ _files: Dict[
823
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
824
+ ] = {}
825
+ _body_params: Optional[bytes] = None
826
+
827
+ # process the path parameters
828
+ # process the query parameters
829
+ # process the header parameters
830
+ # process the form parameters
831
+ # process the body parameter
832
+ if prepare_pipeline_run_request_body is not None:
833
+ _body_params = prepare_pipeline_run_request_body
834
+
835
+
836
+ # set the HTTP header `Accept`
837
+ if 'Accept' not in _header_params:
838
+ _header_params['Accept'] = self.api_client.select_header_accept(
839
+ [
840
+ 'application/json'
841
+ ]
842
+ )
843
+
844
+ # set the HTTP header `Content-Type`
845
+ if _content_type:
846
+ _header_params['Content-Type'] = _content_type
847
+ else:
848
+ _default_content_type = (
849
+ self.api_client.select_header_content_type(
850
+ [
851
+ 'application/json'
852
+ ]
853
+ )
854
+ )
855
+ if _default_content_type is not None:
856
+ _header_params['Content-Type'] = _default_content_type
857
+
858
+ # authentication setting
859
+ _auth_settings: List[str] = [
860
+ 'oidc',
861
+ 'bearerAuth'
862
+ ]
863
+
864
+ return self.api_client.param_serialize(
865
+ method='POST',
866
+ resource_path='/api/pipelineruns/v1/prepare',
867
+ path_params=_path_params,
868
+ query_params=_query_params,
869
+ header_params=_header_params,
870
+ body=_body_params,
871
+ post_params=_form_params,
872
+ files=_files,
873
+ auth_settings=_auth_settings,
874
+ collection_formats=_collection_formats,
875
+ _host=_host,
876
+ _request_auth=_request_auth
877
+ )
878
+
879
+
880
+
881
+
882
+ @validate_call
883
+ def start_pipeline_run(
884
+ self,
885
+ start_pipeline_run_request_body: StartPipelineRunRequestBody,
886
+ _request_timeout: Union[
887
+ None,
888
+ Annotated[StrictFloat, Field(gt=0)],
889
+ Tuple[
890
+ Annotated[StrictFloat, Field(gt=0)],
891
+ Annotated[StrictFloat, Field(gt=0)]
892
+ ]
893
+ ] = None,
894
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
895
+ _content_type: Optional[StrictStr] = None,
896
+ _headers: Optional[Dict[StrictStr, Any]] = None,
897
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
898
+ ) -> AsyncPipelineRunResponse:
899
+ """Start a prepared pipeline run
900
+
901
+
902
+ :param start_pipeline_run_request_body: (required)
903
+ :type start_pipeline_run_request_body: StartPipelineRunRequestBody
904
+ :param _request_timeout: timeout setting for this request. If one
905
+ number provided, it will be total request
906
+ timeout. It can also be a pair (tuple) of
907
+ (connection, read) timeouts.
908
+ :type _request_timeout: int, tuple(int, int), optional
909
+ :param _request_auth: set to override the auth_settings for an a single
910
+ request; this effectively ignores the
911
+ authentication in the spec for a single request.
912
+ :type _request_auth: dict, optional
913
+ :param _content_type: force content-type for the request.
914
+ :type _content_type: str, Optional
915
+ :param _headers: set to override the headers for a single
916
+ request; this effectively ignores the headers
917
+ in the spec for a single request.
918
+ :type _headers: dict, optional
919
+ :param _host_index: set to override the host_index for a single
920
+ request; this effectively ignores the host_index
921
+ in the spec for a single request.
922
+ :type _host_index: int, optional
923
+ :return: Returns the result object.
924
+ """ # noqa: E501
925
+
926
+ _param = self._start_pipeline_run_serialize(
927
+ start_pipeline_run_request_body=start_pipeline_run_request_body,
928
+ _request_auth=_request_auth,
929
+ _content_type=_content_type,
930
+ _headers=_headers,
931
+ _host_index=_host_index
932
+ )
933
+
934
+ _response_types_map: Dict[str, Optional[str]] = {
935
+ '200': "AsyncPipelineRunResponse",
936
+ '202': "AsyncPipelineRunResponse",
937
+ '400': "ErrorReport",
938
+ '403': "ErrorReport",
939
+ '404': "ErrorReport",
940
+ '500': "ErrorReport",
941
+ }
942
+ response_data = self.api_client.call_api(
943
+ *_param,
944
+ _request_timeout=_request_timeout
945
+ )
946
+ response_data.read()
947
+ return self.api_client.response_deserialize(
948
+ response_data=response_data,
949
+ response_types_map=_response_types_map,
950
+ ).data
951
+
952
+
953
+ @validate_call
954
+ def start_pipeline_run_with_http_info(
955
+ self,
956
+ start_pipeline_run_request_body: StartPipelineRunRequestBody,
957
+ _request_timeout: Union[
958
+ None,
959
+ Annotated[StrictFloat, Field(gt=0)],
960
+ Tuple[
961
+ Annotated[StrictFloat, Field(gt=0)],
962
+ Annotated[StrictFloat, Field(gt=0)]
963
+ ]
964
+ ] = None,
965
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
966
+ _content_type: Optional[StrictStr] = None,
967
+ _headers: Optional[Dict[StrictStr, Any]] = None,
968
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
969
+ ) -> ApiResponse[AsyncPipelineRunResponse]:
970
+ """Start a prepared pipeline run
971
+
972
+
973
+ :param start_pipeline_run_request_body: (required)
974
+ :type start_pipeline_run_request_body: StartPipelineRunRequestBody
975
+ :param _request_timeout: timeout setting for this request. If one
976
+ number provided, it will be total request
977
+ timeout. It can also be a pair (tuple) of
978
+ (connection, read) timeouts.
979
+ :type _request_timeout: int, tuple(int, int), optional
980
+ :param _request_auth: set to override the auth_settings for an a single
981
+ request; this effectively ignores the
982
+ authentication in the spec for a single request.
983
+ :type _request_auth: dict, optional
984
+ :param _content_type: force content-type for the request.
985
+ :type _content_type: str, Optional
986
+ :param _headers: set to override the headers for a single
987
+ request; this effectively ignores the headers
988
+ in the spec for a single request.
989
+ :type _headers: dict, optional
990
+ :param _host_index: set to override the host_index for a single
991
+ request; this effectively ignores the host_index
992
+ in the spec for a single request.
993
+ :type _host_index: int, optional
994
+ :return: Returns the result object.
995
+ """ # noqa: E501
996
+
997
+ _param = self._start_pipeline_run_serialize(
998
+ start_pipeline_run_request_body=start_pipeline_run_request_body,
999
+ _request_auth=_request_auth,
1000
+ _content_type=_content_type,
1001
+ _headers=_headers,
1002
+ _host_index=_host_index
1003
+ )
1004
+
1005
+ _response_types_map: Dict[str, Optional[str]] = {
1006
+ '200': "AsyncPipelineRunResponse",
1007
+ '202': "AsyncPipelineRunResponse",
1008
+ '400': "ErrorReport",
1009
+ '403': "ErrorReport",
1010
+ '404': "ErrorReport",
1011
+ '500': "ErrorReport",
1012
+ }
1013
+ response_data = self.api_client.call_api(
1014
+ *_param,
1015
+ _request_timeout=_request_timeout
1016
+ )
1017
+ response_data.read()
1018
+ return self.api_client.response_deserialize(
1019
+ response_data=response_data,
1020
+ response_types_map=_response_types_map,
1021
+ )
1022
+
1023
+
1024
+ @validate_call
1025
+ def start_pipeline_run_without_preload_content(
1026
+ self,
1027
+ start_pipeline_run_request_body: StartPipelineRunRequestBody,
1028
+ _request_timeout: Union[
1029
+ None,
1030
+ Annotated[StrictFloat, Field(gt=0)],
1031
+ Tuple[
1032
+ Annotated[StrictFloat, Field(gt=0)],
1033
+ Annotated[StrictFloat, Field(gt=0)]
1034
+ ]
1035
+ ] = None,
1036
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1037
+ _content_type: Optional[StrictStr] = None,
1038
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1039
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1040
+ ) -> RESTResponseType:
1041
+ """Start a prepared pipeline run
1042
+
1043
+
1044
+ :param start_pipeline_run_request_body: (required)
1045
+ :type start_pipeline_run_request_body: StartPipelineRunRequestBody
1046
+ :param _request_timeout: timeout setting for this request. If one
1047
+ number provided, it will be total request
1048
+ timeout. It can also be a pair (tuple) of
1049
+ (connection, read) timeouts.
1050
+ :type _request_timeout: int, tuple(int, int), optional
1051
+ :param _request_auth: set to override the auth_settings for an a single
1052
+ request; this effectively ignores the
1053
+ authentication in the spec for a single request.
1054
+ :type _request_auth: dict, optional
1055
+ :param _content_type: force content-type for the request.
1056
+ :type _content_type: str, Optional
1057
+ :param _headers: set to override the headers for a single
1058
+ request; this effectively ignores the headers
1059
+ in the spec for a single request.
1060
+ :type _headers: dict, optional
1061
+ :param _host_index: set to override the host_index for a single
1062
+ request; this effectively ignores the host_index
1063
+ in the spec for a single request.
1064
+ :type _host_index: int, optional
1065
+ :return: Returns the result object.
1066
+ """ # noqa: E501
1067
+
1068
+ _param = self._start_pipeline_run_serialize(
1069
+ start_pipeline_run_request_body=start_pipeline_run_request_body,
1070
+ _request_auth=_request_auth,
1071
+ _content_type=_content_type,
1072
+ _headers=_headers,
1073
+ _host_index=_host_index
1074
+ )
1075
+
1076
+ _response_types_map: Dict[str, Optional[str]] = {
1077
+ '200': "AsyncPipelineRunResponse",
1078
+ '202': "AsyncPipelineRunResponse",
1079
+ '400': "ErrorReport",
1080
+ '403': "ErrorReport",
1081
+ '404': "ErrorReport",
1082
+ '500': "ErrorReport",
1083
+ }
1084
+ response_data = self.api_client.call_api(
1085
+ *_param,
1086
+ _request_timeout=_request_timeout
1087
+ )
1088
+ return response_data.response
1089
+
1090
+
1091
+ def _start_pipeline_run_serialize(
1092
+ self,
1093
+ start_pipeline_run_request_body,
1094
+ _request_auth,
1095
+ _content_type,
1096
+ _headers,
1097
+ _host_index,
1098
+ ) -> RequestSerialized:
1099
+
1100
+ _host = None
1101
+
1102
+ _collection_formats: Dict[str, str] = {
1103
+ }
1104
+
1105
+ _path_params: Dict[str, str] = {}
1106
+ _query_params: List[Tuple[str, str]] = []
1107
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1108
+ _form_params: List[Tuple[str, str]] = []
1109
+ _files: Dict[
1110
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1111
+ ] = {}
1112
+ _body_params: Optional[bytes] = None
1113
+
1114
+ # process the path parameters
1115
+ # process the query parameters
1116
+ # process the header parameters
1117
+ # process the form parameters
1118
+ # process the body parameter
1119
+ if start_pipeline_run_request_body is not None:
1120
+ _body_params = start_pipeline_run_request_body
1121
+
1122
+
1123
+ # set the HTTP header `Accept`
1124
+ if 'Accept' not in _header_params:
1125
+ _header_params['Accept'] = self.api_client.select_header_accept(
1126
+ [
1127
+ 'application/json'
1128
+ ]
1129
+ )
1130
+
1131
+ # set the HTTP header `Content-Type`
1132
+ if _content_type:
1133
+ _header_params['Content-Type'] = _content_type
1134
+ else:
1135
+ _default_content_type = (
1136
+ self.api_client.select_header_content_type(
1137
+ [
1138
+ 'application/json'
1139
+ ]
1140
+ )
1141
+ )
1142
+ if _default_content_type is not None:
1143
+ _header_params['Content-Type'] = _default_content_type
1144
+
1145
+ # authentication setting
1146
+ _auth_settings: List[str] = [
1147
+ 'oidc',
1148
+ 'bearerAuth'
1149
+ ]
1150
+
1151
+ return self.api_client.param_serialize(
1152
+ method='POST',
1153
+ resource_path='/api/pipelineruns/v1/start',
1154
+ path_params=_path_params,
1155
+ query_params=_query_params,
1156
+ header_params=_header_params,
1157
+ body=_body_params,
1158
+ post_params=_form_params,
1159
+ files=_files,
1160
+ auth_settings=_auth_settings,
1161
+ collection_formats=_collection_formats,
1162
+ _host=_host,
1163
+ _request_auth=_request_auth
1164
+ )
1165
+
1166
+