instana-client 1.0.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (515) hide show
  1. instana_client/__init__.py +534 -0
  2. instana_client/api/__init__.py +58 -0
  3. instana_client/api/action_catalog_api.py +1380 -0
  4. instana_client/api/action_history_api.py +1793 -0
  5. instana_client/api/apdex_report_api.py +338 -0
  6. instana_client/api/apdex_settings_api.py +1353 -0
  7. instana_client/api/api_token_api.py +1370 -0
  8. instana_client/api/application_alert_configuration_api.py +2865 -0
  9. instana_client/api/application_analyze_api.py +2017 -0
  10. instana_client/api/application_catalog_api.py +885 -0
  11. instana_client/api/application_metrics_api.py +1211 -0
  12. instana_client/api/application_resources_api.py +1487 -0
  13. instana_client/api/application_settings_api.py +7261 -0
  14. instana_client/api/application_topology_api.py +354 -0
  15. instana_client/api/audit_log_api.py +635 -0
  16. instana_client/api/authentication_api.py +1008 -0
  17. instana_client/api/business_monitoring_api.py +2177 -0
  18. instana_client/api/custom_dashboards_api.py +1930 -0
  19. instana_client/api/event_settings_api.py +14613 -0
  20. instana_client/api/events_api.py +1654 -0
  21. instana_client/api/global_application_alert_configuration_api.py +2606 -0
  22. instana_client/api/groups_api.py +4078 -0
  23. instana_client/api/health_api.py +527 -0
  24. instana_client/api/host_agent_api.py +2120 -0
  25. instana_client/api/infrastructure_alert_configuration_api.py +2524 -0
  26. instana_client/api/infrastructure_analyze_api.py +1141 -0
  27. instana_client/api/infrastructure_catalog_api.py +1822 -0
  28. instana_client/api/infrastructure_metrics_api.py +331 -0
  29. instana_client/api/infrastructure_resources_api.py +1880 -0
  30. instana_client/api/infrastructure_topology_api.py +595 -0
  31. instana_client/api/log_alert_configuration_api.py +2524 -0
  32. instana_client/api/maintenance_configuration_api.py +2683 -0
  33. instana_client/api/mobile_app_analyze_api.py +613 -0
  34. instana_client/api/mobile_app_catalog_api.py +825 -0
  35. instana_client/api/mobile_app_configuration_api.py +2847 -0
  36. instana_client/api/mobile_app_metrics_api.py +892 -0
  37. instana_client/api/policies_api.py +1755 -0
  38. instana_client/api/releases_api.py +1408 -0
  39. instana_client/api/service_levels_alert_configuration_api.py +2577 -0
  40. instana_client/api/service_levels_objective_slo_configurations_api.py +1825 -0
  41. instana_client/api/service_levels_objective_slo_report_api.py +335 -0
  42. instana_client/api/session_settings_api.py +801 -0
  43. instana_client/api/sli_report_api.py +352 -0
  44. instana_client/api/sli_settings_api.py +2677 -0
  45. instana_client/api/synthetic_alert_configuration_api.py +2606 -0
  46. instana_client/api/synthetic_calls_api.py +789 -0
  47. instana_client/api/synthetic_catalog_api.py +543 -0
  48. instana_client/api/synthetic_metrics_api.py +322 -0
  49. instana_client/api/synthetic_settings_api.py +5144 -0
  50. instana_client/api/synthetic_test_playback_results_api.py +2142 -0
  51. instana_client/api/usage_api.py +1404 -0
  52. instana_client/api/user_api.py +2404 -0
  53. instana_client/api/website_analyze_api.py +619 -0
  54. instana_client/api/website_catalog_api.py +832 -0
  55. instana_client/api/website_configuration_api.py +3745 -0
  56. instana_client/api/website_metrics_api.py +889 -0
  57. instana_client/api_client.py +798 -0
  58. instana_client/api_response.py +21 -0
  59. instana_client/configuration.py +616 -0
  60. instana_client/exceptions.py +217 -0
  61. instana_client/models/__init__.py +464 -0
  62. instana_client/models/abstract_integration.py +155 -0
  63. instana_client/models/abstract_rule.py +124 -0
  64. instana_client/models/access_log_entry.py +105 -0
  65. instana_client/models/access_log_response.py +98 -0
  66. instana_client/models/access_rule.py +107 -0
  67. instana_client/models/action.py +135 -0
  68. instana_client/models/action_configuration.py +104 -0
  69. instana_client/models/action_instance.py +185 -0
  70. instana_client/models/action_instance_metadata_entry.py +90 -0
  71. instana_client/models/action_instance_parameter.py +94 -0
  72. instana_client/models/action_instance_request.py +108 -0
  73. instana_client/models/action_instance_request_parameters.py +92 -0
  74. instana_client/models/action_match.py +98 -0
  75. instana_client/models/action_search_space.py +94 -0
  76. instana_client/models/adaptive_baseline.py +92 -0
  77. instana_client/models/adaptive_threshold_rule.py +91 -0
  78. instana_client/models/adjusted_timeframe.py +91 -0
  79. instana_client/models/agent_configuration_update.py +93 -0
  80. instana_client/models/alerting_configuration.py +113 -0
  81. instana_client/models/alerting_configuration_with_last_updated.py +115 -0
  82. instana_client/models/alerting_time_window.py +109 -0
  83. instana_client/models/apdex_configuration.py +99 -0
  84. instana_client/models/apdex_configuration_input.py +95 -0
  85. instana_client/models/apdex_entity.py +119 -0
  86. instana_client/models/apdex_report.py +94 -0
  87. instana_client/models/api_create_group.py +104 -0
  88. instana_client/models/api_group.py +107 -0
  89. instana_client/models/api_member.py +90 -0
  90. instana_client/models/api_permission_set.py +178 -0
  91. instana_client/models/api_restricted_application_filter.py +108 -0
  92. instana_client/models/api_token.py +250 -0
  93. instana_client/models/app_data_metric_configuration.py +105 -0
  94. instana_client/models/application.py +104 -0
  95. instana_client/models/application_alert_config.py +203 -0
  96. instana_client/models/application_alert_config_with_metadata.py +213 -0
  97. instana_client/models/application_alert_rule.py +135 -0
  98. instana_client/models/application_apdex_entity.py +111 -0
  99. instana_client/models/application_config.py +131 -0
  100. instana_client/models/application_event_result.py +108 -0
  101. instana_client/models/application_item.py +94 -0
  102. instana_client/models/application_metric_result.py +109 -0
  103. instana_client/models/application_node.py +106 -0
  104. instana_client/models/application_result.py +102 -0
  105. instana_client/models/application_scope.py +89 -0
  106. instana_client/models/application_scope_with_metadata.py +90 -0
  107. instana_client/models/application_sli_entity.py +103 -0
  108. instana_client/models/application_slo_entity.py +112 -0
  109. instana_client/models/application_time_threshold.py +115 -0
  110. instana_client/models/audit_log_entry.py +102 -0
  111. instana_client/models/audit_log_ui_response.py +98 -0
  112. instana_client/models/author.py +100 -0
  113. instana_client/models/availability_blueprint_indicator.py +106 -0
  114. instana_client/models/availability_sli_entity.py +138 -0
  115. instana_client/models/available_metrics.py +96 -0
  116. instana_client/models/available_plugins.py +88 -0
  117. instana_client/models/backend_trace_reference.py +88 -0
  118. instana_client/models/binary_operator_dto.py +107 -0
  119. instana_client/models/browser_script_configuration.py +127 -0
  120. instana_client/models/built_in_event_specification.py +123 -0
  121. instana_client/models/built_in_event_specification_with_last_updated.py +125 -0
  122. instana_client/models/business_activity.py +132 -0
  123. instana_client/models/business_perspective_config.py +99 -0
  124. instana_client/models/call_groups_item.py +95 -0
  125. instana_client/models/call_groups_result.py +111 -0
  126. instana_client/models/call_relation.py +100 -0
  127. instana_client/models/change_summary.py +101 -0
  128. instana_client/models/cloudfoundry_physical_context.py +104 -0
  129. instana_client/models/condition.py +88 -0
  130. instana_client/models/config_version.py +101 -0
  131. instana_client/models/crash_mobile_app_alert_rule.py +90 -0
  132. instana_client/models/cursor_paginated_business_activity_item.py +96 -0
  133. instana_client/models/cursor_pagination.py +93 -0
  134. instana_client/models/cursor_pagination_infra_explore_cursor.py +90 -0
  135. instana_client/models/custom_blueprint_indicator.py +104 -0
  136. instana_client/models/custom_dashboard.py +111 -0
  137. instana_client/models/custom_dashboard_preview.py +103 -0
  138. instana_client/models/custom_email_subject_prefix.py +94 -0
  139. instana_client/models/custom_event_mobile_app_alert_rule.py +92 -0
  140. instana_client/models/custom_event_specification.py +133 -0
  141. instana_client/models/custom_event_specification_with_last_updated.py +143 -0
  142. instana_client/models/custom_event_website_alert_rule.py +92 -0
  143. instana_client/models/custom_payload_configuration.py +97 -0
  144. instana_client/models/custom_payload_field.py +112 -0
  145. instana_client/models/custom_payload_with_last_updated.py +99 -0
  146. instana_client/models/dashboard_api_token.py +90 -0
  147. instana_client/models/database_integration.py +90 -0
  148. instana_client/models/deprecated_tag_filter.py +111 -0
  149. instana_client/models/dns_action_configuration.py +134 -0
  150. instana_client/models/dns_action_filter_query_time.py +99 -0
  151. instana_client/models/dns_action_filter_target_value.py +106 -0
  152. instana_client/models/duration.py +98 -0
  153. instana_client/models/dynamic_field.py +95 -0
  154. instana_client/models/dynamic_field_value.py +90 -0
  155. instana_client/models/dynamic_parameter.py +94 -0
  156. instana_client/models/edit_user.py +88 -0
  157. instana_client/models/email_integration.py +98 -0
  158. instana_client/models/empty_configuration.py +92 -0
  159. instana_client/models/endpoint.py +131 -0
  160. instana_client/models/endpoint_config.py +112 -0
  161. instana_client/models/endpoint_event_result.py +112 -0
  162. instana_client/models/endpoint_item.py +94 -0
  163. instana_client/models/endpoint_metric_result.py +109 -0
  164. instana_client/models/endpoint_node.py +91 -0
  165. instana_client/models/endpoint_result.py +102 -0
  166. instana_client/models/endpoint_simple.py +102 -0
  167. instana_client/models/entity_count_rule.py +100 -0
  168. instana_client/models/entity_count_verification_rule.py +114 -0
  169. instana_client/models/entity_health_info.py +99 -0
  170. instana_client/models/entity_id.py +92 -0
  171. instana_client/models/entity_verification_rule.py +105 -0
  172. instana_client/models/error_budget_alert_rule.py +97 -0
  173. instana_client/models/errors_application_alert_rule.py +90 -0
  174. instana_client/models/event.py +127 -0
  175. instana_client/models/event_filtering_configuration.py +106 -0
  176. instana_client/models/event_result.py +145 -0
  177. instana_client/models/event_specification_info.py +114 -0
  178. instana_client/models/extended_service.py +123 -0
  179. instana_client/models/failure_synthetic_alert_rule.py +90 -0
  180. instana_client/models/fixed_http_path_segment_matching_rule.py +90 -0
  181. instana_client/models/fixed_time_window.py +93 -0
  182. instana_client/models/full_trace.py +97 -0
  183. instana_client/models/generic_infra_alert_rule.py +93 -0
  184. instana_client/models/geo_location_configuration.py +106 -0
  185. instana_client/models/geo_mapping_rule.py +120 -0
  186. instana_client/models/geo_subdivision.py +91 -0
  187. instana_client/models/get_activities.py +115 -0
  188. instana_client/models/get_application_metrics.py +112 -0
  189. instana_client/models/get_applications.py +150 -0
  190. instana_client/models/get_available_metrics_query.py +103 -0
  191. instana_client/models/get_available_plugins_query.py +98 -0
  192. instana_client/models/get_call_groups.py +141 -0
  193. instana_client/models/get_combined_metrics.py +103 -0
  194. instana_client/models/get_dynamic_parameter_values.py +100 -0
  195. instana_client/models/get_endpoints.py +150 -0
  196. instana_client/models/get_infrastructure_groups_query.py +127 -0
  197. instana_client/models/get_infrastructure_query.py +127 -0
  198. instana_client/models/get_metrics_result.py +128 -0
  199. instana_client/models/get_mobile_app_beacon_groups.py +146 -0
  200. instana_client/models/get_mobile_app_beacons.py +118 -0
  201. instana_client/models/get_mobile_app_metrics.py +122 -0
  202. instana_client/models/get_mobile_app_metrics_v2.py +118 -0
  203. instana_client/models/get_payload_keys_result.py +88 -0
  204. instana_client/models/get_services.py +147 -0
  205. instana_client/models/get_snapshots_query.py +95 -0
  206. instana_client/models/get_test_result.py +139 -0
  207. instana_client/models/get_test_result_base.py +120 -0
  208. instana_client/models/get_test_result_list.py +125 -0
  209. instana_client/models/get_test_summary_result.py +130 -0
  210. instana_client/models/get_trace_download_result_item.py +114 -0
  211. instana_client/models/get_trace_groups.py +141 -0
  212. instana_client/models/get_traces.py +125 -0
  213. instana_client/models/get_website_beacon_groups.py +146 -0
  214. instana_client/models/get_website_beacons.py +118 -0
  215. instana_client/models/get_website_metrics.py +122 -0
  216. instana_client/models/get_website_metrics_v2.py +118 -0
  217. instana_client/models/global_application_alert_config_with_metadata.py +205 -0
  218. instana_client/models/global_applications_alert_config.py +191 -0
  219. instana_client/models/google_chat_integration.py +92 -0
  220. instana_client/models/graph_edge.py +102 -0
  221. instana_client/models/graph_node.py +100 -0
  222. instana_client/models/group.py +100 -0
  223. instana_client/models/group_by_tag.py +90 -0
  224. instana_client/models/group_mapping.py +95 -0
  225. instana_client/models/health_state.py +100 -0
  226. instana_client/models/historic_baseline.py +105 -0
  227. instana_client/models/host_availability_rule.py +100 -0
  228. instana_client/models/http_action_configuration.py +127 -0
  229. instana_client/models/http_endpoint_config.py +103 -0
  230. instana_client/models/http_endpoint_rule.py +101 -0
  231. instana_client/models/http_path_segment_matching_rule.py +124 -0
  232. instana_client/models/http_script_configuration.py +113 -0
  233. instana_client/models/hyper_param.py +111 -0
  234. instana_client/models/identity_provider_patch.py +88 -0
  235. instana_client/models/infra_alert_config.py +166 -0
  236. instana_client/models/infra_alert_config_with_metadata.py +176 -0
  237. instana_client/models/infra_alert_rule.py +133 -0
  238. instana_client/models/infra_event_result.py +109 -0
  239. instana_client/models/infra_metric_configuration.py +115 -0
  240. instana_client/models/infra_time_threshold.py +109 -0
  241. instana_client/models/infrastructure_entities_result.py +109 -0
  242. instana_client/models/infrastructure_group.py +92 -0
  243. instana_client/models/infrastructure_groups_result.py +109 -0
  244. instana_client/models/infrastructure_item.py +104 -0
  245. instana_client/models/infrastructure_metric_result.py +96 -0
  246. instana_client/models/instana_version_info.py +92 -0
  247. instana_client/models/integration_overview.py +94 -0
  248. instana_client/models/invitation.py +94 -0
  249. instana_client/models/invitation_response.py +96 -0
  250. instana_client/models/invitation_result.py +100 -0
  251. instana_client/models/ip_masking_configuration.py +95 -0
  252. instana_client/models/js_stack_trace_line.py +99 -0
  253. instana_client/models/kubernetes_physical_context.py +107 -0
  254. instana_client/models/latency_blueprint_indicator.py +106 -0
  255. instana_client/models/location_status.py +96 -0
  256. instana_client/models/log_alert_config.py +154 -0
  257. instana_client/models/log_alert_config_with_metadata.py +164 -0
  258. instana_client/models/log_alert_rule.py +120 -0
  259. instana_client/models/log_count_alert_rule.py +90 -0
  260. instana_client/models/log_entry_actor.py +101 -0
  261. instana_client/models/log_event_result.py +107 -0
  262. instana_client/models/log_time_threshold.py +109 -0
  263. instana_client/models/logs_application_alert_rule.py +122 -0
  264. instana_client/models/maintenance_config.py +103 -0
  265. instana_client/models/maintenance_config_scheduling.py +118 -0
  266. instana_client/models/maintenance_config_v2.py +111 -0
  267. instana_client/models/maintenance_config_v2_with_state_and_occurrence.py +131 -0
  268. instana_client/models/maintenance_config_with_last_updated.py +105 -0
  269. instana_client/models/maintenance_window.py +93 -0
  270. instana_client/models/manual_alerting_channel_configuration.py +99 -0
  271. instana_client/models/manual_close_info.py +99 -0
  272. instana_client/models/manual_service_config.py +103 -0
  273. instana_client/models/match_all_http_path_segment_matching_rule.py +88 -0
  274. instana_client/models/match_expression_dto.py +111 -0
  275. instana_client/models/meta_data.py +96 -0
  276. instana_client/models/metric_api_result.py +94 -0
  277. instana_client/models/metric_config.py +99 -0
  278. instana_client/models/metric_configuration.py +103 -0
  279. instana_client/models/metric_description.py +116 -0
  280. instana_client/models/metric_instance.py +105 -0
  281. instana_client/models/metric_item.py +102 -0
  282. instana_client/models/metric_metadata.py +132 -0
  283. instana_client/models/metric_pattern.py +101 -0
  284. instana_client/models/metrics_result.py +96 -0
  285. instana_client/models/metrics_result_item.py +100 -0
  286. instana_client/models/metrics_test_result_item.py +102 -0
  287. instana_client/models/mobile_app.py +91 -0
  288. instana_client/models/mobile_app_alert_config.py +162 -0
  289. instana_client/models/mobile_app_alert_rule.py +129 -0
  290. instana_client/models/mobile_app_beacon_groups_item.py +95 -0
  291. instana_client/models/mobile_app_beacon_groups_result.py +111 -0
  292. instana_client/models/mobile_app_beacon_result.py +111 -0
  293. instana_client/models/mobile_app_beacon_tag_group.py +100 -0
  294. instana_client/models/mobile_app_beacons_item.py +94 -0
  295. instana_client/models/mobile_app_event_result.py +108 -0
  296. instana_client/models/mobile_app_metric_result.py +88 -0
  297. instana_client/models/mobile_app_monitoring_beacon.py +259 -0
  298. instana_client/models/mobile_app_monitoring_metric_description.py +123 -0
  299. instana_client/models/mobile_app_monitoring_metrics_configuration.py +105 -0
  300. instana_client/models/mobile_app_time_threshold.py +115 -0
  301. instana_client/models/model_field.py +96 -0
  302. instana_client/models/monitoring_state.py +92 -0
  303. instana_client/models/multiple_scripts_configuration.py +90 -0
  304. instana_client/models/new_application_config.py +129 -0
  305. instana_client/models/new_business_perspective_config.py +97 -0
  306. instana_client/models/new_manual_service_config.py +100 -0
  307. instana_client/models/occurrence.py +91 -0
  308. instana_client/models/office365_integration.py +92 -0
  309. instana_client/models/one_time_maintenance_window.py +94 -0
  310. instana_client/models/opsgenie_integration.py +105 -0
  311. instana_client/models/order.py +99 -0
  312. instana_client/models/pagerduty_integration.py +92 -0
  313. instana_client/models/paginated_result.py +95 -0
  314. instana_client/models/pagination.py +91 -0
  315. instana_client/models/parameter.py +102 -0
  316. instana_client/models/parameter_value.py +90 -0
  317. instana_client/models/path_parameter_http_path_segment_matching_rule.py +90 -0
  318. instana_client/models/physical_context.py +119 -0
  319. instana_client/models/plugin_result.py +90 -0
  320. instana_client/models/policy.py +113 -0
  321. instana_client/models/policy_runnable.py +103 -0
  322. instana_client/models/post_snapshots_result.py +98 -0
  323. instana_client/models/problem.py +95 -0
  324. instana_client/models/prometheus_webhook_integration.py +94 -0
  325. instana_client/models/recurrent_maintenance_window.py +98 -0
  326. instana_client/models/release.py +111 -0
  327. instana_client/models/release_scope.py +94 -0
  328. instana_client/models/release_with_metadata.py +125 -0
  329. instana_client/models/rolling_time_window.py +90 -0
  330. instana_client/models/rule_input.py +98 -0
  331. instana_client/models/rule_with_threshold_application_alert_rule.py +116 -0
  332. instana_client/models/rule_with_threshold_infra_alert_rule.py +116 -0
  333. instana_client/models/rule_with_threshold_log_alert_rule.py +116 -0
  334. instana_client/models/rule_with_threshold_mobile_app_alert_rule.py +116 -0
  335. instana_client/models/rule_with_threshold_website_alert_rule.py +116 -0
  336. instana_client/models/run_configuration.py +96 -0
  337. instana_client/models/salesforce_integration.py +98 -0
  338. instana_client/models/scope_binding.py +91 -0
  339. instana_client/models/search_field_result.py +116 -0
  340. instana_client/models/service.py +116 -0
  341. instana_client/models/service_config.py +107 -0
  342. instana_client/models/service_event_result.py +110 -0
  343. instana_client/models/service_item.py +94 -0
  344. instana_client/models/service_level_indicator.py +172 -0
  345. instana_client/models/service_level_objective_alert_rule.py +100 -0
  346. instana_client/models/service_level_objective_configuration.py +118 -0
  347. instana_client/models/service_levels_alert_config.py +133 -0
  348. instana_client/models/service_levels_alert_rule.py +111 -0
  349. instana_client/models/service_levels_burn_rate_time_windows.py +97 -0
  350. instana_client/models/service_levels_time_threshold.py +90 -0
  351. instana_client/models/service_levelse_alert_config_with_metadata.py +143 -0
  352. instana_client/models/service_map.py +106 -0
  353. instana_client/models/service_map_connection.py +97 -0
  354. instana_client/models/service_matching_rule.py +90 -0
  355. instana_client/models/service_metric_result.py +109 -0
  356. instana_client/models/service_node.py +106 -0
  357. instana_client/models/service_now_enhanced_integration.py +116 -0
  358. instana_client/models/service_now_integration.py +98 -0
  359. instana_client/models/service_result.py +102 -0
  360. instana_client/models/service_scope.py +95 -0
  361. instana_client/models/service_scope_with_metadata.py +96 -0
  362. instana_client/models/service_scoped_to.py +97 -0
  363. instana_client/models/service_scoped_to_with_metadata.py +97 -0
  364. instana_client/models/service_simple.py +90 -0
  365. instana_client/models/session_settings.py +91 -0
  366. instana_client/models/slack_integration.py +98 -0
  367. instana_client/models/sli_configuration.py +105 -0
  368. instana_client/models/sli_configuration_with_last_updated.py +107 -0
  369. instana_client/models/sli_entity.py +117 -0
  370. instana_client/models/sli_report.py +100 -0
  371. instana_client/models/slo_entity.py +119 -0
  372. instana_client/models/slo_report.py +112 -0
  373. instana_client/models/slowness_application_alert_rule.py +90 -0
  374. instana_client/models/slowness_website_alert_rule.py +90 -0
  375. instana_client/models/snapshot_item.py +102 -0
  376. instana_client/models/snapshot_preview.py +97 -0
  377. instana_client/models/snapshot_result.py +96 -0
  378. instana_client/models/software_user.py +94 -0
  379. instana_client/models/software_version.py +124 -0
  380. instana_client/models/source_map_file_blob.py +92 -0
  381. instana_client/models/source_map_file_meta.py +115 -0
  382. instana_client/models/source_map_upload_config.py +106 -0
  383. instana_client/models/span.py +156 -0
  384. instana_client/models/span_excerpt.py +132 -0
  385. instana_client/models/span_relation.py +114 -0
  386. instana_client/models/specific_js_errors_website_alert_rule.py +101 -0
  387. instana_client/models/splunk_integration.py +94 -0
  388. instana_client/models/ssl_certificate_configuration.py +99 -0
  389. instana_client/models/stack_trace_item.py +92 -0
  390. instana_client/models/stack_trace_line.py +99 -0
  391. instana_client/models/static_baseline_threshold_rule.py +102 -0
  392. instana_client/models/static_string_field.py +91 -0
  393. instana_client/models/static_threshold.py +94 -0
  394. instana_client/models/static_threshold_rule.py +91 -0
  395. instana_client/models/status_code_application_alert_rule.py +95 -0
  396. instana_client/models/status_code_mobile_app_alert_rule.py +101 -0
  397. instana_client/models/status_code_website_alert_rule.py +101 -0
  398. instana_client/models/synthetic_alert_config.py +127 -0
  399. instana_client/models/synthetic_alert_config_with_metadata.py +137 -0
  400. instana_client/models/synthetic_alert_rule.py +120 -0
  401. instana_client/models/synthetic_call_config.py +99 -0
  402. instana_client/models/synthetic_call_rule.py +99 -0
  403. instana_client/models/synthetic_call_with_defaults_config.py +108 -0
  404. instana_client/models/synthetic_credential.py +111 -0
  405. instana_client/models/synthetic_datacenter.py +117 -0
  406. instana_client/models/synthetic_datacenter_configuration.py +88 -0
  407. instana_client/models/synthetic_geo_point.py +94 -0
  408. instana_client/models/synthetic_location.py +129 -0
  409. instana_client/models/synthetic_location_configuration.py +102 -0
  410. instana_client/models/synthetic_metric_configuration.py +99 -0
  411. instana_client/models/synthetic_metric_tag_group.py +100 -0
  412. instana_client/models/synthetic_playback_capabilities.py +98 -0
  413. instana_client/models/synthetic_slo_entity.py +95 -0
  414. instana_client/models/synthetic_test.py +149 -0
  415. instana_client/models/synthetic_time_threshold.py +110 -0
  416. instana_client/models/synthetic_type_configuration.py +141 -0
  417. instana_client/models/synthetics_event_result.py +110 -0
  418. instana_client/models/system_rule.py +91 -0
  419. instana_client/models/system_rule_label.py +90 -0
  420. instana_client/models/tag.py +123 -0
  421. instana_client/models/tag_catalog.py +106 -0
  422. instana_client/models/tag_filter.py +113 -0
  423. instana_client/models/tag_filter_expression.py +106 -0
  424. instana_client/models/tag_filter_expression_element.py +111 -0
  425. instana_client/models/tag_matcher_dto.py +110 -0
  426. instana_client/models/tag_tree_level.py +109 -0
  427. instana_client/models/tag_tree_node.py +113 -0
  428. instana_client/models/tag_tree_tag.py +103 -0
  429. instana_client/models/test_common_properties.py +136 -0
  430. instana_client/models/test_result.py +105 -0
  431. instana_client/models/test_result_common_properties.py +108 -0
  432. instana_client/models/test_result_detail_data.py +112 -0
  433. instana_client/models/test_result_item.py +106 -0
  434. instana_client/models/test_result_list_item.py +94 -0
  435. instana_client/models/test_result_list_result.py +103 -0
  436. instana_client/models/test_result_metadata.py +94 -0
  437. instana_client/models/test_result_subtransaction.py +90 -0
  438. instana_client/models/threshold.py +122 -0
  439. instana_client/models/threshold_config_rule.py +114 -0
  440. instana_client/models/threshold_rule.py +125 -0
  441. instana_client/models/throughput_application_alert_rule.py +90 -0
  442. instana_client/models/throughput_mobile_app_alert_rule.py +90 -0
  443. instana_client/models/throughput_website_alert_rule.py +90 -0
  444. instana_client/models/time_frame.py +91 -0
  445. instana_client/models/time_window.py +120 -0
  446. instana_client/models/topology.py +106 -0
  447. instana_client/models/trace.py +109 -0
  448. instana_client/models/trace_activity_tree_node_details.py +139 -0
  449. instana_client/models/trace_download_result.py +111 -0
  450. instana_client/models/trace_groups_item.py +95 -0
  451. instana_client/models/trace_groups_result.py +111 -0
  452. instana_client/models/trace_impact_application_time_threshold.py +92 -0
  453. instana_client/models/trace_item.py +94 -0
  454. instana_client/models/trace_result.py +111 -0
  455. instana_client/models/traffic_blueprint_indicator.py +104 -0
  456. instana_client/models/trigger.py +99 -0
  457. instana_client/models/type_configuration.py +107 -0
  458. instana_client/models/unsupported_http_path_segment_matching_rule.py +90 -0
  459. instana_client/models/updated_business_perspective_config.py +97 -0
  460. instana_client/models/usage_result.py +98 -0
  461. instana_client/models/usage_result_items.py +90 -0
  462. instana_client/models/user_basic_result.py +92 -0
  463. instana_client/models/user_impact_mobile_app_time_threshold.py +103 -0
  464. instana_client/models/user_impact_website_time_threshold.py +103 -0
  465. instana_client/models/user_result.py +98 -0
  466. instana_client/models/users_result.py +106 -0
  467. instana_client/models/validated_alerting_channel_input_info.py +123 -0
  468. instana_client/models/validated_alerting_configuration.py +121 -0
  469. instana_client/models/validated_maintenance_config_v2_with_state_and_occurrence.py +135 -0
  470. instana_client/models/validated_maintenance_config_with_status.py +116 -0
  471. instana_client/models/victor_ops_integration.py +94 -0
  472. instana_client/models/violations_in_period_application_time_threshold.py +92 -0
  473. instana_client/models/violations_in_period_mobile_app_time_threshold.py +92 -0
  474. instana_client/models/violations_in_period_website_time_threshold.py +92 -0
  475. instana_client/models/violations_in_sequence_application_time_threshold.py +89 -0
  476. instana_client/models/violations_in_sequence_infra_time_threshold.py +89 -0
  477. instana_client/models/violations_in_sequence_log_time_threshold.py +89 -0
  478. instana_client/models/violations_in_sequence_mobile_app_time_threshold.py +89 -0
  479. instana_client/models/violations_in_sequence_synthetic_time_threshold.py +89 -0
  480. instana_client/models/violations_in_sequence_website_time_threshold.py +89 -0
  481. instana_client/models/watson_ai_ops_webhook_integration.py +94 -0
  482. instana_client/models/webex_teams_webhook_integration.py +92 -0
  483. instana_client/models/webhook_integration.py +94 -0
  484. instana_client/models/webpage_action_configuration.py +109 -0
  485. instana_client/models/webpage_script_configuration.py +109 -0
  486. instana_client/models/website.py +92 -0
  487. instana_client/models/website_alert_config.py +166 -0
  488. instana_client/models/website_alert_config_with_metadata.py +176 -0
  489. instana_client/models/website_alert_rule.py +132 -0
  490. instana_client/models/website_apdex_entity.py +107 -0
  491. instana_client/models/website_beacon_groups_item.py +95 -0
  492. instana_client/models/website_beacon_groups_result.py +111 -0
  493. instana_client/models/website_beacon_result.py +111 -0
  494. instana_client/models/website_beacon_tag_group.py +100 -0
  495. instana_client/models/website_beacons_item.py +94 -0
  496. instana_client/models/website_event_based_sli_entity.py +110 -0
  497. instana_client/models/website_event_result.py +108 -0
  498. instana_client/models/website_metric_result.py +88 -0
  499. instana_client/models/website_monitoring_beacon.py +301 -0
  500. instana_client/models/website_monitoring_metric_description.py +123 -0
  501. instana_client/models/website_monitoring_metrics_configuration.py +99 -0
  502. instana_client/models/website_slo_entity.py +104 -0
  503. instana_client/models/website_time_based_sli_entity.py +105 -0
  504. instana_client/models/website_time_threshold.py +115 -0
  505. instana_client/models/widget.py +103 -0
  506. instana_client/models/with_metadata.py +172 -0
  507. instana_client/models/with_resolved_name.py +102 -0
  508. instana_client/models/z_chat_ops_integration.py +97 -0
  509. instana_client/py.typed +0 -0
  510. instana_client/rest.py +258 -0
  511. instana_client-1.0.0.dist-info/METADATA +25 -0
  512. instana_client-1.0.0.dist-info/RECORD +515 -0
  513. instana_client-1.0.0.dist-info/WHEEL +5 -0
  514. instana_client-1.0.0.dist-info/licenses/LICENSE +202 -0
  515. instana_client-1.0.0.dist-info/top_level.txt +1 -0
@@ -0,0 +1,1654 @@
1
+ # coding: utf-8
2
+
3
+ """
4
+ Instana REST API documentation
5
+
6
+ Searching for answers and best pratices? Check our [IBM Instana Community](https://community.ibm.com/community/user/aiops/communities/community-home?CommunityKey=58f324a3-3104-41be-9510-5b7c413cc48f). ## Overview The Instana REST API provides programmatic access to the Instana platform. It can be used to retrieve data available through the Instana UI Dashboard -- metrics, events, traces, etc -- and also to automate configuration tasks such as user management. ### Navigating the API documentation The API endpoints are grouped by product area and functionality. This generally maps to how our UI Dashboard is organized, hopefully making it easier to locate which endpoints you'd use to fetch the data you see visualized in our UI. The [UI sections](https://www.ibm.com/docs/en/instana-observability/current?topic=working-user-interface#navigation-menu) include: - Websites & Mobile Apps - Applications - Infrastructure - Synthetic Monitoring - Events - Automation - Service Levels - Settings - etc ### Rate Limiting A rate limit is applied to API usage. Up to 5,000 calls per hour can be made. How many remaining calls can be made and when this call limit resets, can inspected via three headers that are part of the responses of the API server. - **X-RateLimit-Limit:** Shows the maximum number of calls that may be executed per hour. - **X-RateLimit-Remaining:** How many calls may still be executed within the current hour. - **X-RateLimit-Reset:** Time when the remaining calls will be reset to the limit. For compatibility reasons with other rate limited APIs, this date is not the date in milliseconds, but instead in seconds since 1970-01-01T00:00:00+00:00. ### Further Reading We provide additional documentation for our REST API in our [product documentation](https://www.ibm.com/docs/en/instana-observability/current?topic=apis-web-rest-api). Here you'll also find some common queries for retrieving data and configuring Instana. ## Getting Started with the REST API ### API base URL The base URL for an specific instance of Instana can be determined using the tenant and unit information. - `base`: This is the base URL of a tenant unit, e.g. `https://test-example.instana.io`. This is the same URL that is used to access the Instana user interface. - `apiToken`: Requests against the Instana API require valid API tokens. An initial API token can be generated via the Instana user interface. Any additional API tokens can be generated via the API itself. ### Curl Example Here is an Example to use the REST API with Curl. First lets get all the available metrics with possible aggregations with a GET call. ```bash curl --request GET \\ --url https://test-instana.instana.io/api/application-monitoring/catalog/metrics \\ --header 'authorization: apiToken xxxxxxxxxxxxxxxx' ``` Next we can get every call grouped by the endpoint name that has an error count greater then zero. As a metric we could get the mean error rate for example. ```bash curl --request POST \\ --url https://test-instana.instana.io/api/application-monitoring/analyze/call-groups \\ --header 'authorization: apiToken xxxxxxxxxxxxxxxx' \\ --header 'content-type: application/json' \\ --data '{ \"group\":{ \"groupbyTag\":\"endpoint.name\" }, \"tagFilters\":[ { \"name\":\"call.error.count\", \"value\":\"0\", \"operator\":\"GREATER_THAN\" } ], \"metrics\":[ { \"metric\":\"errors\", \"aggregation\":\"MEAN\" } ] }' ``` ### Generating REST API clients The API is specified using the [OpenAPI v3](https://github.com/OAI/OpenAPI-Specification) (previously known as Swagger) format. You can download the current specification at our [GitHub API documentation](https://instana.github.io/openapi/openapi.yaml). OpenAPI tries to solve the issue of ever-evolving APIs and clients lagging behind. Please make sure that you always use the latest version of the generator, as a number of improvements are regularly made. To generate a client library for your language, you can use the [OpenAPI client generators](https://github.com/OpenAPITools/openapi-generator). #### Go For example, to generate a client library for Go to interact with our backend, you can use the following script; mind replacing the values of the `UNIT_NAME` and `TENANT_NAME` environment variables using those for your tenant unit: ```bash #!/bin/bash ### This script assumes you have the `java` and `wget` commands on the path export UNIT_NAME='myunit' # for example: prod export TENANT_NAME='mytenant' # for example: awesomecompany //Download the generator to your current working directory: wget https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/4.3.1/openapi-generator-cli-4.3.1.jar -O openapi-generator-cli.jar --server-variables \"tenant=${TENANT_NAME},unit=${UNIT_NAME}\" //generate a client library that you can vendor into your repository java -jar openapi-generator-cli.jar generate -i https://instana.github.io/openapi/openapi.yaml -g go \\ -o pkg/instana/openapi \\ --skip-validate-spec //(optional) format the Go code according to the Go code standard gofmt -s -w pkg/instana/openapi ``` The generated clients contain comprehensive READMEs, and you can start right away using the client from the example above: ```go import instana \"./pkg/instana/openapi\" // readTags will read all available application monitoring tags along with their type and category func readTags() { configuration := instana.NewConfiguration() configuration.Host = \"tenant-unit.instana.io\" configuration.BasePath = \"https://tenant-unit.instana.io\" client := instana.NewAPIClient(configuration) auth := context.WithValue(context.Background(), instana.ContextAPIKey, instana.APIKey{ Key: apiKey, Prefix: \"apiToken\", }) tags, _, err := client.ApplicationCatalogApi.GetApplicationTagCatalog(auth) if err != nil { fmt.Fatalf(\"Error calling the API, aborting.\") } for _, tag := range tags { fmt.Printf(\"%s (%s): %s\\n\", tag.Category, tag.Type, tag.Name) } } ``` #### Java Follow the instructions provided in the official documentation from [OpenAPI Tools](https://github.com/OpenAPITools) to download the [openapi-generator-cli.jar](https://github.com/OpenAPITools/openapi-generator?tab=readme-ov-file#13---download-jar). Depending on your environment, use one of the following java http client implementations which will create a valid client for our OpenAPI specification: ``` //Nativ Java HTTP Client java -jar openapi-generator-cli.jar generate -i https://instana.github.io/openapi/openapi.yaml -g java -o pkg/instana/openapi --skip-validate-spec -p dateLibrary=java8 --library native //Spring WebClient java -jar openapi-generator-cli.jar generate -i https://instana.github.io/openapi/openapi.yaml -g java -o pkg/instana/openapi --skip-validate-spec -p dateLibrary=java8,hideGenerationTimestamp=true --library webclient //Spring RestTemplate java -jar openapi-generator-cli.jar generate -i https://instana.github.io/openapi/openapi.yaml -g java -o pkg/instana/openapi --skip-validate-spec -p dateLibrary=java8,hideGenerationTimestamp=true --library resttemplate ```
7
+
8
+ The version of the OpenAPI document: 1.291.1002
9
+ Contact: support@instana.com
10
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
11
+
12
+ Do not edit the class manually.
13
+ """ # noqa: E501
14
+
15
+ import warnings
16
+ from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
17
+ from typing import Any, Dict, List, Optional, Tuple, Union
18
+ from typing_extensions import Annotated
19
+
20
+ from pydantic import Field, StrictBool, StrictInt, StrictStr, field_validator
21
+ from typing import List, Optional
22
+ from typing_extensions import Annotated
23
+ from instana_client.models.event_result import EventResult
24
+
25
+ from instana_client.api_client import ApiClient, RequestSerialized
26
+ from instana_client.api_response import ApiResponse
27
+ from instana_client.rest import RESTResponseType
28
+
29
+
30
+ class EventsApi:
31
+ """NOTE: This class is auto generated by OpenAPI Generator
32
+ Ref: https://openapi-generator.tech
33
+
34
+ Do not edit the class manually.
35
+ """
36
+
37
+ def __init__(self, api_client=None) -> None:
38
+ if api_client is None:
39
+ api_client = ApiClient.get_default()
40
+ self.api_client = api_client
41
+
42
+
43
+ @validate_call
44
+ def agent_monitoring_events(
45
+ self,
46
+ to: Annotated[Optional[StrictInt], Field(description="A Unix timestamp representing the end of the requested timeframe. Defaults to the current system time")] = None,
47
+ window_size: Annotated[Optional[StrictInt], Field(description="The size of the requested timeframe, in milliseconds, relative to the 'to' parameter. Defaults to 10 minutes (600000 milliseconds) if neither 'windowSize' nor 'from' are provided. Resulting timeframe range = [to - windowSize, to]")] = None,
48
+ var_from: Annotated[Optional[StrictInt], Field(description="A Unix timestamp representing the start of the requested timeframe. Can be used as an alternative to 'windowSize' to define the timeframe. If both 'from' and 'windowSize' are provided, 'from' takes precedence. Resulting timeframe range = [from, to]")] = None,
49
+ filter_event_updates: Annotated[Optional[StrictBool], Field(description="Flag to filter the results to only show events with state changes within the timeframe.")] = None,
50
+ exclude_triggered_before: Annotated[Optional[StrictBool], Field(description="Flag to filter the results to exclude events that have been triggered before the timeframe. This also filters out events with state changes within the timeframe if the events' start times begin before the timeframe.")] = None,
51
+ _request_timeout: Union[
52
+ None,
53
+ Annotated[StrictFloat, Field(gt=0)],
54
+ Tuple[
55
+ Annotated[StrictFloat, Field(gt=0)],
56
+ Annotated[StrictFloat, Field(gt=0)]
57
+ ]
58
+ ] = None,
59
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
60
+ _content_type: Optional[StrictStr] = None,
61
+ _headers: Optional[Dict[StrictStr, Any]] = None,
62
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
63
+ ) -> List[EventResult]:
64
+ """Get Agent Monitoring Events
65
+
66
+ Gets all Agent Monitoring Events within a timeframe. The timeframe is defined as `[from, to]` or `[to - windowSize, to]`.
67
+
68
+ :param to: A Unix timestamp representing the end of the requested timeframe. Defaults to the current system time
69
+ :type to: int
70
+ :param window_size: The size of the requested timeframe, in milliseconds, relative to the 'to' parameter. Defaults to 10 minutes (600000 milliseconds) if neither 'windowSize' nor 'from' are provided. Resulting timeframe range = [to - windowSize, to]
71
+ :type window_size: int
72
+ :param var_from: A Unix timestamp representing the start of the requested timeframe. Can be used as an alternative to 'windowSize' to define the timeframe. If both 'from' and 'windowSize' are provided, 'from' takes precedence. Resulting timeframe range = [from, to]
73
+ :type var_from: int
74
+ :param filter_event_updates: Flag to filter the results to only show events with state changes within the timeframe.
75
+ :type filter_event_updates: bool
76
+ :param exclude_triggered_before: Flag to filter the results to exclude events that have been triggered before the timeframe. This also filters out events with state changes within the timeframe if the events' start times begin before the timeframe.
77
+ :type exclude_triggered_before: bool
78
+ :param _request_timeout: timeout setting for this request. If one
79
+ number provided, it will be total request
80
+ timeout. It can also be a pair (tuple) of
81
+ (connection, read) timeouts.
82
+ :type _request_timeout: int, tuple(int, int), optional
83
+ :param _request_auth: set to override the auth_settings for an a single
84
+ request; this effectively ignores the
85
+ authentication in the spec for a single request.
86
+ :type _request_auth: dict, optional
87
+ :param _content_type: force content-type for the request.
88
+ :type _content_type: str, Optional
89
+ :param _headers: set to override the headers for a single
90
+ request; this effectively ignores the headers
91
+ in the spec for a single request.
92
+ :type _headers: dict, optional
93
+ :param _host_index: set to override the host_index for a single
94
+ request; this effectively ignores the host_index
95
+ in the spec for a single request.
96
+ :type _host_index: int, optional
97
+ :return: Returns the result object.
98
+ """ # noqa: E501
99
+
100
+ _param = self._agent_monitoring_events_serialize(
101
+ to=to,
102
+ window_size=window_size,
103
+ var_from=var_from,
104
+ filter_event_updates=filter_event_updates,
105
+ exclude_triggered_before=exclude_triggered_before,
106
+ _request_auth=_request_auth,
107
+ _content_type=_content_type,
108
+ _headers=_headers,
109
+ _host_index=_host_index
110
+ )
111
+
112
+ _response_types_map: Dict[str, Optional[str]] = {
113
+ '200': "List[EventResult]",
114
+ '400': None,
115
+ '403': None,
116
+ }
117
+ response_data = self.api_client.call_api(
118
+ *_param,
119
+ _request_timeout=_request_timeout
120
+ )
121
+ response_data.read()
122
+ return self.api_client.response_deserialize(
123
+ response_data=response_data,
124
+ response_types_map=_response_types_map,
125
+ ).data
126
+
127
+
128
+ @validate_call
129
+ def agent_monitoring_events_with_http_info(
130
+ self,
131
+ to: Annotated[Optional[StrictInt], Field(description="A Unix timestamp representing the end of the requested timeframe. Defaults to the current system time")] = None,
132
+ window_size: Annotated[Optional[StrictInt], Field(description="The size of the requested timeframe, in milliseconds, relative to the 'to' parameter. Defaults to 10 minutes (600000 milliseconds) if neither 'windowSize' nor 'from' are provided. Resulting timeframe range = [to - windowSize, to]")] = None,
133
+ var_from: Annotated[Optional[StrictInt], Field(description="A Unix timestamp representing the start of the requested timeframe. Can be used as an alternative to 'windowSize' to define the timeframe. If both 'from' and 'windowSize' are provided, 'from' takes precedence. Resulting timeframe range = [from, to]")] = None,
134
+ filter_event_updates: Annotated[Optional[StrictBool], Field(description="Flag to filter the results to only show events with state changes within the timeframe.")] = None,
135
+ exclude_triggered_before: Annotated[Optional[StrictBool], Field(description="Flag to filter the results to exclude events that have been triggered before the timeframe. This also filters out events with state changes within the timeframe if the events' start times begin before the timeframe.")] = None,
136
+ _request_timeout: Union[
137
+ None,
138
+ Annotated[StrictFloat, Field(gt=0)],
139
+ Tuple[
140
+ Annotated[StrictFloat, Field(gt=0)],
141
+ Annotated[StrictFloat, Field(gt=0)]
142
+ ]
143
+ ] = None,
144
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
145
+ _content_type: Optional[StrictStr] = None,
146
+ _headers: Optional[Dict[StrictStr, Any]] = None,
147
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
148
+ ) -> ApiResponse[List[EventResult]]:
149
+ """Get Agent Monitoring Events
150
+
151
+ Gets all Agent Monitoring Events within a timeframe. The timeframe is defined as `[from, to]` or `[to - windowSize, to]`.
152
+
153
+ :param to: A Unix timestamp representing the end of the requested timeframe. Defaults to the current system time
154
+ :type to: int
155
+ :param window_size: The size of the requested timeframe, in milliseconds, relative to the 'to' parameter. Defaults to 10 minutes (600000 milliseconds) if neither 'windowSize' nor 'from' are provided. Resulting timeframe range = [to - windowSize, to]
156
+ :type window_size: int
157
+ :param var_from: A Unix timestamp representing the start of the requested timeframe. Can be used as an alternative to 'windowSize' to define the timeframe. If both 'from' and 'windowSize' are provided, 'from' takes precedence. Resulting timeframe range = [from, to]
158
+ :type var_from: int
159
+ :param filter_event_updates: Flag to filter the results to only show events with state changes within the timeframe.
160
+ :type filter_event_updates: bool
161
+ :param exclude_triggered_before: Flag to filter the results to exclude events that have been triggered before the timeframe. This also filters out events with state changes within the timeframe if the events' start times begin before the timeframe.
162
+ :type exclude_triggered_before: bool
163
+ :param _request_timeout: timeout setting for this request. If one
164
+ number provided, it will be total request
165
+ timeout. It can also be a pair (tuple) of
166
+ (connection, read) timeouts.
167
+ :type _request_timeout: int, tuple(int, int), optional
168
+ :param _request_auth: set to override the auth_settings for an a single
169
+ request; this effectively ignores the
170
+ authentication in the spec for a single request.
171
+ :type _request_auth: dict, optional
172
+ :param _content_type: force content-type for the request.
173
+ :type _content_type: str, Optional
174
+ :param _headers: set to override the headers for a single
175
+ request; this effectively ignores the headers
176
+ in the spec for a single request.
177
+ :type _headers: dict, optional
178
+ :param _host_index: set to override the host_index for a single
179
+ request; this effectively ignores the host_index
180
+ in the spec for a single request.
181
+ :type _host_index: int, optional
182
+ :return: Returns the result object.
183
+ """ # noqa: E501
184
+
185
+ _param = self._agent_monitoring_events_serialize(
186
+ to=to,
187
+ window_size=window_size,
188
+ var_from=var_from,
189
+ filter_event_updates=filter_event_updates,
190
+ exclude_triggered_before=exclude_triggered_before,
191
+ _request_auth=_request_auth,
192
+ _content_type=_content_type,
193
+ _headers=_headers,
194
+ _host_index=_host_index
195
+ )
196
+
197
+ _response_types_map: Dict[str, Optional[str]] = {
198
+ '200': "List[EventResult]",
199
+ '400': None,
200
+ '403': None,
201
+ }
202
+ response_data = self.api_client.call_api(
203
+ *_param,
204
+ _request_timeout=_request_timeout
205
+ )
206
+ response_data.read()
207
+ return self.api_client.response_deserialize(
208
+ response_data=response_data,
209
+ response_types_map=_response_types_map,
210
+ )
211
+
212
+
213
+ @validate_call
214
+ def agent_monitoring_events_without_preload_content(
215
+ self,
216
+ to: Annotated[Optional[StrictInt], Field(description="A Unix timestamp representing the end of the requested timeframe. Defaults to the current system time")] = None,
217
+ window_size: Annotated[Optional[StrictInt], Field(description="The size of the requested timeframe, in milliseconds, relative to the 'to' parameter. Defaults to 10 minutes (600000 milliseconds) if neither 'windowSize' nor 'from' are provided. Resulting timeframe range = [to - windowSize, to]")] = None,
218
+ var_from: Annotated[Optional[StrictInt], Field(description="A Unix timestamp representing the start of the requested timeframe. Can be used as an alternative to 'windowSize' to define the timeframe. If both 'from' and 'windowSize' are provided, 'from' takes precedence. Resulting timeframe range = [from, to]")] = None,
219
+ filter_event_updates: Annotated[Optional[StrictBool], Field(description="Flag to filter the results to only show events with state changes within the timeframe.")] = None,
220
+ exclude_triggered_before: Annotated[Optional[StrictBool], Field(description="Flag to filter the results to exclude events that have been triggered before the timeframe. This also filters out events with state changes within the timeframe if the events' start times begin before the timeframe.")] = None,
221
+ _request_timeout: Union[
222
+ None,
223
+ Annotated[StrictFloat, Field(gt=0)],
224
+ Tuple[
225
+ Annotated[StrictFloat, Field(gt=0)],
226
+ Annotated[StrictFloat, Field(gt=0)]
227
+ ]
228
+ ] = None,
229
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
230
+ _content_type: Optional[StrictStr] = None,
231
+ _headers: Optional[Dict[StrictStr, Any]] = None,
232
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
233
+ ) -> RESTResponseType:
234
+ """Get Agent Monitoring Events
235
+
236
+ Gets all Agent Monitoring Events within a timeframe. The timeframe is defined as `[from, to]` or `[to - windowSize, to]`.
237
+
238
+ :param to: A Unix timestamp representing the end of the requested timeframe. Defaults to the current system time
239
+ :type to: int
240
+ :param window_size: The size of the requested timeframe, in milliseconds, relative to the 'to' parameter. Defaults to 10 minutes (600000 milliseconds) if neither 'windowSize' nor 'from' are provided. Resulting timeframe range = [to - windowSize, to]
241
+ :type window_size: int
242
+ :param var_from: A Unix timestamp representing the start of the requested timeframe. Can be used as an alternative to 'windowSize' to define the timeframe. If both 'from' and 'windowSize' are provided, 'from' takes precedence. Resulting timeframe range = [from, to]
243
+ :type var_from: int
244
+ :param filter_event_updates: Flag to filter the results to only show events with state changes within the timeframe.
245
+ :type filter_event_updates: bool
246
+ :param exclude_triggered_before: Flag to filter the results to exclude events that have been triggered before the timeframe. This also filters out events with state changes within the timeframe if the events' start times begin before the timeframe.
247
+ :type exclude_triggered_before: bool
248
+ :param _request_timeout: timeout setting for this request. If one
249
+ number provided, it will be total request
250
+ timeout. It can also be a pair (tuple) of
251
+ (connection, read) timeouts.
252
+ :type _request_timeout: int, tuple(int, int), optional
253
+ :param _request_auth: set to override the auth_settings for an a single
254
+ request; this effectively ignores the
255
+ authentication in the spec for a single request.
256
+ :type _request_auth: dict, optional
257
+ :param _content_type: force content-type for the request.
258
+ :type _content_type: str, Optional
259
+ :param _headers: set to override the headers for a single
260
+ request; this effectively ignores the headers
261
+ in the spec for a single request.
262
+ :type _headers: dict, optional
263
+ :param _host_index: set to override the host_index for a single
264
+ request; this effectively ignores the host_index
265
+ in the spec for a single request.
266
+ :type _host_index: int, optional
267
+ :return: Returns the result object.
268
+ """ # noqa: E501
269
+
270
+ _param = self._agent_monitoring_events_serialize(
271
+ to=to,
272
+ window_size=window_size,
273
+ var_from=var_from,
274
+ filter_event_updates=filter_event_updates,
275
+ exclude_triggered_before=exclude_triggered_before,
276
+ _request_auth=_request_auth,
277
+ _content_type=_content_type,
278
+ _headers=_headers,
279
+ _host_index=_host_index
280
+ )
281
+
282
+ _response_types_map: Dict[str, Optional[str]] = {
283
+ '200': "List[EventResult]",
284
+ '400': None,
285
+ '403': None,
286
+ }
287
+ response_data = self.api_client.call_api(
288
+ *_param,
289
+ _request_timeout=_request_timeout
290
+ )
291
+ return response_data.response
292
+
293
+
294
+ def _agent_monitoring_events_serialize(
295
+ self,
296
+ to,
297
+ window_size,
298
+ var_from,
299
+ filter_event_updates,
300
+ exclude_triggered_before,
301
+ _request_auth,
302
+ _content_type,
303
+ _headers,
304
+ _host_index,
305
+ ) -> RequestSerialized:
306
+
307
+ _host = None
308
+
309
+ _collection_formats: Dict[str, str] = {
310
+ }
311
+
312
+ _path_params: Dict[str, str] = {}
313
+ _query_params: List[Tuple[str, str]] = []
314
+ _header_params: Dict[str, Optional[str]] = _headers or {}
315
+ _form_params: List[Tuple[str, str]] = []
316
+ _files: Dict[
317
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
318
+ ] = {}
319
+ _body_params: Optional[bytes] = None
320
+
321
+ # process the path parameters
322
+ # process the query parameters
323
+ if to is not None:
324
+
325
+ _query_params.append(('to', to))
326
+
327
+ if window_size is not None:
328
+
329
+ _query_params.append(('windowSize', window_size))
330
+
331
+ if var_from is not None:
332
+
333
+ _query_params.append(('from', var_from))
334
+
335
+ if filter_event_updates is not None:
336
+
337
+ _query_params.append(('filterEventUpdates', filter_event_updates))
338
+
339
+ if exclude_triggered_before is not None:
340
+
341
+ _query_params.append(('excludeTriggeredBefore', exclude_triggered_before))
342
+
343
+ # process the header parameters
344
+ # process the form parameters
345
+ # process the body parameter
346
+
347
+
348
+ # set the HTTP header `Accept`
349
+ if 'Accept' not in _header_params:
350
+ _header_params['Accept'] = self.api_client.select_header_accept(
351
+ [
352
+ 'application/json'
353
+ ]
354
+ )
355
+
356
+
357
+ # authentication setting
358
+ _auth_settings: List[str] = [
359
+ 'ApiKeyAuth'
360
+ ]
361
+
362
+ return self.api_client.param_serialize(
363
+ method='GET',
364
+ resource_path='/api/events/agent-monitoring-events',
365
+ path_params=_path_params,
366
+ query_params=_query_params,
367
+ header_params=_header_params,
368
+ body=_body_params,
369
+ post_params=_form_params,
370
+ files=_files,
371
+ auth_settings=_auth_settings,
372
+ collection_formats=_collection_formats,
373
+ _host=_host,
374
+ _request_auth=_request_auth
375
+ )
376
+
377
+
378
+
379
+
380
+ @validate_call
381
+ def get_event(
382
+ self,
383
+ event_id: Annotated[StrictStr, Field(description="ID of a specific Event to retrieve.")],
384
+ _request_timeout: Union[
385
+ None,
386
+ Annotated[StrictFloat, Field(gt=0)],
387
+ Tuple[
388
+ Annotated[StrictFloat, Field(gt=0)],
389
+ Annotated[StrictFloat, Field(gt=0)]
390
+ ]
391
+ ] = None,
392
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
393
+ _content_type: Optional[StrictStr] = None,
394
+ _headers: Optional[Dict[StrictStr, Any]] = None,
395
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
396
+ ) -> EventResult:
397
+ """Get Event
398
+
399
+ Gets a specific event.
400
+
401
+ :param event_id: ID of a specific Event to retrieve. (required)
402
+ :type event_id: str
403
+ :param _request_timeout: timeout setting for this request. If one
404
+ number provided, it will be total request
405
+ timeout. It can also be a pair (tuple) of
406
+ (connection, read) timeouts.
407
+ :type _request_timeout: int, tuple(int, int), optional
408
+ :param _request_auth: set to override the auth_settings for an a single
409
+ request; this effectively ignores the
410
+ authentication in the spec for a single request.
411
+ :type _request_auth: dict, optional
412
+ :param _content_type: force content-type for the request.
413
+ :type _content_type: str, Optional
414
+ :param _headers: set to override the headers for a single
415
+ request; this effectively ignores the headers
416
+ in the spec for a single request.
417
+ :type _headers: dict, optional
418
+ :param _host_index: set to override the host_index for a single
419
+ request; this effectively ignores the host_index
420
+ in the spec for a single request.
421
+ :type _host_index: int, optional
422
+ :return: Returns the result object.
423
+ """ # noqa: E501
424
+
425
+ _param = self._get_event_serialize(
426
+ event_id=event_id,
427
+ _request_auth=_request_auth,
428
+ _content_type=_content_type,
429
+ _headers=_headers,
430
+ _host_index=_host_index
431
+ )
432
+
433
+ _response_types_map: Dict[str, Optional[str]] = {
434
+ '200': "EventResult",
435
+ '403': None,
436
+ '404': None,
437
+ }
438
+ response_data = self.api_client.call_api(
439
+ *_param,
440
+ _request_timeout=_request_timeout
441
+ )
442
+ response_data.read()
443
+ return self.api_client.response_deserialize(
444
+ response_data=response_data,
445
+ response_types_map=_response_types_map,
446
+ ).data
447
+
448
+
449
+ @validate_call
450
+ def get_event_with_http_info(
451
+ self,
452
+ event_id: Annotated[StrictStr, Field(description="ID of a specific Event to retrieve.")],
453
+ _request_timeout: Union[
454
+ None,
455
+ Annotated[StrictFloat, Field(gt=0)],
456
+ Tuple[
457
+ Annotated[StrictFloat, Field(gt=0)],
458
+ Annotated[StrictFloat, Field(gt=0)]
459
+ ]
460
+ ] = None,
461
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
462
+ _content_type: Optional[StrictStr] = None,
463
+ _headers: Optional[Dict[StrictStr, Any]] = None,
464
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
465
+ ) -> ApiResponse[EventResult]:
466
+ """Get Event
467
+
468
+ Gets a specific event.
469
+
470
+ :param event_id: ID of a specific Event to retrieve. (required)
471
+ :type event_id: str
472
+ :param _request_timeout: timeout setting for this request. If one
473
+ number provided, it will be total request
474
+ timeout. It can also be a pair (tuple) of
475
+ (connection, read) timeouts.
476
+ :type _request_timeout: int, tuple(int, int), optional
477
+ :param _request_auth: set to override the auth_settings for an a single
478
+ request; this effectively ignores the
479
+ authentication in the spec for a single request.
480
+ :type _request_auth: dict, optional
481
+ :param _content_type: force content-type for the request.
482
+ :type _content_type: str, Optional
483
+ :param _headers: set to override the headers for a single
484
+ request; this effectively ignores the headers
485
+ in the spec for a single request.
486
+ :type _headers: dict, optional
487
+ :param _host_index: set to override the host_index for a single
488
+ request; this effectively ignores the host_index
489
+ in the spec for a single request.
490
+ :type _host_index: int, optional
491
+ :return: Returns the result object.
492
+ """ # noqa: E501
493
+
494
+ _param = self._get_event_serialize(
495
+ event_id=event_id,
496
+ _request_auth=_request_auth,
497
+ _content_type=_content_type,
498
+ _headers=_headers,
499
+ _host_index=_host_index
500
+ )
501
+
502
+ _response_types_map: Dict[str, Optional[str]] = {
503
+ '200': "EventResult",
504
+ '403': None,
505
+ '404': None,
506
+ }
507
+ response_data = self.api_client.call_api(
508
+ *_param,
509
+ _request_timeout=_request_timeout
510
+ )
511
+ response_data.read()
512
+ return self.api_client.response_deserialize(
513
+ response_data=response_data,
514
+ response_types_map=_response_types_map,
515
+ )
516
+
517
+
518
+ @validate_call
519
+ def get_event_without_preload_content(
520
+ self,
521
+ event_id: Annotated[StrictStr, Field(description="ID of a specific Event to retrieve.")],
522
+ _request_timeout: Union[
523
+ None,
524
+ Annotated[StrictFloat, Field(gt=0)],
525
+ Tuple[
526
+ Annotated[StrictFloat, Field(gt=0)],
527
+ Annotated[StrictFloat, Field(gt=0)]
528
+ ]
529
+ ] = None,
530
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
531
+ _content_type: Optional[StrictStr] = None,
532
+ _headers: Optional[Dict[StrictStr, Any]] = None,
533
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
534
+ ) -> RESTResponseType:
535
+ """Get Event
536
+
537
+ Gets a specific event.
538
+
539
+ :param event_id: ID of a specific Event to retrieve. (required)
540
+ :type event_id: str
541
+ :param _request_timeout: timeout setting for this request. If one
542
+ number provided, it will be total request
543
+ timeout. It can also be a pair (tuple) of
544
+ (connection, read) timeouts.
545
+ :type _request_timeout: int, tuple(int, int), optional
546
+ :param _request_auth: set to override the auth_settings for an a single
547
+ request; this effectively ignores the
548
+ authentication in the spec for a single request.
549
+ :type _request_auth: dict, optional
550
+ :param _content_type: force content-type for the request.
551
+ :type _content_type: str, Optional
552
+ :param _headers: set to override the headers for a single
553
+ request; this effectively ignores the headers
554
+ in the spec for a single request.
555
+ :type _headers: dict, optional
556
+ :param _host_index: set to override the host_index for a single
557
+ request; this effectively ignores the host_index
558
+ in the spec for a single request.
559
+ :type _host_index: int, optional
560
+ :return: Returns the result object.
561
+ """ # noqa: E501
562
+
563
+ _param = self._get_event_serialize(
564
+ event_id=event_id,
565
+ _request_auth=_request_auth,
566
+ _content_type=_content_type,
567
+ _headers=_headers,
568
+ _host_index=_host_index
569
+ )
570
+
571
+ _response_types_map: Dict[str, Optional[str]] = {
572
+ '200': "EventResult",
573
+ '403': None,
574
+ '404': None,
575
+ }
576
+ response_data = self.api_client.call_api(
577
+ *_param,
578
+ _request_timeout=_request_timeout
579
+ )
580
+ return response_data.response
581
+
582
+
583
+ def _get_event_serialize(
584
+ self,
585
+ event_id,
586
+ _request_auth,
587
+ _content_type,
588
+ _headers,
589
+ _host_index,
590
+ ) -> RequestSerialized:
591
+
592
+ _host = None
593
+
594
+ _collection_formats: Dict[str, str] = {
595
+ }
596
+
597
+ _path_params: Dict[str, str] = {}
598
+ _query_params: List[Tuple[str, str]] = []
599
+ _header_params: Dict[str, Optional[str]] = _headers or {}
600
+ _form_params: List[Tuple[str, str]] = []
601
+ _files: Dict[
602
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
603
+ ] = {}
604
+ _body_params: Optional[bytes] = None
605
+
606
+ # process the path parameters
607
+ if event_id is not None:
608
+ _path_params['eventId'] = event_id
609
+ # process the query parameters
610
+ # process the header parameters
611
+ # process the form parameters
612
+ # process the body parameter
613
+
614
+
615
+ # set the HTTP header `Accept`
616
+ if 'Accept' not in _header_params:
617
+ _header_params['Accept'] = self.api_client.select_header_accept(
618
+ [
619
+ 'application/json'
620
+ ]
621
+ )
622
+
623
+
624
+ # authentication setting
625
+ _auth_settings: List[str] = [
626
+ 'ApiKeyAuth'
627
+ ]
628
+
629
+ return self.api_client.param_serialize(
630
+ method='GET',
631
+ resource_path='/api/events/{eventId}',
632
+ path_params=_path_params,
633
+ query_params=_query_params,
634
+ header_params=_header_params,
635
+ body=_body_params,
636
+ post_params=_form_params,
637
+ files=_files,
638
+ auth_settings=_auth_settings,
639
+ collection_formats=_collection_formats,
640
+ _host=_host,
641
+ _request_auth=_request_auth
642
+ )
643
+
644
+
645
+
646
+
647
+ @validate_call
648
+ def get_events(
649
+ self,
650
+ to: Annotated[Optional[StrictInt], Field(description="A Unix timestamp representing the end of the requested timeframe. Defaults to the current system time")] = None,
651
+ window_size: Annotated[Optional[StrictInt], Field(description="The size of the requested timeframe, in milliseconds, relative to the 'to' parameter. Defaults to 10 minutes (600000 milliseconds) if neither 'windowSize' nor 'from' are provided. Resulting timeframe range = [to - windowSize, to]")] = None,
652
+ var_from: Annotated[Optional[StrictInt], Field(description="A Unix timestamp representing the start of the requested timeframe. Can be used as an alternative to 'windowSize' to define the timeframe. If both 'from' and 'windowSize' are provided, 'from' takes precedence. Resulting timeframe range = [from, to]")] = None,
653
+ filter_event_updates: Annotated[Optional[StrictBool], Field(description="Flag to filter the results to only show events with state changes within the timeframe.")] = None,
654
+ exclude_triggered_before: Annotated[Optional[StrictBool], Field(description="Flag to filter the results to exclude events that have been triggered before the timeframe. This also filters out events with state changes within the timeframe if the events' start times begin before the timeframe.")] = None,
655
+ include_agent_monitoring_issues: Annotated[Optional[StrictBool], Field(description="Flag to filter the results to include Agent Monitoring Issues.")] = None,
656
+ include_kubernetes_info_events: Annotated[Optional[StrictBool], Field(description="Flag to filter the results to include Kubernetes Info Events.")] = None,
657
+ event_type_filters: Annotated[Optional[List[StrictStr]], Field(description="A string representing an event type - an INCIDENT, ISSUE, or CHANGE. This query can be repeated to use multiple filters.")] = None,
658
+ _request_timeout: Union[
659
+ None,
660
+ Annotated[StrictFloat, Field(gt=0)],
661
+ Tuple[
662
+ Annotated[StrictFloat, Field(gt=0)],
663
+ Annotated[StrictFloat, Field(gt=0)]
664
+ ]
665
+ ] = None,
666
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
667
+ _content_type: Optional[StrictStr] = None,
668
+ _headers: Optional[Dict[StrictStr, Any]] = None,
669
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
670
+ ) -> List[EventResult]:
671
+ """Get all Events
672
+
673
+ Get all Events within a timeframe. The timeframe is defined as `[from, to]` or `[to - windowSize, to]`.
674
+
675
+ :param to: A Unix timestamp representing the end of the requested timeframe. Defaults to the current system time
676
+ :type to: int
677
+ :param window_size: The size of the requested timeframe, in milliseconds, relative to the 'to' parameter. Defaults to 10 minutes (600000 milliseconds) if neither 'windowSize' nor 'from' are provided. Resulting timeframe range = [to - windowSize, to]
678
+ :type window_size: int
679
+ :param var_from: A Unix timestamp representing the start of the requested timeframe. Can be used as an alternative to 'windowSize' to define the timeframe. If both 'from' and 'windowSize' are provided, 'from' takes precedence. Resulting timeframe range = [from, to]
680
+ :type var_from: int
681
+ :param filter_event_updates: Flag to filter the results to only show events with state changes within the timeframe.
682
+ :type filter_event_updates: bool
683
+ :param exclude_triggered_before: Flag to filter the results to exclude events that have been triggered before the timeframe. This also filters out events with state changes within the timeframe if the events' start times begin before the timeframe.
684
+ :type exclude_triggered_before: bool
685
+ :param include_agent_monitoring_issues: Flag to filter the results to include Agent Monitoring Issues.
686
+ :type include_agent_monitoring_issues: bool
687
+ :param include_kubernetes_info_events: Flag to filter the results to include Kubernetes Info Events.
688
+ :type include_kubernetes_info_events: bool
689
+ :param event_type_filters: A string representing an event type - an INCIDENT, ISSUE, or CHANGE. This query can be repeated to use multiple filters.
690
+ :type event_type_filters: List[str]
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._get_events_serialize(
714
+ to=to,
715
+ window_size=window_size,
716
+ var_from=var_from,
717
+ filter_event_updates=filter_event_updates,
718
+ exclude_triggered_before=exclude_triggered_before,
719
+ include_agent_monitoring_issues=include_agent_monitoring_issues,
720
+ include_kubernetes_info_events=include_kubernetes_info_events,
721
+ event_type_filters=event_type_filters,
722
+ _request_auth=_request_auth,
723
+ _content_type=_content_type,
724
+ _headers=_headers,
725
+ _host_index=_host_index
726
+ )
727
+
728
+ _response_types_map: Dict[str, Optional[str]] = {
729
+ '200': "List[EventResult]",
730
+ '400': None,
731
+ '403': None,
732
+ }
733
+ response_data = self.api_client.call_api(
734
+ *_param,
735
+ _request_timeout=_request_timeout
736
+ )
737
+ response_data.read()
738
+ return self.api_client.response_deserialize(
739
+ response_data=response_data,
740
+ response_types_map=_response_types_map,
741
+ ).data
742
+
743
+
744
+ @validate_call
745
+ def get_events_with_http_info(
746
+ self,
747
+ to: Annotated[Optional[StrictInt], Field(description="A Unix timestamp representing the end of the requested timeframe. Defaults to the current system time")] = None,
748
+ window_size: Annotated[Optional[StrictInt], Field(description="The size of the requested timeframe, in milliseconds, relative to the 'to' parameter. Defaults to 10 minutes (600000 milliseconds) if neither 'windowSize' nor 'from' are provided. Resulting timeframe range = [to - windowSize, to]")] = None,
749
+ var_from: Annotated[Optional[StrictInt], Field(description="A Unix timestamp representing the start of the requested timeframe. Can be used as an alternative to 'windowSize' to define the timeframe. If both 'from' and 'windowSize' are provided, 'from' takes precedence. Resulting timeframe range = [from, to]")] = None,
750
+ filter_event_updates: Annotated[Optional[StrictBool], Field(description="Flag to filter the results to only show events with state changes within the timeframe.")] = None,
751
+ exclude_triggered_before: Annotated[Optional[StrictBool], Field(description="Flag to filter the results to exclude events that have been triggered before the timeframe. This also filters out events with state changes within the timeframe if the events' start times begin before the timeframe.")] = None,
752
+ include_agent_monitoring_issues: Annotated[Optional[StrictBool], Field(description="Flag to filter the results to include Agent Monitoring Issues.")] = None,
753
+ include_kubernetes_info_events: Annotated[Optional[StrictBool], Field(description="Flag to filter the results to include Kubernetes Info Events.")] = None,
754
+ event_type_filters: Annotated[Optional[List[StrictStr]], Field(description="A string representing an event type - an INCIDENT, ISSUE, or CHANGE. This query can be repeated to use multiple filters.")] = None,
755
+ _request_timeout: Union[
756
+ None,
757
+ Annotated[StrictFloat, Field(gt=0)],
758
+ Tuple[
759
+ Annotated[StrictFloat, Field(gt=0)],
760
+ Annotated[StrictFloat, Field(gt=0)]
761
+ ]
762
+ ] = None,
763
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
764
+ _content_type: Optional[StrictStr] = None,
765
+ _headers: Optional[Dict[StrictStr, Any]] = None,
766
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
767
+ ) -> ApiResponse[List[EventResult]]:
768
+ """Get all Events
769
+
770
+ Get all Events within a timeframe. The timeframe is defined as `[from, to]` or `[to - windowSize, to]`.
771
+
772
+ :param to: A Unix timestamp representing the end of the requested timeframe. Defaults to the current system time
773
+ :type to: int
774
+ :param window_size: The size of the requested timeframe, in milliseconds, relative to the 'to' parameter. Defaults to 10 minutes (600000 milliseconds) if neither 'windowSize' nor 'from' are provided. Resulting timeframe range = [to - windowSize, to]
775
+ :type window_size: int
776
+ :param var_from: A Unix timestamp representing the start of the requested timeframe. Can be used as an alternative to 'windowSize' to define the timeframe. If both 'from' and 'windowSize' are provided, 'from' takes precedence. Resulting timeframe range = [from, to]
777
+ :type var_from: int
778
+ :param filter_event_updates: Flag to filter the results to only show events with state changes within the timeframe.
779
+ :type filter_event_updates: bool
780
+ :param exclude_triggered_before: Flag to filter the results to exclude events that have been triggered before the timeframe. This also filters out events with state changes within the timeframe if the events' start times begin before the timeframe.
781
+ :type exclude_triggered_before: bool
782
+ :param include_agent_monitoring_issues: Flag to filter the results to include Agent Monitoring Issues.
783
+ :type include_agent_monitoring_issues: bool
784
+ :param include_kubernetes_info_events: Flag to filter the results to include Kubernetes Info Events.
785
+ :type include_kubernetes_info_events: bool
786
+ :param event_type_filters: A string representing an event type - an INCIDENT, ISSUE, or CHANGE. This query can be repeated to use multiple filters.
787
+ :type event_type_filters: List[str]
788
+ :param _request_timeout: timeout setting for this request. If one
789
+ number provided, it will be total request
790
+ timeout. It can also be a pair (tuple) of
791
+ (connection, read) timeouts.
792
+ :type _request_timeout: int, tuple(int, int), optional
793
+ :param _request_auth: set to override the auth_settings for an a single
794
+ request; this effectively ignores the
795
+ authentication in the spec for a single request.
796
+ :type _request_auth: dict, optional
797
+ :param _content_type: force content-type for the request.
798
+ :type _content_type: str, Optional
799
+ :param _headers: set to override the headers for a single
800
+ request; this effectively ignores the headers
801
+ in the spec for a single request.
802
+ :type _headers: dict, optional
803
+ :param _host_index: set to override the host_index for a single
804
+ request; this effectively ignores the host_index
805
+ in the spec for a single request.
806
+ :type _host_index: int, optional
807
+ :return: Returns the result object.
808
+ """ # noqa: E501
809
+
810
+ _param = self._get_events_serialize(
811
+ to=to,
812
+ window_size=window_size,
813
+ var_from=var_from,
814
+ filter_event_updates=filter_event_updates,
815
+ exclude_triggered_before=exclude_triggered_before,
816
+ include_agent_monitoring_issues=include_agent_monitoring_issues,
817
+ include_kubernetes_info_events=include_kubernetes_info_events,
818
+ event_type_filters=event_type_filters,
819
+ _request_auth=_request_auth,
820
+ _content_type=_content_type,
821
+ _headers=_headers,
822
+ _host_index=_host_index
823
+ )
824
+
825
+ _response_types_map: Dict[str, Optional[str]] = {
826
+ '200': "List[EventResult]",
827
+ '400': None,
828
+ '403': None,
829
+ }
830
+ response_data = self.api_client.call_api(
831
+ *_param,
832
+ _request_timeout=_request_timeout
833
+ )
834
+ response_data.read()
835
+ return self.api_client.response_deserialize(
836
+ response_data=response_data,
837
+ response_types_map=_response_types_map,
838
+ )
839
+
840
+
841
+ @validate_call
842
+ def get_events_without_preload_content(
843
+ self,
844
+ to: Annotated[Optional[StrictInt], Field(description="A Unix timestamp representing the end of the requested timeframe. Defaults to the current system time")] = None,
845
+ window_size: Annotated[Optional[StrictInt], Field(description="The size of the requested timeframe, in milliseconds, relative to the 'to' parameter. Defaults to 10 minutes (600000 milliseconds) if neither 'windowSize' nor 'from' are provided. Resulting timeframe range = [to - windowSize, to]")] = None,
846
+ var_from: Annotated[Optional[StrictInt], Field(description="A Unix timestamp representing the start of the requested timeframe. Can be used as an alternative to 'windowSize' to define the timeframe. If both 'from' and 'windowSize' are provided, 'from' takes precedence. Resulting timeframe range = [from, to]")] = None,
847
+ filter_event_updates: Annotated[Optional[StrictBool], Field(description="Flag to filter the results to only show events with state changes within the timeframe.")] = None,
848
+ exclude_triggered_before: Annotated[Optional[StrictBool], Field(description="Flag to filter the results to exclude events that have been triggered before the timeframe. This also filters out events with state changes within the timeframe if the events' start times begin before the timeframe.")] = None,
849
+ include_agent_monitoring_issues: Annotated[Optional[StrictBool], Field(description="Flag to filter the results to include Agent Monitoring Issues.")] = None,
850
+ include_kubernetes_info_events: Annotated[Optional[StrictBool], Field(description="Flag to filter the results to include Kubernetes Info Events.")] = None,
851
+ event_type_filters: Annotated[Optional[List[StrictStr]], Field(description="A string representing an event type - an INCIDENT, ISSUE, or CHANGE. This query can be repeated to use multiple filters.")] = None,
852
+ _request_timeout: Union[
853
+ None,
854
+ Annotated[StrictFloat, Field(gt=0)],
855
+ Tuple[
856
+ Annotated[StrictFloat, Field(gt=0)],
857
+ Annotated[StrictFloat, Field(gt=0)]
858
+ ]
859
+ ] = None,
860
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
861
+ _content_type: Optional[StrictStr] = None,
862
+ _headers: Optional[Dict[StrictStr, Any]] = None,
863
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
864
+ ) -> RESTResponseType:
865
+ """Get all Events
866
+
867
+ Get all Events within a timeframe. The timeframe is defined as `[from, to]` or `[to - windowSize, to]`.
868
+
869
+ :param to: A Unix timestamp representing the end of the requested timeframe. Defaults to the current system time
870
+ :type to: int
871
+ :param window_size: The size of the requested timeframe, in milliseconds, relative to the 'to' parameter. Defaults to 10 minutes (600000 milliseconds) if neither 'windowSize' nor 'from' are provided. Resulting timeframe range = [to - windowSize, to]
872
+ :type window_size: int
873
+ :param var_from: A Unix timestamp representing the start of the requested timeframe. Can be used as an alternative to 'windowSize' to define the timeframe. If both 'from' and 'windowSize' are provided, 'from' takes precedence. Resulting timeframe range = [from, to]
874
+ :type var_from: int
875
+ :param filter_event_updates: Flag to filter the results to only show events with state changes within the timeframe.
876
+ :type filter_event_updates: bool
877
+ :param exclude_triggered_before: Flag to filter the results to exclude events that have been triggered before the timeframe. This also filters out events with state changes within the timeframe if the events' start times begin before the timeframe.
878
+ :type exclude_triggered_before: bool
879
+ :param include_agent_monitoring_issues: Flag to filter the results to include Agent Monitoring Issues.
880
+ :type include_agent_monitoring_issues: bool
881
+ :param include_kubernetes_info_events: Flag to filter the results to include Kubernetes Info Events.
882
+ :type include_kubernetes_info_events: bool
883
+ :param event_type_filters: A string representing an event type - an INCIDENT, ISSUE, or CHANGE. This query can be repeated to use multiple filters.
884
+ :type event_type_filters: List[str]
885
+ :param _request_timeout: timeout setting for this request. If one
886
+ number provided, it will be total request
887
+ timeout. It can also be a pair (tuple) of
888
+ (connection, read) timeouts.
889
+ :type _request_timeout: int, tuple(int, int), optional
890
+ :param _request_auth: set to override the auth_settings for an a single
891
+ request; this effectively ignores the
892
+ authentication in the spec for a single request.
893
+ :type _request_auth: dict, optional
894
+ :param _content_type: force content-type for the request.
895
+ :type _content_type: str, Optional
896
+ :param _headers: set to override the headers for a single
897
+ request; this effectively ignores the headers
898
+ in the spec for a single request.
899
+ :type _headers: dict, optional
900
+ :param _host_index: set to override the host_index for a single
901
+ request; this effectively ignores the host_index
902
+ in the spec for a single request.
903
+ :type _host_index: int, optional
904
+ :return: Returns the result object.
905
+ """ # noqa: E501
906
+
907
+ _param = self._get_events_serialize(
908
+ to=to,
909
+ window_size=window_size,
910
+ var_from=var_from,
911
+ filter_event_updates=filter_event_updates,
912
+ exclude_triggered_before=exclude_triggered_before,
913
+ include_agent_monitoring_issues=include_agent_monitoring_issues,
914
+ include_kubernetes_info_events=include_kubernetes_info_events,
915
+ event_type_filters=event_type_filters,
916
+ _request_auth=_request_auth,
917
+ _content_type=_content_type,
918
+ _headers=_headers,
919
+ _host_index=_host_index
920
+ )
921
+
922
+ _response_types_map: Dict[str, Optional[str]] = {
923
+ '200': "List[EventResult]",
924
+ '400': None,
925
+ '403': None,
926
+ }
927
+ response_data = self.api_client.call_api(
928
+ *_param,
929
+ _request_timeout=_request_timeout
930
+ )
931
+ return response_data.response
932
+
933
+
934
+ def _get_events_serialize(
935
+ self,
936
+ to,
937
+ window_size,
938
+ var_from,
939
+ filter_event_updates,
940
+ exclude_triggered_before,
941
+ include_agent_monitoring_issues,
942
+ include_kubernetes_info_events,
943
+ event_type_filters,
944
+ _request_auth,
945
+ _content_type,
946
+ _headers,
947
+ _host_index,
948
+ ) -> RequestSerialized:
949
+
950
+ _host = None
951
+
952
+ _collection_formats: Dict[str, str] = {
953
+ 'eventTypeFilters': 'multi',
954
+ }
955
+
956
+ _path_params: Dict[str, str] = {}
957
+ _query_params: List[Tuple[str, str]] = []
958
+ _header_params: Dict[str, Optional[str]] = _headers or {}
959
+ _form_params: List[Tuple[str, str]] = []
960
+ _files: Dict[
961
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
962
+ ] = {}
963
+ _body_params: Optional[bytes] = None
964
+
965
+ # process the path parameters
966
+ # process the query parameters
967
+ if to is not None:
968
+
969
+ _query_params.append(('to', to))
970
+
971
+ if window_size is not None:
972
+
973
+ _query_params.append(('windowSize', window_size))
974
+
975
+ if var_from is not None:
976
+
977
+ _query_params.append(('from', var_from))
978
+
979
+ if filter_event_updates is not None:
980
+
981
+ _query_params.append(('filterEventUpdates', filter_event_updates))
982
+
983
+ if exclude_triggered_before is not None:
984
+
985
+ _query_params.append(('excludeTriggeredBefore', exclude_triggered_before))
986
+
987
+ if include_agent_monitoring_issues is not None:
988
+
989
+ _query_params.append(('includeAgentMonitoringIssues', include_agent_monitoring_issues))
990
+
991
+ if include_kubernetes_info_events is not None:
992
+
993
+ _query_params.append(('includeKubernetesInfoEvents', include_kubernetes_info_events))
994
+
995
+ if event_type_filters is not None:
996
+
997
+ _query_params.append(('eventTypeFilters', event_type_filters))
998
+
999
+ # process the header parameters
1000
+ # process the form parameters
1001
+ # process the body parameter
1002
+
1003
+
1004
+ # set the HTTP header `Accept`
1005
+ if 'Accept' not in _header_params:
1006
+ _header_params['Accept'] = self.api_client.select_header_accept(
1007
+ [
1008
+ 'application/json'
1009
+ ]
1010
+ )
1011
+
1012
+
1013
+ # authentication setting
1014
+ _auth_settings: List[str] = [
1015
+ 'ApiKeyAuth'
1016
+ ]
1017
+
1018
+ return self.api_client.param_serialize(
1019
+ method='GET',
1020
+ resource_path='/api/events',
1021
+ path_params=_path_params,
1022
+ query_params=_query_params,
1023
+ header_params=_header_params,
1024
+ body=_body_params,
1025
+ post_params=_form_params,
1026
+ files=_files,
1027
+ auth_settings=_auth_settings,
1028
+ collection_formats=_collection_formats,
1029
+ _host=_host,
1030
+ _request_auth=_request_auth
1031
+ )
1032
+
1033
+
1034
+
1035
+
1036
+ @validate_call
1037
+ def get_events_by_ids(
1038
+ self,
1039
+ request_body: List[StrictStr],
1040
+ _request_timeout: Union[
1041
+ None,
1042
+ Annotated[StrictFloat, Field(gt=0)],
1043
+ Tuple[
1044
+ Annotated[StrictFloat, Field(gt=0)],
1045
+ Annotated[StrictFloat, Field(gt=0)]
1046
+ ]
1047
+ ] = None,
1048
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1049
+ _content_type: Optional[StrictStr] = None,
1050
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1051
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1052
+ ) -> List[EventResult]:
1053
+ """Get Events by IDs
1054
+
1055
+ Gets a set of events by their IDs.
1056
+
1057
+ :param request_body: (required)
1058
+ :type request_body: List[str]
1059
+ :param _request_timeout: timeout setting for this request. If one
1060
+ number provided, it will be total request
1061
+ timeout. It can also be a pair (tuple) of
1062
+ (connection, read) timeouts.
1063
+ :type _request_timeout: int, tuple(int, int), optional
1064
+ :param _request_auth: set to override the auth_settings for an a single
1065
+ request; this effectively ignores the
1066
+ authentication in the spec for a single request.
1067
+ :type _request_auth: dict, optional
1068
+ :param _content_type: force content-type for the request.
1069
+ :type _content_type: str, Optional
1070
+ :param _headers: set to override the headers for a single
1071
+ request; this effectively ignores the headers
1072
+ in the spec for a single request.
1073
+ :type _headers: dict, optional
1074
+ :param _host_index: set to override the host_index for a single
1075
+ request; this effectively ignores the host_index
1076
+ in the spec for a single request.
1077
+ :type _host_index: int, optional
1078
+ :return: Returns the result object.
1079
+ """ # noqa: E501
1080
+
1081
+ _param = self._get_events_by_ids_serialize(
1082
+ request_body=request_body,
1083
+ _request_auth=_request_auth,
1084
+ _content_type=_content_type,
1085
+ _headers=_headers,
1086
+ _host_index=_host_index
1087
+ )
1088
+
1089
+ _response_types_map: Dict[str, Optional[str]] = {
1090
+ '200': "List[EventResult]",
1091
+ '403': None,
1092
+ '404': None,
1093
+ '422': None,
1094
+ }
1095
+ response_data = self.api_client.call_api(
1096
+ *_param,
1097
+ _request_timeout=_request_timeout
1098
+ )
1099
+ response_data.read()
1100
+ return self.api_client.response_deserialize(
1101
+ response_data=response_data,
1102
+ response_types_map=_response_types_map,
1103
+ ).data
1104
+
1105
+
1106
+ @validate_call
1107
+ def get_events_by_ids_with_http_info(
1108
+ self,
1109
+ request_body: List[StrictStr],
1110
+ _request_timeout: Union[
1111
+ None,
1112
+ Annotated[StrictFloat, Field(gt=0)],
1113
+ Tuple[
1114
+ Annotated[StrictFloat, Field(gt=0)],
1115
+ Annotated[StrictFloat, Field(gt=0)]
1116
+ ]
1117
+ ] = None,
1118
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1119
+ _content_type: Optional[StrictStr] = None,
1120
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1121
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1122
+ ) -> ApiResponse[List[EventResult]]:
1123
+ """Get Events by IDs
1124
+
1125
+ Gets a set of events by their IDs.
1126
+
1127
+ :param request_body: (required)
1128
+ :type request_body: List[str]
1129
+ :param _request_timeout: timeout setting for this request. If one
1130
+ number provided, it will be total request
1131
+ timeout. It can also be a pair (tuple) of
1132
+ (connection, read) timeouts.
1133
+ :type _request_timeout: int, tuple(int, int), optional
1134
+ :param _request_auth: set to override the auth_settings for an a single
1135
+ request; this effectively ignores the
1136
+ authentication in the spec for a single request.
1137
+ :type _request_auth: dict, optional
1138
+ :param _content_type: force content-type for the request.
1139
+ :type _content_type: str, Optional
1140
+ :param _headers: set to override the headers for a single
1141
+ request; this effectively ignores the headers
1142
+ in the spec for a single request.
1143
+ :type _headers: dict, optional
1144
+ :param _host_index: set to override the host_index for a single
1145
+ request; this effectively ignores the host_index
1146
+ in the spec for a single request.
1147
+ :type _host_index: int, optional
1148
+ :return: Returns the result object.
1149
+ """ # noqa: E501
1150
+
1151
+ _param = self._get_events_by_ids_serialize(
1152
+ request_body=request_body,
1153
+ _request_auth=_request_auth,
1154
+ _content_type=_content_type,
1155
+ _headers=_headers,
1156
+ _host_index=_host_index
1157
+ )
1158
+
1159
+ _response_types_map: Dict[str, Optional[str]] = {
1160
+ '200': "List[EventResult]",
1161
+ '403': None,
1162
+ '404': None,
1163
+ '422': None,
1164
+ }
1165
+ response_data = self.api_client.call_api(
1166
+ *_param,
1167
+ _request_timeout=_request_timeout
1168
+ )
1169
+ response_data.read()
1170
+ return self.api_client.response_deserialize(
1171
+ response_data=response_data,
1172
+ response_types_map=_response_types_map,
1173
+ )
1174
+
1175
+
1176
+ @validate_call
1177
+ def get_events_by_ids_without_preload_content(
1178
+ self,
1179
+ request_body: List[StrictStr],
1180
+ _request_timeout: Union[
1181
+ None,
1182
+ Annotated[StrictFloat, Field(gt=0)],
1183
+ Tuple[
1184
+ Annotated[StrictFloat, Field(gt=0)],
1185
+ Annotated[StrictFloat, Field(gt=0)]
1186
+ ]
1187
+ ] = None,
1188
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1189
+ _content_type: Optional[StrictStr] = None,
1190
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1191
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1192
+ ) -> RESTResponseType:
1193
+ """Get Events by IDs
1194
+
1195
+ Gets a set of events by their IDs.
1196
+
1197
+ :param request_body: (required)
1198
+ :type request_body: List[str]
1199
+ :param _request_timeout: timeout setting for this request. If one
1200
+ number provided, it will be total request
1201
+ timeout. It can also be a pair (tuple) of
1202
+ (connection, read) timeouts.
1203
+ :type _request_timeout: int, tuple(int, int), optional
1204
+ :param _request_auth: set to override the auth_settings for an a single
1205
+ request; this effectively ignores the
1206
+ authentication in the spec for a single request.
1207
+ :type _request_auth: dict, optional
1208
+ :param _content_type: force content-type for the request.
1209
+ :type _content_type: str, Optional
1210
+ :param _headers: set to override the headers for a single
1211
+ request; this effectively ignores the headers
1212
+ in the spec for a single request.
1213
+ :type _headers: dict, optional
1214
+ :param _host_index: set to override the host_index for a single
1215
+ request; this effectively ignores the host_index
1216
+ in the spec for a single request.
1217
+ :type _host_index: int, optional
1218
+ :return: Returns the result object.
1219
+ """ # noqa: E501
1220
+
1221
+ _param = self._get_events_by_ids_serialize(
1222
+ request_body=request_body,
1223
+ _request_auth=_request_auth,
1224
+ _content_type=_content_type,
1225
+ _headers=_headers,
1226
+ _host_index=_host_index
1227
+ )
1228
+
1229
+ _response_types_map: Dict[str, Optional[str]] = {
1230
+ '200': "List[EventResult]",
1231
+ '403': None,
1232
+ '404': None,
1233
+ '422': None,
1234
+ }
1235
+ response_data = self.api_client.call_api(
1236
+ *_param,
1237
+ _request_timeout=_request_timeout
1238
+ )
1239
+ return response_data.response
1240
+
1241
+
1242
+ def _get_events_by_ids_serialize(
1243
+ self,
1244
+ request_body,
1245
+ _request_auth,
1246
+ _content_type,
1247
+ _headers,
1248
+ _host_index,
1249
+ ) -> RequestSerialized:
1250
+
1251
+ _host = None
1252
+
1253
+ _collection_formats: Dict[str, str] = {
1254
+ 'request_body': '',
1255
+ }
1256
+
1257
+ _path_params: Dict[str, str] = {}
1258
+ _query_params: List[Tuple[str, str]] = []
1259
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1260
+ _form_params: List[Tuple[str, str]] = []
1261
+ _files: Dict[
1262
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1263
+ ] = {}
1264
+ _body_params: Optional[bytes] = None
1265
+
1266
+ # process the path parameters
1267
+ # process the query parameters
1268
+ # process the header parameters
1269
+ # process the form parameters
1270
+ # process the body parameter
1271
+ if request_body is not None:
1272
+ _body_params = request_body
1273
+
1274
+
1275
+ # set the HTTP header `Accept`
1276
+ if 'Accept' not in _header_params:
1277
+ _header_params['Accept'] = self.api_client.select_header_accept(
1278
+ [
1279
+ 'application/json'
1280
+ ]
1281
+ )
1282
+
1283
+ # set the HTTP header `Content-Type`
1284
+ if _content_type:
1285
+ _header_params['Content-Type'] = _content_type
1286
+ else:
1287
+ _default_content_type = (
1288
+ self.api_client.select_header_content_type(
1289
+ [
1290
+ 'application/json'
1291
+ ]
1292
+ )
1293
+ )
1294
+ if _default_content_type is not None:
1295
+ _header_params['Content-Type'] = _default_content_type
1296
+
1297
+ # authentication setting
1298
+ _auth_settings: List[str] = [
1299
+ 'ApiKeyAuth'
1300
+ ]
1301
+
1302
+ return self.api_client.param_serialize(
1303
+ method='POST',
1304
+ resource_path='/api/events',
1305
+ path_params=_path_params,
1306
+ query_params=_query_params,
1307
+ header_params=_header_params,
1308
+ body=_body_params,
1309
+ post_params=_form_params,
1310
+ files=_files,
1311
+ auth_settings=_auth_settings,
1312
+ collection_formats=_collection_formats,
1313
+ _host=_host,
1314
+ _request_auth=_request_auth
1315
+ )
1316
+
1317
+
1318
+
1319
+
1320
+ @validate_call
1321
+ def kubernetes_info_events(
1322
+ self,
1323
+ to: Annotated[Optional[StrictInt], Field(description="A Unix timestamp representing the end of the requested timeframe. Defaults to the current system time")] = None,
1324
+ window_size: Annotated[Optional[StrictInt], Field(description="The size of the requested timeframe, in milliseconds, relative to the 'to' parameter. Defaults to 10 minutes (600000 milliseconds) if neither 'windowSize' nor 'from' are provided. Resulting timeframe range = [to - windowSize, to]")] = None,
1325
+ var_from: Annotated[Optional[StrictInt], Field(description="A Unix timestamp representing the start of the requested timeframe. Can be used as an alternative to 'windowSize' to define the timeframe. If both 'from' and 'windowSize' are provided, 'from' takes precedence. Resulting timeframe range = [from, to]")] = None,
1326
+ filter_event_updates: Annotated[Optional[StrictBool], Field(description="Flag to filter the results to only show events with state changes within the timeframe.")] = None,
1327
+ exclude_triggered_before: Annotated[Optional[StrictBool], Field(description="Flag to filter the results to exclude events that have been triggered before the timeframe. This also filters out events with state changes within the timeframe if the events' start times begin before the timeframe.")] = None,
1328
+ _request_timeout: Union[
1329
+ None,
1330
+ Annotated[StrictFloat, Field(gt=0)],
1331
+ Tuple[
1332
+ Annotated[StrictFloat, Field(gt=0)],
1333
+ Annotated[StrictFloat, Field(gt=0)]
1334
+ ]
1335
+ ] = None,
1336
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1337
+ _content_type: Optional[StrictStr] = None,
1338
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1339
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1340
+ ) -> List[EventResult]:
1341
+ """Get Kubernetes Info Events
1342
+
1343
+ Gets all Kubernetes Info Events within a timeframe. The timeframe is defined as `[from, to]` or `[to - windowSize, to]`.
1344
+
1345
+ :param to: A Unix timestamp representing the end of the requested timeframe. Defaults to the current system time
1346
+ :type to: int
1347
+ :param window_size: The size of the requested timeframe, in milliseconds, relative to the 'to' parameter. Defaults to 10 minutes (600000 milliseconds) if neither 'windowSize' nor 'from' are provided. Resulting timeframe range = [to - windowSize, to]
1348
+ :type window_size: int
1349
+ :param var_from: A Unix timestamp representing the start of the requested timeframe. Can be used as an alternative to 'windowSize' to define the timeframe. If both 'from' and 'windowSize' are provided, 'from' takes precedence. Resulting timeframe range = [from, to]
1350
+ :type var_from: int
1351
+ :param filter_event_updates: Flag to filter the results to only show events with state changes within the timeframe.
1352
+ :type filter_event_updates: bool
1353
+ :param exclude_triggered_before: Flag to filter the results to exclude events that have been triggered before the timeframe. This also filters out events with state changes within the timeframe if the events' start times begin before the timeframe.
1354
+ :type exclude_triggered_before: bool
1355
+ :param _request_timeout: timeout setting for this request. If one
1356
+ number provided, it will be total request
1357
+ timeout. It can also be a pair (tuple) of
1358
+ (connection, read) timeouts.
1359
+ :type _request_timeout: int, tuple(int, int), optional
1360
+ :param _request_auth: set to override the auth_settings for an a single
1361
+ request; this effectively ignores the
1362
+ authentication in the spec for a single request.
1363
+ :type _request_auth: dict, optional
1364
+ :param _content_type: force content-type for the request.
1365
+ :type _content_type: str, Optional
1366
+ :param _headers: set to override the headers for a single
1367
+ request; this effectively ignores the headers
1368
+ in the spec for a single request.
1369
+ :type _headers: dict, optional
1370
+ :param _host_index: set to override the host_index for a single
1371
+ request; this effectively ignores the host_index
1372
+ in the spec for a single request.
1373
+ :type _host_index: int, optional
1374
+ :return: Returns the result object.
1375
+ """ # noqa: E501
1376
+
1377
+ _param = self._kubernetes_info_events_serialize(
1378
+ to=to,
1379
+ window_size=window_size,
1380
+ var_from=var_from,
1381
+ filter_event_updates=filter_event_updates,
1382
+ exclude_triggered_before=exclude_triggered_before,
1383
+ _request_auth=_request_auth,
1384
+ _content_type=_content_type,
1385
+ _headers=_headers,
1386
+ _host_index=_host_index
1387
+ )
1388
+
1389
+ _response_types_map: Dict[str, Optional[str]] = {
1390
+ '200': "List[EventResult]",
1391
+ '400': None,
1392
+ '403': None,
1393
+ }
1394
+ response_data = self.api_client.call_api(
1395
+ *_param,
1396
+ _request_timeout=_request_timeout
1397
+ )
1398
+ response_data.read()
1399
+ return self.api_client.response_deserialize(
1400
+ response_data=response_data,
1401
+ response_types_map=_response_types_map,
1402
+ ).data
1403
+
1404
+
1405
+ @validate_call
1406
+ def kubernetes_info_events_with_http_info(
1407
+ self,
1408
+ to: Annotated[Optional[StrictInt], Field(description="A Unix timestamp representing the end of the requested timeframe. Defaults to the current system time")] = None,
1409
+ window_size: Annotated[Optional[StrictInt], Field(description="The size of the requested timeframe, in milliseconds, relative to the 'to' parameter. Defaults to 10 minutes (600000 milliseconds) if neither 'windowSize' nor 'from' are provided. Resulting timeframe range = [to - windowSize, to]")] = None,
1410
+ var_from: Annotated[Optional[StrictInt], Field(description="A Unix timestamp representing the start of the requested timeframe. Can be used as an alternative to 'windowSize' to define the timeframe. If both 'from' and 'windowSize' are provided, 'from' takes precedence. Resulting timeframe range = [from, to]")] = None,
1411
+ filter_event_updates: Annotated[Optional[StrictBool], Field(description="Flag to filter the results to only show events with state changes within the timeframe.")] = None,
1412
+ exclude_triggered_before: Annotated[Optional[StrictBool], Field(description="Flag to filter the results to exclude events that have been triggered before the timeframe. This also filters out events with state changes within the timeframe if the events' start times begin before the timeframe.")] = None,
1413
+ _request_timeout: Union[
1414
+ None,
1415
+ Annotated[StrictFloat, Field(gt=0)],
1416
+ Tuple[
1417
+ Annotated[StrictFloat, Field(gt=0)],
1418
+ Annotated[StrictFloat, Field(gt=0)]
1419
+ ]
1420
+ ] = None,
1421
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1422
+ _content_type: Optional[StrictStr] = None,
1423
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1424
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1425
+ ) -> ApiResponse[List[EventResult]]:
1426
+ """Get Kubernetes Info Events
1427
+
1428
+ Gets all Kubernetes Info Events within a timeframe. The timeframe is defined as `[from, to]` or `[to - windowSize, to]`.
1429
+
1430
+ :param to: A Unix timestamp representing the end of the requested timeframe. Defaults to the current system time
1431
+ :type to: int
1432
+ :param window_size: The size of the requested timeframe, in milliseconds, relative to the 'to' parameter. Defaults to 10 minutes (600000 milliseconds) if neither 'windowSize' nor 'from' are provided. Resulting timeframe range = [to - windowSize, to]
1433
+ :type window_size: int
1434
+ :param var_from: A Unix timestamp representing the start of the requested timeframe. Can be used as an alternative to 'windowSize' to define the timeframe. If both 'from' and 'windowSize' are provided, 'from' takes precedence. Resulting timeframe range = [from, to]
1435
+ :type var_from: int
1436
+ :param filter_event_updates: Flag to filter the results to only show events with state changes within the timeframe.
1437
+ :type filter_event_updates: bool
1438
+ :param exclude_triggered_before: Flag to filter the results to exclude events that have been triggered before the timeframe. This also filters out events with state changes within the timeframe if the events' start times begin before the timeframe.
1439
+ :type exclude_triggered_before: bool
1440
+ :param _request_timeout: timeout setting for this request. If one
1441
+ number provided, it will be total request
1442
+ timeout. It can also be a pair (tuple) of
1443
+ (connection, read) timeouts.
1444
+ :type _request_timeout: int, tuple(int, int), optional
1445
+ :param _request_auth: set to override the auth_settings for an a single
1446
+ request; this effectively ignores the
1447
+ authentication in the spec for a single request.
1448
+ :type _request_auth: dict, optional
1449
+ :param _content_type: force content-type for the request.
1450
+ :type _content_type: str, Optional
1451
+ :param _headers: set to override the headers for a single
1452
+ request; this effectively ignores the headers
1453
+ in the spec for a single request.
1454
+ :type _headers: dict, optional
1455
+ :param _host_index: set to override the host_index for a single
1456
+ request; this effectively ignores the host_index
1457
+ in the spec for a single request.
1458
+ :type _host_index: int, optional
1459
+ :return: Returns the result object.
1460
+ """ # noqa: E501
1461
+
1462
+ _param = self._kubernetes_info_events_serialize(
1463
+ to=to,
1464
+ window_size=window_size,
1465
+ var_from=var_from,
1466
+ filter_event_updates=filter_event_updates,
1467
+ exclude_triggered_before=exclude_triggered_before,
1468
+ _request_auth=_request_auth,
1469
+ _content_type=_content_type,
1470
+ _headers=_headers,
1471
+ _host_index=_host_index
1472
+ )
1473
+
1474
+ _response_types_map: Dict[str, Optional[str]] = {
1475
+ '200': "List[EventResult]",
1476
+ '400': None,
1477
+ '403': None,
1478
+ }
1479
+ response_data = self.api_client.call_api(
1480
+ *_param,
1481
+ _request_timeout=_request_timeout
1482
+ )
1483
+ response_data.read()
1484
+ return self.api_client.response_deserialize(
1485
+ response_data=response_data,
1486
+ response_types_map=_response_types_map,
1487
+ )
1488
+
1489
+
1490
+ @validate_call
1491
+ def kubernetes_info_events_without_preload_content(
1492
+ self,
1493
+ to: Annotated[Optional[StrictInt], Field(description="A Unix timestamp representing the end of the requested timeframe. Defaults to the current system time")] = None,
1494
+ window_size: Annotated[Optional[StrictInt], Field(description="The size of the requested timeframe, in milliseconds, relative to the 'to' parameter. Defaults to 10 minutes (600000 milliseconds) if neither 'windowSize' nor 'from' are provided. Resulting timeframe range = [to - windowSize, to]")] = None,
1495
+ var_from: Annotated[Optional[StrictInt], Field(description="A Unix timestamp representing the start of the requested timeframe. Can be used as an alternative to 'windowSize' to define the timeframe. If both 'from' and 'windowSize' are provided, 'from' takes precedence. Resulting timeframe range = [from, to]")] = None,
1496
+ filter_event_updates: Annotated[Optional[StrictBool], Field(description="Flag to filter the results to only show events with state changes within the timeframe.")] = None,
1497
+ exclude_triggered_before: Annotated[Optional[StrictBool], Field(description="Flag to filter the results to exclude events that have been triggered before the timeframe. This also filters out events with state changes within the timeframe if the events' start times begin before the timeframe.")] = None,
1498
+ _request_timeout: Union[
1499
+ None,
1500
+ Annotated[StrictFloat, Field(gt=0)],
1501
+ Tuple[
1502
+ Annotated[StrictFloat, Field(gt=0)],
1503
+ Annotated[StrictFloat, Field(gt=0)]
1504
+ ]
1505
+ ] = None,
1506
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1507
+ _content_type: Optional[StrictStr] = None,
1508
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1509
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1510
+ ) -> RESTResponseType:
1511
+ """Get Kubernetes Info Events
1512
+
1513
+ Gets all Kubernetes Info Events within a timeframe. The timeframe is defined as `[from, to]` or `[to - windowSize, to]`.
1514
+
1515
+ :param to: A Unix timestamp representing the end of the requested timeframe. Defaults to the current system time
1516
+ :type to: int
1517
+ :param window_size: The size of the requested timeframe, in milliseconds, relative to the 'to' parameter. Defaults to 10 minutes (600000 milliseconds) if neither 'windowSize' nor 'from' are provided. Resulting timeframe range = [to - windowSize, to]
1518
+ :type window_size: int
1519
+ :param var_from: A Unix timestamp representing the start of the requested timeframe. Can be used as an alternative to 'windowSize' to define the timeframe. If both 'from' and 'windowSize' are provided, 'from' takes precedence. Resulting timeframe range = [from, to]
1520
+ :type var_from: int
1521
+ :param filter_event_updates: Flag to filter the results to only show events with state changes within the timeframe.
1522
+ :type filter_event_updates: bool
1523
+ :param exclude_triggered_before: Flag to filter the results to exclude events that have been triggered before the timeframe. This also filters out events with state changes within the timeframe if the events' start times begin before the timeframe.
1524
+ :type exclude_triggered_before: bool
1525
+ :param _request_timeout: timeout setting for this request. If one
1526
+ number provided, it will be total request
1527
+ timeout. It can also be a pair (tuple) of
1528
+ (connection, read) timeouts.
1529
+ :type _request_timeout: int, tuple(int, int), optional
1530
+ :param _request_auth: set to override the auth_settings for an a single
1531
+ request; this effectively ignores the
1532
+ authentication in the spec for a single request.
1533
+ :type _request_auth: dict, optional
1534
+ :param _content_type: force content-type for the request.
1535
+ :type _content_type: str, Optional
1536
+ :param _headers: set to override the headers for a single
1537
+ request; this effectively ignores the headers
1538
+ in the spec for a single request.
1539
+ :type _headers: dict, optional
1540
+ :param _host_index: set to override the host_index for a single
1541
+ request; this effectively ignores the host_index
1542
+ in the spec for a single request.
1543
+ :type _host_index: int, optional
1544
+ :return: Returns the result object.
1545
+ """ # noqa: E501
1546
+
1547
+ _param = self._kubernetes_info_events_serialize(
1548
+ to=to,
1549
+ window_size=window_size,
1550
+ var_from=var_from,
1551
+ filter_event_updates=filter_event_updates,
1552
+ exclude_triggered_before=exclude_triggered_before,
1553
+ _request_auth=_request_auth,
1554
+ _content_type=_content_type,
1555
+ _headers=_headers,
1556
+ _host_index=_host_index
1557
+ )
1558
+
1559
+ _response_types_map: Dict[str, Optional[str]] = {
1560
+ '200': "List[EventResult]",
1561
+ '400': None,
1562
+ '403': None,
1563
+ }
1564
+ response_data = self.api_client.call_api(
1565
+ *_param,
1566
+ _request_timeout=_request_timeout
1567
+ )
1568
+ return response_data.response
1569
+
1570
+
1571
+ def _kubernetes_info_events_serialize(
1572
+ self,
1573
+ to,
1574
+ window_size,
1575
+ var_from,
1576
+ filter_event_updates,
1577
+ exclude_triggered_before,
1578
+ _request_auth,
1579
+ _content_type,
1580
+ _headers,
1581
+ _host_index,
1582
+ ) -> RequestSerialized:
1583
+
1584
+ _host = None
1585
+
1586
+ _collection_formats: Dict[str, str] = {
1587
+ }
1588
+
1589
+ _path_params: Dict[str, str] = {}
1590
+ _query_params: List[Tuple[str, str]] = []
1591
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1592
+ _form_params: List[Tuple[str, str]] = []
1593
+ _files: Dict[
1594
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1595
+ ] = {}
1596
+ _body_params: Optional[bytes] = None
1597
+
1598
+ # process the path parameters
1599
+ # process the query parameters
1600
+ if to is not None:
1601
+
1602
+ _query_params.append(('to', to))
1603
+
1604
+ if window_size is not None:
1605
+
1606
+ _query_params.append(('windowSize', window_size))
1607
+
1608
+ if var_from is not None:
1609
+
1610
+ _query_params.append(('from', var_from))
1611
+
1612
+ if filter_event_updates is not None:
1613
+
1614
+ _query_params.append(('filterEventUpdates', filter_event_updates))
1615
+
1616
+ if exclude_triggered_before is not None:
1617
+
1618
+ _query_params.append(('excludeTriggeredBefore', exclude_triggered_before))
1619
+
1620
+ # process the header parameters
1621
+ # process the form parameters
1622
+ # process the body parameter
1623
+
1624
+
1625
+ # set the HTTP header `Accept`
1626
+ if 'Accept' not in _header_params:
1627
+ _header_params['Accept'] = self.api_client.select_header_accept(
1628
+ [
1629
+ 'application/json'
1630
+ ]
1631
+ )
1632
+
1633
+
1634
+ # authentication setting
1635
+ _auth_settings: List[str] = [
1636
+ 'ApiKeyAuth'
1637
+ ]
1638
+
1639
+ return self.api_client.param_serialize(
1640
+ method='GET',
1641
+ resource_path='/api/events/kubernetes-info-events',
1642
+ path_params=_path_params,
1643
+ query_params=_query_params,
1644
+ header_params=_header_params,
1645
+ body=_body_params,
1646
+ post_params=_form_params,
1647
+ files=_files,
1648
+ auth_settings=_auth_settings,
1649
+ collection_formats=_collection_formats,
1650
+ _host=_host,
1651
+ _request_auth=_request_auth
1652
+ )
1653
+
1654
+