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