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