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,2017 @@
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
21
+ from typing import List, Optional
22
+ from typing_extensions import Annotated
23
+ from instana_client.models.backend_trace_reference import BackendTraceReference
24
+ from instana_client.models.call_groups_result import CallGroupsResult
25
+ from instana_client.models.full_trace import FullTrace
26
+ from instana_client.models.get_call_groups import GetCallGroups
27
+ from instana_client.models.get_trace_groups import GetTraceGroups
28
+ from instana_client.models.get_traces import GetTraces
29
+ from instana_client.models.trace_activity_tree_node_details import TraceActivityTreeNodeDetails
30
+ from instana_client.models.trace_download_result import TraceDownloadResult
31
+ from instana_client.models.trace_groups_result import TraceGroupsResult
32
+ from instana_client.models.trace_result import TraceResult
33
+
34
+ from instana_client.api_client import ApiClient, RequestSerialized
35
+ from instana_client.api_response import ApiResponse
36
+ from instana_client.rest import RESTResponseType
37
+
38
+
39
+ class ApplicationAnalyzeApi:
40
+ """NOTE: This class is auto generated by OpenAPI Generator
41
+ Ref: https://openapi-generator.tech
42
+
43
+ Do not edit the class manually.
44
+ """
45
+
46
+ def __init__(self, api_client=None) -> None:
47
+ if api_client is None:
48
+ api_client = ApiClient.get_default()
49
+ self.api_client = api_client
50
+
51
+
52
+ @validate_call
53
+ def get_call_details(
54
+ self,
55
+ trace_id: StrictStr,
56
+ call_id: StrictStr,
57
+ _request_timeout: Union[
58
+ None,
59
+ Annotated[StrictFloat, Field(gt=0)],
60
+ Tuple[
61
+ Annotated[StrictFloat, Field(gt=0)],
62
+ Annotated[StrictFloat, Field(gt=0)]
63
+ ]
64
+ ] = None,
65
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
66
+ _content_type: Optional[StrictStr] = None,
67
+ _headers: Optional[Dict[StrictStr, Any]] = None,
68
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
69
+ ) -> TraceActivityTreeNodeDetails:
70
+ """Get call detail
71
+
72
+
73
+ :param trace_id: (required)
74
+ :type trace_id: str
75
+ :param call_id: (required)
76
+ :type call_id: str
77
+ :param _request_timeout: timeout setting for this request. If one
78
+ number provided, it will be total request
79
+ timeout. It can also be a pair (tuple) of
80
+ (connection, read) timeouts.
81
+ :type _request_timeout: int, tuple(int, int), optional
82
+ :param _request_auth: set to override the auth_settings for an a single
83
+ request; this effectively ignores the
84
+ authentication in the spec for a single request.
85
+ :type _request_auth: dict, optional
86
+ :param _content_type: force content-type for the request.
87
+ :type _content_type: str, Optional
88
+ :param _headers: set to override the headers for a single
89
+ request; this effectively ignores the headers
90
+ in the spec for a single request.
91
+ :type _headers: dict, optional
92
+ :param _host_index: set to override the host_index for a single
93
+ request; this effectively ignores the host_index
94
+ in the spec for a single request.
95
+ :type _host_index: int, optional
96
+ :return: Returns the result object.
97
+ """ # noqa: E501
98
+
99
+ _param = self._get_call_details_serialize(
100
+ trace_id=trace_id,
101
+ call_id=call_id,
102
+ _request_auth=_request_auth,
103
+ _content_type=_content_type,
104
+ _headers=_headers,
105
+ _host_index=_host_index
106
+ )
107
+
108
+ _response_types_map: Dict[str, Optional[str]] = {
109
+ '200': "TraceActivityTreeNodeDetails",
110
+ }
111
+ response_data = self.api_client.call_api(
112
+ *_param,
113
+ _request_timeout=_request_timeout
114
+ )
115
+ response_data.read()
116
+ return self.api_client.response_deserialize(
117
+ response_data=response_data,
118
+ response_types_map=_response_types_map,
119
+ ).data
120
+
121
+
122
+ @validate_call
123
+ def get_call_details_with_http_info(
124
+ self,
125
+ trace_id: StrictStr,
126
+ call_id: StrictStr,
127
+ _request_timeout: Union[
128
+ None,
129
+ Annotated[StrictFloat, Field(gt=0)],
130
+ Tuple[
131
+ Annotated[StrictFloat, Field(gt=0)],
132
+ Annotated[StrictFloat, Field(gt=0)]
133
+ ]
134
+ ] = None,
135
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
136
+ _content_type: Optional[StrictStr] = None,
137
+ _headers: Optional[Dict[StrictStr, Any]] = None,
138
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
139
+ ) -> ApiResponse[TraceActivityTreeNodeDetails]:
140
+ """Get call detail
141
+
142
+
143
+ :param trace_id: (required)
144
+ :type trace_id: str
145
+ :param call_id: (required)
146
+ :type call_id: str
147
+ :param _request_timeout: timeout setting for this request. If one
148
+ number provided, it will be total request
149
+ timeout. It can also be a pair (tuple) of
150
+ (connection, read) timeouts.
151
+ :type _request_timeout: int, tuple(int, int), optional
152
+ :param _request_auth: set to override the auth_settings for an a single
153
+ request; this effectively ignores the
154
+ authentication in the spec for a single request.
155
+ :type _request_auth: dict, optional
156
+ :param _content_type: force content-type for the request.
157
+ :type _content_type: str, Optional
158
+ :param _headers: set to override the headers for a single
159
+ request; this effectively ignores the headers
160
+ in the spec for a single request.
161
+ :type _headers: dict, optional
162
+ :param _host_index: set to override the host_index for a single
163
+ request; this effectively ignores the host_index
164
+ in the spec for a single request.
165
+ :type _host_index: int, optional
166
+ :return: Returns the result object.
167
+ """ # noqa: E501
168
+
169
+ _param = self._get_call_details_serialize(
170
+ trace_id=trace_id,
171
+ call_id=call_id,
172
+ _request_auth=_request_auth,
173
+ _content_type=_content_type,
174
+ _headers=_headers,
175
+ _host_index=_host_index
176
+ )
177
+
178
+ _response_types_map: Dict[str, Optional[str]] = {
179
+ '200': "TraceActivityTreeNodeDetails",
180
+ }
181
+ response_data = self.api_client.call_api(
182
+ *_param,
183
+ _request_timeout=_request_timeout
184
+ )
185
+ response_data.read()
186
+ return self.api_client.response_deserialize(
187
+ response_data=response_data,
188
+ response_types_map=_response_types_map,
189
+ )
190
+
191
+
192
+ @validate_call
193
+ def get_call_details_without_preload_content(
194
+ self,
195
+ trace_id: StrictStr,
196
+ call_id: StrictStr,
197
+ _request_timeout: Union[
198
+ None,
199
+ Annotated[StrictFloat, Field(gt=0)],
200
+ Tuple[
201
+ Annotated[StrictFloat, Field(gt=0)],
202
+ Annotated[StrictFloat, Field(gt=0)]
203
+ ]
204
+ ] = None,
205
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
206
+ _content_type: Optional[StrictStr] = None,
207
+ _headers: Optional[Dict[StrictStr, Any]] = None,
208
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
209
+ ) -> RESTResponseType:
210
+ """Get call detail
211
+
212
+
213
+ :param trace_id: (required)
214
+ :type trace_id: str
215
+ :param call_id: (required)
216
+ :type call_id: str
217
+ :param _request_timeout: timeout setting for this request. If one
218
+ number provided, it will be total request
219
+ timeout. It can also be a pair (tuple) of
220
+ (connection, read) timeouts.
221
+ :type _request_timeout: int, tuple(int, int), optional
222
+ :param _request_auth: set to override the auth_settings for an a single
223
+ request; this effectively ignores the
224
+ authentication in the spec for a single request.
225
+ :type _request_auth: dict, optional
226
+ :param _content_type: force content-type for the request.
227
+ :type _content_type: str, Optional
228
+ :param _headers: set to override the headers for a single
229
+ request; this effectively ignores the headers
230
+ in the spec for a single request.
231
+ :type _headers: dict, optional
232
+ :param _host_index: set to override the host_index for a single
233
+ request; this effectively ignores the host_index
234
+ in the spec for a single request.
235
+ :type _host_index: int, optional
236
+ :return: Returns the result object.
237
+ """ # noqa: E501
238
+
239
+ _param = self._get_call_details_serialize(
240
+ trace_id=trace_id,
241
+ call_id=call_id,
242
+ _request_auth=_request_auth,
243
+ _content_type=_content_type,
244
+ _headers=_headers,
245
+ _host_index=_host_index
246
+ )
247
+
248
+ _response_types_map: Dict[str, Optional[str]] = {
249
+ '200': "TraceActivityTreeNodeDetails",
250
+ }
251
+ response_data = self.api_client.call_api(
252
+ *_param,
253
+ _request_timeout=_request_timeout
254
+ )
255
+ return response_data.response
256
+
257
+
258
+ def _get_call_details_serialize(
259
+ self,
260
+ trace_id,
261
+ call_id,
262
+ _request_auth,
263
+ _content_type,
264
+ _headers,
265
+ _host_index,
266
+ ) -> RequestSerialized:
267
+
268
+ _host = None
269
+
270
+ _collection_formats: Dict[str, str] = {
271
+ }
272
+
273
+ _path_params: Dict[str, str] = {}
274
+ _query_params: List[Tuple[str, str]] = []
275
+ _header_params: Dict[str, Optional[str]] = _headers or {}
276
+ _form_params: List[Tuple[str, str]] = []
277
+ _files: Dict[
278
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
279
+ ] = {}
280
+ _body_params: Optional[bytes] = None
281
+
282
+ # process the path parameters
283
+ if trace_id is not None:
284
+ _path_params['traceId'] = trace_id
285
+ if call_id is not None:
286
+ _path_params['callId'] = call_id
287
+ # process the query parameters
288
+ # process the header parameters
289
+ # process the form parameters
290
+ # process the body parameter
291
+
292
+
293
+ # set the HTTP header `Accept`
294
+ if 'Accept' not in _header_params:
295
+ _header_params['Accept'] = self.api_client.select_header_accept(
296
+ [
297
+ 'application/json'
298
+ ]
299
+ )
300
+
301
+
302
+ # authentication setting
303
+ _auth_settings: List[str] = [
304
+ 'ApiKeyAuth'
305
+ ]
306
+
307
+ return self.api_client.param_serialize(
308
+ method='GET',
309
+ resource_path='/api/application-monitoring/v2/analyze/traces/{traceId}/calls/{callId}/details',
310
+ path_params=_path_params,
311
+ query_params=_query_params,
312
+ header_params=_header_params,
313
+ body=_body_params,
314
+ post_params=_form_params,
315
+ files=_files,
316
+ auth_settings=_auth_settings,
317
+ collection_formats=_collection_formats,
318
+ _host=_host,
319
+ _request_auth=_request_auth
320
+ )
321
+
322
+
323
+
324
+
325
+ @validate_call
326
+ def get_call_group(
327
+ self,
328
+ fill_time_series: Annotated[Optional[StrictBool], Field(description="If enabled, fill the missing data points in the metric result with timestamp and value 0.")] = None,
329
+ get_call_groups: Optional[GetCallGroups] = None,
330
+ _request_timeout: Union[
331
+ None,
332
+ Annotated[StrictFloat, Field(gt=0)],
333
+ Tuple[
334
+ Annotated[StrictFloat, Field(gt=0)],
335
+ Annotated[StrictFloat, Field(gt=0)]
336
+ ]
337
+ ] = None,
338
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
339
+ _content_type: Optional[StrictStr] = None,
340
+ _headers: Optional[Dict[StrictStr, Any]] = None,
341
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
342
+ ) -> CallGroupsResult:
343
+ """Get grouped call metrics
344
+
345
+ This endpoint retrieves the metrics for calls. ## Deprecated Parameters **tagFilters:** The list of tag filters. It is replaced by **tagFilterExpression**, **includeInternal** and **includeSynthetic**.
346
+
347
+ :param fill_time_series: If enabled, fill the missing data points in the metric result with timestamp and value 0.
348
+ :type fill_time_series: bool
349
+ :param get_call_groups:
350
+ :type get_call_groups: GetCallGroups
351
+ :param _request_timeout: timeout setting for this request. If one
352
+ number provided, it will be total request
353
+ timeout. It can also be a pair (tuple) of
354
+ (connection, read) timeouts.
355
+ :type _request_timeout: int, tuple(int, int), optional
356
+ :param _request_auth: set to override the auth_settings for an a single
357
+ request; this effectively ignores the
358
+ authentication in the spec for a single request.
359
+ :type _request_auth: dict, optional
360
+ :param _content_type: force content-type for the request.
361
+ :type _content_type: str, Optional
362
+ :param _headers: set to override the headers for a single
363
+ request; this effectively ignores the headers
364
+ in the spec for a single request.
365
+ :type _headers: dict, optional
366
+ :param _host_index: set to override the host_index for a single
367
+ request; this effectively ignores the host_index
368
+ in the spec for a single request.
369
+ :type _host_index: int, optional
370
+ :return: Returns the result object.
371
+ """ # noqa: E501
372
+
373
+ _param = self._get_call_group_serialize(
374
+ fill_time_series=fill_time_series,
375
+ get_call_groups=get_call_groups,
376
+ _request_auth=_request_auth,
377
+ _content_type=_content_type,
378
+ _headers=_headers,
379
+ _host_index=_host_index
380
+ )
381
+
382
+ _response_types_map: Dict[str, Optional[str]] = {
383
+ '200': "CallGroupsResult",
384
+ }
385
+ response_data = self.api_client.call_api(
386
+ *_param,
387
+ _request_timeout=_request_timeout
388
+ )
389
+ response_data.read()
390
+ return self.api_client.response_deserialize(
391
+ response_data=response_data,
392
+ response_types_map=_response_types_map,
393
+ ).data
394
+
395
+
396
+ @validate_call
397
+ def get_call_group_with_http_info(
398
+ self,
399
+ fill_time_series: Annotated[Optional[StrictBool], Field(description="If enabled, fill the missing data points in the metric result with timestamp and value 0.")] = None,
400
+ get_call_groups: Optional[GetCallGroups] = None,
401
+ _request_timeout: Union[
402
+ None,
403
+ Annotated[StrictFloat, Field(gt=0)],
404
+ Tuple[
405
+ Annotated[StrictFloat, Field(gt=0)],
406
+ Annotated[StrictFloat, Field(gt=0)]
407
+ ]
408
+ ] = None,
409
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
410
+ _content_type: Optional[StrictStr] = None,
411
+ _headers: Optional[Dict[StrictStr, Any]] = None,
412
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
413
+ ) -> ApiResponse[CallGroupsResult]:
414
+ """Get grouped call metrics
415
+
416
+ This endpoint retrieves the metrics for calls. ## Deprecated Parameters **tagFilters:** The list of tag filters. It is replaced by **tagFilterExpression**, **includeInternal** and **includeSynthetic**.
417
+
418
+ :param fill_time_series: If enabled, fill the missing data points in the metric result with timestamp and value 0.
419
+ :type fill_time_series: bool
420
+ :param get_call_groups:
421
+ :type get_call_groups: GetCallGroups
422
+ :param _request_timeout: timeout setting for this request. If one
423
+ number provided, it will be total request
424
+ timeout. It can also be a pair (tuple) of
425
+ (connection, read) timeouts.
426
+ :type _request_timeout: int, tuple(int, int), optional
427
+ :param _request_auth: set to override the auth_settings for an a single
428
+ request; this effectively ignores the
429
+ authentication in the spec for a single request.
430
+ :type _request_auth: dict, optional
431
+ :param _content_type: force content-type for the request.
432
+ :type _content_type: str, Optional
433
+ :param _headers: set to override the headers for a single
434
+ request; this effectively ignores the headers
435
+ in the spec for a single request.
436
+ :type _headers: dict, optional
437
+ :param _host_index: set to override the host_index for a single
438
+ request; this effectively ignores the host_index
439
+ in the spec for a single request.
440
+ :type _host_index: int, optional
441
+ :return: Returns the result object.
442
+ """ # noqa: E501
443
+
444
+ _param = self._get_call_group_serialize(
445
+ fill_time_series=fill_time_series,
446
+ get_call_groups=get_call_groups,
447
+ _request_auth=_request_auth,
448
+ _content_type=_content_type,
449
+ _headers=_headers,
450
+ _host_index=_host_index
451
+ )
452
+
453
+ _response_types_map: Dict[str, Optional[str]] = {
454
+ '200': "CallGroupsResult",
455
+ }
456
+ response_data = self.api_client.call_api(
457
+ *_param,
458
+ _request_timeout=_request_timeout
459
+ )
460
+ response_data.read()
461
+ return self.api_client.response_deserialize(
462
+ response_data=response_data,
463
+ response_types_map=_response_types_map,
464
+ )
465
+
466
+
467
+ @validate_call
468
+ def get_call_group_without_preload_content(
469
+ self,
470
+ fill_time_series: Annotated[Optional[StrictBool], Field(description="If enabled, fill the missing data points in the metric result with timestamp and value 0.")] = None,
471
+ get_call_groups: Optional[GetCallGroups] = None,
472
+ _request_timeout: Union[
473
+ None,
474
+ Annotated[StrictFloat, Field(gt=0)],
475
+ Tuple[
476
+ Annotated[StrictFloat, Field(gt=0)],
477
+ Annotated[StrictFloat, Field(gt=0)]
478
+ ]
479
+ ] = None,
480
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
481
+ _content_type: Optional[StrictStr] = None,
482
+ _headers: Optional[Dict[StrictStr, Any]] = None,
483
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
484
+ ) -> RESTResponseType:
485
+ """Get grouped call metrics
486
+
487
+ This endpoint retrieves the metrics for calls. ## Deprecated Parameters **tagFilters:** The list of tag filters. It is replaced by **tagFilterExpression**, **includeInternal** and **includeSynthetic**.
488
+
489
+ :param fill_time_series: If enabled, fill the missing data points in the metric result with timestamp and value 0.
490
+ :type fill_time_series: bool
491
+ :param get_call_groups:
492
+ :type get_call_groups: GetCallGroups
493
+ :param _request_timeout: timeout setting for this request. If one
494
+ number provided, it will be total request
495
+ timeout. It can also be a pair (tuple) of
496
+ (connection, read) timeouts.
497
+ :type _request_timeout: int, tuple(int, int), optional
498
+ :param _request_auth: set to override the auth_settings for an a single
499
+ request; this effectively ignores the
500
+ authentication in the spec for a single request.
501
+ :type _request_auth: dict, optional
502
+ :param _content_type: force content-type for the request.
503
+ :type _content_type: str, Optional
504
+ :param _headers: set to override the headers for a single
505
+ request; this effectively ignores the headers
506
+ in the spec for a single request.
507
+ :type _headers: dict, optional
508
+ :param _host_index: set to override the host_index for a single
509
+ request; this effectively ignores the host_index
510
+ in the spec for a single request.
511
+ :type _host_index: int, optional
512
+ :return: Returns the result object.
513
+ """ # noqa: E501
514
+
515
+ _param = self._get_call_group_serialize(
516
+ fill_time_series=fill_time_series,
517
+ get_call_groups=get_call_groups,
518
+ _request_auth=_request_auth,
519
+ _content_type=_content_type,
520
+ _headers=_headers,
521
+ _host_index=_host_index
522
+ )
523
+
524
+ _response_types_map: Dict[str, Optional[str]] = {
525
+ '200': "CallGroupsResult",
526
+ }
527
+ response_data = self.api_client.call_api(
528
+ *_param,
529
+ _request_timeout=_request_timeout
530
+ )
531
+ return response_data.response
532
+
533
+
534
+ def _get_call_group_serialize(
535
+ self,
536
+ fill_time_series,
537
+ get_call_groups,
538
+ _request_auth,
539
+ _content_type,
540
+ _headers,
541
+ _host_index,
542
+ ) -> RequestSerialized:
543
+
544
+ _host = None
545
+
546
+ _collection_formats: Dict[str, str] = {
547
+ }
548
+
549
+ _path_params: Dict[str, str] = {}
550
+ _query_params: List[Tuple[str, str]] = []
551
+ _header_params: Dict[str, Optional[str]] = _headers or {}
552
+ _form_params: List[Tuple[str, str]] = []
553
+ _files: Dict[
554
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
555
+ ] = {}
556
+ _body_params: Optional[bytes] = None
557
+
558
+ # process the path parameters
559
+ # process the query parameters
560
+ if fill_time_series is not None:
561
+
562
+ _query_params.append(('fillTimeSeries', fill_time_series))
563
+
564
+ # process the header parameters
565
+ # process the form parameters
566
+ # process the body parameter
567
+ if get_call_groups is not None:
568
+ _body_params = get_call_groups
569
+
570
+
571
+ # set the HTTP header `Accept`
572
+ if 'Accept' not in _header_params:
573
+ _header_params['Accept'] = self.api_client.select_header_accept(
574
+ [
575
+ 'application/json'
576
+ ]
577
+ )
578
+
579
+ # set the HTTP header `Content-Type`
580
+ if _content_type:
581
+ _header_params['Content-Type'] = _content_type
582
+ else:
583
+ _default_content_type = (
584
+ self.api_client.select_header_content_type(
585
+ [
586
+ 'application/json'
587
+ ]
588
+ )
589
+ )
590
+ if _default_content_type is not None:
591
+ _header_params['Content-Type'] = _default_content_type
592
+
593
+ # authentication setting
594
+ _auth_settings: List[str] = [
595
+ 'ApiKeyAuth'
596
+ ]
597
+
598
+ return self.api_client.param_serialize(
599
+ method='POST',
600
+ resource_path='/api/application-monitoring/analyze/call-groups',
601
+ path_params=_path_params,
602
+ query_params=_query_params,
603
+ header_params=_header_params,
604
+ body=_body_params,
605
+ post_params=_form_params,
606
+ files=_files,
607
+ auth_settings=_auth_settings,
608
+ collection_formats=_collection_formats,
609
+ _host=_host,
610
+ _request_auth=_request_auth
611
+ )
612
+
613
+
614
+
615
+
616
+ @validate_call
617
+ def get_correlated_traces(
618
+ self,
619
+ correlation_id: Annotated[str, Field(min_length=0, strict=True, max_length=128, description="Here, the `backendTraceId` is typically used which can be obtained from the `Get all beacons` API endpoint for website and mobile app monitoring. For XHR, fetch, or HTTP beacons, the `beaconId` retrieved from the same API endpoint can also serve as the `correlationId`. ")],
620
+ _request_timeout: Union[
621
+ None,
622
+ Annotated[StrictFloat, Field(gt=0)],
623
+ Tuple[
624
+ Annotated[StrictFloat, Field(gt=0)],
625
+ Annotated[StrictFloat, Field(gt=0)]
626
+ ]
627
+ ] = None,
628
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
629
+ _content_type: Optional[StrictStr] = None,
630
+ _headers: Optional[Dict[StrictStr, Any]] = None,
631
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
632
+ ) -> List[BackendTraceReference]:
633
+ """Resolve Trace IDs from Monitoring Beacons.
634
+
635
+ Resolves backend trace IDs using correlation IDs from website and mobile app monitoring beacons.
636
+
637
+ :param correlation_id: Here, the `backendTraceId` is typically used which can be obtained from the `Get all beacons` API endpoint for website and mobile app monitoring. For XHR, fetch, or HTTP beacons, the `beaconId` retrieved from the same API endpoint can also serve as the `correlationId`. (required)
638
+ :type correlation_id: str
639
+ :param _request_timeout: timeout setting for this request. If one
640
+ number provided, it will be total request
641
+ timeout. It can also be a pair (tuple) of
642
+ (connection, read) timeouts.
643
+ :type _request_timeout: int, tuple(int, int), optional
644
+ :param _request_auth: set to override the auth_settings for an a single
645
+ request; this effectively ignores the
646
+ authentication in the spec for a single request.
647
+ :type _request_auth: dict, optional
648
+ :param _content_type: force content-type for the request.
649
+ :type _content_type: str, Optional
650
+ :param _headers: set to override the headers for a single
651
+ request; this effectively ignores the headers
652
+ in the spec for a single request.
653
+ :type _headers: dict, optional
654
+ :param _host_index: set to override the host_index for a single
655
+ request; this effectively ignores the host_index
656
+ in the spec for a single request.
657
+ :type _host_index: int, optional
658
+ :return: Returns the result object.
659
+ """ # noqa: E501
660
+
661
+ _param = self._get_correlated_traces_serialize(
662
+ correlation_id=correlation_id,
663
+ _request_auth=_request_auth,
664
+ _content_type=_content_type,
665
+ _headers=_headers,
666
+ _host_index=_host_index
667
+ )
668
+
669
+ _response_types_map: Dict[str, Optional[str]] = {
670
+ '200': "List[BackendTraceReference]",
671
+ }
672
+ response_data = self.api_client.call_api(
673
+ *_param,
674
+ _request_timeout=_request_timeout
675
+ )
676
+ response_data.read()
677
+ return self.api_client.response_deserialize(
678
+ response_data=response_data,
679
+ response_types_map=_response_types_map,
680
+ ).data
681
+
682
+
683
+ @validate_call
684
+ def get_correlated_traces_with_http_info(
685
+ self,
686
+ correlation_id: Annotated[str, Field(min_length=0, strict=True, max_length=128, description="Here, the `backendTraceId` is typically used which can be obtained from the `Get all beacons` API endpoint for website and mobile app monitoring. For XHR, fetch, or HTTP beacons, the `beaconId` retrieved from the same API endpoint can also serve as the `correlationId`. ")],
687
+ _request_timeout: Union[
688
+ None,
689
+ Annotated[StrictFloat, Field(gt=0)],
690
+ Tuple[
691
+ Annotated[StrictFloat, Field(gt=0)],
692
+ Annotated[StrictFloat, Field(gt=0)]
693
+ ]
694
+ ] = None,
695
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
696
+ _content_type: Optional[StrictStr] = None,
697
+ _headers: Optional[Dict[StrictStr, Any]] = None,
698
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
699
+ ) -> ApiResponse[List[BackendTraceReference]]:
700
+ """Resolve Trace IDs from Monitoring Beacons.
701
+
702
+ Resolves backend trace IDs using correlation IDs from website and mobile app monitoring beacons.
703
+
704
+ :param correlation_id: Here, the `backendTraceId` is typically used which can be obtained from the `Get all beacons` API endpoint for website and mobile app monitoring. For XHR, fetch, or HTTP beacons, the `beaconId` retrieved from the same API endpoint can also serve as the `correlationId`. (required)
705
+ :type correlation_id: str
706
+ :param _request_timeout: timeout setting for this request. If one
707
+ number provided, it will be total request
708
+ timeout. It can also be a pair (tuple) of
709
+ (connection, read) timeouts.
710
+ :type _request_timeout: int, tuple(int, int), optional
711
+ :param _request_auth: set to override the auth_settings for an a single
712
+ request; this effectively ignores the
713
+ authentication in the spec for a single request.
714
+ :type _request_auth: dict, optional
715
+ :param _content_type: force content-type for the request.
716
+ :type _content_type: str, Optional
717
+ :param _headers: set to override the headers for a single
718
+ request; this effectively ignores the headers
719
+ in the spec for a single request.
720
+ :type _headers: dict, optional
721
+ :param _host_index: set to override the host_index for a single
722
+ request; this effectively ignores the host_index
723
+ in the spec for a single request.
724
+ :type _host_index: int, optional
725
+ :return: Returns the result object.
726
+ """ # noqa: E501
727
+
728
+ _param = self._get_correlated_traces_serialize(
729
+ correlation_id=correlation_id,
730
+ _request_auth=_request_auth,
731
+ _content_type=_content_type,
732
+ _headers=_headers,
733
+ _host_index=_host_index
734
+ )
735
+
736
+ _response_types_map: Dict[str, Optional[str]] = {
737
+ '200': "List[BackendTraceReference]",
738
+ }
739
+ response_data = self.api_client.call_api(
740
+ *_param,
741
+ _request_timeout=_request_timeout
742
+ )
743
+ response_data.read()
744
+ return self.api_client.response_deserialize(
745
+ response_data=response_data,
746
+ response_types_map=_response_types_map,
747
+ )
748
+
749
+
750
+ @validate_call
751
+ def get_correlated_traces_without_preload_content(
752
+ self,
753
+ correlation_id: Annotated[str, Field(min_length=0, strict=True, max_length=128, description="Here, the `backendTraceId` is typically used which can be obtained from the `Get all beacons` API endpoint for website and mobile app monitoring. For XHR, fetch, or HTTP beacons, the `beaconId` retrieved from the same API endpoint can also serve as the `correlationId`. ")],
754
+ _request_timeout: Union[
755
+ None,
756
+ Annotated[StrictFloat, Field(gt=0)],
757
+ Tuple[
758
+ Annotated[StrictFloat, Field(gt=0)],
759
+ Annotated[StrictFloat, Field(gt=0)]
760
+ ]
761
+ ] = None,
762
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
763
+ _content_type: Optional[StrictStr] = None,
764
+ _headers: Optional[Dict[StrictStr, Any]] = None,
765
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
766
+ ) -> RESTResponseType:
767
+ """Resolve Trace IDs from Monitoring Beacons.
768
+
769
+ Resolves backend trace IDs using correlation IDs from website and mobile app monitoring beacons.
770
+
771
+ :param correlation_id: Here, the `backendTraceId` is typically used which can be obtained from the `Get all beacons` API endpoint for website and mobile app monitoring. For XHR, fetch, or HTTP beacons, the `beaconId` retrieved from the same API endpoint can also serve as the `correlationId`. (required)
772
+ :type correlation_id: str
773
+ :param _request_timeout: timeout setting for this request. If one
774
+ number provided, it will be total request
775
+ timeout. It can also be a pair (tuple) of
776
+ (connection, read) timeouts.
777
+ :type _request_timeout: int, tuple(int, int), optional
778
+ :param _request_auth: set to override the auth_settings for an a single
779
+ request; this effectively ignores the
780
+ authentication in the spec for a single request.
781
+ :type _request_auth: dict, optional
782
+ :param _content_type: force content-type for the request.
783
+ :type _content_type: str, Optional
784
+ :param _headers: set to override the headers for a single
785
+ request; this effectively ignores the headers
786
+ in the spec for a single request.
787
+ :type _headers: dict, optional
788
+ :param _host_index: set to override the host_index for a single
789
+ request; this effectively ignores the host_index
790
+ in the spec for a single request.
791
+ :type _host_index: int, optional
792
+ :return: Returns the result object.
793
+ """ # noqa: E501
794
+
795
+ _param = self._get_correlated_traces_serialize(
796
+ correlation_id=correlation_id,
797
+ _request_auth=_request_auth,
798
+ _content_type=_content_type,
799
+ _headers=_headers,
800
+ _host_index=_host_index
801
+ )
802
+
803
+ _response_types_map: Dict[str, Optional[str]] = {
804
+ '200': "List[BackendTraceReference]",
805
+ }
806
+ response_data = self.api_client.call_api(
807
+ *_param,
808
+ _request_timeout=_request_timeout
809
+ )
810
+ return response_data.response
811
+
812
+
813
+ def _get_correlated_traces_serialize(
814
+ self,
815
+ correlation_id,
816
+ _request_auth,
817
+ _content_type,
818
+ _headers,
819
+ _host_index,
820
+ ) -> RequestSerialized:
821
+
822
+ _host = None
823
+
824
+ _collection_formats: Dict[str, str] = {
825
+ }
826
+
827
+ _path_params: Dict[str, str] = {}
828
+ _query_params: List[Tuple[str, str]] = []
829
+ _header_params: Dict[str, Optional[str]] = _headers or {}
830
+ _form_params: List[Tuple[str, str]] = []
831
+ _files: Dict[
832
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
833
+ ] = {}
834
+ _body_params: Optional[bytes] = None
835
+
836
+ # process the path parameters
837
+ # process the query parameters
838
+ if correlation_id is not None:
839
+
840
+ _query_params.append(('correlationId', correlation_id))
841
+
842
+ # process the header parameters
843
+ # process the form parameters
844
+ # process the body parameter
845
+
846
+
847
+ # set the HTTP header `Accept`
848
+ if 'Accept' not in _header_params:
849
+ _header_params['Accept'] = self.api_client.select_header_accept(
850
+ [
851
+ 'application/json'
852
+ ]
853
+ )
854
+
855
+
856
+ # authentication setting
857
+ _auth_settings: List[str] = [
858
+ 'ApiKeyAuth'
859
+ ]
860
+
861
+ return self.api_client.param_serialize(
862
+ method='GET',
863
+ resource_path='/api/application-monitoring/analyze/backend-correlation',
864
+ path_params=_path_params,
865
+ query_params=_query_params,
866
+ header_params=_header_params,
867
+ body=_body_params,
868
+ post_params=_form_params,
869
+ files=_files,
870
+ auth_settings=_auth_settings,
871
+ collection_formats=_collection_formats,
872
+ _host=_host,
873
+ _request_auth=_request_auth
874
+ )
875
+
876
+
877
+
878
+
879
+ @validate_call
880
+ def get_trace(
881
+ self,
882
+ id: StrictStr,
883
+ _request_timeout: Union[
884
+ None,
885
+ Annotated[StrictFloat, Field(gt=0)],
886
+ Tuple[
887
+ Annotated[StrictFloat, Field(gt=0)],
888
+ Annotated[StrictFloat, Field(gt=0)]
889
+ ]
890
+ ] = None,
891
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
892
+ _content_type: Optional[StrictStr] = None,
893
+ _headers: Optional[Dict[StrictStr, Any]] = None,
894
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
895
+ ) -> FullTrace:
896
+ """(Deprecated) Get trace detail
897
+
898
+ Replaced by /api/application-monitoring/v2/analyze/traces/{id}
899
+
900
+ :param id: (required)
901
+ :type id: str
902
+ :param _request_timeout: timeout setting for this request. If one
903
+ number provided, it will be total request
904
+ timeout. It can also be a pair (tuple) of
905
+ (connection, read) timeouts.
906
+ :type _request_timeout: int, tuple(int, int), optional
907
+ :param _request_auth: set to override the auth_settings for an a single
908
+ request; this effectively ignores the
909
+ authentication in the spec for a single request.
910
+ :type _request_auth: dict, optional
911
+ :param _content_type: force content-type for the request.
912
+ :type _content_type: str, Optional
913
+ :param _headers: set to override the headers for a single
914
+ request; this effectively ignores the headers
915
+ in the spec for a single request.
916
+ :type _headers: dict, optional
917
+ :param _host_index: set to override the host_index for a single
918
+ request; this effectively ignores the host_index
919
+ in the spec for a single request.
920
+ :type _host_index: int, optional
921
+ :return: Returns the result object.
922
+ """ # noqa: E501
923
+ warnings.warn("GET /api/application-monitoring/analyze/traces/{id} is deprecated.", DeprecationWarning)
924
+
925
+ _param = self._get_trace_serialize(
926
+ id=id,
927
+ _request_auth=_request_auth,
928
+ _content_type=_content_type,
929
+ _headers=_headers,
930
+ _host_index=_host_index
931
+ )
932
+
933
+ _response_types_map: Dict[str, Optional[str]] = {
934
+ '200': "FullTrace",
935
+ }
936
+ response_data = self.api_client.call_api(
937
+ *_param,
938
+ _request_timeout=_request_timeout
939
+ )
940
+ response_data.read()
941
+ return self.api_client.response_deserialize(
942
+ response_data=response_data,
943
+ response_types_map=_response_types_map,
944
+ ).data
945
+
946
+
947
+ @validate_call
948
+ def get_trace_with_http_info(
949
+ self,
950
+ id: StrictStr,
951
+ _request_timeout: Union[
952
+ None,
953
+ Annotated[StrictFloat, Field(gt=0)],
954
+ Tuple[
955
+ Annotated[StrictFloat, Field(gt=0)],
956
+ Annotated[StrictFloat, Field(gt=0)]
957
+ ]
958
+ ] = None,
959
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
960
+ _content_type: Optional[StrictStr] = None,
961
+ _headers: Optional[Dict[StrictStr, Any]] = None,
962
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
963
+ ) -> ApiResponse[FullTrace]:
964
+ """(Deprecated) Get trace detail
965
+
966
+ Replaced by /api/application-monitoring/v2/analyze/traces/{id}
967
+
968
+ :param id: (required)
969
+ :type id: str
970
+ :param _request_timeout: timeout setting for this request. If one
971
+ number provided, it will be total request
972
+ timeout. It can also be a pair (tuple) of
973
+ (connection, read) timeouts.
974
+ :type _request_timeout: int, tuple(int, int), optional
975
+ :param _request_auth: set to override the auth_settings for an a single
976
+ request; this effectively ignores the
977
+ authentication in the spec for a single request.
978
+ :type _request_auth: dict, optional
979
+ :param _content_type: force content-type for the request.
980
+ :type _content_type: str, Optional
981
+ :param _headers: set to override the headers for a single
982
+ request; this effectively ignores the headers
983
+ in the spec for a single request.
984
+ :type _headers: dict, optional
985
+ :param _host_index: set to override the host_index for a single
986
+ request; this effectively ignores the host_index
987
+ in the spec for a single request.
988
+ :type _host_index: int, optional
989
+ :return: Returns the result object.
990
+ """ # noqa: E501
991
+ warnings.warn("GET /api/application-monitoring/analyze/traces/{id} is deprecated.", DeprecationWarning)
992
+
993
+ _param = self._get_trace_serialize(
994
+ id=id,
995
+ _request_auth=_request_auth,
996
+ _content_type=_content_type,
997
+ _headers=_headers,
998
+ _host_index=_host_index
999
+ )
1000
+
1001
+ _response_types_map: Dict[str, Optional[str]] = {
1002
+ '200': "FullTrace",
1003
+ }
1004
+ response_data = self.api_client.call_api(
1005
+ *_param,
1006
+ _request_timeout=_request_timeout
1007
+ )
1008
+ response_data.read()
1009
+ return self.api_client.response_deserialize(
1010
+ response_data=response_data,
1011
+ response_types_map=_response_types_map,
1012
+ )
1013
+
1014
+
1015
+ @validate_call
1016
+ def get_trace_without_preload_content(
1017
+ self,
1018
+ id: StrictStr,
1019
+ _request_timeout: Union[
1020
+ None,
1021
+ Annotated[StrictFloat, Field(gt=0)],
1022
+ Tuple[
1023
+ Annotated[StrictFloat, Field(gt=0)],
1024
+ Annotated[StrictFloat, Field(gt=0)]
1025
+ ]
1026
+ ] = None,
1027
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1028
+ _content_type: Optional[StrictStr] = None,
1029
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1030
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1031
+ ) -> RESTResponseType:
1032
+ """(Deprecated) Get trace detail
1033
+
1034
+ Replaced by /api/application-monitoring/v2/analyze/traces/{id}
1035
+
1036
+ :param id: (required)
1037
+ :type id: str
1038
+ :param _request_timeout: timeout setting for this request. If one
1039
+ number provided, it will be total request
1040
+ timeout. It can also be a pair (tuple) of
1041
+ (connection, read) timeouts.
1042
+ :type _request_timeout: int, tuple(int, int), optional
1043
+ :param _request_auth: set to override the auth_settings for an a single
1044
+ request; this effectively ignores the
1045
+ authentication in the spec for a single request.
1046
+ :type _request_auth: dict, optional
1047
+ :param _content_type: force content-type for the request.
1048
+ :type _content_type: str, Optional
1049
+ :param _headers: set to override the headers for a single
1050
+ request; this effectively ignores the headers
1051
+ in the spec for a single request.
1052
+ :type _headers: dict, optional
1053
+ :param _host_index: set to override the host_index for a single
1054
+ request; this effectively ignores the host_index
1055
+ in the spec for a single request.
1056
+ :type _host_index: int, optional
1057
+ :return: Returns the result object.
1058
+ """ # noqa: E501
1059
+ warnings.warn("GET /api/application-monitoring/analyze/traces/{id} is deprecated.", DeprecationWarning)
1060
+
1061
+ _param = self._get_trace_serialize(
1062
+ id=id,
1063
+ _request_auth=_request_auth,
1064
+ _content_type=_content_type,
1065
+ _headers=_headers,
1066
+ _host_index=_host_index
1067
+ )
1068
+
1069
+ _response_types_map: Dict[str, Optional[str]] = {
1070
+ '200': "FullTrace",
1071
+ }
1072
+ response_data = self.api_client.call_api(
1073
+ *_param,
1074
+ _request_timeout=_request_timeout
1075
+ )
1076
+ return response_data.response
1077
+
1078
+
1079
+ def _get_trace_serialize(
1080
+ self,
1081
+ id,
1082
+ _request_auth,
1083
+ _content_type,
1084
+ _headers,
1085
+ _host_index,
1086
+ ) -> RequestSerialized:
1087
+
1088
+ _host = None
1089
+
1090
+ _collection_formats: Dict[str, str] = {
1091
+ }
1092
+
1093
+ _path_params: Dict[str, str] = {}
1094
+ _query_params: List[Tuple[str, str]] = []
1095
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1096
+ _form_params: List[Tuple[str, str]] = []
1097
+ _files: Dict[
1098
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1099
+ ] = {}
1100
+ _body_params: Optional[bytes] = None
1101
+
1102
+ # process the path parameters
1103
+ if id is not None:
1104
+ _path_params['id'] = id
1105
+ # process the query parameters
1106
+ # process the header parameters
1107
+ # process the form parameters
1108
+ # process the body parameter
1109
+
1110
+
1111
+ # set the HTTP header `Accept`
1112
+ if 'Accept' not in _header_params:
1113
+ _header_params['Accept'] = self.api_client.select_header_accept(
1114
+ [
1115
+ 'application/json'
1116
+ ]
1117
+ )
1118
+
1119
+
1120
+ # authentication setting
1121
+ _auth_settings: List[str] = [
1122
+ 'ApiKeyAuth'
1123
+ ]
1124
+
1125
+ return self.api_client.param_serialize(
1126
+ method='GET',
1127
+ resource_path='/api/application-monitoring/analyze/traces/{id}',
1128
+ path_params=_path_params,
1129
+ query_params=_query_params,
1130
+ header_params=_header_params,
1131
+ body=_body_params,
1132
+ post_params=_form_params,
1133
+ files=_files,
1134
+ auth_settings=_auth_settings,
1135
+ collection_formats=_collection_formats,
1136
+ _host=_host,
1137
+ _request_auth=_request_auth
1138
+ )
1139
+
1140
+
1141
+
1142
+
1143
+ @validate_call
1144
+ def get_trace_download(
1145
+ self,
1146
+ id: StrictStr,
1147
+ retrieval_size: Optional[Annotated[int, Field(le=10000, strict=True, ge=1)]] = None,
1148
+ offset: Optional[StrictInt] = None,
1149
+ ingestion_time: Optional[StrictInt] = None,
1150
+ _request_timeout: Union[
1151
+ None,
1152
+ Annotated[StrictFloat, Field(gt=0)],
1153
+ Tuple[
1154
+ Annotated[StrictFloat, Field(gt=0)],
1155
+ Annotated[StrictFloat, Field(gt=0)]
1156
+ ]
1157
+ ] = None,
1158
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1159
+ _content_type: Optional[StrictStr] = None,
1160
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1161
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1162
+ ) -> TraceDownloadResult:
1163
+ """Get trace detail
1164
+
1165
+ Use this API endpoint if one wants to retrive comprehensive details of a particular trace.
1166
+
1167
+ :param id: (required)
1168
+ :type id: str
1169
+ :param retrieval_size:
1170
+ :type retrieval_size: int
1171
+ :param offset:
1172
+ :type offset: int
1173
+ :param ingestion_time:
1174
+ :type ingestion_time: int
1175
+ :param _request_timeout: timeout setting for this request. If one
1176
+ number provided, it will be total request
1177
+ timeout. It can also be a pair (tuple) of
1178
+ (connection, read) timeouts.
1179
+ :type _request_timeout: int, tuple(int, int), optional
1180
+ :param _request_auth: set to override the auth_settings for an a single
1181
+ request; this effectively ignores the
1182
+ authentication in the spec for a single request.
1183
+ :type _request_auth: dict, optional
1184
+ :param _content_type: force content-type for the request.
1185
+ :type _content_type: str, Optional
1186
+ :param _headers: set to override the headers for a single
1187
+ request; this effectively ignores the headers
1188
+ in the spec for a single request.
1189
+ :type _headers: dict, optional
1190
+ :param _host_index: set to override the host_index for a single
1191
+ request; this effectively ignores the host_index
1192
+ in the spec for a single request.
1193
+ :type _host_index: int, optional
1194
+ :return: Returns the result object.
1195
+ """ # noqa: E501
1196
+
1197
+ _param = self._get_trace_download_serialize(
1198
+ id=id,
1199
+ retrieval_size=retrieval_size,
1200
+ offset=offset,
1201
+ ingestion_time=ingestion_time,
1202
+ _request_auth=_request_auth,
1203
+ _content_type=_content_type,
1204
+ _headers=_headers,
1205
+ _host_index=_host_index
1206
+ )
1207
+
1208
+ _response_types_map: Dict[str, Optional[str]] = {
1209
+ '200': "TraceDownloadResult",
1210
+ }
1211
+ response_data = self.api_client.call_api(
1212
+ *_param,
1213
+ _request_timeout=_request_timeout
1214
+ )
1215
+ response_data.read()
1216
+ return self.api_client.response_deserialize(
1217
+ response_data=response_data,
1218
+ response_types_map=_response_types_map,
1219
+ ).data
1220
+
1221
+
1222
+ @validate_call
1223
+ def get_trace_download_with_http_info(
1224
+ self,
1225
+ id: StrictStr,
1226
+ retrieval_size: Optional[Annotated[int, Field(le=10000, strict=True, ge=1)]] = None,
1227
+ offset: Optional[StrictInt] = None,
1228
+ ingestion_time: Optional[StrictInt] = None,
1229
+ _request_timeout: Union[
1230
+ None,
1231
+ Annotated[StrictFloat, Field(gt=0)],
1232
+ Tuple[
1233
+ Annotated[StrictFloat, Field(gt=0)],
1234
+ Annotated[StrictFloat, Field(gt=0)]
1235
+ ]
1236
+ ] = None,
1237
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1238
+ _content_type: Optional[StrictStr] = None,
1239
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1240
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1241
+ ) -> ApiResponse[TraceDownloadResult]:
1242
+ """Get trace detail
1243
+
1244
+ Use this API endpoint if one wants to retrive comprehensive details of a particular trace.
1245
+
1246
+ :param id: (required)
1247
+ :type id: str
1248
+ :param retrieval_size:
1249
+ :type retrieval_size: int
1250
+ :param offset:
1251
+ :type offset: int
1252
+ :param ingestion_time:
1253
+ :type ingestion_time: int
1254
+ :param _request_timeout: timeout setting for this request. If one
1255
+ number provided, it will be total request
1256
+ timeout. It can also be a pair (tuple) of
1257
+ (connection, read) timeouts.
1258
+ :type _request_timeout: int, tuple(int, int), optional
1259
+ :param _request_auth: set to override the auth_settings for an a single
1260
+ request; this effectively ignores the
1261
+ authentication in the spec for a single request.
1262
+ :type _request_auth: dict, optional
1263
+ :param _content_type: force content-type for the request.
1264
+ :type _content_type: str, Optional
1265
+ :param _headers: set to override the headers for a single
1266
+ request; this effectively ignores the headers
1267
+ in the spec for a single request.
1268
+ :type _headers: dict, optional
1269
+ :param _host_index: set to override the host_index for a single
1270
+ request; this effectively ignores the host_index
1271
+ in the spec for a single request.
1272
+ :type _host_index: int, optional
1273
+ :return: Returns the result object.
1274
+ """ # noqa: E501
1275
+
1276
+ _param = self._get_trace_download_serialize(
1277
+ id=id,
1278
+ retrieval_size=retrieval_size,
1279
+ offset=offset,
1280
+ ingestion_time=ingestion_time,
1281
+ _request_auth=_request_auth,
1282
+ _content_type=_content_type,
1283
+ _headers=_headers,
1284
+ _host_index=_host_index
1285
+ )
1286
+
1287
+ _response_types_map: Dict[str, Optional[str]] = {
1288
+ '200': "TraceDownloadResult",
1289
+ }
1290
+ response_data = self.api_client.call_api(
1291
+ *_param,
1292
+ _request_timeout=_request_timeout
1293
+ )
1294
+ response_data.read()
1295
+ return self.api_client.response_deserialize(
1296
+ response_data=response_data,
1297
+ response_types_map=_response_types_map,
1298
+ )
1299
+
1300
+
1301
+ @validate_call
1302
+ def get_trace_download_without_preload_content(
1303
+ self,
1304
+ id: StrictStr,
1305
+ retrieval_size: Optional[Annotated[int, Field(le=10000, strict=True, ge=1)]] = None,
1306
+ offset: Optional[StrictInt] = None,
1307
+ ingestion_time: Optional[StrictInt] = None,
1308
+ _request_timeout: Union[
1309
+ None,
1310
+ Annotated[StrictFloat, Field(gt=0)],
1311
+ Tuple[
1312
+ Annotated[StrictFloat, Field(gt=0)],
1313
+ Annotated[StrictFloat, Field(gt=0)]
1314
+ ]
1315
+ ] = None,
1316
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1317
+ _content_type: Optional[StrictStr] = None,
1318
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1319
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1320
+ ) -> RESTResponseType:
1321
+ """Get trace detail
1322
+
1323
+ Use this API endpoint if one wants to retrive comprehensive details of a particular trace.
1324
+
1325
+ :param id: (required)
1326
+ :type id: str
1327
+ :param retrieval_size:
1328
+ :type retrieval_size: int
1329
+ :param offset:
1330
+ :type offset: int
1331
+ :param ingestion_time:
1332
+ :type ingestion_time: int
1333
+ :param _request_timeout: timeout setting for this request. If one
1334
+ number provided, it will be total request
1335
+ timeout. It can also be a pair (tuple) of
1336
+ (connection, read) timeouts.
1337
+ :type _request_timeout: int, tuple(int, int), optional
1338
+ :param _request_auth: set to override the auth_settings for an a single
1339
+ request; this effectively ignores the
1340
+ authentication in the spec for a single request.
1341
+ :type _request_auth: dict, optional
1342
+ :param _content_type: force content-type for the request.
1343
+ :type _content_type: str, Optional
1344
+ :param _headers: set to override the headers for a single
1345
+ request; this effectively ignores the headers
1346
+ in the spec for a single request.
1347
+ :type _headers: dict, optional
1348
+ :param _host_index: set to override the host_index for a single
1349
+ request; this effectively ignores the host_index
1350
+ in the spec for a single request.
1351
+ :type _host_index: int, optional
1352
+ :return: Returns the result object.
1353
+ """ # noqa: E501
1354
+
1355
+ _param = self._get_trace_download_serialize(
1356
+ id=id,
1357
+ retrieval_size=retrieval_size,
1358
+ offset=offset,
1359
+ ingestion_time=ingestion_time,
1360
+ _request_auth=_request_auth,
1361
+ _content_type=_content_type,
1362
+ _headers=_headers,
1363
+ _host_index=_host_index
1364
+ )
1365
+
1366
+ _response_types_map: Dict[str, Optional[str]] = {
1367
+ '200': "TraceDownloadResult",
1368
+ }
1369
+ response_data = self.api_client.call_api(
1370
+ *_param,
1371
+ _request_timeout=_request_timeout
1372
+ )
1373
+ return response_data.response
1374
+
1375
+
1376
+ def _get_trace_download_serialize(
1377
+ self,
1378
+ id,
1379
+ retrieval_size,
1380
+ offset,
1381
+ ingestion_time,
1382
+ _request_auth,
1383
+ _content_type,
1384
+ _headers,
1385
+ _host_index,
1386
+ ) -> RequestSerialized:
1387
+
1388
+ _host = None
1389
+
1390
+ _collection_formats: Dict[str, str] = {
1391
+ }
1392
+
1393
+ _path_params: Dict[str, str] = {}
1394
+ _query_params: List[Tuple[str, str]] = []
1395
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1396
+ _form_params: List[Tuple[str, str]] = []
1397
+ _files: Dict[
1398
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1399
+ ] = {}
1400
+ _body_params: Optional[bytes] = None
1401
+
1402
+ # process the path parameters
1403
+ if id is not None:
1404
+ _path_params['id'] = id
1405
+ # process the query parameters
1406
+ if retrieval_size is not None:
1407
+
1408
+ _query_params.append(('retrievalSize', retrieval_size))
1409
+
1410
+ if offset is not None:
1411
+
1412
+ _query_params.append(('offset', offset))
1413
+
1414
+ if ingestion_time is not None:
1415
+
1416
+ _query_params.append(('ingestionTime', ingestion_time))
1417
+
1418
+ # process the header parameters
1419
+ # process the form parameters
1420
+ # process the body parameter
1421
+
1422
+
1423
+ # set the HTTP header `Accept`
1424
+ if 'Accept' not in _header_params:
1425
+ _header_params['Accept'] = self.api_client.select_header_accept(
1426
+ [
1427
+ 'application/json'
1428
+ ]
1429
+ )
1430
+
1431
+
1432
+ # authentication setting
1433
+ _auth_settings: List[str] = [
1434
+ 'ApiKeyAuth'
1435
+ ]
1436
+
1437
+ return self.api_client.param_serialize(
1438
+ method='GET',
1439
+ resource_path='/api/application-monitoring/v2/analyze/traces/{id}',
1440
+ path_params=_path_params,
1441
+ query_params=_query_params,
1442
+ header_params=_header_params,
1443
+ body=_body_params,
1444
+ post_params=_form_params,
1445
+ files=_files,
1446
+ auth_settings=_auth_settings,
1447
+ collection_formats=_collection_formats,
1448
+ _host=_host,
1449
+ _request_auth=_request_auth
1450
+ )
1451
+
1452
+
1453
+
1454
+
1455
+ @validate_call
1456
+ def get_trace_groups(
1457
+ self,
1458
+ fill_time_series: Annotated[Optional[StrictBool], Field(description="If enabled, fill the missing data points in the metric result with timestamp and value 0.")] = None,
1459
+ get_trace_groups: Optional[GetTraceGroups] = None,
1460
+ _request_timeout: Union[
1461
+ None,
1462
+ Annotated[StrictFloat, Field(gt=0)],
1463
+ Tuple[
1464
+ Annotated[StrictFloat, Field(gt=0)],
1465
+ Annotated[StrictFloat, Field(gt=0)]
1466
+ ]
1467
+ ] = None,
1468
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1469
+ _content_type: Optional[StrictStr] = None,
1470
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1471
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1472
+ ) -> TraceGroupsResult:
1473
+ """Get grouped trace metrics
1474
+
1475
+ The API endpoint retrieves metrics for traces that are grouped in the endpoint or service name. The supported `groupbyTag` are `trace.endpoint.name` and `trace.service.name`. {: note}
1476
+
1477
+ :param fill_time_series: If enabled, fill the missing data points in the metric result with timestamp and value 0.
1478
+ :type fill_time_series: bool
1479
+ :param get_trace_groups:
1480
+ :type get_trace_groups: GetTraceGroups
1481
+ :param _request_timeout: timeout setting for this request. If one
1482
+ number provided, it will be total request
1483
+ timeout. It can also be a pair (tuple) of
1484
+ (connection, read) timeouts.
1485
+ :type _request_timeout: int, tuple(int, int), optional
1486
+ :param _request_auth: set to override the auth_settings for an a single
1487
+ request; this effectively ignores the
1488
+ authentication in the spec for a single request.
1489
+ :type _request_auth: dict, optional
1490
+ :param _content_type: force content-type for the request.
1491
+ :type _content_type: str, Optional
1492
+ :param _headers: set to override the headers for a single
1493
+ request; this effectively ignores the headers
1494
+ in the spec for a single request.
1495
+ :type _headers: dict, optional
1496
+ :param _host_index: set to override the host_index for a single
1497
+ request; this effectively ignores the host_index
1498
+ in the spec for a single request.
1499
+ :type _host_index: int, optional
1500
+ :return: Returns the result object.
1501
+ """ # noqa: E501
1502
+
1503
+ _param = self._get_trace_groups_serialize(
1504
+ fill_time_series=fill_time_series,
1505
+ get_trace_groups=get_trace_groups,
1506
+ _request_auth=_request_auth,
1507
+ _content_type=_content_type,
1508
+ _headers=_headers,
1509
+ _host_index=_host_index
1510
+ )
1511
+
1512
+ _response_types_map: Dict[str, Optional[str]] = {
1513
+ '200': "TraceGroupsResult",
1514
+ }
1515
+ response_data = self.api_client.call_api(
1516
+ *_param,
1517
+ _request_timeout=_request_timeout
1518
+ )
1519
+ response_data.read()
1520
+ return self.api_client.response_deserialize(
1521
+ response_data=response_data,
1522
+ response_types_map=_response_types_map,
1523
+ ).data
1524
+
1525
+
1526
+ @validate_call
1527
+ def get_trace_groups_with_http_info(
1528
+ self,
1529
+ fill_time_series: Annotated[Optional[StrictBool], Field(description="If enabled, fill the missing data points in the metric result with timestamp and value 0.")] = None,
1530
+ get_trace_groups: Optional[GetTraceGroups] = None,
1531
+ _request_timeout: Union[
1532
+ None,
1533
+ Annotated[StrictFloat, Field(gt=0)],
1534
+ Tuple[
1535
+ Annotated[StrictFloat, Field(gt=0)],
1536
+ Annotated[StrictFloat, Field(gt=0)]
1537
+ ]
1538
+ ] = None,
1539
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1540
+ _content_type: Optional[StrictStr] = None,
1541
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1542
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1543
+ ) -> ApiResponse[TraceGroupsResult]:
1544
+ """Get grouped trace metrics
1545
+
1546
+ The API endpoint retrieves metrics for traces that are grouped in the endpoint or service name. The supported `groupbyTag` are `trace.endpoint.name` and `trace.service.name`. {: note}
1547
+
1548
+ :param fill_time_series: If enabled, fill the missing data points in the metric result with timestamp and value 0.
1549
+ :type fill_time_series: bool
1550
+ :param get_trace_groups:
1551
+ :type get_trace_groups: GetTraceGroups
1552
+ :param _request_timeout: timeout setting for this request. If one
1553
+ number provided, it will be total request
1554
+ timeout. It can also be a pair (tuple) of
1555
+ (connection, read) timeouts.
1556
+ :type _request_timeout: int, tuple(int, int), optional
1557
+ :param _request_auth: set to override the auth_settings for an a single
1558
+ request; this effectively ignores the
1559
+ authentication in the spec for a single request.
1560
+ :type _request_auth: dict, optional
1561
+ :param _content_type: force content-type for the request.
1562
+ :type _content_type: str, Optional
1563
+ :param _headers: set to override the headers for a single
1564
+ request; this effectively ignores the headers
1565
+ in the spec for a single request.
1566
+ :type _headers: dict, optional
1567
+ :param _host_index: set to override the host_index for a single
1568
+ request; this effectively ignores the host_index
1569
+ in the spec for a single request.
1570
+ :type _host_index: int, optional
1571
+ :return: Returns the result object.
1572
+ """ # noqa: E501
1573
+
1574
+ _param = self._get_trace_groups_serialize(
1575
+ fill_time_series=fill_time_series,
1576
+ get_trace_groups=get_trace_groups,
1577
+ _request_auth=_request_auth,
1578
+ _content_type=_content_type,
1579
+ _headers=_headers,
1580
+ _host_index=_host_index
1581
+ )
1582
+
1583
+ _response_types_map: Dict[str, Optional[str]] = {
1584
+ '200': "TraceGroupsResult",
1585
+ }
1586
+ response_data = self.api_client.call_api(
1587
+ *_param,
1588
+ _request_timeout=_request_timeout
1589
+ )
1590
+ response_data.read()
1591
+ return self.api_client.response_deserialize(
1592
+ response_data=response_data,
1593
+ response_types_map=_response_types_map,
1594
+ )
1595
+
1596
+
1597
+ @validate_call
1598
+ def get_trace_groups_without_preload_content(
1599
+ self,
1600
+ fill_time_series: Annotated[Optional[StrictBool], Field(description="If enabled, fill the missing data points in the metric result with timestamp and value 0.")] = None,
1601
+ get_trace_groups: Optional[GetTraceGroups] = None,
1602
+ _request_timeout: Union[
1603
+ None,
1604
+ Annotated[StrictFloat, Field(gt=0)],
1605
+ Tuple[
1606
+ Annotated[StrictFloat, Field(gt=0)],
1607
+ Annotated[StrictFloat, Field(gt=0)]
1608
+ ]
1609
+ ] = None,
1610
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1611
+ _content_type: Optional[StrictStr] = None,
1612
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1613
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1614
+ ) -> RESTResponseType:
1615
+ """Get grouped trace metrics
1616
+
1617
+ The API endpoint retrieves metrics for traces that are grouped in the endpoint or service name. The supported `groupbyTag` are `trace.endpoint.name` and `trace.service.name`. {: note}
1618
+
1619
+ :param fill_time_series: If enabled, fill the missing data points in the metric result with timestamp and value 0.
1620
+ :type fill_time_series: bool
1621
+ :param get_trace_groups:
1622
+ :type get_trace_groups: GetTraceGroups
1623
+ :param _request_timeout: timeout setting for this request. If one
1624
+ number provided, it will be total request
1625
+ timeout. It can also be a pair (tuple) of
1626
+ (connection, read) timeouts.
1627
+ :type _request_timeout: int, tuple(int, int), optional
1628
+ :param _request_auth: set to override the auth_settings for an a single
1629
+ request; this effectively ignores the
1630
+ authentication in the spec for a single request.
1631
+ :type _request_auth: dict, optional
1632
+ :param _content_type: force content-type for the request.
1633
+ :type _content_type: str, Optional
1634
+ :param _headers: set to override the headers for a single
1635
+ request; this effectively ignores the headers
1636
+ in the spec for a single request.
1637
+ :type _headers: dict, optional
1638
+ :param _host_index: set to override the host_index for a single
1639
+ request; this effectively ignores the host_index
1640
+ in the spec for a single request.
1641
+ :type _host_index: int, optional
1642
+ :return: Returns the result object.
1643
+ """ # noqa: E501
1644
+
1645
+ _param = self._get_trace_groups_serialize(
1646
+ fill_time_series=fill_time_series,
1647
+ get_trace_groups=get_trace_groups,
1648
+ _request_auth=_request_auth,
1649
+ _content_type=_content_type,
1650
+ _headers=_headers,
1651
+ _host_index=_host_index
1652
+ )
1653
+
1654
+ _response_types_map: Dict[str, Optional[str]] = {
1655
+ '200': "TraceGroupsResult",
1656
+ }
1657
+ response_data = self.api_client.call_api(
1658
+ *_param,
1659
+ _request_timeout=_request_timeout
1660
+ )
1661
+ return response_data.response
1662
+
1663
+
1664
+ def _get_trace_groups_serialize(
1665
+ self,
1666
+ fill_time_series,
1667
+ get_trace_groups,
1668
+ _request_auth,
1669
+ _content_type,
1670
+ _headers,
1671
+ _host_index,
1672
+ ) -> RequestSerialized:
1673
+
1674
+ _host = None
1675
+
1676
+ _collection_formats: Dict[str, str] = {
1677
+ }
1678
+
1679
+ _path_params: Dict[str, str] = {}
1680
+ _query_params: List[Tuple[str, str]] = []
1681
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1682
+ _form_params: List[Tuple[str, str]] = []
1683
+ _files: Dict[
1684
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1685
+ ] = {}
1686
+ _body_params: Optional[bytes] = None
1687
+
1688
+ # process the path parameters
1689
+ # process the query parameters
1690
+ if fill_time_series is not None:
1691
+
1692
+ _query_params.append(('fillTimeSeries', fill_time_series))
1693
+
1694
+ # process the header parameters
1695
+ # process the form parameters
1696
+ # process the body parameter
1697
+ if get_trace_groups is not None:
1698
+ _body_params = get_trace_groups
1699
+
1700
+
1701
+ # set the HTTP header `Accept`
1702
+ if 'Accept' not in _header_params:
1703
+ _header_params['Accept'] = self.api_client.select_header_accept(
1704
+ [
1705
+ 'application/json'
1706
+ ]
1707
+ )
1708
+
1709
+ # set the HTTP header `Content-Type`
1710
+ if _content_type:
1711
+ _header_params['Content-Type'] = _content_type
1712
+ else:
1713
+ _default_content_type = (
1714
+ self.api_client.select_header_content_type(
1715
+ [
1716
+ 'application/json'
1717
+ ]
1718
+ )
1719
+ )
1720
+ if _default_content_type is not None:
1721
+ _header_params['Content-Type'] = _default_content_type
1722
+
1723
+ # authentication setting
1724
+ _auth_settings: List[str] = [
1725
+ 'ApiKeyAuth'
1726
+ ]
1727
+
1728
+ return self.api_client.param_serialize(
1729
+ method='POST',
1730
+ resource_path='/api/application-monitoring/analyze/trace-groups',
1731
+ path_params=_path_params,
1732
+ query_params=_query_params,
1733
+ header_params=_header_params,
1734
+ body=_body_params,
1735
+ post_params=_form_params,
1736
+ files=_files,
1737
+ auth_settings=_auth_settings,
1738
+ collection_formats=_collection_formats,
1739
+ _host=_host,
1740
+ _request_auth=_request_auth
1741
+ )
1742
+
1743
+
1744
+
1745
+
1746
+ @validate_call
1747
+ def get_traces(
1748
+ self,
1749
+ get_traces: Optional[GetTraces] = None,
1750
+ _request_timeout: Union[
1751
+ None,
1752
+ Annotated[StrictFloat, Field(gt=0)],
1753
+ Tuple[
1754
+ Annotated[StrictFloat, Field(gt=0)],
1755
+ Annotated[StrictFloat, Field(gt=0)]
1756
+ ]
1757
+ ] = None,
1758
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1759
+ _content_type: Optional[StrictStr] = None,
1760
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1761
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1762
+ ) -> TraceResult:
1763
+ """Get all traces
1764
+
1765
+ This endpoint retrieves the metrics for traces. **Manditory Paramters:** **Optional Paramters:** **Defaults:** **Limits:** **Tips:**
1766
+
1767
+ :param get_traces:
1768
+ :type get_traces: GetTraces
1769
+ :param _request_timeout: timeout setting for this request. If one
1770
+ number provided, it will be total request
1771
+ timeout. It can also be a pair (tuple) of
1772
+ (connection, read) timeouts.
1773
+ :type _request_timeout: int, tuple(int, int), optional
1774
+ :param _request_auth: set to override the auth_settings for an a single
1775
+ request; this effectively ignores the
1776
+ authentication in the spec for a single request.
1777
+ :type _request_auth: dict, optional
1778
+ :param _content_type: force content-type for the request.
1779
+ :type _content_type: str, Optional
1780
+ :param _headers: set to override the headers for a single
1781
+ request; this effectively ignores the headers
1782
+ in the spec for a single request.
1783
+ :type _headers: dict, optional
1784
+ :param _host_index: set to override the host_index for a single
1785
+ request; this effectively ignores the host_index
1786
+ in the spec for a single request.
1787
+ :type _host_index: int, optional
1788
+ :return: Returns the result object.
1789
+ """ # noqa: E501
1790
+
1791
+ _param = self._get_traces_serialize(
1792
+ get_traces=get_traces,
1793
+ _request_auth=_request_auth,
1794
+ _content_type=_content_type,
1795
+ _headers=_headers,
1796
+ _host_index=_host_index
1797
+ )
1798
+
1799
+ _response_types_map: Dict[str, Optional[str]] = {
1800
+ '200': "TraceResult",
1801
+ }
1802
+ response_data = self.api_client.call_api(
1803
+ *_param,
1804
+ _request_timeout=_request_timeout
1805
+ )
1806
+ response_data.read()
1807
+ return self.api_client.response_deserialize(
1808
+ response_data=response_data,
1809
+ response_types_map=_response_types_map,
1810
+ ).data
1811
+
1812
+
1813
+ @validate_call
1814
+ def get_traces_with_http_info(
1815
+ self,
1816
+ get_traces: Optional[GetTraces] = None,
1817
+ _request_timeout: Union[
1818
+ None,
1819
+ Annotated[StrictFloat, Field(gt=0)],
1820
+ Tuple[
1821
+ Annotated[StrictFloat, Field(gt=0)],
1822
+ Annotated[StrictFloat, Field(gt=0)]
1823
+ ]
1824
+ ] = None,
1825
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1826
+ _content_type: Optional[StrictStr] = None,
1827
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1828
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1829
+ ) -> ApiResponse[TraceResult]:
1830
+ """Get all traces
1831
+
1832
+ This endpoint retrieves the metrics for traces. **Manditory Paramters:** **Optional Paramters:** **Defaults:** **Limits:** **Tips:**
1833
+
1834
+ :param get_traces:
1835
+ :type get_traces: GetTraces
1836
+ :param _request_timeout: timeout setting for this request. If one
1837
+ number provided, it will be total request
1838
+ timeout. It can also be a pair (tuple) of
1839
+ (connection, read) timeouts.
1840
+ :type _request_timeout: int, tuple(int, int), optional
1841
+ :param _request_auth: set to override the auth_settings for an a single
1842
+ request; this effectively ignores the
1843
+ authentication in the spec for a single request.
1844
+ :type _request_auth: dict, optional
1845
+ :param _content_type: force content-type for the request.
1846
+ :type _content_type: str, Optional
1847
+ :param _headers: set to override the headers for a single
1848
+ request; this effectively ignores the headers
1849
+ in the spec for a single request.
1850
+ :type _headers: dict, optional
1851
+ :param _host_index: set to override the host_index for a single
1852
+ request; this effectively ignores the host_index
1853
+ in the spec for a single request.
1854
+ :type _host_index: int, optional
1855
+ :return: Returns the result object.
1856
+ """ # noqa: E501
1857
+
1858
+ _param = self._get_traces_serialize(
1859
+ get_traces=get_traces,
1860
+ _request_auth=_request_auth,
1861
+ _content_type=_content_type,
1862
+ _headers=_headers,
1863
+ _host_index=_host_index
1864
+ )
1865
+
1866
+ _response_types_map: Dict[str, Optional[str]] = {
1867
+ '200': "TraceResult",
1868
+ }
1869
+ response_data = self.api_client.call_api(
1870
+ *_param,
1871
+ _request_timeout=_request_timeout
1872
+ )
1873
+ response_data.read()
1874
+ return self.api_client.response_deserialize(
1875
+ response_data=response_data,
1876
+ response_types_map=_response_types_map,
1877
+ )
1878
+
1879
+
1880
+ @validate_call
1881
+ def get_traces_without_preload_content(
1882
+ self,
1883
+ get_traces: Optional[GetTraces] = None,
1884
+ _request_timeout: Union[
1885
+ None,
1886
+ Annotated[StrictFloat, Field(gt=0)],
1887
+ Tuple[
1888
+ Annotated[StrictFloat, Field(gt=0)],
1889
+ Annotated[StrictFloat, Field(gt=0)]
1890
+ ]
1891
+ ] = None,
1892
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1893
+ _content_type: Optional[StrictStr] = None,
1894
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1895
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1896
+ ) -> RESTResponseType:
1897
+ """Get all traces
1898
+
1899
+ This endpoint retrieves the metrics for traces. **Manditory Paramters:** **Optional Paramters:** **Defaults:** **Limits:** **Tips:**
1900
+
1901
+ :param get_traces:
1902
+ :type get_traces: GetTraces
1903
+ :param _request_timeout: timeout setting for this request. If one
1904
+ number provided, it will be total request
1905
+ timeout. It can also be a pair (tuple) of
1906
+ (connection, read) timeouts.
1907
+ :type _request_timeout: int, tuple(int, int), optional
1908
+ :param _request_auth: set to override the auth_settings for an a single
1909
+ request; this effectively ignores the
1910
+ authentication in the spec for a single request.
1911
+ :type _request_auth: dict, optional
1912
+ :param _content_type: force content-type for the request.
1913
+ :type _content_type: str, Optional
1914
+ :param _headers: set to override the headers for a single
1915
+ request; this effectively ignores the headers
1916
+ in the spec for a single request.
1917
+ :type _headers: dict, optional
1918
+ :param _host_index: set to override the host_index for a single
1919
+ request; this effectively ignores the host_index
1920
+ in the spec for a single request.
1921
+ :type _host_index: int, optional
1922
+ :return: Returns the result object.
1923
+ """ # noqa: E501
1924
+
1925
+ _param = self._get_traces_serialize(
1926
+ get_traces=get_traces,
1927
+ _request_auth=_request_auth,
1928
+ _content_type=_content_type,
1929
+ _headers=_headers,
1930
+ _host_index=_host_index
1931
+ )
1932
+
1933
+ _response_types_map: Dict[str, Optional[str]] = {
1934
+ '200': "TraceResult",
1935
+ }
1936
+ response_data = self.api_client.call_api(
1937
+ *_param,
1938
+ _request_timeout=_request_timeout
1939
+ )
1940
+ return response_data.response
1941
+
1942
+
1943
+ def _get_traces_serialize(
1944
+ self,
1945
+ get_traces,
1946
+ _request_auth,
1947
+ _content_type,
1948
+ _headers,
1949
+ _host_index,
1950
+ ) -> RequestSerialized:
1951
+
1952
+ _host = None
1953
+
1954
+ _collection_formats: Dict[str, str] = {
1955
+ }
1956
+
1957
+ _path_params: Dict[str, str] = {}
1958
+ _query_params: List[Tuple[str, str]] = []
1959
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1960
+ _form_params: List[Tuple[str, str]] = []
1961
+ _files: Dict[
1962
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1963
+ ] = {}
1964
+ _body_params: Optional[bytes] = None
1965
+
1966
+ # process the path parameters
1967
+ # process the query parameters
1968
+ # process the header parameters
1969
+ # process the form parameters
1970
+ # process the body parameter
1971
+ if get_traces is not None:
1972
+ _body_params = get_traces
1973
+
1974
+
1975
+ # set the HTTP header `Accept`
1976
+ if 'Accept' not in _header_params:
1977
+ _header_params['Accept'] = self.api_client.select_header_accept(
1978
+ [
1979
+ 'application/json'
1980
+ ]
1981
+ )
1982
+
1983
+ # set the HTTP header `Content-Type`
1984
+ if _content_type:
1985
+ _header_params['Content-Type'] = _content_type
1986
+ else:
1987
+ _default_content_type = (
1988
+ self.api_client.select_header_content_type(
1989
+ [
1990
+ 'application/json'
1991
+ ]
1992
+ )
1993
+ )
1994
+ if _default_content_type is not None:
1995
+ _header_params['Content-Type'] = _default_content_type
1996
+
1997
+ # authentication setting
1998
+ _auth_settings: List[str] = [
1999
+ 'ApiKeyAuth'
2000
+ ]
2001
+
2002
+ return self.api_client.param_serialize(
2003
+ method='POST',
2004
+ resource_path='/api/application-monitoring/analyze/traces',
2005
+ path_params=_path_params,
2006
+ query_params=_query_params,
2007
+ header_params=_header_params,
2008
+ body=_body_params,
2009
+ post_params=_form_params,
2010
+ files=_files,
2011
+ auth_settings=_auth_settings,
2012
+ collection_formats=_collection_formats,
2013
+ _host=_host,
2014
+ _request_auth=_request_auth
2015
+ )
2016
+
2017
+