rapidata 2.23.2__py3-none-any.whl → 3.0.1__py3-none-any.whl

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

Potentially problematic release.


This version of rapidata might be problematic. Click here for more details.

Files changed (865) hide show
  1. rapidata/__init__.py +31 -14
  2. rapidata/api_client/__init__.py +84 -312
  3. rapidata/api_client/api/__init__.py +12 -3
  4. rapidata/api_client/api/asset_api.py +853 -0
  5. rapidata/api_client/api/audience_api.py +3044 -0
  6. rapidata/api_client/api/benchmark_api.py +4307 -0
  7. rapidata/api_client/api/campaign_api.py +232 -207
  8. rapidata/api_client/api/client_api.py +166 -145
  9. rapidata/api_client/api/coco_api.py +0 -571
  10. rapidata/api_client/api/compare_workflow_api.py +11 -10
  11. rapidata/api_client/api/customer_rapid_api.py +2216 -0
  12. rapidata/api_client/api/datapoint_api.py +8 -797
  13. rapidata/api_client/api/dataset_api.py +276 -2858
  14. rapidata/api_client/api/evaluation_workflow_api.py +29 -82
  15. rapidata/api_client/api/feedback_api.py +11 -281
  16. rapidata/api_client/api/grouped_ranking_workflow_api.py +319 -0
  17. rapidata/api_client/api/identity_api.py +83 -1171
  18. rapidata/api_client/api/job_api.py +4200 -0
  19. rapidata/api_client/api/job_definition_api.py +319 -0
  20. rapidata/api_client/api/job_revision_api.py +335 -0
  21. rapidata/api_client/api/leaderboard_api.py +2855 -0
  22. rapidata/api_client/api/newsletter_api.py +30 -317
  23. rapidata/api_client/api/order_api.py +758 -5487
  24. rapidata/api_client/api/participant_api.py +2181 -0
  25. rapidata/api_client/api/pipeline_api.py +24 -1783
  26. rapidata/api_client/api/prompt_api.py +320 -0
  27. rapidata/api_client/api/rapidata_identity_api_api.py +5 -4
  28. rapidata/api_client/api/sample_api.py +300 -0
  29. rapidata/api_client/api/simple_workflow_api.py +11 -10
  30. rapidata/api_client/api/survey_api.py +304 -0
  31. rapidata/api_client/api/user_rapid_api.py +1389 -0
  32. rapidata/api_client/api/validation_set_api.py +510 -3230
  33. rapidata/api_client/api/workflow_api.py +32 -825
  34. rapidata/api_client/api_client.py +2 -2
  35. rapidata/api_client/configuration.py +16 -29
  36. rapidata/api_client/exceptions.py +2 -2
  37. rapidata/api_client/models/__init__.py +65 -291
  38. rapidata/api_client/models/ab_test_selection_a_inner.py +27 -13
  39. rapidata/api_client/models/add_campaign_model.py +8 -3
  40. rapidata/api_client/models/add_rapid_to_audience_model.py +144 -0
  41. rapidata/api_client/models/add_user_response_result.py +10 -5
  42. rapidata/api_client/models/add_validation_rapid_model.py +49 -28
  43. rapidata/api_client/models/add_validation_rapid_model_asset.py +154 -0
  44. rapidata/api_client/models/add_validation_rapid_model_context_asset.py +160 -0
  45. rapidata/api_client/models/add_validation_rapid_model_metadata_inner.py +140 -0
  46. rapidata/api_client/models/add_validation_rapid_model_truth.py +32 -12
  47. rapidata/api_client/models/add_validation_rapid_new_model.py +137 -0
  48. rapidata/api_client/models/add_validation_rapid_new_model_asset.py +182 -0
  49. rapidata/api_client/models/add_validation_rapid_new_model_truth.py +286 -0
  50. rapidata/api_client/models/add_validation_text_rapid_model.py +4 -6
  51. rapidata/api_client/models/age_user_filter_model.py +2 -2
  52. rapidata/api_client/models/age_user_filter_model_age_group.py +41 -0
  53. rapidata/api_client/models/aggregated_orders_model.py +98 -0
  54. rapidata/api_client/models/aggregator_type.py +4 -2
  55. rapidata/api_client/models/and_filter.py +121 -0
  56. rapidata/api_client/models/and_filter_filters_inner.py +282 -0
  57. rapidata/api_client/models/and_user_filter_model.py +106 -0
  58. rapidata/api_client/models/and_user_filter_model_filters_inner.py +282 -0
  59. rapidata/api_client/models/are_rapids_active_result.py +2 -2
  60. rapidata/api_client/models/asset_metadata.py +106 -0
  61. rapidata/api_client/models/asset_metadata_asset.py +170 -0
  62. rapidata/api_client/models/asset_metadata_model.py +96 -0
  63. rapidata/api_client/models/asset_metadata_model_asset.py +170 -0
  64. rapidata/api_client/models/asset_type.py +40 -0
  65. rapidata/api_client/models/attach_category_rapid_blueprint.py +13 -3
  66. rapidata/api_client/models/attach_category_rapid_blueprint_category.py +89 -0
  67. rapidata/api_client/models/audience_job_state.py +38 -0
  68. rapidata/api_client/models/audience_status.py +39 -0
  69. rapidata/api_client/models/benchmark_query_result.py +98 -0
  70. rapidata/api_client/models/benchmark_query_result_paged_result.py +105 -0
  71. rapidata/api_client/models/boost_leaderboard_model.py +89 -0
  72. rapidata/api_client/models/boost_mode.py +37 -0
  73. rapidata/api_client/models/boost_query_result.py +97 -0
  74. rapidata/api_client/models/boost_query_result_boost_mode.py +37 -0
  75. rapidata/api_client/models/boost_query_result_boost_status.py +39 -0
  76. rapidata/api_client/models/boost_status.py +39 -0
  77. rapidata/api_client/models/boosting_profile.py +91 -0
  78. rapidata/api_client/models/box_shape.py +4 -33
  79. rapidata/api_client/models/campaign_filter.py +98 -0
  80. rapidata/api_client/models/campaign_query_result.py +15 -13
  81. rapidata/api_client/models/campaign_status.py +2 -2
  82. rapidata/api_client/models/change_boost_model.py +89 -0
  83. rapidata/api_client/models/classification_metadata.py +12 -1
  84. rapidata/api_client/models/classify_payload.py +14 -15
  85. rapidata/api_client/models/classify_payload_category.py +89 -0
  86. rapidata/api_client/models/client_model.py +181 -0
  87. rapidata/api_client/models/clients_query_result.py +5 -5
  88. rapidata/api_client/models/clone_order_model.py +6 -8
  89. rapidata/api_client/models/clone_order_result.py +9 -4
  90. rapidata/api_client/models/compare_rapid_blueprint.py +5 -3
  91. rapidata/api_client/models/compare_rapid_blueprint1.py +96 -0
  92. rapidata/api_client/models/compare_result.py +1 -10
  93. rapidata/api_client/models/compare_workflow_config.py +34 -23
  94. rapidata/api_client/models/compare_workflow_config_context_asset.py +174 -0
  95. rapidata/api_client/models/compare_workflow_config_metadata_value.py +75 -17
  96. rapidata/api_client/models/compare_workflow_config_model.py +15 -5
  97. rapidata/api_client/models/compare_workflow_model.py +34 -6
  98. rapidata/api_client/models/compare_workflow_model1.py +20 -9
  99. rapidata/api_client/models/compare_workflow_model_context_asset.py +160 -0
  100. rapidata/api_client/models/compare_workflow_model_metadata_inner.py +154 -0
  101. rapidata/api_client/models/compare_workflow_model_pair_maker_config.py +1 -1
  102. rapidata/api_client/models/comparison_operator.py +2 -2
  103. rapidata/api_client/models/conditional_validation_selection.py +8 -11
  104. rapidata/api_client/models/conditional_validation_selection_validation_chance.py +103 -0
  105. rapidata/api_client/models/confidence_interval.py +89 -0
  106. rapidata/api_client/models/count_metadata.py +12 -1
  107. rapidata/api_client/models/country_filter.py +98 -0
  108. rapidata/api_client/models/create_audience_request.py +122 -0
  109. rapidata/api_client/models/create_audience_result.py +87 -0
  110. rapidata/api_client/models/create_benchmark_model.py +87 -0
  111. rapidata/api_client/models/create_benchmark_participant_model.py +87 -0
  112. rapidata/api_client/models/create_benchmark_participant_result.py +89 -0
  113. rapidata/api_client/models/create_benchmark_prompt_result.py +87 -0
  114. rapidata/api_client/models/create_benchmark_result.py +87 -0
  115. rapidata/api_client/models/create_bridge_token_result.py +2 -2
  116. rapidata/api_client/models/create_client_model.py +6 -13
  117. rapidata/api_client/models/create_complex_order_model.py +9 -9
  118. rapidata/api_client/models/create_complex_order_result.py +6 -4
  119. rapidata/api_client/models/create_customer_client_result.py +89 -0
  120. rapidata/api_client/models/create_datapoint_from_files_model_metadata_inner.py +25 -11
  121. rapidata/api_client/models/create_datapoint_model.py +124 -0
  122. rapidata/api_client/models/create_datapoint_model_asset.py +154 -0
  123. rapidata/api_client/models/create_datapoint_model_context_asset.py +160 -0
  124. rapidata/api_client/models/create_datapoint_model_metadata_inner.py +154 -0
  125. rapidata/api_client/models/create_datapoint_result.py +6 -18
  126. rapidata/api_client/models/create_dataset_endpoint_input.py +87 -0
  127. rapidata/api_client/models/create_dataset_endpoint_output.py +87 -0
  128. rapidata/api_client/models/create_demographic_rapid_model.py +45 -7
  129. rapidata/api_client/models/create_demographic_rapid_model_asset.py +160 -0
  130. rapidata/api_client/models/create_demographic_rapid_model_context_asset.py +160 -0
  131. rapidata/api_client/models/create_demographic_rapid_model_new.py +119 -0
  132. rapidata/api_client/models/create_empty_validation_set_result.py +2 -2
  133. rapidata/api_client/models/create_job_definition_endpoint_input.py +119 -0
  134. rapidata/api_client/models/create_job_definition_endpoint_output.py +89 -0
  135. rapidata/api_client/models/create_job_endpoint_input.py +100 -0
  136. rapidata/api_client/models/create_job_endpoint_output.py +89 -0
  137. rapidata/api_client/models/create_job_revision_endpoint_input.py +127 -0
  138. rapidata/api_client/models/create_job_revision_endpoint_output.py +89 -0
  139. rapidata/api_client/models/create_leaderboard_model.py +147 -0
  140. rapidata/api_client/models/create_leaderboard_participant_model.py +87 -0
  141. rapidata/api_client/models/create_leaderboard_participant_result.py +89 -0
  142. rapidata/api_client/models/create_leaderboard_result.py +99 -0
  143. rapidata/api_client/models/create_order_definition_model.py +119 -0
  144. rapidata/api_client/models/create_order_definition_result.py +87 -0
  145. rapidata/api_client/models/create_order_definition_revision_model.py +117 -0
  146. rapidata/api_client/models/create_order_definition_revision_result.py +87 -0
  147. rapidata/api_client/models/create_order_model.py +30 -103
  148. rapidata/api_client/models/create_order_model_referee.py +12 -12
  149. rapidata/api_client/models/create_order_model_workflow.py +35 -21
  150. rapidata/api_client/models/create_order_result.py +6 -4
  151. rapidata/api_client/models/create_rapid_result.py +2 -2
  152. rapidata/api_client/models/create_sample_model.py +93 -0
  153. rapidata/api_client/models/create_sample_model_asset.py +154 -0
  154. rapidata/api_client/models/create_sample_model_obsolete.py +87 -0
  155. rapidata/api_client/models/create_simple_pipeline_model_pipeline_steps_inner.py +8 -22
  156. rapidata/api_client/models/create_unsupported_order_model.py +6 -6
  157. rapidata/api_client/models/create_validation_set_model.py +5 -5
  158. rapidata/api_client/models/datapoint_metadata_model.py +3 -3
  159. rapidata/api_client/models/datapoint_model.py +3 -3
  160. rapidata/api_client/models/datapoint_model_paged_result.py +105 -0
  161. rapidata/api_client/models/datapoint_state.py +2 -2
  162. rapidata/api_client/models/dataset_dataset_id_datapoints_post_request_metadata_inner.py +182 -0
  163. rapidata/api_client/models/definition_type.py +49 -0
  164. rapidata/api_client/models/demographic_filter.py +100 -0
  165. rapidata/api_client/models/dynamic_client_registration_request.py +160 -0
  166. rapidata/api_client/models/early_stopping_referee_model.py +3 -3
  167. rapidata/api_client/models/effort_capped_selection.py +106 -0
  168. rapidata/api_client/models/elo_config.py +2 -2
  169. rapidata/api_client/models/elo_config_model.py +6 -6
  170. rapidata/api_client/models/entity_tag_header_value.py +93 -0
  171. rapidata/api_client/models/evaluation_workflow_config.py +13 -3
  172. rapidata/api_client/models/evaluation_workflow_model.py +16 -6
  173. rapidata/api_client/models/existing_asset_input.py +109 -0
  174. rapidata/api_client/models/existing_asset_input_metadata_value.py +126 -0
  175. rapidata/api_client/models/feature_flag.py +2 -2
  176. rapidata/api_client/models/feature_flag_model.py +6 -6
  177. rapidata/api_client/models/feedback_model.py +7 -7
  178. rapidata/api_client/models/file_asset.py +15 -12
  179. rapidata/api_client/models/file_asset_input.py +104 -0
  180. rapidata/api_client/models/file_asset_input1.py +104 -0
  181. rapidata/api_client/models/file_asset_input1_file.py +168 -0
  182. rapidata/api_client/models/file_asset_input2.py +104 -0
  183. rapidata/api_client/models/file_asset_input3.py +104 -0
  184. rapidata/api_client/models/file_asset_input_file.py +168 -0
  185. rapidata/api_client/models/file_asset_metadata_value.py +252 -0
  186. rapidata/api_client/models/file_asset_model_metadata_value.py +37 -51
  187. rapidata/api_client/models/file_stream_result.py +122 -0
  188. rapidata/api_client/models/file_type.py +39 -0
  189. rapidata/api_client/models/file_type_metadata.py +110 -0
  190. rapidata/api_client/models/file_type_metadata_model.py +97 -0
  191. rapidata/api_client/models/filter.py +7 -25
  192. rapidata/api_client/models/filter_operator.py +3 -2
  193. rapidata/api_client/models/fork_benchmark_result.py +87 -0
  194. rapidata/api_client/models/form_file_wrapper.py +135 -0
  195. rapidata/api_client/models/free_text_payload.py +10 -3
  196. rapidata/api_client/models/free_text_rapid_blueprint.py +10 -3
  197. rapidata/api_client/models/gender_user_filter_model.py +2 -2
  198. rapidata/api_client/models/gender_user_filter_model_gender.py +38 -0
  199. rapidata/api_client/models/get_asset_metadata_result.py +100 -0
  200. rapidata/api_client/models/get_audience_by_id_result.py +118 -0
  201. rapidata/api_client/models/get_audience_user_state_metrics_result.py +87 -0
  202. rapidata/api_client/models/get_available_validation_sets_result.py +2 -2
  203. rapidata/api_client/models/get_benchmark_by_id_query.py +96 -0
  204. rapidata/api_client/models/get_benchmark_by_id_query_result.py +94 -0
  205. rapidata/api_client/models/get_benchmark_by_id_query_result_paged_result.py +105 -0
  206. rapidata/api_client/models/get_benchmark_by_id_result.py +98 -0
  207. rapidata/api_client/models/get_boost_result.py +97 -0
  208. rapidata/api_client/models/get_boost_result_boost_mode.py +37 -0
  209. rapidata/api_client/models/get_boost_result_boost_status.py +39 -0
  210. rapidata/api_client/models/get_compare_ab_summary_result.py +5 -5
  211. rapidata/api_client/models/get_compare_workflow_results_model.py +7 -7
  212. rapidata/api_client/models/get_compare_workflow_results_result.py +5 -5
  213. rapidata/api_client/models/get_datapoint_by_id_result.py +10 -21
  214. rapidata/api_client/models/get_datapoint_by_id_result_asset.py +170 -0
  215. rapidata/api_client/models/get_dataset_by_id_result.py +2 -2
  216. rapidata/api_client/models/get_dataset_progress_result.py +2 -2
  217. rapidata/api_client/models/get_evaluation_workflow_results_model.py +119 -0
  218. rapidata/api_client/models/get_failed_datapoints_result.py +5 -5
  219. rapidata/api_client/models/get_failed_datapoints_result_datapoint.py +100 -0
  220. rapidata/api_client/models/get_file_metadata_result.py +100 -0
  221. rapidata/api_client/models/get_grouped_ranking_workflow_results_model.py +106 -0
  222. rapidata/api_client/models/get_grouped_ranking_workflow_results_result.py +97 -0
  223. rapidata/api_client/models/get_grouped_ranking_workflow_results_result_paged_result.py +105 -0
  224. rapidata/api_client/models/get_job_by_id_endpoint_output.py +130 -0
  225. rapidata/api_client/models/get_job_definition_by_id_endpoint_output.py +95 -0
  226. rapidata/api_client/models/get_job_revision_endpoint_output.py +133 -0
  227. rapidata/api_client/models/get_leaderboard_by_id_result.py +135 -0
  228. rapidata/api_client/models/get_order_by_id_result.py +12 -5
  229. rapidata/api_client/models/get_participant_by_id_result.py +91 -0
  230. rapidata/api_client/models/get_pipeline_by_id_result.py +5 -5
  231. rapidata/api_client/models/get_public_orders_result.py +2 -2
  232. rapidata/api_client/models/get_public_responses_result.py +95 -0
  233. rapidata/api_client/models/get_public_responses_result_response.py +112 -0
  234. rapidata/api_client/models/get_rapid_responses_result.py +6 -12
  235. rapidata/api_client/models/get_recommended_validation_set_result.py +95 -0
  236. rapidata/api_client/models/get_responses_for_rapid_result.py +106 -0
  237. rapidata/api_client/models/get_responses_for_rapid_result_response.py +103 -0
  238. rapidata/api_client/models/get_responses_for_rapid_result_response_result.py +266 -0
  239. rapidata/api_client/models/get_responses_result.py +5 -5
  240. rapidata/api_client/models/get_responses_result_response.py +103 -0
  241. rapidata/api_client/models/get_sample_by_id_result.py +125 -0
  242. rapidata/api_client/models/get_simple_workflow_results_model.py +20 -15
  243. rapidata/api_client/models/get_standing_by_id_result.py +96 -0
  244. rapidata/api_client/models/get_validation_rapids_result.py +33 -33
  245. rapidata/api_client/models/get_validation_rapids_result_truth.py +25 -11
  246. rapidata/api_client/models/get_validation_set_by_id_result.py +10 -4
  247. rapidata/api_client/models/get_workflow_by_id_result.py +5 -5
  248. rapidata/api_client/models/get_workflow_by_id_result_workflow.py +23 -9
  249. rapidata/api_client/models/get_workflow_progress_result.py +5 -11
  250. rapidata/api_client/models/get_workflow_results_result.py +34 -23
  251. rapidata/api_client/models/get_workflow_results_result_response.py +103 -0
  252. rapidata/api_client/models/google_one_tap_login_model.py +4 -4
  253. rapidata/api_client/models/grouped_ranking_workflow_config.py +155 -0
  254. rapidata/api_client/models/grouped_ranking_workflow_config_context_assets_value.py +170 -0
  255. rapidata/api_client/models/grouped_ranking_workflow_model.py +147 -0
  256. rapidata/api_client/models/grouped_ranking_workflow_model1.py +121 -0
  257. rapidata/api_client/models/i_artifact_model.py +182 -0
  258. rapidata/api_client/models/i_artifact_model_campaign_artifact_model.py +98 -0
  259. rapidata/api_client/models/i_artifact_model_dataset_artifact_model.py +98 -0
  260. rapidata/api_client/models/i_artifact_model_file_artifact_model.py +98 -0
  261. rapidata/api_client/models/i_artifact_model_workflow_artifact_model.py +98 -0
  262. rapidata/api_client/models/i_artifact_model_workflow_config_artifact_model.py +102 -0
  263. rapidata/api_client/models/i_asset.py +170 -0
  264. rapidata/api_client/models/i_asset_file_asset.py +111 -0
  265. rapidata/api_client/models/i_asset_input.py +156 -0
  266. rapidata/api_client/models/i_asset_input_existing_asset_input.py +118 -0
  267. rapidata/api_client/models/i_asset_input_multi_asset_input.py +128 -0
  268. rapidata/api_client/models/i_asset_input_text_asset_input.py +118 -0
  269. rapidata/api_client/models/i_asset_model.py +170 -0
  270. rapidata/api_client/models/i_asset_model_file_asset_model.py +113 -0
  271. rapidata/api_client/models/i_asset_model_multi_asset_model.py +123 -0
  272. rapidata/api_client/models/i_asset_model_null_asset_model.py +111 -0
  273. rapidata/api_client/models/i_asset_model_text_asset_model.py +113 -0
  274. rapidata/api_client/models/i_asset_multi_asset.py +121 -0
  275. rapidata/api_client/models/i_asset_null_asset.py +109 -0
  276. rapidata/api_client/models/i_asset_text_asset.py +111 -0
  277. rapidata/api_client/models/i_audience_filter.py +184 -0
  278. rapidata/api_client/models/i_audience_filter_and_audience_filter.py +106 -0
  279. rapidata/api_client/models/i_audience_filter_country_audience_filter.py +96 -0
  280. rapidata/api_client/models/i_audience_filter_country_filter.py +96 -0
  281. rapidata/api_client/models/i_audience_filter_language_audience_filter.py +96 -0
  282. rapidata/api_client/models/i_audience_filter_language_filter.py +96 -0
  283. rapidata/api_client/models/i_audience_filter_not_audience_filter.py +102 -0
  284. rapidata/api_client/models/i_audience_filter_or_audience_filter.py +106 -0
  285. rapidata/api_client/models/i_campaign_filter.py +296 -0
  286. rapidata/api_client/models/i_campaign_filter_and_filter.py +117 -0
  287. rapidata/api_client/models/i_campaign_filter_campaign_filter.py +98 -0
  288. rapidata/api_client/models/i_campaign_filter_campaign_session_count_filter.py +101 -0
  289. rapidata/api_client/models/i_campaign_filter_country_filter.py +98 -0
  290. rapidata/api_client/models/i_campaign_filter_demographic_filter.py +100 -0
  291. rapidata/api_client/models/i_campaign_filter_device_filter.py +106 -0
  292. rapidata/api_client/models/i_campaign_filter_language_filter.py +98 -0
  293. rapidata/api_client/models/i_campaign_filter_new_user_filter.py +96 -0
  294. rapidata/api_client/models/i_campaign_filter_not_filter.py +113 -0
  295. rapidata/api_client/models/i_campaign_filter_or_filter.py +117 -0
  296. rapidata/api_client/models/i_campaign_filter_response_count_filter.py +103 -0
  297. rapidata/api_client/models/i_campaign_filter_user_action_restriction_filter.py +106 -0
  298. rapidata/api_client/models/i_campaign_filter_user_score_filter.py +102 -0
  299. rapidata/api_client/models/i_campaign_filter_user_state_filter.py +106 -0
  300. rapidata/api_client/models/i_dataset_metadata_input.py +154 -0
  301. rapidata/api_client/models/i_dataset_metadata_input_prompt_asset_metadata_input.py +100 -0
  302. rapidata/api_client/models/i_dataset_metadata_input_prompt_metadata_input.py +96 -0
  303. rapidata/api_client/models/i_dataset_metadata_input_transcription_metadata_input.py +96 -0
  304. rapidata/api_client/models/i_dataset_model.py +126 -0
  305. rapidata/api_client/models/i_dataset_model_clone_dataset_model.py +98 -0
  306. rapidata/api_client/models/i_metadata.py +252 -0
  307. rapidata/api_client/models/i_metadata_classification_metadata.py +109 -0
  308. rapidata/api_client/models/i_metadata_count_metadata.py +109 -0
  309. rapidata/api_client/models/i_metadata_duration_metadata.py +110 -0
  310. rapidata/api_client/models/i_metadata_file_type_metadata.py +110 -0
  311. rapidata/api_client/models/i_metadata_image_dimension_metadata.py +111 -0
  312. rapidata/api_client/models/i_metadata_input.py +126 -0
  313. rapidata/api_client/models/i_metadata_input_text_metadata_input.py +111 -0
  314. rapidata/api_client/models/i_metadata_location_metadata.py +111 -0
  315. rapidata/api_client/models/i_metadata_model.py +252 -0
  316. rapidata/api_client/models/i_metadata_model_classification_metadata_model.py +96 -0
  317. rapidata/api_client/models/i_metadata_model_count_metadata_model.py +96 -0
  318. rapidata/api_client/models/i_metadata_model_file_type_metadata_model.py +97 -0
  319. rapidata/api_client/models/i_metadata_model_image_dimension_metadata_model.py +98 -0
  320. rapidata/api_client/models/i_metadata_model_location_metadata_model.py +98 -0
  321. rapidata/api_client/models/i_metadata_model_original_filename_metadata_model.py +96 -0
  322. rapidata/api_client/models/i_metadata_model_source_url_metadata_model.py +96 -0
  323. rapidata/api_client/models/i_metadata_model_streams_metadata_model.py +100 -0
  324. rapidata/api_client/models/i_metadata_model_text_metadata_model.py +101 -0
  325. rapidata/api_client/models/i_metadata_model_video_duration_metadata_model.py +97 -0
  326. rapidata/api_client/models/i_metadata_original_filename_metadata.py +109 -0
  327. rapidata/api_client/models/i_metadata_source_url_metadata.py +109 -0
  328. rapidata/api_client/models/i_metadata_streams_metadata.py +113 -0
  329. rapidata/api_client/models/i_metadata_text_metadata.py +114 -0
  330. rapidata/api_client/models/i_metadata_video_duration_metadata.py +110 -0
  331. rapidata/api_client/models/i_order_workflow_model.py +168 -0
  332. rapidata/api_client/models/i_order_workflow_model_compare_workflow_model.py +146 -0
  333. rapidata/api_client/models/i_order_workflow_model_evaluation_workflow_model.py +108 -0
  334. rapidata/api_client/models/i_order_workflow_model_grouped_ranking_workflow_model.py +147 -0
  335. rapidata/api_client/models/i_order_workflow_model_simple_workflow_model.py +110 -0
  336. rapidata/api_client/models/i_pair_maker_config.py +126 -0
  337. rapidata/api_client/models/i_pair_maker_config_model.py +126 -0
  338. rapidata/api_client/models/i_pair_maker_config_model_online_pair_maker_config_model.py +98 -0
  339. rapidata/api_client/models/i_pair_maker_config_online_pair_maker_config.py +98 -0
  340. rapidata/api_client/models/i_pair_maker_information.py +126 -0
  341. rapidata/api_client/models/i_pair_maker_information_online_pair_maker_information.py +100 -0
  342. rapidata/api_client/models/i_pipeline_artifact_model.py +126 -0
  343. rapidata/api_client/models/i_pipeline_artifact_model_create_dataset_artifact_model.py +102 -0
  344. rapidata/api_client/models/i_pipeline_model.py +126 -0
  345. rapidata/api_client/models/i_pipeline_model_create_simple_pipeline_model.py +116 -0
  346. rapidata/api_client/models/i_pipeline_step_model.py +168 -0
  347. rapidata/api_client/models/i_pipeline_step_model_dataset_evaluation_step_model.py +102 -0
  348. rapidata/api_client/models/i_pipeline_step_model_send_completion_mail_step_model.py +98 -0
  349. rapidata/api_client/models/i_pipeline_step_model_workflow_aggregation_step_model.py +103 -0
  350. rapidata/api_client/models/i_pipeline_step_model_workflow_labeling_step_model.py +96 -0
  351. rapidata/api_client/models/i_rapid_blueprint.py +252 -0
  352. rapidata/api_client/models/i_rapid_blueprint_attach_category_rapid_blueprint.py +108 -0
  353. rapidata/api_client/models/i_rapid_blueprint_bounding_box_rapid_blueprint.py +96 -0
  354. rapidata/api_client/models/i_rapid_blueprint_compare_rapid_blueprint.py +98 -0
  355. rapidata/api_client/models/i_rapid_blueprint_free_text_rapid_blueprint.py +105 -0
  356. rapidata/api_client/models/i_rapid_blueprint_line_rapid_blueprint.py +96 -0
  357. rapidata/api_client/models/i_rapid_blueprint_locate_rapid_blueprint.py +96 -0
  358. rapidata/api_client/models/i_rapid_blueprint_named_entity_rapid_blueprint.py +98 -0
  359. rapidata/api_client/models/i_rapid_blueprint_polygon_rapid_blueprint.py +96 -0
  360. rapidata/api_client/models/i_rapid_blueprint_scrub_rapid_blueprint.py +96 -0
  361. rapidata/api_client/models/i_rapid_blueprint_transcription_rapid_blueprint.py +96 -0
  362. rapidata/api_client/models/i_rapid_payload.py +252 -0
  363. rapidata/api_client/models/i_rapid_payload_bounding_box_payload.py +96 -0
  364. rapidata/api_client/models/i_rapid_payload_classify_payload.py +106 -0
  365. rapidata/api_client/models/i_rapid_payload_compare_payload.py +96 -0
  366. rapidata/api_client/models/i_rapid_payload_free_text_payload.py +105 -0
  367. rapidata/api_client/models/i_rapid_payload_line_payload.py +96 -0
  368. rapidata/api_client/models/i_rapid_payload_locate_payload.py +96 -0
  369. rapidata/api_client/models/i_rapid_payload_named_entity_payload.py +98 -0
  370. rapidata/api_client/models/i_rapid_payload_polygon_payload.py +96 -0
  371. rapidata/api_client/models/i_rapid_payload_scrub_payload.py +96 -0
  372. rapidata/api_client/models/i_rapid_payload_transcription_payload.py +106 -0
  373. rapidata/api_client/models/i_rapid_result.py +266 -0
  374. rapidata/api_client/models/i_rapid_result_attach_category_result.py +98 -0
  375. rapidata/api_client/models/i_rapid_result_bounding_box_result.py +106 -0
  376. rapidata/api_client/models/i_rapid_result_compare_result.py +98 -0
  377. rapidata/api_client/models/i_rapid_result_free_text_result.py +98 -0
  378. rapidata/api_client/models/i_rapid_result_line_result.py +106 -0
  379. rapidata/api_client/models/i_rapid_result_locate_result.py +106 -0
  380. rapidata/api_client/models/i_rapid_result_named_entity_result.py +106 -0
  381. rapidata/api_client/models/i_rapid_result_polygon_result.py +106 -0
  382. rapidata/api_client/models/i_rapid_result_scrub_result.py +98 -0
  383. rapidata/api_client/models/i_rapid_result_skip_result.py +96 -0
  384. rapidata/api_client/models/i_rapid_result_transcription_result.py +106 -0
  385. rapidata/api_client/models/i_referee_config.py +154 -0
  386. rapidata/api_client/models/i_referee_config_naive_referee_config.py +96 -0
  387. rapidata/api_client/models/i_referee_config_never_ending_referee_config.py +94 -0
  388. rapidata/api_client/models/i_referee_config_probabilistic_attach_category_referee_config.py +98 -0
  389. rapidata/api_client/models/i_referee_info.py +154 -0
  390. rapidata/api_client/models/i_referee_info_naive_referee_info.py +96 -0
  391. rapidata/api_client/models/i_referee_info_never_ending_referee_info.py +94 -0
  392. rapidata/api_client/models/i_referee_info_probabilistic_attach_category_referee_info.py +98 -0
  393. rapidata/api_client/models/i_referee_model.py +140 -0
  394. rapidata/api_client/models/i_referee_model_early_stopping_referee_model.py +98 -0
  395. rapidata/api_client/models/i_referee_model_naive_referee_model.py +96 -0
  396. rapidata/api_client/models/i_selection.py +240 -0
  397. rapidata/api_client/models/i_selection_ab_test_selection.py +122 -0
  398. rapidata/api_client/models/i_selection_capped_selection.py +108 -0
  399. rapidata/api_client/models/i_selection_conditional_validation_selection.py +110 -0
  400. rapidata/api_client/models/i_selection_demographic_selection.py +98 -0
  401. rapidata/api_client/models/i_selection_effort_capped_selection.py +101 -0
  402. rapidata/api_client/models/i_selection_labeling_selection.py +103 -0
  403. rapidata/api_client/models/i_selection_shuffling_selection.py +106 -0
  404. rapidata/api_client/models/i_selection_static_selection.py +96 -0
  405. rapidata/api_client/models/i_selection_validation_selection.py +98 -0
  406. rapidata/api_client/models/i_user_filter_model.py +296 -0
  407. rapidata/api_client/models/i_user_filter_model_age_user_filter_model.py +104 -0
  408. rapidata/api_client/models/i_user_filter_model_and_user_filter_model.py +106 -0
  409. rapidata/api_client/models/i_user_filter_model_campaign_user_filter_model.py +96 -0
  410. rapidata/api_client/models/i_user_filter_model_country_user_filter_model.py +96 -0
  411. rapidata/api_client/models/i_user_filter_model_custom_user_filter_model.py +98 -0
  412. rapidata/api_client/models/i_user_filter_model_device_user_filter_model.py +104 -0
  413. rapidata/api_client/models/i_user_filter_model_gender_user_filter_model.py +104 -0
  414. rapidata/api_client/models/i_user_filter_model_language_user_filter_model.py +96 -0
  415. rapidata/api_client/models/i_user_filter_model_new_user_filter_model.py +94 -0
  416. rapidata/api_client/models/i_user_filter_model_not_user_filter_model.py +102 -0
  417. rapidata/api_client/models/i_user_filter_model_or_user_filter_model.py +106 -0
  418. rapidata/api_client/models/i_user_filter_model_response_count_user_filter_model.py +101 -0
  419. rapidata/api_client/models/i_user_filter_model_user_score_user_filter_model.py +105 -0
  420. rapidata/api_client/models/i_validation_metadata_input.py +140 -0
  421. rapidata/api_client/models/i_validation_metadata_input_prompt_asset_metadata_input.py +100 -0
  422. rapidata/api_client/models/i_validation_metadata_input_prompt_metadata_input.py +96 -0
  423. rapidata/api_client/models/i_validation_truth.py +280 -0
  424. rapidata/api_client/models/i_validation_truth_attach_category_truth.py +96 -0
  425. rapidata/api_client/models/i_validation_truth_bounding_box_truth.py +102 -0
  426. rapidata/api_client/models/i_validation_truth_compare_truth.py +96 -0
  427. rapidata/api_client/models/i_validation_truth_empty_validation_truth.py +94 -0
  428. rapidata/api_client/models/i_validation_truth_line_truth.py +94 -0
  429. rapidata/api_client/models/i_validation_truth_locate_box_truth.py +108 -0
  430. rapidata/api_client/models/i_validation_truth_model.py +294 -0
  431. rapidata/api_client/models/i_validation_truth_model_attach_category_truth_model.py +96 -0
  432. rapidata/api_client/models/i_validation_truth_model_bounding_box_truth_model.py +102 -0
  433. rapidata/api_client/models/i_validation_truth_model_classify_truth_model.py +96 -0
  434. rapidata/api_client/models/i_validation_truth_model_compare_truth_model.py +96 -0
  435. rapidata/api_client/models/i_validation_truth_model_empty_validation_truth_model.py +94 -0
  436. rapidata/api_client/models/i_validation_truth_model_line_truth_model.py +94 -0
  437. rapidata/api_client/models/i_validation_truth_model_locate_box_truth_model.py +108 -0
  438. rapidata/api_client/models/i_validation_truth_model_multi_compare_truth_model.py +96 -0
  439. rapidata/api_client/models/i_validation_truth_model_named_entity_truth_model.py +104 -0
  440. rapidata/api_client/models/i_validation_truth_model_polygon_truth_model.py +94 -0
  441. rapidata/api_client/models/i_validation_truth_model_scrub_truth_model.py +104 -0
  442. rapidata/api_client/models/i_validation_truth_model_skip_truth_model.py +94 -0
  443. rapidata/api_client/models/i_validation_truth_model_transcription_truth_model.py +115 -0
  444. rapidata/api_client/models/i_validation_truth_multi_compare_truth.py +96 -0
  445. rapidata/api_client/models/i_validation_truth_named_entity_truth.py +104 -0
  446. rapidata/api_client/models/i_validation_truth_polygon_truth.py +94 -0
  447. rapidata/api_client/models/i_validation_truth_scrub_truth.py +104 -0
  448. rapidata/api_client/models/i_validation_truth_skip_truth.py +94 -0
  449. rapidata/api_client/models/i_validation_truth_transcription_truth.py +115 -0
  450. rapidata/api_client/models/i_workflow_config.py +168 -0
  451. rapidata/api_client/models/i_workflow_config_compare_workflow_config.py +142 -0
  452. rapidata/api_client/models/i_workflow_config_evaluation_workflow_config.py +114 -0
  453. rapidata/api_client/models/i_workflow_config_grouped_ranking_workflow_config.py +155 -0
  454. rapidata/api_client/models/i_workflow_config_simple_workflow_config.py +116 -0
  455. rapidata/api_client/models/i_workflow_model.py +168 -0
  456. rapidata/api_client/models/i_workflow_model_compare_workflow_model.py +145 -0
  457. rapidata/api_client/models/i_workflow_model_evaluation_workflow_model.py +115 -0
  458. rapidata/api_client/models/i_workflow_model_grouped_ranking_workflow_model.py +121 -0
  459. rapidata/api_client/models/i_workflow_model_simple_workflow_model.py +119 -0
  460. rapidata/api_client/models/image_dimension_metadata.py +12 -1
  461. rapidata/api_client/models/inquire_file_metadata_result.py +100 -0
  462. rapidata/api_client/models/inspect_report_result.py +2 -2
  463. rapidata/api_client/models/job_definition_revision_state.py +38 -0
  464. rapidata/api_client/models/json_web_key.py +224 -0
  465. rapidata/api_client/models/json_web_key_set.py +95 -0
  466. rapidata/api_client/models/labeling_selection.py +11 -13
  467. rapidata/api_client/models/language_filter.py +98 -0
  468. rapidata/api_client/models/leaderboard_query_result.py +135 -0
  469. rapidata/api_client/models/leaderboard_query_result_paged_result.py +105 -0
  470. rapidata/api_client/models/leaderboards_query_result.py +135 -0
  471. rapidata/api_client/models/line_result.py +3 -3
  472. rapidata/api_client/models/line_result_line.py +97 -0
  473. rapidata/api_client/models/line_result_line_point.py +89 -0
  474. rapidata/api_client/models/local_file_wrapper.py +120 -0
  475. rapidata/api_client/models/locate_coordinate.py +4 -13
  476. rapidata/api_client/models/location_metadata.py +12 -1
  477. rapidata/api_client/models/logic_operator.py +2 -2
  478. rapidata/api_client/models/metadata_i_order_metadata_input.py +154 -0
  479. rapidata/api_client/models/metadata_i_order_metadata_input_metadata_prompt_asset_metadata_input.py +100 -0
  480. rapidata/api_client/models/metadata_i_order_metadata_input_metadata_prompt_metadata_input.py +96 -0
  481. rapidata/api_client/models/metadata_i_order_metadata_input_metadata_transcription_metadata_input.py +96 -0
  482. rapidata/api_client/models/metadata_prompt_asset_metadata_input.py +100 -0
  483. rapidata/api_client/models/metadata_prompt_metadata_input.py +96 -0
  484. rapidata/api_client/models/metadata_transcription_metadata_input.py +96 -0
  485. rapidata/api_client/models/multi_asset.py +17 -12
  486. rapidata/api_client/models/multi_asset_assets_inner.py +170 -0
  487. rapidata/api_client/models/multi_asset_input.py +130 -0
  488. rapidata/api_client/models/multi_asset_input1.py +110 -0
  489. rapidata/api_client/models/multi_asset_input1_assets_inner.py +198 -0
  490. rapidata/api_client/models/multi_asset_input2.py +110 -0
  491. rapidata/api_client/models/multi_asset_input3.py +110 -0
  492. rapidata/api_client/models/multi_asset_input3_assets_inner.py +198 -0
  493. rapidata/api_client/models/multi_asset_input_assets_inner.py +156 -0
  494. rapidata/api_client/models/multi_asset_model.py +3 -3
  495. rapidata/api_client/models/multi_compare_truth.py +96 -0
  496. rapidata/api_client/models/naive_referee_info.py +96 -0
  497. rapidata/api_client/models/naive_referee_model.py +2 -2
  498. rapidata/api_client/models/named_classification.py +4 -13
  499. rapidata/api_client/models/never_ending_referee_info.py +94 -0
  500. rapidata/api_client/models/new_user_filter.py +96 -0
  501. rapidata/api_client/models/newsletter_model.py +6 -6
  502. rapidata/api_client/models/not_available_yet_result.py +4 -13
  503. rapidata/api_client/models/not_filter.py +117 -0
  504. rapidata/api_client/models/not_user_filter_model.py +3 -3
  505. rapidata/api_client/models/null_asset.py +14 -9
  506. rapidata/api_client/models/online_pair_maker_config_model.py +3 -3
  507. rapidata/api_client/models/option_of_aggregator_type.py +49 -0
  508. rapidata/api_client/models/or_filter.py +121 -0
  509. rapidata/api_client/models/or_user_filter_model.py +3 -3
  510. rapidata/api_client/models/order_model.py +15 -14
  511. rapidata/api_client/models/order_state.py +2 -2
  512. rapidata/api_client/models/original_filename_metadata.py +12 -1
  513. rapidata/api_client/models/page_info.py +2 -7
  514. rapidata/api_client/models/paged_result_aggregated_orders_model.py +105 -0
  515. rapidata/api_client/models/paged_result_benchmark_query_result.py +105 -0
  516. rapidata/api_client/models/paged_result_campaign_query_result.py +105 -0
  517. rapidata/api_client/models/paged_result_clients_query_result.py +105 -0
  518. rapidata/api_client/models/paged_result_datapoint_model.py +105 -0
  519. rapidata/api_client/models/paged_result_get_compare_workflow_results_result.py +105 -0
  520. rapidata/api_client/models/paged_result_get_grouped_ranking_workflow_results_result.py +105 -0
  521. rapidata/api_client/models/paged_result_get_validation_rapids_result.py +105 -0
  522. rapidata/api_client/models/paged_result_get_workflow_results_result.py +105 -0
  523. rapidata/api_client/models/paged_result_i_workflow_model.py +105 -0
  524. rapidata/api_client/models/paged_result_leaderboard_query_result.py +105 -0
  525. rapidata/api_client/models/paged_result_leaderboards_query_result.py +105 -0
  526. rapidata/api_client/models/paged_result_of_aggregated_orders_model.py +103 -0
  527. rapidata/api_client/models/paged_result_of_benchmark_query_result.py +103 -0
  528. rapidata/api_client/models/paged_result_of_campaign_query_result.py +103 -0
  529. rapidata/api_client/models/paged_result_of_clients_query_result.py +103 -0
  530. rapidata/api_client/models/paged_result_of_get_compare_workflow_results_result.py +103 -0
  531. rapidata/api_client/models/paged_result_of_get_grouped_ranking_workflow_results_result.py +103 -0
  532. rapidata/api_client/models/paged_result_of_get_validation_rapids_result.py +103 -0
  533. rapidata/api_client/models/paged_result_of_get_workflow_results_result.py +103 -0
  534. rapidata/api_client/models/paged_result_of_i_workflow_model.py +103 -0
  535. rapidata/api_client/models/paged_result_of_leaderboards_query_result.py +103 -0
  536. rapidata/api_client/models/paged_result_of_order_model.py +103 -0
  537. rapidata/api_client/models/paged_result_of_participant_by_benchmark.py +103 -0
  538. rapidata/api_client/models/paged_result_of_prompt_by_benchmark_result.py +103 -0
  539. rapidata/api_client/models/paged_result_of_query_audiences_result.py +103 -0
  540. rapidata/api_client/models/paged_result_of_query_datapoints_by_dataset_id_result.py +103 -0
  541. rapidata/api_client/models/paged_result_of_query_job_definitions_result.py +103 -0
  542. rapidata/api_client/models/paged_result_of_query_job_revisions_result.py +103 -0
  543. rapidata/api_client/models/paged_result_of_query_jobs_result.py +103 -0
  544. rapidata/api_client/models/paged_result_of_query_rapids_for_audience_result.py +103 -0
  545. rapidata/api_client/models/paged_result_of_query_validation_rapid_eligibility_result.py +103 -0
  546. rapidata/api_client/models/paged_result_of_rapid_model.py +103 -0
  547. rapidata/api_client/models/paged_result_of_runs_by_leaderboard_result.py +103 -0
  548. rapidata/api_client/models/paged_result_of_sample_by_identifier.py +103 -0
  549. rapidata/api_client/models/paged_result_of_sample_by_participant.py +103 -0
  550. rapidata/api_client/models/paged_result_of_standing_by_leaderboard.py +103 -0
  551. rapidata/api_client/models/paged_result_of_validation_set_model.py +103 -0
  552. rapidata/api_client/models/paged_result_order_model.py +105 -0
  553. rapidata/api_client/models/paged_result_participant_by_benchmark.py +105 -0
  554. rapidata/api_client/models/paged_result_potential_validation_rapid.py +105 -0
  555. rapidata/api_client/models/paged_result_prompt_by_benchmark_result.py +105 -0
  556. rapidata/api_client/models/paged_result_query_audiences_result.py +105 -0
  557. rapidata/api_client/models/paged_result_query_datapoints_by_dataset_id_result.py +105 -0
  558. rapidata/api_client/models/paged_result_query_validation_rapid_eligibility_result.py +105 -0
  559. rapidata/api_client/models/paged_result_rapid_model.py +105 -0
  560. rapidata/api_client/models/paged_result_runs_by_leaderboard_result.py +105 -0
  561. rapidata/api_client/models/paged_result_sample_by_identifier.py +105 -0
  562. rapidata/api_client/models/paged_result_sample_by_participant.py +105 -0
  563. rapidata/api_client/models/paged_result_standing_by_leaderboard.py +105 -0
  564. rapidata/api_client/models/paged_result_validation_set_model.py +105 -0
  565. rapidata/api_client/models/participant_by_benchmark.py +94 -0
  566. rapidata/api_client/models/participant_by_benchmark_paged_result.py +105 -0
  567. rapidata/api_client/models/participant_by_leaderboard.py +113 -0
  568. rapidata/api_client/models/participant_by_leaderboard_paged_result.py +105 -0
  569. rapidata/api_client/models/participant_status.py +38 -0
  570. rapidata/api_client/models/pipeline_id_workflow_config_put_request.py +140 -0
  571. rapidata/api_client/models/polygon_result.py +3 -3
  572. rapidata/api_client/models/polygon_result_coordinate.py +89 -0
  573. rapidata/api_client/models/polygon_result_shape.py +95 -0
  574. rapidata/api_client/models/potential_validation_rapid.py +103 -0
  575. rapidata/api_client/models/potential_validation_rapid_paged_result.py +105 -0
  576. rapidata/api_client/models/potential_validation_rapid_truth.py +280 -0
  577. rapidata/api_client/models/preliminary_download_model.py +5 -5
  578. rapidata/api_client/models/preview_order_model.py +92 -0
  579. rapidata/api_client/models/probabilistic_attach_category_referee_info.py +98 -0
  580. rapidata/api_client/models/problem_details.py +2 -20
  581. rapidata/api_client/models/prompt_asset_metadata_input.py +100 -0
  582. rapidata/api_client/models/prompt_asset_metadata_input_asset.py +154 -0
  583. rapidata/api_client/models/prompt_by_benchmark_result.py +112 -0
  584. rapidata/api_client/models/prompt_by_benchmark_result_paged_result.py +105 -0
  585. rapidata/api_client/models/prompt_by_leaderboard_result.py +90 -0
  586. rapidata/api_client/models/prompt_by_leaderboard_result_paged_result.py +105 -0
  587. rapidata/api_client/models/prompt_metadata.py +12 -1
  588. rapidata/api_client/models/prompt_metadata_input.py +2 -2
  589. rapidata/api_client/models/prompt_type.py +38 -0
  590. rapidata/api_client/models/proxy_file_wrapper.py +129 -0
  591. rapidata/api_client/models/public_order_model.py +2 -2
  592. rapidata/api_client/models/public_rapid_response.py +112 -0
  593. rapidata/api_client/models/query_audiences_result.py +118 -0
  594. rapidata/api_client/models/query_datapoints_by_dataset_id_result.py +95 -0
  595. rapidata/api_client/models/query_job_definitions_result.py +97 -0
  596. rapidata/api_client/models/query_job_revisions_result.py +95 -0
  597. rapidata/api_client/models/query_jobs_result.py +103 -0
  598. rapidata/api_client/models/query_model.py +10 -5
  599. rapidata/api_client/models/query_rapids_for_audience_result.py +150 -0
  600. rapidata/api_client/models/query_validation_model.py +97 -0
  601. rapidata/api_client/models/query_validation_rapid_eligibility_model_query_validation_model.py +107 -0
  602. rapidata/api_client/models/query_validation_rapid_eligibility_result.py +103 -0
  603. rapidata/api_client/models/query_validation_rapid_eligibility_result_truth.py +280 -0
  604. rapidata/api_client/models/rapid_issue.py +2 -2
  605. rapidata/api_client/models/rapid_modality.py +46 -0
  606. rapidata/api_client/models/rapid_model.py +157 -0
  607. rapidata/api_client/models/rapid_model_paged_result.py +105 -0
  608. rapidata/api_client/models/rapid_model_referee.py +154 -0
  609. rapidata/api_client/models/rapid_result_model.py +7 -7
  610. rapidata/api_client/models/rapid_skipped_model.py +5 -5
  611. rapidata/api_client/models/rapid_state.py +3 -2
  612. rapidata/api_client/models/read_bridge_token_keys_result.py +10 -24
  613. rapidata/api_client/models/reference_asset_input.py +100 -0
  614. rapidata/api_client/models/report_model.py +9 -15
  615. rapidata/api_client/models/response_count_filter.py +103 -0
  616. rapidata/api_client/models/response_count_user_filter_model.py +2 -8
  617. rapidata/api_client/models/retrieval_mode.py +2 -2
  618. rapidata/api_client/models/root_filter.py +5 -14
  619. rapidata/api_client/models/run_status.py +39 -0
  620. rapidata/api_client/models/runs_by_leaderboard_result.py +104 -0
  621. rapidata/api_client/models/runs_by_leaderboard_result_paged_result.py +105 -0
  622. rapidata/api_client/models/sample_by_identifier.py +125 -0
  623. rapidata/api_client/models/sample_by_identifier_paged_result.py +105 -0
  624. rapidata/api_client/models/sample_by_participant.py +121 -0
  625. rapidata/api_client/models/sample_by_participant_paged_result.py +105 -0
  626. rapidata/api_client/models/scrub_range.py +2 -2
  627. rapidata/api_client/models/send_survey_model.py +87 -0
  628. rapidata/api_client/models/simple_workflow_config.py +15 -7
  629. rapidata/api_client/models/simple_workflow_config_blueprint.py +37 -23
  630. rapidata/api_client/models/simple_workflow_config_model.py +11 -3
  631. rapidata/api_client/models/simple_workflow_model.py +14 -4
  632. rapidata/api_client/models/simple_workflow_model1.py +4 -11
  633. rapidata/api_client/models/simple_workflow_model_blueprint.py +1 -1
  634. rapidata/api_client/models/sort_criterion.py +5 -11
  635. rapidata/api_client/models/sort_direction.py +2 -2
  636. rapidata/api_client/models/source_url_metadata.py +12 -1
  637. rapidata/api_client/models/standing_by_benchmark.py +113 -0
  638. rapidata/api_client/models/standing_by_leaderboard.py +113 -0
  639. rapidata/api_client/models/standing_by_leaderboard_paged_result.py +105 -0
  640. rapidata/api_client/models/standing_status.py +38 -0
  641. rapidata/api_client/models/standings_by_benchmark_result.py +95 -0
  642. rapidata/api_client/models/standings_by_leaderboard_result.py +95 -0
  643. rapidata/api_client/models/start_preliminary_download_result.py +87 -0
  644. rapidata/api_client/models/sticky_state.py +3 -2
  645. rapidata/api_client/models/stream_file_wrapper.py +138 -0
  646. rapidata/api_client/models/streams_metadata.py +113 -0
  647. rapidata/api_client/models/streams_metadata_model.py +100 -0
  648. rapidata/api_client/models/string_segment.py +105 -0
  649. rapidata/api_client/models/submit_coco_model.py +1 -3
  650. rapidata/api_client/models/submit_order_model.py +92 -0
  651. rapidata/api_client/models/submit_participant_result.py +89 -0
  652. rapidata/api_client/models/submit_prompt_model.py +107 -0
  653. rapidata/api_client/models/submit_prompt_model_prompt_asset.py +202 -0
  654. rapidata/api_client/models/tags_by_benchmark_result.py +87 -0
  655. rapidata/api_client/models/text_asset.py +15 -10
  656. rapidata/api_client/models/text_asset_input.py +120 -0
  657. rapidata/api_client/models/text_metadata.py +18 -2
  658. rapidata/api_client/models/text_metadata_input.py +111 -0
  659. rapidata/api_client/models/text_metadata_model.py +7 -2
  660. rapidata/api_client/models/transcription_metadata.py +9 -1
  661. rapidata/api_client/models/transcription_metadata_input.py +2 -2
  662. rapidata/api_client/models/transcription_word.py +2 -2
  663. rapidata/api_client/models/translated_string.py +2 -2
  664. rapidata/api_client/models/unlock_order_result.py +2 -2
  665. rapidata/api_client/models/update_access_model.py +1 -1
  666. rapidata/api_client/models/update_audience_request.py +113 -0
  667. rapidata/api_client/models/update_benchmark_model.py +99 -0
  668. rapidata/api_client/models/update_benchmark_name_model.py +87 -0
  669. rapidata/api_client/models/update_campaign_model.py +11 -11
  670. rapidata/api_client/models/update_dataset_name_model.py +5 -5
  671. rapidata/api_client/models/update_dimensions_model.py +3 -3
  672. rapidata/api_client/models/update_job_definition_endpoint_input.py +92 -0
  673. rapidata/api_client/models/update_job_endpoint_input.py +92 -0
  674. rapidata/api_client/models/update_leaderboard_model.py +106 -0
  675. rapidata/api_client/models/update_leaderboard_name_model.py +87 -0
  676. rapidata/api_client/models/update_leaderboard_response_config_model.py +89 -0
  677. rapidata/api_client/models/update_order_name_model.py +5 -5
  678. rapidata/api_client/models/update_participant_model.py +92 -0
  679. rapidata/api_client/models/update_participant_name_model.py +87 -0
  680. rapidata/api_client/models/update_priority_model.py +87 -0
  681. rapidata/api_client/models/update_prompt_tags_model.py +87 -0
  682. rapidata/api_client/models/update_should_alert_model.py +87 -0
  683. rapidata/api_client/models/update_validation_rapid_model.py +28 -12
  684. rapidata/api_client/models/update_validation_rapid_model_context_asset.py +160 -0
  685. rapidata/api_client/models/update_validation_rapid_model_truth.py +26 -12
  686. rapidata/api_client/models/update_validation_set_model.py +120 -0
  687. rapidata/api_client/models/upload_asset_result.py +102 -0
  688. rapidata/api_client/models/upload_file_from_url_result.py +87 -0
  689. rapidata/api_client/models/upload_file_result.py +87 -0
  690. rapidata/api_client/models/upload_files_from_s3_bucket_model.py +12 -2
  691. rapidata/api_client/models/upload_text_sources_to_dataset_model.py +3 -3
  692. rapidata/api_client/models/url_asset_input.py +100 -0
  693. rapidata/api_client/models/user_action_restriction.py +37 -0
  694. rapidata/api_client/models/user_action_restriction_filter.py +101 -0
  695. rapidata/api_client/models/user_score_filter.py +102 -0
  696. rapidata/api_client/models/user_state.py +38 -0
  697. rapidata/api_client/models/user_state_filter.py +101 -0
  698. rapidata/api_client/models/validation_chance.py +20 -3
  699. rapidata/api_client/models/validation_problem_details.py +117 -0
  700. rapidata/api_client/models/validation_set_model.py +39 -5
  701. rapidata/api_client/models/validation_set_overview_model.py +2 -2
  702. rapidata/api_client/models/validation_set_validation_set_id_rapid_post_payload_parameter.py +252 -0
  703. rapidata/api_client/models/validation_set_validation_set_id_rapid_post_truth_parameter.py +280 -0
  704. rapidata/api_client/models/validation_set_zip_post_request_blueprint.py +252 -0
  705. rapidata/api_client/models/video_duration_metadata.py +109 -0
  706. rapidata/api_client/models/video_duration_metadata_model.py +96 -0
  707. rapidata/api_client/models/vote_matrix_result.py +91 -0
  708. rapidata/api_client/models/workflow_aggregation_step_model.py +3 -12
  709. rapidata/api_client/models/workflow_config_artifact_model_workflow_config.py +23 -9
  710. rapidata/api_client/models/workflow_state.py +2 -2
  711. rapidata/api_client/models/zip_entry_file_wrapper.py +151 -0
  712. rapidata/api_client/rest.py +2 -2
  713. rapidata/api_client_README.md +469 -309
  714. rapidata/rapidata_client/__init__.py +23 -22
  715. rapidata/rapidata_client/api/rapidata_api_client.py +253 -0
  716. rapidata/rapidata_client/audience/__init__.py +2 -0
  717. rapidata/rapidata_client/audience/audience_example_handler.py +168 -0
  718. rapidata/rapidata_client/audience/rapidata_audience.py +287 -0
  719. rapidata/rapidata_client/audience/rapidata_audience_manager.py +162 -0
  720. rapidata/rapidata_client/benchmark/__init__.py +0 -0
  721. rapidata/rapidata_client/benchmark/_detail_mapper.py +34 -0
  722. rapidata/rapidata_client/benchmark/leaderboard/__init__.py +0 -0
  723. rapidata/rapidata_client/benchmark/leaderboard/rapidata_leaderboard.py +257 -0
  724. rapidata/rapidata_client/benchmark/participant/__init__.py +0 -0
  725. rapidata/rapidata_client/benchmark/participant/_participant.py +146 -0
  726. rapidata/rapidata_client/benchmark/rapidata_benchmark.py +592 -0
  727. rapidata/rapidata_client/benchmark/rapidata_benchmark_manager.py +216 -0
  728. rapidata/rapidata_client/config/__init__.py +4 -0
  729. rapidata/rapidata_client/config/logger.py +135 -0
  730. rapidata/rapidata_client/config/logging_config.py +55 -0
  731. rapidata/rapidata_client/config/managed_print.py +6 -0
  732. rapidata/rapidata_client/config/order_config.py +14 -0
  733. rapidata/rapidata_client/config/rapidata_config.py +36 -0
  734. rapidata/rapidata_client/config/tracer.py +184 -0
  735. rapidata/rapidata_client/config/upload_config.py +64 -0
  736. rapidata/rapidata_client/datapoints/__init__.py +8 -0
  737. rapidata/rapidata_client/datapoints/_asset_uploader.py +194 -0
  738. rapidata/rapidata_client/datapoints/_datapoint.py +92 -0
  739. rapidata/rapidata_client/datapoints/_datapoint_uploader.py +47 -0
  740. rapidata/rapidata_client/datapoints/_datapoints_validator.py +70 -0
  741. rapidata/rapidata_client/datapoints/_single_flight_cache.py +82 -0
  742. rapidata/rapidata_client/datapoints/assets/__init__.py +0 -0
  743. rapidata/rapidata_client/datapoints/assets/constants.py +7 -0
  744. rapidata/rapidata_client/{metadata → datapoints/metadata}/__init__.py +1 -1
  745. rapidata/rapidata_client/datapoints/metadata/_private_text_metadata.py +16 -0
  746. rapidata/rapidata_client/datapoints/metadata/_prompt_identifier_metadata.py +14 -0
  747. rapidata/rapidata_client/datapoints/metadata/_public_text_metadata.py +16 -0
  748. rapidata/rapidata_client/{metadata → datapoints/metadata}/_select_words_metadata.py +4 -5
  749. rapidata/rapidata_client/dataset/__init__.py +1 -0
  750. rapidata/rapidata_client/dataset/_rapidata_dataset.py +55 -0
  751. rapidata/rapidata_client/demographic/demographic_manager.py +44 -19
  752. rapidata/rapidata_client/exceptions/__init__.py +1 -0
  753. rapidata/rapidata_client/exceptions/failed_upload_exception.py +27 -0
  754. rapidata/rapidata_client/filter/__init__.py +3 -0
  755. rapidata/rapidata_client/filter/_backend_filter_mapper.py +134 -0
  756. rapidata/rapidata_client/filter/_base_filter.py +58 -2
  757. rapidata/rapidata_client/filter/age_filter.py +26 -10
  758. rapidata/rapidata_client/filter/and_filter.py +55 -0
  759. rapidata/rapidata_client/filter/campaign_filter.py +21 -10
  760. rapidata/rapidata_client/filter/country_filter.py +46 -12
  761. rapidata/rapidata_client/filter/custom_filter.py +25 -12
  762. rapidata/rapidata_client/filter/device_filter.py +38 -0
  763. rapidata/rapidata_client/filter/gender_filter.py +25 -10
  764. rapidata/rapidata_client/filter/language_filter.py +51 -21
  765. rapidata/rapidata_client/filter/models/age_group.py +14 -12
  766. rapidata/rapidata_client/filter/models/device_type.py +20 -0
  767. rapidata/rapidata_client/filter/models/gender.py +12 -8
  768. rapidata/rapidata_client/filter/new_user_filter.py +14 -4
  769. rapidata/rapidata_client/filter/not_filter.py +35 -11
  770. rapidata/rapidata_client/filter/or_filter.py +36 -11
  771. rapidata/rapidata_client/filter/rapidata_filters.py +30 -25
  772. rapidata/rapidata_client/filter/response_count_filter.py +51 -20
  773. rapidata/rapidata_client/filter/user_score_filter.py +62 -24
  774. rapidata/rapidata_client/job/__init__.py +3 -0
  775. rapidata/rapidata_client/job/job_definition.py +110 -0
  776. rapidata/rapidata_client/job/job_manager.py +758 -0
  777. rapidata/rapidata_client/job/rapidata_job.py +326 -0
  778. rapidata/rapidata_client/order/__init__.py +2 -0
  779. rapidata/rapidata_client/order/_rapidata_order_builder.py +286 -193
  780. rapidata/rapidata_client/order/rapidata_order.py +329 -153
  781. rapidata/rapidata_client/order/rapidata_order_manager.py +722 -420
  782. rapidata/rapidata_client/rapidata_client.py +130 -26
  783. rapidata/rapidata_client/referee/__init__.py +1 -1
  784. rapidata/rapidata_client/referee/_base_referee.py +14 -3
  785. rapidata/rapidata_client/referee/_early_stopping_referee.py +32 -17
  786. rapidata/rapidata_client/referee/_naive_referee.py +24 -3
  787. rapidata/rapidata_client/results/__init__.py +3 -0
  788. rapidata/rapidata_client/{order → results}/rapidata_results.py +98 -67
  789. rapidata/rapidata_client/selection/__init__.py +2 -1
  790. rapidata/rapidata_client/selection/_base_selection.py +9 -2
  791. rapidata/rapidata_client/selection/ab_test_selection.py +28 -20
  792. rapidata/rapidata_client/selection/capped_selection.py +23 -16
  793. rapidata/rapidata_client/selection/conditional_validation_selection.py +43 -24
  794. rapidata/rapidata_client/selection/demographic_selection.py +21 -6
  795. rapidata/rapidata_client/selection/effort_selection.py +49 -0
  796. rapidata/rapidata_client/selection/labeling_selection.py +36 -12
  797. rapidata/rapidata_client/selection/{retrieval_modes.py → rapidata_retrieval_modes.py} +10 -7
  798. rapidata/rapidata_client/selection/rapidata_selections.py +31 -21
  799. rapidata/rapidata_client/selection/shuffling_selection.py +21 -13
  800. rapidata/rapidata_client/selection/static_selection.py +20 -9
  801. rapidata/rapidata_client/selection/validation_selection.py +20 -4
  802. rapidata/rapidata_client/settings/__init__.py +4 -1
  803. rapidata/rapidata_client/settings/_rapidata_setting.py +22 -3
  804. rapidata/rapidata_client/settings/alert_on_fast_response.py +8 -5
  805. rapidata/rapidata_client/settings/allow_neither_both.py +17 -0
  806. rapidata/rapidata_client/settings/custom_setting.py +3 -2
  807. rapidata/rapidata_client/settings/free_text_minimum_characters.py +9 -4
  808. rapidata/rapidata_client/settings/models/translation_behaviour_options.py +3 -2
  809. rapidata/rapidata_client/settings/mute_video.py +15 -0
  810. rapidata/rapidata_client/settings/no_shuffle.py +4 -2
  811. rapidata/rapidata_client/settings/play_video_until_the_end.py +7 -4
  812. rapidata/rapidata_client/settings/rapidata_settings.py +28 -16
  813. rapidata/rapidata_client/settings/swap_context_instruction.py +20 -0
  814. rapidata/rapidata_client/settings/translation_behaviour.py +7 -5
  815. rapidata/rapidata_client/utils/__init__.py +3 -0
  816. rapidata/rapidata_client/utils/threaded_uploader.py +153 -0
  817. rapidata/rapidata_client/validation/__init__.py +2 -0
  818. rapidata/rapidata_client/validation/rapidata_validation_set.py +106 -12
  819. rapidata/rapidata_client/validation/rapids/__init__.py +2 -0
  820. rapidata/rapidata_client/validation/rapids/_validation_rapid_uploader.py +48 -0
  821. rapidata/rapidata_client/validation/rapids/box.py +37 -12
  822. rapidata/rapidata_client/validation/rapids/rapids.py +29 -104
  823. rapidata/rapidata_client/validation/rapids/rapids_manager.py +371 -214
  824. rapidata/rapidata_client/validation/validation_set_manager.py +529 -227
  825. rapidata/rapidata_client/workflow/__init__.py +2 -2
  826. rapidata/rapidata_client/workflow/_base_workflow.py +25 -7
  827. rapidata/rapidata_client/workflow/_classify_workflow.py +58 -15
  828. rapidata/rapidata_client/workflow/_compare_workflow.py +44 -9
  829. rapidata/rapidata_client/workflow/_draw_workflow.py +40 -10
  830. rapidata/rapidata_client/workflow/_evaluation_workflow.py +28 -7
  831. rapidata/rapidata_client/workflow/_free_text_workflow.py +46 -9
  832. rapidata/rapidata_client/workflow/_locate_workflow.py +40 -10
  833. rapidata/rapidata_client/workflow/_multi_ranking_workflow.py +90 -0
  834. rapidata/rapidata_client/workflow/_select_words_workflow.py +51 -11
  835. rapidata/rapidata_client/workflow/_timestamp_workflow.py +42 -11
  836. rapidata/service/__init__.py +0 -1
  837. rapidata/service/credential_manager.py +18 -18
  838. rapidata/service/openapi_service.py +128 -28
  839. rapidata/types/__init__.py +149 -0
  840. rapidata-3.0.1.dist-info/METADATA +32 -0
  841. rapidata-3.0.1.dist-info/RECORD +1089 -0
  842. {rapidata-2.23.2.dist-info → rapidata-3.0.1.dist-info}/WHEEL +1 -1
  843. rapidata/rapidata_client/api/rapidata_exception.py +0 -107
  844. rapidata/rapidata_client/assets/__init__.py +0 -10
  845. rapidata/rapidata_client/assets/_base_asset.py +0 -11
  846. rapidata/rapidata_client/assets/_media_asset.py +0 -306
  847. rapidata/rapidata_client/assets/_multi_asset.py +0 -66
  848. rapidata/rapidata_client/assets/_sessions.py +0 -35
  849. rapidata/rapidata_client/assets/_text_asset.py +0 -34
  850. rapidata/rapidata_client/assets/data_type_enum.py +0 -7
  851. rapidata/rapidata_client/country_codes/__init__.py +0 -1
  852. rapidata/rapidata_client/country_codes/country_codes.py +0 -19
  853. rapidata/rapidata_client/logging/__init__.py +0 -2
  854. rapidata/rapidata_client/logging/logger.py +0 -47
  855. rapidata/rapidata_client/logging/output_manager.py +0 -16
  856. rapidata/rapidata_client/metadata/_private_text_metadata.py +0 -17
  857. rapidata/rapidata_client/metadata/_prompt_metadata.py +0 -18
  858. rapidata/rapidata_client/metadata/_public_text_metadata.py +0 -17
  859. rapidata/rapidata_client/order/_rapidata_dataset.py +0 -443
  860. rapidata/rapidata_client/workflow/_ranking_workflow.py +0 -51
  861. rapidata/service/local_file_service.py +0 -25
  862. rapidata-2.23.2.dist-info/METADATA +0 -34
  863. rapidata-2.23.2.dist-info/RECORD +0 -523
  864. /rapidata/rapidata_client/{metadata → datapoints/metadata}/_base_metadata.py +0 -0
  865. {rapidata-2.23.2.dist-info → rapidata-3.0.1.dist-info/licenses}/LICENSE +0 -0
@@ -0,0 +1,4200 @@
1
+ # coding: utf-8
2
+
3
+ """
4
+ Rapidata Asset API
5
+
6
+ The API for the Rapidata Asset service
7
+
8
+ The version of the OpenAPI document: v1
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, StrictInt, StrictStr
20
+ from typing import Optional
21
+ from typing_extensions import Annotated
22
+ from rapidata.api_client.models.create_job_definition_endpoint_input import CreateJobDefinitionEndpointInput
23
+ from rapidata.api_client.models.create_job_definition_endpoint_output import CreateJobDefinitionEndpointOutput
24
+ from rapidata.api_client.models.create_job_endpoint_input import CreateJobEndpointInput
25
+ from rapidata.api_client.models.create_job_endpoint_output import CreateJobEndpointOutput
26
+ from rapidata.api_client.models.create_job_revision_endpoint_input import CreateJobRevisionEndpointInput
27
+ from rapidata.api_client.models.create_job_revision_endpoint_output import CreateJobRevisionEndpointOutput
28
+ from rapidata.api_client.models.get_job_by_id_endpoint_output import GetJobByIdEndpointOutput
29
+ from rapidata.api_client.models.get_job_definition_by_id_endpoint_output import GetJobDefinitionByIdEndpointOutput
30
+ from rapidata.api_client.models.get_job_revision_endpoint_output import GetJobRevisionEndpointOutput
31
+ from rapidata.api_client.models.paged_result_of_query_job_definitions_result import PagedResultOfQueryJobDefinitionsResult
32
+ from rapidata.api_client.models.paged_result_of_query_job_revisions_result import PagedResultOfQueryJobRevisionsResult
33
+ from rapidata.api_client.models.paged_result_of_query_jobs_result import PagedResultOfQueryJobsResult
34
+ from rapidata.api_client.models.query_model import QueryModel
35
+ from rapidata.api_client.models.update_job_definition_endpoint_input import UpdateJobDefinitionEndpointInput
36
+ from rapidata.api_client.models.update_job_endpoint_input import UpdateJobEndpointInput
37
+
38
+ from rapidata.api_client.api_client import ApiClient, RequestSerialized
39
+ from rapidata.api_client.api_response import ApiResponse
40
+ from rapidata.api_client.rest import RESTResponseType
41
+
42
+
43
+ class JobApi:
44
+ """NOTE: This class is auto generated by OpenAPI Generator
45
+ Ref: https://openapi-generator.tech
46
+
47
+ Do not edit the class manually.
48
+ """
49
+
50
+ def __init__(self, api_client=None) -> None:
51
+ if api_client is None:
52
+ api_client = ApiClient.get_default()
53
+ self.api_client = api_client
54
+
55
+
56
+ @validate_call
57
+ def job_definition_definition_id_delete(
58
+ self,
59
+ definition_id: StrictStr,
60
+ _request_timeout: Union[
61
+ None,
62
+ Annotated[StrictFloat, Field(gt=0)],
63
+ Tuple[
64
+ Annotated[StrictFloat, Field(gt=0)],
65
+ Annotated[StrictFloat, Field(gt=0)]
66
+ ]
67
+ ] = None,
68
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
69
+ _content_type: Optional[StrictStr] = None,
70
+ _headers: Optional[Dict[StrictStr, Any]] = None,
71
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
72
+ ) -> None:
73
+ """Deletes a job definition and all its revisions.
74
+
75
+
76
+ :param definition_id: (required)
77
+ :type definition_id: str
78
+ :param _request_timeout: timeout setting for this request. If one
79
+ number provided, it will be total request
80
+ timeout. It can also be a pair (tuple) of
81
+ (connection, read) timeouts.
82
+ :type _request_timeout: int, tuple(int, int), optional
83
+ :param _request_auth: set to override the auth_settings for an a single
84
+ request; this effectively ignores the
85
+ authentication in the spec for a single request.
86
+ :type _request_auth: dict, optional
87
+ :param _content_type: force content-type for the request.
88
+ :type _content_type: str, Optional
89
+ :param _headers: set to override the headers for a single
90
+ request; this effectively ignores the headers
91
+ in the spec for a single request.
92
+ :type _headers: dict, optional
93
+ :param _host_index: set to override the host_index for a single
94
+ request; this effectively ignores the host_index
95
+ in the spec for a single request.
96
+ :type _host_index: int, optional
97
+ :return: Returns the result object.
98
+ """ # noqa: E501
99
+
100
+ _param = self._job_definition_definition_id_delete_serialize(
101
+ definition_id=definition_id,
102
+ _request_auth=_request_auth,
103
+ _content_type=_content_type,
104
+ _headers=_headers,
105
+ _host_index=_host_index
106
+ )
107
+
108
+ _response_types_map: Dict[str, Optional[str]] = {
109
+ '204': None,
110
+ '400': "ValidationProblemDetails",
111
+ '401': None,
112
+ '403': None,
113
+ }
114
+ response_data = self.api_client.call_api(
115
+ *_param,
116
+ _request_timeout=_request_timeout
117
+ )
118
+ response_data.read()
119
+ return self.api_client.response_deserialize(
120
+ response_data=response_data,
121
+ response_types_map=_response_types_map,
122
+ ).data
123
+
124
+
125
+ @validate_call
126
+ def job_definition_definition_id_delete_with_http_info(
127
+ self,
128
+ definition_id: StrictStr,
129
+ _request_timeout: Union[
130
+ None,
131
+ Annotated[StrictFloat, Field(gt=0)],
132
+ Tuple[
133
+ Annotated[StrictFloat, Field(gt=0)],
134
+ Annotated[StrictFloat, Field(gt=0)]
135
+ ]
136
+ ] = None,
137
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
138
+ _content_type: Optional[StrictStr] = None,
139
+ _headers: Optional[Dict[StrictStr, Any]] = None,
140
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
141
+ ) -> ApiResponse[None]:
142
+ """Deletes a job definition and all its revisions.
143
+
144
+
145
+ :param definition_id: (required)
146
+ :type definition_id: str
147
+ :param _request_timeout: timeout setting for this request. If one
148
+ number provided, it will be total request
149
+ timeout. It can also be a pair (tuple) of
150
+ (connection, read) timeouts.
151
+ :type _request_timeout: int, tuple(int, int), optional
152
+ :param _request_auth: set to override the auth_settings for an a single
153
+ request; this effectively ignores the
154
+ authentication in the spec for a single request.
155
+ :type _request_auth: dict, optional
156
+ :param _content_type: force content-type for the request.
157
+ :type _content_type: str, Optional
158
+ :param _headers: set to override the headers for a single
159
+ request; this effectively ignores the headers
160
+ in the spec for a single request.
161
+ :type _headers: dict, optional
162
+ :param _host_index: set to override the host_index for a single
163
+ request; this effectively ignores the host_index
164
+ in the spec for a single request.
165
+ :type _host_index: int, optional
166
+ :return: Returns the result object.
167
+ """ # noqa: E501
168
+
169
+ _param = self._job_definition_definition_id_delete_serialize(
170
+ definition_id=definition_id,
171
+ _request_auth=_request_auth,
172
+ _content_type=_content_type,
173
+ _headers=_headers,
174
+ _host_index=_host_index
175
+ )
176
+
177
+ _response_types_map: Dict[str, Optional[str]] = {
178
+ '204': None,
179
+ '400': "ValidationProblemDetails",
180
+ '401': None,
181
+ '403': None,
182
+ }
183
+ response_data = self.api_client.call_api(
184
+ *_param,
185
+ _request_timeout=_request_timeout
186
+ )
187
+ response_data.read()
188
+ return self.api_client.response_deserialize(
189
+ response_data=response_data,
190
+ response_types_map=_response_types_map,
191
+ )
192
+
193
+
194
+ @validate_call
195
+ def job_definition_definition_id_delete_without_preload_content(
196
+ self,
197
+ definition_id: StrictStr,
198
+ _request_timeout: Union[
199
+ None,
200
+ Annotated[StrictFloat, Field(gt=0)],
201
+ Tuple[
202
+ Annotated[StrictFloat, Field(gt=0)],
203
+ Annotated[StrictFloat, Field(gt=0)]
204
+ ]
205
+ ] = None,
206
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
207
+ _content_type: Optional[StrictStr] = None,
208
+ _headers: Optional[Dict[StrictStr, Any]] = None,
209
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
210
+ ) -> RESTResponseType:
211
+ """Deletes a job definition and all its revisions.
212
+
213
+
214
+ :param definition_id: (required)
215
+ :type definition_id: str
216
+ :param _request_timeout: timeout setting for this request. If one
217
+ number provided, it will be total request
218
+ timeout. It can also be a pair (tuple) of
219
+ (connection, read) timeouts.
220
+ :type _request_timeout: int, tuple(int, int), optional
221
+ :param _request_auth: set to override the auth_settings for an a single
222
+ request; this effectively ignores the
223
+ authentication in the spec for a single request.
224
+ :type _request_auth: dict, optional
225
+ :param _content_type: force content-type for the request.
226
+ :type _content_type: str, Optional
227
+ :param _headers: set to override the headers for a single
228
+ request; this effectively ignores the headers
229
+ in the spec for a single request.
230
+ :type _headers: dict, optional
231
+ :param _host_index: set to override the host_index for a single
232
+ request; this effectively ignores the host_index
233
+ in the spec for a single request.
234
+ :type _host_index: int, optional
235
+ :return: Returns the result object.
236
+ """ # noqa: E501
237
+
238
+ _param = self._job_definition_definition_id_delete_serialize(
239
+ definition_id=definition_id,
240
+ _request_auth=_request_auth,
241
+ _content_type=_content_type,
242
+ _headers=_headers,
243
+ _host_index=_host_index
244
+ )
245
+
246
+ _response_types_map: Dict[str, Optional[str]] = {
247
+ '204': None,
248
+ '400': "ValidationProblemDetails",
249
+ '401': None,
250
+ '403': None,
251
+ }
252
+ response_data = self.api_client.call_api(
253
+ *_param,
254
+ _request_timeout=_request_timeout
255
+ )
256
+ return response_data.response
257
+
258
+
259
+ def _job_definition_definition_id_delete_serialize(
260
+ self,
261
+ definition_id,
262
+ _request_auth,
263
+ _content_type,
264
+ _headers,
265
+ _host_index,
266
+ ) -> RequestSerialized:
267
+
268
+ _host = None
269
+
270
+ _collection_formats: Dict[str, str] = {
271
+ }
272
+
273
+ _path_params: Dict[str, str] = {}
274
+ _query_params: List[Tuple[str, str]] = []
275
+ _header_params: Dict[str, Optional[str]] = _headers or {}
276
+ _form_params: List[Tuple[str, str]] = []
277
+ _files: Dict[
278
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
279
+ ] = {}
280
+ _body_params: Optional[bytes] = None
281
+
282
+ # process the path parameters
283
+ if definition_id is not None:
284
+ _path_params['definitionId'] = definition_id
285
+ # process the query parameters
286
+ # process the header parameters
287
+ # process the form parameters
288
+ # process the body parameter
289
+
290
+
291
+ # set the HTTP header `Accept`
292
+ if 'Accept' not in _header_params:
293
+ _header_params['Accept'] = self.api_client.select_header_accept(
294
+ [
295
+ 'application/json'
296
+ ]
297
+ )
298
+
299
+
300
+ # authentication setting
301
+ _auth_settings: List[str] = [
302
+ 'OAuth2',
303
+ 'OpenIdConnect',
304
+ 'Bearer'
305
+ ]
306
+
307
+ return self.api_client.param_serialize(
308
+ method='DELETE',
309
+ resource_path='/job/definition/{definitionId}',
310
+ path_params=_path_params,
311
+ query_params=_query_params,
312
+ header_params=_header_params,
313
+ body=_body_params,
314
+ post_params=_form_params,
315
+ files=_files,
316
+ auth_settings=_auth_settings,
317
+ collection_formats=_collection_formats,
318
+ _host=_host,
319
+ _request_auth=_request_auth
320
+ )
321
+
322
+
323
+
324
+
325
+ @validate_call
326
+ def job_definition_definition_id_get(
327
+ self,
328
+ definition_id: StrictStr,
329
+ _request_timeout: Union[
330
+ None,
331
+ Annotated[StrictFloat, Field(gt=0)],
332
+ Tuple[
333
+ Annotated[StrictFloat, Field(gt=0)],
334
+ Annotated[StrictFloat, Field(gt=0)]
335
+ ]
336
+ ] = None,
337
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
338
+ _content_type: Optional[StrictStr] = None,
339
+ _headers: Optional[Dict[StrictStr, Any]] = None,
340
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
341
+ ) -> GetJobDefinitionByIdEndpointOutput:
342
+ """Gets a job definition by its id.
343
+
344
+
345
+ :param definition_id: (required)
346
+ :type definition_id: str
347
+ :param _request_timeout: timeout setting for this request. If one
348
+ number provided, it will be total request
349
+ timeout. It can also be a pair (tuple) of
350
+ (connection, read) timeouts.
351
+ :type _request_timeout: int, tuple(int, int), optional
352
+ :param _request_auth: set to override the auth_settings for an a single
353
+ request; this effectively ignores the
354
+ authentication in the spec for a single request.
355
+ :type _request_auth: dict, optional
356
+ :param _content_type: force content-type for the request.
357
+ :type _content_type: str, Optional
358
+ :param _headers: set to override the headers for a single
359
+ request; this effectively ignores the headers
360
+ in the spec for a single request.
361
+ :type _headers: dict, optional
362
+ :param _host_index: set to override the host_index for a single
363
+ request; this effectively ignores the host_index
364
+ in the spec for a single request.
365
+ :type _host_index: int, optional
366
+ :return: Returns the result object.
367
+ """ # noqa: E501
368
+
369
+ _param = self._job_definition_definition_id_get_serialize(
370
+ definition_id=definition_id,
371
+ _request_auth=_request_auth,
372
+ _content_type=_content_type,
373
+ _headers=_headers,
374
+ _host_index=_host_index
375
+ )
376
+
377
+ _response_types_map: Dict[str, Optional[str]] = {
378
+ '200': "GetJobDefinitionByIdEndpointOutput",
379
+ '400': "ValidationProblemDetails",
380
+ '401': None,
381
+ '403': None,
382
+ }
383
+ response_data = self.api_client.call_api(
384
+ *_param,
385
+ _request_timeout=_request_timeout
386
+ )
387
+ response_data.read()
388
+ return self.api_client.response_deserialize(
389
+ response_data=response_data,
390
+ response_types_map=_response_types_map,
391
+ ).data
392
+
393
+
394
+ @validate_call
395
+ def job_definition_definition_id_get_with_http_info(
396
+ self,
397
+ definition_id: StrictStr,
398
+ _request_timeout: Union[
399
+ None,
400
+ Annotated[StrictFloat, Field(gt=0)],
401
+ Tuple[
402
+ Annotated[StrictFloat, Field(gt=0)],
403
+ Annotated[StrictFloat, Field(gt=0)]
404
+ ]
405
+ ] = None,
406
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
407
+ _content_type: Optional[StrictStr] = None,
408
+ _headers: Optional[Dict[StrictStr, Any]] = None,
409
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
410
+ ) -> ApiResponse[GetJobDefinitionByIdEndpointOutput]:
411
+ """Gets a job definition by its id.
412
+
413
+
414
+ :param definition_id: (required)
415
+ :type definition_id: str
416
+ :param _request_timeout: timeout setting for this request. If one
417
+ number provided, it will be total request
418
+ timeout. It can also be a pair (tuple) of
419
+ (connection, read) timeouts.
420
+ :type _request_timeout: int, tuple(int, int), optional
421
+ :param _request_auth: set to override the auth_settings for an a single
422
+ request; this effectively ignores the
423
+ authentication in the spec for a single request.
424
+ :type _request_auth: dict, optional
425
+ :param _content_type: force content-type for the request.
426
+ :type _content_type: str, Optional
427
+ :param _headers: set to override the headers for a single
428
+ request; this effectively ignores the headers
429
+ in the spec for a single request.
430
+ :type _headers: dict, optional
431
+ :param _host_index: set to override the host_index for a single
432
+ request; this effectively ignores the host_index
433
+ in the spec for a single request.
434
+ :type _host_index: int, optional
435
+ :return: Returns the result object.
436
+ """ # noqa: E501
437
+
438
+ _param = self._job_definition_definition_id_get_serialize(
439
+ definition_id=definition_id,
440
+ _request_auth=_request_auth,
441
+ _content_type=_content_type,
442
+ _headers=_headers,
443
+ _host_index=_host_index
444
+ )
445
+
446
+ _response_types_map: Dict[str, Optional[str]] = {
447
+ '200': "GetJobDefinitionByIdEndpointOutput",
448
+ '400': "ValidationProblemDetails",
449
+ '401': None,
450
+ '403': None,
451
+ }
452
+ response_data = self.api_client.call_api(
453
+ *_param,
454
+ _request_timeout=_request_timeout
455
+ )
456
+ response_data.read()
457
+ return self.api_client.response_deserialize(
458
+ response_data=response_data,
459
+ response_types_map=_response_types_map,
460
+ )
461
+
462
+
463
+ @validate_call
464
+ def job_definition_definition_id_get_without_preload_content(
465
+ self,
466
+ definition_id: StrictStr,
467
+ _request_timeout: Union[
468
+ None,
469
+ Annotated[StrictFloat, Field(gt=0)],
470
+ Tuple[
471
+ Annotated[StrictFloat, Field(gt=0)],
472
+ Annotated[StrictFloat, Field(gt=0)]
473
+ ]
474
+ ] = None,
475
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
476
+ _content_type: Optional[StrictStr] = None,
477
+ _headers: Optional[Dict[StrictStr, Any]] = None,
478
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
479
+ ) -> RESTResponseType:
480
+ """Gets a job definition by its id.
481
+
482
+
483
+ :param definition_id: (required)
484
+ :type definition_id: str
485
+ :param _request_timeout: timeout setting for this request. If one
486
+ number provided, it will be total request
487
+ timeout. It can also be a pair (tuple) of
488
+ (connection, read) timeouts.
489
+ :type _request_timeout: int, tuple(int, int), optional
490
+ :param _request_auth: set to override the auth_settings for an a single
491
+ request; this effectively ignores the
492
+ authentication in the spec for a single request.
493
+ :type _request_auth: dict, optional
494
+ :param _content_type: force content-type for the request.
495
+ :type _content_type: str, Optional
496
+ :param _headers: set to override the headers for a single
497
+ request; this effectively ignores the headers
498
+ in the spec for a single request.
499
+ :type _headers: dict, optional
500
+ :param _host_index: set to override the host_index for a single
501
+ request; this effectively ignores the host_index
502
+ in the spec for a single request.
503
+ :type _host_index: int, optional
504
+ :return: Returns the result object.
505
+ """ # noqa: E501
506
+
507
+ _param = self._job_definition_definition_id_get_serialize(
508
+ definition_id=definition_id,
509
+ _request_auth=_request_auth,
510
+ _content_type=_content_type,
511
+ _headers=_headers,
512
+ _host_index=_host_index
513
+ )
514
+
515
+ _response_types_map: Dict[str, Optional[str]] = {
516
+ '200': "GetJobDefinitionByIdEndpointOutput",
517
+ '400': "ValidationProblemDetails",
518
+ '401': None,
519
+ '403': None,
520
+ }
521
+ response_data = self.api_client.call_api(
522
+ *_param,
523
+ _request_timeout=_request_timeout
524
+ )
525
+ return response_data.response
526
+
527
+
528
+ def _job_definition_definition_id_get_serialize(
529
+ self,
530
+ definition_id,
531
+ _request_auth,
532
+ _content_type,
533
+ _headers,
534
+ _host_index,
535
+ ) -> RequestSerialized:
536
+
537
+ _host = None
538
+
539
+ _collection_formats: Dict[str, str] = {
540
+ }
541
+
542
+ _path_params: Dict[str, str] = {}
543
+ _query_params: List[Tuple[str, str]] = []
544
+ _header_params: Dict[str, Optional[str]] = _headers or {}
545
+ _form_params: List[Tuple[str, str]] = []
546
+ _files: Dict[
547
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
548
+ ] = {}
549
+ _body_params: Optional[bytes] = None
550
+
551
+ # process the path parameters
552
+ if definition_id is not None:
553
+ _path_params['definitionId'] = definition_id
554
+ # process the query parameters
555
+ # process the header parameters
556
+ # process the form parameters
557
+ # process the body parameter
558
+
559
+
560
+ # set the HTTP header `Accept`
561
+ if 'Accept' not in _header_params:
562
+ _header_params['Accept'] = self.api_client.select_header_accept(
563
+ [
564
+ 'application/json'
565
+ ]
566
+ )
567
+
568
+
569
+ # authentication setting
570
+ _auth_settings: List[str] = [
571
+ 'OAuth2',
572
+ 'OpenIdConnect',
573
+ 'Bearer'
574
+ ]
575
+
576
+ return self.api_client.param_serialize(
577
+ method='GET',
578
+ resource_path='/job/definition/{definitionId}',
579
+ path_params=_path_params,
580
+ query_params=_query_params,
581
+ header_params=_header_params,
582
+ body=_body_params,
583
+ post_params=_form_params,
584
+ files=_files,
585
+ auth_settings=_auth_settings,
586
+ collection_formats=_collection_formats,
587
+ _host=_host,
588
+ _request_auth=_request_auth
589
+ )
590
+
591
+
592
+
593
+
594
+ @validate_call
595
+ def job_definition_definition_id_patch(
596
+ self,
597
+ definition_id: StrictStr,
598
+ update_job_definition_endpoint_input: UpdateJobDefinitionEndpointInput,
599
+ _request_timeout: Union[
600
+ None,
601
+ Annotated[StrictFloat, Field(gt=0)],
602
+ Tuple[
603
+ Annotated[StrictFloat, Field(gt=0)],
604
+ Annotated[StrictFloat, Field(gt=0)]
605
+ ]
606
+ ] = None,
607
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
608
+ _content_type: Optional[StrictStr] = None,
609
+ _headers: Optional[Dict[StrictStr, Any]] = None,
610
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
611
+ ) -> None:
612
+ """Updates a job definition.
613
+
614
+
615
+ :param definition_id: (required)
616
+ :type definition_id: str
617
+ :param update_job_definition_endpoint_input: (required)
618
+ :type update_job_definition_endpoint_input: UpdateJobDefinitionEndpointInput
619
+ :param _request_timeout: timeout setting for this request. If one
620
+ number provided, it will be total request
621
+ timeout. It can also be a pair (tuple) of
622
+ (connection, read) timeouts.
623
+ :type _request_timeout: int, tuple(int, int), optional
624
+ :param _request_auth: set to override the auth_settings for an a single
625
+ request; this effectively ignores the
626
+ authentication in the spec for a single request.
627
+ :type _request_auth: dict, optional
628
+ :param _content_type: force content-type for the request.
629
+ :type _content_type: str, Optional
630
+ :param _headers: set to override the headers for a single
631
+ request; this effectively ignores the headers
632
+ in the spec for a single request.
633
+ :type _headers: dict, optional
634
+ :param _host_index: set to override the host_index for a single
635
+ request; this effectively ignores the host_index
636
+ in the spec for a single request.
637
+ :type _host_index: int, optional
638
+ :return: Returns the result object.
639
+ """ # noqa: E501
640
+
641
+ _param = self._job_definition_definition_id_patch_serialize(
642
+ definition_id=definition_id,
643
+ update_job_definition_endpoint_input=update_job_definition_endpoint_input,
644
+ _request_auth=_request_auth,
645
+ _content_type=_content_type,
646
+ _headers=_headers,
647
+ _host_index=_host_index
648
+ )
649
+
650
+ _response_types_map: Dict[str, Optional[str]] = {
651
+ '204': None,
652
+ '400': "ValidationProblemDetails",
653
+ '401': None,
654
+ '403': None,
655
+ }
656
+ response_data = self.api_client.call_api(
657
+ *_param,
658
+ _request_timeout=_request_timeout
659
+ )
660
+ response_data.read()
661
+ return self.api_client.response_deserialize(
662
+ response_data=response_data,
663
+ response_types_map=_response_types_map,
664
+ ).data
665
+
666
+
667
+ @validate_call
668
+ def job_definition_definition_id_patch_with_http_info(
669
+ self,
670
+ definition_id: StrictStr,
671
+ update_job_definition_endpoint_input: UpdateJobDefinitionEndpointInput,
672
+ _request_timeout: Union[
673
+ None,
674
+ Annotated[StrictFloat, Field(gt=0)],
675
+ Tuple[
676
+ Annotated[StrictFloat, Field(gt=0)],
677
+ Annotated[StrictFloat, Field(gt=0)]
678
+ ]
679
+ ] = None,
680
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
681
+ _content_type: Optional[StrictStr] = None,
682
+ _headers: Optional[Dict[StrictStr, Any]] = None,
683
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
684
+ ) -> ApiResponse[None]:
685
+ """Updates a job definition.
686
+
687
+
688
+ :param definition_id: (required)
689
+ :type definition_id: str
690
+ :param update_job_definition_endpoint_input: (required)
691
+ :type update_job_definition_endpoint_input: UpdateJobDefinitionEndpointInput
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._job_definition_definition_id_patch_serialize(
715
+ definition_id=definition_id,
716
+ update_job_definition_endpoint_input=update_job_definition_endpoint_input,
717
+ _request_auth=_request_auth,
718
+ _content_type=_content_type,
719
+ _headers=_headers,
720
+ _host_index=_host_index
721
+ )
722
+
723
+ _response_types_map: Dict[str, Optional[str]] = {
724
+ '204': None,
725
+ '400': "ValidationProblemDetails",
726
+ '401': None,
727
+ '403': None,
728
+ }
729
+ response_data = self.api_client.call_api(
730
+ *_param,
731
+ _request_timeout=_request_timeout
732
+ )
733
+ response_data.read()
734
+ return self.api_client.response_deserialize(
735
+ response_data=response_data,
736
+ response_types_map=_response_types_map,
737
+ )
738
+
739
+
740
+ @validate_call
741
+ def job_definition_definition_id_patch_without_preload_content(
742
+ self,
743
+ definition_id: StrictStr,
744
+ update_job_definition_endpoint_input: UpdateJobDefinitionEndpointInput,
745
+ _request_timeout: Union[
746
+ None,
747
+ Annotated[StrictFloat, Field(gt=0)],
748
+ Tuple[
749
+ Annotated[StrictFloat, Field(gt=0)],
750
+ Annotated[StrictFloat, Field(gt=0)]
751
+ ]
752
+ ] = None,
753
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
754
+ _content_type: Optional[StrictStr] = None,
755
+ _headers: Optional[Dict[StrictStr, Any]] = None,
756
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
757
+ ) -> RESTResponseType:
758
+ """Updates a job definition.
759
+
760
+
761
+ :param definition_id: (required)
762
+ :type definition_id: str
763
+ :param update_job_definition_endpoint_input: (required)
764
+ :type update_job_definition_endpoint_input: UpdateJobDefinitionEndpointInput
765
+ :param _request_timeout: timeout setting for this request. If one
766
+ number provided, it will be total request
767
+ timeout. It can also be a pair (tuple) of
768
+ (connection, read) timeouts.
769
+ :type _request_timeout: int, tuple(int, int), optional
770
+ :param _request_auth: set to override the auth_settings for an a single
771
+ request; this effectively ignores the
772
+ authentication in the spec for a single request.
773
+ :type _request_auth: dict, optional
774
+ :param _content_type: force content-type for the request.
775
+ :type _content_type: str, Optional
776
+ :param _headers: set to override the headers for a single
777
+ request; this effectively ignores the headers
778
+ in the spec for a single request.
779
+ :type _headers: dict, optional
780
+ :param _host_index: set to override the host_index for a single
781
+ request; this effectively ignores the host_index
782
+ in the spec for a single request.
783
+ :type _host_index: int, optional
784
+ :return: Returns the result object.
785
+ """ # noqa: E501
786
+
787
+ _param = self._job_definition_definition_id_patch_serialize(
788
+ definition_id=definition_id,
789
+ update_job_definition_endpoint_input=update_job_definition_endpoint_input,
790
+ _request_auth=_request_auth,
791
+ _content_type=_content_type,
792
+ _headers=_headers,
793
+ _host_index=_host_index
794
+ )
795
+
796
+ _response_types_map: Dict[str, Optional[str]] = {
797
+ '204': None,
798
+ '400': "ValidationProblemDetails",
799
+ '401': None,
800
+ '403': None,
801
+ }
802
+ response_data = self.api_client.call_api(
803
+ *_param,
804
+ _request_timeout=_request_timeout
805
+ )
806
+ return response_data.response
807
+
808
+
809
+ def _job_definition_definition_id_patch_serialize(
810
+ self,
811
+ definition_id,
812
+ update_job_definition_endpoint_input,
813
+ _request_auth,
814
+ _content_type,
815
+ _headers,
816
+ _host_index,
817
+ ) -> RequestSerialized:
818
+
819
+ _host = None
820
+
821
+ _collection_formats: Dict[str, str] = {
822
+ }
823
+
824
+ _path_params: Dict[str, str] = {}
825
+ _query_params: List[Tuple[str, str]] = []
826
+ _header_params: Dict[str, Optional[str]] = _headers or {}
827
+ _form_params: List[Tuple[str, str]] = []
828
+ _files: Dict[
829
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
830
+ ] = {}
831
+ _body_params: Optional[bytes] = None
832
+
833
+ # process the path parameters
834
+ if definition_id is not None:
835
+ _path_params['definitionId'] = definition_id
836
+ # process the query parameters
837
+ # process the header parameters
838
+ # process the form parameters
839
+ # process the body parameter
840
+ if update_job_definition_endpoint_input is not None:
841
+ _body_params = update_job_definition_endpoint_input
842
+
843
+
844
+ # set the HTTP header `Accept`
845
+ if 'Accept' not in _header_params:
846
+ _header_params['Accept'] = self.api_client.select_header_accept(
847
+ [
848
+ 'application/json'
849
+ ]
850
+ )
851
+
852
+ # set the HTTP header `Content-Type`
853
+ if _content_type:
854
+ _header_params['Content-Type'] = _content_type
855
+ else:
856
+ _default_content_type = (
857
+ self.api_client.select_header_content_type(
858
+ [
859
+ 'application/json'
860
+ ]
861
+ )
862
+ )
863
+ if _default_content_type is not None:
864
+ _header_params['Content-Type'] = _default_content_type
865
+
866
+ # authentication setting
867
+ _auth_settings: List[str] = [
868
+ 'OAuth2',
869
+ 'OpenIdConnect',
870
+ 'Bearer'
871
+ ]
872
+
873
+ return self.api_client.param_serialize(
874
+ method='PATCH',
875
+ resource_path='/job/definition/{definitionId}',
876
+ path_params=_path_params,
877
+ query_params=_query_params,
878
+ header_params=_header_params,
879
+ body=_body_params,
880
+ post_params=_form_params,
881
+ files=_files,
882
+ auth_settings=_auth_settings,
883
+ collection_formats=_collection_formats,
884
+ _host=_host,
885
+ _request_auth=_request_auth
886
+ )
887
+
888
+
889
+
890
+
891
+ @validate_call
892
+ def job_definition_definition_id_revision_get(
893
+ self,
894
+ definition_id: StrictStr,
895
+ _request_timeout: Union[
896
+ None,
897
+ Annotated[StrictFloat, Field(gt=0)],
898
+ Tuple[
899
+ Annotated[StrictFloat, Field(gt=0)],
900
+ Annotated[StrictFloat, Field(gt=0)]
901
+ ]
902
+ ] = None,
903
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
904
+ _content_type: Optional[StrictStr] = None,
905
+ _headers: Optional[Dict[StrictStr, Any]] = None,
906
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
907
+ ) -> GetJobRevisionEndpointOutput:
908
+ """Gets the latest revision for a job definition.
909
+
910
+
911
+ :param definition_id: (required)
912
+ :type definition_id: str
913
+ :param _request_timeout: timeout setting for this request. If one
914
+ number provided, it will be total request
915
+ timeout. It can also be a pair (tuple) of
916
+ (connection, read) timeouts.
917
+ :type _request_timeout: int, tuple(int, int), optional
918
+ :param _request_auth: set to override the auth_settings for an a single
919
+ request; this effectively ignores the
920
+ authentication in the spec for a single request.
921
+ :type _request_auth: dict, optional
922
+ :param _content_type: force content-type for the request.
923
+ :type _content_type: str, Optional
924
+ :param _headers: set to override the headers for a single
925
+ request; this effectively ignores the headers
926
+ in the spec for a single request.
927
+ :type _headers: dict, optional
928
+ :param _host_index: set to override the host_index for a single
929
+ request; this effectively ignores the host_index
930
+ in the spec for a single request.
931
+ :type _host_index: int, optional
932
+ :return: Returns the result object.
933
+ """ # noqa: E501
934
+
935
+ _param = self._job_definition_definition_id_revision_get_serialize(
936
+ definition_id=definition_id,
937
+ _request_auth=_request_auth,
938
+ _content_type=_content_type,
939
+ _headers=_headers,
940
+ _host_index=_host_index
941
+ )
942
+
943
+ _response_types_map: Dict[str, Optional[str]] = {
944
+ '200': "GetJobRevisionEndpointOutput",
945
+ '400': "ValidationProblemDetails",
946
+ '401': None,
947
+ '403': None,
948
+ }
949
+ response_data = self.api_client.call_api(
950
+ *_param,
951
+ _request_timeout=_request_timeout
952
+ )
953
+ response_data.read()
954
+ return self.api_client.response_deserialize(
955
+ response_data=response_data,
956
+ response_types_map=_response_types_map,
957
+ ).data
958
+
959
+
960
+ @validate_call
961
+ def job_definition_definition_id_revision_get_with_http_info(
962
+ self,
963
+ definition_id: StrictStr,
964
+ _request_timeout: Union[
965
+ None,
966
+ Annotated[StrictFloat, Field(gt=0)],
967
+ Tuple[
968
+ Annotated[StrictFloat, Field(gt=0)],
969
+ Annotated[StrictFloat, Field(gt=0)]
970
+ ]
971
+ ] = None,
972
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
973
+ _content_type: Optional[StrictStr] = None,
974
+ _headers: Optional[Dict[StrictStr, Any]] = None,
975
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
976
+ ) -> ApiResponse[GetJobRevisionEndpointOutput]:
977
+ """Gets the latest revision for a job definition.
978
+
979
+
980
+ :param definition_id: (required)
981
+ :type definition_id: str
982
+ :param _request_timeout: timeout setting for this request. If one
983
+ number provided, it will be total request
984
+ timeout. It can also be a pair (tuple) of
985
+ (connection, read) timeouts.
986
+ :type _request_timeout: int, tuple(int, int), optional
987
+ :param _request_auth: set to override the auth_settings for an a single
988
+ request; this effectively ignores the
989
+ authentication in the spec for a single request.
990
+ :type _request_auth: dict, optional
991
+ :param _content_type: force content-type for the request.
992
+ :type _content_type: str, Optional
993
+ :param _headers: set to override the headers for a single
994
+ request; this effectively ignores the headers
995
+ in the spec for a single request.
996
+ :type _headers: dict, optional
997
+ :param _host_index: set to override the host_index for a single
998
+ request; this effectively ignores the host_index
999
+ in the spec for a single request.
1000
+ :type _host_index: int, optional
1001
+ :return: Returns the result object.
1002
+ """ # noqa: E501
1003
+
1004
+ _param = self._job_definition_definition_id_revision_get_serialize(
1005
+ definition_id=definition_id,
1006
+ _request_auth=_request_auth,
1007
+ _content_type=_content_type,
1008
+ _headers=_headers,
1009
+ _host_index=_host_index
1010
+ )
1011
+
1012
+ _response_types_map: Dict[str, Optional[str]] = {
1013
+ '200': "GetJobRevisionEndpointOutput",
1014
+ '400': "ValidationProblemDetails",
1015
+ '401': None,
1016
+ '403': None,
1017
+ }
1018
+ response_data = self.api_client.call_api(
1019
+ *_param,
1020
+ _request_timeout=_request_timeout
1021
+ )
1022
+ response_data.read()
1023
+ return self.api_client.response_deserialize(
1024
+ response_data=response_data,
1025
+ response_types_map=_response_types_map,
1026
+ )
1027
+
1028
+
1029
+ @validate_call
1030
+ def job_definition_definition_id_revision_get_without_preload_content(
1031
+ self,
1032
+ definition_id: StrictStr,
1033
+ _request_timeout: Union[
1034
+ None,
1035
+ Annotated[StrictFloat, Field(gt=0)],
1036
+ Tuple[
1037
+ Annotated[StrictFloat, Field(gt=0)],
1038
+ Annotated[StrictFloat, Field(gt=0)]
1039
+ ]
1040
+ ] = None,
1041
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1042
+ _content_type: Optional[StrictStr] = None,
1043
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1044
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1045
+ ) -> RESTResponseType:
1046
+ """Gets the latest revision for a job definition.
1047
+
1048
+
1049
+ :param definition_id: (required)
1050
+ :type definition_id: str
1051
+ :param _request_timeout: timeout setting for this request. If one
1052
+ number provided, it will be total request
1053
+ timeout. It can also be a pair (tuple) of
1054
+ (connection, read) timeouts.
1055
+ :type _request_timeout: int, tuple(int, int), optional
1056
+ :param _request_auth: set to override the auth_settings for an a single
1057
+ request; this effectively ignores the
1058
+ authentication in the spec for a single request.
1059
+ :type _request_auth: dict, optional
1060
+ :param _content_type: force content-type for the request.
1061
+ :type _content_type: str, Optional
1062
+ :param _headers: set to override the headers for a single
1063
+ request; this effectively ignores the headers
1064
+ in the spec for a single request.
1065
+ :type _headers: dict, optional
1066
+ :param _host_index: set to override the host_index for a single
1067
+ request; this effectively ignores the host_index
1068
+ in the spec for a single request.
1069
+ :type _host_index: int, optional
1070
+ :return: Returns the result object.
1071
+ """ # noqa: E501
1072
+
1073
+ _param = self._job_definition_definition_id_revision_get_serialize(
1074
+ definition_id=definition_id,
1075
+ _request_auth=_request_auth,
1076
+ _content_type=_content_type,
1077
+ _headers=_headers,
1078
+ _host_index=_host_index
1079
+ )
1080
+
1081
+ _response_types_map: Dict[str, Optional[str]] = {
1082
+ '200': "GetJobRevisionEndpointOutput",
1083
+ '400': "ValidationProblemDetails",
1084
+ '401': None,
1085
+ '403': None,
1086
+ }
1087
+ response_data = self.api_client.call_api(
1088
+ *_param,
1089
+ _request_timeout=_request_timeout
1090
+ )
1091
+ return response_data.response
1092
+
1093
+
1094
+ def _job_definition_definition_id_revision_get_serialize(
1095
+ self,
1096
+ definition_id,
1097
+ _request_auth,
1098
+ _content_type,
1099
+ _headers,
1100
+ _host_index,
1101
+ ) -> RequestSerialized:
1102
+
1103
+ _host = None
1104
+
1105
+ _collection_formats: Dict[str, str] = {
1106
+ }
1107
+
1108
+ _path_params: Dict[str, str] = {}
1109
+ _query_params: List[Tuple[str, str]] = []
1110
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1111
+ _form_params: List[Tuple[str, str]] = []
1112
+ _files: Dict[
1113
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1114
+ ] = {}
1115
+ _body_params: Optional[bytes] = None
1116
+
1117
+ # process the path parameters
1118
+ if definition_id is not None:
1119
+ _path_params['definitionId'] = definition_id
1120
+ # process the query parameters
1121
+ # process the header parameters
1122
+ # process the form parameters
1123
+ # process the body parameter
1124
+
1125
+
1126
+ # set the HTTP header `Accept`
1127
+ if 'Accept' not in _header_params:
1128
+ _header_params['Accept'] = self.api_client.select_header_accept(
1129
+ [
1130
+ 'application/json'
1131
+ ]
1132
+ )
1133
+
1134
+
1135
+ # authentication setting
1136
+ _auth_settings: List[str] = [
1137
+ 'OAuth2',
1138
+ 'OpenIdConnect',
1139
+ 'Bearer'
1140
+ ]
1141
+
1142
+ return self.api_client.param_serialize(
1143
+ method='GET',
1144
+ resource_path='/job/definition/{definitionId}/revision',
1145
+ path_params=_path_params,
1146
+ query_params=_query_params,
1147
+ header_params=_header_params,
1148
+ body=_body_params,
1149
+ post_params=_form_params,
1150
+ files=_files,
1151
+ auth_settings=_auth_settings,
1152
+ collection_formats=_collection_formats,
1153
+ _host=_host,
1154
+ _request_auth=_request_auth
1155
+ )
1156
+
1157
+
1158
+
1159
+
1160
+ @validate_call
1161
+ def job_definition_definition_id_revision_post(
1162
+ self,
1163
+ definition_id: StrictStr,
1164
+ create_job_revision_endpoint_input: CreateJobRevisionEndpointInput,
1165
+ _request_timeout: Union[
1166
+ None,
1167
+ Annotated[StrictFloat, Field(gt=0)],
1168
+ Tuple[
1169
+ Annotated[StrictFloat, Field(gt=0)],
1170
+ Annotated[StrictFloat, Field(gt=0)]
1171
+ ]
1172
+ ] = None,
1173
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1174
+ _content_type: Optional[StrictStr] = None,
1175
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1176
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1177
+ ) -> CreateJobRevisionEndpointOutput:
1178
+ """Creates a new revision for an existing job definition.
1179
+
1180
+
1181
+ :param definition_id: (required)
1182
+ :type definition_id: str
1183
+ :param create_job_revision_endpoint_input: (required)
1184
+ :type create_job_revision_endpoint_input: CreateJobRevisionEndpointInput
1185
+ :param _request_timeout: timeout setting for this request. If one
1186
+ number provided, it will be total request
1187
+ timeout. It can also be a pair (tuple) of
1188
+ (connection, read) timeouts.
1189
+ :type _request_timeout: int, tuple(int, int), optional
1190
+ :param _request_auth: set to override the auth_settings for an a single
1191
+ request; this effectively ignores the
1192
+ authentication in the spec for a single request.
1193
+ :type _request_auth: dict, optional
1194
+ :param _content_type: force content-type for the request.
1195
+ :type _content_type: str, Optional
1196
+ :param _headers: set to override the headers for a single
1197
+ request; this effectively ignores the headers
1198
+ in the spec for a single request.
1199
+ :type _headers: dict, optional
1200
+ :param _host_index: set to override the host_index for a single
1201
+ request; this effectively ignores the host_index
1202
+ in the spec for a single request.
1203
+ :type _host_index: int, optional
1204
+ :return: Returns the result object.
1205
+ """ # noqa: E501
1206
+
1207
+ _param = self._job_definition_definition_id_revision_post_serialize(
1208
+ definition_id=definition_id,
1209
+ create_job_revision_endpoint_input=create_job_revision_endpoint_input,
1210
+ _request_auth=_request_auth,
1211
+ _content_type=_content_type,
1212
+ _headers=_headers,
1213
+ _host_index=_host_index
1214
+ )
1215
+
1216
+ _response_types_map: Dict[str, Optional[str]] = {
1217
+ '200': "CreateJobRevisionEndpointOutput",
1218
+ '400': "ValidationProblemDetails",
1219
+ '401': None,
1220
+ '403': None,
1221
+ }
1222
+ response_data = self.api_client.call_api(
1223
+ *_param,
1224
+ _request_timeout=_request_timeout
1225
+ )
1226
+ response_data.read()
1227
+ return self.api_client.response_deserialize(
1228
+ response_data=response_data,
1229
+ response_types_map=_response_types_map,
1230
+ ).data
1231
+
1232
+
1233
+ @validate_call
1234
+ def job_definition_definition_id_revision_post_with_http_info(
1235
+ self,
1236
+ definition_id: StrictStr,
1237
+ create_job_revision_endpoint_input: CreateJobRevisionEndpointInput,
1238
+ _request_timeout: Union[
1239
+ None,
1240
+ Annotated[StrictFloat, Field(gt=0)],
1241
+ Tuple[
1242
+ Annotated[StrictFloat, Field(gt=0)],
1243
+ Annotated[StrictFloat, Field(gt=0)]
1244
+ ]
1245
+ ] = None,
1246
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1247
+ _content_type: Optional[StrictStr] = None,
1248
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1249
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1250
+ ) -> ApiResponse[CreateJobRevisionEndpointOutput]:
1251
+ """Creates a new revision for an existing job definition.
1252
+
1253
+
1254
+ :param definition_id: (required)
1255
+ :type definition_id: str
1256
+ :param create_job_revision_endpoint_input: (required)
1257
+ :type create_job_revision_endpoint_input: CreateJobRevisionEndpointInput
1258
+ :param _request_timeout: timeout setting for this request. If one
1259
+ number provided, it will be total request
1260
+ timeout. It can also be a pair (tuple) of
1261
+ (connection, read) timeouts.
1262
+ :type _request_timeout: int, tuple(int, int), optional
1263
+ :param _request_auth: set to override the auth_settings for an a single
1264
+ request; this effectively ignores the
1265
+ authentication in the spec for a single request.
1266
+ :type _request_auth: dict, optional
1267
+ :param _content_type: force content-type for the request.
1268
+ :type _content_type: str, Optional
1269
+ :param _headers: set to override the headers for a single
1270
+ request; this effectively ignores the headers
1271
+ in the spec for a single request.
1272
+ :type _headers: dict, optional
1273
+ :param _host_index: set to override the host_index for a single
1274
+ request; this effectively ignores the host_index
1275
+ in the spec for a single request.
1276
+ :type _host_index: int, optional
1277
+ :return: Returns the result object.
1278
+ """ # noqa: E501
1279
+
1280
+ _param = self._job_definition_definition_id_revision_post_serialize(
1281
+ definition_id=definition_id,
1282
+ create_job_revision_endpoint_input=create_job_revision_endpoint_input,
1283
+ _request_auth=_request_auth,
1284
+ _content_type=_content_type,
1285
+ _headers=_headers,
1286
+ _host_index=_host_index
1287
+ )
1288
+
1289
+ _response_types_map: Dict[str, Optional[str]] = {
1290
+ '200': "CreateJobRevisionEndpointOutput",
1291
+ '400': "ValidationProblemDetails",
1292
+ '401': None,
1293
+ '403': None,
1294
+ }
1295
+ response_data = self.api_client.call_api(
1296
+ *_param,
1297
+ _request_timeout=_request_timeout
1298
+ )
1299
+ response_data.read()
1300
+ return self.api_client.response_deserialize(
1301
+ response_data=response_data,
1302
+ response_types_map=_response_types_map,
1303
+ )
1304
+
1305
+
1306
+ @validate_call
1307
+ def job_definition_definition_id_revision_post_without_preload_content(
1308
+ self,
1309
+ definition_id: StrictStr,
1310
+ create_job_revision_endpoint_input: CreateJobRevisionEndpointInput,
1311
+ _request_timeout: Union[
1312
+ None,
1313
+ Annotated[StrictFloat, Field(gt=0)],
1314
+ Tuple[
1315
+ Annotated[StrictFloat, Field(gt=0)],
1316
+ Annotated[StrictFloat, Field(gt=0)]
1317
+ ]
1318
+ ] = None,
1319
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1320
+ _content_type: Optional[StrictStr] = None,
1321
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1322
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1323
+ ) -> RESTResponseType:
1324
+ """Creates a new revision for an existing job definition.
1325
+
1326
+
1327
+ :param definition_id: (required)
1328
+ :type definition_id: str
1329
+ :param create_job_revision_endpoint_input: (required)
1330
+ :type create_job_revision_endpoint_input: CreateJobRevisionEndpointInput
1331
+ :param _request_timeout: timeout setting for this request. If one
1332
+ number provided, it will be total request
1333
+ timeout. It can also be a pair (tuple) of
1334
+ (connection, read) timeouts.
1335
+ :type _request_timeout: int, tuple(int, int), optional
1336
+ :param _request_auth: set to override the auth_settings for an a single
1337
+ request; this effectively ignores the
1338
+ authentication in the spec for a single request.
1339
+ :type _request_auth: dict, optional
1340
+ :param _content_type: force content-type for the request.
1341
+ :type _content_type: str, Optional
1342
+ :param _headers: set to override the headers for a single
1343
+ request; this effectively ignores the headers
1344
+ in the spec for a single request.
1345
+ :type _headers: dict, optional
1346
+ :param _host_index: set to override the host_index for a single
1347
+ request; this effectively ignores the host_index
1348
+ in the spec for a single request.
1349
+ :type _host_index: int, optional
1350
+ :return: Returns the result object.
1351
+ """ # noqa: E501
1352
+
1353
+ _param = self._job_definition_definition_id_revision_post_serialize(
1354
+ definition_id=definition_id,
1355
+ create_job_revision_endpoint_input=create_job_revision_endpoint_input,
1356
+ _request_auth=_request_auth,
1357
+ _content_type=_content_type,
1358
+ _headers=_headers,
1359
+ _host_index=_host_index
1360
+ )
1361
+
1362
+ _response_types_map: Dict[str, Optional[str]] = {
1363
+ '200': "CreateJobRevisionEndpointOutput",
1364
+ '400': "ValidationProblemDetails",
1365
+ '401': None,
1366
+ '403': None,
1367
+ }
1368
+ response_data = self.api_client.call_api(
1369
+ *_param,
1370
+ _request_timeout=_request_timeout
1371
+ )
1372
+ return response_data.response
1373
+
1374
+
1375
+ def _job_definition_definition_id_revision_post_serialize(
1376
+ self,
1377
+ definition_id,
1378
+ create_job_revision_endpoint_input,
1379
+ _request_auth,
1380
+ _content_type,
1381
+ _headers,
1382
+ _host_index,
1383
+ ) -> RequestSerialized:
1384
+
1385
+ _host = None
1386
+
1387
+ _collection_formats: Dict[str, str] = {
1388
+ }
1389
+
1390
+ _path_params: Dict[str, str] = {}
1391
+ _query_params: List[Tuple[str, str]] = []
1392
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1393
+ _form_params: List[Tuple[str, str]] = []
1394
+ _files: Dict[
1395
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1396
+ ] = {}
1397
+ _body_params: Optional[bytes] = None
1398
+
1399
+ # process the path parameters
1400
+ if definition_id is not None:
1401
+ _path_params['definitionId'] = definition_id
1402
+ # process the query parameters
1403
+ # process the header parameters
1404
+ # process the form parameters
1405
+ # process the body parameter
1406
+ if create_job_revision_endpoint_input is not None:
1407
+ _body_params = create_job_revision_endpoint_input
1408
+
1409
+
1410
+ # set the HTTP header `Accept`
1411
+ if 'Accept' not in _header_params:
1412
+ _header_params['Accept'] = self.api_client.select_header_accept(
1413
+ [
1414
+ 'application/json'
1415
+ ]
1416
+ )
1417
+
1418
+ # set the HTTP header `Content-Type`
1419
+ if _content_type:
1420
+ _header_params['Content-Type'] = _content_type
1421
+ else:
1422
+ _default_content_type = (
1423
+ self.api_client.select_header_content_type(
1424
+ [
1425
+ 'application/json'
1426
+ ]
1427
+ )
1428
+ )
1429
+ if _default_content_type is not None:
1430
+ _header_params['Content-Type'] = _default_content_type
1431
+
1432
+ # authentication setting
1433
+ _auth_settings: List[str] = [
1434
+ 'OAuth2',
1435
+ 'OpenIdConnect',
1436
+ 'Bearer'
1437
+ ]
1438
+
1439
+ return self.api_client.param_serialize(
1440
+ method='POST',
1441
+ resource_path='/job/definition/{definitionId}/revision',
1442
+ path_params=_path_params,
1443
+ query_params=_query_params,
1444
+ header_params=_header_params,
1445
+ body=_body_params,
1446
+ post_params=_form_params,
1447
+ files=_files,
1448
+ auth_settings=_auth_settings,
1449
+ collection_formats=_collection_formats,
1450
+ _host=_host,
1451
+ _request_auth=_request_auth
1452
+ )
1453
+
1454
+
1455
+
1456
+
1457
+ @validate_call
1458
+ def job_definition_definition_id_revision_revision_number_get(
1459
+ self,
1460
+ definition_id: StrictStr,
1461
+ revision_number: StrictInt,
1462
+ _request_timeout: Union[
1463
+ None,
1464
+ Annotated[StrictFloat, Field(gt=0)],
1465
+ Tuple[
1466
+ Annotated[StrictFloat, Field(gt=0)],
1467
+ Annotated[StrictFloat, Field(gt=0)]
1468
+ ]
1469
+ ] = None,
1470
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1471
+ _content_type: Optional[StrictStr] = None,
1472
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1473
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1474
+ ) -> GetJobRevisionEndpointOutput:
1475
+ """Gets a specific revision for a job definition.
1476
+
1477
+
1478
+ :param definition_id: (required)
1479
+ :type definition_id: str
1480
+ :param revision_number: (required)
1481
+ :type revision_number: int
1482
+ :param _request_timeout: timeout setting for this request. If one
1483
+ number provided, it will be total request
1484
+ timeout. It can also be a pair (tuple) of
1485
+ (connection, read) timeouts.
1486
+ :type _request_timeout: int, tuple(int, int), optional
1487
+ :param _request_auth: set to override the auth_settings for an a single
1488
+ request; this effectively ignores the
1489
+ authentication in the spec for a single request.
1490
+ :type _request_auth: dict, optional
1491
+ :param _content_type: force content-type for the request.
1492
+ :type _content_type: str, Optional
1493
+ :param _headers: set to override the headers for a single
1494
+ request; this effectively ignores the headers
1495
+ in the spec for a single request.
1496
+ :type _headers: dict, optional
1497
+ :param _host_index: set to override the host_index for a single
1498
+ request; this effectively ignores the host_index
1499
+ in the spec for a single request.
1500
+ :type _host_index: int, optional
1501
+ :return: Returns the result object.
1502
+ """ # noqa: E501
1503
+
1504
+ _param = self._job_definition_definition_id_revision_revision_number_get_serialize(
1505
+ definition_id=definition_id,
1506
+ revision_number=revision_number,
1507
+ _request_auth=_request_auth,
1508
+ _content_type=_content_type,
1509
+ _headers=_headers,
1510
+ _host_index=_host_index
1511
+ )
1512
+
1513
+ _response_types_map: Dict[str, Optional[str]] = {
1514
+ '200': "GetJobRevisionEndpointOutput",
1515
+ '400': "ValidationProblemDetails",
1516
+ '401': None,
1517
+ '403': None,
1518
+ }
1519
+ response_data = self.api_client.call_api(
1520
+ *_param,
1521
+ _request_timeout=_request_timeout
1522
+ )
1523
+ response_data.read()
1524
+ return self.api_client.response_deserialize(
1525
+ response_data=response_data,
1526
+ response_types_map=_response_types_map,
1527
+ ).data
1528
+
1529
+
1530
+ @validate_call
1531
+ def job_definition_definition_id_revision_revision_number_get_with_http_info(
1532
+ self,
1533
+ definition_id: StrictStr,
1534
+ revision_number: StrictInt,
1535
+ _request_timeout: Union[
1536
+ None,
1537
+ Annotated[StrictFloat, Field(gt=0)],
1538
+ Tuple[
1539
+ Annotated[StrictFloat, Field(gt=0)],
1540
+ Annotated[StrictFloat, Field(gt=0)]
1541
+ ]
1542
+ ] = None,
1543
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1544
+ _content_type: Optional[StrictStr] = None,
1545
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1546
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1547
+ ) -> ApiResponse[GetJobRevisionEndpointOutput]:
1548
+ """Gets a specific revision for a job definition.
1549
+
1550
+
1551
+ :param definition_id: (required)
1552
+ :type definition_id: str
1553
+ :param revision_number: (required)
1554
+ :type revision_number: int
1555
+ :param _request_timeout: timeout setting for this request. If one
1556
+ number provided, it will be total request
1557
+ timeout. It can also be a pair (tuple) of
1558
+ (connection, read) timeouts.
1559
+ :type _request_timeout: int, tuple(int, int), optional
1560
+ :param _request_auth: set to override the auth_settings for an a single
1561
+ request; this effectively ignores the
1562
+ authentication in the spec for a single request.
1563
+ :type _request_auth: dict, optional
1564
+ :param _content_type: force content-type for the request.
1565
+ :type _content_type: str, Optional
1566
+ :param _headers: set to override the headers for a single
1567
+ request; this effectively ignores the headers
1568
+ in the spec for a single request.
1569
+ :type _headers: dict, optional
1570
+ :param _host_index: set to override the host_index for a single
1571
+ request; this effectively ignores the host_index
1572
+ in the spec for a single request.
1573
+ :type _host_index: int, optional
1574
+ :return: Returns the result object.
1575
+ """ # noqa: E501
1576
+
1577
+ _param = self._job_definition_definition_id_revision_revision_number_get_serialize(
1578
+ definition_id=definition_id,
1579
+ revision_number=revision_number,
1580
+ _request_auth=_request_auth,
1581
+ _content_type=_content_type,
1582
+ _headers=_headers,
1583
+ _host_index=_host_index
1584
+ )
1585
+
1586
+ _response_types_map: Dict[str, Optional[str]] = {
1587
+ '200': "GetJobRevisionEndpointOutput",
1588
+ '400': "ValidationProblemDetails",
1589
+ '401': None,
1590
+ '403': None,
1591
+ }
1592
+ response_data = self.api_client.call_api(
1593
+ *_param,
1594
+ _request_timeout=_request_timeout
1595
+ )
1596
+ response_data.read()
1597
+ return self.api_client.response_deserialize(
1598
+ response_data=response_data,
1599
+ response_types_map=_response_types_map,
1600
+ )
1601
+
1602
+
1603
+ @validate_call
1604
+ def job_definition_definition_id_revision_revision_number_get_without_preload_content(
1605
+ self,
1606
+ definition_id: StrictStr,
1607
+ revision_number: StrictInt,
1608
+ _request_timeout: Union[
1609
+ None,
1610
+ Annotated[StrictFloat, Field(gt=0)],
1611
+ Tuple[
1612
+ Annotated[StrictFloat, Field(gt=0)],
1613
+ Annotated[StrictFloat, Field(gt=0)]
1614
+ ]
1615
+ ] = None,
1616
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1617
+ _content_type: Optional[StrictStr] = None,
1618
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1619
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1620
+ ) -> RESTResponseType:
1621
+ """Gets a specific revision for a job definition.
1622
+
1623
+
1624
+ :param definition_id: (required)
1625
+ :type definition_id: str
1626
+ :param revision_number: (required)
1627
+ :type revision_number: int
1628
+ :param _request_timeout: timeout setting for this request. If one
1629
+ number provided, it will be total request
1630
+ timeout. It can also be a pair (tuple) of
1631
+ (connection, read) timeouts.
1632
+ :type _request_timeout: int, tuple(int, int), optional
1633
+ :param _request_auth: set to override the auth_settings for an a single
1634
+ request; this effectively ignores the
1635
+ authentication in the spec for a single request.
1636
+ :type _request_auth: dict, optional
1637
+ :param _content_type: force content-type for the request.
1638
+ :type _content_type: str, Optional
1639
+ :param _headers: set to override the headers for a single
1640
+ request; this effectively ignores the headers
1641
+ in the spec for a single request.
1642
+ :type _headers: dict, optional
1643
+ :param _host_index: set to override the host_index for a single
1644
+ request; this effectively ignores the host_index
1645
+ in the spec for a single request.
1646
+ :type _host_index: int, optional
1647
+ :return: Returns the result object.
1648
+ """ # noqa: E501
1649
+
1650
+ _param = self._job_definition_definition_id_revision_revision_number_get_serialize(
1651
+ definition_id=definition_id,
1652
+ revision_number=revision_number,
1653
+ _request_auth=_request_auth,
1654
+ _content_type=_content_type,
1655
+ _headers=_headers,
1656
+ _host_index=_host_index
1657
+ )
1658
+
1659
+ _response_types_map: Dict[str, Optional[str]] = {
1660
+ '200': "GetJobRevisionEndpointOutput",
1661
+ '400': "ValidationProblemDetails",
1662
+ '401': None,
1663
+ '403': None,
1664
+ }
1665
+ response_data = self.api_client.call_api(
1666
+ *_param,
1667
+ _request_timeout=_request_timeout
1668
+ )
1669
+ return response_data.response
1670
+
1671
+
1672
+ def _job_definition_definition_id_revision_revision_number_get_serialize(
1673
+ self,
1674
+ definition_id,
1675
+ revision_number,
1676
+ _request_auth,
1677
+ _content_type,
1678
+ _headers,
1679
+ _host_index,
1680
+ ) -> RequestSerialized:
1681
+
1682
+ _host = None
1683
+
1684
+ _collection_formats: Dict[str, str] = {
1685
+ }
1686
+
1687
+ _path_params: Dict[str, str] = {}
1688
+ _query_params: List[Tuple[str, str]] = []
1689
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1690
+ _form_params: List[Tuple[str, str]] = []
1691
+ _files: Dict[
1692
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1693
+ ] = {}
1694
+ _body_params: Optional[bytes] = None
1695
+
1696
+ # process the path parameters
1697
+ if definition_id is not None:
1698
+ _path_params['definitionId'] = definition_id
1699
+ if revision_number is not None:
1700
+ _path_params['revisionNumber'] = revision_number
1701
+ # process the query parameters
1702
+ # process the header parameters
1703
+ # process the form parameters
1704
+ # process the body parameter
1705
+
1706
+
1707
+ # set the HTTP header `Accept`
1708
+ if 'Accept' not in _header_params:
1709
+ _header_params['Accept'] = self.api_client.select_header_accept(
1710
+ [
1711
+ 'application/json'
1712
+ ]
1713
+ )
1714
+
1715
+
1716
+ # authentication setting
1717
+ _auth_settings: List[str] = [
1718
+ 'OAuth2',
1719
+ 'OpenIdConnect',
1720
+ 'Bearer'
1721
+ ]
1722
+
1723
+ return self.api_client.param_serialize(
1724
+ method='GET',
1725
+ resource_path='/job/definition/{definitionId}/revision/{revisionNumber}',
1726
+ path_params=_path_params,
1727
+ query_params=_query_params,
1728
+ header_params=_header_params,
1729
+ body=_body_params,
1730
+ post_params=_form_params,
1731
+ files=_files,
1732
+ auth_settings=_auth_settings,
1733
+ collection_formats=_collection_formats,
1734
+ _host=_host,
1735
+ _request_auth=_request_auth
1736
+ )
1737
+
1738
+
1739
+
1740
+
1741
+ @validate_call
1742
+ def job_definition_definition_id_revisions_get(
1743
+ self,
1744
+ definition_id: Annotated[StrictStr, Field(description="The id of the job definition")],
1745
+ request: Annotated[Optional[QueryModel], Field(description="The parameters for filtering, paging, and sorting")] = None,
1746
+ _request_timeout: Union[
1747
+ None,
1748
+ Annotated[StrictFloat, Field(gt=0)],
1749
+ Tuple[
1750
+ Annotated[StrictFloat, Field(gt=0)],
1751
+ Annotated[StrictFloat, Field(gt=0)]
1752
+ ]
1753
+ ] = None,
1754
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1755
+ _content_type: Optional[StrictStr] = None,
1756
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1757
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1758
+ ) -> PagedResultOfQueryJobRevisionsResult:
1759
+ """Queries job revisions for a specific definition based on filter, page, and sort criteria.
1760
+
1761
+
1762
+ :param definition_id: The id of the job definition (required)
1763
+ :type definition_id: str
1764
+ :param request: The parameters for filtering, paging, and sorting
1765
+ :type request: QueryModel
1766
+ :param _request_timeout: timeout setting for this request. If one
1767
+ number provided, it will be total request
1768
+ timeout. It can also be a pair (tuple) of
1769
+ (connection, read) timeouts.
1770
+ :type _request_timeout: int, tuple(int, int), optional
1771
+ :param _request_auth: set to override the auth_settings for an a single
1772
+ request; this effectively ignores the
1773
+ authentication in the spec for a single request.
1774
+ :type _request_auth: dict, optional
1775
+ :param _content_type: force content-type for the request.
1776
+ :type _content_type: str, Optional
1777
+ :param _headers: set to override the headers for a single
1778
+ request; this effectively ignores the headers
1779
+ in the spec for a single request.
1780
+ :type _headers: dict, optional
1781
+ :param _host_index: set to override the host_index for a single
1782
+ request; this effectively ignores the host_index
1783
+ in the spec for a single request.
1784
+ :type _host_index: int, optional
1785
+ :return: Returns the result object.
1786
+ """ # noqa: E501
1787
+
1788
+ _param = self._job_definition_definition_id_revisions_get_serialize(
1789
+ definition_id=definition_id,
1790
+ request=request,
1791
+ _request_auth=_request_auth,
1792
+ _content_type=_content_type,
1793
+ _headers=_headers,
1794
+ _host_index=_host_index
1795
+ )
1796
+
1797
+ _response_types_map: Dict[str, Optional[str]] = {
1798
+ '200': "PagedResultOfQueryJobRevisionsResult",
1799
+ }
1800
+ response_data = self.api_client.call_api(
1801
+ *_param,
1802
+ _request_timeout=_request_timeout
1803
+ )
1804
+ response_data.read()
1805
+ return self.api_client.response_deserialize(
1806
+ response_data=response_data,
1807
+ response_types_map=_response_types_map,
1808
+ ).data
1809
+
1810
+
1811
+ @validate_call
1812
+ def job_definition_definition_id_revisions_get_with_http_info(
1813
+ self,
1814
+ definition_id: Annotated[StrictStr, Field(description="The id of the job definition")],
1815
+ request: Annotated[Optional[QueryModel], Field(description="The parameters for filtering, paging, and sorting")] = None,
1816
+ _request_timeout: Union[
1817
+ None,
1818
+ Annotated[StrictFloat, Field(gt=0)],
1819
+ Tuple[
1820
+ Annotated[StrictFloat, Field(gt=0)],
1821
+ Annotated[StrictFloat, Field(gt=0)]
1822
+ ]
1823
+ ] = None,
1824
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1825
+ _content_type: Optional[StrictStr] = None,
1826
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1827
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1828
+ ) -> ApiResponse[PagedResultOfQueryJobRevisionsResult]:
1829
+ """Queries job revisions for a specific definition based on filter, page, and sort criteria.
1830
+
1831
+
1832
+ :param definition_id: The id of the job definition (required)
1833
+ :type definition_id: str
1834
+ :param request: The parameters for filtering, paging, and sorting
1835
+ :type request: QueryModel
1836
+ :param _request_timeout: timeout setting for this request. If one
1837
+ number provided, it will be total request
1838
+ timeout. It can also be a pair (tuple) of
1839
+ (connection, read) timeouts.
1840
+ :type _request_timeout: int, tuple(int, int), optional
1841
+ :param _request_auth: set to override the auth_settings for an a single
1842
+ request; this effectively ignores the
1843
+ authentication in the spec for a single request.
1844
+ :type _request_auth: dict, optional
1845
+ :param _content_type: force content-type for the request.
1846
+ :type _content_type: str, Optional
1847
+ :param _headers: set to override the headers for a single
1848
+ request; this effectively ignores the headers
1849
+ in the spec for a single request.
1850
+ :type _headers: dict, optional
1851
+ :param _host_index: set to override the host_index for a single
1852
+ request; this effectively ignores the host_index
1853
+ in the spec for a single request.
1854
+ :type _host_index: int, optional
1855
+ :return: Returns the result object.
1856
+ """ # noqa: E501
1857
+
1858
+ _param = self._job_definition_definition_id_revisions_get_serialize(
1859
+ definition_id=definition_id,
1860
+ request=request,
1861
+ _request_auth=_request_auth,
1862
+ _content_type=_content_type,
1863
+ _headers=_headers,
1864
+ _host_index=_host_index
1865
+ )
1866
+
1867
+ _response_types_map: Dict[str, Optional[str]] = {
1868
+ '200': "PagedResultOfQueryJobRevisionsResult",
1869
+ }
1870
+ response_data = self.api_client.call_api(
1871
+ *_param,
1872
+ _request_timeout=_request_timeout
1873
+ )
1874
+ response_data.read()
1875
+ return self.api_client.response_deserialize(
1876
+ response_data=response_data,
1877
+ response_types_map=_response_types_map,
1878
+ )
1879
+
1880
+
1881
+ @validate_call
1882
+ def job_definition_definition_id_revisions_get_without_preload_content(
1883
+ self,
1884
+ definition_id: Annotated[StrictStr, Field(description="The id of the job definition")],
1885
+ request: Annotated[Optional[QueryModel], Field(description="The parameters for filtering, paging, and sorting")] = None,
1886
+ _request_timeout: Union[
1887
+ None,
1888
+ Annotated[StrictFloat, Field(gt=0)],
1889
+ Tuple[
1890
+ Annotated[StrictFloat, Field(gt=0)],
1891
+ Annotated[StrictFloat, Field(gt=0)]
1892
+ ]
1893
+ ] = None,
1894
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1895
+ _content_type: Optional[StrictStr] = None,
1896
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1897
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1898
+ ) -> RESTResponseType:
1899
+ """Queries job revisions for a specific definition based on filter, page, and sort criteria.
1900
+
1901
+
1902
+ :param definition_id: The id of the job definition (required)
1903
+ :type definition_id: str
1904
+ :param request: The parameters for filtering, paging, and sorting
1905
+ :type request: QueryModel
1906
+ :param _request_timeout: timeout setting for this request. If one
1907
+ number provided, it will be total request
1908
+ timeout. It can also be a pair (tuple) of
1909
+ (connection, read) timeouts.
1910
+ :type _request_timeout: int, tuple(int, int), optional
1911
+ :param _request_auth: set to override the auth_settings for an a single
1912
+ request; this effectively ignores the
1913
+ authentication in the spec for a single request.
1914
+ :type _request_auth: dict, optional
1915
+ :param _content_type: force content-type for the request.
1916
+ :type _content_type: str, Optional
1917
+ :param _headers: set to override the headers for a single
1918
+ request; this effectively ignores the headers
1919
+ in the spec for a single request.
1920
+ :type _headers: dict, optional
1921
+ :param _host_index: set to override the host_index for a single
1922
+ request; this effectively ignores the host_index
1923
+ in the spec for a single request.
1924
+ :type _host_index: int, optional
1925
+ :return: Returns the result object.
1926
+ """ # noqa: E501
1927
+
1928
+ _param = self._job_definition_definition_id_revisions_get_serialize(
1929
+ definition_id=definition_id,
1930
+ request=request,
1931
+ _request_auth=_request_auth,
1932
+ _content_type=_content_type,
1933
+ _headers=_headers,
1934
+ _host_index=_host_index
1935
+ )
1936
+
1937
+ _response_types_map: Dict[str, Optional[str]] = {
1938
+ '200': "PagedResultOfQueryJobRevisionsResult",
1939
+ }
1940
+ response_data = self.api_client.call_api(
1941
+ *_param,
1942
+ _request_timeout=_request_timeout
1943
+ )
1944
+ return response_data.response
1945
+
1946
+
1947
+ def _job_definition_definition_id_revisions_get_serialize(
1948
+ self,
1949
+ definition_id,
1950
+ request,
1951
+ _request_auth,
1952
+ _content_type,
1953
+ _headers,
1954
+ _host_index,
1955
+ ) -> RequestSerialized:
1956
+
1957
+ _host = None
1958
+
1959
+ _collection_formats: Dict[str, str] = {
1960
+ }
1961
+
1962
+ _path_params: Dict[str, str] = {}
1963
+ _query_params: List[Tuple[str, str]] = []
1964
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1965
+ _form_params: List[Tuple[str, str]] = []
1966
+ _files: Dict[
1967
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1968
+ ] = {}
1969
+ _body_params: Optional[bytes] = None
1970
+
1971
+ # process the path parameters
1972
+ if definition_id is not None:
1973
+ _path_params['definitionId'] = definition_id
1974
+ # process the query parameters
1975
+ if request is not None:
1976
+
1977
+ _query_params.append(('request', request))
1978
+
1979
+ # process the header parameters
1980
+ # process the form parameters
1981
+ # process the body parameter
1982
+
1983
+
1984
+ # set the HTTP header `Accept`
1985
+ if 'Accept' not in _header_params:
1986
+ _header_params['Accept'] = self.api_client.select_header_accept(
1987
+ [
1988
+ 'text/plain',
1989
+ 'application/json',
1990
+ 'text/json'
1991
+ ]
1992
+ )
1993
+
1994
+
1995
+ # authentication setting
1996
+ _auth_settings: List[str] = [
1997
+ 'OAuth2',
1998
+ 'OpenIdConnect',
1999
+ 'Bearer'
2000
+ ]
2001
+
2002
+ return self.api_client.param_serialize(
2003
+ method='GET',
2004
+ resource_path='/job/definition/{definitionId}/revisions',
2005
+ path_params=_path_params,
2006
+ query_params=_query_params,
2007
+ header_params=_header_params,
2008
+ body=_body_params,
2009
+ post_params=_form_params,
2010
+ files=_files,
2011
+ auth_settings=_auth_settings,
2012
+ collection_formats=_collection_formats,
2013
+ _host=_host,
2014
+ _request_auth=_request_auth
2015
+ )
2016
+
2017
+
2018
+
2019
+
2020
+ @validate_call
2021
+ def job_definition_post(
2022
+ self,
2023
+ create_job_definition_endpoint_input: CreateJobDefinitionEndpointInput,
2024
+ _request_timeout: Union[
2025
+ None,
2026
+ Annotated[StrictFloat, Field(gt=0)],
2027
+ Tuple[
2028
+ Annotated[StrictFloat, Field(gt=0)],
2029
+ Annotated[StrictFloat, Field(gt=0)]
2030
+ ]
2031
+ ] = None,
2032
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2033
+ _content_type: Optional[StrictStr] = None,
2034
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2035
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2036
+ ) -> CreateJobDefinitionEndpointOutput:
2037
+ """Creates a new job definition.
2038
+
2039
+
2040
+ :param create_job_definition_endpoint_input: (required)
2041
+ :type create_job_definition_endpoint_input: CreateJobDefinitionEndpointInput
2042
+ :param _request_timeout: timeout setting for this request. If one
2043
+ number provided, it will be total request
2044
+ timeout. It can also be a pair (tuple) of
2045
+ (connection, read) timeouts.
2046
+ :type _request_timeout: int, tuple(int, int), optional
2047
+ :param _request_auth: set to override the auth_settings for an a single
2048
+ request; this effectively ignores the
2049
+ authentication in the spec for a single request.
2050
+ :type _request_auth: dict, optional
2051
+ :param _content_type: force content-type for the request.
2052
+ :type _content_type: str, Optional
2053
+ :param _headers: set to override the headers for a single
2054
+ request; this effectively ignores the headers
2055
+ in the spec for a single request.
2056
+ :type _headers: dict, optional
2057
+ :param _host_index: set to override the host_index for a single
2058
+ request; this effectively ignores the host_index
2059
+ in the spec for a single request.
2060
+ :type _host_index: int, optional
2061
+ :return: Returns the result object.
2062
+ """ # noqa: E501
2063
+
2064
+ _param = self._job_definition_post_serialize(
2065
+ create_job_definition_endpoint_input=create_job_definition_endpoint_input,
2066
+ _request_auth=_request_auth,
2067
+ _content_type=_content_type,
2068
+ _headers=_headers,
2069
+ _host_index=_host_index
2070
+ )
2071
+
2072
+ _response_types_map: Dict[str, Optional[str]] = {
2073
+ '200': "CreateJobDefinitionEndpointOutput",
2074
+ '400': "ValidationProblemDetails",
2075
+ '401': None,
2076
+ '403': None,
2077
+ }
2078
+ response_data = self.api_client.call_api(
2079
+ *_param,
2080
+ _request_timeout=_request_timeout
2081
+ )
2082
+ response_data.read()
2083
+ return self.api_client.response_deserialize(
2084
+ response_data=response_data,
2085
+ response_types_map=_response_types_map,
2086
+ ).data
2087
+
2088
+
2089
+ @validate_call
2090
+ def job_definition_post_with_http_info(
2091
+ self,
2092
+ create_job_definition_endpoint_input: CreateJobDefinitionEndpointInput,
2093
+ _request_timeout: Union[
2094
+ None,
2095
+ Annotated[StrictFloat, Field(gt=0)],
2096
+ Tuple[
2097
+ Annotated[StrictFloat, Field(gt=0)],
2098
+ Annotated[StrictFloat, Field(gt=0)]
2099
+ ]
2100
+ ] = None,
2101
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2102
+ _content_type: Optional[StrictStr] = None,
2103
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2104
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2105
+ ) -> ApiResponse[CreateJobDefinitionEndpointOutput]:
2106
+ """Creates a new job definition.
2107
+
2108
+
2109
+ :param create_job_definition_endpoint_input: (required)
2110
+ :type create_job_definition_endpoint_input: CreateJobDefinitionEndpointInput
2111
+ :param _request_timeout: timeout setting for this request. If one
2112
+ number provided, it will be total request
2113
+ timeout. It can also be a pair (tuple) of
2114
+ (connection, read) timeouts.
2115
+ :type _request_timeout: int, tuple(int, int), optional
2116
+ :param _request_auth: set to override the auth_settings for an a single
2117
+ request; this effectively ignores the
2118
+ authentication in the spec for a single request.
2119
+ :type _request_auth: dict, optional
2120
+ :param _content_type: force content-type for the request.
2121
+ :type _content_type: str, Optional
2122
+ :param _headers: set to override the headers for a single
2123
+ request; this effectively ignores the headers
2124
+ in the spec for a single request.
2125
+ :type _headers: dict, optional
2126
+ :param _host_index: set to override the host_index for a single
2127
+ request; this effectively ignores the host_index
2128
+ in the spec for a single request.
2129
+ :type _host_index: int, optional
2130
+ :return: Returns the result object.
2131
+ """ # noqa: E501
2132
+
2133
+ _param = self._job_definition_post_serialize(
2134
+ create_job_definition_endpoint_input=create_job_definition_endpoint_input,
2135
+ _request_auth=_request_auth,
2136
+ _content_type=_content_type,
2137
+ _headers=_headers,
2138
+ _host_index=_host_index
2139
+ )
2140
+
2141
+ _response_types_map: Dict[str, Optional[str]] = {
2142
+ '200': "CreateJobDefinitionEndpointOutput",
2143
+ '400': "ValidationProblemDetails",
2144
+ '401': None,
2145
+ '403': None,
2146
+ }
2147
+ response_data = self.api_client.call_api(
2148
+ *_param,
2149
+ _request_timeout=_request_timeout
2150
+ )
2151
+ response_data.read()
2152
+ return self.api_client.response_deserialize(
2153
+ response_data=response_data,
2154
+ response_types_map=_response_types_map,
2155
+ )
2156
+
2157
+
2158
+ @validate_call
2159
+ def job_definition_post_without_preload_content(
2160
+ self,
2161
+ create_job_definition_endpoint_input: CreateJobDefinitionEndpointInput,
2162
+ _request_timeout: Union[
2163
+ None,
2164
+ Annotated[StrictFloat, Field(gt=0)],
2165
+ Tuple[
2166
+ Annotated[StrictFloat, Field(gt=0)],
2167
+ Annotated[StrictFloat, Field(gt=0)]
2168
+ ]
2169
+ ] = None,
2170
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2171
+ _content_type: Optional[StrictStr] = None,
2172
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2173
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2174
+ ) -> RESTResponseType:
2175
+ """Creates a new job definition.
2176
+
2177
+
2178
+ :param create_job_definition_endpoint_input: (required)
2179
+ :type create_job_definition_endpoint_input: CreateJobDefinitionEndpointInput
2180
+ :param _request_timeout: timeout setting for this request. If one
2181
+ number provided, it will be total request
2182
+ timeout. It can also be a pair (tuple) of
2183
+ (connection, read) timeouts.
2184
+ :type _request_timeout: int, tuple(int, int), optional
2185
+ :param _request_auth: set to override the auth_settings for an a single
2186
+ request; this effectively ignores the
2187
+ authentication in the spec for a single request.
2188
+ :type _request_auth: dict, optional
2189
+ :param _content_type: force content-type for the request.
2190
+ :type _content_type: str, Optional
2191
+ :param _headers: set to override the headers for a single
2192
+ request; this effectively ignores the headers
2193
+ in the spec for a single request.
2194
+ :type _headers: dict, optional
2195
+ :param _host_index: set to override the host_index for a single
2196
+ request; this effectively ignores the host_index
2197
+ in the spec for a single request.
2198
+ :type _host_index: int, optional
2199
+ :return: Returns the result object.
2200
+ """ # noqa: E501
2201
+
2202
+ _param = self._job_definition_post_serialize(
2203
+ create_job_definition_endpoint_input=create_job_definition_endpoint_input,
2204
+ _request_auth=_request_auth,
2205
+ _content_type=_content_type,
2206
+ _headers=_headers,
2207
+ _host_index=_host_index
2208
+ )
2209
+
2210
+ _response_types_map: Dict[str, Optional[str]] = {
2211
+ '200': "CreateJobDefinitionEndpointOutput",
2212
+ '400': "ValidationProblemDetails",
2213
+ '401': None,
2214
+ '403': None,
2215
+ }
2216
+ response_data = self.api_client.call_api(
2217
+ *_param,
2218
+ _request_timeout=_request_timeout
2219
+ )
2220
+ return response_data.response
2221
+
2222
+
2223
+ def _job_definition_post_serialize(
2224
+ self,
2225
+ create_job_definition_endpoint_input,
2226
+ _request_auth,
2227
+ _content_type,
2228
+ _headers,
2229
+ _host_index,
2230
+ ) -> RequestSerialized:
2231
+
2232
+ _host = None
2233
+
2234
+ _collection_formats: Dict[str, str] = {
2235
+ }
2236
+
2237
+ _path_params: Dict[str, str] = {}
2238
+ _query_params: List[Tuple[str, str]] = []
2239
+ _header_params: Dict[str, Optional[str]] = _headers or {}
2240
+ _form_params: List[Tuple[str, str]] = []
2241
+ _files: Dict[
2242
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
2243
+ ] = {}
2244
+ _body_params: Optional[bytes] = None
2245
+
2246
+ # process the path parameters
2247
+ # process the query parameters
2248
+ # process the header parameters
2249
+ # process the form parameters
2250
+ # process the body parameter
2251
+ if create_job_definition_endpoint_input is not None:
2252
+ _body_params = create_job_definition_endpoint_input
2253
+
2254
+
2255
+ # set the HTTP header `Accept`
2256
+ if 'Accept' not in _header_params:
2257
+ _header_params['Accept'] = self.api_client.select_header_accept(
2258
+ [
2259
+ 'application/json'
2260
+ ]
2261
+ )
2262
+
2263
+ # set the HTTP header `Content-Type`
2264
+ if _content_type:
2265
+ _header_params['Content-Type'] = _content_type
2266
+ else:
2267
+ _default_content_type = (
2268
+ self.api_client.select_header_content_type(
2269
+ [
2270
+ 'application/json'
2271
+ ]
2272
+ )
2273
+ )
2274
+ if _default_content_type is not None:
2275
+ _header_params['Content-Type'] = _default_content_type
2276
+
2277
+ # authentication setting
2278
+ _auth_settings: List[str] = [
2279
+ 'OAuth2',
2280
+ 'OpenIdConnect',
2281
+ 'Bearer'
2282
+ ]
2283
+
2284
+ return self.api_client.param_serialize(
2285
+ method='POST',
2286
+ resource_path='/job/definition',
2287
+ path_params=_path_params,
2288
+ query_params=_query_params,
2289
+ header_params=_header_params,
2290
+ body=_body_params,
2291
+ post_params=_form_params,
2292
+ files=_files,
2293
+ auth_settings=_auth_settings,
2294
+ collection_formats=_collection_formats,
2295
+ _host=_host,
2296
+ _request_auth=_request_auth
2297
+ )
2298
+
2299
+
2300
+
2301
+
2302
+ @validate_call
2303
+ def job_definitions_get(
2304
+ self,
2305
+ request: Annotated[Optional[QueryModel], Field(description="The parameters for filtering, paging, and sorting")] = None,
2306
+ _request_timeout: Union[
2307
+ None,
2308
+ Annotated[StrictFloat, Field(gt=0)],
2309
+ Tuple[
2310
+ Annotated[StrictFloat, Field(gt=0)],
2311
+ Annotated[StrictFloat, Field(gt=0)]
2312
+ ]
2313
+ ] = None,
2314
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2315
+ _content_type: Optional[StrictStr] = None,
2316
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2317
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2318
+ ) -> PagedResultOfQueryJobDefinitionsResult:
2319
+ """Queries job definitions based on filter, page, and sort criteria.
2320
+
2321
+
2322
+ :param request: The parameters for filtering, paging, and sorting
2323
+ :type request: QueryModel
2324
+ :param _request_timeout: timeout setting for this request. If one
2325
+ number provided, it will be total request
2326
+ timeout. It can also be a pair (tuple) of
2327
+ (connection, read) timeouts.
2328
+ :type _request_timeout: int, tuple(int, int), optional
2329
+ :param _request_auth: set to override the auth_settings for an a single
2330
+ request; this effectively ignores the
2331
+ authentication in the spec for a single request.
2332
+ :type _request_auth: dict, optional
2333
+ :param _content_type: force content-type for the request.
2334
+ :type _content_type: str, Optional
2335
+ :param _headers: set to override the headers for a single
2336
+ request; this effectively ignores the headers
2337
+ in the spec for a single request.
2338
+ :type _headers: dict, optional
2339
+ :param _host_index: set to override the host_index for a single
2340
+ request; this effectively ignores the host_index
2341
+ in the spec for a single request.
2342
+ :type _host_index: int, optional
2343
+ :return: Returns the result object.
2344
+ """ # noqa: E501
2345
+
2346
+ _param = self._job_definitions_get_serialize(
2347
+ request=request,
2348
+ _request_auth=_request_auth,
2349
+ _content_type=_content_type,
2350
+ _headers=_headers,
2351
+ _host_index=_host_index
2352
+ )
2353
+
2354
+ _response_types_map: Dict[str, Optional[str]] = {
2355
+ '200': "PagedResultOfQueryJobDefinitionsResult",
2356
+ }
2357
+ response_data = self.api_client.call_api(
2358
+ *_param,
2359
+ _request_timeout=_request_timeout
2360
+ )
2361
+ response_data.read()
2362
+ return self.api_client.response_deserialize(
2363
+ response_data=response_data,
2364
+ response_types_map=_response_types_map,
2365
+ ).data
2366
+
2367
+
2368
+ @validate_call
2369
+ def job_definitions_get_with_http_info(
2370
+ self,
2371
+ request: Annotated[Optional[QueryModel], Field(description="The parameters for filtering, paging, and sorting")] = None,
2372
+ _request_timeout: Union[
2373
+ None,
2374
+ Annotated[StrictFloat, Field(gt=0)],
2375
+ Tuple[
2376
+ Annotated[StrictFloat, Field(gt=0)],
2377
+ Annotated[StrictFloat, Field(gt=0)]
2378
+ ]
2379
+ ] = None,
2380
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2381
+ _content_type: Optional[StrictStr] = None,
2382
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2383
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2384
+ ) -> ApiResponse[PagedResultOfQueryJobDefinitionsResult]:
2385
+ """Queries job definitions based on filter, page, and sort criteria.
2386
+
2387
+
2388
+ :param request: The parameters for filtering, paging, and sorting
2389
+ :type request: QueryModel
2390
+ :param _request_timeout: timeout setting for this request. If one
2391
+ number provided, it will be total request
2392
+ timeout. It can also be a pair (tuple) of
2393
+ (connection, read) timeouts.
2394
+ :type _request_timeout: int, tuple(int, int), optional
2395
+ :param _request_auth: set to override the auth_settings for an a single
2396
+ request; this effectively ignores the
2397
+ authentication in the spec for a single request.
2398
+ :type _request_auth: dict, optional
2399
+ :param _content_type: force content-type for the request.
2400
+ :type _content_type: str, Optional
2401
+ :param _headers: set to override the headers for a single
2402
+ request; this effectively ignores the headers
2403
+ in the spec for a single request.
2404
+ :type _headers: dict, optional
2405
+ :param _host_index: set to override the host_index for a single
2406
+ request; this effectively ignores the host_index
2407
+ in the spec for a single request.
2408
+ :type _host_index: int, optional
2409
+ :return: Returns the result object.
2410
+ """ # noqa: E501
2411
+
2412
+ _param = self._job_definitions_get_serialize(
2413
+ request=request,
2414
+ _request_auth=_request_auth,
2415
+ _content_type=_content_type,
2416
+ _headers=_headers,
2417
+ _host_index=_host_index
2418
+ )
2419
+
2420
+ _response_types_map: Dict[str, Optional[str]] = {
2421
+ '200': "PagedResultOfQueryJobDefinitionsResult",
2422
+ }
2423
+ response_data = self.api_client.call_api(
2424
+ *_param,
2425
+ _request_timeout=_request_timeout
2426
+ )
2427
+ response_data.read()
2428
+ return self.api_client.response_deserialize(
2429
+ response_data=response_data,
2430
+ response_types_map=_response_types_map,
2431
+ )
2432
+
2433
+
2434
+ @validate_call
2435
+ def job_definitions_get_without_preload_content(
2436
+ self,
2437
+ request: Annotated[Optional[QueryModel], Field(description="The parameters for filtering, paging, and sorting")] = None,
2438
+ _request_timeout: Union[
2439
+ None,
2440
+ Annotated[StrictFloat, Field(gt=0)],
2441
+ Tuple[
2442
+ Annotated[StrictFloat, Field(gt=0)],
2443
+ Annotated[StrictFloat, Field(gt=0)]
2444
+ ]
2445
+ ] = None,
2446
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2447
+ _content_type: Optional[StrictStr] = None,
2448
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2449
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2450
+ ) -> RESTResponseType:
2451
+ """Queries job definitions based on filter, page, and sort criteria.
2452
+
2453
+
2454
+ :param request: The parameters for filtering, paging, and sorting
2455
+ :type request: QueryModel
2456
+ :param _request_timeout: timeout setting for this request. If one
2457
+ number provided, it will be total request
2458
+ timeout. It can also be a pair (tuple) of
2459
+ (connection, read) timeouts.
2460
+ :type _request_timeout: int, tuple(int, int), optional
2461
+ :param _request_auth: set to override the auth_settings for an a single
2462
+ request; this effectively ignores the
2463
+ authentication in the spec for a single request.
2464
+ :type _request_auth: dict, optional
2465
+ :param _content_type: force content-type for the request.
2466
+ :type _content_type: str, Optional
2467
+ :param _headers: set to override the headers for a single
2468
+ request; this effectively ignores the headers
2469
+ in the spec for a single request.
2470
+ :type _headers: dict, optional
2471
+ :param _host_index: set to override the host_index for a single
2472
+ request; this effectively ignores the host_index
2473
+ in the spec for a single request.
2474
+ :type _host_index: int, optional
2475
+ :return: Returns the result object.
2476
+ """ # noqa: E501
2477
+
2478
+ _param = self._job_definitions_get_serialize(
2479
+ request=request,
2480
+ _request_auth=_request_auth,
2481
+ _content_type=_content_type,
2482
+ _headers=_headers,
2483
+ _host_index=_host_index
2484
+ )
2485
+
2486
+ _response_types_map: Dict[str, Optional[str]] = {
2487
+ '200': "PagedResultOfQueryJobDefinitionsResult",
2488
+ }
2489
+ response_data = self.api_client.call_api(
2490
+ *_param,
2491
+ _request_timeout=_request_timeout
2492
+ )
2493
+ return response_data.response
2494
+
2495
+
2496
+ def _job_definitions_get_serialize(
2497
+ self,
2498
+ request,
2499
+ _request_auth,
2500
+ _content_type,
2501
+ _headers,
2502
+ _host_index,
2503
+ ) -> RequestSerialized:
2504
+
2505
+ _host = None
2506
+
2507
+ _collection_formats: Dict[str, str] = {
2508
+ }
2509
+
2510
+ _path_params: Dict[str, str] = {}
2511
+ _query_params: List[Tuple[str, str]] = []
2512
+ _header_params: Dict[str, Optional[str]] = _headers or {}
2513
+ _form_params: List[Tuple[str, str]] = []
2514
+ _files: Dict[
2515
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
2516
+ ] = {}
2517
+ _body_params: Optional[bytes] = None
2518
+
2519
+ # process the path parameters
2520
+ # process the query parameters
2521
+ if request is not None:
2522
+
2523
+ _query_params.append(('request', request))
2524
+
2525
+ # process the header parameters
2526
+ # process the form parameters
2527
+ # process the body parameter
2528
+
2529
+
2530
+ # set the HTTP header `Accept`
2531
+ if 'Accept' not in _header_params:
2532
+ _header_params['Accept'] = self.api_client.select_header_accept(
2533
+ [
2534
+ 'text/plain',
2535
+ 'application/json',
2536
+ 'text/json'
2537
+ ]
2538
+ )
2539
+
2540
+
2541
+ # authentication setting
2542
+ _auth_settings: List[str] = [
2543
+ 'OAuth2',
2544
+ 'OpenIdConnect',
2545
+ 'Bearer'
2546
+ ]
2547
+
2548
+ return self.api_client.param_serialize(
2549
+ method='GET',
2550
+ resource_path='/job/definitions',
2551
+ path_params=_path_params,
2552
+ query_params=_query_params,
2553
+ header_params=_header_params,
2554
+ body=_body_params,
2555
+ post_params=_form_params,
2556
+ files=_files,
2557
+ auth_settings=_auth_settings,
2558
+ collection_formats=_collection_formats,
2559
+ _host=_host,
2560
+ _request_auth=_request_auth
2561
+ )
2562
+
2563
+
2564
+
2565
+
2566
+ @validate_call
2567
+ def job_job_id_download_results_get(
2568
+ self,
2569
+ job_id: StrictStr,
2570
+ _request_timeout: Union[
2571
+ None,
2572
+ Annotated[StrictFloat, Field(gt=0)],
2573
+ Tuple[
2574
+ Annotated[StrictFloat, Field(gt=0)],
2575
+ Annotated[StrictFloat, Field(gt=0)]
2576
+ ]
2577
+ ] = None,
2578
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2579
+ _content_type: Optional[StrictStr] = None,
2580
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2581
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2582
+ ) -> None:
2583
+ """Downloads the results of a job as a file attachment.
2584
+
2585
+
2586
+ :param job_id: (required)
2587
+ :type job_id: str
2588
+ :param _request_timeout: timeout setting for this request. If one
2589
+ number provided, it will be total request
2590
+ timeout. It can also be a pair (tuple) of
2591
+ (connection, read) timeouts.
2592
+ :type _request_timeout: int, tuple(int, int), optional
2593
+ :param _request_auth: set to override the auth_settings for an a single
2594
+ request; this effectively ignores the
2595
+ authentication in the spec for a single request.
2596
+ :type _request_auth: dict, optional
2597
+ :param _content_type: force content-type for the request.
2598
+ :type _content_type: str, Optional
2599
+ :param _headers: set to override the headers for a single
2600
+ request; this effectively ignores the headers
2601
+ in the spec for a single request.
2602
+ :type _headers: dict, optional
2603
+ :param _host_index: set to override the host_index for a single
2604
+ request; this effectively ignores the host_index
2605
+ in the spec for a single request.
2606
+ :type _host_index: int, optional
2607
+ :return: Returns the result object.
2608
+ """ # noqa: E501
2609
+
2610
+ _param = self._job_job_id_download_results_get_serialize(
2611
+ job_id=job_id,
2612
+ _request_auth=_request_auth,
2613
+ _content_type=_content_type,
2614
+ _headers=_headers,
2615
+ _host_index=_host_index
2616
+ )
2617
+
2618
+ _response_types_map: Dict[str, Optional[str]] = {
2619
+ '200': None,
2620
+ '401': None,
2621
+ '403': None,
2622
+ }
2623
+ response_data = self.api_client.call_api(
2624
+ *_param,
2625
+ _request_timeout=_request_timeout
2626
+ )
2627
+ response_data.read()
2628
+ return self.api_client.response_deserialize(
2629
+ response_data=response_data,
2630
+ response_types_map=_response_types_map,
2631
+ ).data
2632
+
2633
+
2634
+ @validate_call
2635
+ def job_job_id_download_results_get_with_http_info(
2636
+ self,
2637
+ job_id: StrictStr,
2638
+ _request_timeout: Union[
2639
+ None,
2640
+ Annotated[StrictFloat, Field(gt=0)],
2641
+ Tuple[
2642
+ Annotated[StrictFloat, Field(gt=0)],
2643
+ Annotated[StrictFloat, Field(gt=0)]
2644
+ ]
2645
+ ] = None,
2646
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2647
+ _content_type: Optional[StrictStr] = None,
2648
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2649
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2650
+ ) -> ApiResponse[None]:
2651
+ """Downloads the results of a job as a file attachment.
2652
+
2653
+
2654
+ :param job_id: (required)
2655
+ :type job_id: str
2656
+ :param _request_timeout: timeout setting for this request. If one
2657
+ number provided, it will be total request
2658
+ timeout. It can also be a pair (tuple) of
2659
+ (connection, read) timeouts.
2660
+ :type _request_timeout: int, tuple(int, int), optional
2661
+ :param _request_auth: set to override the auth_settings for an a single
2662
+ request; this effectively ignores the
2663
+ authentication in the spec for a single request.
2664
+ :type _request_auth: dict, optional
2665
+ :param _content_type: force content-type for the request.
2666
+ :type _content_type: str, Optional
2667
+ :param _headers: set to override the headers for a single
2668
+ request; this effectively ignores the headers
2669
+ in the spec for a single request.
2670
+ :type _headers: dict, optional
2671
+ :param _host_index: set to override the host_index for a single
2672
+ request; this effectively ignores the host_index
2673
+ in the spec for a single request.
2674
+ :type _host_index: int, optional
2675
+ :return: Returns the result object.
2676
+ """ # noqa: E501
2677
+
2678
+ _param = self._job_job_id_download_results_get_serialize(
2679
+ job_id=job_id,
2680
+ _request_auth=_request_auth,
2681
+ _content_type=_content_type,
2682
+ _headers=_headers,
2683
+ _host_index=_host_index
2684
+ )
2685
+
2686
+ _response_types_map: Dict[str, Optional[str]] = {
2687
+ '200': None,
2688
+ '401': None,
2689
+ '403': None,
2690
+ }
2691
+ response_data = self.api_client.call_api(
2692
+ *_param,
2693
+ _request_timeout=_request_timeout
2694
+ )
2695
+ response_data.read()
2696
+ return self.api_client.response_deserialize(
2697
+ response_data=response_data,
2698
+ response_types_map=_response_types_map,
2699
+ )
2700
+
2701
+
2702
+ @validate_call
2703
+ def job_job_id_download_results_get_without_preload_content(
2704
+ self,
2705
+ job_id: StrictStr,
2706
+ _request_timeout: Union[
2707
+ None,
2708
+ Annotated[StrictFloat, Field(gt=0)],
2709
+ Tuple[
2710
+ Annotated[StrictFloat, Field(gt=0)],
2711
+ Annotated[StrictFloat, Field(gt=0)]
2712
+ ]
2713
+ ] = None,
2714
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2715
+ _content_type: Optional[StrictStr] = None,
2716
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2717
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2718
+ ) -> RESTResponseType:
2719
+ """Downloads the results of a job as a file attachment.
2720
+
2721
+
2722
+ :param job_id: (required)
2723
+ :type job_id: str
2724
+ :param _request_timeout: timeout setting for this request. If one
2725
+ number provided, it will be total request
2726
+ timeout. It can also be a pair (tuple) of
2727
+ (connection, read) timeouts.
2728
+ :type _request_timeout: int, tuple(int, int), optional
2729
+ :param _request_auth: set to override the auth_settings for an a single
2730
+ request; this effectively ignores the
2731
+ authentication in the spec for a single request.
2732
+ :type _request_auth: dict, optional
2733
+ :param _content_type: force content-type for the request.
2734
+ :type _content_type: str, Optional
2735
+ :param _headers: set to override the headers for a single
2736
+ request; this effectively ignores the headers
2737
+ in the spec for a single request.
2738
+ :type _headers: dict, optional
2739
+ :param _host_index: set to override the host_index for a single
2740
+ request; this effectively ignores the host_index
2741
+ in the spec for a single request.
2742
+ :type _host_index: int, optional
2743
+ :return: Returns the result object.
2744
+ """ # noqa: E501
2745
+
2746
+ _param = self._job_job_id_download_results_get_serialize(
2747
+ job_id=job_id,
2748
+ _request_auth=_request_auth,
2749
+ _content_type=_content_type,
2750
+ _headers=_headers,
2751
+ _host_index=_host_index
2752
+ )
2753
+
2754
+ _response_types_map: Dict[str, Optional[str]] = {
2755
+ '200': None,
2756
+ '401': None,
2757
+ '403': None,
2758
+ }
2759
+ response_data = self.api_client.call_api(
2760
+ *_param,
2761
+ _request_timeout=_request_timeout
2762
+ )
2763
+ return response_data.response
2764
+
2765
+
2766
+ def _job_job_id_download_results_get_serialize(
2767
+ self,
2768
+ job_id,
2769
+ _request_auth,
2770
+ _content_type,
2771
+ _headers,
2772
+ _host_index,
2773
+ ) -> RequestSerialized:
2774
+
2775
+ _host = None
2776
+
2777
+ _collection_formats: Dict[str, str] = {
2778
+ }
2779
+
2780
+ _path_params: Dict[str, str] = {}
2781
+ _query_params: List[Tuple[str, str]] = []
2782
+ _header_params: Dict[str, Optional[str]] = _headers or {}
2783
+ _form_params: List[Tuple[str, str]] = []
2784
+ _files: Dict[
2785
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
2786
+ ] = {}
2787
+ _body_params: Optional[bytes] = None
2788
+
2789
+ # process the path parameters
2790
+ if job_id is not None:
2791
+ _path_params['jobId'] = job_id
2792
+ # process the query parameters
2793
+ # process the header parameters
2794
+ # process the form parameters
2795
+ # process the body parameter
2796
+
2797
+
2798
+
2799
+
2800
+ # authentication setting
2801
+ _auth_settings: List[str] = [
2802
+ 'OAuth2',
2803
+ 'OpenIdConnect',
2804
+ 'Bearer'
2805
+ ]
2806
+
2807
+ return self.api_client.param_serialize(
2808
+ method='GET',
2809
+ resource_path='/job/{jobId}/download-results',
2810
+ path_params=_path_params,
2811
+ query_params=_query_params,
2812
+ header_params=_header_params,
2813
+ body=_body_params,
2814
+ post_params=_form_params,
2815
+ files=_files,
2816
+ auth_settings=_auth_settings,
2817
+ collection_formats=_collection_formats,
2818
+ _host=_host,
2819
+ _request_auth=_request_auth
2820
+ )
2821
+
2822
+
2823
+
2824
+
2825
+ @validate_call
2826
+ def job_job_id_get(
2827
+ self,
2828
+ job_id: StrictStr,
2829
+ _request_timeout: Union[
2830
+ None,
2831
+ Annotated[StrictFloat, Field(gt=0)],
2832
+ Tuple[
2833
+ Annotated[StrictFloat, Field(gt=0)],
2834
+ Annotated[StrictFloat, Field(gt=0)]
2835
+ ]
2836
+ ] = None,
2837
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2838
+ _content_type: Optional[StrictStr] = None,
2839
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2840
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2841
+ ) -> GetJobByIdEndpointOutput:
2842
+ """Gets a job by its id.
2843
+
2844
+
2845
+ :param job_id: (required)
2846
+ :type job_id: str
2847
+ :param _request_timeout: timeout setting for this request. If one
2848
+ number provided, it will be total request
2849
+ timeout. It can also be a pair (tuple) of
2850
+ (connection, read) timeouts.
2851
+ :type _request_timeout: int, tuple(int, int), optional
2852
+ :param _request_auth: set to override the auth_settings for an a single
2853
+ request; this effectively ignores the
2854
+ authentication in the spec for a single request.
2855
+ :type _request_auth: dict, optional
2856
+ :param _content_type: force content-type for the request.
2857
+ :type _content_type: str, Optional
2858
+ :param _headers: set to override the headers for a single
2859
+ request; this effectively ignores the headers
2860
+ in the spec for a single request.
2861
+ :type _headers: dict, optional
2862
+ :param _host_index: set to override the host_index for a single
2863
+ request; this effectively ignores the host_index
2864
+ in the spec for a single request.
2865
+ :type _host_index: int, optional
2866
+ :return: Returns the result object.
2867
+ """ # noqa: E501
2868
+
2869
+ _param = self._job_job_id_get_serialize(
2870
+ job_id=job_id,
2871
+ _request_auth=_request_auth,
2872
+ _content_type=_content_type,
2873
+ _headers=_headers,
2874
+ _host_index=_host_index
2875
+ )
2876
+
2877
+ _response_types_map: Dict[str, Optional[str]] = {
2878
+ '200': "GetJobByIdEndpointOutput",
2879
+ '400': "ValidationProblemDetails",
2880
+ '401': None,
2881
+ '403': None,
2882
+ }
2883
+ response_data = self.api_client.call_api(
2884
+ *_param,
2885
+ _request_timeout=_request_timeout
2886
+ )
2887
+ response_data.read()
2888
+ return self.api_client.response_deserialize(
2889
+ response_data=response_data,
2890
+ response_types_map=_response_types_map,
2891
+ ).data
2892
+
2893
+
2894
+ @validate_call
2895
+ def job_job_id_get_with_http_info(
2896
+ self,
2897
+ job_id: StrictStr,
2898
+ _request_timeout: Union[
2899
+ None,
2900
+ Annotated[StrictFloat, Field(gt=0)],
2901
+ Tuple[
2902
+ Annotated[StrictFloat, Field(gt=0)],
2903
+ Annotated[StrictFloat, Field(gt=0)]
2904
+ ]
2905
+ ] = None,
2906
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2907
+ _content_type: Optional[StrictStr] = None,
2908
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2909
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2910
+ ) -> ApiResponse[GetJobByIdEndpointOutput]:
2911
+ """Gets a job by its id.
2912
+
2913
+
2914
+ :param job_id: (required)
2915
+ :type job_id: str
2916
+ :param _request_timeout: timeout setting for this request. If one
2917
+ number provided, it will be total request
2918
+ timeout. It can also be a pair (tuple) of
2919
+ (connection, read) timeouts.
2920
+ :type _request_timeout: int, tuple(int, int), optional
2921
+ :param _request_auth: set to override the auth_settings for an a single
2922
+ request; this effectively ignores the
2923
+ authentication in the spec for a single request.
2924
+ :type _request_auth: dict, optional
2925
+ :param _content_type: force content-type for the request.
2926
+ :type _content_type: str, Optional
2927
+ :param _headers: set to override the headers for a single
2928
+ request; this effectively ignores the headers
2929
+ in the spec for a single request.
2930
+ :type _headers: dict, optional
2931
+ :param _host_index: set to override the host_index for a single
2932
+ request; this effectively ignores the host_index
2933
+ in the spec for a single request.
2934
+ :type _host_index: int, optional
2935
+ :return: Returns the result object.
2936
+ """ # noqa: E501
2937
+
2938
+ _param = self._job_job_id_get_serialize(
2939
+ job_id=job_id,
2940
+ _request_auth=_request_auth,
2941
+ _content_type=_content_type,
2942
+ _headers=_headers,
2943
+ _host_index=_host_index
2944
+ )
2945
+
2946
+ _response_types_map: Dict[str, Optional[str]] = {
2947
+ '200': "GetJobByIdEndpointOutput",
2948
+ '400': "ValidationProblemDetails",
2949
+ '401': None,
2950
+ '403': None,
2951
+ }
2952
+ response_data = self.api_client.call_api(
2953
+ *_param,
2954
+ _request_timeout=_request_timeout
2955
+ )
2956
+ response_data.read()
2957
+ return self.api_client.response_deserialize(
2958
+ response_data=response_data,
2959
+ response_types_map=_response_types_map,
2960
+ )
2961
+
2962
+
2963
+ @validate_call
2964
+ def job_job_id_get_without_preload_content(
2965
+ self,
2966
+ job_id: StrictStr,
2967
+ _request_timeout: Union[
2968
+ None,
2969
+ Annotated[StrictFloat, Field(gt=0)],
2970
+ Tuple[
2971
+ Annotated[StrictFloat, Field(gt=0)],
2972
+ Annotated[StrictFloat, Field(gt=0)]
2973
+ ]
2974
+ ] = None,
2975
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2976
+ _content_type: Optional[StrictStr] = None,
2977
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2978
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2979
+ ) -> RESTResponseType:
2980
+ """Gets a job by its id.
2981
+
2982
+
2983
+ :param job_id: (required)
2984
+ :type job_id: str
2985
+ :param _request_timeout: timeout setting for this request. If one
2986
+ number provided, it will be total request
2987
+ timeout. It can also be a pair (tuple) of
2988
+ (connection, read) timeouts.
2989
+ :type _request_timeout: int, tuple(int, int), optional
2990
+ :param _request_auth: set to override the auth_settings for an a single
2991
+ request; this effectively ignores the
2992
+ authentication in the spec for a single request.
2993
+ :type _request_auth: dict, optional
2994
+ :param _content_type: force content-type for the request.
2995
+ :type _content_type: str, Optional
2996
+ :param _headers: set to override the headers for a single
2997
+ request; this effectively ignores the headers
2998
+ in the spec for a single request.
2999
+ :type _headers: dict, optional
3000
+ :param _host_index: set to override the host_index for a single
3001
+ request; this effectively ignores the host_index
3002
+ in the spec for a single request.
3003
+ :type _host_index: int, optional
3004
+ :return: Returns the result object.
3005
+ """ # noqa: E501
3006
+
3007
+ _param = self._job_job_id_get_serialize(
3008
+ job_id=job_id,
3009
+ _request_auth=_request_auth,
3010
+ _content_type=_content_type,
3011
+ _headers=_headers,
3012
+ _host_index=_host_index
3013
+ )
3014
+
3015
+ _response_types_map: Dict[str, Optional[str]] = {
3016
+ '200': "GetJobByIdEndpointOutput",
3017
+ '400': "ValidationProblemDetails",
3018
+ '401': None,
3019
+ '403': None,
3020
+ }
3021
+ response_data = self.api_client.call_api(
3022
+ *_param,
3023
+ _request_timeout=_request_timeout
3024
+ )
3025
+ return response_data.response
3026
+
3027
+
3028
+ def _job_job_id_get_serialize(
3029
+ self,
3030
+ job_id,
3031
+ _request_auth,
3032
+ _content_type,
3033
+ _headers,
3034
+ _host_index,
3035
+ ) -> RequestSerialized:
3036
+
3037
+ _host = None
3038
+
3039
+ _collection_formats: Dict[str, str] = {
3040
+ }
3041
+
3042
+ _path_params: Dict[str, str] = {}
3043
+ _query_params: List[Tuple[str, str]] = []
3044
+ _header_params: Dict[str, Optional[str]] = _headers or {}
3045
+ _form_params: List[Tuple[str, str]] = []
3046
+ _files: Dict[
3047
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
3048
+ ] = {}
3049
+ _body_params: Optional[bytes] = None
3050
+
3051
+ # process the path parameters
3052
+ if job_id is not None:
3053
+ _path_params['jobId'] = job_id
3054
+ # process the query parameters
3055
+ # process the header parameters
3056
+ # process the form parameters
3057
+ # process the body parameter
3058
+
3059
+
3060
+ # set the HTTP header `Accept`
3061
+ if 'Accept' not in _header_params:
3062
+ _header_params['Accept'] = self.api_client.select_header_accept(
3063
+ [
3064
+ 'application/json'
3065
+ ]
3066
+ )
3067
+
3068
+
3069
+ # authentication setting
3070
+ _auth_settings: List[str] = [
3071
+ 'OAuth2',
3072
+ 'OpenIdConnect',
3073
+ 'Bearer'
3074
+ ]
3075
+
3076
+ return self.api_client.param_serialize(
3077
+ method='GET',
3078
+ resource_path='/job/{jobId}',
3079
+ path_params=_path_params,
3080
+ query_params=_query_params,
3081
+ header_params=_header_params,
3082
+ body=_body_params,
3083
+ post_params=_form_params,
3084
+ files=_files,
3085
+ auth_settings=_auth_settings,
3086
+ collection_formats=_collection_formats,
3087
+ _host=_host,
3088
+ _request_auth=_request_auth
3089
+ )
3090
+
3091
+
3092
+
3093
+
3094
+ @validate_call
3095
+ def job_job_id_patch(
3096
+ self,
3097
+ job_id: StrictStr,
3098
+ update_job_endpoint_input: UpdateJobEndpointInput,
3099
+ _request_timeout: Union[
3100
+ None,
3101
+ Annotated[StrictFloat, Field(gt=0)],
3102
+ Tuple[
3103
+ Annotated[StrictFloat, Field(gt=0)],
3104
+ Annotated[StrictFloat, Field(gt=0)]
3105
+ ]
3106
+ ] = None,
3107
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3108
+ _content_type: Optional[StrictStr] = None,
3109
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3110
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3111
+ ) -> None:
3112
+ """Updates a job.
3113
+
3114
+
3115
+ :param job_id: (required)
3116
+ :type job_id: str
3117
+ :param update_job_endpoint_input: (required)
3118
+ :type update_job_endpoint_input: UpdateJobEndpointInput
3119
+ :param _request_timeout: timeout setting for this request. If one
3120
+ number provided, it will be total request
3121
+ timeout. It can also be a pair (tuple) of
3122
+ (connection, read) timeouts.
3123
+ :type _request_timeout: int, tuple(int, int), optional
3124
+ :param _request_auth: set to override the auth_settings for an a single
3125
+ request; this effectively ignores the
3126
+ authentication in the spec for a single request.
3127
+ :type _request_auth: dict, optional
3128
+ :param _content_type: force content-type for the request.
3129
+ :type _content_type: str, Optional
3130
+ :param _headers: set to override the headers for a single
3131
+ request; this effectively ignores the headers
3132
+ in the spec for a single request.
3133
+ :type _headers: dict, optional
3134
+ :param _host_index: set to override the host_index for a single
3135
+ request; this effectively ignores the host_index
3136
+ in the spec for a single request.
3137
+ :type _host_index: int, optional
3138
+ :return: Returns the result object.
3139
+ """ # noqa: E501
3140
+
3141
+ _param = self._job_job_id_patch_serialize(
3142
+ job_id=job_id,
3143
+ update_job_endpoint_input=update_job_endpoint_input,
3144
+ _request_auth=_request_auth,
3145
+ _content_type=_content_type,
3146
+ _headers=_headers,
3147
+ _host_index=_host_index
3148
+ )
3149
+
3150
+ _response_types_map: Dict[str, Optional[str]] = {
3151
+ '204': None,
3152
+ '400': "ValidationProblemDetails",
3153
+ '401': None,
3154
+ '403': None,
3155
+ }
3156
+ response_data = self.api_client.call_api(
3157
+ *_param,
3158
+ _request_timeout=_request_timeout
3159
+ )
3160
+ response_data.read()
3161
+ return self.api_client.response_deserialize(
3162
+ response_data=response_data,
3163
+ response_types_map=_response_types_map,
3164
+ ).data
3165
+
3166
+
3167
+ @validate_call
3168
+ def job_job_id_patch_with_http_info(
3169
+ self,
3170
+ job_id: StrictStr,
3171
+ update_job_endpoint_input: UpdateJobEndpointInput,
3172
+ _request_timeout: Union[
3173
+ None,
3174
+ Annotated[StrictFloat, Field(gt=0)],
3175
+ Tuple[
3176
+ Annotated[StrictFloat, Field(gt=0)],
3177
+ Annotated[StrictFloat, Field(gt=0)]
3178
+ ]
3179
+ ] = None,
3180
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3181
+ _content_type: Optional[StrictStr] = None,
3182
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3183
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3184
+ ) -> ApiResponse[None]:
3185
+ """Updates a job.
3186
+
3187
+
3188
+ :param job_id: (required)
3189
+ :type job_id: str
3190
+ :param update_job_endpoint_input: (required)
3191
+ :type update_job_endpoint_input: UpdateJobEndpointInput
3192
+ :param _request_timeout: timeout setting for this request. If one
3193
+ number provided, it will be total request
3194
+ timeout. It can also be a pair (tuple) of
3195
+ (connection, read) timeouts.
3196
+ :type _request_timeout: int, tuple(int, int), optional
3197
+ :param _request_auth: set to override the auth_settings for an a single
3198
+ request; this effectively ignores the
3199
+ authentication in the spec for a single request.
3200
+ :type _request_auth: dict, optional
3201
+ :param _content_type: force content-type for the request.
3202
+ :type _content_type: str, Optional
3203
+ :param _headers: set to override the headers for a single
3204
+ request; this effectively ignores the headers
3205
+ in the spec for a single request.
3206
+ :type _headers: dict, optional
3207
+ :param _host_index: set to override the host_index for a single
3208
+ request; this effectively ignores the host_index
3209
+ in the spec for a single request.
3210
+ :type _host_index: int, optional
3211
+ :return: Returns the result object.
3212
+ """ # noqa: E501
3213
+
3214
+ _param = self._job_job_id_patch_serialize(
3215
+ job_id=job_id,
3216
+ update_job_endpoint_input=update_job_endpoint_input,
3217
+ _request_auth=_request_auth,
3218
+ _content_type=_content_type,
3219
+ _headers=_headers,
3220
+ _host_index=_host_index
3221
+ )
3222
+
3223
+ _response_types_map: Dict[str, Optional[str]] = {
3224
+ '204': None,
3225
+ '400': "ValidationProblemDetails",
3226
+ '401': None,
3227
+ '403': None,
3228
+ }
3229
+ response_data = self.api_client.call_api(
3230
+ *_param,
3231
+ _request_timeout=_request_timeout
3232
+ )
3233
+ response_data.read()
3234
+ return self.api_client.response_deserialize(
3235
+ response_data=response_data,
3236
+ response_types_map=_response_types_map,
3237
+ )
3238
+
3239
+
3240
+ @validate_call
3241
+ def job_job_id_patch_without_preload_content(
3242
+ self,
3243
+ job_id: StrictStr,
3244
+ update_job_endpoint_input: UpdateJobEndpointInput,
3245
+ _request_timeout: Union[
3246
+ None,
3247
+ Annotated[StrictFloat, Field(gt=0)],
3248
+ Tuple[
3249
+ Annotated[StrictFloat, Field(gt=0)],
3250
+ Annotated[StrictFloat, Field(gt=0)]
3251
+ ]
3252
+ ] = None,
3253
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3254
+ _content_type: Optional[StrictStr] = None,
3255
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3256
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3257
+ ) -> RESTResponseType:
3258
+ """Updates a job.
3259
+
3260
+
3261
+ :param job_id: (required)
3262
+ :type job_id: str
3263
+ :param update_job_endpoint_input: (required)
3264
+ :type update_job_endpoint_input: UpdateJobEndpointInput
3265
+ :param _request_timeout: timeout setting for this request. If one
3266
+ number provided, it will be total request
3267
+ timeout. It can also be a pair (tuple) of
3268
+ (connection, read) timeouts.
3269
+ :type _request_timeout: int, tuple(int, int), optional
3270
+ :param _request_auth: set to override the auth_settings for an a single
3271
+ request; this effectively ignores the
3272
+ authentication in the spec for a single request.
3273
+ :type _request_auth: dict, optional
3274
+ :param _content_type: force content-type for the request.
3275
+ :type _content_type: str, Optional
3276
+ :param _headers: set to override the headers for a single
3277
+ request; this effectively ignores the headers
3278
+ in the spec for a single request.
3279
+ :type _headers: dict, optional
3280
+ :param _host_index: set to override the host_index for a single
3281
+ request; this effectively ignores the host_index
3282
+ in the spec for a single request.
3283
+ :type _host_index: int, optional
3284
+ :return: Returns the result object.
3285
+ """ # noqa: E501
3286
+
3287
+ _param = self._job_job_id_patch_serialize(
3288
+ job_id=job_id,
3289
+ update_job_endpoint_input=update_job_endpoint_input,
3290
+ _request_auth=_request_auth,
3291
+ _content_type=_content_type,
3292
+ _headers=_headers,
3293
+ _host_index=_host_index
3294
+ )
3295
+
3296
+ _response_types_map: Dict[str, Optional[str]] = {
3297
+ '204': None,
3298
+ '400': "ValidationProblemDetails",
3299
+ '401': None,
3300
+ '403': None,
3301
+ }
3302
+ response_data = self.api_client.call_api(
3303
+ *_param,
3304
+ _request_timeout=_request_timeout
3305
+ )
3306
+ return response_data.response
3307
+
3308
+
3309
+ def _job_job_id_patch_serialize(
3310
+ self,
3311
+ job_id,
3312
+ update_job_endpoint_input,
3313
+ _request_auth,
3314
+ _content_type,
3315
+ _headers,
3316
+ _host_index,
3317
+ ) -> RequestSerialized:
3318
+
3319
+ _host = None
3320
+
3321
+ _collection_formats: Dict[str, str] = {
3322
+ }
3323
+
3324
+ _path_params: Dict[str, str] = {}
3325
+ _query_params: List[Tuple[str, str]] = []
3326
+ _header_params: Dict[str, Optional[str]] = _headers or {}
3327
+ _form_params: List[Tuple[str, str]] = []
3328
+ _files: Dict[
3329
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
3330
+ ] = {}
3331
+ _body_params: Optional[bytes] = None
3332
+
3333
+ # process the path parameters
3334
+ if job_id is not None:
3335
+ _path_params['jobId'] = job_id
3336
+ # process the query parameters
3337
+ # process the header parameters
3338
+ # process the form parameters
3339
+ # process the body parameter
3340
+ if update_job_endpoint_input is not None:
3341
+ _body_params = update_job_endpoint_input
3342
+
3343
+
3344
+ # set the HTTP header `Accept`
3345
+ if 'Accept' not in _header_params:
3346
+ _header_params['Accept'] = self.api_client.select_header_accept(
3347
+ [
3348
+ 'application/json'
3349
+ ]
3350
+ )
3351
+
3352
+ # set the HTTP header `Content-Type`
3353
+ if _content_type:
3354
+ _header_params['Content-Type'] = _content_type
3355
+ else:
3356
+ _default_content_type = (
3357
+ self.api_client.select_header_content_type(
3358
+ [
3359
+ 'application/json'
3360
+ ]
3361
+ )
3362
+ )
3363
+ if _default_content_type is not None:
3364
+ _header_params['Content-Type'] = _default_content_type
3365
+
3366
+ # authentication setting
3367
+ _auth_settings: List[str] = [
3368
+ 'OAuth2',
3369
+ 'OpenIdConnect',
3370
+ 'Bearer'
3371
+ ]
3372
+
3373
+ return self.api_client.param_serialize(
3374
+ method='PATCH',
3375
+ resource_path='/job/{jobId}',
3376
+ path_params=_path_params,
3377
+ query_params=_query_params,
3378
+ header_params=_header_params,
3379
+ body=_body_params,
3380
+ post_params=_form_params,
3381
+ files=_files,
3382
+ auth_settings=_auth_settings,
3383
+ collection_formats=_collection_formats,
3384
+ _host=_host,
3385
+ _request_auth=_request_auth
3386
+ )
3387
+
3388
+
3389
+
3390
+
3391
+ @validate_call
3392
+ def job_job_id_results_get(
3393
+ self,
3394
+ job_id: StrictStr,
3395
+ _request_timeout: Union[
3396
+ None,
3397
+ Annotated[StrictFloat, Field(gt=0)],
3398
+ Tuple[
3399
+ Annotated[StrictFloat, Field(gt=0)],
3400
+ Annotated[StrictFloat, Field(gt=0)]
3401
+ ]
3402
+ ] = None,
3403
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3404
+ _content_type: Optional[StrictStr] = None,
3405
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3406
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3407
+ ) -> str:
3408
+ """Gets the results of a job as a JSON string.
3409
+
3410
+
3411
+ :param job_id: (required)
3412
+ :type job_id: str
3413
+ :param _request_timeout: timeout setting for this request. If one
3414
+ number provided, it will be total request
3415
+ timeout. It can also be a pair (tuple) of
3416
+ (connection, read) timeouts.
3417
+ :type _request_timeout: int, tuple(int, int), optional
3418
+ :param _request_auth: set to override the auth_settings for an a single
3419
+ request; this effectively ignores the
3420
+ authentication in the spec for a single request.
3421
+ :type _request_auth: dict, optional
3422
+ :param _content_type: force content-type for the request.
3423
+ :type _content_type: str, Optional
3424
+ :param _headers: set to override the headers for a single
3425
+ request; this effectively ignores the headers
3426
+ in the spec for a single request.
3427
+ :type _headers: dict, optional
3428
+ :param _host_index: set to override the host_index for a single
3429
+ request; this effectively ignores the host_index
3430
+ in the spec for a single request.
3431
+ :type _host_index: int, optional
3432
+ :return: Returns the result object.
3433
+ """ # noqa: E501
3434
+
3435
+ _param = self._job_job_id_results_get_serialize(
3436
+ job_id=job_id,
3437
+ _request_auth=_request_auth,
3438
+ _content_type=_content_type,
3439
+ _headers=_headers,
3440
+ _host_index=_host_index
3441
+ )
3442
+
3443
+ _response_types_map: Dict[str, Optional[str]] = {
3444
+ '200': "str",
3445
+ '401': None,
3446
+ '403': None,
3447
+ }
3448
+ response_data = self.api_client.call_api(
3449
+ *_param,
3450
+ _request_timeout=_request_timeout
3451
+ )
3452
+ response_data.read()
3453
+ return self.api_client.response_deserialize(
3454
+ response_data=response_data,
3455
+ response_types_map=_response_types_map,
3456
+ ).data
3457
+
3458
+
3459
+ @validate_call
3460
+ def job_job_id_results_get_with_http_info(
3461
+ self,
3462
+ job_id: StrictStr,
3463
+ _request_timeout: Union[
3464
+ None,
3465
+ Annotated[StrictFloat, Field(gt=0)],
3466
+ Tuple[
3467
+ Annotated[StrictFloat, Field(gt=0)],
3468
+ Annotated[StrictFloat, Field(gt=0)]
3469
+ ]
3470
+ ] = None,
3471
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3472
+ _content_type: Optional[StrictStr] = None,
3473
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3474
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3475
+ ) -> ApiResponse[str]:
3476
+ """Gets the results of a job as a JSON string.
3477
+
3478
+
3479
+ :param job_id: (required)
3480
+ :type job_id: str
3481
+ :param _request_timeout: timeout setting for this request. If one
3482
+ number provided, it will be total request
3483
+ timeout. It can also be a pair (tuple) of
3484
+ (connection, read) timeouts.
3485
+ :type _request_timeout: int, tuple(int, int), optional
3486
+ :param _request_auth: set to override the auth_settings for an a single
3487
+ request; this effectively ignores the
3488
+ authentication in the spec for a single request.
3489
+ :type _request_auth: dict, optional
3490
+ :param _content_type: force content-type for the request.
3491
+ :type _content_type: str, Optional
3492
+ :param _headers: set to override the headers for a single
3493
+ request; this effectively ignores the headers
3494
+ in the spec for a single request.
3495
+ :type _headers: dict, optional
3496
+ :param _host_index: set to override the host_index for a single
3497
+ request; this effectively ignores the host_index
3498
+ in the spec for a single request.
3499
+ :type _host_index: int, optional
3500
+ :return: Returns the result object.
3501
+ """ # noqa: E501
3502
+
3503
+ _param = self._job_job_id_results_get_serialize(
3504
+ job_id=job_id,
3505
+ _request_auth=_request_auth,
3506
+ _content_type=_content_type,
3507
+ _headers=_headers,
3508
+ _host_index=_host_index
3509
+ )
3510
+
3511
+ _response_types_map: Dict[str, Optional[str]] = {
3512
+ '200': "str",
3513
+ '401': None,
3514
+ '403': None,
3515
+ }
3516
+ response_data = self.api_client.call_api(
3517
+ *_param,
3518
+ _request_timeout=_request_timeout
3519
+ )
3520
+ response_data.read()
3521
+ return self.api_client.response_deserialize(
3522
+ response_data=response_data,
3523
+ response_types_map=_response_types_map,
3524
+ )
3525
+
3526
+
3527
+ @validate_call
3528
+ def job_job_id_results_get_without_preload_content(
3529
+ self,
3530
+ job_id: StrictStr,
3531
+ _request_timeout: Union[
3532
+ None,
3533
+ Annotated[StrictFloat, Field(gt=0)],
3534
+ Tuple[
3535
+ Annotated[StrictFloat, Field(gt=0)],
3536
+ Annotated[StrictFloat, Field(gt=0)]
3537
+ ]
3538
+ ] = None,
3539
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3540
+ _content_type: Optional[StrictStr] = None,
3541
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3542
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3543
+ ) -> RESTResponseType:
3544
+ """Gets the results of a job as a JSON string.
3545
+
3546
+
3547
+ :param job_id: (required)
3548
+ :type job_id: str
3549
+ :param _request_timeout: timeout setting for this request. If one
3550
+ number provided, it will be total request
3551
+ timeout. It can also be a pair (tuple) of
3552
+ (connection, read) timeouts.
3553
+ :type _request_timeout: int, tuple(int, int), optional
3554
+ :param _request_auth: set to override the auth_settings for an a single
3555
+ request; this effectively ignores the
3556
+ authentication in the spec for a single request.
3557
+ :type _request_auth: dict, optional
3558
+ :param _content_type: force content-type for the request.
3559
+ :type _content_type: str, Optional
3560
+ :param _headers: set to override the headers for a single
3561
+ request; this effectively ignores the headers
3562
+ in the spec for a single request.
3563
+ :type _headers: dict, optional
3564
+ :param _host_index: set to override the host_index for a single
3565
+ request; this effectively ignores the host_index
3566
+ in the spec for a single request.
3567
+ :type _host_index: int, optional
3568
+ :return: Returns the result object.
3569
+ """ # noqa: E501
3570
+
3571
+ _param = self._job_job_id_results_get_serialize(
3572
+ job_id=job_id,
3573
+ _request_auth=_request_auth,
3574
+ _content_type=_content_type,
3575
+ _headers=_headers,
3576
+ _host_index=_host_index
3577
+ )
3578
+
3579
+ _response_types_map: Dict[str, Optional[str]] = {
3580
+ '200': "str",
3581
+ '401': None,
3582
+ '403': None,
3583
+ }
3584
+ response_data = self.api_client.call_api(
3585
+ *_param,
3586
+ _request_timeout=_request_timeout
3587
+ )
3588
+ return response_data.response
3589
+
3590
+
3591
+ def _job_job_id_results_get_serialize(
3592
+ self,
3593
+ job_id,
3594
+ _request_auth,
3595
+ _content_type,
3596
+ _headers,
3597
+ _host_index,
3598
+ ) -> RequestSerialized:
3599
+
3600
+ _host = None
3601
+
3602
+ _collection_formats: Dict[str, str] = {
3603
+ }
3604
+
3605
+ _path_params: Dict[str, str] = {}
3606
+ _query_params: List[Tuple[str, str]] = []
3607
+ _header_params: Dict[str, Optional[str]] = _headers or {}
3608
+ _form_params: List[Tuple[str, str]] = []
3609
+ _files: Dict[
3610
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
3611
+ ] = {}
3612
+ _body_params: Optional[bytes] = None
3613
+
3614
+ # process the path parameters
3615
+ if job_id is not None:
3616
+ _path_params['jobId'] = job_id
3617
+ # process the query parameters
3618
+ # process the header parameters
3619
+ # process the form parameters
3620
+ # process the body parameter
3621
+
3622
+
3623
+ # set the HTTP header `Accept`
3624
+ if 'Accept' not in _header_params:
3625
+ _header_params['Accept'] = self.api_client.select_header_accept(
3626
+ [
3627
+ 'application/json'
3628
+ ]
3629
+ )
3630
+
3631
+
3632
+ # authentication setting
3633
+ _auth_settings: List[str] = [
3634
+ 'OAuth2',
3635
+ 'OpenIdConnect',
3636
+ 'Bearer'
3637
+ ]
3638
+
3639
+ return self.api_client.param_serialize(
3640
+ method='GET',
3641
+ resource_path='/job/{jobId}/results',
3642
+ path_params=_path_params,
3643
+ query_params=_query_params,
3644
+ header_params=_header_params,
3645
+ body=_body_params,
3646
+ post_params=_form_params,
3647
+ files=_files,
3648
+ auth_settings=_auth_settings,
3649
+ collection_formats=_collection_formats,
3650
+ _host=_host,
3651
+ _request_auth=_request_auth
3652
+ )
3653
+
3654
+
3655
+
3656
+
3657
+ @validate_call
3658
+ def job_post(
3659
+ self,
3660
+ create_job_endpoint_input: CreateJobEndpointInput,
3661
+ _request_timeout: Union[
3662
+ None,
3663
+ Annotated[StrictFloat, Field(gt=0)],
3664
+ Tuple[
3665
+ Annotated[StrictFloat, Field(gt=0)],
3666
+ Annotated[StrictFloat, Field(gt=0)]
3667
+ ]
3668
+ ] = None,
3669
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3670
+ _content_type: Optional[StrictStr] = None,
3671
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3672
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3673
+ ) -> CreateJobEndpointOutput:
3674
+ """Creates a new job from a job definition and audience.
3675
+
3676
+
3677
+ :param create_job_endpoint_input: (required)
3678
+ :type create_job_endpoint_input: CreateJobEndpointInput
3679
+ :param _request_timeout: timeout setting for this request. If one
3680
+ number provided, it will be total request
3681
+ timeout. It can also be a pair (tuple) of
3682
+ (connection, read) timeouts.
3683
+ :type _request_timeout: int, tuple(int, int), optional
3684
+ :param _request_auth: set to override the auth_settings for an a single
3685
+ request; this effectively ignores the
3686
+ authentication in the spec for a single request.
3687
+ :type _request_auth: dict, optional
3688
+ :param _content_type: force content-type for the request.
3689
+ :type _content_type: str, Optional
3690
+ :param _headers: set to override the headers for a single
3691
+ request; this effectively ignores the headers
3692
+ in the spec for a single request.
3693
+ :type _headers: dict, optional
3694
+ :param _host_index: set to override the host_index for a single
3695
+ request; this effectively ignores the host_index
3696
+ in the spec for a single request.
3697
+ :type _host_index: int, optional
3698
+ :return: Returns the result object.
3699
+ """ # noqa: E501
3700
+
3701
+ _param = self._job_post_serialize(
3702
+ create_job_endpoint_input=create_job_endpoint_input,
3703
+ _request_auth=_request_auth,
3704
+ _content_type=_content_type,
3705
+ _headers=_headers,
3706
+ _host_index=_host_index
3707
+ )
3708
+
3709
+ _response_types_map: Dict[str, Optional[str]] = {
3710
+ '200': "CreateJobEndpointOutput",
3711
+ '400': "ValidationProblemDetails",
3712
+ '401': None,
3713
+ '403': None,
3714
+ }
3715
+ response_data = self.api_client.call_api(
3716
+ *_param,
3717
+ _request_timeout=_request_timeout
3718
+ )
3719
+ response_data.read()
3720
+ return self.api_client.response_deserialize(
3721
+ response_data=response_data,
3722
+ response_types_map=_response_types_map,
3723
+ ).data
3724
+
3725
+
3726
+ @validate_call
3727
+ def job_post_with_http_info(
3728
+ self,
3729
+ create_job_endpoint_input: CreateJobEndpointInput,
3730
+ _request_timeout: Union[
3731
+ None,
3732
+ Annotated[StrictFloat, Field(gt=0)],
3733
+ Tuple[
3734
+ Annotated[StrictFloat, Field(gt=0)],
3735
+ Annotated[StrictFloat, Field(gt=0)]
3736
+ ]
3737
+ ] = None,
3738
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3739
+ _content_type: Optional[StrictStr] = None,
3740
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3741
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3742
+ ) -> ApiResponse[CreateJobEndpointOutput]:
3743
+ """Creates a new job from a job definition and audience.
3744
+
3745
+
3746
+ :param create_job_endpoint_input: (required)
3747
+ :type create_job_endpoint_input: CreateJobEndpointInput
3748
+ :param _request_timeout: timeout setting for this request. If one
3749
+ number provided, it will be total request
3750
+ timeout. It can also be a pair (tuple) of
3751
+ (connection, read) timeouts.
3752
+ :type _request_timeout: int, tuple(int, int), optional
3753
+ :param _request_auth: set to override the auth_settings for an a single
3754
+ request; this effectively ignores the
3755
+ authentication in the spec for a single request.
3756
+ :type _request_auth: dict, optional
3757
+ :param _content_type: force content-type for the request.
3758
+ :type _content_type: str, Optional
3759
+ :param _headers: set to override the headers for a single
3760
+ request; this effectively ignores the headers
3761
+ in the spec for a single request.
3762
+ :type _headers: dict, optional
3763
+ :param _host_index: set to override the host_index for a single
3764
+ request; this effectively ignores the host_index
3765
+ in the spec for a single request.
3766
+ :type _host_index: int, optional
3767
+ :return: Returns the result object.
3768
+ """ # noqa: E501
3769
+
3770
+ _param = self._job_post_serialize(
3771
+ create_job_endpoint_input=create_job_endpoint_input,
3772
+ _request_auth=_request_auth,
3773
+ _content_type=_content_type,
3774
+ _headers=_headers,
3775
+ _host_index=_host_index
3776
+ )
3777
+
3778
+ _response_types_map: Dict[str, Optional[str]] = {
3779
+ '200': "CreateJobEndpointOutput",
3780
+ '400': "ValidationProblemDetails",
3781
+ '401': None,
3782
+ '403': None,
3783
+ }
3784
+ response_data = self.api_client.call_api(
3785
+ *_param,
3786
+ _request_timeout=_request_timeout
3787
+ )
3788
+ response_data.read()
3789
+ return self.api_client.response_deserialize(
3790
+ response_data=response_data,
3791
+ response_types_map=_response_types_map,
3792
+ )
3793
+
3794
+
3795
+ @validate_call
3796
+ def job_post_without_preload_content(
3797
+ self,
3798
+ create_job_endpoint_input: CreateJobEndpointInput,
3799
+ _request_timeout: Union[
3800
+ None,
3801
+ Annotated[StrictFloat, Field(gt=0)],
3802
+ Tuple[
3803
+ Annotated[StrictFloat, Field(gt=0)],
3804
+ Annotated[StrictFloat, Field(gt=0)]
3805
+ ]
3806
+ ] = None,
3807
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3808
+ _content_type: Optional[StrictStr] = None,
3809
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3810
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3811
+ ) -> RESTResponseType:
3812
+ """Creates a new job from a job definition and audience.
3813
+
3814
+
3815
+ :param create_job_endpoint_input: (required)
3816
+ :type create_job_endpoint_input: CreateJobEndpointInput
3817
+ :param _request_timeout: timeout setting for this request. If one
3818
+ number provided, it will be total request
3819
+ timeout. It can also be a pair (tuple) of
3820
+ (connection, read) timeouts.
3821
+ :type _request_timeout: int, tuple(int, int), optional
3822
+ :param _request_auth: set to override the auth_settings for an a single
3823
+ request; this effectively ignores the
3824
+ authentication in the spec for a single request.
3825
+ :type _request_auth: dict, optional
3826
+ :param _content_type: force content-type for the request.
3827
+ :type _content_type: str, Optional
3828
+ :param _headers: set to override the headers for a single
3829
+ request; this effectively ignores the headers
3830
+ in the spec for a single request.
3831
+ :type _headers: dict, optional
3832
+ :param _host_index: set to override the host_index for a single
3833
+ request; this effectively ignores the host_index
3834
+ in the spec for a single request.
3835
+ :type _host_index: int, optional
3836
+ :return: Returns the result object.
3837
+ """ # noqa: E501
3838
+
3839
+ _param = self._job_post_serialize(
3840
+ create_job_endpoint_input=create_job_endpoint_input,
3841
+ _request_auth=_request_auth,
3842
+ _content_type=_content_type,
3843
+ _headers=_headers,
3844
+ _host_index=_host_index
3845
+ )
3846
+
3847
+ _response_types_map: Dict[str, Optional[str]] = {
3848
+ '200': "CreateJobEndpointOutput",
3849
+ '400': "ValidationProblemDetails",
3850
+ '401': None,
3851
+ '403': None,
3852
+ }
3853
+ response_data = self.api_client.call_api(
3854
+ *_param,
3855
+ _request_timeout=_request_timeout
3856
+ )
3857
+ return response_data.response
3858
+
3859
+
3860
+ def _job_post_serialize(
3861
+ self,
3862
+ create_job_endpoint_input,
3863
+ _request_auth,
3864
+ _content_type,
3865
+ _headers,
3866
+ _host_index,
3867
+ ) -> RequestSerialized:
3868
+
3869
+ _host = None
3870
+
3871
+ _collection_formats: Dict[str, str] = {
3872
+ }
3873
+
3874
+ _path_params: Dict[str, str] = {}
3875
+ _query_params: List[Tuple[str, str]] = []
3876
+ _header_params: Dict[str, Optional[str]] = _headers or {}
3877
+ _form_params: List[Tuple[str, str]] = []
3878
+ _files: Dict[
3879
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
3880
+ ] = {}
3881
+ _body_params: Optional[bytes] = None
3882
+
3883
+ # process the path parameters
3884
+ # process the query parameters
3885
+ # process the header parameters
3886
+ # process the form parameters
3887
+ # process the body parameter
3888
+ if create_job_endpoint_input is not None:
3889
+ _body_params = create_job_endpoint_input
3890
+
3891
+
3892
+ # set the HTTP header `Accept`
3893
+ if 'Accept' not in _header_params:
3894
+ _header_params['Accept'] = self.api_client.select_header_accept(
3895
+ [
3896
+ 'application/json'
3897
+ ]
3898
+ )
3899
+
3900
+ # set the HTTP header `Content-Type`
3901
+ if _content_type:
3902
+ _header_params['Content-Type'] = _content_type
3903
+ else:
3904
+ _default_content_type = (
3905
+ self.api_client.select_header_content_type(
3906
+ [
3907
+ 'application/json'
3908
+ ]
3909
+ )
3910
+ )
3911
+ if _default_content_type is not None:
3912
+ _header_params['Content-Type'] = _default_content_type
3913
+
3914
+ # authentication setting
3915
+ _auth_settings: List[str] = [
3916
+ 'OAuth2',
3917
+ 'OpenIdConnect',
3918
+ 'Bearer'
3919
+ ]
3920
+
3921
+ return self.api_client.param_serialize(
3922
+ method='POST',
3923
+ resource_path='/job',
3924
+ path_params=_path_params,
3925
+ query_params=_query_params,
3926
+ header_params=_header_params,
3927
+ body=_body_params,
3928
+ post_params=_form_params,
3929
+ files=_files,
3930
+ auth_settings=_auth_settings,
3931
+ collection_formats=_collection_formats,
3932
+ _host=_host,
3933
+ _request_auth=_request_auth
3934
+ )
3935
+
3936
+
3937
+
3938
+
3939
+ @validate_call
3940
+ def jobs_get(
3941
+ self,
3942
+ request: Annotated[Optional[QueryModel], Field(description="The parameters for filtering, paging, and sorting")] = None,
3943
+ _request_timeout: Union[
3944
+ None,
3945
+ Annotated[StrictFloat, Field(gt=0)],
3946
+ Tuple[
3947
+ Annotated[StrictFloat, Field(gt=0)],
3948
+ Annotated[StrictFloat, Field(gt=0)]
3949
+ ]
3950
+ ] = None,
3951
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3952
+ _content_type: Optional[StrictStr] = None,
3953
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3954
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3955
+ ) -> PagedResultOfQueryJobsResult:
3956
+ """Queries jobs based on filter, page, and sort criteria.
3957
+
3958
+
3959
+ :param request: The parameters for filtering, paging, and sorting
3960
+ :type request: QueryModel
3961
+ :param _request_timeout: timeout setting for this request. If one
3962
+ number provided, it will be total request
3963
+ timeout. It can also be a pair (tuple) of
3964
+ (connection, read) timeouts.
3965
+ :type _request_timeout: int, tuple(int, int), optional
3966
+ :param _request_auth: set to override the auth_settings for an a single
3967
+ request; this effectively ignores the
3968
+ authentication in the spec for a single request.
3969
+ :type _request_auth: dict, optional
3970
+ :param _content_type: force content-type for the request.
3971
+ :type _content_type: str, Optional
3972
+ :param _headers: set to override the headers for a single
3973
+ request; this effectively ignores the headers
3974
+ in the spec for a single request.
3975
+ :type _headers: dict, optional
3976
+ :param _host_index: set to override the host_index for a single
3977
+ request; this effectively ignores the host_index
3978
+ in the spec for a single request.
3979
+ :type _host_index: int, optional
3980
+ :return: Returns the result object.
3981
+ """ # noqa: E501
3982
+
3983
+ _param = self._jobs_get_serialize(
3984
+ request=request,
3985
+ _request_auth=_request_auth,
3986
+ _content_type=_content_type,
3987
+ _headers=_headers,
3988
+ _host_index=_host_index
3989
+ )
3990
+
3991
+ _response_types_map: Dict[str, Optional[str]] = {
3992
+ '200': "PagedResultOfQueryJobsResult",
3993
+ }
3994
+ response_data = self.api_client.call_api(
3995
+ *_param,
3996
+ _request_timeout=_request_timeout
3997
+ )
3998
+ response_data.read()
3999
+ return self.api_client.response_deserialize(
4000
+ response_data=response_data,
4001
+ response_types_map=_response_types_map,
4002
+ ).data
4003
+
4004
+
4005
+ @validate_call
4006
+ def jobs_get_with_http_info(
4007
+ self,
4008
+ request: Annotated[Optional[QueryModel], Field(description="The parameters for filtering, paging, and sorting")] = None,
4009
+ _request_timeout: Union[
4010
+ None,
4011
+ Annotated[StrictFloat, Field(gt=0)],
4012
+ Tuple[
4013
+ Annotated[StrictFloat, Field(gt=0)],
4014
+ Annotated[StrictFloat, Field(gt=0)]
4015
+ ]
4016
+ ] = None,
4017
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
4018
+ _content_type: Optional[StrictStr] = None,
4019
+ _headers: Optional[Dict[StrictStr, Any]] = None,
4020
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
4021
+ ) -> ApiResponse[PagedResultOfQueryJobsResult]:
4022
+ """Queries jobs based on filter, page, and sort criteria.
4023
+
4024
+
4025
+ :param request: The parameters for filtering, paging, and sorting
4026
+ :type request: QueryModel
4027
+ :param _request_timeout: timeout setting for this request. If one
4028
+ number provided, it will be total request
4029
+ timeout. It can also be a pair (tuple) of
4030
+ (connection, read) timeouts.
4031
+ :type _request_timeout: int, tuple(int, int), optional
4032
+ :param _request_auth: set to override the auth_settings for an a single
4033
+ request; this effectively ignores the
4034
+ authentication in the spec for a single request.
4035
+ :type _request_auth: dict, optional
4036
+ :param _content_type: force content-type for the request.
4037
+ :type _content_type: str, Optional
4038
+ :param _headers: set to override the headers for a single
4039
+ request; this effectively ignores the headers
4040
+ in the spec for a single request.
4041
+ :type _headers: dict, optional
4042
+ :param _host_index: set to override the host_index for a single
4043
+ request; this effectively ignores the host_index
4044
+ in the spec for a single request.
4045
+ :type _host_index: int, optional
4046
+ :return: Returns the result object.
4047
+ """ # noqa: E501
4048
+
4049
+ _param = self._jobs_get_serialize(
4050
+ request=request,
4051
+ _request_auth=_request_auth,
4052
+ _content_type=_content_type,
4053
+ _headers=_headers,
4054
+ _host_index=_host_index
4055
+ )
4056
+
4057
+ _response_types_map: Dict[str, Optional[str]] = {
4058
+ '200': "PagedResultOfQueryJobsResult",
4059
+ }
4060
+ response_data = self.api_client.call_api(
4061
+ *_param,
4062
+ _request_timeout=_request_timeout
4063
+ )
4064
+ response_data.read()
4065
+ return self.api_client.response_deserialize(
4066
+ response_data=response_data,
4067
+ response_types_map=_response_types_map,
4068
+ )
4069
+
4070
+
4071
+ @validate_call
4072
+ def jobs_get_without_preload_content(
4073
+ self,
4074
+ request: Annotated[Optional[QueryModel], Field(description="The parameters for filtering, paging, and sorting")] = None,
4075
+ _request_timeout: Union[
4076
+ None,
4077
+ Annotated[StrictFloat, Field(gt=0)],
4078
+ Tuple[
4079
+ Annotated[StrictFloat, Field(gt=0)],
4080
+ Annotated[StrictFloat, Field(gt=0)]
4081
+ ]
4082
+ ] = None,
4083
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
4084
+ _content_type: Optional[StrictStr] = None,
4085
+ _headers: Optional[Dict[StrictStr, Any]] = None,
4086
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
4087
+ ) -> RESTResponseType:
4088
+ """Queries jobs based on filter, page, and sort criteria.
4089
+
4090
+
4091
+ :param request: The parameters for filtering, paging, and sorting
4092
+ :type request: QueryModel
4093
+ :param _request_timeout: timeout setting for this request. If one
4094
+ number provided, it will be total request
4095
+ timeout. It can also be a pair (tuple) of
4096
+ (connection, read) timeouts.
4097
+ :type _request_timeout: int, tuple(int, int), optional
4098
+ :param _request_auth: set to override the auth_settings for an a single
4099
+ request; this effectively ignores the
4100
+ authentication in the spec for a single request.
4101
+ :type _request_auth: dict, optional
4102
+ :param _content_type: force content-type for the request.
4103
+ :type _content_type: str, Optional
4104
+ :param _headers: set to override the headers for a single
4105
+ request; this effectively ignores the headers
4106
+ in the spec for a single request.
4107
+ :type _headers: dict, optional
4108
+ :param _host_index: set to override the host_index for a single
4109
+ request; this effectively ignores the host_index
4110
+ in the spec for a single request.
4111
+ :type _host_index: int, optional
4112
+ :return: Returns the result object.
4113
+ """ # noqa: E501
4114
+
4115
+ _param = self._jobs_get_serialize(
4116
+ request=request,
4117
+ _request_auth=_request_auth,
4118
+ _content_type=_content_type,
4119
+ _headers=_headers,
4120
+ _host_index=_host_index
4121
+ )
4122
+
4123
+ _response_types_map: Dict[str, Optional[str]] = {
4124
+ '200': "PagedResultOfQueryJobsResult",
4125
+ }
4126
+ response_data = self.api_client.call_api(
4127
+ *_param,
4128
+ _request_timeout=_request_timeout
4129
+ )
4130
+ return response_data.response
4131
+
4132
+
4133
+ def _jobs_get_serialize(
4134
+ self,
4135
+ request,
4136
+ _request_auth,
4137
+ _content_type,
4138
+ _headers,
4139
+ _host_index,
4140
+ ) -> RequestSerialized:
4141
+
4142
+ _host = None
4143
+
4144
+ _collection_formats: Dict[str, str] = {
4145
+ }
4146
+
4147
+ _path_params: Dict[str, str] = {}
4148
+ _query_params: List[Tuple[str, str]] = []
4149
+ _header_params: Dict[str, Optional[str]] = _headers or {}
4150
+ _form_params: List[Tuple[str, str]] = []
4151
+ _files: Dict[
4152
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
4153
+ ] = {}
4154
+ _body_params: Optional[bytes] = None
4155
+
4156
+ # process the path parameters
4157
+ # process the query parameters
4158
+ if request is not None:
4159
+
4160
+ _query_params.append(('request', request))
4161
+
4162
+ # process the header parameters
4163
+ # process the form parameters
4164
+ # process the body parameter
4165
+
4166
+
4167
+ # set the HTTP header `Accept`
4168
+ if 'Accept' not in _header_params:
4169
+ _header_params['Accept'] = self.api_client.select_header_accept(
4170
+ [
4171
+ 'text/plain',
4172
+ 'application/json',
4173
+ 'text/json'
4174
+ ]
4175
+ )
4176
+
4177
+
4178
+ # authentication setting
4179
+ _auth_settings: List[str] = [
4180
+ 'OAuth2',
4181
+ 'OpenIdConnect',
4182
+ 'Bearer'
4183
+ ]
4184
+
4185
+ return self.api_client.param_serialize(
4186
+ method='GET',
4187
+ resource_path='/jobs',
4188
+ path_params=_path_params,
4189
+ query_params=_query_params,
4190
+ header_params=_header_params,
4191
+ body=_body_params,
4192
+ post_params=_form_params,
4193
+ files=_files,
4194
+ auth_settings=_auth_settings,
4195
+ collection_formats=_collection_formats,
4196
+ _host=_host,
4197
+ _request_auth=_request_auth
4198
+ )
4199
+
4200
+