From 7db3e587478a3bfcae539cf5a6871a12ecfe7703 Mon Sep 17 00:00:00 2001 From: Matthew Kime Date: Tue, 7 Jun 2022 16:08:22 -0500 Subject: [PATCH] update docs (#133798) --- api_docs/actions.devdocs.json | 2 +- api_docs/actions.mdx | 2 +- api_docs/advanced_settings.mdx | 2 +- api_docs/aiops.mdx | 2 +- api_docs/alerting.mdx | 2 +- api_docs/apm.devdocs.json | 114 +- api_docs/apm.mdx | 2 +- api_docs/banners.mdx | 2 +- api_docs/bfetch.mdx | 2 +- api_docs/canvas.mdx | 2 +- api_docs/cases.mdx | 2 +- api_docs/charts.mdx | 2 +- api_docs/cloud.mdx | 2 +- api_docs/cloud_security_posture.mdx | 2 +- api_docs/console.mdx | 2 +- api_docs/controls.devdocs.json | 50 +- api_docs/controls.mdx | 4 +- api_docs/core.devdocs.json | 234 +- api_docs/core.mdx | 4 +- api_docs/core_application.mdx | 4 +- api_docs/core_chrome.devdocs.json | 58 +- api_docs/core_chrome.mdx | 4 +- api_docs/core_http.mdx | 4 +- api_docs/core_saved_objects.devdocs.json | 5097 +-- api_docs/core_saved_objects.mdx | 7 +- api_docs/custom_integrations.mdx | 2 +- api_docs/dashboard.devdocs.json | 26 +- api_docs/dashboard.mdx | 2 +- api_docs/dashboard_enhanced.mdx | 2 +- api_docs/data.devdocs.json | 37459 ++++++++-------- api_docs/data.mdx | 4 +- api_docs/data_query.devdocs.json | 400 +- api_docs/data_query.mdx | 4 +- api_docs/data_search.devdocs.json | 969 +- api_docs/data_search.mdx | 4 +- api_docs/data_view_editor.mdx | 2 +- api_docs/data_view_field_editor.mdx | 2 +- api_docs/data_view_management.mdx | 2 +- api_docs/data_views.devdocs.json | 30215 ++++++------- api_docs/data_views.mdx | 4 +- api_docs/data_visualizer.mdx | 2 +- api_docs/deprecations_by_api.mdx | 89 +- api_docs/deprecations_by_plugin.mdx | 225 +- api_docs/deprecations_by_team.mdx | 66 +- api_docs/dev_tools.mdx | 2 +- api_docs/discover.devdocs.json | 18 +- api_docs/discover.mdx | 2 +- api_docs/discover_enhanced.mdx | 2 +- api_docs/elastic_apm_synthtrace.devdocs.json | 6 +- api_docs/elastic_apm_synthtrace.mdx | 2 +- api_docs/embeddable.devdocs.json | 15 +- api_docs/embeddable.mdx | 4 +- api_docs/embeddable_enhanced.mdx | 2 +- api_docs/encrypted_saved_objects.mdx | 2 +- api_docs/enterprise_search.mdx | 2 +- api_docs/es_ui_shared.mdx | 2 +- api_docs/event_annotation.mdx | 2 +- api_docs/event_log.devdocs.json | 6 +- api_docs/event_log.mdx | 2 +- api_docs/expression_error.mdx | 2 +- api_docs/expression_gauge.mdx | 2 +- api_docs/expression_heatmap.mdx | 2 +- api_docs/expression_image.mdx | 2 +- api_docs/expression_metric.mdx | 2 +- api_docs/expression_metric_vis.mdx | 2 +- api_docs/expression_partition_vis.mdx | 2 +- api_docs/expression_repeat_image.mdx | 2 +- api_docs/expression_reveal_image.mdx | 2 +- api_docs/expression_shape.devdocs.json | 2 +- api_docs/expression_shape.mdx | 2 +- api_docs/expression_tagcloud.mdx | 2 +- api_docs/expression_x_y.devdocs.json | 55 +- api_docs/expression_x_y.mdx | 4 +- api_docs/expressions.devdocs.json | 88 +- api_docs/expressions.mdx | 2 +- api_docs/features.mdx | 2 +- api_docs/field_formats.devdocs.json | 410 +- api_docs/field_formats.mdx | 4 +- api_docs/file_upload.mdx | 2 +- api_docs/fleet.devdocs.json | 427 +- api_docs/fleet.mdx | 4 +- api_docs/global_search.mdx | 2 +- api_docs/home.mdx | 2 +- api_docs/index_lifecycle_management.mdx | 2 +- api_docs/index_management.devdocs.json | 2 +- api_docs/index_management.mdx | 2 +- api_docs/infra.mdx | 2 +- api_docs/inspector.mdx | 2 +- api_docs/interactive_setup.mdx | 2 +- api_docs/kbn_ace.mdx | 2 +- api_docs/kbn_aiops_utils.mdx | 2 +- api_docs/kbn_alerts.mdx | 2 +- api_docs/kbn_analytics.mdx | 2 +- api_docs/kbn_analytics_client.devdocs.json | 47 +- api_docs/kbn_analytics_client.mdx | 4 +- ...s_shippers_elastic_v3_browser.devdocs.json | 55 +- ..._analytics_shippers_elastic_v3_browser.mdx | 4 +- ...cs_shippers_elastic_v3_common.devdocs.json | 133 +- ...n_analytics_shippers_elastic_v3_common.mdx | 4 +- ...cs_shippers_elastic_v3_server.devdocs.json | 55 +- ...n_analytics_shippers_elastic_v3_server.mdx | 4 +- ..._analytics_shippers_fullstory.devdocs.json | 34 +- api_docs/kbn_analytics_shippers_fullstory.mdx | 4 +- api_docs/kbn_apm_config_loader.mdx | 2 +- api_docs/kbn_apm_utils.mdx | 2 +- api_docs/kbn_axe_config.mdx | 2 +- api_docs/kbn_bazel_packages.mdx | 2 +- api_docs/kbn_bazel_runner.mdx | 2 +- api_docs/kbn_ci_stats_core.mdx | 2 +- api_docs/kbn_ci_stats_reporter.mdx | 2 +- api_docs/kbn_cli_dev_mode.mdx | 2 +- api_docs/kbn_coloring.mdx | 2 +- api_docs/kbn_config.mdx | 2 +- api_docs/kbn_config_mocks.devdocs.json | 328 + api_docs/kbn_config_mocks.mdx | 33 + api_docs/kbn_config_schema.mdx | 2 +- api_docs/kbn_core_base_common.devdocs.json | 194 + api_docs/kbn_core_base_common.mdx | 33 + ...ore_injected_metadata_browser.devdocs.json | 154 + .../kbn_core_injected_metadata_browser.mdx | 27 + ...jected_metadata_browser_mocks.devdocs.json | 90 + ...n_core_injected_metadata_browser_mocks.mdx | 27 + api_docs/kbn_crypto.mdx | 2 +- api_docs/kbn_datemath.mdx | 2 +- api_docs/kbn_dev_cli_errors.mdx | 2 +- api_docs/kbn_dev_cli_runner.mdx | 2 +- api_docs/kbn_dev_proc_runner.mdx | 2 +- api_docs/kbn_dev_utils.mdx | 2 +- api_docs/kbn_doc_links.devdocs.json | 2 +- api_docs/kbn_doc_links.mdx | 2 +- api_docs/kbn_docs_utils.mdx | 2 +- api_docs/kbn_es_archiver.mdx | 2 +- api_docs/kbn_es_query.devdocs.json | 222 +- api_docs/kbn_es_query.mdx | 4 +- api_docs/kbn_eslint_plugin_imports.mdx | 2 +- api_docs/kbn_field_types.mdx | 2 +- api_docs/kbn_find_used_node_modules.mdx | 2 +- api_docs/kbn_generate.mdx | 2 +- api_docs/kbn_handlebars.mdx | 2 +- api_docs/kbn_i18n.mdx | 2 +- api_docs/kbn_import_resolver.mdx | 2 +- api_docs/kbn_interpreter.mdx | 2 +- api_docs/kbn_io_ts_utils.mdx | 2 +- api_docs/kbn_jest_serializers.mdx | 2 +- api_docs/kbn_kibana_json_schema.mdx | 2 +- api_docs/kbn_logging.mdx | 2 +- api_docs/kbn_logging_mocks.mdx | 2 +- api_docs/kbn_mapbox_gl.mdx | 2 +- api_docs/kbn_monaco.mdx | 2 +- api_docs/kbn_optimizer.mdx | 2 +- ..._performance_testing_dataset_extractor.mdx | 2 +- api_docs/kbn_plugin_discovery.mdx | 2 +- api_docs/kbn_plugin_generator.mdx | 2 +- api_docs/kbn_plugin_helpers.mdx | 2 +- api_docs/kbn_pm.mdx | 2 +- api_docs/kbn_react_field.mdx | 2 +- api_docs/kbn_rule_data_utils.devdocs.json | 4 +- api_docs/kbn_rule_data_utils.mdx | 2 +- ...securitysolution_autocomplete.devdocs.json | 6 +- .../kbn_securitysolution_autocomplete.mdx | 2 +- api_docs/kbn_securitysolution_es_utils.mdx | 2 +- api_docs/kbn_securitysolution_hook_utils.mdx | 2 +- ..._securitysolution_io_ts_alerting_types.mdx | 2 +- ...ritysolution_io_ts_list_types.devdocs.json | 86 +- .../kbn_securitysolution_io_ts_list_types.mdx | 2 +- api_docs/kbn_securitysolution_io_ts_types.mdx | 2 +- api_docs/kbn_securitysolution_io_ts_utils.mdx | 2 +- ...kbn_securitysolution_list_api.devdocs.json | 18 +- api_docs/kbn_securitysolution_list_api.mdx | 2 +- .../kbn_securitysolution_list_constants.mdx | 2 +- ...n_securitysolution_list_hooks.devdocs.json | 40 +- api_docs/kbn_securitysolution_list_hooks.mdx | 2 +- ...n_securitysolution_list_utils.devdocs.json | 26 +- api_docs/kbn_securitysolution_list_utils.mdx | 2 +- api_docs/kbn_securitysolution_rules.mdx | 2 +- api_docs/kbn_securitysolution_t_grid.mdx | 2 +- api_docs/kbn_securitysolution_utils.mdx | 2 +- api_docs/kbn_server_http_tools.mdx | 2 +- api_docs/kbn_server_route_repository.mdx | 2 +- ...ed_ux_button_exit_full_screen.devdocs.json | 242 - .../kbn_shared_ux_button_exit_full_screen.mdx | 27 - .../kbn_shared_ux_components.devdocs.json | 254 +- api_docs/kbn_shared_ux_components.mdx | 4 +- ...red_ux_page_analytics_no_data.devdocs.json | 57 +- .../kbn_shared_ux_page_analytics_no_data.mdx | 4 +- ...hared_ux_prompt_no_data_views.devdocs.json | 309 + .../kbn_shared_ux_prompt_no_data_views.mdx | 30 + api_docs/kbn_shared_ux_services.mdx | 2 +- api_docs/kbn_shared_ux_storybook.mdx | 2 +- api_docs/kbn_shared_ux_utility.mdx | 2 +- api_docs/kbn_sort_package_json.mdx | 2 +- api_docs/kbn_std.mdx | 2 +- api_docs/kbn_stdio_dev_helpers.mdx | 2 +- api_docs/kbn_storybook.devdocs.json | 3 + api_docs/kbn_storybook.mdx | 2 +- api_docs/kbn_telemetry_tools.mdx | 2 +- api_docs/kbn_test.devdocs.json | 16 + api_docs/kbn_test.mdx | 4 +- api_docs/kbn_test_jest_helpers.mdx | 2 +- api_docs/kbn_tooling_log.mdx | 2 +- api_docs/kbn_type_summarizer.mdx | 2 +- api_docs/kbn_typed_react_router_config.mdx | 2 +- api_docs/kbn_ui_theme.mdx | 2 +- api_docs/kbn_utility_types.mdx | 2 +- api_docs/kbn_utility_types_jest.devdocs.json | 64 + api_docs/kbn_utility_types_jest.mdx | 27 + api_docs/kbn_utils.mdx | 2 +- api_docs/kibana_overview.mdx | 2 +- api_docs/kibana_react.devdocs.json | 21 +- api_docs/kibana_react.mdx | 4 +- api_docs/kibana_utils.mdx | 2 +- api_docs/kubernetes_security.devdocs.json | 73 + api_docs/kubernetes_security.mdx | 27 + api_docs/lens.devdocs.json | 277 +- api_docs/lens.mdx | 4 +- api_docs/license_api_guard.mdx | 2 +- api_docs/license_management.mdx | 2 +- api_docs/licensing.devdocs.json | 8 +- api_docs/licensing.mdx | 2 +- api_docs/lists.devdocs.json | 64 +- api_docs/lists.mdx | 2 +- api_docs/management.mdx | 2 +- api_docs/maps.mdx | 2 +- api_docs/maps_ems.mdx | 2 +- api_docs/ml.mdx | 2 +- api_docs/monitoring.mdx | 2 +- api_docs/monitoring_collection.mdx | 2 +- api_docs/navigation.mdx | 2 +- api_docs/newsfeed.mdx | 2 +- api_docs/observability.devdocs.json | 117 +- api_docs/observability.mdx | 4 +- api_docs/osquery.mdx | 2 +- api_docs/plugin_directory.mdx | 62 +- api_docs/presentation_util.mdx | 2 +- api_docs/remote_clusters.mdx | 2 +- api_docs/reporting.devdocs.json | 60 +- api_docs/reporting.mdx | 2 +- api_docs/rollup.mdx | 2 +- api_docs/rule_registry.devdocs.json | 2 +- api_docs/rule_registry.mdx | 2 +- api_docs/runtime_fields.mdx | 2 +- api_docs/saved_objects.devdocs.json | 122 +- api_docs/saved_objects.mdx | 2 +- .../saved_objects_management.devdocs.json | 2 +- api_docs/saved_objects_management.mdx | 2 +- api_docs/saved_objects_tagging.mdx | 2 +- api_docs/saved_objects_tagging_oss.mdx | 2 +- api_docs/screenshot_mode.mdx | 2 +- api_docs/screenshotting.devdocs.json | 62 +- api_docs/screenshotting.mdx | 10 +- api_docs/security.mdx | 2 +- api_docs/security_solution.devdocs.json | 66 +- api_docs/security_solution.mdx | 4 +- api_docs/session_view.mdx | 2 +- api_docs/share.mdx | 2 +- api_docs/shared_u_x.mdx | 2 +- api_docs/snapshot_restore.mdx | 2 +- api_docs/spaces.mdx | 2 +- api_docs/stack_alerts.mdx | 2 +- api_docs/task_manager.mdx | 2 +- api_docs/telemetry.mdx | 2 +- api_docs/telemetry_collection_manager.mdx | 2 +- api_docs/telemetry_collection_xpack.mdx | 2 +- api_docs/telemetry_management_section.mdx | 2 +- api_docs/timelines.mdx | 2 +- api_docs/transform.mdx | 2 +- api_docs/triggers_actions_ui.devdocs.json | 217 +- api_docs/triggers_actions_ui.mdx | 4 +- api_docs/ui_actions.mdx | 2 +- api_docs/ui_actions_enhanced.mdx | 2 +- api_docs/unified_search.mdx | 2 +- .../unified_search_autocomplete.devdocs.json | 4 +- api_docs/unified_search_autocomplete.mdx | 2 +- api_docs/url_forwarding.mdx | 2 +- api_docs/usage_collection.devdocs.json | 2 +- api_docs/usage_collection.mdx | 2 +- api_docs/ux.mdx | 2 +- api_docs/vis_default_editor.mdx | 2 +- api_docs/vis_type_gauge.mdx | 2 +- api_docs/vis_type_heatmap.mdx | 2 +- api_docs/vis_type_pie.mdx | 2 +- api_docs/vis_type_table.mdx | 2 +- api_docs/vis_type_timelion.mdx | 2 +- api_docs/vis_type_timeseries.mdx | 2 +- api_docs/vis_type_vega.mdx | 2 +- api_docs/vis_type_vislib.devdocs.json | 4 +- api_docs/vis_type_vislib.mdx | 2 +- api_docs/vis_type_xy.mdx | 2 +- api_docs/visualizations.devdocs.json | 157 +- api_docs/visualizations.mdx | 4 +- 290 files changed, 40231 insertions(+), 40293 deletions(-) create mode 100644 api_docs/kbn_config_mocks.devdocs.json create mode 100644 api_docs/kbn_config_mocks.mdx create mode 100644 api_docs/kbn_core_base_common.devdocs.json create mode 100644 api_docs/kbn_core_base_common.mdx create mode 100644 api_docs/kbn_core_injected_metadata_browser.devdocs.json create mode 100644 api_docs/kbn_core_injected_metadata_browser.mdx create mode 100644 api_docs/kbn_core_injected_metadata_browser_mocks.devdocs.json create mode 100644 api_docs/kbn_core_injected_metadata_browser_mocks.mdx delete mode 100644 api_docs/kbn_shared_ux_button_exit_full_screen.devdocs.json delete mode 100644 api_docs/kbn_shared_ux_button_exit_full_screen.mdx create mode 100644 api_docs/kbn_shared_ux_prompt_no_data_views.devdocs.json create mode 100644 api_docs/kbn_shared_ux_prompt_no_data_views.mdx create mode 100644 api_docs/kbn_utility_types_jest.devdocs.json create mode 100644 api_docs/kbn_utility_types_jest.mdx create mode 100644 api_docs/kubernetes_security.devdocs.json create mode 100644 api_docs/kubernetes_security.mdx diff --git a/api_docs/actions.devdocs.json b/api_docs/actions.devdocs.json index 3e37dacfedfa4f..fb97ae6ebb5c88 100644 --- a/api_docs/actions.devdocs.json +++ b/api_docs/actions.devdocs.json @@ -1593,7 +1593,7 @@ "label": "ActionParamsType", "description": [], "signature": [ - "{ readonly source?: string | undefined; readonly summary?: string | undefined; readonly group?: string | undefined; readonly component?: string | undefined; readonly timestamp?: string | undefined; readonly eventAction?: \"resolve\" | \"trigger\" | \"acknowledge\" | undefined; readonly dedupKey?: string | undefined; readonly severity?: \"error\" | \"warning\" | \"info\" | \"critical\" | undefined; readonly class?: string | undefined; }" + "{ readonly source?: string | undefined; readonly group?: string | undefined; readonly component?: string | undefined; readonly summary?: string | undefined; readonly timestamp?: string | undefined; readonly eventAction?: \"resolve\" | \"trigger\" | \"acknowledge\" | undefined; readonly dedupKey?: string | undefined; readonly severity?: \"error\" | \"warning\" | \"info\" | \"critical\" | undefined; readonly class?: string | undefined; }" ], "path": "x-pack/plugins/actions/server/builtin_action_types/pagerduty.ts", "deprecated": false, diff --git a/api_docs/actions.mdx b/api_docs/actions.mdx index 0d88e756cdf8d3..484ca5ef38f787 100644 --- a/api_docs/actions.mdx +++ b/api_docs/actions.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/actions title: "actions" image: https://source.unsplash.com/400x175/?github summary: API docs for the actions plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'actions'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/advanced_settings.mdx b/api_docs/advanced_settings.mdx index 6942f75a5adcc2..640315b0c0cbbc 100644 --- a/api_docs/advanced_settings.mdx +++ b/api_docs/advanced_settings.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/advancedSettings title: "advancedSettings" image: https://source.unsplash.com/400x175/?github summary: API docs for the advancedSettings plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'advancedSettings'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/aiops.mdx b/api_docs/aiops.mdx index 22dc2801aa158f..99032550c0fa1b 100644 --- a/api_docs/aiops.mdx +++ b/api_docs/aiops.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/aiops title: "aiops" image: https://source.unsplash.com/400x175/?github summary: API docs for the aiops plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'aiops'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/alerting.mdx b/api_docs/alerting.mdx index 99be27030552f1..e4697e9772f0e1 100644 --- a/api_docs/alerting.mdx +++ b/api_docs/alerting.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/alerting title: "alerting" image: https://source.unsplash.com/400x175/?github summary: API docs for the alerting plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'alerting'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/apm.devdocs.json b/api_docs/apm.devdocs.json index daff1b24dec991..769fa299602f56 100644 --- a/api_docs/apm.devdocs.json +++ b/api_docs/apm.devdocs.json @@ -62,7 +62,19 @@ "label": "ApmPluginSetup", "description": [], "signature": [ - "{}" + "{ locator: ", + { + "pluginId": "share", + "scope": "common", + "docId": "kibSharePluginApi", + "section": "def-common.LocatorPublic", + "text": "LocatorPublic" + }, + "<{ serviceName: undefined; } | ({ serviceName: string; } & { serviceOverviewTab?: \"metrics\" | \"errors\" | \"logs\" | \"traces\" | undefined; } & { query: { environment: \"ENVIRONMENT_NOT_DEFINED\" | \"ENVIRONMENT_ALL\" | ", + "Branded", + "; }; })>; }" ], "path": "x-pack/plugins/apm/public/plugin.ts", "deprecated": false, @@ -186,7 +198,7 @@ "APMPluginSetupDependencies", ") => { config$: ", "Observable", - "; autoCreateApmDataView: boolean; serviceMapEnabled: boolean; serviceMapFingerprintBucketSize: number; serviceMapTraceIdBucketSize: number; serviceMapFingerprintGlobalBucketSize: number; serviceMapTraceIdGlobalBucketSize: number; serviceMapMaxTracesPerRequest: number; ui: Readonly<{} & { enabled: boolean; transactionGroupBucketSize: number; maxTraceItems: number; }>; searchAggregatedTransactions: ", + "; autoCreateApmDataView: boolean; serviceMapEnabled: boolean; serviceMapFingerprintBucketSize: number; serviceMapTraceIdBucketSize: number; serviceMapFingerprintGlobalBucketSize: number; serviceMapTraceIdGlobalBucketSize: number; serviceMapMaxTracesPerRequest: number; ui: Readonly<{} & { enabled: boolean; transactionGroupBucketSize: number; maxTraceItems: number; }>; searchAggregatedTransactions: ", "SearchAggregatedTransactionSetting", "; telemetryCollectionEnabled: boolean; metricsInterval: number; profilingEnabled: boolean; agent: Readonly<{} & { migrations: Readonly<{} & { enabled: boolean; }>; }>; }>>; getApmIndices: () => Promise<", "ApmIndicesConfig", @@ -409,7 +421,7 @@ "label": "config", "description": [], "signature": [ - "{ readonly indices: Readonly<{} & { error: string; span: string; metric: string; transaction: string; sourcemap: string; onboarding: string; }>; readonly autoCreateApmDataView: boolean; readonly serviceMapEnabled: boolean; readonly serviceMapFingerprintBucketSize: number; readonly serviceMapTraceIdBucketSize: number; readonly serviceMapFingerprintGlobalBucketSize: number; readonly serviceMapTraceIdGlobalBucketSize: number; readonly serviceMapMaxTracesPerRequest: number; readonly ui: Readonly<{} & { enabled: boolean; transactionGroupBucketSize: number; maxTraceItems: number; }>; readonly searchAggregatedTransactions: ", + "{ readonly indices: Readonly<{} & { error: string; metric: string; span: string; transaction: string; sourcemap: string; onboarding: string; }>; readonly autoCreateApmDataView: boolean; readonly serviceMapEnabled: boolean; readonly serviceMapFingerprintBucketSize: number; readonly serviceMapTraceIdBucketSize: number; readonly serviceMapFingerprintGlobalBucketSize: number; readonly serviceMapTraceIdGlobalBucketSize: number; readonly serviceMapMaxTracesPerRequest: number; readonly ui: Readonly<{} & { enabled: boolean; transactionGroupBucketSize: number; maxTraceItems: number; }>; readonly searchAggregatedTransactions: ", "SearchAggregatedTransactionSetting", "; readonly telemetryCollectionEnabled: boolean; readonly metricsInterval: number; readonly profilingEnabled: boolean; readonly agent: Readonly<{} & { migrations: Readonly<{} & { enabled: boolean; }>; }>; }" ], @@ -778,7 +790,7 @@ "label": "APIEndpoint", "description": [], "signature": [ - "\"POST /internal/apm/data_view/static\" | \"GET /internal/apm/data_view/dynamic\" | \"GET /internal/apm/environments\" | \"GET /internal/apm/services/{serviceName}/errors/groups/main_statistics\" | \"GET /internal/apm/services/{serviceName}/errors/groups/detailed_statistics\" | \"GET /internal/apm/services/{serviceName}/errors/{groupId}\" | \"GET /internal/apm/services/{serviceName}/errors/distribution\" | \"POST /internal/apm/latency/overall_distribution\" | \"GET /internal/apm/services/{serviceName}/metrics/charts\" | \"GET /internal/apm/observability_overview\" | \"GET /internal/apm/observability_overview/has_data\" | \"GET /internal/apm/ux/client-metrics\" | \"GET /internal/apm/ux/page-load-distribution\" | \"GET /internal/apm/ux/page-load-distribution/breakdown\" | \"GET /internal/apm/ux/page-view-trends\" | \"GET /internal/apm/ux/visitor-breakdown\" | \"GET /internal/apm/ux/web-core-vitals\" | \"GET /internal/apm/ux/long-task-metrics\" | \"GET /internal/apm/ux/url-search\" | \"GET /internal/apm/ux/js-errors\" | \"GET /api/apm/observability_overview/has_rum_data\" | \"GET /internal/apm/service-map\" | \"GET /internal/apm/service-map/service/{serviceName}\" | \"GET /internal/apm/service-map/backend\" | \"GET /internal/apm/services/{serviceName}/serviceNodes\" | \"GET /internal/apm/services\" | \"GET /internal/apm/services/detailed_statistics\" | \"GET /internal/apm/services/{serviceName}/metadata/details\" | \"GET /internal/apm/services/{serviceName}/metadata/icons\" | \"GET /internal/apm/services/{serviceName}/agent\" | \"GET /internal/apm/services/{serviceName}/transaction_types\" | \"GET /internal/apm/services/{serviceName}/node/{serviceNodeName}/metadata\" | \"GET /api/apm/services/{serviceName}/annotation/search\" | \"POST /api/apm/services/{serviceName}/annotation\" | \"GET /internal/apm/services/{serviceName}/service_overview_instances/details/{serviceNodeName}\" | \"GET /internal/apm/services/{serviceName}/throughput\" | \"GET /internal/apm/services/{serviceName}/service_overview_instances/main_statistics\" | \"GET /internal/apm/services/{serviceName}/service_overview_instances/detailed_statistics\" | \"GET /internal/apm/services/{serviceName}/dependencies\" | \"GET /internal/apm/services/{serviceName}/dependencies/breakdown\" | \"GET /internal/apm/services/{serviceName}/profiling/timeline\" | \"GET /internal/apm/services/{serviceName}/profiling/statistics\" | \"GET /internal/apm/services/{serviceName}/infrastructure_attributes_for_logs\" | \"GET /internal/apm/services/{serviceName}/anomaly_charts\" | \"GET /internal/apm/sorted_and_filtered_services\" | \"GET /internal/apm/service-groups\" | \"GET /internal/apm/service-group\" | \"POST /internal/apm/service-group\" | \"DELETE /internal/apm/service-group\" | \"GET /internal/apm/service-group/services\" | \"GET /internal/apm/suggestions\" | \"GET /internal/apm/traces/{traceId}\" | \"GET /internal/apm/traces\" | \"GET /internal/apm/traces/{traceId}/root_transaction\" | \"GET /internal/apm/transactions/{transactionId}\" | \"GET /internal/apm/traces/find\" | \"GET /internal/apm/services/{serviceName}/transactions/groups/main_statistics\" | \"GET /internal/apm/services/{serviceName}/transactions/groups/detailed_statistics\" | \"GET /internal/apm/services/{serviceName}/transactions/charts/latency\" | \"GET /internal/apm/services/{serviceName}/transactions/traces/samples\" | \"GET /internal/apm/services/{serviceName}/transaction/charts/breakdown\" | \"GET /internal/apm/services/{serviceName}/transactions/charts/error_rate\" | \"GET /internal/apm/services/{serviceName}/transactions/charts/coldstart_rate\" | \"GET /internal/apm/services/{serviceName}/transactions/charts/coldstart_rate_by_transaction_name\" | \"GET /internal/apm/alerts/chart_preview/transaction_error_rate\" | \"GET /internal/apm/alerts/chart_preview/transaction_duration\" | \"GET /internal/apm/alerts/chart_preview/transaction_error_count\" | \"GET /api/apm/settings/agent-configuration\" | \"GET /api/apm/settings/agent-configuration/view\" | \"DELETE /api/apm/settings/agent-configuration\" | \"PUT /api/apm/settings/agent-configuration\" | \"POST /api/apm/settings/agent-configuration/search\" | \"GET /api/apm/settings/agent-configuration/environments\" | \"GET /api/apm/settings/agent-configuration/agent_name\" | \"GET /internal/apm/settings/anomaly-detection/jobs\" | \"POST /internal/apm/settings/anomaly-detection/jobs\" | \"GET /internal/apm/settings/anomaly-detection/environments\" | \"POST /internal/apm/settings/anomaly-detection/update_to_v3\" | \"GET /internal/apm/settings/apm-index-settings\" | \"GET /internal/apm/settings/apm-indices\" | \"POST /internal/apm/settings/apm-indices/save\" | \"GET /internal/apm/settings/custom_links/transaction\" | \"GET /internal/apm/settings/custom_links\" | \"POST /internal/apm/settings/custom_links\" | \"PUT /internal/apm/settings/custom_links/{id}\" | \"DELETE /internal/apm/settings/custom_links/{id}\" | \"GET /api/apm/sourcemaps\" | \"POST /api/apm/sourcemaps\" | \"DELETE /api/apm/sourcemaps/{id}\" | \"GET /internal/apm/fleet/has_apm_policies\" | \"GET /internal/apm/fleet/agents\" | \"POST /api/apm/fleet/apm_server_schema\" | \"GET /internal/apm/fleet/apm_server_schema/unsupported\" | \"GET /internal/apm/fleet/migration_check\" | \"POST /internal/apm/fleet/cloud_apm_package_policy\" | \"GET /internal/apm/backends/top_backends\" | \"GET /internal/apm/backends/upstream_services\" | \"GET /internal/apm/backends/metadata\" | \"GET /internal/apm/backends/charts/latency\" | \"GET /internal/apm/backends/charts/throughput\" | \"GET /internal/apm/backends/charts/error_rate\" | \"POST /internal/apm/correlations/p_values\" | \"GET /internal/apm/correlations/field_candidates\" | \"POST /internal/apm/correlations/field_stats\" | \"GET /internal/apm/correlations/field_value_stats\" | \"POST /internal/apm/correlations/field_value_pairs\" | \"POST /internal/apm/correlations/significant_correlations\" | \"GET /internal/apm/fallback_to_transactions\" | \"GET /internal/apm/has_data\" | \"GET /internal/apm/event_metadata/{processorEvent}/{id}\" | \"GET /internal/apm/agent_keys\" | \"GET /internal/apm/agent_keys/privileges\" | \"POST /internal/apm/api_key/invalidate\" | \"POST /api/apm/agent_keys\" | \"GET /internal/apm/traces/{traceId}/span_links/{spanId}/parents\" | \"GET /internal/apm/traces/{traceId}/span_links/{spanId}/children\" | \"GET /internal/apm/services/{serviceName}/infrastructure_attributes\" | \"GET /internal/apm/debug-telemetry\"" + "\"POST /internal/apm/data_view/static\" | \"GET /internal/apm/data_view/dynamic\" | \"GET /internal/apm/environments\" | \"GET /internal/apm/services/{serviceName}/errors/groups/main_statistics\" | \"GET /internal/apm/services/{serviceName}/errors/groups/detailed_statistics\" | \"GET /internal/apm/services/{serviceName}/errors/{groupId}\" | \"GET /internal/apm/services/{serviceName}/errors/distribution\" | \"POST /internal/apm/latency/overall_distribution\" | \"GET /internal/apm/services/{serviceName}/metrics/charts\" | \"GET /internal/apm/observability_overview\" | \"GET /internal/apm/observability_overview/has_data\" | \"GET /internal/apm/ux/client-metrics\" | \"GET /internal/apm/ux/page-load-distribution\" | \"GET /internal/apm/ux/page-load-distribution/breakdown\" | \"GET /internal/apm/ux/page-view-trends\" | \"GET /internal/apm/ux/visitor-breakdown\" | \"GET /internal/apm/ux/web-core-vitals\" | \"GET /internal/apm/ux/long-task-metrics\" | \"GET /api/apm/observability_overview/has_rum_data\" | \"GET /internal/apm/service-map\" | \"GET /internal/apm/service-map/service/{serviceName}\" | \"GET /internal/apm/service-map/backend\" | \"GET /internal/apm/services/{serviceName}/serviceNodes\" | \"GET /internal/apm/services\" | \"GET /internal/apm/services/detailed_statistics\" | \"GET /internal/apm/services/{serviceName}/metadata/details\" | \"GET /internal/apm/services/{serviceName}/metadata/icons\" | \"GET /internal/apm/services/{serviceName}/agent\" | \"GET /internal/apm/services/{serviceName}/transaction_types\" | \"GET /internal/apm/services/{serviceName}/node/{serviceNodeName}/metadata\" | \"GET /api/apm/services/{serviceName}/annotation/search\" | \"POST /api/apm/services/{serviceName}/annotation\" | \"GET /internal/apm/services/{serviceName}/service_overview_instances/details/{serviceNodeName}\" | \"GET /internal/apm/services/{serviceName}/throughput\" | \"GET /internal/apm/services/{serviceName}/service_overview_instances/main_statistics\" | \"GET /internal/apm/services/{serviceName}/service_overview_instances/detailed_statistics\" | \"GET /internal/apm/services/{serviceName}/dependencies\" | \"GET /internal/apm/services/{serviceName}/dependencies/breakdown\" | \"GET /internal/apm/services/{serviceName}/profiling/timeline\" | \"GET /internal/apm/services/{serviceName}/profiling/statistics\" | \"GET /internal/apm/services/{serviceName}/infrastructure_attributes_for_logs\" | \"GET /internal/apm/services/{serviceName}/anomaly_charts\" | \"GET /internal/apm/sorted_and_filtered_services\" | \"GET /internal/apm/service-groups\" | \"GET /internal/apm/service-group\" | \"POST /internal/apm/service-group\" | \"DELETE /internal/apm/service-group\" | \"GET /internal/apm/service-group/services\" | \"GET /internal/apm/suggestions\" | \"GET /internal/apm/traces/{traceId}\" | \"GET /internal/apm/traces\" | \"GET /internal/apm/traces/{traceId}/root_transaction\" | \"GET /internal/apm/transactions/{transactionId}\" | \"GET /internal/apm/traces/find\" | \"GET /internal/apm/services/{serviceName}/transactions/groups/main_statistics\" | \"GET /internal/apm/services/{serviceName}/transactions/groups/detailed_statistics\" | \"GET /internal/apm/services/{serviceName}/transactions/charts/latency\" | \"GET /internal/apm/services/{serviceName}/transactions/traces/samples\" | \"GET /internal/apm/services/{serviceName}/transaction/charts/breakdown\" | \"GET /internal/apm/services/{serviceName}/transactions/charts/error_rate\" | \"GET /internal/apm/services/{serviceName}/transactions/charts/coldstart_rate\" | \"GET /internal/apm/services/{serviceName}/transactions/charts/coldstart_rate_by_transaction_name\" | \"GET /internal/apm/alerts/chart_preview/transaction_error_rate\" | \"GET /internal/apm/alerts/chart_preview/transaction_duration\" | \"GET /internal/apm/alerts/chart_preview/transaction_error_count\" | \"GET /api/apm/settings/agent-configuration\" | \"GET /api/apm/settings/agent-configuration/view\" | \"DELETE /api/apm/settings/agent-configuration\" | \"PUT /api/apm/settings/agent-configuration\" | \"POST /api/apm/settings/agent-configuration/search\" | \"GET /api/apm/settings/agent-configuration/environments\" | \"GET /api/apm/settings/agent-configuration/agent_name\" | \"GET /internal/apm/settings/anomaly-detection/jobs\" | \"POST /internal/apm/settings/anomaly-detection/jobs\" | \"GET /internal/apm/settings/anomaly-detection/environments\" | \"POST /internal/apm/settings/anomaly-detection/update_to_v3\" | \"GET /internal/apm/settings/apm-index-settings\" | \"GET /internal/apm/settings/apm-indices\" | \"POST /internal/apm/settings/apm-indices/save\" | \"GET /internal/apm/settings/custom_links/transaction\" | \"GET /internal/apm/settings/custom_links\" | \"POST /internal/apm/settings/custom_links\" | \"PUT /internal/apm/settings/custom_links/{id}\" | \"DELETE /internal/apm/settings/custom_links/{id}\" | \"GET /api/apm/sourcemaps\" | \"POST /api/apm/sourcemaps\" | \"DELETE /api/apm/sourcemaps/{id}\" | \"GET /internal/apm/fleet/has_apm_policies\" | \"GET /internal/apm/fleet/agents\" | \"POST /api/apm/fleet/apm_server_schema\" | \"GET /internal/apm/fleet/apm_server_schema/unsupported\" | \"GET /internal/apm/fleet/migration_check\" | \"POST /internal/apm/fleet/cloud_apm_package_policy\" | \"GET /internal/apm/backends/top_backends\" | \"GET /internal/apm/backends/upstream_services\" | \"GET /internal/apm/backends/metadata\" | \"GET /internal/apm/backends/charts/latency\" | \"GET /internal/apm/backends/charts/throughput\" | \"GET /internal/apm/backends/charts/error_rate\" | \"POST /internal/apm/correlations/p_values\" | \"GET /internal/apm/correlations/field_candidates\" | \"POST /internal/apm/correlations/field_stats\" | \"GET /internal/apm/correlations/field_value_stats\" | \"POST /internal/apm/correlations/field_value_pairs\" | \"POST /internal/apm/correlations/significant_correlations\" | \"GET /internal/apm/fallback_to_transactions\" | \"GET /internal/apm/has_data\" | \"GET /internal/apm/event_metadata/{processorEvent}/{id}\" | \"GET /internal/apm/agent_keys\" | \"GET /internal/apm/agent_keys/privileges\" | \"POST /internal/apm/api_key/invalidate\" | \"POST /api/apm/agent_keys\" | \"GET /internal/apm/traces/{traceId}/span_links/{spanId}/parents\" | \"GET /internal/apm/traces/{traceId}/span_links/{spanId}/children\" | \"GET /internal/apm/services/{serviceName}/infrastructure_attributes\" | \"GET /internal/apm/debug-telemetry\"" ], "path": "x-pack/plugins/apm/server/routes/apm_routes/get_global_apm_server_route_repository.ts", "deprecated": false, @@ -806,7 +818,7 @@ "label": "APMConfig", "description": [], "signature": [ - "{ readonly indices: Readonly<{} & { error: string; span: string; metric: string; transaction: string; sourcemap: string; onboarding: string; }>; readonly autoCreateApmDataView: boolean; readonly serviceMapEnabled: boolean; readonly serviceMapFingerprintBucketSize: number; readonly serviceMapTraceIdBucketSize: number; readonly serviceMapFingerprintGlobalBucketSize: number; readonly serviceMapTraceIdGlobalBucketSize: number; readonly serviceMapMaxTracesPerRequest: number; readonly ui: Readonly<{} & { enabled: boolean; transactionGroupBucketSize: number; maxTraceItems: number; }>; readonly searchAggregatedTransactions: ", + "{ readonly indices: Readonly<{} & { error: string; metric: string; span: string; transaction: string; sourcemap: string; onboarding: string; }>; readonly autoCreateApmDataView: boolean; readonly serviceMapEnabled: boolean; readonly serviceMapFingerprintBucketSize: number; readonly serviceMapTraceIdBucketSize: number; readonly serviceMapFingerprintGlobalBucketSize: number; readonly serviceMapTraceIdGlobalBucketSize: number; readonly serviceMapMaxTracesPerRequest: number; readonly ui: Readonly<{} & { enabled: boolean; transactionGroupBucketSize: number; maxTraceItems: number; }>; readonly searchAggregatedTransactions: ", "SearchAggregatedTransactionSetting", "; readonly telemetryCollectionEnabled: boolean; readonly metricsInterval: number; readonly profilingEnabled: boolean; readonly agent: Readonly<{} & { migrations: Readonly<{} & { enabled: boolean; }>; }>; }" ], @@ -822,7 +834,7 @@ "label": "ApmIndicesConfigName", "description": [], "signature": [ - "\"error\" | \"span\" | \"metric\" | \"transaction\" | \"sourcemap\" | \"onboarding\"" + "\"error\" | \"metric\" | \"span\" | \"transaction\" | \"sourcemap\" | \"onboarding\"" ], "path": "x-pack/plugins/apm/server/index.ts", "deprecated": false, @@ -2178,7 +2190,7 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { apmIndexSettings: { configurationName: \"error\" | \"span\" | \"metric\" | \"transaction\" | \"sourcemap\" | \"onboarding\"; defaultValue: string; savedValue: string | undefined; }[]; }, ", + ", { apmIndexSettings: { configurationName: \"error\" | \"metric\" | \"span\" | \"transaction\" | \"sourcemap\" | \"onboarding\"; defaultValue: string; savedValue: string | undefined; }[]; }, ", "APMRouteCreateOptions", ">; \"POST /internal/apm/settings/anomaly-detection/update_to_v3\": ", "ServerRoute", @@ -3492,6 +3504,20 @@ "Type", "; }>, ", "TypeC", + "<{ environment: ", + "UnionC", + "<[", + "LiteralC", + "<\"ENVIRONMENT_NOT_DEFINED\">, ", + "LiteralC", + "<\"ENVIRONMENT_ALL\">, ", + "BrandC", + "<", + "StringC", + ", ", + "NonEmptyStringBrand", + ">]>; }>, ", + "TypeC", "<{ transactionType: ", "StringC", "; }>]>; }>, ", @@ -4588,74 +4614,6 @@ }, ", { indices: string; hasData: boolean; serviceName: string | number | undefined; }, ", "APMRouteCreateOptions", - ">; \"GET /internal/apm/ux/js-errors\": ", - "ServerRoute", - "<\"GET /internal/apm/ux/js-errors\", ", - "TypeC", - "<{ query: ", - "IntersectionC", - "<[", - "TypeC", - "<{ uiFilters: ", - "StringC", - "; }>, ", - "TypeC", - "<{ start: ", - "Type", - "; end: ", - "Type", - "; }>, ", - "TypeC", - "<{ pageSize: ", - "StringC", - "; pageIndex: ", - "StringC", - "; }>, ", - "PartialC", - "<{ urlQuery: ", - "StringC", - "; }>]>; }>, ", - { - "pluginId": "apm", - "scope": "server", - "docId": "kibApmPluginApi", - "section": "def-server.APMRouteHandlerResources", - "text": "APMRouteHandlerResources" - }, - ", { totalErrorPages: number; totalErrors: number; totalErrorGroups: number; items: { count: number; errorGroupId: string | number; errorMessage: string; }[] | undefined; }, ", - "APMRouteCreateOptions", - ">; \"GET /internal/apm/ux/url-search\": ", - "ServerRoute", - "<\"GET /internal/apm/ux/url-search\", ", - "TypeC", - "<{ query: ", - "IntersectionC", - "<[", - "TypeC", - "<{ uiFilters: ", - "StringC", - "; }>, ", - "TypeC", - "<{ start: ", - "Type", - "; end: ", - "Type", - "; }>, ", - "PartialC", - "<{ urlQuery: ", - "StringC", - "; percentile: ", - "StringC", - "; }>]>; }>, ", - { - "pluginId": "apm", - "scope": "server", - "docId": "kibApmPluginApi", - "section": "def-server.APMRouteHandlerResources", - "text": "APMRouteHandlerResources" - }, - ", { total: number; items: { url: string; count: number; pld: number; }[]; }, ", - "APMRouteCreateOptions", ">; \"GET /internal/apm/ux/long-task-metrics\": ", "ServerRoute", "<\"GET /internal/apm/ux/long-task-metrics\", ", @@ -5310,11 +5268,11 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { environments: (", + ", { environments: (\"ENVIRONMENT_NOT_DEFINED\" | \"ENVIRONMENT_ALL\" | ", "Branded", " | \"ENVIRONMENT_NOT_DEFINED\" | \"ENVIRONMENT_ALL\")[]; }, ", + ">)[]; }, ", "APMRouteCreateOptions", ">; \"GET /internal/apm/data_view/dynamic\": ", "ServerRoute", @@ -5369,7 +5327,7 @@ "description": [], "signature": [ "Observable", - "; autoCreateApmDataView: boolean; serviceMapEnabled: boolean; serviceMapFingerprintBucketSize: number; serviceMapTraceIdBucketSize: number; serviceMapFingerprintGlobalBucketSize: number; serviceMapTraceIdGlobalBucketSize: number; serviceMapMaxTracesPerRequest: number; ui: Readonly<{} & { enabled: boolean; transactionGroupBucketSize: number; maxTraceItems: number; }>; searchAggregatedTransactions: ", + "; autoCreateApmDataView: boolean; serviceMapEnabled: boolean; serviceMapFingerprintBucketSize: number; serviceMapTraceIdBucketSize: number; serviceMapFingerprintGlobalBucketSize: number; serviceMapTraceIdGlobalBucketSize: number; serviceMapMaxTracesPerRequest: number; ui: Readonly<{} & { enabled: boolean; transactionGroupBucketSize: number; maxTraceItems: number; }>; searchAggregatedTransactions: ", "SearchAggregatedTransactionSetting", "; telemetryCollectionEnabled: boolean; metricsInterval: number; profilingEnabled: boolean; agent: Readonly<{} & { migrations: Readonly<{} & { enabled: boolean; }>; }>; }>>" ], diff --git a/api_docs/apm.mdx b/api_docs/apm.mdx index 33036bb8bee67a..08462f6575a3f5 100644 --- a/api_docs/apm.mdx +++ b/api_docs/apm.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/apm title: "apm" image: https://source.unsplash.com/400x175/?github summary: API docs for the apm plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apm'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/banners.mdx b/api_docs/banners.mdx index ab3323315c0527..6567d989990b96 100644 --- a/api_docs/banners.mdx +++ b/api_docs/banners.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/banners title: "banners" image: https://source.unsplash.com/400x175/?github summary: API docs for the banners plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'banners'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/bfetch.mdx b/api_docs/bfetch.mdx index 697fcd47eefea2..fad50d98ea4cfe 100644 --- a/api_docs/bfetch.mdx +++ b/api_docs/bfetch.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/bfetch title: "bfetch" image: https://source.unsplash.com/400x175/?github summary: API docs for the bfetch plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'bfetch'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/canvas.mdx b/api_docs/canvas.mdx index d2990dfb31fd08..7d46b77d3f87f8 100644 --- a/api_docs/canvas.mdx +++ b/api_docs/canvas.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/canvas title: "canvas" image: https://source.unsplash.com/400x175/?github summary: API docs for the canvas plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'canvas'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/cases.mdx b/api_docs/cases.mdx index 948048051b2161..5905d564615eb4 100644 --- a/api_docs/cases.mdx +++ b/api_docs/cases.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/cases title: "cases" image: https://source.unsplash.com/400x175/?github summary: API docs for the cases plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cases'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/charts.mdx b/api_docs/charts.mdx index d89dbf0e171154..01f93d266c9d3c 100644 --- a/api_docs/charts.mdx +++ b/api_docs/charts.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/charts title: "charts" image: https://source.unsplash.com/400x175/?github summary: API docs for the charts plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'charts'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/cloud.mdx b/api_docs/cloud.mdx index b85c6af643fb91..7a9cdf1c80ce41 100644 --- a/api_docs/cloud.mdx +++ b/api_docs/cloud.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/cloud title: "cloud" image: https://source.unsplash.com/400x175/?github summary: API docs for the cloud plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloud'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/cloud_security_posture.mdx b/api_docs/cloud_security_posture.mdx index 370fd13f607654..2c7279b45dc384 100644 --- a/api_docs/cloud_security_posture.mdx +++ b/api_docs/cloud_security_posture.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/cloudSecurityPosture title: "cloudSecurityPosture" image: https://source.unsplash.com/400x175/?github summary: API docs for the cloudSecurityPosture plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudSecurityPosture'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/console.mdx b/api_docs/console.mdx index 18e4ad056b1c11..e46ea4ef176247 100644 --- a/api_docs/console.mdx +++ b/api_docs/console.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/console title: "console" image: https://source.unsplash.com/400x175/?github summary: API docs for the console plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'console'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/controls.devdocs.json b/api_docs/controls.devdocs.json index 0901e5fd0cb858..2e20885112df4a 100644 --- a/api_docs/controls.devdocs.json +++ b/api_docs/controls.devdocs.json @@ -3397,13 +3397,7 @@ " | undefined; filters?: ", "Filter", "[] | undefined; timeRange?: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, + "TimeRange", " | undefined; controlStyle?: ", "ControlStyle", " | undefined; ignoreParentSettings?: ", @@ -4339,7 +4333,9 @@ "type": "Type", "tags": [], "label": "PersistableControlGroupInput", - "description": [], + "description": [ + "\nOnly parts of the Control Group Input should be persisted" + ], "signature": [ "{ controlStyle: ", "ControlStyle", @@ -4397,6 +4393,44 @@ "deprecated": false, "initialIsOpen": false }, + { + "parentPluginId": "controls", + "id": "def-common.SerializableControlGroupInput", + "type": "Type", + "tags": [], + "label": "SerializableControlGroupInput", + "description": [ + "\nSome use cases need the Persistable Control Group Input to conform to the SerializableRecord format which requires string index signatures in any objects" + ], + "signature": [ + "Omit<", + { + "pluginId": "controls", + "scope": "common", + "docId": "kibControlsPluginApi", + "section": "def-common.PersistableControlGroupInput", + "text": "PersistableControlGroupInput" + }, + ", \"ignoreParentSettings\" | \"panels\"> & { panels: ", + { + "pluginId": "controls", + "scope": "common", + "docId": "kibControlsPluginApi", + "section": "def-common.ControlsPanels", + "text": "ControlsPanels" + }, + " & ", + "SerializableRecord", + "; ignoreParentSettings: ", + "ParentIgnoreSettings", + " & ", + "SerializableRecord", + "; }" + ], + "path": "src/plugins/controls/common/control_group/types.ts", + "deprecated": false, + "initialIsOpen": false + }, { "parentPluginId": "controls", "id": "def-common.TIME_SLIDER_CONTROL", diff --git a/api_docs/controls.mdx b/api_docs/controls.mdx index 8f83075baf5841..da4438ea94928a 100644 --- a/api_docs/controls.mdx +++ b/api_docs/controls.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/controls title: "controls" image: https://source.unsplash.com/400x175/?github summary: API docs for the controls plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'controls'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-prese | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 205 | 0 | 199 | 7 | +| 206 | 0 | 198 | 7 | ## Client diff --git a/api_docs/core.devdocs.json b/api_docs/core.devdocs.json index 97dd65c8d16c3f..bc5653e038e0fb 100644 --- a/api_docs/core.devdocs.json +++ b/api_docs/core.devdocs.json @@ -651,6 +651,9 @@ "description": [ "\r\nAnalytics client's public APIs" ], + "signature": [ + "AnalyticsClient" + ], "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "children": [ @@ -1366,20 +1369,16 @@ "parentPluginId": "core", "id": "def-public.CoreSetup.injectedMetadata", "type": "Object", - "tags": [ - "deprecated" - ], + "tags": [], "label": "injectedMetadata", "description": [ - "\nexposed temporarily until https://github.com/elastic/kibana/issues/41990 done\nuse *only* to retrieve config values. There is no way to set injected values\nin the new platform." + "{@link InjectedMetadataSetup}" ], "signature": [ - "{ getInjectedVar: (name: string, defaultValue?: any) => unknown; }" + "InjectedMetadataSetup" ], "path": "src/core/public/index.ts", - "deprecated": true, - "removeBy": "8.8.0", - "references": [] + "deprecated": false }, { "parentPluginId": "core", @@ -1740,25 +1739,16 @@ "parentPluginId": "core", "id": "def-public.CoreStart.injectedMetadata", "type": "Object", - "tags": [ - "deprecated" - ], + "tags": [], "label": "injectedMetadata", "description": [ - "\nexposed temporarily until https://github.com/elastic/kibana/issues/41990 done\nuse *only* to retrieve config values. There is no way to set injected values\nin the new platform." + "{@link InjectedMetadataStart}" ], "signature": [ - "{ getInjectedVar: (name: string, defaultValue?: any) => unknown; }" + "InjectedMetadataStart" ], "path": "src/core/public/index.ts", - "deprecated": true, - "removeBy": "8.8.0", - "references": [ - { - "plugin": "monitoring", - "path": "x-pack/plugins/monitoring/public/legacy_shims.ts" - } - ] + "deprecated": false } ], "initialIsOpen": false @@ -1987,6 +1977,9 @@ "tags": [], "label": "EnvironmentMode", "description": [], + "signature": [ + "EnvironmentMode" + ], "path": "node_modules/@types/kbn__config/index.d.ts", "deprecated": false, "children": [ @@ -2166,6 +2159,9 @@ "description": [ "\r\nDefinition of the context that can be appended to the events through the {@link IAnalyticsClient.registerContextProvider}." ], + "signature": [ + "EventContext" + ], "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "children": [ @@ -2244,6 +2240,21 @@ "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false }, + { + "parentPluginId": "core", + "id": "def-public.EventContext.isElasticCloudUser", + "type": "CompoundType", + "tags": [], + "label": "isElasticCloudUser", + "description": [ + "\r\n`true` if the user is logged in via the Elastic Cloud authentication provider." + ], + "signature": [ + "boolean | undefined" + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false + }, { "parentPluginId": "core", "id": "def-public.EventContext.version", @@ -2780,6 +2791,9 @@ "description": [ "\r\nBasic structure of a Shipper" ], + "signature": [ + "IShipper" + ], "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "children": [ @@ -3659,6 +3673,9 @@ "description": [ "\r\n" ], + "signature": [ + "OptInConfig" + ], "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "children": [ @@ -4945,6 +4962,9 @@ "tags": [], "label": "PackageInfo", "description": [], + "signature": [ + "PackageInfo" + ], "path": "node_modules/@types/kbn__config/index.d.ts", "deprecated": false, "children": [ @@ -5729,51 +5749,6 @@ ], "initialIsOpen": false }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsBulkResolveResponse", - "type": "Interface", - "tags": [], - "label": "SavedObjectsBulkResolveResponse", - "description": [ - "\n" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkResolveResponse", - "text": "SavedObjectsBulkResolveResponse" - }, - "" - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsBulkResolveResponse.resolved_objects", - "type": "Array", - "tags": [], - "label": "resolved_objects", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsResolveResponse", - "text": "SavedObjectsResolveResponse" - }, - "[]" - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, { "parentPluginId": "core", "id": "def-public.SavedObjectsCollectMultiNamespaceReferencesResponse", @@ -7080,6 +7055,9 @@ "description": [ "\r\nShape of the events emitted by the telemetryCounter$ observable" ], + "signature": [ + "TelemetryCounter" + ], "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "children": [ @@ -7585,6 +7563,9 @@ "description": [ "\r\nTypes of the Telemetry Counter: It allows to differentiate what happened to the events" ], + "signature": [ + "TelemetryCounterType" + ], "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "initialIsOpen": false @@ -8007,7 +7988,7 @@ "signature": [ "symbol" ], - "path": "src/core/server/plugins/types.ts", + "path": "node_modules/@types/kbn__core-base-common/index.d.ts", "deprecated": false, "initialIsOpen": false }, @@ -8164,7 +8145,7 @@ "signature": [ "Pick<", "Toast", - ", \"children\" | \"color\" | \"className\" | \"onChange\" | \"onKeyDown\" | \"onClick\" | \"security\" | \"defaultValue\" | \"hidden\" | \"defaultChecked\" | \"suppressContentEditableWarning\" | \"suppressHydrationWarning\" | \"accessKey\" | \"contentEditable\" | \"contextMenu\" | \"dir\" | \"draggable\" | \"lang\" | \"placeholder\" | \"slot\" | \"spellCheck\" | \"style\" | \"tabIndex\" | \"translate\" | \"radioGroup\" | \"role\" | \"about\" | \"datatype\" | \"inlist\" | \"prefix\" | \"property\" | \"resource\" | \"typeof\" | \"vocab\" | \"autoCapitalize\" | \"autoCorrect\" | \"autoSave\" | \"itemProp\" | \"itemScope\" | \"itemType\" | \"itemID\" | \"itemRef\" | \"results\" | \"unselectable\" | \"inputMode\" | \"is\" | \"aria-activedescendant\" | \"aria-atomic\" | \"aria-autocomplete\" | \"aria-busy\" | \"aria-checked\" | \"aria-colcount\" | \"aria-colindex\" | \"aria-colspan\" | \"aria-controls\" | \"aria-current\" | \"aria-describedby\" | \"aria-details\" | \"aria-disabled\" | \"aria-dropeffect\" | \"aria-errormessage\" | \"aria-expanded\" | \"aria-flowto\" | \"aria-grabbed\" | \"aria-haspopup\" | \"aria-hidden\" | \"aria-invalid\" | \"aria-keyshortcuts\" | \"aria-label\" | \"aria-labelledby\" | \"aria-level\" | \"aria-live\" | \"aria-modal\" | \"aria-multiline\" | \"aria-multiselectable\" | \"aria-orientation\" | \"aria-owns\" | \"aria-placeholder\" | \"aria-posinset\" | \"aria-pressed\" | \"aria-readonly\" | \"aria-relevant\" | \"aria-required\" | \"aria-roledescription\" | \"aria-rowcount\" | \"aria-rowindex\" | \"aria-rowspan\" | \"aria-selected\" | \"aria-setsize\" | \"aria-sort\" | \"aria-valuemax\" | \"aria-valuemin\" | \"aria-valuenow\" | \"aria-valuetext\" | \"dangerouslySetInnerHTML\" | \"onCopy\" | \"onCopyCapture\" | \"onCut\" | \"onCutCapture\" | \"onPaste\" | \"onPasteCapture\" | \"onCompositionEnd\" | \"onCompositionEndCapture\" | \"onCompositionStart\" | \"onCompositionStartCapture\" | \"onCompositionUpdate\" | \"onCompositionUpdateCapture\" | \"onFocus\" | \"onFocusCapture\" | \"onBlur\" | \"onBlurCapture\" | \"onChangeCapture\" | \"onBeforeInput\" | \"onBeforeInputCapture\" | \"onInput\" | \"onInputCapture\" | \"onReset\" | \"onResetCapture\" | \"onSubmit\" | \"onSubmitCapture\" | \"onInvalid\" | \"onInvalidCapture\" | \"onLoad\" | \"onLoadCapture\" | \"onError\" | \"onErrorCapture\" | \"onKeyDownCapture\" | \"onKeyPress\" | \"onKeyPressCapture\" | \"onKeyUp\" | \"onKeyUpCapture\" | \"onAbort\" | \"onAbortCapture\" | \"onCanPlay\" | \"onCanPlayCapture\" | \"onCanPlayThrough\" | \"onCanPlayThroughCapture\" | \"onDurationChange\" | \"onDurationChangeCapture\" | \"onEmptied\" | \"onEmptiedCapture\" | \"onEncrypted\" | \"onEncryptedCapture\" | \"onEnded\" | \"onEndedCapture\" | \"onLoadedData\" | \"onLoadedDataCapture\" | \"onLoadedMetadata\" | \"onLoadedMetadataCapture\" | \"onLoadStart\" | \"onLoadStartCapture\" | \"onPause\" | \"onPauseCapture\" | \"onPlay\" | \"onPlayCapture\" | \"onPlaying\" | \"onPlayingCapture\" | \"onProgress\" | \"onProgressCapture\" | \"onRateChange\" | \"onRateChangeCapture\" | \"onSeeked\" | \"onSeekedCapture\" | \"onSeeking\" | \"onSeekingCapture\" | \"onStalled\" | \"onStalledCapture\" | \"onSuspend\" | \"onSuspendCapture\" | \"onTimeUpdate\" | \"onTimeUpdateCapture\" | \"onVolumeChange\" | \"onVolumeChangeCapture\" | \"onWaiting\" | \"onWaitingCapture\" | \"onAuxClick\" | \"onAuxClickCapture\" | \"onClickCapture\" | \"onContextMenu\" | \"onContextMenuCapture\" | \"onDoubleClick\" | \"onDoubleClickCapture\" | \"onDrag\" | \"onDragCapture\" | \"onDragEnd\" | \"onDragEndCapture\" | \"onDragEnter\" | \"onDragEnterCapture\" | \"onDragExit\" | \"onDragExitCapture\" | \"onDragLeave\" | \"onDragLeaveCapture\" | \"onDragOver\" | \"onDragOverCapture\" | \"onDragStart\" | \"onDragStartCapture\" | \"onDrop\" | \"onDropCapture\" | \"onMouseDown\" | \"onMouseDownCapture\" | \"onMouseEnter\" | \"onMouseLeave\" | \"onMouseMove\" | \"onMouseMoveCapture\" | \"onMouseOut\" | \"onMouseOutCapture\" | \"onMouseOver\" | \"onMouseOverCapture\" | \"onMouseUp\" | \"onMouseUpCapture\" | \"onSelect\" | \"onSelectCapture\" | \"onTouchCancel\" | \"onTouchCancelCapture\" | \"onTouchEnd\" | \"onTouchEndCapture\" | \"onTouchMove\" | \"onTouchMoveCapture\" | \"onTouchStart\" | \"onTouchStartCapture\" | \"onPointerDown\" | \"onPointerDownCapture\" | \"onPointerMove\" | \"onPointerMoveCapture\" | \"onPointerUp\" | \"onPointerUpCapture\" | \"onPointerCancel\" | \"onPointerCancelCapture\" | \"onPointerEnter\" | \"onPointerEnterCapture\" | \"onPointerLeave\" | \"onPointerLeaveCapture\" | \"onPointerOver\" | \"onPointerOverCapture\" | \"onPointerOut\" | \"onPointerOutCapture\" | \"onGotPointerCapture\" | \"onGotPointerCaptureCapture\" | \"onLostPointerCapture\" | \"onLostPointerCaptureCapture\" | \"onScroll\" | \"onScrollCapture\" | \"onWheel\" | \"onWheelCapture\" | \"onAnimationStart\" | \"onAnimationStartCapture\" | \"onAnimationEnd\" | \"onAnimationEndCapture\" | \"onAnimationIteration\" | \"onAnimationIterationCapture\" | \"onTransitionEnd\" | \"onTransitionEndCapture\" | \"toastLifeTimeMs\" | \"iconType\" | \"onClose\" | \"data-test-subj\"> & { title?: string | ", + ", \"children\" | \"color\" | \"className\" | \"onChange\" | \"onKeyDown\" | \"onClick\" | \"security\" | \"defaultValue\" | \"hidden\" | \"lang\" | \"onError\" | \"defaultChecked\" | \"suppressContentEditableWarning\" | \"suppressHydrationWarning\" | \"accessKey\" | \"contentEditable\" | \"contextMenu\" | \"dir\" | \"draggable\" | \"placeholder\" | \"slot\" | \"spellCheck\" | \"style\" | \"tabIndex\" | \"translate\" | \"radioGroup\" | \"role\" | \"about\" | \"datatype\" | \"inlist\" | \"prefix\" | \"property\" | \"resource\" | \"typeof\" | \"vocab\" | \"autoCapitalize\" | \"autoCorrect\" | \"autoSave\" | \"itemProp\" | \"itemScope\" | \"itemType\" | \"itemID\" | \"itemRef\" | \"results\" | \"unselectable\" | \"inputMode\" | \"is\" | \"aria-activedescendant\" | \"aria-atomic\" | \"aria-autocomplete\" | \"aria-busy\" | \"aria-checked\" | \"aria-colcount\" | \"aria-colindex\" | \"aria-colspan\" | \"aria-controls\" | \"aria-current\" | \"aria-describedby\" | \"aria-details\" | \"aria-disabled\" | \"aria-dropeffect\" | \"aria-errormessage\" | \"aria-expanded\" | \"aria-flowto\" | \"aria-grabbed\" | \"aria-haspopup\" | \"aria-hidden\" | \"aria-invalid\" | \"aria-keyshortcuts\" | \"aria-label\" | \"aria-labelledby\" | \"aria-level\" | \"aria-live\" | \"aria-modal\" | \"aria-multiline\" | \"aria-multiselectable\" | \"aria-orientation\" | \"aria-owns\" | \"aria-placeholder\" | \"aria-posinset\" | \"aria-pressed\" | \"aria-readonly\" | \"aria-relevant\" | \"aria-required\" | \"aria-roledescription\" | \"aria-rowcount\" | \"aria-rowindex\" | \"aria-rowspan\" | \"aria-selected\" | \"aria-setsize\" | \"aria-sort\" | \"aria-valuemax\" | \"aria-valuemin\" | \"aria-valuenow\" | \"aria-valuetext\" | \"dangerouslySetInnerHTML\" | \"onCopy\" | \"onCopyCapture\" | \"onCut\" | \"onCutCapture\" | \"onPaste\" | \"onPasteCapture\" | \"onCompositionEnd\" | \"onCompositionEndCapture\" | \"onCompositionStart\" | \"onCompositionStartCapture\" | \"onCompositionUpdate\" | \"onCompositionUpdateCapture\" | \"onFocus\" | \"onFocusCapture\" | \"onBlur\" | \"onBlurCapture\" | \"onChangeCapture\" | \"onBeforeInput\" | \"onBeforeInputCapture\" | \"onInput\" | \"onInputCapture\" | \"onReset\" | \"onResetCapture\" | \"onSubmit\" | \"onSubmitCapture\" | \"onInvalid\" | \"onInvalidCapture\" | \"onLoad\" | \"onLoadCapture\" | \"onErrorCapture\" | \"onKeyDownCapture\" | \"onKeyPress\" | \"onKeyPressCapture\" | \"onKeyUp\" | \"onKeyUpCapture\" | \"onAbort\" | \"onAbortCapture\" | \"onCanPlay\" | \"onCanPlayCapture\" | \"onCanPlayThrough\" | \"onCanPlayThroughCapture\" | \"onDurationChange\" | \"onDurationChangeCapture\" | \"onEmptied\" | \"onEmptiedCapture\" | \"onEncrypted\" | \"onEncryptedCapture\" | \"onEnded\" | \"onEndedCapture\" | \"onLoadedData\" | \"onLoadedDataCapture\" | \"onLoadedMetadata\" | \"onLoadedMetadataCapture\" | \"onLoadStart\" | \"onLoadStartCapture\" | \"onPause\" | \"onPauseCapture\" | \"onPlay\" | \"onPlayCapture\" | \"onPlaying\" | \"onPlayingCapture\" | \"onProgress\" | \"onProgressCapture\" | \"onRateChange\" | \"onRateChangeCapture\" | \"onSeeked\" | \"onSeekedCapture\" | \"onSeeking\" | \"onSeekingCapture\" | \"onStalled\" | \"onStalledCapture\" | \"onSuspend\" | \"onSuspendCapture\" | \"onTimeUpdate\" | \"onTimeUpdateCapture\" | \"onVolumeChange\" | \"onVolumeChangeCapture\" | \"onWaiting\" | \"onWaitingCapture\" | \"onAuxClick\" | \"onAuxClickCapture\" | \"onClickCapture\" | \"onContextMenu\" | \"onContextMenuCapture\" | \"onDoubleClick\" | \"onDoubleClickCapture\" | \"onDrag\" | \"onDragCapture\" | \"onDragEnd\" | \"onDragEndCapture\" | \"onDragEnter\" | \"onDragEnterCapture\" | \"onDragExit\" | \"onDragExitCapture\" | \"onDragLeave\" | \"onDragLeaveCapture\" | \"onDragOver\" | \"onDragOverCapture\" | \"onDragStart\" | \"onDragStartCapture\" | \"onDrop\" | \"onDropCapture\" | \"onMouseDown\" | \"onMouseDownCapture\" | \"onMouseEnter\" | \"onMouseLeave\" | \"onMouseMove\" | \"onMouseMoveCapture\" | \"onMouseOut\" | \"onMouseOutCapture\" | \"onMouseOver\" | \"onMouseOverCapture\" | \"onMouseUp\" | \"onMouseUpCapture\" | \"onSelect\" | \"onSelectCapture\" | \"onTouchCancel\" | \"onTouchCancelCapture\" | \"onTouchEnd\" | \"onTouchEndCapture\" | \"onTouchMove\" | \"onTouchMoveCapture\" | \"onTouchStart\" | \"onTouchStartCapture\" | \"onPointerDown\" | \"onPointerDownCapture\" | \"onPointerMove\" | \"onPointerMoveCapture\" | \"onPointerUp\" | \"onPointerUpCapture\" | \"onPointerCancel\" | \"onPointerCancelCapture\" | \"onPointerEnter\" | \"onPointerEnterCapture\" | \"onPointerLeave\" | \"onPointerLeaveCapture\" | \"onPointerOver\" | \"onPointerOverCapture\" | \"onPointerOut\" | \"onPointerOutCapture\" | \"onGotPointerCapture\" | \"onGotPointerCaptureCapture\" | \"onLostPointerCapture\" | \"onLostPointerCaptureCapture\" | \"onScroll\" | \"onScrollCapture\" | \"onWheel\" | \"onWheelCapture\" | \"onAnimationStart\" | \"onAnimationStartCapture\" | \"onAnimationEnd\" | \"onAnimationEndCapture\" | \"onAnimationIteration\" | \"onAnimationIterationCapture\" | \"onTransitionEnd\" | \"onTransitionEndCapture\" | \"toastLifeTimeMs\" | \"iconType\" | \"onClose\" | \"data-test-subj\"> & { title?: string | ", { "pluginId": "core", "scope": "public", @@ -8221,7 +8202,7 @@ "signature": [ "Pick<", "Toast", - ", \"children\" | \"color\" | \"className\" | \"onChange\" | \"onKeyDown\" | \"onClick\" | \"security\" | \"defaultValue\" | \"hidden\" | \"defaultChecked\" | \"suppressContentEditableWarning\" | \"suppressHydrationWarning\" | \"accessKey\" | \"contentEditable\" | \"contextMenu\" | \"dir\" | \"draggable\" | \"lang\" | \"placeholder\" | \"slot\" | \"spellCheck\" | \"style\" | \"tabIndex\" | \"translate\" | \"radioGroup\" | \"role\" | \"about\" | \"datatype\" | \"inlist\" | \"prefix\" | \"property\" | \"resource\" | \"typeof\" | \"vocab\" | \"autoCapitalize\" | \"autoCorrect\" | \"autoSave\" | \"itemProp\" | \"itemScope\" | \"itemType\" | \"itemID\" | \"itemRef\" | \"results\" | \"unselectable\" | \"inputMode\" | \"is\" | \"aria-activedescendant\" | \"aria-atomic\" | \"aria-autocomplete\" | \"aria-busy\" | \"aria-checked\" | \"aria-colcount\" | \"aria-colindex\" | \"aria-colspan\" | \"aria-controls\" | \"aria-current\" | \"aria-describedby\" | \"aria-details\" | \"aria-disabled\" | \"aria-dropeffect\" | \"aria-errormessage\" | \"aria-expanded\" | \"aria-flowto\" | \"aria-grabbed\" | \"aria-haspopup\" | \"aria-hidden\" | \"aria-invalid\" | \"aria-keyshortcuts\" | \"aria-label\" | \"aria-labelledby\" | \"aria-level\" | \"aria-live\" | \"aria-modal\" | \"aria-multiline\" | \"aria-multiselectable\" | \"aria-orientation\" | \"aria-owns\" | \"aria-placeholder\" | \"aria-posinset\" | \"aria-pressed\" | \"aria-readonly\" | \"aria-relevant\" | \"aria-required\" | \"aria-roledescription\" | \"aria-rowcount\" | \"aria-rowindex\" | \"aria-rowspan\" | \"aria-selected\" | \"aria-setsize\" | \"aria-sort\" | \"aria-valuemax\" | \"aria-valuemin\" | \"aria-valuenow\" | \"aria-valuetext\" | \"dangerouslySetInnerHTML\" | \"onCopy\" | \"onCopyCapture\" | \"onCut\" | \"onCutCapture\" | \"onPaste\" | \"onPasteCapture\" | \"onCompositionEnd\" | \"onCompositionEndCapture\" | \"onCompositionStart\" | \"onCompositionStartCapture\" | \"onCompositionUpdate\" | \"onCompositionUpdateCapture\" | \"onFocus\" | \"onFocusCapture\" | \"onBlur\" | \"onBlurCapture\" | \"onChangeCapture\" | \"onBeforeInput\" | \"onBeforeInputCapture\" | \"onInput\" | \"onInputCapture\" | \"onReset\" | \"onResetCapture\" | \"onSubmit\" | \"onSubmitCapture\" | \"onInvalid\" | \"onInvalidCapture\" | \"onLoad\" | \"onLoadCapture\" | \"onError\" | \"onErrorCapture\" | \"onKeyDownCapture\" | \"onKeyPress\" | \"onKeyPressCapture\" | \"onKeyUp\" | \"onKeyUpCapture\" | \"onAbort\" | \"onAbortCapture\" | \"onCanPlay\" | \"onCanPlayCapture\" | \"onCanPlayThrough\" | \"onCanPlayThroughCapture\" | \"onDurationChange\" | \"onDurationChangeCapture\" | \"onEmptied\" | \"onEmptiedCapture\" | \"onEncrypted\" | \"onEncryptedCapture\" | \"onEnded\" | \"onEndedCapture\" | \"onLoadedData\" | \"onLoadedDataCapture\" | \"onLoadedMetadata\" | \"onLoadedMetadataCapture\" | \"onLoadStart\" | \"onLoadStartCapture\" | \"onPause\" | \"onPauseCapture\" | \"onPlay\" | \"onPlayCapture\" | \"onPlaying\" | \"onPlayingCapture\" | \"onProgress\" | \"onProgressCapture\" | \"onRateChange\" | \"onRateChangeCapture\" | \"onSeeked\" | \"onSeekedCapture\" | \"onSeeking\" | \"onSeekingCapture\" | \"onStalled\" | \"onStalledCapture\" | \"onSuspend\" | \"onSuspendCapture\" | \"onTimeUpdate\" | \"onTimeUpdateCapture\" | \"onVolumeChange\" | \"onVolumeChangeCapture\" | \"onWaiting\" | \"onWaitingCapture\" | \"onAuxClick\" | \"onAuxClickCapture\" | \"onClickCapture\" | \"onContextMenu\" | \"onContextMenuCapture\" | \"onDoubleClick\" | \"onDoubleClickCapture\" | \"onDrag\" | \"onDragCapture\" | \"onDragEnd\" | \"onDragEndCapture\" | \"onDragEnter\" | \"onDragEnterCapture\" | \"onDragExit\" | \"onDragExitCapture\" | \"onDragLeave\" | \"onDragLeaveCapture\" | \"onDragOver\" | \"onDragOverCapture\" | \"onDragStart\" | \"onDragStartCapture\" | \"onDrop\" | \"onDropCapture\" | \"onMouseDown\" | \"onMouseDownCapture\" | \"onMouseEnter\" | \"onMouseLeave\" | \"onMouseMove\" | \"onMouseMoveCapture\" | \"onMouseOut\" | \"onMouseOutCapture\" | \"onMouseOver\" | \"onMouseOverCapture\" | \"onMouseUp\" | \"onMouseUpCapture\" | \"onSelect\" | \"onSelectCapture\" | \"onTouchCancel\" | \"onTouchCancelCapture\" | \"onTouchEnd\" | \"onTouchEndCapture\" | \"onTouchMove\" | \"onTouchMoveCapture\" | \"onTouchStart\" | \"onTouchStartCapture\" | \"onPointerDown\" | \"onPointerDownCapture\" | \"onPointerMove\" | \"onPointerMoveCapture\" | \"onPointerUp\" | \"onPointerUpCapture\" | \"onPointerCancel\" | \"onPointerCancelCapture\" | \"onPointerEnter\" | \"onPointerEnterCapture\" | \"onPointerLeave\" | \"onPointerLeaveCapture\" | \"onPointerOver\" | \"onPointerOverCapture\" | \"onPointerOut\" | \"onPointerOutCapture\" | \"onGotPointerCapture\" | \"onGotPointerCaptureCapture\" | \"onLostPointerCapture\" | \"onLostPointerCaptureCapture\" | \"onScroll\" | \"onScrollCapture\" | \"onWheel\" | \"onWheelCapture\" | \"onAnimationStart\" | \"onAnimationStartCapture\" | \"onAnimationEnd\" | \"onAnimationEndCapture\" | \"onAnimationIteration\" | \"onAnimationIterationCapture\" | \"onTransitionEnd\" | \"onTransitionEndCapture\" | \"toastLifeTimeMs\" | \"iconType\" | \"onClose\" | \"data-test-subj\"> & { title?: string | ", + ", \"children\" | \"color\" | \"className\" | \"onChange\" | \"onKeyDown\" | \"onClick\" | \"security\" | \"defaultValue\" | \"hidden\" | \"lang\" | \"onError\" | \"defaultChecked\" | \"suppressContentEditableWarning\" | \"suppressHydrationWarning\" | \"accessKey\" | \"contentEditable\" | \"contextMenu\" | \"dir\" | \"draggable\" | \"placeholder\" | \"slot\" | \"spellCheck\" | \"style\" | \"tabIndex\" | \"translate\" | \"radioGroup\" | \"role\" | \"about\" | \"datatype\" | \"inlist\" | \"prefix\" | \"property\" | \"resource\" | \"typeof\" | \"vocab\" | \"autoCapitalize\" | \"autoCorrect\" | \"autoSave\" | \"itemProp\" | \"itemScope\" | \"itemType\" | \"itemID\" | \"itemRef\" | \"results\" | \"unselectable\" | \"inputMode\" | \"is\" | \"aria-activedescendant\" | \"aria-atomic\" | \"aria-autocomplete\" | \"aria-busy\" | \"aria-checked\" | \"aria-colcount\" | \"aria-colindex\" | \"aria-colspan\" | \"aria-controls\" | \"aria-current\" | \"aria-describedby\" | \"aria-details\" | \"aria-disabled\" | \"aria-dropeffect\" | \"aria-errormessage\" | \"aria-expanded\" | \"aria-flowto\" | \"aria-grabbed\" | \"aria-haspopup\" | \"aria-hidden\" | \"aria-invalid\" | \"aria-keyshortcuts\" | \"aria-label\" | \"aria-labelledby\" | \"aria-level\" | \"aria-live\" | \"aria-modal\" | \"aria-multiline\" | \"aria-multiselectable\" | \"aria-orientation\" | \"aria-owns\" | \"aria-placeholder\" | \"aria-posinset\" | \"aria-pressed\" | \"aria-readonly\" | \"aria-relevant\" | \"aria-required\" | \"aria-roledescription\" | \"aria-rowcount\" | \"aria-rowindex\" | \"aria-rowspan\" | \"aria-selected\" | \"aria-setsize\" | \"aria-sort\" | \"aria-valuemax\" | \"aria-valuemin\" | \"aria-valuenow\" | \"aria-valuetext\" | \"dangerouslySetInnerHTML\" | \"onCopy\" | \"onCopyCapture\" | \"onCut\" | \"onCutCapture\" | \"onPaste\" | \"onPasteCapture\" | \"onCompositionEnd\" | \"onCompositionEndCapture\" | \"onCompositionStart\" | \"onCompositionStartCapture\" | \"onCompositionUpdate\" | \"onCompositionUpdateCapture\" | \"onFocus\" | \"onFocusCapture\" | \"onBlur\" | \"onBlurCapture\" | \"onChangeCapture\" | \"onBeforeInput\" | \"onBeforeInputCapture\" | \"onInput\" | \"onInputCapture\" | \"onReset\" | \"onResetCapture\" | \"onSubmit\" | \"onSubmitCapture\" | \"onInvalid\" | \"onInvalidCapture\" | \"onLoad\" | \"onLoadCapture\" | \"onErrorCapture\" | \"onKeyDownCapture\" | \"onKeyPress\" | \"onKeyPressCapture\" | \"onKeyUp\" | \"onKeyUpCapture\" | \"onAbort\" | \"onAbortCapture\" | \"onCanPlay\" | \"onCanPlayCapture\" | \"onCanPlayThrough\" | \"onCanPlayThroughCapture\" | \"onDurationChange\" | \"onDurationChangeCapture\" | \"onEmptied\" | \"onEmptiedCapture\" | \"onEncrypted\" | \"onEncryptedCapture\" | \"onEnded\" | \"onEndedCapture\" | \"onLoadedData\" | \"onLoadedDataCapture\" | \"onLoadedMetadata\" | \"onLoadedMetadataCapture\" | \"onLoadStart\" | \"onLoadStartCapture\" | \"onPause\" | \"onPauseCapture\" | \"onPlay\" | \"onPlayCapture\" | \"onPlaying\" | \"onPlayingCapture\" | \"onProgress\" | \"onProgressCapture\" | \"onRateChange\" | \"onRateChangeCapture\" | \"onSeeked\" | \"onSeekedCapture\" | \"onSeeking\" | \"onSeekingCapture\" | \"onStalled\" | \"onStalledCapture\" | \"onSuspend\" | \"onSuspendCapture\" | \"onTimeUpdate\" | \"onTimeUpdateCapture\" | \"onVolumeChange\" | \"onVolumeChangeCapture\" | \"onWaiting\" | \"onWaitingCapture\" | \"onAuxClick\" | \"onAuxClickCapture\" | \"onClickCapture\" | \"onContextMenu\" | \"onContextMenuCapture\" | \"onDoubleClick\" | \"onDoubleClickCapture\" | \"onDrag\" | \"onDragCapture\" | \"onDragEnd\" | \"onDragEndCapture\" | \"onDragEnter\" | \"onDragEnterCapture\" | \"onDragExit\" | \"onDragExitCapture\" | \"onDragLeave\" | \"onDragLeaveCapture\" | \"onDragOver\" | \"onDragOverCapture\" | \"onDragStart\" | \"onDragStartCapture\" | \"onDrop\" | \"onDropCapture\" | \"onMouseDown\" | \"onMouseDownCapture\" | \"onMouseEnter\" | \"onMouseLeave\" | \"onMouseMove\" | \"onMouseMoveCapture\" | \"onMouseOut\" | \"onMouseOutCapture\" | \"onMouseOver\" | \"onMouseOverCapture\" | \"onMouseUp\" | \"onMouseUpCapture\" | \"onSelect\" | \"onSelectCapture\" | \"onTouchCancel\" | \"onTouchCancelCapture\" | \"onTouchEnd\" | \"onTouchEndCapture\" | \"onTouchMove\" | \"onTouchMoveCapture\" | \"onTouchStart\" | \"onTouchStartCapture\" | \"onPointerDown\" | \"onPointerDownCapture\" | \"onPointerMove\" | \"onPointerMoveCapture\" | \"onPointerUp\" | \"onPointerUpCapture\" | \"onPointerCancel\" | \"onPointerCancelCapture\" | \"onPointerEnter\" | \"onPointerEnterCapture\" | \"onPointerLeave\" | \"onPointerLeaveCapture\" | \"onPointerOver\" | \"onPointerOverCapture\" | \"onPointerOut\" | \"onPointerOutCapture\" | \"onGotPointerCapture\" | \"onGotPointerCaptureCapture\" | \"onLostPointerCapture\" | \"onLostPointerCaptureCapture\" | \"onScroll\" | \"onScrollCapture\" | \"onWheel\" | \"onWheelCapture\" | \"onAnimationStart\" | \"onAnimationStartCapture\" | \"onAnimationEnd\" | \"onAnimationEndCapture\" | \"onAnimationIteration\" | \"onAnimationIterationCapture\" | \"onTransitionEnd\" | \"onTransitionEndCapture\" | \"toastLifeTimeMs\" | \"iconType\" | \"onClose\" | \"data-test-subj\"> & { title?: string | ", { "pluginId": "core", "scope": "public", @@ -9179,6 +9160,9 @@ "description": [ "\r\nAnalytics client's public APIs" ], + "signature": [ + "AnalyticsClient" + ], "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "children": [ @@ -9839,7 +9823,7 @@ "corrective action needed to fix this deprecation." ], "signature": [ - "{ api?: { path: string; method: \"PUT\" | \"POST\"; body?: { [key: string]: any; } | undefined; omitContextFromBody?: boolean | undefined; } | undefined; manualSteps: string[]; }" + "{ api?: { path: string; method: \"POST\" | \"PUT\"; body?: { [key: string]: any; } | undefined; omitContextFromBody?: boolean | undefined; } | undefined; manualSteps: string[]; }" ], "path": "src/core/server/deprecations/types.ts", "deprecated": false @@ -10131,6 +10115,9 @@ "description": [ "\r\nDeprecation context provided to {@link ConfigDeprecation | config deprecations}\r\n" ], + "signature": [ + "ConfigDeprecationContext" + ], "path": "node_modules/@types/kbn__config/index.d.ts", "deprecated": false, "children": [ @@ -10238,6 +10225,9 @@ "description": [ "\r\nProvides helpers to generates the most commonly used {@link ConfigDeprecation}\r\nwhen invoking a {@link ConfigDeprecationProvider}.\r\n\r\nSee methods documentation for more detailed examples.\r\n" ], + "signature": [ + "ConfigDeprecationFactory" + ], "path": "node_modules/@types/kbn__config/index.d.ts", "deprecated": false, "children": [ @@ -11855,9 +11845,12 @@ "tags": [], "label": "DiscoveredPlugin", "description": [ - "\nSmall container object used to expose information about discovered plugins that may\nor may not have been started." + "\r\nSmall container object used to expose information about discovered plugins that may\r\nor may not have been started." ], - "path": "src/core/server/plugins/types.ts", + "signature": [ + "DiscoveredPlugin" + ], + "path": "node_modules/@types/kbn__core-base-common/index.d.ts", "deprecated": false, "children": [ { @@ -11867,9 +11860,9 @@ "tags": [], "label": "id", "description": [ - "\nIdentifier of the plugin." + "\r\nIdentifier of the plugin." ], - "path": "src/core/server/plugins/types.ts", + "path": "node_modules/@types/kbn__core-base-common/index.d.ts", "deprecated": false }, { @@ -11879,12 +11872,12 @@ "tags": [], "label": "configPath", "description": [ - "\nRoot configuration path used by the plugin, defaults to \"id\" in snake_case format." + "\r\nRoot configuration path used by the plugin, defaults to \"id\" in snake_case format." ], "signature": [ "string | string[]" ], - "path": "src/core/server/plugins/types.ts", + "path": "node_modules/@types/kbn__core-base-common/index.d.ts", "deprecated": false }, { @@ -11894,18 +11887,12 @@ "tags": [], "label": "type", "description": [ - "\nType of the plugin, defaults to `standard`." + "\r\nType of the plugin, defaults to `standard`." ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.PluginType", - "text": "PluginType" - } + "PluginType" ], - "path": "src/core/server/plugins/types.ts", + "path": "node_modules/@types/kbn__core-base-common/index.d.ts", "deprecated": false }, { @@ -11915,12 +11902,12 @@ "tags": [], "label": "requiredPlugins", "description": [ - "\nAn optional list of the other plugins that **must be** installed and enabled\nfor this plugin to function properly." + "\r\nAn optional list of the other plugins that **must be** installed and enabled\r\nfor this plugin to function properly." ], "signature": [ "readonly string[]" ], - "path": "src/core/server/plugins/types.ts", + "path": "node_modules/@types/kbn__core-base-common/index.d.ts", "deprecated": false }, { @@ -11930,12 +11917,12 @@ "tags": [], "label": "optionalPlugins", "description": [ - "\nAn optional list of the other plugins that if installed and enabled **may be**\nleveraged by this plugin for some additional functionality but otherwise are\nnot required for this plugin to work properly." + "\r\nAn optional list of the other plugins that if installed and enabled **may be**\r\nleveraged by this plugin for some additional functionality but otherwise are\r\nnot required for this plugin to work properly." ], "signature": [ "readonly string[]" ], - "path": "src/core/server/plugins/types.ts", + "path": "node_modules/@types/kbn__core-base-common/index.d.ts", "deprecated": false }, { @@ -11945,12 +11932,12 @@ "tags": [], "label": "requiredBundles", "description": [ - "\nList of plugin ids that this plugin's UI code imports modules from that are\nnot in `requiredPlugins`.\n" + "\r\nList of plugin ids that this plugin's UI code imports modules from that are\r\nnot in `requiredPlugins`.\r\n" ], "signature": [ "readonly string[]" ], - "path": "src/core/server/plugins/types.ts", + "path": "node_modules/@types/kbn__core-base-common/index.d.ts", "deprecated": false }, { @@ -11960,12 +11947,12 @@ "tags": [], "label": "enabledOnAnonymousPages", "description": [ - "\nSpecifies whether this plugin - and its required dependencies - will be enabled for anonymous pages (login page, status page when\nconfigured, etc.) Default is false." + "\r\nSpecifies whether this plugin - and its required dependencies - will be enabled for anonymous pages (login page, status page when\r\nconfigured, etc.) Default is false." ], "signature": [ "boolean | undefined" ], - "path": "src/core/server/plugins/types.ts", + "path": "node_modules/@types/kbn__core-base-common/index.d.ts", "deprecated": false } ], @@ -12448,6 +12435,9 @@ "tags": [], "label": "EnvironmentMode", "description": [], + "signature": [ + "EnvironmentMode" + ], "path": "node_modules/@types/kbn__config/index.d.ts", "deprecated": false, "children": [ @@ -12568,6 +12558,9 @@ "description": [ "\r\nDefinition of the context that can be appended to the events through the {@link IAnalyticsClient.registerContextProvider}." ], + "signature": [ + "EventContext" + ], "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "children": [ @@ -12646,6 +12639,21 @@ "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false }, + { + "parentPluginId": "core", + "id": "def-server.EventContext.isElasticCloudUser", + "type": "CompoundType", + "tags": [], + "label": "isElasticCloudUser", + "description": [ + "\r\n`true` if the user is logged in via the Elastic Cloud authentication provider." + ], + "signature": [ + "boolean | undefined" + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false + }, { "parentPluginId": "core", "id": "def-server.EventContext.version", @@ -18676,6 +18684,9 @@ "description": [ "\r\nBasic structure of a Shipper" ], + "signature": [ + "IShipper" + ], "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "children": [ @@ -19141,6 +19152,9 @@ "description": [ "\r\nLogger exposes all the necessary methods to log any type of information and\r\nthis is the interface used by the logging consumers including plugins.\r\n" ], + "signature": [ + "Logger" + ], "path": "node_modules/@types/kbn__logging/index.d.ts", "deprecated": false, "children": [ @@ -19568,6 +19582,9 @@ "description": [ "\r\nThe single purpose of `LoggerFactory` interface is to define a way to\r\nretrieve a context-based logger instance.\r\n" ], + "signature": [ + "LoggerFactory" + ], "path": "node_modules/@types/kbn__logging/index.d.ts", "deprecated": false, "children": [ @@ -20260,6 +20277,9 @@ "description": [ "\r\n" ], + "signature": [ + "OptInConfig" + ], "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "children": [ @@ -20305,6 +20325,9 @@ "tags": [], "label": "PackageInfo", "description": [], + "signature": [ + "PackageInfo" + ], "path": "node_modules/@types/kbn__config/index.d.ts", "deprecated": false, "children": [ @@ -20778,13 +20801,7 @@ "\nType of the plugin, defaults to `standard`." ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.PluginType", - "text": "PluginType" - } + "PluginType" ], "path": "src/core/server/plugins/types.ts", "deprecated": false @@ -23452,6 +23469,9 @@ "description": [ "\r\nShape of the events emitted by the telemetryCounter$ observable" ], + "signature": [ + "TelemetryCounter" + ], "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "children": [ @@ -24174,7 +24194,10 @@ "tags": [], "label": "PluginType", "description": [], - "path": "src/core/server/plugins/types.ts", + "signature": [ + "PluginType" + ], + "path": "node_modules/@types/kbn__core-base-common/index.d.ts", "deprecated": false, "initialIsOpen": false }, @@ -24187,6 +24210,9 @@ "description": [ "\r\nTypes of the Telemetry Counter: It allows to differentiate what happened to the events" ], + "signature": [ + "TelemetryCounterType" + ], "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "initialIsOpen": false @@ -27037,12 +27063,12 @@ "tags": [], "label": "PluginName", "description": [ - "\nDedicated type for plugin name/id that is supposed to make Map/Set/Arrays\nthat use it as a key or value more obvious.\n" + "\r\nDedicated type for plugin name/id that is supposed to make Map/Set/Arrays\r\nthat use it as a key or value more obvious.\r\n" ], "signature": [ "string" ], - "path": "src/core/server/plugins/types.ts", + "path": "node_modules/@types/kbn__core-base-common/index.d.ts", "deprecated": false, "initialIsOpen": false }, @@ -27056,7 +27082,7 @@ "signature": [ "symbol" ], - "path": "src/core/server/plugins/types.ts", + "path": "node_modules/@types/kbn__core-base-common/index.d.ts", "deprecated": false, "initialIsOpen": false }, diff --git a/api_docs/core.mdx b/api_docs/core.mdx index 8dac39426a0288..b5da288e4b7403 100644 --- a/api_docs/core.mdx +++ b/api_docs/core.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/core title: "core" image: https://source.unsplash.com/400x175/?github summary: API docs for the core plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'core'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for que | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 2541 | 15 | 977 | 33 | +| 2524 | 15 | 956 | 33 | ## Client diff --git a/api_docs/core_application.mdx b/api_docs/core_application.mdx index 23dc2eaf1abbf5..dc5cabcb41f1b3 100644 --- a/api_docs/core_application.mdx +++ b/api_docs/core_application.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/core-application title: "core.application" image: https://source.unsplash.com/400x175/?github summary: API docs for the core.application plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'core.application'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for que | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 2541 | 15 | 977 | 33 | +| 2524 | 15 | 956 | 33 | ## Client diff --git a/api_docs/core_chrome.devdocs.json b/api_docs/core_chrome.devdocs.json index 90f19604102acb..5810ae6c818030 100644 --- a/api_docs/core_chrome.devdocs.json +++ b/api_docs/core_chrome.devdocs.json @@ -171,7 +171,15 @@ "\nCustom content to occur below the list of links" ], "signature": [ - "((element: HTMLDivElement) => () => void) | undefined" + "((element: HTMLDivElement, menuActions: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreChromePluginApi", + "section": "def-public.ChromeHelpMenuActions", + "text": "ChromeHelpMenuActions" + }, + ") => () => void) | undefined" ], "path": "src/core/public/chrome/types.ts", "deprecated": false, @@ -189,6 +197,26 @@ "path": "src/core/public/chrome/types.ts", "deprecated": false, "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-public.ChromeHelpExtension.content.$2", + "type": "Object", + "tags": [], + "label": "menuActions", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreChromePluginApi", + "section": "def-public.ChromeHelpMenuActions", + "text": "ChromeHelpMenuActions" + } + ], + "path": "src/core/public/chrome/types.ts", + "deprecated": false, + "isRequired": true } ], "returnComment": [] @@ -457,6 +485,34 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "core", + "id": "def-public.ChromeHelpMenuActions", + "type": "Interface", + "tags": [], + "label": "ChromeHelpMenuActions", + "description": [], + "path": "src/core/public/chrome/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.ChromeHelpMenuActions.hideHelpMenu", + "type": "Function", + "tags": [], + "label": "hideHelpMenu", + "description": [], + "signature": [ + "() => void" + ], + "path": "src/core/public/chrome/types.ts", + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + }, { "parentPluginId": "core", "id": "def-public.ChromeNavControl", diff --git a/api_docs/core_chrome.mdx b/api_docs/core_chrome.mdx index 836ab672a0b60e..f52356cb326ed0 100644 --- a/api_docs/core_chrome.mdx +++ b/api_docs/core_chrome.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/core-chrome title: "core.chrome" image: https://source.unsplash.com/400x175/?github summary: API docs for the core.chrome plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'core.chrome'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for que | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 2541 | 15 | 977 | 33 | +| 2524 | 15 | 956 | 33 | ## Client diff --git a/api_docs/core_http.mdx b/api_docs/core_http.mdx index 3e88698fc5bb8a..fd33a86ced037b 100644 --- a/api_docs/core_http.mdx +++ b/api_docs/core_http.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/core-http title: "core.http" image: https://source.unsplash.com/400x175/?github summary: API docs for the core.http plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'core.http'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for que | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 2541 | 15 | 977 | 33 | +| 2524 | 15 | 956 | 33 | ## Client diff --git a/api_docs/core_saved_objects.devdocs.json b/api_docs/core_saved_objects.devdocs.json index 9bc63a8bcba304..540ce398b49904 100644 --- a/api_docs/core_saved_objects.devdocs.json +++ b/api_docs/core_saved_objects.devdocs.json @@ -4,92 +4,230 @@ "classes": [ { "parentPluginId": "core", - "id": "def-public.SavedObjectsClient", + "id": "def-public.SimpleSavedObject", "type": "Class", "tags": [], - "label": "SavedObjectsClient", + "label": "SimpleSavedObject", "description": [ - "\nSaved Objects is Kibana's data persisentence mechanism allowing plugins to\nuse Elasticsearch for storing plugin state. The client-side\nSavedObjectsClient is a thin convenience library around the SavedObjects\nHTTP API for interacting with Saved Objects.\n" + "\nThis class is a very simple wrapper for SavedObjects loaded from the server\nwith the {@link SavedObjectsClientContract}.\n\nIt provides basic functionality for creating/saving/deleting saved objects,\nbut doesn't include any type-specific implementations.\n" ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SimpleSavedObject", + "text": "SimpleSavedObject" + }, + "" + ], + "path": "src/core/public/saved_objects/simple_saved_object.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.SavedObjectsClient.create", - "type": "Function", + "id": "def-public.SimpleSavedObject.attributes", + "type": "Uncategorized", "tags": [], - "label": "create", + "label": "attributes", + "description": [], + "signature": [ + "T" + ], + "path": "src/core/public/saved_objects/simple_saved_object.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.SimpleSavedObject._version", + "type": "string", + "tags": [], + "label": "_version", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "src/core/public/saved_objects/simple_saved_object.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.SimpleSavedObject.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "path": "src/core/public/saved_objects/simple_saved_object.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.SimpleSavedObject.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "path": "src/core/public/saved_objects/simple_saved_object.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.SimpleSavedObject.migrationVersion", + "type": "Object", + "tags": [], + "label": "migrationVersion", + "description": [], + "signature": [ + "SavedObjectsMigrationVersion", + " | undefined" + ], + "path": "src/core/public/saved_objects/simple_saved_object.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.SimpleSavedObject.coreMigrationVersion", + "type": "string", + "tags": [], + "label": "coreMigrationVersion", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "src/core/public/saved_objects/simple_saved_object.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.SimpleSavedObject.error", + "type": "Object", + "tags": [], + "label": "error", + "description": [], + "signature": [ + "SavedObjectError", + " | undefined" + ], + "path": "src/core/public/saved_objects/simple_saved_object.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.SimpleSavedObject.references", + "type": "Array", + "tags": [], + "label": "references", + "description": [], + "signature": [ + "SavedObjectReference", + "[]" + ], + "path": "src/core/public/saved_objects/simple_saved_object.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.SimpleSavedObject.updatedAt", + "type": "string", + "tags": [], + "label": "updatedAt", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "src/core/public/saved_objects/simple_saved_object.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.SimpleSavedObject.namespaces", + "type": "Array", + "tags": [], + "label": "namespaces", "description": [ - "\nPersists an object\n" + "\nSpace(s) that this saved object exists in. This attribute is not used for \"global\" saved object types which are registered with\n`namespaceType: 'agnostic'`." ], "signature": [ - "(type: string, attributes: T, options?: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsCreateOptions", - "text": "SavedObjectsCreateOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SimpleSavedObject", - "text": "SimpleSavedObject" - }, - ">" + "string[] | undefined" ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", + "path": "src/core/public/saved_objects/simple_saved_object.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.SimpleSavedObject.Unnamed", + "type": "Function", + "tags": [], + "label": "Constructor", + "description": [], + "signature": [ + "any" + ], + "path": "src/core/public/saved_objects/simple_saved_object.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.SavedObjectsClient.create.$1", - "type": "string", + "id": "def-public.SimpleSavedObject.Unnamed.$1", + "type": "Object", "tags": [], - "label": "type", + "label": "client", "description": [], "signature": [ - "string" + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SavedObjectsClientContract", + "text": "SavedObjectsClientContract" + } ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", + "path": "src/core/public/saved_objects/simple_saved_object.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsClient.create.$2", - "type": "Uncategorized", + "id": "def-public.SimpleSavedObject.Unnamed.$2", + "type": "Object", "tags": [], - "label": "attributes", + "label": "{\n id,\n type,\n version,\n attributes,\n error,\n references,\n migrationVersion,\n coreMigrationVersion,\n namespaces,\n updated_at: updatedAt,\n }", "description": [], "signature": [ - "T" + "SavedObject", + "" ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", + "path": "src/core/public/saved_objects/simple_saved_object.ts", "deprecated": false, "isRequired": true - }, + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-public.SimpleSavedObject.get", + "type": "Function", + "tags": [], + "label": "get", + "description": [], + "signature": [ + "(key: string) => any" + ], + "path": "src/core/public/saved_objects/simple_saved_object.ts", + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-public.SavedObjectsClient.create.$3", - "type": "Object", + "id": "def-public.SimpleSavedObject.get.$1", + "type": "string", "tags": [], - "label": "options", + "label": "key", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsCreateOptions", - "text": "SavedObjectsCreateOptions" - } + "string" ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", + "path": "src/core/public/saved_objects/simple_saved_object.ts", "deprecated": false, "isRequired": true } @@ -98,217 +236,154 @@ }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsClient.bulkCreate", + "id": "def-public.SimpleSavedObject.set", "type": "Function", - "tags": [ - "property" - ], - "label": "bulkCreate", - "description": [ - "\nCreates multiple documents at once\n" - ], + "tags": [], + "label": "set", + "description": [], "signature": [ - "(objects?: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsBulkCreateObject", - "text": "SavedObjectsBulkCreateObject" - }, - "[], options?: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsBulkCreateOptions", - "text": "SavedObjectsBulkCreateOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsBatchResponse", - "text": "SavedObjectsBatchResponse" - }, - ">" - ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "deprecated": false, - "children": [ + "(key: string, value: any) => T" + ], + "path": "src/core/public/saved_objects/simple_saved_object.ts", + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-public.SavedObjectsClient.bulkCreate.$1", - "type": "Array", + "id": "def-public.SimpleSavedObject.set.$1", + "type": "string", "tags": [], - "label": "objects", - "description": [ - "- [{ type, id, attributes, references, migrationVersion }]" - ], + "label": "key", + "description": [], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsBulkCreateObject", - "text": "SavedObjectsBulkCreateObject" - }, - "[]" + "string" ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", + "path": "src/core/public/saved_objects/simple_saved_object.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsClient.bulkCreate.$2", - "type": "Object", + "id": "def-public.SimpleSavedObject.set.$2", + "type": "Any", "tags": [], - "label": "options", + "label": "value", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsBulkCreateOptions", - "text": "SavedObjectsBulkCreateOptions" - } + "any" ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", + "path": "src/core/public/saved_objects/simple_saved_object.ts", "deprecated": false, "isRequired": true } ], - "returnComment": [ - "The result of the create operation containing created saved objects." - ] + "returnComment": [] }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsClient.delete", + "id": "def-public.SimpleSavedObject.has", "type": "Function", "tags": [], - "label": "delete", - "description": [ - "\nDeletes an object\n" - ], + "label": "has", + "description": [], "signature": [ - "(type: string, id: string, options?: ", - "SavedObjectsDeleteOptions", - " | undefined) => Promise<{}>" + "(key: string) => boolean" ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", + "path": "src/core/public/saved_objects/simple_saved_object.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.SavedObjectsClient.delete.$1", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "string" - ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsClient.delete.$2", + "id": "def-public.SimpleSavedObject.has.$1", "type": "string", "tags": [], - "label": "id", + "label": "key", "description": [], "signature": [ "string" ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", + "path": "src/core/public/saved_objects/simple_saved_object.ts", "deprecated": false, "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsClient.delete.$3", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - "SavedObjectsDeleteOptions", - " | undefined" - ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "deprecated": false, - "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsClient.find", + "id": "def-public.SimpleSavedObject.save", "type": "Function", - "tags": [ - "property", - "property", - "property", - "property", - "property", - "property", - "property" - ], - "label": "find", - "description": [ - "\nSearch for objects\n" - ], + "tags": [], + "label": "save", + "description": [], "signature": [ - "(options: SavedObjectsFindOptions) => Promise<", + "() => Promise<", { "pluginId": "core", "scope": "public", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsFindResponsePublic", - "text": "SavedObjectsFindResponsePublic" + "section": "def-public.SimpleSavedObject", + "text": "SimpleSavedObject" }, - ">" + ">" ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", + "path": "src/core/public/saved_objects/simple_saved_object.ts", "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsClient.find.$1", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - "SavedObjectsFindOptions" - ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [ - "A find result with objects matching the specified search." - ] + "children": [], + "returnComment": [] }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsClient.get", + "id": "def-public.SimpleSavedObject.delete", "type": "Function", "tags": [], - "label": "get", + "label": "delete", + "description": [], + "signature": [ + "() => Promise<{}>" + ], + "path": "src/core/public/saved_objects/simple_saved_object.ts", + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + } + ], + "functions": [], + "interfaces": [ + { + "parentPluginId": "core", + "id": "def-public.ResolvedSimpleSavedObject", + "type": "Interface", + "tags": [], + "label": "ResolvedSimpleSavedObject", + "description": [ + "\nThis interface is a very simple wrapper for SavedObjects resolved from the server\nwith the {@link SavedObjectsClientContract}.\n" + ], + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.ResolvedSimpleSavedObject", + "text": "ResolvedSimpleSavedObject" + }, + "" + ], + "path": "src/core/public/saved_objects/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.ResolvedSimpleSavedObject.saved_object", + "type": "Object", + "tags": [], + "label": "saved_object", "description": [ - "\nFetches a single object\n" + "\nThe saved object that was found." ], "signature": [ - "(type: string, id: string) => Promise<", { "pluginId": "core", "scope": "public", @@ -316,214 +391,366 @@ "section": "def-public.SimpleSavedObject", "text": "SimpleSavedObject" }, - ">" - ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsClient.get.$1", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "string" - ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsClient.get.$2", - "type": "string", - "tags": [], - "label": "id", - "description": [], - "signature": [ - "string" - ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "deprecated": false, - "isRequired": true - } + "" ], - "returnComment": [ - "The saved object for the given type and id." - ] + "path": "src/core/public/saved_objects/types.ts", + "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsClient.bulkGet", - "type": "Function", + "id": "def-public.ResolvedSimpleSavedObject.outcome", + "type": "CompoundType", "tags": [], - "label": "bulkGet", + "label": "outcome", "description": [ - "\nReturns an array of objects by id\n" + "\nThe outcome for a successful `resolve` call is one of the following values:\n\n * `'exactMatch'` -- One document exactly matched the given ID.\n * `'aliasMatch'` -- One document with a legacy URL alias matched the given ID; in this case the `saved_object.id` field is different\n than the given ID.\n * `'conflict'` -- Two documents matched the given ID, one was an exact match and another with a legacy URL alias; in this case the\n `saved_object` object is the exact match, and the `saved_object.id` field is the same as the given ID." ], "signature": [ - "(objects?: { id: string; type: string; }[]) => Promise<", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsBatchResponse", - "text": "SavedObjectsBatchResponse" - }, - ">" + "\"exactMatch\" | \"aliasMatch\" | \"conflict\"" ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsClient.bulkGet.$1", - "type": "Array", - "tags": [], - "label": "objects", - "description": [ - "- an array ids, or an array of objects containing id and optionally type" - ], - "signature": [ - "{ id: string; type: string; }[]" - ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [ - "The saved objects with the given type and ids requested" - ] + "path": "src/core/public/saved_objects/types.ts", + "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsClient.resolve", - "type": "Function", - "tags": [ - "note" - ], - "label": "resolve", + "id": "def-public.ResolvedSimpleSavedObject.alias_target_id", + "type": "string", + "tags": [], + "label": "alias_target_id", "description": [ - "\nResolves a single object\n" + "\nThe ID of the object that the legacy URL alias points to.\n\n**Note:** this field is *only* included when an alias was found (in other words, when the outcome is `'aliasMatch'` or `'conflict'`)." ], "signature": [ - "(type: string, id: string) => Promise<", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.ResolvedSimpleSavedObject", - "text": "ResolvedSimpleSavedObject" - }, - ">" - ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsClient.resolve.$1", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "string" - ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsClient.resolve.$2", - "type": "string", - "tags": [], - "label": "id", - "description": [], - "signature": [ - "string" - ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "deprecated": false, - "isRequired": true - } + "string | undefined" ], - "returnComment": [ - "The resolve result for the saved object for the given type and id." - ] + "path": "src/core/public/saved_objects/types.ts", + "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsClient.bulkResolve", - "type": "Function", - "tags": [ - "note" - ], - "label": "bulkResolve", + "id": "def-public.ResolvedSimpleSavedObject.alias_purpose", + "type": "CompoundType", + "tags": [], + "label": "alias_purpose", "description": [ - "\nResolves an array of objects by id, using any legacy URL aliases if they exist\n" + "\nThe reason this alias was created.\n\nCurrently this is used to determine whether or not a toast should be shown when a user is redirected from a legacy URL; if the alias\nwas created because of saved object conversion, then we will display a toast telling the user that the object has a new URL.\n\n**Note:** this field is *only* included when an alias was found (in other words, when the outcome is `'aliasMatch'` or `'conflict'`)." + ], + "signature": [ + "\"savedObjectConversion\" | \"savedObjectImport\" | undefined" ], + "path": "src/core/public/saved_objects/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsBatchResponse", + "type": "Interface", + "tags": [], + "label": "SavedObjectsBatchResponse", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SavedObjectsBatchResponse", + "text": "SavedObjectsBatchResponse" + }, + "" + ], + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsBatchResponse.savedObjects", + "type": "Array", + "tags": [], + "label": "savedObjects", + "description": [], "signature": [ - "(objects?: { id: string; type: string; }[]) => Promise<{ resolved_objects: ", { "pluginId": "core", "scope": "public", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.ResolvedSimpleSavedObject", - "text": "ResolvedSimpleSavedObject" + "section": "def-public.SimpleSavedObject", + "text": "SimpleSavedObject" }, - "[]; }>" + "[]" ], "path": "src/core/public/saved_objects/saved_objects_client.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsClient.bulkResolve.$1", - "type": "Array", - "tags": [], - "label": "objects", - "description": [ - "- an array of objects containing id, type" - ], - "signature": [ - "{ id: string; type: string; }[]" - ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [ - "The bulk resolve result for the saved objects for the given types and ids." - ] + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsBulkCreateObject", + "type": "Interface", + "tags": [], + "label": "SavedObjectsBulkCreateObject", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SavedObjectsBulkCreateObject", + "text": "SavedObjectsBulkCreateObject" + }, + " extends ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SavedObjectsCreateOptions", + "text": "SavedObjectsCreateOptions" + } + ], + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsBulkCreateObject.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsClient.update", - "type": "Function", - "tags": [ - "prop", - "prop" + "id": "def-public.SavedObjectsBulkCreateObject.attributes", + "type": "Uncategorized", + "tags": [], + "label": "attributes", + "description": [], + "signature": [ + "T" ], - "label": "update", + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsBulkCreateOptions", + "type": "Interface", + "tags": [], + "label": "SavedObjectsBulkCreateOptions", + "description": [], + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsBulkCreateOptions.overwrite", + "type": "CompoundType", + "tags": [], + "label": "overwrite", "description": [ - "\nUpdates an object\n" + "If a document with the given `id` already exists, overwrite it's contents (default=false)." + ], + "signature": [ + "boolean | undefined" ], + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsBulkResolveResponse", + "type": "Interface", + "tags": [], + "label": "SavedObjectsBulkResolveResponse", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SavedObjectsBulkResolveResponse", + "text": "SavedObjectsBulkResolveResponse" + }, + "" + ], + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsBulkResolveResponse.resolved_objects", + "type": "Array", + "tags": [], + "label": "resolved_objects", + "description": [], "signature": [ - "(type: string, id: string, attributes: T, { version, references, upsert }?: ", { "pluginId": "core", "scope": "public", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsUpdateOptions", - "text": "SavedObjectsUpdateOptions" + "section": "def-public.ResolvedSimpleSavedObject", + "text": "ResolvedSimpleSavedObject" + }, + "[]" + ], + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsBulkUpdateObject", + "type": "Interface", + "tags": [], + "label": "SavedObjectsBulkUpdateObject", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SavedObjectsBulkUpdateObject", + "text": "SavedObjectsBulkUpdateObject" + }, + "" + ], + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsBulkUpdateObject.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsBulkUpdateObject.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsBulkUpdateObject.attributes", + "type": "Uncategorized", + "tags": [], + "label": "attributes", + "description": [], + "signature": [ + "T" + ], + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsBulkUpdateObject.version", + "type": "string", + "tags": [], + "label": "version", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsBulkUpdateObject.references", + "type": "Array", + "tags": [], + "label": "references", + "description": [], + "signature": [ + "SavedObjectReference", + "[] | undefined" + ], + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsBulkUpdateOptions", + "type": "Interface", + "tags": [], + "label": "SavedObjectsBulkUpdateOptions", + "description": [], + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsBulkUpdateOptions.namespace", + "type": "string", + "tags": [], + "label": "namespace", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsClientContract", + "type": "Interface", + "tags": [], + "label": "SavedObjectsClientContract", + "description": [ + "\nThe client-side SavedObjectsClient is a thin convenience library around the SavedObjects\nHTTP API for interacting with Saved Objects.\n" + ], + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsClientContract.create", + "type": "Function", + "tags": [], + "label": "create", + "description": [ + "\nPersists an object" + ], + "signature": [ + "(type: string, attributes: T, options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SavedObjectsCreateOptions", + "text": "SavedObjectsCreateOptions" }, - ") => Promise<", + " | undefined) => Promise<", { "pluginId": "core", "scope": "public", @@ -538,7 +765,7 @@ "children": [ { "parentPluginId": "core", - "id": "def-public.SavedObjectsClient.update.$1", + "id": "def-public.SavedObjectsClientContract.create.$1", "type": "string", "tags": [], "label": "type", @@ -552,21 +779,7 @@ }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsClient.update.$2", - "type": "string", - "tags": [], - "label": "id", - "description": [], - "signature": [ - "string" - ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsClient.update.$3", + "id": "def-public.SavedObjectsClientContract.create.$2", "type": "Uncategorized", "tags": [], "label": "attributes", @@ -580,47 +793,55 @@ }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsClient.update.$4", + "id": "def-public.SavedObjectsClientContract.create.$3", "type": "Object", "tags": [], - "label": "{ version, references, upsert }", + "label": "options", "description": [], "signature": [ { "pluginId": "core", "scope": "public", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsUpdateOptions", - "text": "SavedObjectsUpdateOptions" + "section": "def-public.SavedObjectsCreateOptions", + "text": "SavedObjectsCreateOptions" }, - "" + " | undefined" ], "path": "src/core/public/saved_objects/saved_objects_client.ts", "deprecated": false, - "isRequired": true + "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsClient.bulkUpdate", + "id": "def-public.SavedObjectsClientContract.bulkCreate", "type": "Function", "tags": [], - "label": "bulkUpdate", + "label": "bulkCreate", "description": [ - "\nUpdate multiple documents at once\n" + "\nCreates multiple documents at once" ], "signature": [ - "(objects?: ", + "(objects: ", { "pluginId": "core", "scope": "public", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsBulkUpdateObject", - "text": "SavedObjectsBulkUpdateObject" + "section": "def-public.SavedObjectsBulkCreateObject", + "text": "SavedObjectsBulkCreateObject" }, - "[]) => Promise<", + "[], options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SavedObjectsBulkCreateOptions", + "text": "SavedObjectsBulkCreateOptions" + }, + " | undefined) => Promise<", { "pluginId": "core", "scope": "public", @@ -628,512 +849,397 @@ "section": "def-public.SavedObjectsBatchResponse", "text": "SavedObjectsBatchResponse" }, - ">" + ">" ], "path": "src/core/public/saved_objects/saved_objects_client.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.SavedObjectsClient.bulkUpdate.$1", + "id": "def-public.SavedObjectsClientContract.bulkCreate.$1", "type": "Array", "tags": [], "label": "objects", - "description": [ - "- [{ type, id, attributes, options: { version, references } }]" - ], + "description": [], "signature": [ { "pluginId": "core", "scope": "public", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsBulkUpdateObject", - "text": "SavedObjectsBulkUpdateObject" + "section": "def-public.SavedObjectsBulkCreateObject", + "text": "SavedObjectsBulkCreateObject" }, "[]" ], "path": "src/core/public/saved_objects/saved_objects_client.ts", "deprecated": false, "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsClientContract.bulkCreate.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SavedObjectsBulkCreateOptions", + "text": "SavedObjectsBulkCreateOptions" + }, + " | undefined" + ], + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "deprecated": false, + "isRequired": false } ], "returnComment": [ - "The result of the update operation containing both failed and updated saved objects." + "The result of the create operation containing created saved objects." ] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.SimpleSavedObject", - "type": "Class", - "tags": [], - "label": "SimpleSavedObject", - "description": [ - "\nThis class is a very simple wrapper for SavedObjects loaded from the server\nwith the {@link SavedObjectsClient}.\n\nIt provides basic functionality for creating/saving/deleting saved objects,\nbut doesn't include any type-specific implementations.\n" - ], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SimpleSavedObject", - "text": "SimpleSavedObject" }, - "" - ], - "path": "src/core/public/saved_objects/simple_saved_object.ts", - "deprecated": false, - "children": [ { "parentPluginId": "core", - "id": "def-public.SimpleSavedObject.attributes", - "type": "Uncategorized", + "id": "def-public.SavedObjectsClientContract.delete", + "type": "Function", "tags": [], - "label": "attributes", - "description": [], - "signature": [ - "T" + "label": "delete", + "description": [ + "\nDeletes an object" ], - "path": "src/core/public/saved_objects/simple_saved_object.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.SimpleSavedObject._version", - "type": "string", - "tags": [], - "label": "_version", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "src/core/public/saved_objects/simple_saved_object.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.SimpleSavedObject.id", - "type": "string", - "tags": [], - "label": "id", - "description": [], - "path": "src/core/public/saved_objects/simple_saved_object.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.SimpleSavedObject.type", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "path": "src/core/public/saved_objects/simple_saved_object.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.SimpleSavedObject.migrationVersion", - "type": "Object", - "tags": [], - "label": "migrationVersion", - "description": [], - "signature": [ - "SavedObjectsMigrationVersion", - " | undefined" - ], - "path": "src/core/public/saved_objects/simple_saved_object.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.SimpleSavedObject.coreMigrationVersion", - "type": "string", - "tags": [], - "label": "coreMigrationVersion", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "src/core/public/saved_objects/simple_saved_object.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.SimpleSavedObject.error", - "type": "Object", - "tags": [], - "label": "error", - "description": [], - "signature": [ - "SavedObjectError", - " | undefined" - ], - "path": "src/core/public/saved_objects/simple_saved_object.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.SimpleSavedObject.references", - "type": "Array", - "tags": [], - "label": "references", - "description": [], - "signature": [ - "SavedObjectReference", - "[]" - ], - "path": "src/core/public/saved_objects/simple_saved_object.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.SimpleSavedObject.updatedAt", - "type": "string", - "tags": [], - "label": "updatedAt", - "description": [], "signature": [ - "string | undefined" - ], - "path": "src/core/public/saved_objects/simple_saved_object.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.SimpleSavedObject.namespaces", - "type": "Array", - "tags": [], - "label": "namespaces", - "description": [ - "\nSpace(s) that this saved object exists in. This attribute is not used for \"global\" saved object types which are registered with\n`namespaceType: 'agnostic'`." - ], - "signature": [ - "string[] | undefined" - ], - "path": "src/core/public/saved_objects/simple_saved_object.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.SimpleSavedObject.Unnamed", - "type": "Function", - "tags": [], - "label": "Constructor", - "description": [], - "signature": [ - "any" + "(type: string, id: string, options?: ", + "SavedObjectsDeleteOptions", + " | undefined) => Promise<{}>" ], - "path": "src/core/public/saved_objects/simple_saved_object.ts", + "path": "src/core/public/saved_objects/saved_objects_client.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.SimpleSavedObject.Unnamed.$1", - "type": "Object", + "id": "def-public.SavedObjectsClientContract.delete.$1", + "type": "string", "tags": [], - "label": "client", + "label": "type", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsClientContract", - "text": "SavedObjectsClientContract" - } + "string" ], - "path": "src/core/public/saved_objects/simple_saved_object.ts", + "path": "src/core/public/saved_objects/saved_objects_client.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "core", - "id": "def-public.SimpleSavedObject.Unnamed.$2", - "type": "Object", + "id": "def-public.SavedObjectsClientContract.delete.$2", + "type": "string", "tags": [], - "label": "{\n id,\n type,\n version,\n attributes,\n error,\n references,\n migrationVersion,\n coreMigrationVersion,\n namespaces,\n updated_at: updatedAt,\n }", + "label": "id", "description": [], "signature": [ - "SavedObject", - "" + "string" ], - "path": "src/core/public/saved_objects/simple_saved_object.ts", + "path": "src/core/public/saved_objects/saved_objects_client.ts", "deprecated": false, "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsClientContract.delete.$3", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "SavedObjectsDeleteOptions", + " | undefined" + ], + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "deprecated": false, + "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "core", - "id": "def-public.SimpleSavedObject.get", + "id": "def-public.SavedObjectsClientContract.find", "type": "Function", - "tags": [], - "label": "get", - "description": [], + "tags": [ + "property", + "property", + "property", + "property", + "property", + "property", + "property" + ], + "label": "find", + "description": [ + "\nSearch for objects\n" + ], "signature": [ - "(key: string) => any" + "(options: SavedObjectsFindOptions) => Promise<", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SavedObjectsFindResponsePublic", + "text": "SavedObjectsFindResponsePublic" + }, + ">" ], - "path": "src/core/public/saved_objects/simple_saved_object.ts", + "path": "src/core/public/saved_objects/saved_objects_client.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.SimpleSavedObject.get.$1", - "type": "string", + "id": "def-public.SavedObjectsClientContract.find.$1", + "type": "Object", "tags": [], - "label": "key", + "label": "options", "description": [], "signature": [ - "string" + "SavedObjectsFindOptions" ], - "path": "src/core/public/saved_objects/simple_saved_object.ts", + "path": "src/core/public/saved_objects/saved_objects_client.ts", "deprecated": false, "isRequired": true } ], - "returnComment": [] + "returnComment": [ + "A find result with objects matching the specified search." + ] }, { "parentPluginId": "core", - "id": "def-public.SimpleSavedObject.set", + "id": "def-public.SavedObjectsClientContract.get", "type": "Function", "tags": [], - "label": "set", - "description": [], + "label": "get", + "description": [ + "\nFetches a single object\n" + ], "signature": [ - "(key: string, value: any) => T" + "(type: string, id: string) => Promise<", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SimpleSavedObject", + "text": "SimpleSavedObject" + }, + ">" ], - "path": "src/core/public/saved_objects/simple_saved_object.ts", + "path": "src/core/public/saved_objects/saved_objects_client.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.SimpleSavedObject.set.$1", + "id": "def-public.SavedObjectsClientContract.get.$1", "type": "string", "tags": [], - "label": "key", + "label": "type", "description": [], "signature": [ "string" ], - "path": "src/core/public/saved_objects/simple_saved_object.ts", + "path": "src/core/public/saved_objects/saved_objects_client.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "core", - "id": "def-public.SimpleSavedObject.set.$2", - "type": "Any", + "id": "def-public.SavedObjectsClientContract.get.$2", + "type": "string", "tags": [], - "label": "value", + "label": "id", "description": [], "signature": [ - "any" + "string" ], - "path": "src/core/public/saved_objects/simple_saved_object.ts", + "path": "src/core/public/saved_objects/saved_objects_client.ts", "deprecated": false, "isRequired": true } ], - "returnComment": [] + "returnComment": [ + "The saved object for the given type and id." + ] }, { "parentPluginId": "core", - "id": "def-public.SimpleSavedObject.has", + "id": "def-public.SavedObjectsClientContract.bulkGet", "type": "Function", "tags": [], - "label": "has", - "description": [], - "signature": [ - "(key: string) => boolean" + "label": "bulkGet", + "description": [ + "\nReturns an array of objects by id\n" ], - "path": "src/core/public/saved_objects/simple_saved_object.ts", + "signature": [ + "(objects: { id: string; type: string; }[]) => Promise<", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SavedObjectsBatchResponse", + "text": "SavedObjectsBatchResponse" + }, + ">" + ], + "path": "src/core/public/saved_objects/saved_objects_client.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.SimpleSavedObject.has.$1", - "type": "string", + "id": "def-public.SavedObjectsClientContract.bulkGet.$1", + "type": "Array", "tags": [], - "label": "key", - "description": [], + "label": "objects", + "description": [ + "- an array ids, or an array of objects containing id and optionally type" + ], "signature": [ - "string" + "{ id: string; type: string; }[]" ], - "path": "src/core/public/saved_objects/simple_saved_object.ts", + "path": "src/core/public/saved_objects/saved_objects_client.ts", "deprecated": false, "isRequired": true } ], - "returnComment": [] + "returnComment": [ + "The saved objects with the given type and ids requested" + ] }, { "parentPluginId": "core", - "id": "def-public.SimpleSavedObject.save", + "id": "def-public.SavedObjectsClientContract.resolve", "type": "Function", - "tags": [], - "label": "save", - "description": [], + "tags": [ + "note" + ], + "label": "resolve", + "description": [ + "\nResolves a single object\n" + ], "signature": [ - "() => Promise<", + "(type: string, id: string) => Promise<", { "pluginId": "core", "scope": "public", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SimpleSavedObject", - "text": "SimpleSavedObject" + "section": "def-public.ResolvedSimpleSavedObject", + "text": "ResolvedSimpleSavedObject" }, ">" ], - "path": "src/core/public/saved_objects/simple_saved_object.ts", + "path": "src/core/public/saved_objects/saved_objects_client.ts", "deprecated": false, - "children": [], - "returnComment": [] + "children": [ + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsClientContract.resolve.$1", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "string" + ], + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsClientContract.resolve.$2", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "string" + ], + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [ + "The resolve result for the saved object for the given type and id." + ] }, { "parentPluginId": "core", - "id": "def-public.SimpleSavedObject.delete", + "id": "def-public.SavedObjectsClientContract.bulkResolve", "type": "Function", - "tags": [], - "label": "delete", - "description": [], - "signature": [ - "() => Promise<{}>" + "tags": [ + "note" ], - "path": "src/core/public/saved_objects/simple_saved_object.ts", - "deprecated": false, - "children": [], - "returnComment": [] - } - ], - "initialIsOpen": false - } - ], - "functions": [], - "interfaces": [ - { - "parentPluginId": "core", - "id": "def-public.ResolvedSimpleSavedObject", - "type": "Interface", - "tags": [], - "label": "ResolvedSimpleSavedObject", - "description": [ - "\nThis interface is a very simple wrapper for SavedObjects resolved from the server\nwith the {@link SavedObjectsClient}.\n" - ], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.ResolvedSimpleSavedObject", - "text": "ResolvedSimpleSavedObject" - }, - "" - ], - "path": "src/core/public/saved_objects/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.ResolvedSimpleSavedObject.saved_object", - "type": "Object", - "tags": [], - "label": "saved_object", + "label": "bulkResolve", "description": [ - "\nThe saved object that was found." + "\nResolves an array of objects by id, using any legacy URL aliases if they exist\n" ], "signature": [ + "(objects: { id: string; type: string; }[]) => Promise<", { "pluginId": "core", "scope": "public", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SimpleSavedObject", - "text": "SimpleSavedObject" + "section": "def-public.SavedObjectsBulkResolveResponse", + "text": "SavedObjectsBulkResolveResponse" }, - "" - ], - "path": "src/core/public/saved_objects/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.ResolvedSimpleSavedObject.outcome", - "type": "CompoundType", - "tags": [], - "label": "outcome", - "description": [ - "\nThe outcome for a successful `resolve` call is one of the following values:\n\n * `'exactMatch'` -- One document exactly matched the given ID.\n * `'aliasMatch'` -- One document with a legacy URL alias matched the given ID; in this case the `saved_object.id` field is different\n than the given ID.\n * `'conflict'` -- Two documents matched the given ID, one was an exact match and another with a legacy URL alias; in this case the\n `saved_object` object is the exact match, and the `saved_object.id` field is the same as the given ID." + ">" ], - "signature": [ - "\"exactMatch\" | \"aliasMatch\" | \"conflict\"" + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsClientContract.bulkResolve.$1", + "type": "Array", + "tags": [], + "label": "objects", + "description": [ + "- an array of objects containing id, type" + ], + "signature": [ + "{ id: string; type: string; }[]" + ], + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "deprecated": false, + "isRequired": true + } ], - "path": "src/core/public/saved_objects/types.ts", - "deprecated": false + "returnComment": [ + "The bulk resolve result for the saved objects for the given types and ids." + ] }, { "parentPluginId": "core", - "id": "def-public.ResolvedSimpleSavedObject.alias_target_id", - "type": "string", - "tags": [], - "label": "alias_target_id", - "description": [ - "\nThe ID of the object that the legacy URL alias points to.\n\n**Note:** this field is *only* included when an alias was found (in other words, when the outcome is `'aliasMatch'` or `'conflict'`)." - ], - "signature": [ - "string | undefined" + "id": "def-public.SavedObjectsClientContract.update", + "type": "Function", + "tags": [ + "prop", + "prop" ], - "path": "src/core/public/saved_objects/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.ResolvedSimpleSavedObject.alias_purpose", - "type": "CompoundType", - "tags": [], - "label": "alias_purpose", + "label": "update", "description": [ - "\nThe reason this alias was created.\n\nCurrently this is used to determine whether or not a toast should be shown when a user is redirected from a legacy URL; if the alias\nwas created because of saved object conversion, then we will display a toast telling the user that the object has a new URL.\n\n**Note:** this field is *only* included when an alias was found (in other words, when the outcome is `'aliasMatch'` or `'conflict'`)." - ], - "signature": [ - "\"savedObjectConversion\" | \"savedObjectImport\" | undefined" + "\nUpdates an object\n" ], - "path": "src/core/public/saved_objects/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsBatchResponse", - "type": "Interface", - "tags": [], - "label": "SavedObjectsBatchResponse", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsBatchResponse", - "text": "SavedObjectsBatchResponse" - }, - "" - ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsBatchResponse.savedObjects", - "type": "Array", - "tags": [], - "label": "savedObjects", - "description": [], "signature": [ + "(type: string, id: string, attributes: T, options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SavedObjectsUpdateOptions", + "text": "SavedObjectsUpdateOptions" + }, + " | undefined) => Promise<", { "pluginId": "core", "scope": "public", @@ -1141,155 +1247,204 @@ "section": "def-public.SimpleSavedObject", "text": "SimpleSavedObject" }, - "[]" + ">" ], "path": "src/core/public/saved_objects/saved_objects_client.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsBulkCreateObject", - "type": "Interface", - "tags": [], - "label": "SavedObjectsBulkCreateObject", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsBulkCreateObject", - "text": "SavedObjectsBulkCreateObject" - }, - " extends ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsCreateOptions", - "text": "SavedObjectsCreateOptions" - } - ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsBulkCreateObject.type", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsClientContract.update.$1", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "string" + ], + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsClientContract.update.$2", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "string" + ], + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsClientContract.update.$3", + "type": "Uncategorized", + "tags": [], + "label": "attributes", + "description": [], + "signature": [ + "T" + ], + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsClientContract.update.$4", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SavedObjectsUpdateOptions", + "text": "SavedObjectsUpdateOptions" + }, + " | undefined" + ], + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsBulkCreateObject.attributes", - "type": "Uncategorized", + "id": "def-public.SavedObjectsClientContract.bulkUpdate", + "type": "Function", "tags": [], - "label": "attributes", - "description": [], + "label": "bulkUpdate", + "description": [ + "\nUpdate multiple documents at once\n" + ], "signature": [ - "T" + "(objects: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SavedObjectsBulkUpdateObject", + "text": "SavedObjectsBulkUpdateObject" + }, + "[]) => Promise<", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SavedObjectsBatchResponse", + "text": "SavedObjectsBatchResponse" + }, + ">" ], "path": "src/core/public/saved_objects/saved_objects_client.ts", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsClientContract.bulkUpdate.$1", + "type": "Array", + "tags": [], + "label": "objects", + "description": [ + "- [{ type, id, attributes, options: { version, references } }]" + ], + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SavedObjectsBulkUpdateObject", + "text": "SavedObjectsBulkUpdateObject" + }, + "[]" + ], + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [ + "The result of the update operation containing both failed and updated saved objects." + ] } ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsBulkCreateOptions", + "id": "def-public.SavedObjectsCreateOptions", "type": "Interface", "tags": [], - "label": "SavedObjectsBulkCreateOptions", + "label": "SavedObjectsCreateOptions", "description": [], "path": "src/core/public/saved_objects/saved_objects_client.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.SavedObjectsBulkCreateOptions.overwrite", - "type": "CompoundType", + "id": "def-public.SavedObjectsCreateOptions.id", + "type": "string", "tags": [], - "label": "overwrite", + "label": "id", "description": [ - "If a document with the given `id` already exists, overwrite it's contents (default=false)." + "\n(Not recommended) Specify an id instead of having the saved objects service generate one for you." ], "signature": [ - "boolean | undefined" + "string | undefined" ], "path": "src/core/public/saved_objects/saved_objects_client.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsBulkUpdateObject", - "type": "Interface", - "tags": [], - "label": "SavedObjectsBulkUpdateObject", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsBulkUpdateObject", - "text": "SavedObjectsBulkUpdateObject" - }, - "" - ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsBulkUpdateObject.type", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsBulkUpdateObject.id", - "type": "string", + "id": "def-public.SavedObjectsCreateOptions.overwrite", + "type": "CompoundType", "tags": [], - "label": "id", - "description": [], + "label": "overwrite", + "description": [ + "If a document with the given `id` already exists, overwrite it's contents (default=false)." + ], + "signature": [ + "boolean | undefined" + ], "path": "src/core/public/saved_objects/saved_objects_client.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsBulkUpdateObject.attributes", - "type": "Uncategorized", + "id": "def-public.SavedObjectsCreateOptions.migrationVersion", + "type": "Object", "tags": [], - "label": "attributes", - "description": [], + "label": "migrationVersion", + "description": [ + "{@inheritDoc SavedObjectsMigrationVersion}" + ], "signature": [ - "T" + "SavedObjectsMigrationVersion", + " | undefined" ], "path": "src/core/public/saved_objects/saved_objects_client.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsBulkUpdateObject.version", + "id": "def-public.SavedObjectsCreateOptions.coreMigrationVersion", "type": "string", "tags": [], - "label": "version", - "description": [], + "label": "coreMigrationVersion", + "description": [ + "A semver value that is used when upgrading objects between Kibana versions." + ], "signature": [ "string | undefined" ], @@ -1298,7 +1453,7 @@ }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsBulkUpdateObject.references", + "id": "def-public.SavedObjectsCreateOptions.references", "type": "Array", "tags": [], "label": "references", @@ -1315,145 +1470,31 @@ }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsBulkUpdateOptions", + "id": "def-public.SavedObjectsFindResponsePublic", "type": "Interface", "tags": [], - "label": "SavedObjectsBulkUpdateOptions", - "description": [], - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsBulkUpdateOptions.namespace", - "type": "string", - "tags": [], - "label": "namespace", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsCreateOptions", - "type": "Interface", - "tags": [], - "label": "SavedObjectsCreateOptions", - "description": [], - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsCreateOptions.id", - "type": "string", - "tags": [], - "label": "id", - "description": [ - "\n(Not recommended) Specify an id instead of having the saved objects service generate one for you." - ], - "signature": [ - "string | undefined" - ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsCreateOptions.overwrite", - "type": "CompoundType", - "tags": [], - "label": "overwrite", - "description": [ - "If a document with the given `id` already exists, overwrite it's contents (default=false)." - ], - "signature": [ - "boolean | undefined" - ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsCreateOptions.migrationVersion", - "type": "Object", - "tags": [], - "label": "migrationVersion", - "description": [ - "{@inheritDoc SavedObjectsMigrationVersion}" - ], - "signature": [ - "SavedObjectsMigrationVersion", - " | undefined" - ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsCreateOptions.coreMigrationVersion", - "type": "string", - "tags": [], - "label": "coreMigrationVersion", - "description": [ - "A semver value that is used when upgrading objects between Kibana versions." - ], - "signature": [ - "string | undefined" - ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsCreateOptions.references", - "type": "Array", - "tags": [], - "label": "references", - "description": [], - "signature": [ - "SavedObjectReference", - "[] | undefined" - ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsFindResponsePublic", - "type": "Interface", - "tags": [], - "label": "SavedObjectsFindResponsePublic", - "description": [ - "\nReturn type of the Saved Objects `find()` method.\n\n*Note*: this type is different between the Public and Server Saved Objects\nclients.\n" - ], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsFindResponsePublic", - "text": "SavedObjectsFindResponsePublic" - }, - " extends ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsBatchResponse", - "text": "SavedObjectsBatchResponse" - }, - "" - ], + "label": "SavedObjectsFindResponsePublic", + "description": [ + "\nReturn type of the Saved Objects `find()` method.\n\n*Note*: this type is different between the Public and Server Saved Objects\nclients.\n" + ], + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SavedObjectsFindResponsePublic", + "text": "SavedObjectsFindResponsePublic" + }, + " extends ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SavedObjectsBatchResponse", + "text": "SavedObjectsBatchResponse" + }, + "" + ], "path": "src/core/public/saved_objects/saved_objects_client.ts", "deprecated": false, "children": [ @@ -1520,124 +1561,16 @@ "tags": [], "label": "client", "description": [ - "{@link SavedObjectsClient}" + "{@link SavedObjectsClientContract}" ], "signature": [ - "{ create: (type: string, attributes: T, options?: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsCreateOptions", - "text": "SavedObjectsCreateOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SimpleSavedObject", - "text": "SimpleSavedObject" - }, - ">; bulkCreate: (objects?: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsBulkCreateObject", - "text": "SavedObjectsBulkCreateObject" - }, - "[], options?: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsBulkCreateOptions", - "text": "SavedObjectsBulkCreateOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsBatchResponse", - "text": "SavedObjectsBatchResponse" - }, - ">; delete: (type: string, id: string, options?: ", - "SavedObjectsDeleteOptions", - " | undefined) => Promise<{}>; find: (options: SavedObjectsFindOptions) => Promise<", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsFindResponsePublic", - "text": "SavedObjectsFindResponsePublic" - }, - ">; bulkGet: (objects?: { id: string; type: string; }[]) => Promise<", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsBatchResponse", - "text": "SavedObjectsBatchResponse" - }, - ">; bulkResolve: (objects?: { id: string; type: string; }[]) => Promise<{ resolved_objects: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.ResolvedSimpleSavedObject", - "text": "ResolvedSimpleSavedObject" - }, - "[]; }>; get: (type: string, id: string) => Promise<", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SimpleSavedObject", - "text": "SimpleSavedObject" - }, - ">; resolve: (type: string, id: string) => Promise<", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.ResolvedSimpleSavedObject", - "text": "ResolvedSimpleSavedObject" - }, - ">; update: (type: string, id: string, attributes: T, { version, references, upsert }?: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsUpdateOptions", - "text": "SavedObjectsUpdateOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SimpleSavedObject", - "text": "SimpleSavedObject" - }, - ">; bulkUpdate: (objects?: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsBulkUpdateObject", - "text": "SavedObjectsBulkUpdateObject" - }, - "[]) => Promise<", { "pluginId": "core", "scope": "public", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsBatchResponse", - "text": "SavedObjectsBatchResponse" - }, - ">; }" + "section": "def-public.SavedObjectsClientContract", + "text": "SavedObjectsClientContract" + } ], "path": "src/core/public/saved_objects/saved_objects_service.ts", "deprecated": false @@ -1710,154 +1643,23 @@ } ], "enums": [], - "misc": [ + "misc": [], + "objects": [] + }, + "server": { + "classes": [ { "parentPluginId": "core", - "id": "def-public.SavedObjectsClientContract", - "type": "Type", + "id": "def-server.SavedObjectsClient", + "type": "Class", "tags": [], - "label": "SavedObjectsClientContract", + "label": "SavedObjectsClient", "description": [ - "\nSavedObjectsClientContract as implemented by the {@link SavedObjectsClient}\n" + "\n" ], - "signature": [ - "{ create: (type: string, attributes: T, options?: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsCreateOptions", - "text": "SavedObjectsCreateOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SimpleSavedObject", - "text": "SimpleSavedObject" - }, - ">; bulkCreate: (objects?: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsBulkCreateObject", - "text": "SavedObjectsBulkCreateObject" - }, - "[], options?: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsBulkCreateOptions", - "text": "SavedObjectsBulkCreateOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsBatchResponse", - "text": "SavedObjectsBatchResponse" - }, - ">; delete: (type: string, id: string, options?: ", - "SavedObjectsDeleteOptions", - " | undefined) => Promise<{}>; find: (options: SavedObjectsFindOptions) => Promise<", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsFindResponsePublic", - "text": "SavedObjectsFindResponsePublic" - }, - ">; bulkGet: (objects?: { id: string; type: string; }[]) => Promise<", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsBatchResponse", - "text": "SavedObjectsBatchResponse" - }, - ">; bulkResolve: (objects?: { id: string; type: string; }[]) => Promise<{ resolved_objects: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.ResolvedSimpleSavedObject", - "text": "ResolvedSimpleSavedObject" - }, - "[]; }>; get: (type: string, id: string) => Promise<", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SimpleSavedObject", - "text": "SimpleSavedObject" - }, - ">; resolve: (type: string, id: string) => Promise<", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.ResolvedSimpleSavedObject", - "text": "ResolvedSimpleSavedObject" - }, - ">; update: (type: string, id: string, attributes: T, { version, references, upsert }?: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsUpdateOptions", - "text": "SavedObjectsUpdateOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SimpleSavedObject", - "text": "SimpleSavedObject" - }, - ">; bulkUpdate: (objects?: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsBulkUpdateObject", - "text": "SavedObjectsBulkUpdateObject" - }, - "[]) => Promise<", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsBatchResponse", - "text": "SavedObjectsBatchResponse" - }, - ">; }" - ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "deprecated": false, - "initialIsOpen": false - } - ], - "objects": [] - }, - "server": { - "classes": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsClient", - "type": "Class", - "tags": [], - "label": "SavedObjectsClient", - "description": [ - "\n" - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false, - "children": [ + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "deprecated": false, + "children": [ { "parentPluginId": "core", "id": "def-server.SavedObjectsClient.errors", @@ -4402,2168 +4204,276 @@ "deprecated": false, "children": [ { - "parentPluginId": "core", - "id": "def-server.SavedObjectsErrorHelpers.isGeneralError.$1", - "type": "CompoundType", - "tags": [], - "label": "error", - "description": [], - "signature": [ - "Error | ", - "DecoratedError" - ], - "path": "src/core/server/saved_objects/service/lib/errors.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsErrorHelpers.createGenericNotFoundEsUnavailableError", - "type": "Function", - "tags": [], - "label": "createGenericNotFoundEsUnavailableError", - "description": [], - "signature": [ - "(type?: string | null, id?: string | null) => ", - "DecoratedError" - ], - "path": "src/core/server/saved_objects/service/lib/errors.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsErrorHelpers.createGenericNotFoundEsUnavailableError.$1", - "type": "CompoundType", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "string | null" - ], - "path": "src/core/server/saved_objects/service/lib/errors.ts", - "deprecated": false, - "isRequired": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsErrorHelpers.createGenericNotFoundEsUnavailableError.$2", - "type": "CompoundType", - "tags": [], - "label": "id", - "description": [], - "signature": [ - "string | null" - ], - "path": "src/core/server/saved_objects/service/lib/errors.ts", - "deprecated": false, - "isRequired": false - } - ], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsExporter", - "type": "Class", - "tags": [], - "label": "SavedObjectsExporter", - "description": [], - "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsExporter.savedObjectsClient", - "type": "Object", - "tags": [], - "label": "#savedObjectsClient", - "description": [], - "signature": [ - "{ create: (type: string, attributes: T, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreateOptions", - "text": "SavedObjectsCreateOptions" - }, - " | undefined) => Promise<", - "SavedObject", - ">; bulkCreate: (objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkCreateObject", - "text": "SavedObjectsBulkCreateObject" - }, - "[], options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreateOptions", - "text": "SavedObjectsCreateOptions" - }, - " | undefined) => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkResponse", - "text": "SavedObjectsBulkResponse" - }, - ">; checkConflicts: (objects?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCheckConflictsObject", - "text": "SavedObjectsCheckConflictsObject" - }, - "[], options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCheckConflictsResponse", - "text": "SavedObjectsCheckConflictsResponse" - }, - ">; delete: (type: string, id: string, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsDeleteOptions", - "text": "SavedObjectsDeleteOptions" - }, - ") => Promise<{}>; find: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsFindOptions", - "text": "SavedObjectsFindOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsFindResponse", - "text": "SavedObjectsFindResponse" - }, - ">; bulkGet: (objects?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkGetObject", - "text": "SavedObjectsBulkGetObject" - }, - "[], options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkResponse", - "text": "SavedObjectsBulkResponse" - }, - ">; bulkResolve: (objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkResolveObject", - "text": "SavedObjectsBulkResolveObject" - }, - "[], options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - " | undefined) => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkResolveResponse", - "text": "SavedObjectsBulkResolveResponse" - }, - ">; get: (type: string, id: string, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - ") => Promise<", - "SavedObject", - ">; resolve: (type: string, id: string, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsResolveResponse", - "text": "SavedObjectsResolveResponse" - }, - ">; update: (type: string, id: string, attributes: Partial, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateOptions", - "text": "SavedObjectsUpdateOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateResponse", - "text": "SavedObjectsUpdateResponse" - }, - ">; collectMultiNamespaceReferences: (objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesObject", - "text": "SavedObjectsCollectMultiNamespaceReferencesObject" - }, - "[], options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesOptions", - "text": "SavedObjectsCollectMultiNamespaceReferencesOptions" - }, - " | undefined) => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesResponse", - "text": "SavedObjectsCollectMultiNamespaceReferencesResponse" - }, - ">; updateObjectsSpaces: (objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateObjectsSpacesObject", - "text": "SavedObjectsUpdateObjectsSpacesObject" - }, - "[], spacesToAdd: string[], spacesToRemove: string[], options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateObjectsSpacesOptions", - "text": "SavedObjectsUpdateObjectsSpacesOptions" - }, - " | undefined) => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateObjectsSpacesResponse", - "text": "SavedObjectsUpdateObjectsSpacesResponse" - }, - ">; bulkUpdate: (objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateObject", - "text": "SavedObjectsBulkUpdateObject" - }, - "[], options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateOptions", - "text": "SavedObjectsBulkUpdateOptions" - }, - " | undefined) => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateResponse", - "text": "SavedObjectsBulkUpdateResponse" - }, - ">; removeReferencesTo: (type: string, id: string, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsRemoveReferencesToOptions", - "text": "SavedObjectsRemoveReferencesToOptions" - }, - " | undefined) => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsRemoveReferencesToResponse", - "text": "SavedObjectsRemoveReferencesToResponse" - }, - ">; openPointInTimeForType: (type: string | string[], options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsOpenPointInTimeOptions", - "text": "SavedObjectsOpenPointInTimeOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsOpenPointInTimeResponse", - "text": "SavedObjectsOpenPointInTimeResponse" - }, - ">; closePointInTime: (id: string, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - " | undefined) => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClosePointInTimeResponse", - "text": "SavedObjectsClosePointInTimeResponse" - }, - ">; createPointInTimeFinder: (findOptions: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreatePointInTimeFinderOptions", - "text": "SavedObjectsCreatePointInTimeFinderOptions" - }, - ", dependencies?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreatePointInTimeFinderDependencies", - "text": "SavedObjectsCreatePointInTimeFinderDependencies" - }, - " | undefined) => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.ISavedObjectsPointInTimeFinder", - "text": "ISavedObjectsPointInTimeFinder" - }, - "; errors: typeof ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsErrorHelpers", - "text": "SavedObjectsErrorHelpers" - }, - "; }" - ], - "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsExporter.exportSizeLimit", - "type": "number", - "tags": [], - "label": "#exportSizeLimit", - "description": [], - "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsExporter.typeRegistry", - "type": "Object", - "tags": [], - "label": "#typeRegistry", - "description": [], - "signature": [ - "{ getType: (type: string) => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsType", - "text": "SavedObjectsType" - }, - " | undefined; getVisibleTypes: () => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsType", - "text": "SavedObjectsType" - }, - "[]; getAllTypes: () => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsType", - "text": "SavedObjectsType" - }, - "[]; getImportableAndExportableTypes: () => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsType", - "text": "SavedObjectsType" - }, - "[]; isNamespaceAgnostic: (type: string) => boolean; isSingleNamespace: (type: string) => boolean; isMultiNamespace: (type: string) => boolean; isShareable: (type: string) => boolean; isHidden: (type: string) => boolean; getIndex: (type: string) => string | undefined; isImportableAndExportable: (type: string) => boolean; }" - ], - "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsExporter.log", - "type": "Object", - "tags": [], - "label": "#log", - "description": [], - "signature": [ - "Logger" - ], - "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsExporter.Unnamed", - "type": "Function", - "tags": [], - "label": "Constructor", - "description": [], - "signature": [ - "any" - ], - "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsExporter.Unnamed.$1", - "type": "Object", - "tags": [], - "label": "{\n savedObjectsClient,\n typeRegistry,\n exportSizeLimit,\n logger,\n }", - "description": [], - "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsExporter.Unnamed.$1.savedObjectsClient", - "type": "Object", - "tags": [], - "label": "savedObjectsClient", - "description": [], - "signature": [ - "{ create: (type: string, attributes: T, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreateOptions", - "text": "SavedObjectsCreateOptions" - }, - " | undefined) => Promise<", - "SavedObject", - ">; bulkCreate: (objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkCreateObject", - "text": "SavedObjectsBulkCreateObject" - }, - "[], options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreateOptions", - "text": "SavedObjectsCreateOptions" - }, - " | undefined) => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkResponse", - "text": "SavedObjectsBulkResponse" - }, - ">; checkConflicts: (objects?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCheckConflictsObject", - "text": "SavedObjectsCheckConflictsObject" - }, - "[], options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCheckConflictsResponse", - "text": "SavedObjectsCheckConflictsResponse" - }, - ">; delete: (type: string, id: string, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsDeleteOptions", - "text": "SavedObjectsDeleteOptions" - }, - ") => Promise<{}>; find: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsFindOptions", - "text": "SavedObjectsFindOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsFindResponse", - "text": "SavedObjectsFindResponse" - }, - ">; bulkGet: (objects?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkGetObject", - "text": "SavedObjectsBulkGetObject" - }, - "[], options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkResponse", - "text": "SavedObjectsBulkResponse" - }, - ">; bulkResolve: (objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkResolveObject", - "text": "SavedObjectsBulkResolveObject" - }, - "[], options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - " | undefined) => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkResolveResponse", - "text": "SavedObjectsBulkResolveResponse" - }, - ">; get: (type: string, id: string, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - ") => Promise<", - "SavedObject", - ">; resolve: (type: string, id: string, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsResolveResponse", - "text": "SavedObjectsResolveResponse" - }, - ">; update: (type: string, id: string, attributes: Partial, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateOptions", - "text": "SavedObjectsUpdateOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateResponse", - "text": "SavedObjectsUpdateResponse" - }, - ">; collectMultiNamespaceReferences: (objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesObject", - "text": "SavedObjectsCollectMultiNamespaceReferencesObject" - }, - "[], options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesOptions", - "text": "SavedObjectsCollectMultiNamespaceReferencesOptions" - }, - " | undefined) => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesResponse", - "text": "SavedObjectsCollectMultiNamespaceReferencesResponse" - }, - ">; updateObjectsSpaces: (objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateObjectsSpacesObject", - "text": "SavedObjectsUpdateObjectsSpacesObject" - }, - "[], spacesToAdd: string[], spacesToRemove: string[], options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateObjectsSpacesOptions", - "text": "SavedObjectsUpdateObjectsSpacesOptions" - }, - " | undefined) => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateObjectsSpacesResponse", - "text": "SavedObjectsUpdateObjectsSpacesResponse" - }, - ">; bulkUpdate: (objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateObject", - "text": "SavedObjectsBulkUpdateObject" - }, - "[], options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateOptions", - "text": "SavedObjectsBulkUpdateOptions" - }, - " | undefined) => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateResponse", - "text": "SavedObjectsBulkUpdateResponse" - }, - ">; removeReferencesTo: (type: string, id: string, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsRemoveReferencesToOptions", - "text": "SavedObjectsRemoveReferencesToOptions" - }, - " | undefined) => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsRemoveReferencesToResponse", - "text": "SavedObjectsRemoveReferencesToResponse" - }, - ">; openPointInTimeForType: (type: string | string[], options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsOpenPointInTimeOptions", - "text": "SavedObjectsOpenPointInTimeOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsOpenPointInTimeResponse", - "text": "SavedObjectsOpenPointInTimeResponse" - }, - ">; closePointInTime: (id: string, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - " | undefined) => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClosePointInTimeResponse", - "text": "SavedObjectsClosePointInTimeResponse" - }, - ">; createPointInTimeFinder: (findOptions: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreatePointInTimeFinderOptions", - "text": "SavedObjectsCreatePointInTimeFinderOptions" - }, - ", dependencies?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreatePointInTimeFinderDependencies", - "text": "SavedObjectsCreatePointInTimeFinderDependencies" - }, - " | undefined) => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.ISavedObjectsPointInTimeFinder", - "text": "ISavedObjectsPointInTimeFinder" - }, - "; errors: typeof ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsErrorHelpers", - "text": "SavedObjectsErrorHelpers" - }, - "; }" - ], - "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsExporter.Unnamed.$1.typeRegistry", - "type": "Object", - "tags": [], - "label": "typeRegistry", - "description": [], - "signature": [ - "{ getType: (type: string) => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsType", - "text": "SavedObjectsType" - }, - " | undefined; getVisibleTypes: () => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsType", - "text": "SavedObjectsType" - }, - "[]; getAllTypes: () => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsType", - "text": "SavedObjectsType" - }, - "[]; getImportableAndExportableTypes: () => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsType", - "text": "SavedObjectsType" - }, - "[]; isNamespaceAgnostic: (type: string) => boolean; isSingleNamespace: (type: string) => boolean; isMultiNamespace: (type: string) => boolean; isShareable: (type: string) => boolean; isHidden: (type: string) => boolean; getIndex: (type: string) => string | undefined; isImportableAndExportable: (type: string) => boolean; }" - ], - "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsExporter.Unnamed.$1.exportSizeLimit", - "type": "number", - "tags": [], - "label": "exportSizeLimit", - "description": [], - "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsExporter.Unnamed.$1.logger", - "type": "Object", - "tags": [], - "label": "logger", - "description": [], - "signature": [ - "Logger" - ], - "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", - "deprecated": false - } - ] - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsExporter.exportByTypes", - "type": "Function", - "tags": [ - "throws" - ], - "label": "exportByTypes", - "description": [ - "\nGenerates an export stream for given types.\n\nSee the {@link SavedObjectsExportByTypeOptions | options} for more detailed information.\n" - ], - "signature": [ - "(options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsExportByTypeOptions", - "text": "SavedObjectsExportByTypeOptions" - }, - ") => Promise<", - "Readable", - ">" - ], - "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsExporter.exportByTypes.$1", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsExportByTypeOptions", - "text": "SavedObjectsExportByTypeOptions" - } - ], - "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsExporter.exportByObjects", - "type": "Function", - "tags": [ - "throws" - ], - "label": "exportByObjects", - "description": [ - "\nGenerates an export stream for given object references.\n\nSee the {@link SavedObjectsExportByObjectOptions | options} for more detailed information.\n" - ], - "signature": [ - "(options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsExportByObjectOptions", - "text": "SavedObjectsExportByObjectOptions" - }, - ") => Promise<", - "Readable", - ">" - ], - "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsExporter.exportByObjects.$1", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsExportByObjectOptions", - "text": "SavedObjectsExportByObjectOptions" - } - ], - "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsExportError", - "type": "Class", - "tags": [], - "label": "SavedObjectsExportError", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsExportError", - "text": "SavedObjectsExportError" - }, - " extends Error" - ], - "path": "src/core/server/saved_objects/export/errors.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsExportError.Unnamed", - "type": "Function", - "tags": [], - "label": "Constructor", - "description": [], - "signature": [ - "any" - ], - "path": "src/core/server/saved_objects/export/errors.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsExportError.Unnamed.$1", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "string" - ], - "path": "src/core/server/saved_objects/export/errors.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsExportError.Unnamed.$2", - "type": "string", - "tags": [], - "label": "message", - "description": [], - "signature": [ - "string" - ], - "path": "src/core/server/saved_objects/export/errors.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsExportError.Unnamed.$3", - "type": "Object", - "tags": [], - "label": "attributes", - "description": [], - "signature": [ - "Record | undefined" - ], - "path": "src/core/server/saved_objects/export/errors.ts", - "deprecated": false, - "isRequired": false - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsExportError.exportSizeExceeded", - "type": "Function", - "tags": [], - "label": "exportSizeExceeded", - "description": [], - "signature": [ - "(limit: number) => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsExportError", - "text": "SavedObjectsExportError" - } - ], - "path": "src/core/server/saved_objects/export/errors.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsExportError.exportSizeExceeded.$1", - "type": "number", - "tags": [], - "label": "limit", - "description": [], - "signature": [ - "number" - ], - "path": "src/core/server/saved_objects/export/errors.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsExportError.objectFetchError", - "type": "Function", - "tags": [], - "label": "objectFetchError", - "description": [], - "signature": [ - "(objects: ", - "SavedObject", - "[]) => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsExportError", - "text": "SavedObjectsExportError" - } - ], - "path": "src/core/server/saved_objects/export/errors.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsExportError.objectFetchError.$1", - "type": "Array", - "tags": [], - "label": "objects", - "description": [], - "signature": [ - "SavedObject", - "[]" - ], - "path": "src/core/server/saved_objects/export/errors.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsExportError.objectTransformError", - "type": "Function", - "tags": [], - "label": "objectTransformError", - "description": [ - "\nError returned when a {@link SavedObjectsExportTransform | export transform} threw an error" - ], - "signature": [ - "(objects: ", - "SavedObject", - "[], cause: Error) => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsExportError", - "text": "SavedObjectsExportError" - } - ], - "path": "src/core/server/saved_objects/export/errors.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsExportError.objectTransformError.$1", - "type": "Array", - "tags": [], - "label": "objects", - "description": [], - "signature": [ - "SavedObject", - "[]" - ], - "path": "src/core/server/saved_objects/export/errors.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsExportError.objectTransformError.$2", - "type": "Object", - "tags": [], - "label": "cause", - "description": [], - "signature": [ - "Error" - ], - "path": "src/core/server/saved_objects/export/errors.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsExportError.invalidTransformError", - "type": "Function", - "tags": [], - "label": "invalidTransformError", - "description": [ - "\nError returned when a {@link SavedObjectsExportTransform | export transform} performed an invalid operation\nduring the transform, such as removing objects from the export, or changing an object's type or id." - ], - "signature": [ - "(objectKeys: string[]) => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsExportError", - "text": "SavedObjectsExportError" - } - ], - "path": "src/core/server/saved_objects/export/errors.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsExportError.invalidTransformError.$1", - "type": "Array", - "tags": [], - "label": "objectKeys", - "description": [], - "signature": [ - "string[]" - ], - "path": "src/core/server/saved_objects/export/errors.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsImporter", - "type": "Class", - "tags": [], - "label": "SavedObjectsImporter", - "description": [], - "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsImporter.savedObjectsClient", - "type": "Object", - "tags": [], - "label": "#savedObjectsClient", - "description": [], - "signature": [ - "{ create: (type: string, attributes: T, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreateOptions", - "text": "SavedObjectsCreateOptions" - }, - " | undefined) => Promise<", - "SavedObject", - ">; bulkCreate: (objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkCreateObject", - "text": "SavedObjectsBulkCreateObject" - }, - "[], options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreateOptions", - "text": "SavedObjectsCreateOptions" - }, - " | undefined) => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkResponse", - "text": "SavedObjectsBulkResponse" - }, - ">; checkConflicts: (objects?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCheckConflictsObject", - "text": "SavedObjectsCheckConflictsObject" - }, - "[], options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCheckConflictsResponse", - "text": "SavedObjectsCheckConflictsResponse" - }, - ">; delete: (type: string, id: string, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsDeleteOptions", - "text": "SavedObjectsDeleteOptions" - }, - ") => Promise<{}>; find: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsFindOptions", - "text": "SavedObjectsFindOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsFindResponse", - "text": "SavedObjectsFindResponse" - }, - ">; bulkGet: (objects?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkGetObject", - "text": "SavedObjectsBulkGetObject" - }, - "[], options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkResponse", - "text": "SavedObjectsBulkResponse" - }, - ">; bulkResolve: (objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkResolveObject", - "text": "SavedObjectsBulkResolveObject" - }, - "[], options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - " | undefined) => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkResolveResponse", - "text": "SavedObjectsBulkResolveResponse" - }, - ">; get: (type: string, id: string, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - ") => Promise<", - "SavedObject", - ">; resolve: (type: string, id: string, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsResolveResponse", - "text": "SavedObjectsResolveResponse" - }, - ">; update: (type: string, id: string, attributes: Partial, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateOptions", - "text": "SavedObjectsUpdateOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateResponse", - "text": "SavedObjectsUpdateResponse" - }, - ">; collectMultiNamespaceReferences: (objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesObject", - "text": "SavedObjectsCollectMultiNamespaceReferencesObject" - }, - "[], options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesOptions", - "text": "SavedObjectsCollectMultiNamespaceReferencesOptions" - }, - " | undefined) => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesResponse", - "text": "SavedObjectsCollectMultiNamespaceReferencesResponse" - }, - ">; updateObjectsSpaces: (objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateObjectsSpacesObject", - "text": "SavedObjectsUpdateObjectsSpacesObject" - }, - "[], spacesToAdd: string[], spacesToRemove: string[], options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateObjectsSpacesOptions", - "text": "SavedObjectsUpdateObjectsSpacesOptions" - }, - " | undefined) => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateObjectsSpacesResponse", - "text": "SavedObjectsUpdateObjectsSpacesResponse" - }, - ">; bulkUpdate: (objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateObject", - "text": "SavedObjectsBulkUpdateObject" - }, - "[], options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateOptions", - "text": "SavedObjectsBulkUpdateOptions" - }, - " | undefined) => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateResponse", - "text": "SavedObjectsBulkUpdateResponse" - }, - ">; removeReferencesTo: (type: string, id: string, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsRemoveReferencesToOptions", - "text": "SavedObjectsRemoveReferencesToOptions" - }, - " | undefined) => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsRemoveReferencesToResponse", - "text": "SavedObjectsRemoveReferencesToResponse" - }, - ">; openPointInTimeForType: (type: string | string[], options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsOpenPointInTimeOptions", - "text": "SavedObjectsOpenPointInTimeOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsOpenPointInTimeResponse", - "text": "SavedObjectsOpenPointInTimeResponse" - }, - ">; closePointInTime: (id: string, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - " | undefined) => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClosePointInTimeResponse", - "text": "SavedObjectsClosePointInTimeResponse" - }, - ">; createPointInTimeFinder: (findOptions: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreatePointInTimeFinderOptions", - "text": "SavedObjectsCreatePointInTimeFinderOptions" - }, - ", dependencies?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreatePointInTimeFinderDependencies", - "text": "SavedObjectsCreatePointInTimeFinderDependencies" - }, - " | undefined) => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.ISavedObjectsPointInTimeFinder", - "text": "ISavedObjectsPointInTimeFinder" - }, - "; errors: typeof ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsErrorHelpers", - "text": "SavedObjectsErrorHelpers" - }, - "; }" + "parentPluginId": "core", + "id": "def-server.SavedObjectsErrorHelpers.isGeneralError.$1", + "type": "CompoundType", + "tags": [], + "label": "error", + "description": [], + "signature": [ + "Error | ", + "DecoratedError" + ], + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "deprecated": false, + "isRequired": true + } ], - "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", - "deprecated": false + "returnComment": [] }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsImporter.typeRegistry", - "type": "Object", + "id": "def-server.SavedObjectsErrorHelpers.createGenericNotFoundEsUnavailableError", + "type": "Function", "tags": [], - "label": "#typeRegistry", + "label": "createGenericNotFoundEsUnavailableError", "description": [], "signature": [ - "{ getType: (type: string) => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsType", - "text": "SavedObjectsType" - }, - " | undefined; getVisibleTypes: () => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsType", - "text": "SavedObjectsType" - }, - "[]; getAllTypes: () => ", + "(type?: string | null, id?: string | null) => ", + "DecoratedError" + ], + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "deprecated": false, + "children": [ { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsType", - "text": "SavedObjectsType" + "parentPluginId": "core", + "id": "def-server.SavedObjectsErrorHelpers.createGenericNotFoundEsUnavailableError.$1", + "type": "CompoundType", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "string | null" + ], + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "deprecated": false, + "isRequired": false }, - "[]; getImportableAndExportableTypes: () => ", { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsType", - "text": "SavedObjectsType" - }, - "[]; isNamespaceAgnostic: (type: string) => boolean; isSingleNamespace: (type: string) => boolean; isMultiNamespace: (type: string) => boolean; isShareable: (type: string) => boolean; isHidden: (type: string) => boolean; getIndex: (type: string) => string | undefined; isImportableAndExportable: (type: string) => boolean; }" + "parentPluginId": "core", + "id": "def-server.SavedObjectsErrorHelpers.createGenericNotFoundEsUnavailableError.$2", + "type": "CompoundType", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "string | null" + ], + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "deprecated": false, + "isRequired": false + } ], - "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", - "deprecated": false + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsExportError", + "type": "Class", + "tags": [], + "label": "SavedObjectsExportError", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsExportError", + "text": "SavedObjectsExportError" }, + " extends Error" + ], + "path": "src/core/server/saved_objects/export/errors.ts", + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsImporter.importSizeLimit", - "type": "number", + "id": "def-server.SavedObjectsExportError.Unnamed", + "type": "Function", "tags": [], - "label": "#importSizeLimit", + "label": "Constructor", "description": [], - "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", - "deprecated": false + "signature": [ + "any" + ], + "path": "src/core/server/saved_objects/export/errors.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsExportError.Unnamed.$1", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "string" + ], + "path": "src/core/server/saved_objects/export/errors.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsExportError.Unnamed.$2", + "type": "string", + "tags": [], + "label": "message", + "description": [], + "signature": [ + "string" + ], + "path": "src/core/server/saved_objects/export/errors.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsExportError.Unnamed.$3", + "type": "Object", + "tags": [], + "label": "attributes", + "description": [], + "signature": [ + "Record | undefined" + ], + "path": "src/core/server/saved_objects/export/errors.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsImporter.importHooks", - "type": "Object", + "id": "def-server.SavedObjectsExportError.exportSizeExceeded", + "type": "Function", "tags": [], - "label": "#importHooks", + "label": "exportSizeExceeded", "description": [], "signature": [ - "{ [x: string]: ", + "(limit: number) => ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportHook", - "text": "SavedObjectsImportHook" - }, - "[]; }" + "section": "def-server.SavedObjectsExportError", + "text": "SavedObjectsExportError" + } ], - "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", - "deprecated": false + "path": "src/core/server/saved_objects/export/errors.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsExportError.exportSizeExceeded.$1", + "type": "number", + "tags": [], + "label": "limit", + "description": [], + "signature": [ + "number" + ], + "path": "src/core/server/saved_objects/export/errors.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsImporter.Unnamed", + "id": "def-server.SavedObjectsExportError.objectFetchError", "type": "Function", "tags": [], - "label": "Constructor", + "label": "objectFetchError", "description": [], "signature": [ - "any" + "(objects: ", + "SavedObject", + "[]) => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsExportError", + "text": "SavedObjectsExportError" + } ], - "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", + "path": "src/core/server/saved_objects/export/errors.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsImporter.Unnamed.$1", - "type": "Object", + "id": "def-server.SavedObjectsExportError.objectFetchError.$1", + "type": "Array", "tags": [], - "label": "{\n savedObjectsClient,\n typeRegistry,\n importSizeLimit,\n }", + "label": "objects", "description": [], - "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", + "signature": [ + "SavedObject", + "[]" + ], + "path": "src/core/server/saved_objects/export/errors.ts", "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsImporter.Unnamed.$1.savedObjectsClient", - "type": "Object", - "tags": [], - "label": "savedObjectsClient", - "description": [], - "signature": [ - "{ create: (type: string, attributes: T, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreateOptions", - "text": "SavedObjectsCreateOptions" - }, - " | undefined) => Promise<", - "SavedObject", - ">; bulkCreate: (objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkCreateObject", - "text": "SavedObjectsBulkCreateObject" - }, - "[], options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreateOptions", - "text": "SavedObjectsCreateOptions" - }, - " | undefined) => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkResponse", - "text": "SavedObjectsBulkResponse" - }, - ">; checkConflicts: (objects?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCheckConflictsObject", - "text": "SavedObjectsCheckConflictsObject" - }, - "[], options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCheckConflictsResponse", - "text": "SavedObjectsCheckConflictsResponse" - }, - ">; delete: (type: string, id: string, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsDeleteOptions", - "text": "SavedObjectsDeleteOptions" - }, - ") => Promise<{}>; find: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsFindOptions", - "text": "SavedObjectsFindOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsFindResponse", - "text": "SavedObjectsFindResponse" - }, - ">; bulkGet: (objects?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkGetObject", - "text": "SavedObjectsBulkGetObject" - }, - "[], options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkResponse", - "text": "SavedObjectsBulkResponse" - }, - ">; bulkResolve: (objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkResolveObject", - "text": "SavedObjectsBulkResolveObject" - }, - "[], options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - " | undefined) => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkResolveResponse", - "text": "SavedObjectsBulkResolveResponse" - }, - ">; get: (type: string, id: string, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - ") => Promise<", - "SavedObject", - ">; resolve: (type: string, id: string, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsResolveResponse", - "text": "SavedObjectsResolveResponse" - }, - ">; update: (type: string, id: string, attributes: Partial, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateOptions", - "text": "SavedObjectsUpdateOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateResponse", - "text": "SavedObjectsUpdateResponse" - }, - ">; collectMultiNamespaceReferences: (objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesObject", - "text": "SavedObjectsCollectMultiNamespaceReferencesObject" - }, - "[], options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesOptions", - "text": "SavedObjectsCollectMultiNamespaceReferencesOptions" - }, - " | undefined) => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesResponse", - "text": "SavedObjectsCollectMultiNamespaceReferencesResponse" - }, - ">; updateObjectsSpaces: (objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateObjectsSpacesObject", - "text": "SavedObjectsUpdateObjectsSpacesObject" - }, - "[], spacesToAdd: string[], spacesToRemove: string[], options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateObjectsSpacesOptions", - "text": "SavedObjectsUpdateObjectsSpacesOptions" - }, - " | undefined) => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateObjectsSpacesResponse", - "text": "SavedObjectsUpdateObjectsSpacesResponse" - }, - ">; bulkUpdate: (objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateObject", - "text": "SavedObjectsBulkUpdateObject" - }, - "[], options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateOptions", - "text": "SavedObjectsBulkUpdateOptions" - }, - " | undefined) => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateResponse", - "text": "SavedObjectsBulkUpdateResponse" - }, - ">; removeReferencesTo: (type: string, id: string, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsRemoveReferencesToOptions", - "text": "SavedObjectsRemoveReferencesToOptions" - }, - " | undefined) => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsRemoveReferencesToResponse", - "text": "SavedObjectsRemoveReferencesToResponse" - }, - ">; openPointInTimeForType: (type: string | string[], options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsOpenPointInTimeOptions", - "text": "SavedObjectsOpenPointInTimeOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsOpenPointInTimeResponse", - "text": "SavedObjectsOpenPointInTimeResponse" - }, - ">; closePointInTime: (id: string, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - " | undefined) => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClosePointInTimeResponse", - "text": "SavedObjectsClosePointInTimeResponse" - }, - ">; createPointInTimeFinder: (findOptions: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreatePointInTimeFinderOptions", - "text": "SavedObjectsCreatePointInTimeFinderOptions" - }, - ", dependencies?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreatePointInTimeFinderDependencies", - "text": "SavedObjectsCreatePointInTimeFinderDependencies" - }, - " | undefined) => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.ISavedObjectsPointInTimeFinder", - "text": "ISavedObjectsPointInTimeFinder" - }, - "; errors: typeof ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsErrorHelpers", - "text": "SavedObjectsErrorHelpers" - }, - "; }" - ], - "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsImporter.Unnamed.$1.typeRegistry", - "type": "Object", - "tags": [], - "label": "typeRegistry", - "description": [], - "signature": [ - "{ getType: (type: string) => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsType", - "text": "SavedObjectsType" - }, - " | undefined; getVisibleTypes: () => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsType", - "text": "SavedObjectsType" - }, - "[]; getAllTypes: () => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsType", - "text": "SavedObjectsType" - }, - "[]; getImportableAndExportableTypes: () => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsType", - "text": "SavedObjectsType" - }, - "[]; isNamespaceAgnostic: (type: string) => boolean; isSingleNamespace: (type: string) => boolean; isMultiNamespace: (type: string) => boolean; isShareable: (type: string) => boolean; isHidden: (type: string) => boolean; getIndex: (type: string) => string | undefined; isImportableAndExportable: (type: string) => boolean; }" - ], - "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsImporter.Unnamed.$1.importSizeLimit", - "type": "number", - "tags": [], - "label": "importSizeLimit", - "description": [], - "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", - "deprecated": false - } - ] + "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsImporter.import", + "id": "def-server.SavedObjectsExportError.objectTransformError", "type": "Function", - "tags": [ - "throws" - ], - "label": "import", + "tags": [], + "label": "objectTransformError", "description": [ - "\nImport saved objects from given stream. See the {@link SavedObjectsImportOptions | options} for more\ndetailed information.\n" + "\nError returned when a {@link SavedObjectsExportTransform | export transform} threw an error" ], "signature": [ - "({ readStream, createNewCopies, namespace, overwrite, refresh, }: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportOptions", - "text": "SavedObjectsImportOptions" - }, - ") => Promise<", + "(objects: ", + "SavedObject", + "[], cause: Error) => ", { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportResponse", - "text": "SavedObjectsImportResponse" - }, - ">" + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsExportError", + "text": "SavedObjectsExportError" + } ], - "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", + "path": "src/core/server/saved_objects/export/errors.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsImporter.import.$1", + "id": "def-server.SavedObjectsExportError.objectTransformError.$1", + "type": "Array", + "tags": [], + "label": "objects", + "description": [], + "signature": [ + "SavedObject", + "[]" + ], + "path": "src/core/server/saved_objects/export/errors.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsExportError.objectTransformError.$2", "type": "Object", "tags": [], - "label": "{\n readStream,\n createNewCopies,\n namespace,\n overwrite,\n refresh,\n }", + "label": "cause", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportOptions", - "text": "SavedObjectsImportOptions" - } + "Error" ], - "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", + "path": "src/core/server/saved_objects/export/errors.ts", "deprecated": false, "isRequired": true } @@ -6572,54 +4482,37 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsImporter.resolveImportErrors", + "id": "def-server.SavedObjectsExportError.invalidTransformError", "type": "Function", - "tags": [ - "throws" - ], - "label": "resolveImportErrors", + "tags": [], + "label": "invalidTransformError", "description": [ - "\nResolve and return saved object import errors.\nSee the {@link SavedObjectsResolveImportErrorsOptions | options} for more detailed information.\n" + "\nError returned when a {@link SavedObjectsExportTransform | export transform} performed an invalid operation\nduring the transform, such as removing objects from the export, or changing an object's type or id." ], "signature": [ - "({ readStream, createNewCopies, namespace, retries, }: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsResolveImportErrorsOptions", - "text": "SavedObjectsResolveImportErrorsOptions" - }, - ") => Promise<", + "(objectKeys: string[]) => ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportResponse", - "text": "SavedObjectsImportResponse" - }, - ">" + "section": "def-server.SavedObjectsExportError", + "text": "SavedObjectsExportError" + } ], - "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", + "path": "src/core/server/saved_objects/export/errors.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsImporter.resolveImportErrors.$1", - "type": "Object", + "id": "def-server.SavedObjectsExportError.invalidTransformError.$1", + "type": "Array", "tags": [], - "label": "{\n readStream,\n createNewCopies,\n namespace,\n retries,\n }", + "label": "objectKeys", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsResolveImportErrorsOptions", - "text": "SavedObjectsResolveImportErrorsOptions" - } + "string[]" ], - "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", + "path": "src/core/server/saved_objects/export/errors.ts", "deprecated": false, "isRequired": true } @@ -9460,7 +7353,190 @@ "signature": [ "string" ], - "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectTypeRegistry.isImportableAndExportable", + "type": "Function", + "tags": [], + "label": "isImportableAndExportable", + "description": [ + "\nReturns the `management.importableAndExportable` property for given type, or\n`false` if the type is not registered or does not define a management section." + ], + "signature": [ + "(type: string) => boolean" + ], + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectTypeRegistry.isImportableAndExportable.$1", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "string" + ], + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + } + ], + "functions": [ + { + "parentPluginId": "core", + "id": "def-server.mergeSavedObjectMigrationMaps", + "type": "Function", + "tags": [], + "label": "mergeSavedObjectMigrationMaps", + "description": [ + "\nMerges two saved object migration maps.\n\nIf there is a migration for a given version on only one of the maps,\nthat migration function will be used:\n\nmergeSavedObjectMigrationMaps({ '1.2.3': f }, { '4.5.6': g }) -> { '1.2.3': f, '4.5.6': g }\n\nIf there is a migration for a given version on both maps, the migrations will be composed:\n\nmergeSavedObjectMigrationMaps({ '1.2.3': f }, { '1.2.3': g }) -> { '1.2.3': (doc, context) => f(g(doc, context), context) }\n" + ], + "signature": [ + "(map1: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectMigrationMap", + "text": "SavedObjectMigrationMap" + }, + ", map2: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectMigrationMap", + "text": "SavedObjectMigrationMap" + }, + ") => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectMigrationMap", + "text": "SavedObjectMigrationMap" + } + ], + "path": "src/core/server/saved_objects/migrations/utils.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.mergeSavedObjectMigrationMaps.$1", + "type": "Object", + "tags": [], + "label": "map1", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectMigrationMap", + "text": "SavedObjectMigrationMap" + } + ], + "path": "src/core/server/saved_objects/migrations/utils.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.mergeSavedObjectMigrationMaps.$2", + "type": "Object", + "tags": [], + "label": "map2", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectMigrationMap", + "text": "SavedObjectMigrationMap" + } + ], + "path": "src/core/server/saved_objects/migrations/utils.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [ + { + "parentPluginId": "core", + "id": "def-server.ISavedObjectsExporter", + "type": "Interface", + "tags": [], + "label": "ISavedObjectsExporter", + "description": [ + "\nUtility class used to export savedObjects.\n" + ], + "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.ISavedObjectsExporter.exportByTypes", + "type": "Function", + "tags": [ + "throws" + ], + "label": "exportByTypes", + "description": [ + "\nGenerates an export stream for given types.\n\nSee the {@link SavedObjectsExportByTypeOptions | options} for more detailed information.\n" + ], + "signature": [ + "(options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsExportByTypeOptions", + "text": "SavedObjectsExportByTypeOptions" + }, + ") => Promise<", + "Readable", + ">" + ], + "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.ISavedObjectsExporter.exportByTypes.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsExportByTypeOptions", + "text": "SavedObjectsExportByTypeOptions" + } + ], + "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", "deprecated": false, "isRequired": true } @@ -9469,30 +7545,48 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectTypeRegistry.isImportableAndExportable", + "id": "def-server.ISavedObjectsExporter.exportByObjects", "type": "Function", - "tags": [], - "label": "isImportableAndExportable", + "tags": [ + "throws" + ], + "label": "exportByObjects", "description": [ - "\nReturns the `management.importableAndExportable` property for given type, or\n`false` if the type is not registered or does not define a management section." + "\nGenerates an export stream for given object references.\n\nSee the {@link SavedObjectsExportByObjectOptions | options} for more detailed information.\n" ], "signature": [ - "(type: string) => boolean" + "(options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsExportByObjectOptions", + "text": "SavedObjectsExportByObjectOptions" + }, + ") => Promise<", + "Readable", + ">" ], - "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectTypeRegistry.isImportableAndExportable.$1", - "type": "string", + "id": "def-server.ISavedObjectsExporter.exportByObjects.$1", + "type": "Object", "tags": [], - "label": "type", + "label": "options", "description": [], "signature": [ - "string" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsExportByObjectOptions", + "text": "SavedObjectsExportByObjectOptions" + } ], - "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", "deprecated": false, "isRequired": true } @@ -9501,93 +7595,134 @@ } ], "initialIsOpen": false - } - ], - "functions": [ + }, { "parentPluginId": "core", - "id": "def-server.mergeSavedObjectMigrationMaps", - "type": "Function", + "id": "def-server.ISavedObjectsImporter", + "type": "Interface", "tags": [], - "label": "mergeSavedObjectMigrationMaps", + "label": "ISavedObjectsImporter", "description": [ - "\nMerges two saved object migration maps.\n\nIf there is a migration for a given version on only one of the maps,\nthat migration function will be used:\n\nmergeSavedObjectMigrationMaps({ '1.2.3': f }, { '4.5.6': g }) -> { '1.2.3': f, '4.5.6': g }\n\nIf there is a migration for a given version on both maps, the migrations will be composed:\n\nmergeSavedObjectMigrationMaps({ '1.2.3': f }, { '1.2.3': g }) -> { '1.2.3': (doc, context) => f(g(doc, context), context) }\n" - ], - "signature": [ - "(map1: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectMigrationMap", - "text": "SavedObjectMigrationMap" - }, - ", map2: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectMigrationMap", - "text": "SavedObjectMigrationMap" - }, - ") => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectMigrationMap", - "text": "SavedObjectMigrationMap" - } + "\nUtility class used to import savedObjects.\n" ], - "path": "src/core/server/saved_objects/migrations/utils.ts", + "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.mergeSavedObjectMigrationMaps.$1", - "type": "Object", - "tags": [], - "label": "map1", - "description": [], + "id": "def-server.ISavedObjectsImporter.import", + "type": "Function", + "tags": [ + "throws" + ], + "label": "import", + "description": [ + "\nImport saved objects from given stream. See the {@link SavedObjectsImportOptions | options} for more\ndetailed information.\n" + ], "signature": [ + "(options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectMigrationMap", - "text": "SavedObjectMigrationMap" - } + "section": "def-server.SavedObjectsImportOptions", + "text": "SavedObjectsImportOptions" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportResponse", + "text": "SavedObjectsImportResponse" + }, + ">" ], - "path": "src/core/server/saved_objects/migrations/utils.ts", + "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", "deprecated": false, - "isRequired": true + "children": [ + { + "parentPluginId": "core", + "id": "def-server.ISavedObjectsImporter.import.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportOptions", + "text": "SavedObjectsImportOptions" + } + ], + "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "core", - "id": "def-server.mergeSavedObjectMigrationMaps.$2", - "type": "Object", - "tags": [], - "label": "map2", - "description": [], + "id": "def-server.ISavedObjectsImporter.resolveImportErrors", + "type": "Function", + "tags": [ + "throws" + ], + "label": "resolveImportErrors", + "description": [ + "\nResolve and return saved object import errors.\nSee the {@link SavedObjectsResolveImportErrorsOptions | options} for more detailed information.\n" + ], "signature": [ + "(options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectMigrationMap", - "text": "SavedObjectMigrationMap" - } + "section": "def-server.SavedObjectsResolveImportErrorsOptions", + "text": "SavedObjectsResolveImportErrorsOptions" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportResponse", + "text": "SavedObjectsImportResponse" + }, + ">" ], - "path": "src/core/server/saved_objects/migrations/utils.ts", + "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", "deprecated": false, - "isRequired": true + "children": [ + { + "parentPluginId": "core", + "id": "def-server.ISavedObjectsImporter.resolveImportErrors.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsResolveImportErrorsOptions", + "text": "SavedObjectsResolveImportErrorsOptions" + } + ], + "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] } ], - "returnComment": [], "initialIsOpen": false - } - ], - "interfaces": [ + }, { "parentPluginId": "core", "id": "def-server.ISavedObjectsPointInTimeFinder", @@ -11624,7 +9759,7 @@ "tags": [], "label": "SavedObjectsExportByObjectOptions", "description": [ - "\nOptions for the {@link SavedObjectsExporter.exportByObjects | export by objects API}\n" + "\nOptions for the {@link ISavedObjectsExporter.exportByObjects | export by objects API}\n" ], "signature": [ { @@ -11671,7 +9806,7 @@ "tags": [], "label": "SavedObjectsExportByTypeOptions", "description": [ - "\nOptions for the {@link SavedObjectsExporter.exportByTypes | export by type API}\n" + "\nOptions for the {@link ISavedObjectsExporter.exportByTypes | export by type API}\n" ], "signature": [ { @@ -15783,86 +13918,6 @@ ], "enums": [], "misc": [ - { - "parentPluginId": "core", - "id": "def-server.ISavedObjectsExporter", - "type": "Type", - "tags": [], - "label": "ISavedObjectsExporter", - "description": [], - "signature": [ - "{ exportByTypes: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsExportByTypeOptions", - "text": "SavedObjectsExportByTypeOptions" - }, - ") => Promise<", - "Readable", - ">; exportByObjects: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsExportByObjectOptions", - "text": "SavedObjectsExportByObjectOptions" - }, - ") => Promise<", - "Readable", - ">; }" - ], - "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.ISavedObjectsImporter", - "type": "Type", - "tags": [], - "label": "ISavedObjectsImporter", - "description": [], - "signature": [ - "{ import: ({ readStream, createNewCopies, namespace, overwrite, refresh, }: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportOptions", - "text": "SavedObjectsImportOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportResponse", - "text": "SavedObjectsImportResponse" - }, - ">; resolveImportErrors: ({ readStream, createNewCopies, namespace, retries, }: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsResolveImportErrorsOptions", - "text": "SavedObjectsResolveImportErrorsOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportResponse", - "text": "SavedObjectsImportResponse" - }, - ">; }" - ], - "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", - "deprecated": false, - "initialIsOpen": false - }, { "parentPluginId": "core", "id": "def-server.ISavedObjectsRepository", diff --git a/api_docs/core_saved_objects.mdx b/api_docs/core_saved_objects.mdx index c68e80c1a83a89..703391faf0e73f 100644 --- a/api_docs/core_saved_objects.mdx +++ b/api_docs/core_saved_objects.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/core-savedObjects title: "core.savedObjects" image: https://source.unsplash.com/400x175/?github summary: API docs for the core.savedObjects plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'core.savedObjects'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for que | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 2541 | 15 | 977 | 33 | +| 2524 | 15 | 956 | 33 | ## Client @@ -28,9 +28,6 @@ Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for que ### Interfaces -### Consts, variables and types - - ## Server ### Functions diff --git a/api_docs/custom_integrations.mdx b/api_docs/custom_integrations.mdx index 8f5689085e3fd4..6fbae866b65162 100644 --- a/api_docs/custom_integrations.mdx +++ b/api_docs/custom_integrations.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/customIntegrations title: "customIntegrations" image: https://source.unsplash.com/400x175/?github summary: API docs for the customIntegrations plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'customIntegrations'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/dashboard.devdocs.json b/api_docs/dashboard.devdocs.json index 3c7de7012e4b34..288beaececaf23 100644 --- a/api_docs/dashboard.devdocs.json +++ b/api_docs/dashboard.devdocs.json @@ -1855,7 +1855,15 @@ }, "; serialize: () => { searchSourceJSON: string; references: ", "SavedObjectReference", - "[]; }; }" + "[]; }; toExpressionAst: ({ asDatatable }?: ExpressionAstOptions) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + "; }" ], "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts", "deprecated": false @@ -2043,13 +2051,7 @@ ], "signature": [ "{ dashboardId?: string | undefined; timeRange?: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, + "TimeRange", " | undefined; refreshInterval?: ", { "pluginId": "data", @@ -2080,6 +2082,14 @@ }, "[] | undefined; savedQuery?: string | undefined; options?: ", "DashboardOptions", + " | undefined; controlGroupInput?: ", + { + "pluginId": "controls", + "scope": "common", + "docId": "kibControlsPluginApi", + "section": "def-common.SerializableControlGroupInput", + "text": "SerializableControlGroupInput" + }, " | undefined; }" ], "path": "src/plugins/dashboard/public/locator.ts", diff --git a/api_docs/dashboard.mdx b/api_docs/dashboard.mdx index de4f5ac75f3714..877bc0ebbbdd40 100644 --- a/api_docs/dashboard.mdx +++ b/api_docs/dashboard.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/dashboard title: "dashboard" image: https://source.unsplash.com/400x175/?github summary: API docs for the dashboard plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboard'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/dashboard_enhanced.mdx b/api_docs/dashboard_enhanced.mdx index 81cec6d9f2ccd2..461746cb527b0f 100644 --- a/api_docs/dashboard_enhanced.mdx +++ b/api_docs/dashboard_enhanced.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/dashboardEnhanced title: "dashboardEnhanced" image: https://source.unsplash.com/400x175/?github summary: API docs for the dashboardEnhanced plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboardEnhanced'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/data.devdocs.json b/api_docs/data.devdocs.json index 12527c97b10bea..f24c9cf71ffded 100644 --- a/api_docs/data.devdocs.json +++ b/api_docs/data.devdocs.json @@ -923,8 +923,8 @@ "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" + "section": "def-common.DataView", + "text": "DataView" } ], "path": "src/plugins/data/common/search/aggs/agg_config.ts", @@ -941,13 +941,7 @@ "description": [], "signature": [ "() => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, + "TimeRange", " | undefined" ], "path": "src/plugins/data/common/search/aggs/agg_config.ts", @@ -1130,25 +1124,6 @@ "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "deprecated": false, "children": [ - { - "parentPluginId": "data", - "id": "def-public.AggConfigs.indexPattern", - "type": "Object", - "tags": [], - "label": "indexPattern", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" - } - ], - "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "deprecated": false - }, { "parentPluginId": "data", "id": "def-public.AggConfigs.timeRange", @@ -1157,13 +1132,7 @@ "label": "timeRange", "description": [], "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, + "TimeRange", " | undefined" ], "path": "src/plugins/data/common/search/aggs/agg_configs.ts", @@ -1195,19 +1164,6 @@ "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "deprecated": false }, - { - "parentPluginId": "data", - "id": "def-public.AggConfigs.hierarchical", - "type": "CompoundType", - "tags": [], - "label": "hierarchical", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "deprecated": false - }, { "parentPluginId": "data", "id": "def-public.AggConfigs.aggs", @@ -1228,6 +1184,42 @@ "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "deprecated": false }, + { + "parentPluginId": "data", + "id": "def-public.AggConfigs.partialRows", + "type": "CompoundType", + "tags": [], + "label": "partialRows", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.AggConfigs.hierarchical", + "type": "CompoundType", + "tags": [], + "label": "hierarchical", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.AggConfigs.timeZone", + "type": "string", + "tags": [], + "label": "timeZone", + "description": [], + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "deprecated": false + }, { "parentPluginId": "data", "id": "def-public.AggConfigs.Unnamed", @@ -1253,8 +1245,8 @@ "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" + "section": "def-common.DataView", + "text": "DataView" } ], "path": "src/plugins/data/common/search/aggs/agg_configs.ts", @@ -1301,6 +1293,26 @@ "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "deprecated": false, "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-public.AggConfigs.Unnamed.$4", + "type": "Function", + "tags": [], + "label": "getConfig", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.GetConfigFn", + "text": "GetConfigFn" + } + ], + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "deprecated": false, + "isRequired": true } ], "returnComment": [] @@ -1374,13 +1386,7 @@ "description": [], "signature": [ "(timeRange: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, + "TimeRange", ") => void" ], "path": "src/plugins/data/common/search/aggs/agg_configs.ts", @@ -1394,13 +1400,7 @@ "label": "timeRange", "description": [], "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - } + "TimeRange" ], "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "deprecated": false, @@ -2195,6 +2195,32 @@ } ], "returnComment": [] + }, + { + "parentPluginId": "data", + "id": "def-public.AggConfigs.toExpressionAst", + "type": "Function", + "tags": [], + "label": "toExpressionAst", + "description": [ + "\nGenerates an expression abstract syntax tree using the `esaggs` expression function." + ], + "signature": [ + "() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } + ], + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "deprecated": false, + "children": [], + "returnComment": [ + "The expression AST." + ] } ], "initialIsOpen": false @@ -2583,7 +2609,9 @@ "type": "Class", "tags": [], "label": "DuplicateDataViewError", - "description": [], + "description": [ + "\nError thrown when attempting to create duplicate index pattern based on title." + ], "signature": [ { "pluginId": "dataViews", @@ -2603,7 +2631,9 @@ "type": "Function", "tags": [], "label": "Constructor", - "description": [], + "description": [ + "\nconstructor" + ], "signature": [ "any" ], @@ -2616,7 +2646,9 @@ "type": "string", "tags": [], "label": "message", - "description": [], + "description": [ + "- Error message" + ], "signature": [ "string" ], @@ -2632,869 +2664,790 @@ }, { "parentPluginId": "data", - "id": "def-public.IndexPattern", + "id": "def-public.NowProvider", "type": "Class", - "tags": [ - "deprecated" - ], - "label": "IndexPattern", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" - }, - " extends ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - } + "tags": [], + "label": "NowProvider", + "description": [ + "\nUsed to synchronize time between parallel searches with relative time range that rely on `now`." ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": true, - "references": [ + "path": "src/plugins/data/public/now_provider/now_provider.ts", + "deprecated": false, + "children": [ { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/index.ts" + "parentPluginId": "data", + "id": "def-public.NowProvider.Unnamed", + "type": "Function", + "tags": [], + "label": "Constructor", + "description": [], + "signature": [ + "any" + ], + "path": "src/plugins/data/public/now_provider/now_provider.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { - "plugin": "discover", - "path": "src/plugins/discover/public/application/view_alert/view_alert_route.tsx" + "parentPluginId": "data", + "id": "def-public.NowProvider.get", + "type": "Function", + "tags": [], + "label": "get", + "description": [], + "signature": [ + "() => Date" + ], + "path": "src/plugins/data/public/now_provider/now_provider.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { - "plugin": "discover", - "path": "src/plugins/discover/public/application/view_alert/view_alert_route.tsx" + "parentPluginId": "data", + "id": "def-public.NowProvider.set", + "type": "Function", + "tags": [], + "label": "set", + "description": [], + "signature": [ + "(now: Date) => void" + ], + "path": "src/plugins/data/public/now_provider/now_provider.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-public.NowProvider.set.$1", + "type": "Object", + "tags": [], + "label": "now", + "description": [], + "signature": [ + "Date" + ], + "path": "src/plugins/data/public/now_provider/now_provider.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { - "plugin": "ux", - "path": "x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_filters.tsx" - }, + "parentPluginId": "data", + "id": "def-public.NowProvider.reset", + "type": "Function", + "tags": [], + "label": "reset", + "description": [], + "signature": [ + "() => void" + ], + "path": "src/plugins/data/public/now_provider/now_provider.ts", + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-public.OptionedParamType", + "type": "Class", + "tags": [], + "label": "OptionedParamType", + "description": [], + "signature": [ { - "plugin": "ux", - "path": "x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_filters.tsx" + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.OptionedParamType", + "text": "OptionedParamType" }, + " extends ", { - "plugin": "ux", - "path": "x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_wildcards.tsx" - }, - { - "plugin": "ux", - "path": "x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_wildcards.tsx" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/fields/data_view_field.test.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/fields/data_view_field.test.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/public/index.ts" - }, - { - "plugin": "savedObjects", - "path": "src/plugins/saved_objects/public/types.ts" - }, - { - "plugin": "savedObjects", - "path": "src/plugins/saved_objects/public/types.ts" - }, - { - "plugin": "savedObjects", - "path": "src/plugins/saved_objects/public/types.ts" - }, - { - "plugin": "savedObjects", - "path": "src/plugins/saved_objects/public/saved_object/helpers/apply_es_resp.ts" - }, - { - "plugin": "savedObjects", - "path": "src/plugins/saved_objects/public/saved_object/helpers/apply_es_resp.ts" - }, - { - "plugin": "dataViewEditor", - "path": "src/plugins/data_view_editor/public/shared_imports.ts" - }, - { - "plugin": "dataViewEditor", - "path": "src/plugins/data_view_editor/public/open_editor.tsx" - }, - { - "plugin": "dataViewEditor", - "path": "src/plugins/data_view_editor/public/open_editor.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/fields/agg/percentile_agg_field.test.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/fields/agg/percentile_agg_field.test.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/agg_filters/agg_type_filters.ts" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/agg_filters/agg_type_filters.ts" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/agg_filters/agg_type_filters.ts" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/utils/editor_config.ts" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/utils/editor_config.ts" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.ts" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.ts" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_select.tsx" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_select.tsx" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_params.tsx" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_params.tsx" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.test.ts" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.test.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.test.ts" + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.BaseParamType", + "text": "BaseParamType" }, + "<", { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.test.ts" + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" }, + ">" + ], + "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", + "deprecated": false, + "children": [ { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.test.ts" + "parentPluginId": "data", + "id": "def-public.OptionedParamType.options", + "type": "Array", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.OptionedValueProp", + "text": "OptionedValueProp" + }, + "[]" + ], + "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", + "deprecated": false }, { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.test.ts" + "parentPluginId": "data", + "id": "def-public.OptionedParamType.Unnamed", + "type": "Function", + "tags": [], + "label": "Constructor", + "description": [], + "signature": [ + "any" + ], + "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-public.OptionedParamType.Unnamed.$1", + "type": "Object", + "tags": [], + "label": "config", + "description": [], + "signature": [ + "Record" + ], + "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] } ], - "children": [], "initialIsOpen": false }, { "parentPluginId": "data", - "id": "def-public.IndexPatternField", + "id": "def-public.SearchSource", "type": "Class", - "tags": [ - "deprecated" - ], - "label": "IndexPatternField", + "tags": [], + "label": "SearchSource", "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IndexPatternField", - "text": "IndexPatternField" - }, - " extends ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" - } - ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": true, - "references": [ - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/index.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/public/index.ts" - }, - { - "plugin": "dataViewEditor", - "path": "src/plugins/data_view_editor/public/shared_imports.ts" - }, - { - "plugin": "dataViewEditor", - "path": "src/plugins/data_view_editor/public/lib/extract_time_fields.ts" - }, - { - "plugin": "dataViewEditor", - "path": "src/plugins/data_view_editor/public/lib/extract_time_fields.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" - }, + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "deprecated": false, + "children": [ { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" + "parentPluginId": "data", + "id": "def-public.SearchSource.history", + "type": "Array", + "tags": [], + "label": "history", + "description": [], + "signature": [ + "SearchRequest", + "[]" + ], + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "deprecated": false }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" + "parentPluginId": "data", + "id": "def-public.SearchSource.Unnamed", + "type": "Function", + "tags": [], + "label": "Constructor", + "description": [], + "signature": [ + "any" + ], + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-public.SearchSource.Unnamed.$1", + "type": "Object", + "tags": [], + "label": "fields", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" + } + ], + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-public.SearchSource.Unnamed.$2", + "type": "Object", + "tags": [], + "label": "dependencies", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceDependencies", + "text": "SearchSourceDependencies" + } + ], + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" + "parentPluginId": "data", + "id": "def-public.SearchSource.setOverwriteDataViewType", + "type": "Function", + "tags": [], + "label": "setOverwriteDataViewType", + "description": [ + "**\nPUBLIC API\n\nUsed to make the search source overwrite the actual data view type for the\nspecific requests done. This should only be needed very rarely, since it means\ne.g. we'd be treating a rollup index pattern as a regular one. Be very sure\nyou understand the consequences of using this method before using it.\n" + ], + "signature": [ + "(overwriteType: string | false | undefined) => void" + ], + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-public.SearchSource.setOverwriteDataViewType.$1", + "type": "CompoundType", + "tags": [], + "label": "overwriteType", + "description": [ + "If `false` is passed in it will disable the overwrite, otherwise\nthe passed in value will be used as the data view type for this search source." + ], + "signature": [ + "string | false | undefined" + ], + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" + "parentPluginId": "data", + "id": "def-public.SearchSource.setField", + "type": "Function", + "tags": [], + "label": "setField", + "description": [ + "\nsets value to a single search source field" + ], + "signature": [ + "(field: K, value: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" + }, + "[K]) => this" + ], + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-public.SearchSource.setField.$1", + "type": "Uncategorized", + "tags": [], + "label": "field", + "description": [ + ": field name" + ], + "signature": [ + "K" + ], + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-public.SearchSource.setField.$2", + "type": "Uncategorized", + "tags": [], + "label": "value", + "description": [ + ": value for the field" + ], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" + }, + "[K]" + ], + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" + "parentPluginId": "data", + "id": "def-public.SearchSource.removeField", + "type": "Function", + "tags": [], + "label": "removeField", + "description": [ + "\nremove field" + ], + "signature": [ + "(field: K) => this" + ], + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-public.SearchSource.removeField.$1", + "type": "Uncategorized", + "tags": [], + "label": "field", + "description": [ + ": field name" + ], + "signature": [ + "K" + ], + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/metrics_editor/metric_editor.tsx" + "parentPluginId": "data", + "id": "def-public.SearchSource.setFields", + "type": "Function", + "tags": [ + "private" + ], + "label": "setFields", + "description": [ + "\nInternal, do not use. Overrides all search source fields with the new field array.\n" + ], + "signature": [ + "(newFields: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" + }, + ") => this" + ], + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-public.SearchSource.setFields.$1", + "type": "Object", + "tags": [], + "label": "newFields", + "description": [ + "New field array." + ], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" + } + ], + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/metrics_editor/metric_editor.tsx" + "parentPluginId": "data", + "id": "def-public.SearchSource.getId", + "type": "Function", + "tags": [], + "label": "getId", + "description": [ + "\nreturns search source id" + ], + "signature": [ + "() => string" + ], + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/metrics_editor/metric_editor.tsx" + "parentPluginId": "data", + "id": "def-public.SearchSource.getFields", + "type": "Function", + "tags": [], + "label": "getFields", + "description": [ + "\nreturns all search source fields" + ], + "signature": [ + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" + } + ], + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/fields/es_doc_field.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/fields/es_doc_field.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/metrics_editor/metrics_editor.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/metrics_editor/metrics_editor.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_geo_grid_source/update_source_editor.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_geo_grid_source/update_source_editor.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/top_hits/top_hits_form.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/top_hits/top_hits_form.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/top_hits/top_hits_form.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/top_hits/update_source_editor.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/top_hits/update_source_editor.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/top_hits/update_source_editor.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/geo_field_select.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/geo_field_select.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/connected_components/edit_layer_panel/join_editor/resources/join_expression.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/connected_components/edit_layer_panel/join_editor/resources/join_expression.tsx" + "parentPluginId": "data", + "id": "def-public.SearchSource.getField", + "type": "Function", + "tags": [], + "label": "getField", + "description": [ + "\nGets a single field from the fields" + ], + "signature": [ + "(field: K, recurse?: boolean) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" + }, + "[K]" + ], + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-public.SearchSource.getField.$1", + "type": "Uncategorized", + "tags": [], + "label": "field", + "description": [], + "signature": [ + "K" + ], + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-public.SearchSource.getField.$2", + "type": "boolean", + "tags": [], + "label": "recurse", + "description": [], + "signature": [ + "boolean" + ], + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/connected_components/edit_layer_panel/join_editor/resources/metrics_expression.tsx" + "parentPluginId": "data", + "id": "def-public.SearchSource.getOwnField", + "type": "Function", + "tags": [], + "label": "getOwnField", + "description": [ + "\nGet the field from our own fields, don't traverse up the chain" + ], + "signature": [ + "(field: K) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" + }, + "[K]" + ], + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-public.SearchSource.getOwnField.$1", + "type": "Uncategorized", + "tags": [], + "label": "field", + "description": [], + "signature": [ + "K" + ], + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/connected_components/edit_layer_panel/join_editor/resources/metrics_expression.tsx" + "parentPluginId": "data", + "id": "def-public.SearchSource.create", + "type": "Function", + "tags": [ + "deprecated" + ], + "label": "create", + "description": [], + "signature": [ + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSource", + "text": "SearchSource" + } + ], + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "deprecated": true, + "references": [ + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/lib/wrap_search_source_client.ts" + }, + { + "plugin": "discover", + "path": "src/plugins/discover/public/embeddable/saved_search_embeddable.tsx" + }, + { + "plugin": "discover", + "path": "src/plugins/discover/public/embeddable/saved_search_embeddable.tsx" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.ts" + } + ], + "children": [], + "returnComment": [] }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/index_pattern_util.test.ts" + "parentPluginId": "data", + "id": "def-public.SearchSource.createCopy", + "type": "Function", + "tags": [], + "label": "createCopy", + "description": [ + "\ncreates a copy of this search source (without its children)" + ], + "signature": [ + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSource", + "text": "SearchSource" + } + ], + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/index_pattern_util.test.ts" + "parentPluginId": "data", + "id": "def-public.SearchSource.createChild", + "type": "Function", + "tags": [], + "label": "createChild", + "description": [ + "\ncreates a new child search source" + ], + "signature": [ + "(options?: {}) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSource", + "text": "SearchSource" + } + ], + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-public.SearchSource.createChild.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "{}" + ], + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/index_pattern_util.test.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/index_pattern_util.test.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/index_pattern_util.test.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/index_pattern_util.test.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/agg_filters/agg_type_field_filters.ts" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/agg_filters/agg_type_field_filters.ts" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/agg_filters/agg_type_field_filters.ts" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_param_props.ts" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_param_props.ts" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/controls/field.tsx" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/controls/field.tsx" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/controls/field.tsx" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/controls/field.tsx" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/controls/top_field.tsx" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/controls/top_field.tsx" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/controls/top_sort_field.tsx" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/controls/top_sort_field.tsx" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.ts" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.ts" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.ts" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.ts" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.ts" - }, - { - "plugin": "dataViewEditor", - "path": "src/plugins/data_view_editor/public/lib/extract_time_fields.test.ts" - }, - { - "plugin": "dataViewEditor", - "path": "src/plugins/data_view_editor/public/lib/extract_time_fields.test.ts" - }, - { - "plugin": "dataViewEditor", - "path": "src/plugins/data_view_editor/public/lib/extract_time_fields.test.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.test.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.test.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.test.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.test.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.test.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.test.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/fields/data_view_field.test.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/fields/data_view_field.test.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/fields/data_view_field.test.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/fields/data_view_field.test.ts" - } - ], - "children": [], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-public.IndexPatternsService", - "type": "Class", - "tags": [ - "deprecated" - ], - "label": "IndexPatternsService", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IndexPatternsService", - "text": "IndexPatternsService" - }, - " extends ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewsService", - "text": "DataViewsService" - } - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": true, - "references": [ - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/index.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/server/data_indexing/create_doc_source.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/server/data_indexing/create_doc_source.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/public/index.ts" - } - ], - "children": [], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-public.NowProvider", - "type": "Class", - "tags": [], - "label": "NowProvider", - "description": [ - "\nUsed to synchronize time between parallel searches with relative time range that rely on `now`." - ], - "path": "src/plugins/data/public/now_provider/now_provider.ts", - "deprecated": false, - "children": [ { "parentPluginId": "data", - "id": "def-public.NowProvider.Unnamed", + "id": "def-public.SearchSource.setParent", "type": "Function", - "tags": [], - "label": "Constructor", - "description": [], - "signature": [ - "any" + "tags": [ + "return" ], - "path": "src/plugins/data/public/now_provider/now_provider.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-public.NowProvider.get", - "type": "Function", - "tags": [], - "label": "get", - "description": [], - "signature": [ - "() => Date" + "label": "setParent", + "description": [ + "\nSet a searchSource that this source should inherit from" ], - "path": "src/plugins/data/public/now_provider/now_provider.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-public.NowProvider.set", - "type": "Function", - "tags": [], - "label": "set", - "description": [], "signature": [ - "(now: Date) => void" + "(parent?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchSource", + "text": "ISearchSource" + }, + " | undefined, options?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceOptions", + "text": "SearchSourceOptions" + }, + ") => this" ], - "path": "src/plugins/data/public/now_provider/now_provider.ts", + "path": "src/plugins/data/common/search/search_source/search_source.ts", "deprecated": false, "children": [ { "parentPluginId": "data", - "id": "def-public.NowProvider.set.$1", + "id": "def-public.SearchSource.setParent.$1", "type": "Object", "tags": [], - "label": "now", - "description": [], + "label": "parent", + "description": [ + "- the parent searchSource" + ], "signature": [ - "Date" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchSource", + "text": "ISearchSource" + }, + " | undefined" ], - "path": "src/plugins/data/public/now_provider/now_provider.ts", + "path": "src/plugins/data/common/search/search_source/search_source.ts", "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-public.NowProvider.reset", - "type": "Function", - "tags": [], - "label": "reset", - "description": [], - "signature": [ - "() => void" - ], - "path": "src/plugins/data/public/now_provider/now_provider.ts", - "deprecated": false, - "children": [], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-public.OptionedParamType", - "type": "Class", - "tags": [], - "label": "OptionedParamType", - "description": [], - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.OptionedParamType", - "text": "OptionedParamType" - }, - " extends ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.BaseParamType", - "text": "BaseParamType" - }, - "<", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggConfig", - "text": "AggConfig" - }, - ">" - ], - "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-public.OptionedParamType.options", - "type": "Array", - "tags": [], - "label": "options", - "description": [], - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.OptionedValueProp", - "text": "OptionedValueProp" + "isRequired": false }, - "[]" - ], - "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.OptionedParamType.Unnamed", - "type": "Function", - "tags": [], - "label": "Constructor", - "description": [], - "signature": [ - "any" - ], - "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-public.OptionedParamType.Unnamed.$1", - "type": "Object", - "tags": [], - "label": "config", - "description": [], - "signature": [ - "Record" - ], - "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-public.SearchSource", - "type": "Class", - "tags": [], - "label": "SearchSource", - "description": [], - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-public.SearchSource.history", - "type": "Array", - "tags": [], - "label": "history", - "description": [], - "signature": [ - "SearchRequest", - "[]" - ], - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.SearchSource.Unnamed", - "type": "Function", - "tags": [], - "label": "Constructor", - "description": [], - "signature": [ - "any" - ], - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "deprecated": false, - "children": [ { "parentPluginId": "data", - "id": "def-public.SearchSource.Unnamed.$1", + "id": "def-public.SearchSource.setParent.$2", "type": "Object", "tags": [], - "label": "fields", - "description": [], - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchSourceFields", - "text": "SearchSourceFields" - } + "label": "options", + "description": [ + "- the inherit options" ], - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "data", - "id": "def-public.SearchSource.Unnamed.$2", - "type": "Object", - "tags": [], - "label": "dependencies", - "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchSourceDependencies", - "text": "SearchSourceDependencies" + "section": "def-common.SearchSourceOptions", + "text": "SearchSourceOptions" } ], "path": "src/plugins/data/common/search/search_source/search_source.ts", @@ -3502,107 +3455,89 @@ "isRequired": true } ], - "returnComment": [] + "returnComment": [ + "- chainable" + ] }, { "parentPluginId": "data", - "id": "def-public.SearchSource.setOverwriteDataViewType", + "id": "def-public.SearchSource.getParent", "type": "Function", - "tags": [], - "label": "setOverwriteDataViewType", + "tags": [ + "return" + ], + "label": "getParent", "description": [ - "**\nPUBLIC API\n\nUsed to make the search source overwrite the actual data view type for the\nspecific requests done. This should only be needed very rarely, since it means\ne.g. we'd be treating a rollup index pattern as a regular one. Be very sure\nyou understand the consequences of using this method before using it.\n" + "\nGet the parent of this SearchSource" ], "signature": [ - "(overwriteType: string | false | undefined) => void" + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSource", + "text": "SearchSource" + }, + " | undefined" ], "path": "src/plugins/data/common/search/search_source/search_source.ts", "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-public.SearchSource.setOverwriteDataViewType.$1", - "type": "CompoundType", - "tags": [], - "label": "overwriteType", - "description": [ - "If `false` is passed in it will disable the overwrite, otherwise\nthe passed in value will be used as the data view type for this search source." - ], - "signature": [ - "string | false | undefined" - ], - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "deprecated": false, - "isRequired": false - } - ], + "children": [], "returnComment": [] }, { "parentPluginId": "data", - "id": "def-public.SearchSource.setField", + "id": "def-public.SearchSource.fetch$", "type": "Function", "tags": [], - "label": "setField", + "label": "fetch$", "description": [ - "\nsets value to a single search source field" + "\nFetch this source from Elasticsearch, returning an observable over the response(s)" ], "signature": [ - "(field: K, value: ", + ") => ", + "Observable", + "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchSourceFields", - "text": "SearchSourceFields" + "section": "def-common.IKibanaSearchResponse", + "text": "IKibanaSearchResponse" }, - "[K]) => this" + "<", + "SearchResponse", + ">>>" ], "path": "src/plugins/data/common/search/search_source/search_source.ts", "deprecated": false, "children": [ { "parentPluginId": "data", - "id": "def-public.SearchSource.setField.$1", - "type": "Uncategorized", + "id": "def-public.SearchSource.fetch$.$1", + "type": "Object", "tags": [], - "label": "field", - "description": [ - ": field name" - ], + "label": "options", + "description": [], "signature": [ - "K" - ], - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "data", - "id": "def-public.SearchSource.setField.$2", - "type": "Uncategorized", - "tags": [], - "label": "value", - "description": [ - ": value for the field" - ], - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchSourceFields", - "text": "SearchSourceFields" - }, - "[K]" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchOptions", + "text": "ISearchOptions" + } ], "path": "src/plugins/data/common/search/search_source/search_source.ts", "deprecated": false, @@ -3613,38 +3548,115 @@ }, { "parentPluginId": "data", - "id": "def-public.SearchSource.removeField", + "id": "def-public.SearchSource.fetch", "type": "Function", - "tags": [], - "label": "removeField", + "tags": [ + "deprecated" + ], + "label": "fetch", "description": [ - "\nremove field" + "\nFetch this source and reject the returned Promise on error" ], "signature": [ - "(field: K) => this" + ") => Promise<", + "SearchResponse", + ">>" ], "path": "src/plugins/data/common/search/search_source/search_source.ts", - "deprecated": false, + "deprecated": true, + "removeBy": "8.1", + "references": [ + { + "plugin": "stackAlerts", + "path": "x-pack/plugins/stack_alerts/server/alert_types/es_query/lib/fetch_search_source_query.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts" + }, + { + "plugin": "stackAlerts", + "path": "x-pack/plugins/stack_alerts/server/alert_types/es_query/rule_type.test.ts" + }, + { + "plugin": "stackAlerts", + "path": "x-pack/plugins/stack_alerts/server/alert_types/es_query/rule_type.test.ts" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts" + }, + { + "plugin": "inputControlVis", + "path": "src/plugins/input_control_vis/public/control/list_control_factory.ts" + }, + { + "plugin": "inputControlVis", + "path": "src/plugins/input_control_vis/public/control/range_control_factory.ts" + } + ], "children": [ { "parentPluginId": "data", - "id": "def-public.SearchSource.removeField.$1", - "type": "Uncategorized", + "id": "def-public.SearchSource.fetch.$1", + "type": "Object", "tags": [], - "label": "field", - "description": [ - ": field name" - ], + "label": "options", + "description": [], "signature": [ - "K" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchOptions", + "text": "ISearchOptions" + } ], "path": "src/plugins/data/common/search/search_source/search_source.ts", "deprecated": false, @@ -3655,46 +3667,62 @@ }, { "parentPluginId": "data", - "id": "def-public.SearchSource.setFields", + "id": "def-public.SearchSource.onRequestStart", "type": "Function", "tags": [ - "private" + "return" ], - "label": "setFields", + "label": "onRequestStart", "description": [ - "\nInternal, do not use. Overrides all search source fields with the new field array.\n" + "\n Add a handler that will be notified whenever requests start" ], "signature": [ - "(newFields: ", + "(handler: (searchSource: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchSourceFields", - "text": "SearchSourceFields" + "section": "def-common.SearchSource", + "text": "SearchSource" }, - ") => this" + ", options?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchOptions", + "text": "ISearchOptions" + }, + " | undefined) => Promise) => void" ], "path": "src/plugins/data/common/search/search_source/search_source.ts", "deprecated": false, "children": [ { "parentPluginId": "data", - "id": "def-public.SearchSource.setFields.$1", - "type": "Object", + "id": "def-public.SearchSource.onRequestStart.$1", + "type": "Function", "tags": [], - "label": "newFields", - "description": [ - "New field array." - ], + "label": "handler", + "description": [], "signature": [ + "(searchSource: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchSourceFields", - "text": "SearchSourceFields" - } + "section": "def-common.SearchSource", + "text": "SearchSource" + }, + ", options?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchOptions", + "text": "ISearchOptions" + }, + " | undefined) => Promise" ], "path": "src/plugins/data/common/search/search_source/search_source.ts", "deprecated": false, @@ -3705,15 +3733,15 @@ }, { "parentPluginId": "data", - "id": "def-public.SearchSource.getId", + "id": "def-public.SearchSource.getSearchRequestBody", "type": "Function", "tags": [], - "label": "getId", + "label": "getSearchRequestBody", "description": [ - "\nreturns search source id" + "\nReturns body contents of the search request, often referred as query DSL." ], "signature": [ - "() => string" + "() => any" ], "path": "src/plugins/data/common/search/search_source/search_source.ts", "deprecated": false, @@ -3722,22 +3750,17 @@ }, { "parentPluginId": "data", - "id": "def-public.SearchSource.getFields", + "id": "def-public.SearchSource.destroy", "type": "Function", - "tags": [], - "label": "getFields", + "tags": [ + "return" + ], + "label": "destroy", "description": [ - "\nreturns all search source fields" + "\nCompletely destroy the SearchSource." ], "signature": [ - "() => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchSourceFields", - "text": "SearchSourceFields" - } + "() => void" ], "path": "src/plugins/data/common/search/search_source/search_source.ts", "deprecated": false, @@ -3746,52 +3769,29 @@ }, { "parentPluginId": "data", - "id": "def-public.SearchSource.getField", + "id": "def-public.SearchSource.getSerializedFields", "type": "Function", "tags": [], - "label": "getField", + "label": "getSerializedFields", "description": [ - "\nGets a single field from the fields" + "\nserializes search source fields (which can later be passed to {@link ISearchStartSearchSource})" ], "signature": [ - "(field: K, recurse?: boolean) => ", + "(recurse?: boolean) => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchSourceFields", - "text": "SearchSourceFields" - }, - "[K]" + "section": "def-common.SerializedSearchSourceFields", + "text": "SerializedSearchSourceFields" + } ], "path": "src/plugins/data/common/search/search_source/search_source.ts", "deprecated": false, "children": [ { "parentPluginId": "data", - "id": "def-public.SearchSource.getField.$1", - "type": "Uncategorized", - "tags": [], - "label": "field", - "description": [], - "signature": [ - "K" - ], - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "data", - "id": "def-public.SearchSource.getField.$2", + "id": "def-public.SearchSource.getSerializedFields.$1", "type": "boolean", "tags": [], "label": "recurse", @@ -3808,672 +3808,557 @@ }, { "parentPluginId": "data", - "id": "def-public.SearchSource.getOwnField", + "id": "def-public.SearchSource.serialize", "type": "Function", "tags": [], - "label": "getOwnField", + "label": "serialize", "description": [ - "\nGet the field from our own fields, don't traverse up the chain" + "\nSerializes the instance to a JSON string and a set of referenced objects.\nUse this method to get a representation of the search source which can be stored in a saved object.\n\nThe references returned by this function can be mixed with other references in the same object,\nhowever make sure there are no name-collisions. The references will be named `kibanaSavedObjectMeta.searchSourceJSON.index`\nand `kibanaSavedObjectMeta.searchSourceJSON.filter[].meta.index`.\n\nUsing `createSearchSource`, the instance can be re-created." ], "signature": [ - "(field: K) => ", + "() => { searchSourceJSON: string; references: ", + "SavedObjectReference", + "[]; }" + ], + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "data", + "id": "def-public.SearchSource.toExpressionAst", + "type": "Function", + "tags": [], + "label": "toExpressionAst", + "description": [ + "\nGenerates an expression abstract syntax tree using the fields set in the current search source and its ancestors.\nThe produced expression from the returned AST will return the `datatable` structure.\nIf the `asDatatable` option is truthy or omitted, the generator will use the `esdsl` function to perform the search.\nWhen the `aggs` field is present, it will use the `esaggs` function instead." + ], + "signature": [ + "({ asDatatable }?: ExpressionAstOptions) => ", { - "pluginId": "data", + "pluginId": "expressions", "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchSourceFields", - "text": "SearchSourceFields" - }, - "[K]" + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } ], "path": "src/plugins/data/common/search/search_source/search_source.ts", "deprecated": false, "children": [ { "parentPluginId": "data", - "id": "def-public.SearchSource.getOwnField.$1", - "type": "Uncategorized", + "id": "def-public.SearchSource.toExpressionAst.$1", + "type": "Object", "tags": [], - "label": "field", + "label": "{ asDatatable = true }", "description": [], "signature": [ - "K" + "ExpressionAstOptions" ], "path": "src/plugins/data/common/search/search_source/search_source.ts", "deprecated": false, "isRequired": true } ], - "returnComment": [] - }, + "returnComment": [ + "The expression AST." + ] + } + ], + "initialIsOpen": false + } + ], + "functions": [ + { + "parentPluginId": "data", + "id": "def-public.calculateBounds", + "type": "Function", + "tags": [], + "label": "calculateBounds", + "description": [], + "signature": [ + "(timeRange: ", + "TimeRange", + ", options: CalculateBoundsOptions) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRangeBounds", + "text": "TimeRangeBounds" + } + ], + "path": "src/plugins/data/common/query/timefilter/get_time.ts", + "deprecated": false, + "children": [ { "parentPluginId": "data", - "id": "def-public.SearchSource.create", - "type": "Function", - "tags": [ - "deprecated" - ], - "label": "create", + "id": "def-public.calculateBounds.$1", + "type": "Object", + "tags": [], + "label": "timeRange", "description": [], "signature": [ - "() => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchSource", - "text": "SearchSource" - } - ], - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "deprecated": true, - "references": [ - { - "plugin": "alerting", - "path": "x-pack/plugins/alerting/server/lib/wrap_search_source_client.ts" - }, - { - "plugin": "discover", - "path": "src/plugins/discover/public/embeddable/saved_search_embeddable.tsx" - }, - { - "plugin": "discover", - "path": "src/plugins/discover/public/embeddable/saved_search_embeddable.tsx" - }, - { - "plugin": "securitySolution", - "path": "x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.ts" - } + "TimeRange" ], - "children": [], - "returnComment": [] + "path": "src/plugins/data/common/query/timefilter/get_time.ts", + "deprecated": false, + "isRequired": true }, { "parentPluginId": "data", - "id": "def-public.SearchSource.createCopy", - "type": "Function", + "id": "def-public.calculateBounds.$2", + "type": "Object", "tags": [], - "label": "createCopy", - "description": [ - "\ncreates a copy of this search source (without its children)" - ], + "label": "options", + "description": [], "signature": [ - "() => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchSource", - "text": "SearchSource" - } + "CalculateBoundsOptions" ], - "path": "src/plugins/data/common/search/search_source/search_source.ts", + "path": "src/plugins/data/common/query/timefilter/get_time.ts", "deprecated": false, - "children": [], - "returnComment": [] + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-public.extractReferences", + "type": "Function", + "tags": [], + "label": "extractReferences", + "description": [], + "signature": [ + "(state: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SerializedSearchSourceFields", + "text": "SerializedSearchSourceFields" + }, + ") => [", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SerializedSearchSourceFields", + "text": "SerializedSearchSourceFields" }, + ", ", + "SavedObjectReference", + "[]]" + ], + "path": "src/plugins/data/common/search/search_source/extract_references.ts", + "deprecated": false, + "children": [ { "parentPluginId": "data", - "id": "def-public.SearchSource.createChild", - "type": "Function", + "id": "def-public.extractReferences.$1", + "type": "Object", "tags": [], - "label": "createChild", - "description": [ - "\ncreates a new child search source" - ], + "label": "state", + "description": [], "signature": [ - "(options?: {}) => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchSource", - "text": "SearchSource" + "section": "def-common.SerializedSearchSourceFields", + "text": "SerializedSearchSourceFields" } ], - "path": "src/plugins/data/common/search/search_source/search_source.ts", + "path": "src/plugins/data/common/search/search_source/extract_references.ts", "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-public.SearchSource.createChild.$1", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - "{}" - ], - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-public.fieldList", + "type": "Function", + "tags": [], + "label": "fieldList", + "description": [], + "signature": [ + "(specs?: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" }, + "[], shortDotsEnable?: boolean) => ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.IIndexPatternFieldList", + "text": "IIndexPatternFieldList" + } + ], + "path": "src/plugins/data_views/common/fields/field_list.ts", + "deprecated": false, + "children": [ { "parentPluginId": "data", - "id": "def-public.SearchSource.setParent", - "type": "Function", - "tags": [ - "return" - ], - "label": "setParent", - "description": [ - "\nSet a searchSource that this source should inherit from" - ], + "id": "def-public.fieldList.$1", + "type": "Array", + "tags": [], + "label": "specs", + "description": [], "signature": [ - "(parent?: ", { - "pluginId": "data", + "pluginId": "dataViews", "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.ISearchSource", - "text": "ISearchSource" + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" }, - " | undefined, options?: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchSourceOptions", - "text": "SearchSourceOptions" - }, - ") => this" + "[]" ], - "path": "src/plugins/data/common/search/search_source/search_source.ts", + "path": "src/plugins/data_views/common/fields/field_list.ts", "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-public.SearchSource.setParent.$1", - "type": "Object", - "tags": [], - "label": "parent", - "description": [ - "- the parent searchSource" - ], - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.ISearchSource", - "text": "ISearchSource" - }, - " | undefined" - ], - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "deprecated": false, - "isRequired": false - }, - { - "parentPluginId": "data", - "id": "def-public.SearchSource.setParent.$2", - "type": "Object", - "tags": [], - "label": "options", - "description": [ - "- the inherit options" - ], - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchSourceOptions", - "text": "SearchSourceOptions" - } - ], - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [ - "- chainable" - ] + "isRequired": true }, { "parentPluginId": "data", - "id": "def-public.SearchSource.getParent", - "type": "Function", - "tags": [ - "return" + "id": "def-public.fieldList.$2", + "type": "boolean", + "tags": [], + "label": "shortDotsEnable", + "description": [], + "signature": [ + "boolean" ], - "label": "getParent", + "path": "src/plugins/data_views/common/fields/field_list.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-public.flattenHit", + "type": "Function", + "tags": [], + "label": "flattenHit", + "description": [ + "\nFlattens an individual hit (from an ES response) into an object. This will\ncreate flattened field names, like `user.name`.\n" + ], + "signature": [ + "(hit: Hit, indexPattern: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + " | undefined, params: TabifyDocsOptions | undefined) => Record" + ], + "path": "src/plugins/data/common/search/tabify/tabify_docs.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-public.flattenHit.$1", + "type": "CompoundType", + "tags": [], + "label": "hit", "description": [ - "\nGet the parent of this SearchSource" + "The hit from an ES reponse's hits.hits[]" ], "signature": [ - "() => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchSource", - "text": "SearchSource" - }, - " | undefined" + "Hit" ], - "path": "src/plugins/data/common/search/search_source/search_source.ts", + "path": "src/plugins/data/common/search/tabify/tabify_docs.ts", "deprecated": false, - "children": [], - "returnComment": [] + "isRequired": true }, { "parentPluginId": "data", - "id": "def-public.SearchSource.fetch$", - "type": "Function", + "id": "def-public.flattenHit.$2", + "type": "Object", "tags": [], - "label": "fetch$", + "label": "indexPattern", "description": [ - "\nFetch this source from Elasticsearch, returning an observable over the response(s)" + "The index pattern for the requested index if available." ], "signature": [ - "(options?: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.ISearchOptions", - "text": "ISearchOptions" - }, - ") => ", - "Observable", - "<", { - "pluginId": "data", + "pluginId": "dataViews", "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.IKibanaSearchResponse", - "text": "IKibanaSearchResponse" + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" }, - "<", - "SearchResponse", - ">>>" + " | undefined" ], - "path": "src/plugins/data/common/search/search_source/search_source.ts", + "path": "src/plugins/data/common/search/tabify/tabify_docs.ts", "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-public.SearchSource.fetch$.$1", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.ISearchOptions", - "text": "ISearchOptions" - } - ], - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] + "isRequired": false }, { "parentPluginId": "data", - "id": "def-public.SearchSource.fetch", - "type": "Function", - "tags": [ - "deprecated" - ], - "label": "fetch", + "id": "def-public.flattenHit.$3", + "type": "Object", + "tags": [], + "label": "params", "description": [ - "\nFetch this source and reject the returned Promise on error" + "Parameters how to flatten the hit" ], "signature": [ - "(options?: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.ISearchOptions", - "text": "ISearchOptions" - }, - ") => Promise<", - "SearchResponse", - ">>" + "TabifyDocsOptions | undefined" ], - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [ - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/server/alert_types/es_query/lib/fetch_search_source_query.ts" - }, - { - "plugin": "alerting", - "path": "x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts" - }, - { - "plugin": "alerting", - "path": "x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts" - }, - { - "plugin": "alerting", - "path": "x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts" - }, - { - "plugin": "alerting", - "path": "x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts" - }, - { - "plugin": "alerting", - "path": "x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts" - }, - { - "plugin": "alerting", - "path": "x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts" - }, - { - "plugin": "alerting", - "path": "x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/server/alert_types/es_query/alert_type.test.ts" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/server/alert_types/es_query/alert_type.test.ts" - }, - { - "plugin": "securitySolution", - "path": "x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts" - }, - { - "plugin": "securitySolution", - "path": "x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts" - }, - { - "plugin": "securitySolution", - "path": "x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts" - }, - { - "plugin": "securitySolution", - "path": "x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts" - }, - { - "plugin": "inputControlVis", - "path": "src/plugins/input_control_vis/public/control/list_control_factory.ts" - }, - { - "plugin": "inputControlVis", - "path": "src/plugins/input_control_vis/public/control/range_control_factory.ts" - } - ], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.SearchSource.fetch.$1", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.ISearchOptions", - "text": "ISearchOptions" - } - ], - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-public.SearchSource.onRequestStart", - "type": "Function", - "tags": [ - "return" - ], - "label": "onRequestStart", - "description": [ - "\n Add a handler that will be notified whenever requests start" - ], - "signature": [ - "(handler: (searchSource: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchSource", - "text": "SearchSource" - }, - ", options?: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.ISearchOptions", - "text": "ISearchOptions" - }, - " | undefined) => Promise) => void" - ], - "path": "src/plugins/data/common/search/search_source/search_source.ts", + "path": "src/plugins/data/common/search/tabify/tabify_docs.ts", "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-public.SearchSource.onRequestStart.$1", - "type": "Function", - "tags": [], - "label": "handler", - "description": [], - "signature": [ - "(searchSource: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchSource", - "text": "SearchSource" - }, - ", options?: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.ISearchOptions", - "text": "ISearchOptions" - }, - " | undefined) => Promise" - ], - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, + "isRequired": false + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-public.getEsQueryConfig", + "type": "Function", + "tags": [], + "label": "getEsQueryConfig", + "description": [], + "signature": [ + "(config: KibanaConfig) => ", + "EsQueryConfig" + ], + "path": "src/plugins/data/common/es_query/get_es_query_config.ts", + "deprecated": false, + "children": [ { "parentPluginId": "data", - "id": "def-public.SearchSource.getSearchRequestBody", - "type": "Function", + "id": "def-public.getEsQueryConfig.$1", + "type": "Object", "tags": [], - "label": "getSearchRequestBody", - "description": [ - "\nReturns body contents of the search request, often referred as query DSL." - ], + "label": "config", + "description": [], "signature": [ - "() => any" + "KibanaConfig" ], - "path": "src/plugins/data/common/search/search_source/search_source.ts", + "path": "src/plugins/data/common/es_query/get_es_query_config.ts", "deprecated": false, - "children": [], - "returnComment": [] + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-public.getSearchParamsFromRequest", + "type": "Function", + "tags": [], + "label": "getSearchParamsFromRequest", + "description": [], + "signature": [ + "(searchRequest: ", + "SearchRequest", + ", dependencies: { getConfig: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.GetConfigFn", + "text": "GetConfigFn" }, + "; }) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchRequestParams", + "text": "ISearchRequestParams" + } + ], + "path": "src/plugins/data/common/search/search_source/fetch/get_search_params.ts", + "deprecated": false, + "children": [ { "parentPluginId": "data", - "id": "def-public.SearchSource.destroy", - "type": "Function", - "tags": [ - "return" - ], - "label": "destroy", - "description": [ - "\nCompletely destroy the SearchSource." - ], + "id": "def-public.getSearchParamsFromRequest.$1", + "type": "Object", + "tags": [], + "label": "searchRequest", + "description": [], "signature": [ - "() => void" + "SearchRequest" ], - "path": "src/plugins/data/common/search/search_source/search_source.ts", + "path": "src/plugins/data/common/search/search_source/fetch/get_search_params.ts", "deprecated": false, - "children": [], - "returnComment": [] + "isRequired": true }, { "parentPluginId": "data", - "id": "def-public.SearchSource.getSerializedFields", - "type": "Function", + "id": "def-public.getSearchParamsFromRequest.$2", + "type": "Object", "tags": [], - "label": "getSerializedFields", - "description": [ - "\nserializes search source fields (which can later be passed to {@link ISearchStartSearchSource})" - ], - "signature": [ - "(recurse?: boolean) => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SerializedSearchSourceFields", - "text": "SerializedSearchSourceFields" - } - ], - "path": "src/plugins/data/common/search/search_source/search_source.ts", + "label": "dependencies", + "description": [], + "path": "src/plugins/data/common/search/search_source/fetch/get_search_params.ts", "deprecated": false, "children": [ { "parentPluginId": "data", - "id": "def-public.SearchSource.getSerializedFields.$1", - "type": "boolean", + "id": "def-public.getSearchParamsFromRequest.$2.getConfig", + "type": "Function", "tags": [], - "label": "recurse", + "label": "getConfig", "description": [], "signature": [ - "boolean" + "(key: string, defaultOverride?: T | undefined) => T" ], - "path": "src/plugins/data/common/search/search_source/search_source.ts", + "path": "src/plugins/data/common/search/search_source/fetch/get_search_params.ts", "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-public.SearchSource.serialize", - "type": "Function", - "tags": [], - "label": "serialize", - "description": [ - "\nSerializes the instance to a JSON string and a set of referenced objects.\nUse this method to get a representation of the search source which can be stored in a saved object.\n\nThe references returned by this function can be mixed with other references in the same object,\nhowever make sure there are no name-collisions. The references will be named `kibanaSavedObjectMeta.searchSourceJSON.index`\nand `kibanaSavedObjectMeta.searchSourceJSON.filter[].meta.index`.\n\nUsing `createSearchSource`, the instance can be re-created." - ], - "signature": [ - "() => { searchSourceJSON: string; references: ", - "SavedObjectReference", - "[]; }" - ], - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "deprecated": false, - "children": [], - "returnComment": [] + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.getSearchParamsFromRequest.$2.getConfig.$1", + "type": "string", + "tags": [], + "label": "key", + "description": [], + "path": "src/plugins/data/common/types.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.getSearchParamsFromRequest.$2.getConfig.$2", + "type": "Uncategorized", + "tags": [], + "label": "defaultOverride", + "description": [], + "signature": [ + "T | undefined" + ], + "path": "src/plugins/data/common/types.ts", + "deprecated": false + } + ] + } + ] } ], + "returnComment": [], "initialIsOpen": false - } - ], - "functions": [ + }, { "parentPluginId": "data", - "id": "def-public.calculateBounds", + "id": "def-public.getTime", "type": "Function", "tags": [], - "label": "calculateBounds", + "label": "getTime", "description": [], "signature": [ - "(timeRange: ", + "(indexPattern: ", { - "pluginId": "data", + "pluginId": "dataViews", "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" }, - ", options: CalculateBoundsOptions) => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRangeBounds", - "text": "TimeRangeBounds" - } + " | undefined, timeRange: ", + "TimeRange", + ", options: { forceNow?: Date | undefined; fieldName?: string | undefined; } | undefined) => ", + "RangeFilter", + " | ", + "ScriptedRangeFilter", + " | MatchAllRangeFilter | undefined" ], "path": "src/plugins/data/common/query/timefilter/get_time.ts", "deprecated": false, "children": [ { "parentPluginId": "data", - "id": "def-public.calculateBounds.$1", + "id": "def-public.getTime.$1", "type": "Object", "tags": [], - "label": "timeRange", + "label": "indexPattern", "description": [], "signature": [ { - "pluginId": "data", + "pluginId": "dataViews", "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - } + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + " | undefined" ], "path": "src/plugins/data/common/query/timefilter/get_time.ts", "deprecated": false, - "isRequired": true + "isRequired": false }, { "parentPluginId": "data", - "id": "def-public.calculateBounds.$2", + "id": "def-public.getTime.$2", "type": "Object", "tags": [], - "label": "options", + "label": "timeRange", "description": [], "signature": [ - "CalculateBoundsOptions" + "TimeRange" ], "path": "src/plugins/data/common/query/timefilter/get_time.ts", "deprecated": false, "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-public.getTime.$3", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "path": "src/plugins/data/common/query/timefilter/get_time.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-public.getTime.$3.forceNow", + "type": "Object", + "tags": [], + "label": "forceNow", + "description": [], + "signature": [ + "Date | undefined" + ], + "path": "src/plugins/data/common/query/timefilter/get_time.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.getTime.$3.fieldName", + "type": "string", + "tags": [], + "label": "fieldName", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data/common/query/timefilter/get_time.ts", + "deprecated": false + } + ] } ], "returnComment": [], @@ -4481,13 +4366,13 @@ }, { "parentPluginId": "data", - "id": "def-public.extractReferences", + "id": "def-public.injectReferences", "type": "Function", "tags": [], - "label": "extractReferences", + "label": "injectReferences", "description": [], "signature": [ - "(state: ", + "(searchSourceFields: ", { "pluginId": "data", "scope": "common", @@ -4495,27 +4380,26 @@ "section": "def-common.SerializedSearchSourceFields", "text": "SerializedSearchSourceFields" }, - ") => [", + " & { indexRefName: string; }, references: ", + "SavedObjectReference", + "[]) => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SerializedSearchSourceFields", "text": "SerializedSearchSourceFields" - }, - ", ", - "SavedObjectReference", - "[]]" + } ], - "path": "src/plugins/data/common/search/search_source/extract_references.ts", + "path": "src/plugins/data/common/search/search_source/inject_references.ts", "deprecated": false, "children": [ { "parentPluginId": "data", - "id": "def-public.extractReferences.$1", - "type": "Object", + "id": "def-public.injectReferences.$1", + "type": "CompoundType", "tags": [], - "label": "state", + "label": "searchSourceFields", "description": [], "signature": [ { @@ -4524,9 +4408,25 @@ "docId": "kibDataSearchPluginApi", "section": "def-common.SerializedSearchSourceFields", "text": "SerializedSearchSourceFields" - } + }, + " & { indexRefName: string; }" ], - "path": "src/plugins/data/common/search/search_source/extract_references.ts", + "path": "src/plugins/data/common/search/search_source/inject_references.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-public.injectReferences.$2", + "type": "Array", + "tags": [], + "label": "references", + "description": [], + "signature": [ + "SavedObjectReference", + "[]" + ], + "path": "src/plugins/data/common/search/search_source/inject_references.ts", "deprecated": false, "isRequired": true } @@ -4536,178 +4436,209 @@ }, { "parentPluginId": "data", - "id": "def-public.fieldList", + "id": "def-public.isCompleteResponse", "type": "Function", "tags": [], - "label": "fieldList", + "label": "isCompleteResponse", "description": [], "signature": [ - "(specs?: ", + "(response?: ", { - "pluginId": "dataViews", + "pluginId": "data", "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" + "docId": "kibDataSearchPluginApi", + "section": "def-common.IKibanaSearchResponse", + "text": "IKibanaSearchResponse" }, - "[], shortDotsEnable?: boolean) => ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IIndexPatternFieldList", - "text": "IIndexPatternFieldList" - } + " | undefined) => boolean" ], - "path": "src/plugins/data_views/common/fields/field_list.ts", + "path": "src/plugins/data/common/search/utils.ts", "deprecated": false, "children": [ { "parentPluginId": "data", - "id": "def-public.fieldList.$1", - "type": "Array", + "id": "def-public.isCompleteResponse.$1", + "type": "Object", "tags": [], - "label": "specs", + "label": "response", "description": [], "signature": [ { - "pluginId": "dataViews", + "pluginId": "data", "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" + "docId": "kibDataSearchPluginApi", + "section": "def-common.IKibanaSearchResponse", + "text": "IKibanaSearchResponse" }, - "[]" - ], - "path": "src/plugins/data_views/common/fields/field_list.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "data", - "id": "def-public.fieldList.$2", - "type": "boolean", - "tags": [], - "label": "shortDotsEnable", - "description": [], - "signature": [ - "boolean" + " | undefined" ], - "path": "src/plugins/data_views/common/fields/field_list.ts", + "path": "src/plugins/data/common/search/utils.ts", "deprecated": false, - "isRequired": true + "isRequired": false } ], - "returnComment": [], + "returnComment": [ + "true if response is completed successfully" + ], "initialIsOpen": false }, { "parentPluginId": "data", - "id": "def-public.flattenHit", + "id": "def-public.isErrorResponse", "type": "Function", "tags": [], - "label": "flattenHit", - "description": [ - "\nFlattens an individual hit (from an ES response) into an object. This will\ncreate flattened field names, like `user.name`.\n" - ], + "label": "isErrorResponse", + "description": [], "signature": [ - "(hit: Hit, indexPattern: ", + "(response?: ", { - "pluginId": "dataViews", + "pluginId": "data", "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" + "docId": "kibDataSearchPluginApi", + "section": "def-common.IKibanaSearchResponse", + "text": "IKibanaSearchResponse" }, - " | undefined, params: TabifyDocsOptions | undefined) => Record" + " | undefined) => boolean" ], - "path": "src/plugins/data/common/search/tabify/tabify_docs.ts", + "path": "src/plugins/data/common/search/utils.ts", "deprecated": false, "children": [ { "parentPluginId": "data", - "id": "def-public.flattenHit.$1", - "type": "CompoundType", + "id": "def-public.isErrorResponse.$1", + "type": "Object", "tags": [], - "label": "hit", - "description": [ - "The hit from an ES reponse's hits.hits[]" - ], + "label": "response", + "description": [], "signature": [ - "Hit" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IKibanaSearchResponse", + "text": "IKibanaSearchResponse" + }, + " | undefined" ], - "path": "src/plugins/data/common/search/tabify/tabify_docs.ts", + "path": "src/plugins/data/common/search/utils.ts", "deprecated": false, - "isRequired": true - }, + "isRequired": false + } + ], + "returnComment": [ + "true if response had an error while executing in ES" + ], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-public.isFilters", + "type": "Function", + "tags": [ + "deprecated" + ], + "label": "isFilters", + "description": [], + "signature": [ + "(x: unknown) => x is ", + "Filter", + "[]" + ], + "path": "src/plugins/data/common/es_query/index.ts", + "deprecated": true, + "removeBy": "8.1", + "references": [], + "returnComment": [], + "children": [ { "parentPluginId": "data", - "id": "def-public.flattenHit.$2", - "type": "Object", + "id": "def-public.isFilters.$1", + "type": "Unknown", "tags": [], - "label": "indexPattern", - "description": [ - "The index pattern for the requested index if available." - ], + "label": "x", + "description": [], "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" - }, - " | undefined" + "unknown" ], - "path": "src/plugins/data/common/search/tabify/tabify_docs.ts", - "deprecated": false, - "isRequired": false + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-public.isPartialResponse", + "type": "Function", + "tags": [], + "label": "isPartialResponse", + "description": [], + "signature": [ + "(response?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IKibanaSearchResponse", + "text": "IKibanaSearchResponse" }, + " | undefined) => boolean" + ], + "path": "src/plugins/data/common/search/utils.ts", + "deprecated": false, + "children": [ { "parentPluginId": "data", - "id": "def-public.flattenHit.$3", + "id": "def-public.isPartialResponse.$1", "type": "Object", "tags": [], - "label": "params", - "description": [ - "Parameters how to flatten the hit" - ], + "label": "response", + "description": [], "signature": [ - "TabifyDocsOptions | undefined" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IKibanaSearchResponse", + "text": "IKibanaSearchResponse" + }, + " | undefined" ], - "path": "src/plugins/data/common/search/tabify/tabify_docs.ts", + "path": "src/plugins/data/common/search/utils.ts", "deprecated": false, "isRequired": false } ], - "returnComment": [], + "returnComment": [ + "true if request is still running an/d response contains partial results" + ], "initialIsOpen": false }, { "parentPluginId": "data", - "id": "def-public.getEsQueryConfig", + "id": "def-public.isQuery", "type": "Function", "tags": [], - "label": "getEsQueryConfig", + "label": "isQuery", "description": [], "signature": [ - "(config: KibanaConfig) => ", - "EsQueryConfig" + "(x: unknown) => x is ", + "Query" ], - "path": "src/plugins/data/common/es_query/get_es_query_config.ts", + "path": "src/plugins/data/common/query/is_query.ts", "deprecated": false, "children": [ { "parentPluginId": "data", - "id": "def-public.getEsQueryConfig.$1", - "type": "Object", + "id": "def-public.isQuery.$1", + "type": "Unknown", "tags": [], - "label": "config", + "label": "x", "description": [], "signature": [ - "KibanaConfig" + "unknown" ], - "path": "src/plugins/data/common/es_query/get_es_query_config.ts", + "path": "src/plugins/data/common/query/is_query.ts", "deprecated": false, "isRequired": true } @@ -4717,98 +4648,37 @@ }, { "parentPluginId": "data", - "id": "def-public.getSearchParamsFromRequest", + "id": "def-public.isTimeRange", "type": "Function", "tags": [], - "label": "getSearchParamsFromRequest", + "label": "isTimeRange", "description": [], "signature": [ - "(searchRequest: ", - "SearchRequest", - ", dependencies: { getConfig: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.GetConfigFn", - "text": "GetConfigFn" - }, - "; }) => ", + "(x: unknown) => x is ", { "pluginId": "data", "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.ISearchRequestParams", - "text": "ISearchRequestParams" + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" } ], - "path": "src/plugins/data/common/search/search_source/fetch/get_search_params.ts", + "path": "src/plugins/data/common/query/timefilter/is_time_range.ts", "deprecated": false, "children": [ { "parentPluginId": "data", - "id": "def-public.getSearchParamsFromRequest.$1", - "type": "Object", + "id": "def-public.isTimeRange.$1", + "type": "Unknown", "tags": [], - "label": "searchRequest", + "label": "x", "description": [], "signature": [ - "SearchRequest" + "unknown" ], - "path": "src/plugins/data/common/search/search_source/fetch/get_search_params.ts", + "path": "src/plugins/data/common/query/timefilter/is_time_range.ts", "deprecated": false, "isRequired": true - }, - { - "parentPluginId": "data", - "id": "def-public.getSearchParamsFromRequest.$2", - "type": "Object", - "tags": [], - "label": "dependencies", - "description": [], - "path": "src/plugins/data/common/search/search_source/fetch/get_search_params.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-public.getSearchParamsFromRequest.$2.getConfig", - "type": "Function", - "tags": [], - "label": "getConfig", - "description": [], - "signature": [ - "(key: string, defaultOverride?: T | undefined) => T" - ], - "path": "src/plugins/data/common/search/search_source/fetch/get_search_params.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.getSearchParamsFromRequest.$2.getConfig.$1", - "type": "string", - "tags": [], - "label": "key", - "description": [], - "path": "src/plugins/data/common/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.getSearchParamsFromRequest.$2.getConfig.$2", - "type": "Uncategorized", - "tags": [], - "label": "defaultOverride", - "description": [], - "signature": [ - "T | undefined" - ], - "path": "src/plugins/data/common/types.ts", - "deprecated": false - } - ] - } - ] } ], "returnComment": [], @@ -4816,115 +4686,37 @@ }, { "parentPluginId": "data", - "id": "def-public.getTime", + "id": "def-public.parseSearchSourceJSON", "type": "Function", "tags": [], - "label": "getTime", + "label": "parseSearchSourceJSON", "description": [], "signature": [ - "(indexPattern: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IIndexPattern", - "text": "IIndexPattern" - }, - " | undefined, timeRange: ", + "(searchSourceJSON: string) => ", { "pluginId": "data", "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, - ", options: { forceNow?: Date | undefined; fieldName?: string | undefined; } | undefined) => ", - "RangeFilter", - " | ", - "ScriptedRangeFilter", - " | MatchAllRangeFilter | undefined" + "docId": "kibDataSearchPluginApi", + "section": "def-common.SerializedSearchSourceFields", + "text": "SerializedSearchSourceFields" + } ], - "path": "src/plugins/data/common/query/timefilter/get_time.ts", + "path": "src/plugins/data/common/search/search_source/parse_json.ts", "deprecated": false, "children": [ { "parentPluginId": "data", - "id": "def-public.getTime.$1", - "type": "Object", + "id": "def-public.parseSearchSourceJSON.$1", + "type": "string", "tags": [], - "label": "indexPattern", + "label": "searchSourceJSON", "description": [], "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IIndexPattern", - "text": "IIndexPattern" - }, - " | undefined" - ], - "path": "src/plugins/data/common/query/timefilter/get_time.ts", - "deprecated": false, - "isRequired": false - }, - { - "parentPluginId": "data", - "id": "def-public.getTime.$2", - "type": "Object", - "tags": [], - "label": "timeRange", - "description": [], - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - } + "string" ], - "path": "src/plugins/data/common/query/timefilter/get_time.ts", + "path": "src/plugins/data/common/search/search_source/parse_json.ts", "deprecated": false, "isRequired": true - }, - { - "parentPluginId": "data", - "id": "def-public.getTime.$3", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "path": "src/plugins/data/common/query/timefilter/get_time.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-public.getTime.$3.forceNow", - "type": "Object", - "tags": [], - "label": "forceNow", - "description": [], - "signature": [ - "Date | undefined" - ], - "path": "src/plugins/data/common/query/timefilter/get_time.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.getTime.$3.fieldName", - "type": "string", - "tags": [], - "label": "fieldName", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/data/common/query/timefilter/get_time.ts", - "deprecated": false - } - ] } ], "returnComment": [], @@ -4932,468 +4724,340 @@ }, { "parentPluginId": "data", - "id": "def-public.injectReferences", + "id": "def-public.tabifyAggResponse", "type": "Function", "tags": [], - "label": "injectReferences", - "description": [], + "label": "tabifyAggResponse", + "description": [ + "\nSets up the ResponseWriter and kicks off bucket collection." + ], "signature": [ - "(searchSourceFields: ", + "(aggConfigs: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.SerializedSearchSourceFields", - "text": "SerializedSearchSourceFields" + "section": "def-common.AggConfigs", + "text": "AggConfigs" }, - " & { indexRefName: string; }, references: ", - "SavedObjectReference", - "[]) => ", + ", esResponse: Record, respOpts: Partial<", + "TabbedResponseWriterOptions", + "> | undefined) => ", { - "pluginId": "data", + "pluginId": "expressions", "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SerializedSearchSourceFields", - "text": "SerializedSearchSourceFields" + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" } ], - "path": "src/plugins/data/common/search/search_source/inject_references.ts", + "path": "src/plugins/data/common/search/tabify/tabify.ts", "deprecated": false, "children": [ { "parentPluginId": "data", - "id": "def-public.injectReferences.$1", - "type": "CompoundType", + "id": "def-public.tabifyAggResponse.$1", + "type": "Object", "tags": [], - "label": "searchSourceFields", + "label": "aggConfigs", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.SerializedSearchSourceFields", - "text": "SerializedSearchSourceFields" - }, - " & { indexRefName: string; }" + "section": "def-common.AggConfigs", + "text": "AggConfigs" + } ], - "path": "src/plugins/data/common/search/search_source/inject_references.ts", + "path": "src/plugins/data/common/search/tabify/tabify.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "data", - "id": "def-public.injectReferences.$2", - "type": "Array", + "id": "def-public.tabifyAggResponse.$2", + "type": "Object", "tags": [], - "label": "references", + "label": "esResponse", "description": [], "signature": [ - "SavedObjectReference", - "[]" + "Record" ], - "path": "src/plugins/data/common/search/search_source/inject_references.ts", + "path": "src/plugins/data/common/search/tabify/tabify.ts", "deprecated": false, "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-public.tabifyAggResponse.$3", + "type": "Object", + "tags": [], + "label": "respOpts", + "description": [], + "signature": [ + "Partial<", + "TabbedResponseWriterOptions", + "> | undefined" + ], + "path": "src/plugins/data/common/search/tabify/tabify.ts", + "deprecated": false, + "isRequired": false } ], "returnComment": [], "initialIsOpen": false - }, + } + ], + "interfaces": [ { "parentPluginId": "data", - "id": "def-public.isCompleteResponse", - "type": "Function", + "id": "def-public.AggFunctionsMapping", + "type": "Interface", "tags": [], - "label": "isCompleteResponse", - "description": [], - "signature": [ - "(response?: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.IKibanaSearchResponse", - "text": "IKibanaSearchResponse" - }, - " | undefined) => boolean" + "label": "AggFunctionsMapping", + "description": [ + "\nA global list of the expression function definitions for each agg type function." ], - "path": "src/plugins/data/common/search/utils.ts", + "path": "src/plugins/data/common/search/aggs/types.ts", "deprecated": false, "children": [ { "parentPluginId": "data", - "id": "def-public.isCompleteResponse.$1", + "id": "def-public.AggFunctionsMapping.aggFilter", "type": "Object", "tags": [], - "label": "response", + "label": "aggFilter", "description": [], "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggFilter\", any, Arguments, ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.IKibanaSearchResponse", - "text": "IKibanaSearchResponse" + "section": "def-common.AggExpressionType", + "text": "AggExpressionType" }, - " | undefined" + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableRecord", + ">>" ], - "path": "src/plugins/data/common/search/utils.ts", - "deprecated": false, - "isRequired": false - } - ], - "returnComment": [ - "true if response is completed successfully" - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-public.isErrorResponse", - "type": "Function", - "tags": [], - "label": "isErrorResponse", - "description": [], - "signature": [ - "(response?: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.IKibanaSearchResponse", - "text": "IKibanaSearchResponse" + "path": "src/plugins/data/common/search/aggs/types.ts", + "deprecated": false }, - " | undefined) => boolean" - ], - "path": "src/plugins/data/common/search/utils.ts", - "deprecated": false, - "children": [ { "parentPluginId": "data", - "id": "def-public.isErrorResponse.$1", + "id": "def-public.AggFunctionsMapping.aggFilters", "type": "Object", "tags": [], - "label": "response", + "label": "aggFilters", "description": [], "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggFilters\", any, Arguments, ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.IKibanaSearchResponse", - "text": "IKibanaSearchResponse" + "section": "def-common.AggExpressionType", + "text": "AggExpressionType" }, - " | undefined" - ], - "path": "src/plugins/data/common/search/utils.ts", - "deprecated": false, - "isRequired": false - } - ], - "returnComment": [ - "true if response had an error while executing in ES" - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-public.isFilters", - "type": "Function", - "tags": [ - "deprecated" - ], - "label": "isFilters", - "description": [], - "signature": [ - "(x: unknown) => x is ", - "Filter", - "[]" - ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [], - "returnComment": [], - "children": [ + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableRecord", + ">>" + ], + "path": "src/plugins/data/common/search/aggs/types.ts", + "deprecated": false + }, { "parentPluginId": "data", - "id": "def-public.isFilters.$1", - "type": "Unknown", + "id": "def-public.AggFunctionsMapping.aggSignificantTerms", + "type": "Object", "tags": [], - "label": "x", + "label": "aggSignificantTerms", "description": [], "signature": [ - "unknown" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggSignificantTerms\", any, AggArgs, ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggExpressionType", + "text": "AggExpressionType" + }, + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableRecord", + ">>" ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", + "path": "src/plugins/data/common/search/aggs/types.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-public.isPartialResponse", - "type": "Function", - "tags": [], - "label": "isPartialResponse", - "description": [], - "signature": [ - "(response?: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.IKibanaSearchResponse", - "text": "IKibanaSearchResponse" }, - " | undefined) => boolean" - ], - "path": "src/plugins/data/common/search/utils.ts", - "deprecated": false, - "children": [ { "parentPluginId": "data", - "id": "def-public.isPartialResponse.$1", + "id": "def-public.AggFunctionsMapping.aggIpRange", "type": "Object", "tags": [], - "label": "response", + "label": "aggIpRange", "description": [], "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggIpRange\", any, Arguments, ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.IKibanaSearchResponse", - "text": "IKibanaSearchResponse" + "section": "def-common.AggExpressionType", + "text": "AggExpressionType" }, - " | undefined" + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableRecord", + ">>" ], - "path": "src/plugins/data/common/search/utils.ts", - "deprecated": false, - "isRequired": false - } - ], - "returnComment": [ - "true if request is still running an/d response contains partial results" - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-public.isQuery", - "type": "Function", - "tags": [], - "label": "isQuery", - "description": [], - "signature": [ - "(x: unknown) => x is ", - "Query" - ], - "path": "src/plugins/data/common/query/is_query.ts", - "deprecated": false, - "children": [ + "path": "src/plugins/data/common/search/aggs/types.ts", + "deprecated": false + }, { "parentPluginId": "data", - "id": "def-public.isQuery.$1", - "type": "Unknown", + "id": "def-public.AggFunctionsMapping.aggDateRange", + "type": "Object", "tags": [], - "label": "x", + "label": "aggDateRange", "description": [], "signature": [ - "unknown" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggDateRange\", any, Arguments, ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggExpressionType", + "text": "AggExpressionType" + }, + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableRecord", + ">>" ], - "path": "src/plugins/data/common/query/is_query.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-public.isTimeRange", - "type": "Function", - "tags": [], - "label": "isTimeRange", - "description": [], - "signature": [ - "(x: unknown) => x is ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - } - ], - "path": "src/plugins/data/common/query/timefilter/is_time_range.ts", - "deprecated": false, - "children": [ + "path": "src/plugins/data/common/search/aggs/types.ts", + "deprecated": false + }, { "parentPluginId": "data", - "id": "def-public.isTimeRange.$1", - "type": "Unknown", + "id": "def-public.AggFunctionsMapping.aggRange", + "type": "Object", "tags": [], - "label": "x", - "description": [], - "signature": [ - "unknown" - ], - "path": "src/plugins/data/common/query/timefilter/is_time_range.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-public.parseSearchSourceJSON", - "type": "Function", - "tags": [], - "label": "parseSearchSourceJSON", - "description": [], - "signature": [ - "(searchSourceJSON: string) => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SerializedSearchSourceFields", - "text": "SerializedSearchSourceFields" - } - ], - "path": "src/plugins/data/common/search/search_source/parse_json.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-public.parseSearchSourceJSON.$1", - "type": "string", - "tags": [], - "label": "searchSourceJSON", - "description": [], - "signature": [ - "string" - ], - "path": "src/plugins/data/common/search/search_source/parse_json.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-public.tabifyAggResponse", - "type": "Function", - "tags": [], - "label": "tabifyAggResponse", - "description": [ - "\nSets up the ResponseWriter and kicks off bucket collection." - ], - "signature": [ - "(aggConfigs: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggConfigs", - "text": "AggConfigs" - }, - ", esResponse: Record, respOpts: Partial<", - "TabbedResponseWriterOptions", - "> | undefined) => ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.Datatable", - "text": "Datatable" - } - ], - "path": "src/plugins/data/common/search/tabify/tabify.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-public.tabifyAggResponse.$1", - "type": "Object", - "tags": [], - "label": "aggConfigs", - "description": [], - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggConfigs", - "text": "AggConfigs" - } - ], - "path": "src/plugins/data/common/search/tabify/tabify.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "data", - "id": "def-public.tabifyAggResponse.$2", - "type": "Object", - "tags": [], - "label": "esResponse", - "description": [], - "signature": [ - "Record" - ], - "path": "src/plugins/data/common/search/tabify/tabify.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "data", - "id": "def-public.tabifyAggResponse.$3", - "type": "Object", - "tags": [], - "label": "respOpts", - "description": [], - "signature": [ - "Partial<", - "TabbedResponseWriterOptions", - "> | undefined" - ], - "path": "src/plugins/data/common/search/tabify/tabify.ts", - "deprecated": false, - "isRequired": false - } - ], - "returnComment": [], - "initialIsOpen": false - } - ], - "interfaces": [ - { - "parentPluginId": "data", - "id": "def-public.AggFunctionsMapping", - "type": "Interface", - "tags": [], - "label": "AggFunctionsMapping", - "description": [ - "\nA global list of the expression function definitions for each agg type function." - ], - "path": "src/plugins/data/common/search/aggs/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-public.AggFunctionsMapping.aggFilter", - "type": "Object", - "tags": [], - "label": "aggFilter", + "label": "aggRange", "description": [], "signature": [ { @@ -5403,7 +5067,7 @@ "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, - "<\"aggFilter\", any, Arguments, ", + "<\"aggRange\", any, Arguments, ", { "pluginId": "data", "scope": "common", @@ -5436,10 +5100,10 @@ }, { "parentPluginId": "data", - "id": "def-public.AggFunctionsMapping.aggFilters", + "id": "def-public.AggFunctionsMapping.aggGeoTile", "type": "Object", "tags": [], - "label": "aggFilters", + "label": "aggGeoTile", "description": [], "signature": [ { @@ -5449,7 +5113,7 @@ "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, - "<\"aggFilters\", any, Arguments, ", + "<\"aggGeoTile\", any, AggArgs, ", { "pluginId": "data", "scope": "common", @@ -5482,10 +5146,10 @@ }, { "parentPluginId": "data", - "id": "def-public.AggFunctionsMapping.aggSignificantTerms", + "id": "def-public.AggFunctionsMapping.aggGeoHash", "type": "Object", "tags": [], - "label": "aggSignificantTerms", + "label": "aggGeoHash", "description": [], "signature": [ { @@ -5495,7 +5159,7 @@ "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, - "<\"aggSignificantTerms\", any, AggArgs, ", + "<\"aggGeoHash\", any, Arguments, ", { "pluginId": "data", "scope": "common", @@ -5528,10 +5192,10 @@ }, { "parentPluginId": "data", - "id": "def-public.AggFunctionsMapping.aggIpRange", + "id": "def-public.AggFunctionsMapping.aggHistogram", "type": "Object", "tags": [], - "label": "aggIpRange", + "label": "aggHistogram", "description": [], "signature": [ { @@ -5541,7 +5205,7 @@ "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, - "<\"aggIpRange\", any, Arguments, ", + "<\"aggHistogram\", any, Arguments, ", { "pluginId": "data", "scope": "common", @@ -5574,10 +5238,10 @@ }, { "parentPluginId": "data", - "id": "def-public.AggFunctionsMapping.aggDateRange", + "id": "def-public.AggFunctionsMapping.aggDateHistogram", "type": "Object", "tags": [], - "label": "aggDateRange", + "label": "aggDateHistogram", "description": [], "signature": [ { @@ -5587,7 +5251,7 @@ "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, - "<\"aggDateRange\", any, Arguments, ", + "<\"aggDateHistogram\", any, Arguments, ", { "pluginId": "data", "scope": "common", @@ -5620,10 +5284,10 @@ }, { "parentPluginId": "data", - "id": "def-public.AggFunctionsMapping.aggRange", + "id": "def-public.AggFunctionsMapping.aggTerms", "type": "Object", "tags": [], - "label": "aggRange", + "label": "aggTerms", "description": [], "signature": [ { @@ -5633,7 +5297,7 @@ "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, - "<\"aggRange\", any, Arguments, ", + "<\"aggTerms\", any, Arguments, ", { "pluginId": "data", "scope": "common", @@ -5666,10 +5330,10 @@ }, { "parentPluginId": "data", - "id": "def-public.AggFunctionsMapping.aggGeoTile", + "id": "def-public.AggFunctionsMapping.aggMultiTerms", "type": "Object", "tags": [], - "label": "aggGeoTile", + "label": "aggMultiTerms", "description": [], "signature": [ { @@ -5679,7 +5343,7 @@ "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, - "<\"aggGeoTile\", any, AggArgs, ", + "<\"aggMultiTerms\", any, Arguments, ", { "pluginId": "data", "scope": "common", @@ -5712,10 +5376,10 @@ }, { "parentPluginId": "data", - "id": "def-public.AggFunctionsMapping.aggGeoHash", + "id": "def-public.AggFunctionsMapping.aggRareTerms", "type": "Object", "tags": [], - "label": "aggGeoHash", + "label": "aggRareTerms", "description": [], "signature": [ { @@ -5725,7 +5389,7 @@ "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, - "<\"aggGeoHash\", any, Arguments, ", + "<\"aggRareTerms\", any, AggArgs, ", { "pluginId": "data", "scope": "common", @@ -5758,10 +5422,10 @@ }, { "parentPluginId": "data", - "id": "def-public.AggFunctionsMapping.aggHistogram", + "id": "def-public.AggFunctionsMapping.aggAvg", "type": "Object", "tags": [], - "label": "aggHistogram", + "label": "aggAvg", "description": [], "signature": [ { @@ -5771,7 +5435,7 @@ "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, - "<\"aggHistogram\", any, Arguments, ", + "<\"aggAvg\", any, AggArgs, ", { "pluginId": "data", "scope": "common", @@ -5804,10 +5468,10 @@ }, { "parentPluginId": "data", - "id": "def-public.AggFunctionsMapping.aggDateHistogram", + "id": "def-public.AggFunctionsMapping.aggBucketAvg", "type": "Object", "tags": [], - "label": "aggDateHistogram", + "label": "aggBucketAvg", "description": [], "signature": [ { @@ -5817,7 +5481,7 @@ "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, - "<\"aggDateHistogram\", any, Arguments, ", + "<\"aggBucketAvg\", any, Arguments, ", { "pluginId": "data", "scope": "common", @@ -5850,10 +5514,10 @@ }, { "parentPluginId": "data", - "id": "def-public.AggFunctionsMapping.aggTerms", + "id": "def-public.AggFunctionsMapping.aggBucketMax", "type": "Object", "tags": [], - "label": "aggTerms", + "label": "aggBucketMax", "description": [], "signature": [ { @@ -5863,7 +5527,7 @@ "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, - "<\"aggTerms\", any, Arguments, ", + "<\"aggBucketMax\", any, Arguments, ", { "pluginId": "data", "scope": "common", @@ -5896,10 +5560,10 @@ }, { "parentPluginId": "data", - "id": "def-public.AggFunctionsMapping.aggMultiTerms", + "id": "def-public.AggFunctionsMapping.aggBucketMin", "type": "Object", "tags": [], - "label": "aggMultiTerms", + "label": "aggBucketMin", "description": [], "signature": [ { @@ -5909,7 +5573,7 @@ "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, - "<\"aggMultiTerms\", any, Arguments, ", + "<\"aggBucketMin\", any, Arguments, ", { "pluginId": "data", "scope": "common", @@ -5942,10 +5606,10 @@ }, { "parentPluginId": "data", - "id": "def-public.AggFunctionsMapping.aggRareTerms", + "id": "def-public.AggFunctionsMapping.aggBucketSum", "type": "Object", "tags": [], - "label": "aggRareTerms", + "label": "aggBucketSum", "description": [], "signature": [ { @@ -5955,7 +5619,7 @@ "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, - "<\"aggRareTerms\", any, AggArgs, ", + "<\"aggBucketSum\", any, Arguments, ", { "pluginId": "data", "scope": "common", @@ -5988,10 +5652,10 @@ }, { "parentPluginId": "data", - "id": "def-public.AggFunctionsMapping.aggAvg", + "id": "def-public.AggFunctionsMapping.aggFilteredMetric", "type": "Object", "tags": [], - "label": "aggAvg", + "label": "aggFilteredMetric", "description": [], "signature": [ { @@ -6001,7 +5665,7 @@ "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, - "<\"aggAvg\", any, AggArgs, ", + "<\"aggFilteredMetric\", any, Arguments, ", { "pluginId": "data", "scope": "common", @@ -6034,10 +5698,10 @@ }, { "parentPluginId": "data", - "id": "def-public.AggFunctionsMapping.aggBucketAvg", + "id": "def-public.AggFunctionsMapping.aggCardinality", "type": "Object", "tags": [], - "label": "aggBucketAvg", + "label": "aggCardinality", "description": [], "signature": [ { @@ -6047,7 +5711,7 @@ "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, - "<\"aggBucketAvg\", any, Arguments, ", + "<\"aggCardinality\", any, AggArgs, ", { "pluginId": "data", "scope": "common", @@ -6080,10 +5744,10 @@ }, { "parentPluginId": "data", - "id": "def-public.AggFunctionsMapping.aggBucketMax", + "id": "def-public.AggFunctionsMapping.aggCount", "type": "Object", "tags": [], - "label": "aggBucketMax", + "label": "aggCount", "description": [], "signature": [ { @@ -6093,7 +5757,7 @@ "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, - "<\"aggBucketMax\", any, Arguments, ", + "<\"aggCount\", any, AggArgs, ", { "pluginId": "data", "scope": "common", @@ -6126,10 +5790,10 @@ }, { "parentPluginId": "data", - "id": "def-public.AggFunctionsMapping.aggBucketMin", + "id": "def-public.AggFunctionsMapping.aggCumulativeSum", "type": "Object", "tags": [], - "label": "aggBucketMin", + "label": "aggCumulativeSum", "description": [], "signature": [ { @@ -6139,7 +5803,7 @@ "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, - "<\"aggBucketMin\", any, Arguments, ", + "<\"aggCumulativeSum\", any, Arguments, ", { "pluginId": "data", "scope": "common", @@ -6172,10 +5836,10 @@ }, { "parentPluginId": "data", - "id": "def-public.AggFunctionsMapping.aggBucketSum", + "id": "def-public.AggFunctionsMapping.aggDerivative", "type": "Object", "tags": [], - "label": "aggBucketSum", + "label": "aggDerivative", "description": [], "signature": [ { @@ -6185,7 +5849,7 @@ "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, - "<\"aggBucketSum\", any, Arguments, ", + "<\"aggDerivative\", any, Arguments, ", { "pluginId": "data", "scope": "common", @@ -6218,194 +5882,10 @@ }, { "parentPluginId": "data", - "id": "def-public.AggFunctionsMapping.aggFilteredMetric", + "id": "def-public.AggFunctionsMapping.aggGeoBounds", "type": "Object", "tags": [], - "label": "aggFilteredMetric", - "description": [], - "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"aggFilteredMetric\", any, Arguments, ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggExpressionType", - "text": "AggExpressionType" - }, - ", ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutionContext", - "text": "ExecutionContext" - }, - "<", - { - "pluginId": "inspector", - "scope": "common", - "docId": "kibInspectorPluginApi", - "section": "def-common.Adapters", - "text": "Adapters" - }, - ", ", - "SerializableRecord", - ">>" - ], - "path": "src/plugins/data/common/search/aggs/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.AggFunctionsMapping.aggCardinality", - "type": "Object", - "tags": [], - "label": "aggCardinality", - "description": [], - "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"aggCardinality\", any, AggArgs, ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggExpressionType", - "text": "AggExpressionType" - }, - ", ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutionContext", - "text": "ExecutionContext" - }, - "<", - { - "pluginId": "inspector", - "scope": "common", - "docId": "kibInspectorPluginApi", - "section": "def-common.Adapters", - "text": "Adapters" - }, - ", ", - "SerializableRecord", - ">>" - ], - "path": "src/plugins/data/common/search/aggs/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.AggFunctionsMapping.aggCount", - "type": "Object", - "tags": [], - "label": "aggCount", - "description": [], - "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"aggCount\", any, AggArgs, ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggExpressionType", - "text": "AggExpressionType" - }, - ", ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutionContext", - "text": "ExecutionContext" - }, - "<", - { - "pluginId": "inspector", - "scope": "common", - "docId": "kibInspectorPluginApi", - "section": "def-common.Adapters", - "text": "Adapters" - }, - ", ", - "SerializableRecord", - ">>" - ], - "path": "src/plugins/data/common/search/aggs/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.AggFunctionsMapping.aggCumulativeSum", - "type": "Object", - "tags": [], - "label": "aggCumulativeSum", - "description": [], - "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"aggCumulativeSum\", any, Arguments, ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggExpressionType", - "text": "AggExpressionType" - }, - ", ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutionContext", - "text": "ExecutionContext" - }, - "<", - { - "pluginId": "inspector", - "scope": "common", - "docId": "kibInspectorPluginApi", - "section": "def-common.Adapters", - "text": "Adapters" - }, - ", ", - "SerializableRecord", - ">>" - ], - "path": "src/plugins/data/common/search/aggs/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.AggFunctionsMapping.aggDerivative", - "type": "Object", - "tags": [], - "label": "aggDerivative", + "label": "aggGeoBounds", "description": [], "signature": [ { @@ -6415,7 +5895,7 @@ "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, - "<\"aggDerivative\", any, Arguments, ", + "<\"aggGeoBounds\", any, AggArgs, ", { "pluginId": "data", "scope": "common", @@ -6448,10 +5928,10 @@ }, { "parentPluginId": "data", - "id": "def-public.AggFunctionsMapping.aggGeoBounds", + "id": "def-public.AggFunctionsMapping.aggGeoCentroid", "type": "Object", "tags": [], - "label": "aggGeoBounds", + "label": "aggGeoCentroid", "description": [], "signature": [ { @@ -6461,7 +5941,7 @@ "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, - "<\"aggGeoBounds\", any, AggArgs, ", + "<\"aggGeoCentroid\", any, AggArgs, ", { "pluginId": "data", "scope": "common", @@ -6494,10 +5974,10 @@ }, { "parentPluginId": "data", - "id": "def-public.AggFunctionsMapping.aggGeoCentroid", + "id": "def-public.AggFunctionsMapping.aggMax", "type": "Object", "tags": [], - "label": "aggGeoCentroid", + "label": "aggMax", "description": [], "signature": [ { @@ -6507,7 +5987,7 @@ "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, - "<\"aggGeoCentroid\", any, AggArgs, ", + "<\"aggMax\", any, AggArgs, ", { "pluginId": "data", "scope": "common", @@ -6540,10 +6020,10 @@ }, { "parentPluginId": "data", - "id": "def-public.AggFunctionsMapping.aggMax", + "id": "def-public.AggFunctionsMapping.aggMedian", "type": "Object", "tags": [], - "label": "aggMax", + "label": "aggMedian", "description": [], "signature": [ { @@ -6553,7 +6033,7 @@ "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, - "<\"aggMax\", any, AggArgs, ", + "<\"aggMedian\", any, AggArgs, ", { "pluginId": "data", "scope": "common", @@ -6586,10 +6066,10 @@ }, { "parentPluginId": "data", - "id": "def-public.AggFunctionsMapping.aggMedian", + "id": "def-public.AggFunctionsMapping.aggSinglePercentile", "type": "Object", "tags": [], - "label": "aggMedian", + "label": "aggSinglePercentile", "description": [], "signature": [ { @@ -6599,7 +6079,7 @@ "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, - "<\"aggMedian\", any, AggArgs, ", + "<\"aggSinglePercentile\", any, AggArgs, ", { "pluginId": "data", "scope": "common", @@ -6632,10 +6112,10 @@ }, { "parentPluginId": "data", - "id": "def-public.AggFunctionsMapping.aggSinglePercentile", + "id": "def-public.AggFunctionsMapping.aggSinglePercentileRank", "type": "Object", "tags": [], - "label": "aggSinglePercentile", + "label": "aggSinglePercentileRank", "description": [], "signature": [ { @@ -6645,7 +6125,7 @@ "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, - "<\"aggSinglePercentile\", any, AggArgs, ", + "<\"aggSinglePercentileRank\", any, AggArgs, ", { "pluginId": "data", "scope": "common", @@ -7253,7 +6733,9 @@ "type": "Interface", "tags": [], "label": "DataViewListItem", - "description": [], + "description": [ + "\nResult from data view search - summary data." + ], "path": "src/plugins/data_views/common/data_views/data_views.ts", "deprecated": false, "children": [ @@ -7263,7 +6745,9 @@ "type": "string", "tags": [], "label": "id", - "description": [], + "description": [ + "\nSaved object id" + ], "path": "src/plugins/data_views/common/data_views/data_views.ts", "deprecated": false }, @@ -7273,7 +6757,9 @@ "type": "Array", "tags": [], "label": "namespaces", - "description": [], + "description": [ + "\nNamespace ids" + ], "signature": [ "string[] | undefined" ], @@ -7286,7 +6772,9 @@ "type": "string", "tags": [], "label": "title", - "description": [], + "description": [ + "\nData view title" + ], "path": "src/plugins/data_views/common/data_views/data_views.ts", "deprecated": false }, @@ -7296,7 +6784,9 @@ "type": "string", "tags": [], "label": "type", - "description": [], + "description": [ + "\nData view type" + ], "signature": [ "string | undefined" ], @@ -7309,7 +6799,9 @@ "type": "Object", "tags": [], "label": "typeMeta", - "description": [], + "description": [ + "\nData view type meta" + ], "signature": [ { "pluginId": "dataViews", @@ -7677,388 +7169,474 @@ }, { "parentPluginId": "data", - "id": "def-public.IFieldType", + "id": "def-public.IKibanaSearchRequest", "type": "Interface", - "tags": [ - "deprecated" - ], - "label": "IFieldType", + "tags": [], + "label": "IKibanaSearchRequest", "description": [], "signature": [ { - "pluginId": "dataViews", + "pluginId": "data", "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" + "docId": "kibDataSearchPluginApi", + "section": "def-common.IKibanaSearchRequest", + "text": "IKibanaSearchRequest" }, - " extends ", - "DataViewFieldBase" + "" ], - "path": "src/plugins/data_views/common/fields/types.ts", - "deprecated": true, - "removeBy": "8.2", - "references": [ - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/fields/utils.ts" - }, + "path": "src/plugins/data/common/search/types.ts", + "deprecated": false, + "children": [ { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/fields/utils.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/fields/data_view_field.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/fields/data_view_field.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/fields/field_list.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/fields/field_list.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/fields/field_list.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/fields/field_list.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/index.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/types.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/types.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/types.ts" + "parentPluginId": "data", + "id": "def-public.IKibanaSearchRequest.id", + "type": "string", + "tags": [], + "label": "id", + "description": [ + "\nAn id can be used to uniquely identify this request." + ], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data/common/search/types.ts", + "deprecated": false }, { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/types.ts" - }, + "parentPluginId": "data", + "id": "def-public.IKibanaSearchRequest.params", + "type": "Uncategorized", + "tags": [], + "label": "params", + "description": [], + "signature": [ + "Params | undefined" + ], + "path": "src/plugins/data/common/search/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-public.IKibanaSearchResponse", + "type": "Interface", + "tags": [], + "label": "IKibanaSearchResponse", + "description": [], + "signature": [ { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/utils.test.ts" + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IKibanaSearchResponse", + "text": "IKibanaSearchResponse" }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/utils.test.ts" - } + "" ], + "path": "src/plugins/data/common/search/types.ts", + "deprecated": false, "children": [ { "parentPluginId": "data", - "id": "def-public.IFieldType.count", + "id": "def-public.IKibanaSearchResponse.id", + "type": "string", + "tags": [], + "label": "id", + "description": [ + "\nSome responses may contain a unique id to identify the request this response came from." + ], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data/common/search/types.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.IKibanaSearchResponse.total", "type": "number", "tags": [], - "label": "count", - "description": [], + "label": "total", + "description": [ + "\nIf relevant to the search strategy, return a total number\nthat represents how progress is indicated." + ], "signature": [ "number | undefined" ], - "path": "src/plugins/data_views/common/fields/types.ts", + "path": "src/plugins/data/common/search/types.ts", "deprecated": false }, { "parentPluginId": "data", - "id": "def-public.IFieldType.esTypes", - "type": "Array", + "id": "def-public.IKibanaSearchResponse.loaded", + "type": "number", "tags": [], - "label": "esTypes", - "description": [], + "label": "loaded", + "description": [ + "\nIf relevant to the search strategy, return a loaded number\nthat represents how progress is indicated." + ], "signature": [ - "string[] | undefined" + "number | undefined" ], - "path": "src/plugins/data_views/common/fields/types.ts", + "path": "src/plugins/data/common/search/types.ts", "deprecated": false }, { "parentPluginId": "data", - "id": "def-public.IFieldType.aggregatable", + "id": "def-public.IKibanaSearchResponse.isRunning", "type": "CompoundType", "tags": [], - "label": "aggregatable", - "description": [], + "label": "isRunning", + "description": [ + "\nIndicates whether search is still in flight" + ], "signature": [ "boolean | undefined" ], - "path": "src/plugins/data_views/common/fields/types.ts", + "path": "src/plugins/data/common/search/types.ts", "deprecated": false }, { "parentPluginId": "data", - "id": "def-public.IFieldType.filterable", + "id": "def-public.IKibanaSearchResponse.isPartial", "type": "CompoundType", "tags": [], - "label": "filterable", - "description": [], + "label": "isPartial", + "description": [ + "\nIndicates whether the results returned are complete or partial" + ], "signature": [ "boolean | undefined" ], - "path": "src/plugins/data_views/common/fields/types.ts", + "path": "src/plugins/data/common/search/types.ts", "deprecated": false }, { "parentPluginId": "data", - "id": "def-public.IFieldType.searchable", + "id": "def-public.IKibanaSearchResponse.isRestored", "type": "CompoundType", "tags": [], - "label": "searchable", - "description": [], + "label": "isRestored", + "description": [ + "\nIndicates whether the results returned are from the async-search index" + ], "signature": [ "boolean | undefined" ], - "path": "src/plugins/data_views/common/fields/types.ts", + "path": "src/plugins/data/common/search/types.ts", "deprecated": false }, { "parentPluginId": "data", - "id": "def-public.IFieldType.sortable", - "type": "CompoundType", + "id": "def-public.IKibanaSearchResponse.warning", + "type": "string", "tags": [], - "label": "sortable", - "description": [], + "label": "warning", + "description": [ + "\nOptional warnings returned from Elasticsearch (for example, deprecation warnings)" + ], "signature": [ - "boolean | undefined" + "string | undefined" ], - "path": "src/plugins/data_views/common/fields/types.ts", + "path": "src/plugins/data/common/search/types.ts", "deprecated": false }, { "parentPluginId": "data", - "id": "def-public.IFieldType.visualizable", - "type": "CompoundType", + "id": "def-public.IKibanaSearchResponse.rawResponse", + "type": "Uncategorized", "tags": [], - "label": "visualizable", - "description": [], + "label": "rawResponse", + "description": [ + "\nThe raw response returned by the internal search method (usually the raw ES response)" + ], "signature": [ - "boolean | undefined" + "RawResponse" ], - "path": "src/plugins/data_views/common/fields/types.ts", + "path": "src/plugins/data/common/search/types.ts", "deprecated": false - }, + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-public.ISearchOptions", + "type": "Interface", + "tags": [], + "label": "ISearchOptions", + "description": [], + "path": "src/plugins/data/common/search/types.ts", + "deprecated": false, + "children": [ { "parentPluginId": "data", - "id": "def-public.IFieldType.readFromDocValues", - "type": "CompoundType", + "id": "def-public.ISearchOptions.abortSignal", + "type": "Object", "tags": [], - "label": "readFromDocValues", - "description": [], + "label": "abortSignal", + "description": [ + "\nAn `AbortSignal` that allows the caller of `search` to abort a search request." + ], "signature": [ - "boolean | undefined" + "AbortSignal | undefined" ], - "path": "src/plugins/data_views/common/fields/types.ts", + "path": "src/plugins/data/common/search/types.ts", "deprecated": false }, { "parentPluginId": "data", - "id": "def-public.IFieldType.displayName", + "id": "def-public.ISearchOptions.strategy", "type": "string", "tags": [], - "label": "displayName", - "description": [], + "label": "strategy", + "description": [ + "\nUse this option to force using a specific server side search strategy. Leave empty to use the default strategy." + ], "signature": [ "string | undefined" ], - "path": "src/plugins/data_views/common/fields/types.ts", + "path": "src/plugins/data/common/search/types.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.ISearchOptions.legacyHitsTotal", + "type": "CompoundType", + "tags": [], + "label": "legacyHitsTotal", + "description": [ + "\nRequest the legacy format for the total number of hits. If sending `rest_total_hits_as_int` to\nsomething other than `true`, this should be set to `false`." + ], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/data/common/search/types.ts", "deprecated": false }, { "parentPluginId": "data", - "id": "def-public.IFieldType.customLabel", + "id": "def-public.ISearchOptions.sessionId", "type": "string", "tags": [], - "label": "customLabel", - "description": [], + "label": "sessionId", + "description": [ + "\nA session ID, grouping multiple search requests into a single session." + ], "signature": [ "string | undefined" ], - "path": "src/plugins/data_views/common/fields/types.ts", + "path": "src/plugins/data/common/search/types.ts", "deprecated": false }, { "parentPluginId": "data", - "id": "def-public.IFieldType.format", - "type": "Any", + "id": "def-public.ISearchOptions.isStored", + "type": "CompoundType", "tags": [], - "label": "format", - "description": [], + "label": "isStored", + "description": [ + "\nWhether the session is already saved (i.e. sent to background)" + ], "signature": [ - "any" + "boolean | undefined" ], - "path": "src/plugins/data_views/common/fields/types.ts", + "path": "src/plugins/data/common/search/types.ts", "deprecated": false }, { "parentPluginId": "data", - "id": "def-public.IFieldType.toSpec", - "type": "Function", + "id": "def-public.ISearchOptions.isRestore", + "type": "CompoundType", "tags": [], - "label": "toSpec", - "description": [], + "label": "isRestore", + "description": [ + "\nWhether the session is restored (i.e. search requests should re-use the stored search IDs,\nrather than starting from scratch)" + ], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/data/common/search/types.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.ISearchOptions.indexPattern", + "type": "Object", + "tags": [], + "label": "indexPattern", + "description": [ + "\nIndex pattern reference is used for better error messages" + ], "signature": [ - "((options?: { getFormatterForField?: ((field: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" - }, - " | ", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" + "section": "def-common.DataView", + "text": "DataView" }, - " | ", + " | undefined" + ], + "path": "src/plugins/data/common/search/types.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.ISearchOptions.inspector", + "type": "Object", + "tags": [], + "label": "inspector", + "description": [ + "\nInspector integration options" + ], + "signature": [ { - "pluginId": "dataViews", + "pluginId": "data", "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" + "docId": "kibDataSearchPluginApi", + "section": "def-common.IInspectorInfo", + "text": "IInspectorInfo" }, - ") => ", + " | undefined" + ], + "path": "src/plugins/data/common/search/types.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.ISearchOptions.executionContext", + "type": "Object", + "tags": [], + "label": "executionContext", + "description": [], + "signature": [ + "KibanaExecutionContext", + " | undefined" + ], + "path": "src/plugins/data/common/search/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-public.ISearchStartSearchSource", + "type": "Interface", + "tags": [], + "label": "ISearchStartSearchSource", + "description": [ + "\nhigh level search service" + ], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchStartSearchSource", + "text": "ISearchStartSearchSource" + }, + " extends ", + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.PersistableStateService", + "text": "PersistableStateService" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SerializedSearchSourceFields", + "text": "SerializedSearchSourceFields" + }, + ">" + ], + "path": "src/plugins/data/common/search/search_source/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-public.ISearchStartSearchSource.create", + "type": "Function", + "tags": [], + "label": "create", + "description": [ + "\ncreates {@link SearchSource} based on provided serialized {@link SearchSourceFields}" + ], + "signature": [ + "(fields?: ", { - "pluginId": "fieldFormats", + "pluginId": "data", "scope": "common", - "docId": "kibFieldFormatsPluginApi", - "section": "def-common.FieldFormat", - "text": "FieldFormat" + "docId": "kibDataSearchPluginApi", + "section": "def-common.SerializedSearchSourceFields", + "text": "SerializedSearchSourceFields" }, - ") | undefined; } | undefined) => ", + " | undefined) => Promise<", { - "pluginId": "dataViews", + "pluginId": "data", "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchSource", + "text": "ISearchSource" }, - ") | undefined" + ">" ], - "path": "src/plugins/data_views/common/fields/types.ts", + "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false, "children": [ { "parentPluginId": "data", - "id": "def-public.IFieldType.toSpec.$1", + "id": "def-public.ISearchStartSearchSource.create.$1", "type": "Object", "tags": [], - "label": "options", + "label": "fields", "description": [], - "path": "src/plugins/data_views/common/fields/types.ts", - "deprecated": false, - "children": [ + "signature": [ { - "parentPluginId": "data", - "id": "def-public.IFieldType.toSpec.$1.getFormatterForField", - "type": "Function", - "tags": [], - "label": "getFormatterForField", - "description": [], - "signature": [ - "((field: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" - }, - " | ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - " | ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" - }, - ") => ", - { - "pluginId": "fieldFormats", - "scope": "common", - "docId": "kibFieldFormatsPluginApi", - "section": "def-common.FieldFormat", - "text": "FieldFormat" - }, - ") | undefined" - ], - "path": "src/plugins/data_views/common/fields/types.ts", - "deprecated": false - } - ] + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SerializedSearchSourceFields", + "text": "SerializedSearchSourceFields" + }, + " | undefined" + ], + "path": "src/plugins/data/common/search/search_source/types.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "data", + "id": "def-public.ISearchStartSearchSource.createEmpty", + "type": "Function", + "tags": [], + "label": "createEmpty", + "description": [ + "\ncreates empty {@link SearchSource}" + ], + "signature": [ + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchSource", + "text": "ISearchSource" } ], + "path": "src/plugins/data/common/search/search_source/types.ts", + "deprecated": false, + "children": [], "returnComment": [] } ], @@ -8066,251 +7644,85 @@ }, { "parentPluginId": "data", - "id": "def-public.IIndexPattern", + "id": "def-public.OptionedValueProp", "type": "Interface", - "tags": [ - "deprecated" - ], - "label": "IIndexPattern", + "tags": [], + "label": "OptionedValueProp", "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IIndexPattern", - "text": "IIndexPattern" - }, - " extends ", - "DataViewBase" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": true, - "references": [ - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/index.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts" - } - ], + "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", + "deprecated": false, "children": [ { "parentPluginId": "data", - "id": "def-public.IIndexPattern.title", + "id": "def-public.OptionedValueProp.value", "type": "string", "tags": [], - "label": "title", + "label": "value", "description": [], - "path": "src/plugins/data_views/common/types.ts", + "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", "deprecated": false }, { "parentPluginId": "data", - "id": "def-public.IIndexPattern.fields", - "type": "Array", + "id": "def-public.OptionedValueProp.text", + "type": "string", "tags": [], - "label": "fields", + "label": "text", "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" - }, - "[]" - ], - "path": "src/plugins/data_views/common/types.ts", + "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", "deprecated": false }, { "parentPluginId": "data", - "id": "def-public.IIndexPattern.type", - "type": "string", + "id": "def-public.OptionedValueProp.disabled", + "type": "CompoundType", "tags": [], - "label": "type", - "description": [ - "\nType is used for identifying rollup indices, otherwise left undefined" - ], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.IIndexPattern.timeFieldName", - "type": "string", - "tags": [], - "label": "timeFieldName", + "label": "disabled", "description": [], "signature": [ - "string | undefined" + "boolean | undefined" ], - "path": "src/plugins/data_views/common/types.ts", + "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", "deprecated": false }, { "parentPluginId": "data", - "id": "def-public.IIndexPattern.getTimeField", + "id": "def-public.OptionedValueProp.isCompatible", "type": "Function", "tags": [], - "label": "getTimeField", - "description": [], - "signature": [ - "(() => ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" - }, - " | undefined) | undefined" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-public.IIndexPattern.fieldFormatMap", - "type": "Object", - "tags": [], - "label": "fieldFormatMap", + "label": "isCompatible", "description": [], "signature": [ - "Record | undefined> | undefined" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.IIndexPattern.getFormatterForField", - "type": "Function", - "tags": [], - "label": "getFormatterForField", - "description": [ - "\nLook up a formatter for a given field" - ], - "signature": [ - "((field: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" - }, - " | ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - " | ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" - }, - ") => ", + "(agg: ", { - "pluginId": "fieldFormats", + "pluginId": "data", "scope": "common", - "docId": "kibFieldFormatsPluginApi", - "section": "def-common.FieldFormat", - "text": "FieldFormat" + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" }, - ") | undefined" + ") => boolean" ], - "path": "src/plugins/data_views/common/types.ts", + "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", "deprecated": false, "children": [ { "parentPluginId": "data", - "id": "def-public.IIndexPattern.getFormatterForField.$1", - "type": "CompoundType", + "id": "def-public.OptionedValueProp.isCompatible.$1", + "type": "Object", "tags": [], - "label": "field", + "label": "agg", "description": [], "signature": [ { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" - }, - " | ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - " | ", - { - "pluginId": "dataViews", + "pluginId": "data", "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" } ], - "path": "src/plugins/data_views/common/types.ts", + "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", "deprecated": false, "isRequired": true } @@ -8322,193 +7734,176 @@ }, { "parentPluginId": "data", - "id": "def-public.IKibanaSearchRequest", + "id": "def-public.SavedObject", "type": "Interface", "tags": [], - "label": "IKibanaSearchRequest", + "label": "SavedObject", "description": [], "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.IKibanaSearchRequest", - "text": "IKibanaSearchRequest" - }, - "" + "SavedObject", + "" ], - "path": "src/plugins/data/common/search/types.ts", + "path": "src/core/types/saved_objects.ts", "deprecated": false, "children": [ { "parentPluginId": "data", - "id": "def-public.IKibanaSearchRequest.id", + "id": "def-public.SavedObject.id", "type": "string", "tags": [], "label": "id", "description": [ - "\nAn id can be used to uniquely identify this request." - ], - "signature": [ - "string | undefined" + "The ID of this Saved Object, guaranteed to be unique for all objects of the same `type`" ], - "path": "src/plugins/data/common/search/types.ts", + "path": "src/core/types/saved_objects.ts", "deprecated": false }, { "parentPluginId": "data", - "id": "def-public.IKibanaSearchRequest.params", - "type": "Uncategorized", + "id": "def-public.SavedObject.type", + "type": "string", "tags": [], - "label": "params", - "description": [], - "signature": [ - "Params | undefined" + "label": "type", + "description": [ + " The type of Saved Object. Each plugin can define it's own custom Saved Object types." ], - "path": "src/plugins/data/common/search/types.ts", + "path": "src/core/types/saved_objects.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-public.IKibanaSearchResponse", - "type": "Interface", - "tags": [], - "label": "IKibanaSearchResponse", - "description": [], - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.IKibanaSearchResponse", - "text": "IKibanaSearchResponse" }, - "" - ], - "path": "src/plugins/data/common/search/types.ts", - "deprecated": false, - "children": [ { "parentPluginId": "data", - "id": "def-public.IKibanaSearchResponse.id", + "id": "def-public.SavedObject.version", "type": "string", "tags": [], - "label": "id", + "label": "version", "description": [ - "\nSome responses may contain a unique id to identify the request this response came from." + "An opaque version number which changes on each successful write operation. Can be used for implementing optimistic concurrency control." ], "signature": [ "string | undefined" ], - "path": "src/plugins/data/common/search/types.ts", + "path": "src/core/types/saved_objects.ts", "deprecated": false }, { "parentPluginId": "data", - "id": "def-public.IKibanaSearchResponse.total", - "type": "number", + "id": "def-public.SavedObject.updated_at", + "type": "string", "tags": [], - "label": "total", + "label": "updated_at", "description": [ - "\nIf relevant to the search strategy, return a total number\nthat represents how progress is indicated." + "Timestamp of the last time this document had been updated." ], "signature": [ - "number | undefined" + "string | undefined" ], - "path": "src/plugins/data/common/search/types.ts", + "path": "src/core/types/saved_objects.ts", "deprecated": false }, { "parentPluginId": "data", - "id": "def-public.IKibanaSearchResponse.loaded", - "type": "number", + "id": "def-public.SavedObject.error", + "type": "Object", "tags": [], - "label": "loaded", - "description": [ - "\nIf relevant to the search strategy, return a loaded number\nthat represents how progress is indicated." - ], + "label": "error", + "description": [], "signature": [ - "number | undefined" + "SavedObjectError", + " | undefined" ], - "path": "src/plugins/data/common/search/types.ts", + "path": "src/core/types/saved_objects.ts", "deprecated": false }, { "parentPluginId": "data", - "id": "def-public.IKibanaSearchResponse.isRunning", - "type": "CompoundType", + "id": "def-public.SavedObject.attributes", + "type": "Uncategorized", "tags": [], - "label": "isRunning", + "label": "attributes", "description": [ - "\nIndicates whether search is still in flight" + "{@inheritdoc SavedObjectAttributes}" ], "signature": [ - "boolean | undefined" + "T" ], - "path": "src/plugins/data/common/search/types.ts", + "path": "src/core/types/saved_objects.ts", "deprecated": false }, { "parentPluginId": "data", - "id": "def-public.IKibanaSearchResponse.isPartial", - "type": "CompoundType", + "id": "def-public.SavedObject.references", + "type": "Array", "tags": [], - "label": "isPartial", + "label": "references", "description": [ - "\nIndicates whether the results returned are complete or partial" + "{@inheritdoc SavedObjectReference}" ], "signature": [ - "boolean | undefined" + "SavedObjectReference", + "[]" ], - "path": "src/plugins/data/common/search/types.ts", + "path": "src/core/types/saved_objects.ts", "deprecated": false }, { "parentPluginId": "data", - "id": "def-public.IKibanaSearchResponse.isRestored", - "type": "CompoundType", + "id": "def-public.SavedObject.migrationVersion", + "type": "Object", "tags": [], - "label": "isRestored", + "label": "migrationVersion", "description": [ - "\nIndicates whether the results returned are from the async-search index" + "{@inheritdoc SavedObjectsMigrationVersion}" ], "signature": [ - "boolean | undefined" + "SavedObjectsMigrationVersion", + " | undefined" ], - "path": "src/plugins/data/common/search/types.ts", + "path": "src/core/types/saved_objects.ts", "deprecated": false }, { "parentPluginId": "data", - "id": "def-public.IKibanaSearchResponse.warning", + "id": "def-public.SavedObject.coreMigrationVersion", "type": "string", "tags": [], - "label": "warning", + "label": "coreMigrationVersion", "description": [ - "\nOptional warnings returned from Elasticsearch (for example, deprecation warnings)" + "A semver value that is used when upgrading objects between Kibana versions." ], "signature": [ "string | undefined" ], - "path": "src/plugins/data/common/search/types.ts", + "path": "src/core/types/saved_objects.ts", "deprecated": false }, { "parentPluginId": "data", - "id": "def-public.IKibanaSearchResponse.rawResponse", - "type": "Uncategorized", + "id": "def-public.SavedObject.namespaces", + "type": "Array", "tags": [], - "label": "rawResponse", + "label": "namespaces", "description": [ - "\nThe raw response returned by the internal search method (usually the raw ES response)" + "\nSpace(s) that this saved object exists in. This attribute is not used for \"global\" saved object types which are registered with\n`namespaceType: 'agnostic'`." ], "signature": [ - "RawResponse" + "string[] | undefined" ], - "path": "src/plugins/data/common/search/types.ts", + "path": "src/core/types/saved_objects.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.SavedObject.originId", + "type": "string", + "tags": [], + "label": "originId", + "description": [ + "\nThe ID of the saved object this originated from. This is set if this object's `id` was regenerated; that can happen during migration\nfrom a legacy single-namespace type, or during import. It is only set during migration or create operations. This is used during import\nto ensure that ID regeneration is deterministic, so saved objects will be overwritten if they are imported multiple times into a given\nspace." + ], + "signature": [ + "string | undefined" + ], + "path": "src/core/types/saved_objects.ts", "deprecated": false } ], @@ -8516,1400 +7911,1265 @@ }, { "parentPluginId": "data", - "id": "def-public.ISearchOptions", + "id": "def-public.SearchSourceFields", "type": "Interface", "tags": [], - "label": "ISearchOptions", - "description": [], - "path": "src/plugins/data/common/search/types.ts", + "label": "SearchSourceFields", + "description": [ + "\nsearch source fields" + ], + "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false, "children": [ { "parentPluginId": "data", - "id": "def-public.ISearchOptions.abortSignal", - "type": "Object", + "id": "def-public.SearchSourceFields.type", + "type": "string", "tags": [], - "label": "abortSignal", - "description": [ - "\nAn `AbortSignal` that allows the caller of `search` to abort a search request." - ], + "label": "type", + "description": [], "signature": [ - "AbortSignal | undefined" + "string | undefined" ], - "path": "src/plugins/data/common/search/types.ts", + "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false }, { "parentPluginId": "data", - "id": "def-public.ISearchOptions.strategy", - "type": "string", + "id": "def-public.SearchSourceFields.query", + "type": "Object", "tags": [], - "label": "strategy", + "label": "query", "description": [ - "\nUse this option to force using a specific server side search strategy. Leave empty to use the default strategy." + "\n{@link Query}" ], "signature": [ - "string | undefined" + "Query", + " | undefined" ], - "path": "src/plugins/data/common/search/types.ts", + "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false }, { "parentPluginId": "data", - "id": "def-public.ISearchOptions.legacyHitsTotal", + "id": "def-public.SearchSourceFields.filter", "type": "CompoundType", "tags": [], - "label": "legacyHitsTotal", + "label": "filter", "description": [ - "\nRequest the legacy format for the total number of hits. If sending `rest_total_hits_as_int` to\nsomething other than `true`, this should be set to `false`." + "\n{@link Filter}" ], "signature": [ - "boolean | undefined" + "Filter", + " | ", + "Filter", + "[] | (() => ", + "Filter", + " | ", + "Filter", + "[] | undefined) | undefined" ], - "path": "src/plugins/data/common/search/types.ts", + "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false }, { "parentPluginId": "data", - "id": "def-public.ISearchOptions.sessionId", - "type": "string", + "id": "def-public.SearchSourceFields.sort", + "type": "CompoundType", "tags": [], - "label": "sessionId", + "label": "sort", "description": [ - "\nA session ID, grouping multiple search requests into a single session." + "\n{@link EsQuerySortValue}" ], "signature": [ - "string | undefined" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.EsQuerySortValue", + "text": "EsQuerySortValue" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.EsQuerySortValue", + "text": "EsQuerySortValue" + }, + "[] | undefined" ], - "path": "src/plugins/data/common/search/types.ts", + "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false }, { "parentPluginId": "data", - "id": "def-public.ISearchOptions.isStored", - "type": "CompoundType", + "id": "def-public.SearchSourceFields.highlight", + "type": "Any", "tags": [], - "label": "isStored", - "description": [ - "\nWhether the session is already saved (i.e. sent to background)" - ], + "label": "highlight", + "description": [], "signature": [ - "boolean | undefined" + "any" ], - "path": "src/plugins/data/common/search/types.ts", + "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false }, { "parentPluginId": "data", - "id": "def-public.ISearchOptions.isRestore", + "id": "def-public.SearchSourceFields.highlightAll", "type": "CompoundType", "tags": [], - "label": "isRestore", - "description": [ - "\nWhether the session is restored (i.e. search requests should re-use the stored search IDs,\nrather than starting from scratch)" - ], + "label": "highlightAll", + "description": [], "signature": [ "boolean | undefined" ], - "path": "src/plugins/data/common/search/types.ts", + "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false }, { "parentPluginId": "data", - "id": "def-public.ISearchOptions.indexPattern", - "type": "Object", + "id": "def-public.SearchSourceFields.trackTotalHits", + "type": "CompoundType", "tags": [], - "label": "indexPattern", - "description": [ - "\nIndex pattern reference is used for better error messages" - ], + "label": "trackTotalHits", + "description": [], "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" - }, - " | undefined" + "number | boolean | undefined" ], - "path": "src/plugins/data/common/search/types.ts", + "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false }, { "parentPluginId": "data", - "id": "def-public.ISearchOptions.inspector", - "type": "Object", + "id": "def-public.SearchSourceFields.aggs", + "type": "CompoundType", "tags": [], - "label": "inspector", + "label": "aggs", "description": [ - "\nInspector integration options" + "\n{@link AggConfigs}" ], "signature": [ + "object | ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.IInspectorInfo", - "text": "IInspectorInfo" + "section": "def-common.AggConfigs", + "text": "AggConfigs" }, - " | undefined" + " | (() => object) | undefined" ], - "path": "src/plugins/data/common/search/types.ts", + "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false }, { "parentPluginId": "data", - "id": "def-public.ISearchOptions.executionContext", - "type": "Object", + "id": "def-public.SearchSourceFields.from", + "type": "number", "tags": [], - "label": "executionContext", + "label": "from", "description": [], "signature": [ - "KibanaExecutionContext", - " | undefined" + "number | undefined" ], - "path": "src/plugins/data/common/search/types.ts", + "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-public.ISearchStartSearchSource", - "type": "Interface", - "tags": [], - "label": "ISearchStartSearchSource", - "description": [ - "\nhigh level search service" - ], - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.ISearchStartSearchSource", - "text": "ISearchStartSearchSource" }, - " extends ", { - "pluginId": "kibanaUtils", - "scope": "common", - "docId": "kibKibanaUtilsPluginApi", - "section": "def-common.PersistableStateService", - "text": "PersistableStateService" + "parentPluginId": "data", + "id": "def-public.SearchSourceFields.size", + "type": "number", + "tags": [], + "label": "size", + "description": [], + "signature": [ + "number | undefined" + ], + "path": "src/plugins/data/common/search/search_source/types.ts", + "deprecated": false }, - "<", { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SerializedSearchSourceFields", - "text": "SerializedSearchSourceFields" + "parentPluginId": "data", + "id": "def-public.SearchSourceFields.source", + "type": "CompoundType", + "tags": [], + "label": "source", + "description": [], + "signature": [ + "boolean | ", + "Fields", + " | undefined" + ], + "path": "src/plugins/data/common/search/search_source/types.ts", + "deprecated": false }, - ">" - ], - "path": "src/plugins/data/common/search/search_source/types.ts", - "deprecated": false, - "children": [ { "parentPluginId": "data", - "id": "def-public.ISearchStartSearchSource.create", - "type": "Function", + "id": "def-public.SearchSourceFields.version", + "type": "CompoundType", "tags": [], - "label": "create", - "description": [ - "\ncreates {@link SearchSource} based on provided serialized {@link SearchSourceFields}" - ], + "label": "version", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/data/common/search/search_source/types.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.SearchSourceFields.fields", + "type": "Array", + "tags": [], + "label": "fields", + "description": [ + "\nRetrieve fields via the search Fields API" + ], "signature": [ - "(fields?: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SerializedSearchSourceFields", - "text": "SerializedSearchSourceFields" - }, - " | undefined) => Promise<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.ISearchSource", - "text": "ISearchSource" + "section": "def-common.SearchFieldValue", + "text": "SearchFieldValue" }, - ">" + "[] | undefined" ], "path": "src/plugins/data/common/search/search_source/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-public.ISearchStartSearchSource.create.$1", - "type": "Object", - "tags": [], - "label": "fields", - "description": [], - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SerializedSearchSourceFields", - "text": "SerializedSearchSourceFields" - }, - " | undefined" - ], - "path": "src/plugins/data/common/search/search_source/types.ts", - "deprecated": false, - "isRequired": false - } + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.SearchSourceFields.fieldsFromSource", + "type": "CompoundType", + "tags": [ + "deprecated" ], - "returnComment": [] + "label": "fieldsFromSource", + "description": [ + "\nRetreive fields directly from _source (legacy behavior)\n" + ], + "signature": [ + "Fields", + " | undefined" + ], + "path": "src/plugins/data/common/search/search_source/types.ts", + "deprecated": true, + "references": [] }, { "parentPluginId": "data", - "id": "def-public.ISearchStartSearchSource.createEmpty", - "type": "Function", + "id": "def-public.SearchSourceFields.index", + "type": "Object", "tags": [], - "label": "createEmpty", + "label": "index", "description": [ - "\ncreates empty {@link SearchSource}" + "\n{@link IndexPatternService}" ], "signature": [ - "() => ", { - "pluginId": "data", + "pluginId": "dataViews", "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.ISearchSource", - "text": "ISearchSource" - } + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + " | undefined" ], "path": "src/plugins/data/common/search/search_source/types.ts", - "deprecated": false, - "children": [], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-public.OptionedValueProp", - "type": "Interface", - "tags": [], - "label": "OptionedValueProp", - "description": [], - "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", - "deprecated": false, - "children": [ + "deprecated": false + }, { "parentPluginId": "data", - "id": "def-public.OptionedValueProp.value", - "type": "string", + "id": "def-public.SearchSourceFields.searchAfter", + "type": "Object", "tags": [], - "label": "value", + "label": "searchAfter", "description": [], - "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.EsQuerySearchAfter", + "text": "EsQuerySearchAfter" + }, + " | undefined" + ], + "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false }, { "parentPluginId": "data", - "id": "def-public.OptionedValueProp.text", + "id": "def-public.SearchSourceFields.timeout", "type": "string", "tags": [], - "label": "text", + "label": "timeout", "description": [], - "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false }, { "parentPluginId": "data", - "id": "def-public.OptionedValueProp.disabled", - "type": "CompoundType", + "id": "def-public.SearchSourceFields.terminate_after", + "type": "number", "tags": [], - "label": "disabled", + "label": "terminate_after", "description": [], "signature": [ - "boolean | undefined" + "number | undefined" ], - "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", + "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false }, { "parentPluginId": "data", - "id": "def-public.OptionedValueProp.isCompatible", - "type": "Function", + "id": "def-public.SearchSourceFields.parent", + "type": "Object", "tags": [], - "label": "isCompatible", + "label": "parent", "description": [], "signature": [ - "(agg: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.AggConfig", - "text": "AggConfig" + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" }, - ") => boolean" - ], - "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-public.OptionedValueProp.isCompatible.$1", - "type": "Object", - "tags": [], - "label": "agg", - "description": [], - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggConfig", - "text": "AggConfig" - } - ], - "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", - "deprecated": false, - "isRequired": true - } + " | undefined" ], - "returnComment": [] + "path": "src/plugins/data/common/search/search_source/types.ts", + "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "data", - "id": "def-public.SavedObject", + "id": "def-public.TypeMeta", "type": "Interface", "tags": [], - "label": "SavedObject", - "description": [], - "signature": [ - "SavedObject", - "" + "label": "TypeMeta", + "description": [ + "\nInterface for metadata about rollup indices" ], - "path": "src/core/types/saved_objects.ts", + "path": "src/plugins/data_views/common/types.ts", "deprecated": false, "children": [ { "parentPluginId": "data", - "id": "def-public.SavedObject.id", - "type": "string", - "tags": [], - "label": "id", - "description": [ - "The ID of this Saved Object, guaranteed to be unique for all objects of the same `type`" - ], - "path": "src/core/types/saved_objects.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.SavedObject.type", - "type": "string", - "tags": [], - "label": "type", - "description": [ - " The type of Saved Object. Each plugin can define it's own custom Saved Object types." - ], - "path": "src/core/types/saved_objects.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.SavedObject.version", - "type": "string", + "id": "def-public.TypeMeta.aggs", + "type": "Object", "tags": [], - "label": "version", + "label": "aggs", "description": [ - "An opaque version number which changes on each successful write operation. Can be used for implementing optimistic concurrency control." + "\nAggregation restrictions for rollup fields" ], "signature": [ - "string | undefined" + "Record | undefined" ], - "path": "src/core/types/saved_objects.ts", + "path": "src/plugins/data_views/common/types.ts", "deprecated": false }, { "parentPluginId": "data", - "id": "def-public.SavedObject.updated_at", - "type": "string", + "id": "def-public.TypeMeta.params", + "type": "Object", "tags": [], - "label": "updated_at", + "label": "params", "description": [ - "Timestamp of the last time this document had been updated." + "\nParams for retrieving rollup field data" ], "signature": [ - "string | undefined" + "{ rollup_index: string; } | undefined" ], - "path": "src/core/types/saved_objects.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.SavedObject.error", - "type": "Object", - "tags": [], - "label": "error", - "description": [], - "signature": [ - "SavedObjectError", - " | undefined" - ], - "path": "src/core/types/saved_objects.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.SavedObject.attributes", - "type": "Uncategorized", - "tags": [], - "label": "attributes", - "description": [ - "{@inheritdoc SavedObjectAttributes}" - ], - "signature": [ - "T" - ], - "path": "src/core/types/saved_objects.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.SavedObject.references", - "type": "Array", - "tags": [], - "label": "references", - "description": [ - "{@inheritdoc SavedObjectReference}" - ], - "signature": [ - "SavedObjectReference", - "[]" - ], - "path": "src/core/types/saved_objects.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.SavedObject.migrationVersion", - "type": "Object", - "tags": [], - "label": "migrationVersion", - "description": [ - "{@inheritdoc SavedObjectsMigrationVersion}" - ], - "signature": [ - "SavedObjectsMigrationVersion", - " | undefined" - ], - "path": "src/core/types/saved_objects.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.SavedObject.coreMigrationVersion", - "type": "string", - "tags": [], - "label": "coreMigrationVersion", - "description": [ - "A semver value that is used when upgrading objects between Kibana versions." - ], - "signature": [ - "string | undefined" - ], - "path": "src/core/types/saved_objects.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.SavedObject.namespaces", - "type": "Array", - "tags": [], - "label": "namespaces", - "description": [ - "\nSpace(s) that this saved object exists in. This attribute is not used for \"global\" saved object types which are registered with\n`namespaceType: 'agnostic'`." - ], - "signature": [ - "string[] | undefined" - ], - "path": "src/core/types/saved_objects.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.SavedObject.originId", - "type": "string", - "tags": [], - "label": "originId", - "description": [ - "\nThe ID of the saved object this originated from. This is set if this object's `id` was regenerated; that can happen during migration\nfrom a legacy single-namespace type, or during import. It is only set during migration or create operations. This is used during import\nto ensure that ID regeneration is deterministic, so saved objects will be overwritten if they are imported multiple times into a given\nspace." - ], - "signature": [ - "string | undefined" - ], - "path": "src/core/types/saved_objects.ts", + "path": "src/plugins/data_views/common/types.ts", "deprecated": false } ], "initialIsOpen": false + } + ], + "enums": [ + { + "parentPluginId": "data", + "id": "def-public.BUCKET_TYPES", + "type": "Enum", + "tags": [], + "label": "BUCKET_TYPES", + "description": [], + "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_types.ts", + "deprecated": false, + "initialIsOpen": false }, { "parentPluginId": "data", - "id": "def-public.SearchSourceFields", - "type": "Interface", + "id": "def-public.ES_FIELD_TYPES", + "type": "Enum", "tags": [], - "label": "SearchSourceFields", + "label": "ES_FIELD_TYPES", + "description": [], + "signature": [ + "ES_FIELD_TYPES" + ], + "path": "node_modules/@types/kbn__field-types/index.d.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-public.FilterStateStore", + "type": "Enum", + "tags": [], + "label": "FilterStateStore", "description": [ - "\nsearch source fields" + "\r\n Filter,\r\nAn enum to denote whether a filter is specific to an application's context or whether it should be applied globally." + ], + "signature": [ + "FilterStateStore" + ], + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-public.KBN_FIELD_TYPES", + "type": "Enum", + "tags": [], + "label": "KBN_FIELD_TYPES", + "description": [], + "signature": [ + "KBN_FIELD_TYPES" ], + "path": "node_modules/@types/kbn__field-types/index.d.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-public.METRIC_TYPES", + "type": "Enum", + "tags": [], + "label": "METRIC_TYPES", + "description": [], + "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_types.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-public.SortDirection", + "type": "Enum", + "tags": [], + "label": "SortDirection", + "description": [], "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false, - "children": [ + "initialIsOpen": false + } + ], + "misc": [ + { + "parentPluginId": "data", + "id": "def-public.AggConfigOptions", + "type": "Type", + "tags": [], + "label": "AggConfigOptions", + "description": [], + "signature": [ + "{ id?: string | undefined; type: ", { - "parentPluginId": "data", - "id": "def-public.SearchSourceFields.type", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/data/common/search/search_source/types.ts", - "deprecated": false + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IAggType", + "text": "IAggType" }, + "; enabled?: boolean | undefined; params?: {} | ", + "SerializableRecord", + " | undefined; schema?: string | undefined; }" + ], + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-public.AggConfigSerialized", + "type": "Type", + "tags": [], + "label": "AggConfigSerialized", + "description": [], + "signature": [ + "{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", + "SerializableRecord", + " | undefined; schema?: string | undefined; }" + ], + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-public.AggGroupName", + "type": "Type", + "tags": [], + "label": "AggGroupName", + "description": [], + "signature": [ + "\"none\" | \"buckets\" | \"metrics\"" + ], + "path": "src/plugins/data/common/search/aggs/agg_groups.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-public.AggParam", + "type": "Type", + "tags": [], + "label": "AggParam", + "description": [], + "signature": [ { - "parentPluginId": "data", - "id": "def-public.SearchSourceFields.query", - "type": "Object", - "tags": [], - "label": "query", - "description": [ - "\n{@link Query}" - ], - "signature": [ - "Query", - " | undefined" - ], - "path": "src/plugins/data/common/search/search_source/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.SearchSourceFields.filter", - "type": "CompoundType", - "tags": [], - "label": "filter", - "description": [ - "\n{@link Filter}" - ], - "signature": [ - "Filter", - " | ", - "Filter", - "[] | (() => ", - "Filter", - " | ", - "Filter", - "[] | undefined) | undefined" - ], - "path": "src/plugins/data/common/search/search_source/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.SearchSourceFields.sort", - "type": "CompoundType", - "tags": [], - "label": "sort", - "description": [ - "\n{@link EsQuerySortValue}" - ], - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.EsQuerySortValue", - "text": "EsQuerySortValue" - }, - " | ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.EsQuerySortValue", - "text": "EsQuerySortValue" - }, - "[] | undefined" - ], - "path": "src/plugins/data/common/search/search_source/types.ts", - "deprecated": false + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.BaseParamType", + "text": "BaseParamType" }, + "<", { - "parentPluginId": "data", - "id": "def-public.SearchSourceFields.highlight", - "type": "Any", - "tags": [], - "label": "highlight", - "description": [], - "signature": [ - "any" - ], - "path": "src/plugins/data/common/search/search_source/types.ts", - "deprecated": false + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" }, + ">" + ], + "path": "src/plugins/data/common/search/aggs/agg_params.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-public.AggregationRestrictions", + "type": "Type", + "tags": [], + "label": "AggregationRestrictions", + "description": [], + "signature": [ + "{ [x: string]: { agg?: string | undefined; interval?: number | undefined; fixed_interval?: string | undefined; calendar_interval?: string | undefined; delay?: string | undefined; time_zone?: string | undefined; }; }" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-public.AggregationRestrictions", + "type": "Type", + "tags": [], + "label": "AggregationRestrictions", + "description": [], + "signature": [ + "{ [x: string]: { agg?: string | undefined; interval?: number | undefined; fixed_interval?: string | undefined; calendar_interval?: string | undefined; delay?: string | undefined; time_zone?: string | undefined; }; }" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-public.AggsStart", + "type": "Type", + "tags": [], + "label": "AggsStart", + "description": [ + "\nAggsStart represents the actual external contract as AggsCommonStart\nis only used internally. The difference is that AggsStart includes the\ntypings for the registry with initialized agg types.\n" + ], + "signature": [ + "{ calculateAutoTimeExpression: (range: ", { - "parentPluginId": "data", - "id": "def-public.SearchSourceFields.highlightAll", - "type": "CompoundType", - "tags": [], - "label": "highlightAll", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "src/plugins/data/common/search/search_source/types.ts", - "deprecated": false + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" }, + ") => string | undefined; createAggConfigs: (indexPattern: ", { - "parentPluginId": "data", - "id": "def-public.SearchSourceFields.trackTotalHits", - "type": "CompoundType", - "tags": [], - "label": "trackTotalHits", - "description": [], - "signature": [ - "number | boolean | undefined" - ], - "path": "src/plugins/data/common/search/search_source/types.ts", - "deprecated": false + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" }, + ", configStates?: ", { - "parentPluginId": "data", - "id": "def-public.SearchSourceFields.aggs", - "type": "CompoundType", - "tags": [], - "label": "aggs", - "description": [ - "\n{@link AggConfigs}" - ], - "signature": [ - "object | ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggConfigs", - "text": "AggConfigs" - }, - " | (() => object) | undefined" - ], - "path": "src/plugins/data/common/search/search_source/types.ts", - "deprecated": false + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.CreateAggConfigParams", + "text": "CreateAggConfigParams" }, + "[] | undefined) => ", { - "parentPluginId": "data", - "id": "def-public.SearchSourceFields.from", - "type": "number", - "tags": [], - "label": "from", - "description": [], - "signature": [ - "number | undefined" - ], - "path": "src/plugins/data/common/search/search_source/types.ts", - "deprecated": false + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfigs", + "text": "AggConfigs" }, + "; types: ", { - "parentPluginId": "data", - "id": "def-public.SearchSourceFields.size", - "type": "number", - "tags": [], - "label": "size", - "description": [], - "signature": [ - "number | undefined" - ], - "path": "src/plugins/data/common/search/search_source/types.ts", - "deprecated": false + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggTypesRegistryStart", + "text": "AggTypesRegistryStart" }, + "; }" + ], + "path": "src/plugins/data/common/search/aggs/types.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-public.APPLY_FILTER_TRIGGER", + "type": "string", + "tags": [], + "label": "APPLY_FILTER_TRIGGER", + "description": [], + "signature": [ + "\"FILTER_TRIGGER\"" + ], + "path": "src/plugins/data/public/triggers/apply_filter_trigger.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-public.DataViewsContract", + "type": "Type", + "tags": [], + "label": "DataViewsContract", + "description": [], + "signature": [ { - "parentPluginId": "data", - "id": "def-public.SearchSourceFields.source", - "type": "CompoundType", - "tags": [], - "label": "source", - "description": [], - "signature": [ - "boolean | ", - "Fields", - " | undefined" - ], - "path": "src/plugins/data/common/search/search_source/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.SearchSourceFields.version", - "type": "CompoundType", - "tags": [], - "label": "version", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "src/plugins/data/common/search/search_source/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.SearchSourceFields.fields", - "type": "Array", - "tags": [], - "label": "fields", - "description": [ - "\nRetrieve fields via the search Fields API" - ], - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchFieldValue", - "text": "SearchFieldValue" - }, - "[] | undefined" - ], - "path": "src/plugins/data/common/search/search_source/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.SearchSourceFields.fieldsFromSource", - "type": "CompoundType", - "tags": [ - "deprecated" - ], - "label": "fieldsFromSource", - "description": [ - "\nRetreive fields directly from _source (legacy behavior)\n" - ], - "signature": [ - "Fields", - " | undefined" - ], - "path": "src/plugins/data/common/search/search_source/types.ts", - "deprecated": true, - "references": [] - }, - { - "parentPluginId": "data", - "id": "def-public.SearchSourceFields.index", - "type": "Object", - "tags": [], - "label": "index", - "description": [ - "\n{@link IndexPatternService}" - ], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" - }, - " | undefined" - ], - "path": "src/plugins/data/common/search/search_source/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.SearchSourceFields.searchAfter", - "type": "Object", - "tags": [], - "label": "searchAfter", - "description": [], - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.EsQuerySearchAfter", - "text": "EsQuerySearchAfter" - }, - " | undefined" - ], - "path": "src/plugins/data/common/search/search_source/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.SearchSourceFields.timeout", - "type": "string", - "tags": [], - "label": "timeout", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/data/common/search/search_source/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.SearchSourceFields.terminate_after", - "type": "number", - "tags": [], - "label": "terminate_after", - "description": [], - "signature": [ - "number | undefined" - ], - "path": "src/plugins/data/common/search/search_source/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.SearchSourceFields.parent", - "type": "Object", - "tags": [], - "label": "parent", - "description": [], - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchSourceFields", - "text": "SearchSourceFields" - }, - " | undefined" - ], - "path": "src/plugins/data/common/search/search_source/types.ts", - "deprecated": false + "pluginId": "dataViews", + "scope": "public", + "docId": "kibDataViewsPluginApi", + "section": "def-public.DataViewsServicePublic", + "text": "DataViewsServicePublic" } ], + "path": "src/plugins/data_views/public/types.ts", + "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", - "id": "def-public.TypeMeta", - "type": "Interface", + "id": "def-public.ES_SEARCH_STRATEGY", + "type": "string", "tags": [], - "label": "TypeMeta", + "label": "ES_SEARCH_STRATEGY", "description": [], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-public.TypeMeta.aggs", - "type": "Object", - "tags": [], - "label": "aggs", - "description": [], - "signature": [ - "Record | undefined" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.TypeMeta.params", - "type": "Object", - "tags": [], - "label": "params", - "description": [], - "signature": [ - "{ rollup_index: string; } | undefined" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false - } + "signature": [ + "\"es\"" ], - "initialIsOpen": false - } - ], - "enums": [ - { - "parentPluginId": "data", - "id": "def-public.BUCKET_TYPES", - "type": "Enum", - "tags": [], - "label": "BUCKET_TYPES", - "description": [], - "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_types.ts", + "path": "src/plugins/data/common/search/strategies/es_search/types.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", - "id": "def-public.ES_FIELD_TYPES", - "type": "Enum", + "id": "def-public.EsaggsExpressionFunctionDefinition", + "type": "Type", "tags": [], - "label": "ES_FIELD_TYPES", + "label": "EsaggsExpressionFunctionDefinition", "description": [], - "path": "node_modules/@types/kbn__field-types/index.d.ts", + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"esaggs\", Input, Arguments, Output, ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableRecord", + ">>" + ], + "path": "src/plugins/data/common/search/expressions/esaggs/esaggs_fn.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", - "id": "def-public.FilterStateStore", - "type": "Enum", - "tags": [], - "label": "FilterStateStore", - "description": [ - "\r\n Filter,\r\nAn enum to denote whether a filter is specific to an application's context or whether it should be applied globally." - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-public.KBN_FIELD_TYPES", - "type": "Enum", - "tags": [], - "label": "KBN_FIELD_TYPES", - "description": [], - "path": "node_modules/@types/kbn__field-types/index.d.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-public.METRIC_TYPES", - "type": "Enum", - "tags": [], - "label": "METRIC_TYPES", + "id": "def-public.EsQueryConfig", + "type": "Type", + "tags": [ + "deprecated" + ], + "label": "EsQueryConfig", "description": [], - "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_types.ts", - "deprecated": false, + "signature": [ + "KueryQueryOptions", + " & { allowLeadingWildcards: boolean; queryStringOptions: ", + "SerializableRecord", + "; ignoreFilterIfFieldNotInIndex: boolean; }" + ], + "path": "src/plugins/data/common/es_query/index.ts", + "deprecated": true, + "removeBy": "8.1", + "references": [], "initialIsOpen": false }, { "parentPluginId": "data", - "id": "def-public.SortDirection", - "type": "Enum", - "tags": [], - "label": "SortDirection", - "description": [], - "path": "src/plugins/data/common/search/search_source/types.ts", - "deprecated": false, - "initialIsOpen": false - } - ], - "misc": [ - { - "parentPluginId": "data", - "id": "def-public.AggConfigOptions", + "id": "def-public.EsQuerySortValue", "type": "Type", "tags": [], - "label": "AggConfigOptions", + "label": "EsQuerySortValue", "description": [], "signature": [ - "{ id?: string | undefined; type: ", + "{ [x: string]: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.IAggType", - "text": "IAggType" + "section": "def-common.SortDirection", + "text": "SortDirection" }, - "; enabled?: boolean | undefined; params?: {} | ", - "SerializableRecord", - " | undefined; schema?: string | undefined; }" + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SortDirectionNumeric", + "text": "SortDirectionNumeric" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SortDirectionFormat", + "text": "SortDirectionFormat" + }, + "; }" ], - "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", - "id": "def-public.AggConfigSerialized", + "id": "def-public.ExecutionContextSearch", "type": "Type", "tags": [], - "label": "AggConfigSerialized", + "label": "ExecutionContextSearch", "description": [], "signature": [ - "{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", - "SerializableRecord", - " | undefined; schema?: string | undefined; }" + "{ filters?: ", + "Filter", + "[] | undefined; query?: ", + "Query", + " | ", + "Query", + "[] | undefined; timeRange?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + }, + " | undefined; }" ], - "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", - "id": "def-public.AggGroupName", + "id": "def-public.ExistsFilter", "type": "Type", - "tags": [], - "label": "AggGroupName", + "tags": [ + "deprecated" + ], + "label": "ExistsFilter", "description": [], "signature": [ - "\"none\" | \"buckets\" | \"metrics\"" + "Filter", + " & { meta: ", + "FilterMeta", + "; query: { exists?: { field: string; } | undefined; }; }" ], - "path": "src/plugins/data/common/search/aggs/agg_groups.ts", - "deprecated": false, + "path": "src/plugins/data/common/es_query/index.ts", + "deprecated": true, + "removeBy": "8.1", + "references": [], "initialIsOpen": false }, { "parentPluginId": "data", - "id": "def-public.AggParam", + "id": "def-public.ExpressionFunctionKibana", "type": "Type", "tags": [], - "label": "AggParam", + "label": "ExpressionFunctionKibana", "description": [], "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"kibana\", ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.BaseParamType", - "text": "BaseParamType" + "section": "def-common.ExpressionValueSearchContext", + "text": "ExpressionValueSearchContext" + }, + " | null, object, ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ExpressionValueSearchContext", + "text": "ExpressionValueSearchContext" + }, + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" }, "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.AggConfig", - "text": "AggConfig" + "section": "def-common.ExecutionContextSearch", + "text": "ExecutionContextSearch" }, - ">" - ], - "path": "src/plugins/data/common/search/aggs/agg_params.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-public.AggregationRestrictions", - "type": "Type", - "tags": [], - "label": "AggregationRestrictions", - "description": [], - "signature": [ - "{ [x: string]: { agg?: string | undefined; interval?: number | undefined; fixed_interval?: string | undefined; calendar_interval?: string | undefined; delay?: string | undefined; time_zone?: string | undefined; }; }" + ">>" ], - "path": "src/plugins/data_views/common/types.ts", + "path": "src/plugins/data/common/search/expressions/kibana.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", - "id": "def-public.AggregationRestrictions", + "id": "def-public.ExpressionFunctionKibanaContext", "type": "Type", "tags": [], - "label": "AggregationRestrictions", + "label": "ExpressionFunctionKibanaContext", "description": [], "signature": [ - "{ [x: string]: { agg?: string | undefined; interval?: number | undefined; fixed_interval?: string | undefined; calendar_interval?: string | undefined; delay?: string | undefined; time_zone?: string | undefined; }; }" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-public.AggsStart", - "type": "Type", - "tags": [], - "label": "AggsStart", - "description": [ - "\nAggsStart represents the actual external contract as AggsCommonStart\nis only used internally. The difference is that AggsStart includes the\ntypings for the registry with initialized agg types.\n" - ], - "signature": [ - "{ calculateAutoTimeExpression: (range: ", { - "pluginId": "data", + "pluginId": "expressions", "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" }, - ") => string | undefined; createAggConfigs: (indexPattern: ", + "<\"kibana_context\", ", { - "pluginId": "dataViews", + "pluginId": "data", "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" + "docId": "kibDataSearchPluginApi", + "section": "def-common.ExpressionValueSearchContext", + "text": "ExpressionValueSearchContext" }, - ", configStates?: ", + " | null, Arguments, Promise<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.CreateAggConfigParams", - "text": "CreateAggConfigParams" + "section": "def-common.ExpressionValueSearchContext", + "text": "ExpressionValueSearchContext" }, - "[] | undefined) => ", + ">, ", { - "pluginId": "data", + "pluginId": "expressions", "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggConfigs", - "text": "AggConfigs" + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" }, - "; types: ", + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.AggTypesRegistryStart", - "text": "AggTypesRegistryStart" + "section": "def-common.ExecutionContextSearch", + "text": "ExecutionContextSearch" }, - "; }" + ">>" ], - "path": "src/plugins/data/common/search/aggs/types.ts", + "path": "src/plugins/data/common/search/expressions/kibana_context.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", - "id": "def-public.APPLY_FILTER_TRIGGER", - "type": "string", + "id": "def-public.ExpressionValueSearchContext", + "type": "Type", "tags": [], - "label": "APPLY_FILTER_TRIGGER", + "label": "ExpressionValueSearchContext", "description": [], "signature": [ - "\"FILTER_TRIGGER\"" + "{ type: \"kibana_context\"; } & ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ExecutionContextSearch", + "text": "ExecutionContextSearch" + } ], - "path": "src/plugins/data/public/triggers/apply_filter_trigger.ts", + "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", - "id": "def-public.DataViewsContract", + "id": "def-public.Filter", "type": "Type", - "tags": [], - "label": "DataViewsContract", - "description": [], - "signature": [ - "DataViewsServicePublic" + "tags": [ + "deprecated" ], - "path": "src/plugins/data_views/public/types.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-public.ES_SEARCH_STRATEGY", - "type": "string", - "tags": [], - "label": "ES_SEARCH_STRATEGY", + "label": "Filter", "description": [], "signature": [ - "\"es\"" + "{ $state?: { store: ", + "FilterStateStore", + "; } | undefined; meta: ", + "FilterMeta", + "; query?: Record | undefined; }" ], - "path": "src/plugins/data/common/search/strategies/es_search/types.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-public.EsaggsExpressionFunctionDefinition", - "type": "Type", - "tags": [], - "label": "EsaggsExpressionFunctionDefinition", - "description": [], - "signature": [ + "path": "src/plugins/data/common/es_query/index.ts", + "deprecated": true, + "removeBy": "8.1", + "references": [ { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" + "plugin": "discover", + "path": "src/plugins/discover/public/application/view_alert/view_alert_route.tsx" }, - "<\"esaggs\", Input, Arguments, Output, ", { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutionContext", - "text": "ExecutionContext" + "plugin": "discover", + "path": "src/plugins/discover/public/application/view_alert/view_alert_route.tsx" }, - "<", { - "pluginId": "inspector", - "scope": "common", - "docId": "kibInspectorPluginApi", - "section": "def-common.Adapters", - "text": "Adapters" + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/application/lib/filter_utils.ts" }, - ", ", - "SerializableRecord", - ">>" + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/application/lib/filter_utils.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/application/lib/filter_utils.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/application/lib/filter_utils.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/application/lib/filter_utils.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/application/state/dashboard_state_slice.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/application/state/dashboard_state_slice.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/application/state/dashboard_state_slice.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/application/lib/sync_dashboard_filter_state.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/application/lib/sync_dashboard_filter_state.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/application/lib/sync_dashboard_filter_state.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx" + }, + { + "plugin": "lens", + "path": "x-pack/plugins/lens/public/trigger_actions/open_in_discover_drilldown.tsx" + }, + { + "plugin": "lens", + "path": "x-pack/plugins/lens/public/trigger_actions/open_in_discover_drilldown.tsx" + }, + { + "plugin": "urlDrilldown", + "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/variables/context_variables.ts" + }, + { + "plugin": "urlDrilldown", + "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/variables/context_variables.ts" + }, + { + "plugin": "urlDrilldown", + "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/url_drilldown.tsx" + }, + { + "plugin": "urlDrilldown", + "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/url_drilldown.tsx" + }, + { + "plugin": "urlDrilldown", + "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/test/data.ts" + }, + { + "plugin": "urlDrilldown", + "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/test/data.ts" + } ], - "path": "src/plugins/data/common/search/expressions/esaggs/esaggs_fn.ts", - "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", - "id": "def-public.EsQueryConfig", + "id": "def-public.IAggConfig", "type": "Type", "tags": [ - "deprecated" + "name", + "description" ], - "label": "EsQueryConfig", + "label": "IAggConfig", "description": [], "signature": [ - "KueryQueryOptions", - " & { allowLeadingWildcards: boolean; queryStringOptions: ", - "SerializableRecord", - "; ignoreFilterIfFieldNotInIndex: boolean; }" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + } ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [], + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", - "id": "def-public.EsQuerySortValue", + "id": "def-public.IAggType", "type": "Type", "tags": [], - "label": "EsQuerySortValue", + "label": "IAggType", "description": [], "signature": [ - "{ [x: string]: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.SortDirection", - "text": "SortDirection" + "section": "def-common.AggType", + "text": "AggType" }, - " | ", + "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.SortDirectionNumeric", - "text": "SortDirectionNumeric" + "section": "def-common.AggConfig", + "text": "AggConfig" }, - " | ", + ", ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.SortDirectionFormat", - "text": "SortDirectionFormat" + "section": "def-common.AggParamType", + "text": "AggParamType" }, - "; }" + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + ">>" ], - "path": "src/plugins/data/common/search/search_source/types.ts", + "path": "src/plugins/data/common/search/aggs/agg_type.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", - "id": "def-public.ExecutionContextSearch", + "id": "def-public.IEsSearchResponse", "type": "Type", "tags": [], - "label": "ExecutionContextSearch", + "label": "IEsSearchResponse", "description": [], "signature": [ - "{ filters?: ", - "Filter", - "[] | undefined; query?: ", - "Query", - " | ", - "Query", - "[] | undefined; timeRange?: ", { "pluginId": "data", "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" + "docId": "kibDataSearchPluginApi", + "section": "def-common.IKibanaSearchResponse", + "text": "IKibanaSearchResponse" }, - " | undefined; }" - ], - "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", - "deprecated": false, - "initialIsOpen": false + "<", + "SearchResponse", + ">>" + ], + "path": "src/plugins/data/common/search/strategies/es_search/types.ts", + "deprecated": false, + "initialIsOpen": false }, { "parentPluginId": "data", - "id": "def-public.ExistsFilter", + "id": "def-public.IFieldParamType", "type": "Type", - "tags": [ - "deprecated" - ], - "label": "ExistsFilter", + "tags": [], + "label": "IFieldParamType", "description": [], "signature": [ - "Filter", - " & { meta: ", - "FilterMeta", - "; query: { exists?: { field: string; } | undefined; }; }" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.FieldParamType", + "text": "FieldParamType" + } ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [], + "path": "src/plugins/data/common/search/aggs/param_types/field.ts", + "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", - "id": "def-public.ExpressionFunctionKibana", + "id": "def-public.IMetricAggType", "type": "Type", "tags": [], - "label": "ExpressionFunctionKibana", + "label": "IMetricAggType", "description": [], "signature": [ { - "pluginId": "expressions", + "pluginId": "data", "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" + "docId": "kibDataSearchPluginApi", + "section": "def-common.MetricAggType", + "text": "MetricAggType" }, - "<\"kibana\", ", + "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.ExpressionValueSearchContext", - "text": "ExpressionValueSearchContext" + "section": "def-common.IMetricAggConfig", + "text": "IMetricAggConfig" }, - " | null, object, ", + ">" + ], + "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-public.IndexPatternLoadExpressionFunctionDefinition", + "type": "Type", + "tags": [], + "label": "IndexPatternLoadExpressionFunctionDefinition", + "description": [], + "signature": [ { - "pluginId": "data", + "pluginId": "expressions", "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.ExpressionValueSearchContext", - "text": "ExpressionValueSearchContext" + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" }, - ", ", + "<\"indexPatternLoad\", null, Arguments, Output, ", { "pluginId": "expressions", "scope": "common", @@ -9926,9488 +9186,9921 @@ "text": "Adapters" }, ", ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.ExecutionContextSearch", - "text": "ExecutionContextSearch" - }, + "SerializableRecord", ">>" ], - "path": "src/plugins/data/common/search/expressions/kibana.ts", + "path": "src/plugins/data_views/common/expressions/load_index_pattern.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", - "id": "def-public.ExpressionFunctionKibanaContext", + "id": "def-public.ISearchGeneric", "type": "Type", "tags": [], - "label": "ExpressionFunctionKibanaContext", + "label": "ISearchGeneric", "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"kibana_context\", ", + " = ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.ExpressionValueSearchContext", - "text": "ExpressionValueSearchContext" + "section": "def-common.IEsSearchRequest", + "text": "IEsSearchRequest" }, - ">, ", + ", SearchStrategyResponse extends ", { - "pluginId": "expressions", + "pluginId": "data", "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutionContext", - "text": "ExecutionContext" + "docId": "kibDataSearchPluginApi", + "section": "def-common.IKibanaSearchResponse", + "text": "IKibanaSearchResponse" }, - "<", + " = ", { - "pluginId": "inspector", + "pluginId": "data", "scope": "common", - "docId": "kibInspectorPluginApi", - "section": "def-common.Adapters", - "text": "Adapters" + "docId": "kibDataSearchPluginApi", + "section": "def-common.IEsSearchResponse", + "text": "IEsSearchResponse" }, - ", ", + ">(request: SearchStrategyRequest, options?: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.ExecutionContextSearch", - "text": "ExecutionContextSearch" + "section": "def-common.ISearchOptions", + "text": "ISearchOptions" }, - ">>" + " | undefined) => ", + "Observable", + "" ], - "path": "src/plugins/data/common/search/expressions/kibana_context.ts", + "path": "src/plugins/data/common/search/types.ts", "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-public.ExpressionValueSearchContext", - "type": "Type", - "tags": [], - "label": "ExpressionValueSearchContext", - "description": [], - "signature": [ - "{ type: \"kibana_context\"; } & ", + "returnComment": [], + "children": [ { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.ExecutionContextSearch", - "text": "ExecutionContextSearch" + "parentPluginId": "data", + "id": "def-public.ISearchGeneric.$1", + "type": "Uncategorized", + "tags": [], + "label": "request", + "description": [], + "signature": [ + "SearchStrategyRequest" + ], + "path": "src/plugins/data/common/search/types.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.ISearchGeneric.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchOptions", + "text": "ISearchOptions" + }, + " | undefined" + ], + "path": "src/plugins/data/common/search/types.ts", + "deprecated": false } ], - "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", - "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", - "id": "def-public.Filter", + "id": "def-public.ISearchSource", "type": "Type", - "tags": [ - "deprecated" + "tags": [], + "label": "ISearchSource", + "description": [ + "\nsearch source interface" ], - "label": "Filter", - "description": [], "signature": [ - "{ $state?: { store: ", - "FilterStateStore", - "; } | undefined; meta: ", - "FilterMeta", - "; query?: Record | undefined; }" - ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [ + "{ create: () => ", { - "plugin": "discover", - "path": "src/plugins/discover/public/application/view_alert/view_alert_route.tsx" + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSource", + "text": "SearchSource" }, + "; history: ", + "SearchRequest", + "[]; setOverwriteDataViewType: (overwriteType: string | false | undefined) => void; setField: (field: K, value: ", { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/lib/filter_utils.ts" + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" }, + "[K]) => ", { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/lib/filter_utils.ts" + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSource", + "text": "SearchSource" }, + "; removeField: (field: K) => ", { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/lib/filter_utils.ts" - }, - { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/lib/filter_utils.ts" - }, - { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts" - }, - { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts" - }, - { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/state/dashboard_state_slice.ts" - }, - { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/state/dashboard_state_slice.ts" + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSource", + "text": "SearchSource" }, + "; setFields: (newFields: ", { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/state/dashboard_state_slice.ts" + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" }, + ") => ", { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/lib/sync_dashboard_filter_state.ts" + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSource", + "text": "SearchSource" }, + "; getId: () => string; getFields: () => ", { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/lib/sync_dashboard_filter_state.ts" + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" }, + "; getField: (field: K, recurse?: boolean) => ", { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx" + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" }, + "[K]; getOwnField: (field: K) => ", { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/trigger_actions/open_in_discover_drilldown.tsx" + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" }, + "[K]; createCopy: () => ", { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/trigger_actions/open_in_discover_drilldown.tsx" + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSource", + "text": "SearchSource" }, + "; createChild: (options?: {}) => ", { - "plugin": "urlDrilldown", - "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/variables/context_variables.ts" + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSource", + "text": "SearchSource" }, + "; setParent: (parent?: ", { - "plugin": "urlDrilldown", - "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/variables/context_variables.ts" + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchSource", + "text": "ISearchSource" }, + " | undefined, options?: ", { - "plugin": "urlDrilldown", - "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/url_drilldown.tsx" + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceOptions", + "text": "SearchSourceOptions" }, + ") => ", { - "plugin": "urlDrilldown", - "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/url_drilldown.tsx" + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSource", + "text": "SearchSource" }, + "; getParent: () => ", { - "plugin": "urlDrilldown", - "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/test/data.ts" + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSource", + "text": "SearchSource" }, - { - "plugin": "urlDrilldown", - "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/test/data.ts" - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-public.IAggConfig", - "type": "Type", - "tags": [ - "name", - "description" - ], - "label": "IAggConfig", - "description": [], - "signature": [ + " | undefined; fetch$: (options?: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.AggConfig", - "text": "AggConfig" - } - ], - "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-public.IAggType", - "type": "Type", - "tags": [], - "label": "IAggType", - "description": [], - "signature": [ + "section": "def-common.ISearchOptions", + "text": "ISearchOptions" + }, + ") => ", + "Observable", + "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.AggType", - "text": "AggType" + "section": "def-common.IKibanaSearchResponse", + "text": "IKibanaSearchResponse" }, "<", + "SearchResponse", + ">>>; fetch: (options?: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.AggConfig", - "text": "AggConfig" + "section": "def-common.ISearchOptions", + "text": "ISearchOptions" }, - ", ", + ") => Promise<", + "SearchResponse", + ">>; onRequestStart: (handler: (searchSource: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.AggParamType", - "text": "AggParamType" + "section": "def-common.SearchSource", + "text": "SearchSource" }, - "<", + ", options?: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.AggConfig", - "text": "AggConfig" + "section": "def-common.ISearchOptions", + "text": "ISearchOptions" }, - ">>" - ], - "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-public.IEsSearchResponse", - "type": "Type", - "tags": [], - "label": "IEsSearchResponse", - "description": [], - "signature": [ + " | undefined) => Promise) => void; getSearchRequestBody: () => any; destroy: () => void; getSerializedFields: (recurse?: boolean) => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.IKibanaSearchResponse", - "text": "IKibanaSearchResponse" + "section": "def-common.SerializedSearchSourceFields", + "text": "SerializedSearchSourceFields" }, - "<", - "SearchResponse", - ">>" + "; serialize: () => { searchSourceJSON: string; references: ", + "SavedObjectReference", + "[]; }; toExpressionAst: ({ asDatatable }?: ExpressionAstOptions) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + "; }" ], - "path": "src/plugins/data/common/search/strategies/es_search/types.ts", + "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", - "id": "def-public.IFieldParamType", + "id": "def-public.KibanaContext", "type": "Type", "tags": [], - "label": "IFieldParamType", + "label": "KibanaContext", "description": [], "signature": [ + "{ type: \"kibana_context\"; } & ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.FieldParamType", - "text": "FieldParamType" + "section": "def-common.ExecutionContextSearch", + "text": "ExecutionContextSearch" } ], - "path": "src/plugins/data/common/search/aggs/param_types/field.ts", + "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", - "id": "def-public.IMetricAggType", + "id": "def-public.KueryNode", "type": "Type", - "tags": [], - "label": "IMetricAggType", + "tags": [ + "deprecated" + ], + "label": "KueryNode", "description": [], "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.MetricAggType", - "text": "MetricAggType" - }, - "<", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.IMetricAggConfig", - "text": "IMetricAggConfig" - }, - ">" + "KueryNode" ], - "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", - "deprecated": false, + "path": "src/plugins/data/common/es_query/index.ts", + "deprecated": true, + "removeBy": "8.1", + "references": [], "initialIsOpen": false }, { "parentPluginId": "data", - "id": "def-public.IndexPatternAttributes", + "id": "def-public.MatchAllFilter", "type": "Type", "tags": [ "deprecated" ], - "label": "IndexPatternAttributes", + "label": "MatchAllFilter", "description": [], "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewAttributes", - "text": "DataViewAttributes" - } + "Filter", + " & { meta: MatchAllFilterMeta; query: { match_all: ", + "QueryDslMatchAllQuery", + "; }; }" ], - "path": "src/plugins/data_views/common/types.ts", + "path": "src/plugins/data/common/es_query/index.ts", "deprecated": true, - "references": [ - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/index.ts" - }, - { - "plugin": "canvas", - "path": "x-pack/plugins/canvas/public/lib/es_service.ts" - }, - { - "plugin": "canvas", - "path": "x-pack/plugins/canvas/public/lib/es_service.ts" - }, - { - "plugin": "canvas", - "path": "x-pack/plugins/canvas/public/lib/es_service.ts" - } + "removeBy": "8.1", + "references": [], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-public.NowProviderInternalContract", + "type": "Type", + "tags": [], + "label": "NowProviderInternalContract", + "description": [], + "signature": [ + "{ get: () => Date; set: (now: Date) => void; reset: () => void; }" ], + "path": "src/plugins/data/public/now_provider/now_provider.ts", + "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", - "id": "def-public.IndexPatternLoadExpressionFunctionDefinition", + "id": "def-public.NowProviderPublicContract", "type": "Type", "tags": [], - "label": "IndexPatternLoadExpressionFunctionDefinition", + "label": "NowProviderPublicContract", "description": [], "signature": [ + "{ get: () => Date; }" + ], + "path": "src/plugins/data/public/now_provider/now_provider.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-public.ParsedInterval", + "type": "Type", + "tags": [], + "label": "ParsedInterval", + "description": [], + "signature": [ + "{ value: number; unit: ", + "Unit", + "; type: \"calendar\" | \"fixed\"; }" + ], + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_es_interval.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-public.PhraseFilter", + "type": "Type", + "tags": [ + "deprecated" + ], + "label": "PhraseFilter", + "description": [], + "signature": [ + "Filter", + " & { meta: PhraseFilterMeta; query: { match_phrase?: Partial> | undefined; match?: Partial> | undefined; }; }" + ], + "path": "src/plugins/data/common/es_query/index.ts", + "deprecated": true, + "removeBy": "8.1", + "references": [], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-public.Query", + "type": "Type", + "tags": [], + "label": "Query", + "description": [], + "signature": [ + "{ query: string | { [key: string]: any; }; language: string; }" + ], + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-public.QueryState", + "type": "Type", + "tags": [], + "label": "QueryState", + "description": [ + "\nAll query state service state\n" + ], + "signature": [ + "{ time?: ", { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"indexPatternLoad\", null, Arguments, Output, ", - { - "pluginId": "expressions", + "pluginId": "data", "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutionContext", - "text": "ExecutionContext" + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" }, - "<", + " | undefined; refreshInterval?: ", { - "pluginId": "inspector", + "pluginId": "data", "scope": "common", - "docId": "kibInspectorPluginApi", - "section": "def-common.Adapters", - "text": "Adapters" + "docId": "kibDataQueryPluginApi", + "section": "def-common.RefreshInterval", + "text": "RefreshInterval" }, - ", ", - "SerializableRecord", - ">>" + " | undefined; filters?: ", + "Filter", + "[] | undefined; query?: ", + "Query", + " | undefined; }" ], - "path": "src/plugins/data_views/common/expressions/load_index_pattern.ts", + "path": "src/plugins/data/common/query/query_state.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", - "id": "def-public.IndexPatternsContract", + "id": "def-public.RangeFilter", "type": "Type", "tags": [ "deprecated" ], - "label": "IndexPatternsContract", + "label": "RangeFilter", "description": [], "signature": [ - "{ create: (spec: ", + "Filter", + " & { meta: ", + "RangeFilterMeta", + "; query: { range: { [key: string]: ", + "RangeFilterParams", + "; }; }; }" + ], + "path": "src/plugins/data/common/es_query/index.ts", + "deprecated": true, + "removeBy": "8.1", + "references": [], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-public.RangeFilterParams", + "type": "Type", + "tags": [ + "deprecated" + ], + "label": "RangeFilterParams", + "description": [], + "signature": [ + "RangeFilterParams" + ], + "path": "src/plugins/data/common/es_query/index.ts", + "deprecated": true, + "removeBy": "8.1", + "references": [], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-public.RefreshInterval", + "type": "Type", + "tags": [], + "label": "RefreshInterval", + "description": [], + "signature": [ + "{ pause: boolean; value: number; }" + ], + "path": "src/plugins/data/common/query/timefilter/types.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-public.SerializedSearchSourceFields", + "type": "Type", + "tags": [], + "label": "SerializedSearchSourceFields", + "description": [], + "signature": [ + "{ type?: string | undefined; query?: ", + "Query", + " | undefined; filter?: ", + "Filter", + "[] | undefined; sort?: ", { - "pluginId": "dataViews", + "pluginId": "data", "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" + "docId": "kibDataSearchPluginApi", + "section": "def-common.EsQuerySortValue", + "text": "EsQuerySortValue" }, - ", skipFetchFields?: boolean) => Promise<", + "[] | undefined; highlight?: ", + "SerializableRecord", + " | undefined; highlightAll?: boolean | undefined; trackTotalHits?: number | boolean | undefined; aggs?: { type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", + "SerializableRecord", + " | undefined; schema?: string | undefined; }[] | undefined; from?: number | undefined; size?: number | undefined; source?: boolean | ", + "Fields", + " | undefined; version?: boolean | undefined; fields?: ", { - "pluginId": "dataViews", + "pluginId": "data", "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchFieldValue", + "text": "SearchFieldValue" }, - ">; delete: (indexPatternId: string) => Promise<{}>; find: (search: string, size?: number) => Promise<", - { - "pluginId": "dataViews", + "[] | undefined; fieldsFromSource?: ", + "Fields", + " | undefined; index?: string | undefined; searchAfter?: ", + { + "pluginId": "data", "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" + "docId": "kibDataSearchPluginApi", + "section": "def-common.EsQuerySearchAfter", + "text": "EsQuerySearchAfter" }, - "[]>; get: (id: string) => Promise<", + " | undefined; timeout?: string | undefined; terminate_after?: number | undefined; parent?: ", { - "pluginId": "dataViews", + "pluginId": "data", "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" + "docId": "kibDataSearchPluginApi", + "section": "def-common.SerializedSearchSourceFields", + "text": "SerializedSearchSourceFields" }, - ">; getCanSave: () => Promise; ensureDefaultDataView: ", - "EnsureDefaultDataView", - "; getIds: (refresh?: boolean) => Promise; getTitles: (refresh?: boolean) => Promise; getIdsWithTitle: (refresh?: boolean) => Promise<", + " | undefined; }" + ], + "path": "src/plugins/data/common/search/search_source/types.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-public.TimeRange", + "type": "Type", + "tags": [ + "deprecated", + "deprecated" + ], + "label": "TimeRange", + "description": [ + "\n" + ], + "signature": [ + "{ from: string; to: string; mode?: \"absolute\" | \"relative\" | undefined; }" + ], + "path": "src/plugins/data/common/es_query/index.ts", + "deprecated": true, + "removeBy": "8.1", + "references": [ { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewListItem", - "text": "DataViewListItem" + "plugin": "infra", + "path": "x-pack/plugins/infra/public/pages/logs/log_entry_rate/use_log_entry_rate_results_url_state.tsx" }, - "[]>; clearCache: (id?: string | undefined) => void; getCache: () => Promise<", - "SavedObject", - "<", - "IndexPatternSavedObjectAttrs", - ">[] | null | undefined>; getDefault: () => Promise<", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" + "plugin": "discover", + "path": "src/plugins/discover/public/locator.ts" }, - " | null>; getDefaultId: () => Promise; setDefault: (id: string | null, force?: boolean) => Promise; hasUserDataView: () => Promise; getFieldsForWildcard: (options: ", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.GetFieldsOptions", - "text": "GetFieldsOptions" + "plugin": "discover", + "path": "src/plugins/discover/public/locator.ts" }, - ") => Promise<", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" + "plugin": "discover", + "path": "src/plugins/discover/public/embeddable/types.ts" }, - "[]>; getFieldsForIndexPattern: (indexPattern: ", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" + "plugin": "discover", + "path": "src/plugins/discover/public/embeddable/types.ts" }, - " | ", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" + "plugin": "discover", + "path": "src/plugins/discover/public/embeddable/saved_search_embeddable.tsx" }, - ", options?: ", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.GetFieldsOptions", - "text": "GetFieldsOptions" + "plugin": "discover", + "path": "src/plugins/discover/public/embeddable/saved_search_embeddable.tsx" }, - " | undefined) => Promise<", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" + "plugin": "discover", + "path": "src/plugins/discover/public/embeddable/search_embeddable_factory.ts" }, - "[]>; refreshFields: (indexPattern: ", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" + "plugin": "discover", + "path": "src/plugins/discover/public/embeddable/search_embeddable_factory.ts" }, - ") => Promise; fieldArrayToMap: (fields: ", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" + "plugin": "discover", + "path": "src/plugins/discover/public/application/main/components/layout/types.ts" }, - "[], fieldAttrs?: ", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldAttrs", - "text": "FieldAttrs" + "plugin": "discover", + "path": "src/plugins/discover/public/application/main/components/layout/types.ts" }, - " | undefined) => ", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewFieldMap", - "text": "DataViewFieldMap" + "plugin": "discover", + "path": "src/plugins/discover/public/application/main/components/top_nav/discover_topnav.tsx" }, - "; savedObjectToSpec: (savedObject: ", - "SavedObject", - "<", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewAttributes", - "text": "DataViewAttributes" + "plugin": "discover", + "path": "src/plugins/discover/public/application/main/components/top_nav/discover_topnav.tsx" }, - ">) => ", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" + "plugin": "visualizations", + "path": "src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx" }, - "; createAndSave: (spec: ", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" + "plugin": "visualizations", + "path": "src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx" }, - ", override?: boolean, skipFetchFields?: boolean) => Promise<", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" + "plugin": "visualizations", + "path": "src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx" }, - ">; createSavedObject: (indexPattern: ", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" + "plugin": "visualizations", + "path": "src/plugins/visualizations/public/visualize_app/types.ts" }, - ", override?: boolean) => Promise<", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" + "plugin": "visualizations", + "path": "src/plugins/visualizations/public/visualize_app/types.ts" }, - ">; updateSavedObject: (indexPattern: ", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/application/lib/filter_utils.ts" }, - ", saveAttempts?: number, ignoreErrors?: boolean) => Promise; getDefaultDataView: () => Promise<", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/application/lib/filter_utils.ts" }, - " | null>; }" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": true, - "references": [ { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/index.ts" + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/application/state/dashboard_state_slice.ts" }, { - "plugin": "dataViews", - "path": "src/plugins/data_views/public/index.ts" + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/application/state/dashboard_state_slice.ts" }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/lazy_load_bundle/index.ts" + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/application/lib/convert_dashboard_state.ts" }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/lazy_load_bundle/index.ts" - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-public.ISearchGeneric", - "type": "Type", - "tags": [], - "label": "ISearchGeneric", - "description": [], - "signature": [ - " = ", { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.IEsSearchRequest", - "text": "IEsSearchRequest" + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/types.ts" }, - ", SearchStrategyResponse extends ", { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.IKibanaSearchResponse", - "text": "IKibanaSearchResponse" + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/types.ts" }, - " = ", { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.IEsSearchResponse", - "text": "IEsSearchResponse" + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx" }, - ">(request: SearchStrategyRequest, options?: ", { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.ISearchOptions", - "text": "ISearchOptions" + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx" }, - " | undefined) => ", - "Observable", - "" - ], - "path": "src/plugins/data/common/search/types.ts", - "deprecated": false, - "returnComment": [], - "children": [ { - "parentPluginId": "data", - "id": "def-public.ISearchGeneric.$1", - "type": "Uncategorized", - "tags": [], - "label": "request", - "description": [], - "signature": [ - "SearchStrategyRequest" - ], - "path": "src/plugins/data/common/search/types.ts", - "deprecated": false + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/application/top_nav/show_share_modal.tsx" }, { - "parentPluginId": "data", - "id": "def-public.ISearchGeneric.$2", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.ISearchOptions", - "text": "ISearchOptions" - }, - " | undefined" - ], - "path": "src/plugins/data/common/search/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-public.ISearchSource", - "type": "Type", - "tags": [], - "label": "ISearchSource", - "description": [ - "\nsearch source interface" - ], - "signature": [ - "{ create: () => ", + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/application/top_nav/show_share_modal.tsx" + }, { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchSource", - "text": "SearchSource" + "plugin": "controls", + "path": "src/plugins/controls/public/services/kibana/options_list.ts" }, - "; history: ", - "SearchRequest", - "[]; setOverwriteDataViewType: (overwriteType: string | false | undefined) => void; setField: (field: K, value: ", { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchSourceFields", - "text": "SearchSourceFields" + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/locator.ts" }, - "[K]) => ", { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchSource", - "text": "SearchSource" + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/locator.ts" }, - "; removeField: (field: K) => ", { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchSource", - "text": "SearchSource" + "plugin": "uiActionsEnhanced", + "path": "x-pack/plugins/ui_actions_enhanced/public/customize_time_range_modal.tsx" }, - "; setFields: (newFields: ", { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchSourceFields", - "text": "SearchSourceFields" + "plugin": "uiActionsEnhanced", + "path": "x-pack/plugins/ui_actions_enhanced/public/custom_time_range_action.tsx" }, - ") => ", { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchSource", - "text": "SearchSource" + "plugin": "uiActionsEnhanced", + "path": "x-pack/plugins/ui_actions_enhanced/public/custom_time_range_action.tsx" }, - "; getId: () => string; getFields: () => ", { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchSourceFields", - "text": "SearchSourceFields" + "plugin": "uiActionsEnhanced", + "path": "x-pack/plugins/ui_actions_enhanced/public/custom_time_range_badge.tsx" }, - "; getField: (field: K, recurse?: boolean) => ", { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchSourceFields", - "text": "SearchSourceFields" + "plugin": "lens", + "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx" }, - "[K]; getOwnField: (field: K) => ", { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchSourceFields", - "text": "SearchSourceFields" + "plugin": "lens", + "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx" }, - "[K]; createCopy: () => ", { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchSource", - "text": "SearchSource" + "plugin": "lens", + "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx" }, - "; createChild: (options?: {}) => ", { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchSource", - "text": "SearchSource" + "plugin": "lens", + "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx" }, - "; setParent: (parent?: ", { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.ISearchSource", - "text": "ISearchSource" + "plugin": "lens", + "path": "x-pack/plugins/lens/public/trigger_actions/open_in_discover_helpers.ts" }, - " | undefined, options?: ", { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchSourceOptions", - "text": "SearchSourceOptions" + "plugin": "lens", + "path": "x-pack/plugins/lens/public/trigger_actions/open_in_discover_helpers.ts" }, - ") => ", { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchSource", - "text": "SearchSource" + "plugin": "lens", + "path": "x-pack/plugins/lens/public/trigger_actions/open_in_discover_drilldown.tsx" }, - "; getParent: () => ", { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchSource", - "text": "SearchSource" + "plugin": "lens", + "path": "x-pack/plugins/lens/public/trigger_actions/open_in_discover_drilldown.tsx" }, - " | undefined; fetch$: (options?: ", { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.ISearchOptions", - "text": "ISearchOptions" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx" }, - ") => ", - "Observable", - "<", { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.IKibanaSearchResponse", - "text": "IKibanaSearchResponse" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx" }, - "<", - "SearchResponse", - ">>>; fetch: (options?: ", { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.ISearchOptions", - "text": "ISearchOptions" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/reducers/map/types.ts" }, - ") => Promise<", - "SearchResponse", - ">>; onRequestStart: (handler: (searchSource: ", { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchSource", - "text": "SearchSource" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/reducers/map/types.ts" }, - ", options?: ", { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.ISearchOptions", - "text": "ISearchOptions" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/selectors/map_selectors.ts" }, - " | undefined) => Promise) => void; getSearchRequestBody: () => any; destroy: () => void; getSerializedFields: (recurse?: boolean) => ", { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SerializedSearchSourceFields", - "text": "SerializedSearchSourceFields" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/selectors/map_selectors.ts" }, - "; serialize: () => { searchSourceJSON: string; references: ", - "SavedObjectReference", - "[]; }; }" - ], - "path": "src/plugins/data/common/search/search_source/types.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-public.KibanaContext", - "type": "Type", - "tags": [], - "label": "KibanaContext", - "description": [], - "signature": [ - "{ type: \"kibana_context\"; } & ", { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.ExecutionContextSearch", - "text": "ExecutionContextSearch" - } - ], - "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-public.KueryNode", - "type": "Type", - "tags": [ - "deprecated" - ], - "label": "KueryNode", - "description": [], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-public.MatchAllFilter", - "type": "Type", - "tags": [ - "deprecated" - ], - "label": "MatchAllFilter", - "description": [], - "signature": [ - "Filter", - " & { meta: MatchAllFilterMeta; query: { match_all: ", - "QueryDslMatchAllQuery", - "; }; }" - ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-public.NowProviderInternalContract", - "type": "Type", - "tags": [], - "label": "NowProviderInternalContract", - "description": [], - "signature": [ - "{ get: () => Date; set: (now: Date) => void; reset: () => void; }" - ], - "path": "src/plugins/data/public/now_provider/now_provider.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-public.ParsedInterval", - "type": "Type", - "tags": [], - "label": "ParsedInterval", - "description": [], - "signature": [ - "{ value: number; unit: ", - "Unit", - "; type: \"calendar\" | \"fixed\"; }" - ], - "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_es_interval.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-public.PhraseFilter", - "type": "Type", - "tags": [ - "deprecated" - ], - "label": "PhraseFilter", - "description": [], - "signature": [ - "Filter", - " & { meta: PhraseFilterMeta; query: { match_phrase?: Partial> | undefined; match?: Partial> | undefined; }; }" - ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-public.Query", - "type": "Type", - "tags": [], - "label": "Query", - "description": [], - "signature": [ - "{ query: string | { [key: string]: any; }; language: string; }" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-public.QueryState", - "type": "Type", - "tags": [], - "label": "QueryState", - "description": [ - "\nAll query state service state\n" - ], - "signature": [ - "{ time?: ", + "plugin": "maps", + "path": "x-pack/plugins/maps/public/actions/map_actions.ts" + }, { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/actions/map_actions.ts" }, - " | undefined; refreshInterval?: ", { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.RefreshInterval", - "text": "RefreshInterval" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/routes/map_page/saved_map/types.ts" }, - " | undefined; filters?: ", - "Filter", - "[] | undefined; query?: ", - "Query", - " | undefined; }" - ], - "path": "src/plugins/data/common/query/query_state.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-public.RangeFilter", - "type": "Type", - "tags": [ - "deprecated" - ], - "label": "RangeFilter", - "description": [], - "signature": [ - "Filter", - " & { meta: ", - "RangeFilterMeta", - "; query: { range: { [key: string]: ", - "RangeFilterParams", - "; }; }; }" - ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-public.RangeFilterParams", - "type": "Type", - "tags": [ - "deprecated" - ], - "label": "RangeFilterParams", - "description": [], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-public.RefreshInterval", - "type": "Type", - "tags": [], - "label": "RefreshInterval", - "description": [], - "signature": [ - "{ pause: boolean; value: number; }" - ], - "path": "src/plugins/data/common/query/timefilter/types.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-public.SerializedSearchSourceFields", - "type": "Type", - "tags": [], - "label": "SerializedSearchSourceFields", - "description": [], - "signature": [ - "{ type?: string | undefined; query?: ", - "Query", - " | undefined; filter?: ", - "Filter", - "[] | undefined; sort?: ", { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.EsQuerySortValue", - "text": "EsQuerySortValue" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/routes/map_page/saved_map/types.ts" }, - "[] | undefined; highlight?: ", - "SerializableRecord", - " | undefined; highlightAll?: boolean | undefined; trackTotalHits?: number | boolean | undefined; aggs?: { type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", - "SerializableRecord", - " | undefined; schema?: string | undefined; }[] | undefined; from?: number | undefined; size?: number | undefined; source?: boolean | ", - "Fields", - " | undefined; version?: boolean | undefined; fields?: ", { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchFieldValue", - "text": "SearchFieldValue" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/routes/map_page/url_state/global_sync.ts" }, - "[] | undefined; fieldsFromSource?: ", - "Fields", - " | undefined; index?: string | undefined; searchAfter?: ", { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.EsQuerySearchAfter", - "text": "EsQuerySearchAfter" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/routes/map_page/url_state/global_sync.ts" }, - " | undefined; timeout?: string | undefined; terminate_after?: number | undefined; parent?: ", { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SerializedSearchSourceFields", - "text": "SerializedSearchSourceFields" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/routes/map_page/map_app/index.ts" }, - " | undefined; }" - ], - "path": "src/plugins/data/common/search/search_source/types.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-public.TimeRange", - "type": "Type", - "tags": [], - "label": "TimeRange", - "description": [], - "signature": [ - "{ from: string; to: string; mode?: \"absolute\" | \"relative\" | undefined; }" - ], - "path": "src/plugins/data/common/query/timefilter/types.ts", - "deprecated": false, - "initialIsOpen": false - } - ], - "objects": [ - { - "parentPluginId": "data", - "id": "def-public.AggGroupLabels", - "type": "Object", - "tags": [], - "label": "AggGroupLabels", - "description": [], - "path": "src/plugins/data/common/search/aggs/agg_groups.ts", - "deprecated": false, - "children": [ { - "parentPluginId": "data", - "id": "def-public.AggGroupLabels.AggGroupNames.Buckets", - "type": "string", - "tags": [], - "label": "[AggGroupNames.Buckets]", - "description": [], - "path": "src/plugins/data/common/search/aggs/agg_groups.ts", - "deprecated": false + "plugin": "maps", + "path": "x-pack/plugins/maps/public/routes/map_page/map_app/index.ts" }, { - "parentPluginId": "data", - "id": "def-public.AggGroupLabels.AggGroupNames.Metrics", - "type": "string", - "tags": [], - "label": "[AggGroupNames.Metrics]", - "description": [], - "path": "src/plugins/data/common/search/aggs/agg_groups.ts", - "deprecated": false + "plugin": "maps", + "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx" }, { - "parentPluginId": "data", - "id": "def-public.AggGroupLabels.AggGroupNames.None", - "type": "string", - "tags": [], - "label": "[AggGroupNames.None]", - "description": [], - "path": "src/plugins/data/common/search/aggs/agg_groups.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-public.AggGroupNames", - "type": "Object", - "tags": [], - "label": "AggGroupNames", - "description": [], - "signature": [ - "{ readonly Buckets: \"buckets\"; readonly Metrics: \"metrics\"; readonly None: \"none\"; }" - ], - "path": "src/plugins/data/common/search/aggs/agg_groups.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-public.esFilters", - "type": "Object", - "tags": [ - "deprecated" - ], - "label": "esFilters", - "description": [ - "\nFilter helpers namespace:" - ], - "path": "src/plugins/data/public/deprecated.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [ + "plugin": "maps", + "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx" + }, { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/actions/apply_filter_action.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/locators.ts" }, { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/actions/apply_filter_action.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/locators.ts" }, { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/actions/apply_filter_action.ts" - } - ], - "children": [ + "plugin": "maps", + "path": "x-pack/plugins/maps/public/locators.ts" + }, { - "parentPluginId": "data", - "id": "def-public.esFilters.FILTERS", - "type": "Object", - "tags": [], - "label": "FILTERS", - "description": [], - "signature": [ - "typeof ", - "FILTERS" - ], - "path": "src/plugins/data/public/deprecated.ts", - "deprecated": false + "plugin": "maps", + "path": "x-pack/plugins/maps/public/locators.ts" }, { - "parentPluginId": "data", - "id": "def-public.esFilters.FilterStateStore", - "type": "Object", - "tags": [], - "label": "FilterStateStore", - "description": [], - "signature": [ - "typeof ", - "FilterStateStore" - ], - "path": "src/plugins/data/public/deprecated.ts", - "deprecated": false + "plugin": "dataVisualizer", + "path": "x-pack/plugins/data_visualizer/public/application/common/components/results_links/results_links.tsx" }, { - "parentPluginId": "data", - "id": "def-public.esFilters.buildEmptyFilter", - "type": "Function", - "tags": [], - "label": "buildEmptyFilter", - "description": [], - "signature": [ - "(isPinned: boolean, index?: string | undefined) => ", - "Filter" - ], - "path": "src/plugins/data/public/deprecated.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.esFilters.buildEmptyFilter.$1", - "type": "boolean", - "tags": [], - "label": "isPinned", - "description": [], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.esFilters.buildEmptyFilter.$2", - "type": "string", - "tags": [], - "label": "index", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ] + "plugin": "dataVisualizer", + "path": "x-pack/plugins/data_visualizer/public/application/common/components/results_links/results_links.tsx" }, { - "parentPluginId": "data", - "id": "def-public.esFilters.buildPhrasesFilter", - "type": "Function", - "tags": [], - "label": "buildPhrasesFilter", - "description": [], - "signature": [ - "(field: ", - "DataViewFieldBase", - ", params: PhraseFilterValue[], indexPattern: ", - "DataViewBase", - ") => ", - "PhrasesFilter" - ], - "path": "src/plugins/data/public/deprecated.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.esFilters.buildPhrasesFilter.$1", - "type": "Object", - "tags": [], - "label": "field", - "description": [], - "signature": [ - "DataViewFieldBase" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.esFilters.buildPhrasesFilter.$2", - "type": "Array", - "tags": [], - "label": "params", - "description": [], - "signature": [ - "PhraseFilterValue[]" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.esFilters.buildPhrasesFilter.$3", - "type": "Object", - "tags": [], - "label": "indexPattern", - "description": [], - "signature": [ - "DataViewBase" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ] + "plugin": "dataVisualizer", + "path": "x-pack/plugins/data_visualizer/public/application/common/components/date_picker_wrapper/date_picker_wrapper.tsx" }, { - "parentPluginId": "data", - "id": "def-public.esFilters.buildExistsFilter", - "type": "Function", - "tags": [], - "label": "buildExistsFilter", - "description": [], - "signature": [ - "(field: ", - "DataViewFieldBase", - ", indexPattern: ", - "DataViewBase", - ") => ", - "ExistsFilter" - ], - "path": "src/plugins/data/public/deprecated.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.esFilters.buildExistsFilter.$1", - "type": "Object", - "tags": [], - "label": "field", - "description": [], - "signature": [ - "DataViewFieldBase" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.esFilters.buildExistsFilter.$2", - "type": "Object", - "tags": [], - "label": "indexPattern", - "description": [], - "signature": [ - "DataViewBase" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ] + "plugin": "dataVisualizer", + "path": "x-pack/plugins/data_visualizer/public/application/common/components/date_picker_wrapper/date_picker_wrapper.tsx" }, { - "parentPluginId": "data", - "id": "def-public.esFilters.buildPhraseFilter", - "type": "Function", - "tags": [], - "label": "buildPhraseFilter", - "description": [], - "signature": [ - "(field: ", - "DataViewFieldBase", - ", value: PhraseFilterValue, indexPattern: ", - "DataViewBase", - ") => ", - "PhraseFilter", - " | ", - "ScriptedPhraseFilter" - ], - "path": "src/plugins/data/public/deprecated.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.esFilters.buildPhraseFilter.$1", - "type": "Object", - "tags": [], - "label": "field", - "description": [], - "signature": [ - "DataViewFieldBase" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.esFilters.buildPhraseFilter.$2", - "type": "CompoundType", - "tags": [], - "label": "value", - "description": [], - "signature": [ - "string | number | boolean" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.esFilters.buildPhraseFilter.$3", - "type": "Object", - "tags": [], - "label": "indexPattern", - "description": [], - "signature": [ - "DataViewBase" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ] + "plugin": "ml", + "path": "x-pack/plugins/ml/public/application/services/anomaly_timeline_service.ts" }, { - "parentPluginId": "data", - "id": "def-public.esFilters.buildQueryFilter", - "type": "Function", - "tags": [], - "label": "buildQueryFilter", - "description": [], - "signature": [ - "(query: (Record & { query_string?: { query: string; fields?: string[] | undefined; } | undefined; }) | undefined, index: string, alias?: string | undefined, meta?: ", - "FilterMeta", - " | undefined) => { query: (Record & { query_string?: { query: string; fields?: string[] | undefined; } | undefined; }) | undefined; meta: { alias: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index: string; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; }; }" - ], - "path": "src/plugins/data/public/deprecated.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.esFilters.buildQueryFilter.$1", - "type": "CompoundType", - "tags": [], - "label": "query", - "description": [], - "signature": [ - "(Record & { query_string?: { query: string; fields?: string[] | undefined; } | undefined; }) | undefined" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.esFilters.buildQueryFilter.$2", - "type": "string", - "tags": [], - "label": "index", - "description": [], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.esFilters.buildQueryFilter.$3", - "type": "string", - "tags": [], - "label": "alias", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.esFilters.buildQueryFilter.$4", - "type": "Object", - "tags": [], - "label": "meta", - "description": [], - "signature": [ - "FilterMeta", - " | undefined" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ] + "plugin": "ml", + "path": "x-pack/plugins/ml/public/application/services/anomaly_timeline_service.ts" }, { - "parentPluginId": "data", - "id": "def-public.esFilters.buildRangeFilter", - "type": "Function", - "tags": [], - "label": "buildRangeFilter", - "description": [], - "signature": [ - "(field: ", - "DataViewFieldBase", - ", params: ", - "RangeFilterParams", - ", indexPattern: ", - "DataViewBase", - ", formattedValue?: string | undefined) => ", - "RangeFilter", - " | ", - "ScriptedRangeFilter", - " | MatchAllRangeFilter" - ], - "path": "src/plugins/data/public/deprecated.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.esFilters.buildRangeFilter.$1", - "type": "Object", - "tags": [], - "label": "field", - "description": [], - "signature": [ - "DataViewFieldBase" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.esFilters.buildRangeFilter.$2", - "type": "Object", - "tags": [], - "label": "params", - "description": [], - "signature": [ - "RangeFilterParams" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.esFilters.buildRangeFilter.$3", - "type": "Object", - "tags": [], - "label": "indexPattern", - "description": [], - "signature": [ - "DataViewBase" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.esFilters.buildRangeFilter.$4", - "type": "string", - "tags": [], - "label": "formattedValue", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ] + "plugin": "ml", + "path": "x-pack/plugins/ml/public/application/services/anomaly_timeline_service.ts" }, { - "parentPluginId": "data", - "id": "def-public.esFilters.isPhraseFilter", - "type": "Function", - "tags": [], - "label": "isPhraseFilter", - "description": [], - "signature": [ - "(filter: ", - "Filter", - ") => filter is ", - "PhraseFilter" - ], - "path": "src/plugins/data/public/deprecated.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.esFilters.isPhraseFilter.$1", - "type": "Object", - "tags": [], - "label": "filter", - "description": [], - "signature": [ - "{ $state?: { store: ", - "FilterStateStore", - "; } | undefined; meta: ", - "FilterMeta", - "; query?: Record | undefined; }" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ] + "plugin": "ml", + "path": "x-pack/plugins/ml/public/application/services/anomaly_explorer_charts_service.ts" }, { - "parentPluginId": "data", - "id": "def-public.esFilters.isExistsFilter", - "type": "Function", - "tags": [], - "label": "isExistsFilter", - "description": [], - "signature": [ - "(filter: ", - "Filter", - ") => filter is ", - "ExistsFilter" - ], - "path": "src/plugins/data/public/deprecated.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.esFilters.isExistsFilter.$1", - "type": "Object", - "tags": [], - "label": "filter", - "description": [], - "signature": [ - "{ $state?: { store: ", - "FilterStateStore", - "; } | undefined; meta: ", - "FilterMeta", - "; query?: Record | undefined; }" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ] + "plugin": "ml", + "path": "x-pack/plugins/ml/public/application/services/anomaly_explorer_charts_service.ts" }, { - "parentPluginId": "data", - "id": "def-public.esFilters.isPhrasesFilter", - "type": "Function", - "tags": [], - "label": "isPhrasesFilter", - "description": [], - "signature": [ - "(filter: ", - "Filter", - ") => filter is ", - "PhrasesFilter" - ], - "path": "src/plugins/data/public/deprecated.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.esFilters.isPhrasesFilter.$1", - "type": "Object", - "tags": [], - "label": "filter", - "description": [], - "signature": [ - "{ $state?: { store: ", - "FilterStateStore", - "; } | undefined; meta: ", - "FilterMeta", - "; query?: Record | undefined; }" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ] + "plugin": "ml", + "path": "x-pack/plugins/ml/public/application/services/anomaly_explorer_charts_service.ts" }, { - "parentPluginId": "data", - "id": "def-public.esFilters.isRangeFilter", - "type": "Function", - "tags": [], - "label": "isRangeFilter", - "description": [], - "signature": [ - "(filter?: ", - "Filter", - " | undefined) => filter is ", - "RangeFilter" - ], - "path": "src/plugins/data/public/deprecated.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.esFilters.isRangeFilter.$1", - "type": "Object", - "tags": [], - "label": "filter", - "description": [], - "signature": [ - "Filter", - " | undefined" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ] + "plugin": "ml", + "path": "x-pack/plugins/ml/public/application/components/navigation_menu/date_picker_wrapper/date_picker_wrapper.tsx" }, { - "parentPluginId": "data", - "id": "def-public.esFilters.isMatchAllFilter", - "type": "Function", - "tags": [], - "label": "isMatchAllFilter", - "description": [], - "signature": [ - "(filter: ", - "Filter", - ") => filter is ", - "MatchAllFilter" - ], - "path": "src/plugins/data/public/deprecated.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.esFilters.isMatchAllFilter.$1", - "type": "Object", - "tags": [], - "label": "filter", - "description": [], - "signature": [ - "{ $state?: { store: ", - "FilterStateStore", - "; } | undefined; meta: ", - "FilterMeta", - "; query?: Record | undefined; }" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ] + "plugin": "ml", + "path": "x-pack/plugins/ml/public/application/components/navigation_menu/date_picker_wrapper/date_picker_wrapper.tsx" }, { - "parentPluginId": "data", - "id": "def-public.esFilters.isQueryStringFilter", - "type": "Function", - "tags": [], - "label": "isQueryStringFilter", - "description": [], - "signature": [ - "(filter: ", - "Filter", - ") => filter is ", - "QueryStringFilter" - ], - "path": "src/plugins/data/public/deprecated.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.esFilters.isQueryStringFilter.$1", - "type": "Object", - "tags": [], - "label": "filter", - "description": [], - "signature": [ - "{ $state?: { store: ", - "FilterStateStore", - "; } | undefined; meta: ", - "FilterMeta", - "; query?: Record | undefined; }" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ] + "plugin": "infra", + "path": "x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx" }, { - "parentPluginId": "data", - "id": "def-public.esFilters.isFilterPinned", - "type": "Function", - "tags": [], - "label": "isFilterPinned", - "description": [], - "signature": [ - "(filter: ", - "Filter", - ") => boolean | undefined" - ], - "path": "src/plugins/data/public/deprecated.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.esFilters.isFilterPinned.$1", - "type": "Object", - "tags": [], - "label": "filter", - "description": [], - "signature": [ - "{ $state?: { store: ", - "FilterStateStore", - "; } | undefined; meta: ", - "FilterMeta", - "; query?: Record | undefined; }" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ] + "plugin": "infra", + "path": "x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx" }, { - "parentPluginId": "data", - "id": "def-public.esFilters.toggleFilterNegated", - "type": "Function", - "tags": [], - "label": "toggleFilterNegated", - "description": [], - "signature": [ - "(filter: ", - "Filter", - ") => { meta: { negate: boolean; alias?: string | null | undefined; disabled?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; }; $state?: { store: ", - "FilterStateStore", - "; } | undefined; query?: Record | undefined; }" - ], - "path": "src/plugins/data/public/deprecated.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.esFilters.toggleFilterNegated.$1", - "type": "Object", - "tags": [], - "label": "filter", - "description": [], - "signature": [ - "{ $state?: { store: ", - "FilterStateStore", - "; } | undefined; meta: ", - "FilterMeta", - "; query?: Record | undefined; }" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ] + "plugin": "infra", + "path": "x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx" }, { - "parentPluginId": "data", - "id": "def-public.esFilters.disableFilter", - "type": "Function", - "tags": [], - "label": "disableFilter", - "description": [], - "signature": [ - "(filter: ", - "Filter", - ") => ", - "Filter" - ], - "path": "src/plugins/data/public/deprecated.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.esFilters.disableFilter.$1", - "type": "Object", - "tags": [], - "label": "filter", - "description": [], - "signature": [ - "{ $state?: { store: ", - "FilterStateStore", - "; } | undefined; meta: ", - "FilterMeta", - "; query?: Record | undefined; }" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ] + "plugin": "infra", + "path": "x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx" }, { - "parentPluginId": "data", - "id": "def-public.esFilters.getPhraseFilterField", - "type": "Function", - "tags": [], - "label": "getPhraseFilterField", - "description": [], - "signature": [ - "(filter: ", - "PhraseFilter", - ") => string" - ], - "path": "src/plugins/data/public/deprecated.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.esFilters.getPhraseFilterField.$1", - "type": "CompoundType", - "tags": [], - "label": "filter", - "description": [], - "signature": [ - "Filter", - " & { meta: PhraseFilterMeta; query: { match_phrase?: Partial> | undefined; match?: Partial> | undefined; }; }" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ] + "plugin": "infra", + "path": "x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx" }, { - "parentPluginId": "data", - "id": "def-public.esFilters.getPhraseFilterValue", - "type": "Function", - "tags": [], - "label": "getPhraseFilterValue", - "description": [], - "signature": [ - "(filter: ", - "PhraseFilter", - " | ", - "ScriptedPhraseFilter", - ") => PhraseFilterValue" - ], - "path": "src/plugins/data/public/deprecated.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.esFilters.getPhraseFilterValue.$1", - "type": "CompoundType", - "tags": [], - "label": "filter", - "description": [], - "signature": [ - "PhraseFilter", - " | ", - "ScriptedPhraseFilter" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ] + "plugin": "infra", + "path": "x-pack/plugins/infra/public/components/log_stream/log_stream_embeddable.tsx" }, { - "parentPluginId": "data", - "id": "def-public.esFilters.getDisplayValueFromFilter", - "type": "Function", - "tags": [], - "label": "getDisplayValueFromFilter", - "description": [], - "signature": [ - "(filter: ", - "Filter", - ", indexPatterns: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - "[]) => string" - ], - "path": "src/plugins/data/public/deprecated.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.esFilters.getDisplayValueFromFilter.$1", - "type": "Object", - "tags": [], - "label": "filter", - "description": [], - "signature": [ - "{ $state?: { store: ", - "FilterStateStore", - "; } | undefined; meta: ", - "FilterMeta", - "; query?: Record | undefined; }" - ], - "path": "src/plugins/data/public/query/filter_manager/lib/get_display_value.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.esFilters.getDisplayValueFromFilter.$2", - "type": "Array", - "tags": [], - "label": "indexPatterns", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - "[]" - ], - "path": "src/plugins/data/public/query/filter_manager/lib/get_display_value.ts", - "deprecated": false - } - ] + "plugin": "infra", + "path": "x-pack/plugins/infra/public/components/log_stream/log_stream_embeddable.tsx" }, { - "parentPluginId": "data", - "id": "def-public.esFilters.compareFilters", - "type": "Function", - "tags": [], - "label": "compareFilters", - "description": [], - "signature": [ - "(first: ", - "Filter", - " | ", - "Filter", - "[], second: ", - "Filter", - " | ", - "Filter", - "[], comparatorOptions?: ", - "FilterCompareOptions", - " | undefined) => boolean" - ], - "path": "src/plugins/data/public/deprecated.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.esFilters.compareFilters.$1", - "type": "CompoundType", - "tags": [], - "label": "first", - "description": [], - "signature": [ - "Filter", - " | ", - "Filter", - "[]" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.esFilters.compareFilters.$2", - "type": "CompoundType", - "tags": [], - "label": "second", - "description": [], - "signature": [ - "Filter", - " | ", - "Filter", - "[]" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.esFilters.compareFilters.$3", - "type": "Object", - "tags": [], - "label": "comparatorOptions", - "description": [], - "signature": [ - "FilterCompareOptions", - " | undefined" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ] + "plugin": "infra", + "path": "x-pack/plugins/infra/public/pages/logs/log_entry_rate/use_log_entry_rate_results_url_state.tsx" }, { - "parentPluginId": "data", - "id": "def-public.esFilters.COMPARE_ALL_OPTIONS", - "type": "Object", - "tags": [], - "label": "COMPARE_ALL_OPTIONS", - "description": [], - "signature": [ - "FilterCompareOptions" - ], - "path": "src/plugins/data/public/deprecated.ts", - "deprecated": false + "plugin": "infra", + "path": "x-pack/plugins/infra/public/pages/logs/log_entry_rate/use_log_entry_rate_results_url_state.tsx" }, { - "parentPluginId": "data", - "id": "def-public.esFilters.generateFilters", - "type": "Function", - "tags": [], - "label": "generateFilters", - "description": [], - "signature": [ - "(filterManager: ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.FilterManager", - "text": "FilterManager" - }, - ", field: string | ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" - }, - ", values: any, operation: string, index: string) => ", - "Filter", - "[]" - ], - "path": "src/plugins/data/public/deprecated.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.esFilters.generateFilters.$1", - "type": "Object", - "tags": [], - "label": "filterManager", - "description": [], - "signature": [ - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.FilterManager", - "text": "FilterManager" - } - ], - "path": "src/plugins/data/public/query/filter_manager/lib/generate_filters.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.esFilters.generateFilters.$2", - "type": "CompoundType", - "tags": [], - "label": "field", - "description": [], - "signature": [ - "string | ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" - } - ], - "path": "src/plugins/data/public/query/filter_manager/lib/generate_filters.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.esFilters.generateFilters.$3", - "type": "Any", - "tags": [], - "label": "values", - "description": [], - "signature": [ - "any" - ], - "path": "src/plugins/data/public/query/filter_manager/lib/generate_filters.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.esFilters.generateFilters.$4", - "type": "string", - "tags": [], - "label": "operation", - "description": [], - "path": "src/plugins/data/public/query/filter_manager/lib/generate_filters.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.esFilters.generateFilters.$5", - "type": "string", - "tags": [], - "label": "index", - "description": [], - "path": "src/plugins/data/public/query/filter_manager/lib/generate_filters.ts", - "deprecated": false - } - ] + "plugin": "fleet", + "path": "x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/agent_logs.tsx" }, { - "parentPluginId": "data", - "id": "def-public.esFilters.onlyDisabledFiltersChanged", - "type": "Function", - "tags": [], - "label": "onlyDisabledFiltersChanged", - "description": [], - "signature": [ - "(newFilters?: ", - "Filter", - "[] | undefined, oldFilters?: ", - "Filter", - "[] | undefined) => boolean" - ], - "path": "src/plugins/data/public/deprecated.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.esFilters.onlyDisabledFiltersChanged.$1", - "type": "Array", - "tags": [], - "label": "newFilters", - "description": [], - "signature": [ - "Filter", - "[] | undefined" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.esFilters.onlyDisabledFiltersChanged.$2", - "type": "Array", - "tags": [], - "label": "oldFilters", - "description": [], - "signature": [ - "Filter", - "[] | undefined" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ] + "plugin": "fleet", + "path": "x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/agent_logs.tsx" }, { - "parentPluginId": "data", - "id": "def-public.esFilters.changeTimeFilter", - "type": "Function", - "tags": [], - "label": "changeTimeFilter", - "description": [], - "signature": [ - "(timeFilter: ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.TimefilterContract", - "text": "TimefilterContract" - }, - ", filter: ", - "RangeFilter", - ") => void" - ], - "path": "src/plugins/data/public/deprecated.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.esFilters.changeTimeFilter.$1", - "type": "Object", - "tags": [], - "label": "timeFilter", - "description": [], - "signature": [ - "{ isTimeRangeSelectorEnabled: () => boolean; isAutoRefreshSelectorEnabled: () => boolean; isTimeTouched: () => boolean; isRefreshIntervalTouched: () => boolean; getEnabledUpdated$: () => ", - "Observable", - "; getTimeUpdate$: () => ", - "Observable", - "; getRefreshIntervalUpdate$: () => ", - "Observable", - "; getAutoRefreshFetch$: () => ", - "Observable", - "<", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.AutoRefreshDoneFn", - "text": "AutoRefreshDoneFn" - }, - ">; getFetch$: () => ", - "Observable", - "; getTime: () => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, - "; getAbsoluteTime: () => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, - "; setTime: (time: ", - "InputTimeRange", - ") => void; getRefreshInterval: () => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.RefreshInterval", - "text": "RefreshInterval" - }, - "; setRefreshInterval: (refreshInterval: Partial<", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.RefreshInterval", - "text": "RefreshInterval" - }, - ">) => void; createFilter: (indexPattern: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IIndexPattern", - "text": "IIndexPattern" - }, - ", timeRange?: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, - " | undefined) => ", - "RangeFilter", - " | ", - "ScriptedRangeFilter", - " | MatchAllRangeFilter | undefined; createRelativeFilter: (indexPattern: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IIndexPattern", - "text": "IIndexPattern" - }, - ", timeRange?: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, - " | undefined) => ", - "RangeFilter", - " | ", - "ScriptedRangeFilter", - " | MatchAllRangeFilter | undefined; getBounds: () => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRangeBounds", - "text": "TimeRangeBounds" - }, - "; calculateBounds: (timeRange: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, - ") => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRangeBounds", - "text": "TimeRangeBounds" - }, - "; getActiveBounds: () => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRangeBounds", - "text": "TimeRangeBounds" - }, - " | undefined; enableTimeRangeSelector: () => void; disableTimeRangeSelector: () => void; enableAutoRefreshSelector: () => void; disableAutoRefreshSelector: () => void; getTimeDefaults: () => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, - "; getRefreshIntervalDefaults: () => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.RefreshInterval", - "text": "RefreshInterval" - }, - "; }" - ], - "path": "src/plugins/data/public/query/timefilter/lib/change_time_filter.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.esFilters.changeTimeFilter.$2", - "type": "CompoundType", - "tags": [], - "label": "filter", - "description": [], - "signature": [ - "Filter", - " & { meta: ", - "RangeFilterMeta", - "; query: { range: { [key: string]: ", - "RangeFilterParams", - "; }; }; }" - ], - "path": "src/plugins/data/public/query/timefilter/lib/change_time_filter.ts", - "deprecated": false - } - ] + "plugin": "fleet", + "path": "x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/agent_logs.tsx" }, { - "parentPluginId": "data", - "id": "def-public.esFilters.convertRangeFilterToTimeRangeString", - "type": "Function", - "tags": [], - "label": "convertRangeFilterToTimeRangeString", - "description": [], - "signature": [ - "(filter: ", - "RangeFilter", - ") => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - } - ], - "path": "src/plugins/data/public/deprecated.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.esFilters.convertRangeFilterToTimeRangeString.$1", - "type": "CompoundType", - "tags": [], - "label": "filter", - "description": [], - "signature": [ - "Filter", - " & { meta: ", - "RangeFilterMeta", - "; query: { range: { [key: string]: ", - "RangeFilterParams", - "; }; }; }" - ], - "path": "src/plugins/data/public/query/timefilter/lib/change_time_filter.ts", - "deprecated": false - } - ] + "plugin": "canvas", + "path": "x-pack/plugins/canvas/types/embeddables.ts" }, { - "parentPluginId": "data", - "id": "def-public.esFilters.mapAndFlattenFilters", - "type": "Function", - "tags": [], - "label": "mapAndFlattenFilters", - "description": [], - "signature": [ - "(filters: ", - "Filter", - "[]) => ", - "Filter", - "[]" - ], - "path": "src/plugins/data/public/deprecated.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.esFilters.mapAndFlattenFilters.$1", - "type": "Array", - "tags": [], - "label": "filters", - "description": [], - "signature": [ - "Filter", - "[]" - ], - "path": "src/plugins/data/public/query/filter_manager/lib/map_and_flatten_filters.ts", - "deprecated": false - } - ] + "plugin": "canvas", + "path": "x-pack/plugins/canvas/types/embeddables.ts" }, { - "parentPluginId": "data", - "id": "def-public.esFilters.extractTimeFilter", - "type": "Function", - "tags": [], - "label": "extractTimeFilter", - "description": [], - "signature": [ - "(timeFieldName: string, filters: ", - "Filter", - "[]) => { restOfFilters: ", - "Filter", - "[]; timeRangeFilter: ", - "RangeFilter", - " | undefined; }" - ], - "path": "src/plugins/data/public/deprecated.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.esFilters.extractTimeFilter.$1", - "type": "string", - "tags": [], - "label": "timeFieldName", - "description": [], - "path": "src/plugins/data/public/query/timefilter/lib/extract_time_filter.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.esFilters.extractTimeFilter.$2", - "type": "Array", - "tags": [], - "label": "filters", - "description": [], - "signature": [ - "Filter", - "[]" - ], - "path": "src/plugins/data/public/query/timefilter/lib/extract_time_filter.ts", - "deprecated": false - } - ] + "plugin": "dashboardEnhanced", + "path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/embeddable_to_dashboard_drilldown/embeddable_to_dashboard_drilldown.tsx" }, { - "parentPluginId": "data", - "id": "def-public.esFilters.extractTimeRange", - "type": "Function", - "tags": [], - "label": "extractTimeRange", - "description": [], - "signature": [ - "(filters: ", - "Filter", - "[], timeFieldName?: string | undefined) => { restOfFilters: ", - "Filter", - "[]; timeRange?: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, - " | undefined; }" - ], - "path": "src/plugins/data/public/deprecated.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.esFilters.extractTimeRange.$1", - "type": "Array", - "tags": [], - "label": "filters", - "description": [], - "signature": [ - "Filter", - "[]" - ], - "path": "src/plugins/data/public/query/timefilter/lib/extract_time_filter.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.esFilters.extractTimeRange.$2", - "type": "string", - "tags": [], - "label": "timeFieldName", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/data/public/query/timefilter/lib/extract_time_filter.ts", - "deprecated": false - } - ] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-public.esKuery", - "type": "Object", - "tags": [ - "deprecated" - ], - "label": "esKuery", - "description": [], - "path": "src/plugins/data/public/deprecated.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [ + "plugin": "dashboardEnhanced", + "path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/embeddable_to_dashboard_drilldown/embeddable_to_dashboard_drilldown.tsx" + }, { - "plugin": "apm", - "path": "x-pack/plugins/apm/public/components/shared/kuery_bar/index.tsx" + "plugin": "discoverEnhanced", + "path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts" }, { - "plugin": "apm", - "path": "x-pack/plugins/apm/public/components/shared/kuery_bar/index.tsx" + "plugin": "discoverEnhanced", + "path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts" }, { - "plugin": "apm", - "path": "x-pack/plugins/apm/public/components/shared/kuery_bar/index.tsx" - } - ], - "children": [ + "plugin": "monitoring", + "path": "x-pack/plugins/monitoring/public/url_state.ts" + }, { - "parentPluginId": "data", - "id": "def-public.esKuery.nodeTypes", - "type": "Object", - "tags": [], - "label": "nodeTypes", - "description": [], - "signature": [ - "NodeTypes" - ], - "path": "src/plugins/data/public/deprecated.ts", - "deprecated": false + "plugin": "monitoring", + "path": "x-pack/plugins/monitoring/public/url_state.ts" }, { - "parentPluginId": "data", - "id": "def-public.esKuery.fromKueryExpression", - "type": "Function", - "tags": [], - "label": "fromKueryExpression", - "description": [], - "signature": [ - "(expression: string | ", - "QueryDslQueryContainer", - ", parseOptions?: Partial<", - "KueryParseOptions", - "> | undefined) => ", - "KueryNode" - ], - "path": "src/plugins/data/public/deprecated.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.esKuery.fromKueryExpression.$1", - "type": "CompoundType", - "tags": [], - "label": "expression", - "description": [], - "signature": [ - "string | ", - "QueryDslQueryContainer" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.esKuery.fromKueryExpression.$2", - "type": "Object", - "tags": [], - "label": "parseOptions", - "description": [], - "signature": [ - "Partial<", - "KueryParseOptions", - "> | undefined" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ] + "plugin": "monitoring", + "path": "x-pack/plugins/monitoring/public/application/contexts/global_state_context.tsx" }, { - "parentPluginId": "data", - "id": "def-public.esKuery.toElasticsearchQuery", - "type": "Function", - "tags": [], - "label": "toElasticsearchQuery", - "description": [], - "signature": [ - "(node: ", - "KueryNode", - ", indexPattern?: ", - "DataViewBase", - " | undefined, config?: ", - "KueryQueryOptions", - " | undefined, context?: Record | undefined) => ", - "QueryDslQueryContainer" - ], - "path": "src/plugins/data/public/deprecated.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.esKuery.toElasticsearchQuery.$1", - "type": "Object", - "tags": [], - "label": "node", - "description": [], - "signature": [ - "KueryNode" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.esKuery.toElasticsearchQuery.$2", - "type": "Object", - "tags": [], - "label": "indexPattern", - "description": [], - "signature": [ - "DataViewBase", - " | undefined" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.esKuery.toElasticsearchQuery.$3", - "type": "Object", - "tags": [], - "label": "config", - "description": [], - "signature": [ - "KueryQueryOptions", - " | undefined" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.esKuery.toElasticsearchQuery.$4", - "type": "Object", - "tags": [], - "label": "context", - "description": [], - "signature": [ - "Record | undefined" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-public.esQuery", - "type": "Object", - "tags": [ - "deprecated" - ], - "label": "esQuery", - "description": [], - "path": "src/plugins/data/public/deprecated.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [], - "children": [ + "plugin": "monitoring", + "path": "x-pack/plugins/monitoring/public/application/contexts/global_state_context.tsx" + }, { - "parentPluginId": "data", - "id": "def-public.esQuery.buildEsQuery", - "type": "Function", - "tags": [], - "label": "buildEsQuery", - "description": [], - "signature": [ - "(indexPattern: ", - "DataViewBase", - " | undefined, queries: ", - "Query", - " | ", - "Query", - "[], filters: ", - "Filter", - " | ", - "Filter", - "[], config?: ", - "EsQueryConfig", - " | undefined) => { bool: ", - "BoolQuery", - "; }" - ], - "path": "src/plugins/data/public/deprecated.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.esQuery.buildEsQuery.$1", - "type": "Object", - "tags": [], - "label": "indexPattern", - "description": [], - "signature": [ - "DataViewBase", - " | undefined" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.esQuery.buildEsQuery.$2", - "type": "CompoundType", - "tags": [], - "label": "queries", - "description": [], - "signature": [ - "Query", - " | ", - "Query", - "[]" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.esQuery.buildEsQuery.$3", - "type": "CompoundType", - "tags": [], - "label": "filters", - "description": [], - "signature": [ - "Filter", - " | ", - "Filter", - "[]" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.esQuery.buildEsQuery.$4", - "type": "CompoundType", - "tags": [], - "label": "config", - "description": [], - "signature": [ - "EsQueryConfig", - " | undefined" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ] + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/public/common/components/query_bar/index.tsx" }, { - "parentPluginId": "data", - "id": "def-public.esQuery.getEsQueryConfig", - "type": "Function", - "tags": [], - "label": "getEsQueryConfig", - "description": [], - "signature": [ - "(config: KibanaConfig) => ", - "EsQueryConfig" - ], - "path": "src/plugins/data/public/deprecated.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.esQuery.getEsQueryConfig.$1", - "type": "Object", - "tags": [], - "label": "config", - "description": [], - "signature": [ - "KibanaConfig" - ], - "path": "src/plugins/data/common/es_query/get_es_query_config.ts", - "deprecated": false - } - ] + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/public/common/components/query_bar/index.tsx" }, { - "parentPluginId": "data", - "id": "def-public.esQuery.buildQueryFromFilters", - "type": "Function", - "tags": [], - "label": "buildQueryFromFilters", - "description": [], - "signature": [ - "(filters: ", - "Filter", - "[] | undefined, indexPattern: ", - "DataViewBase", - " | undefined, ignoreFilterIfFieldNotInIndex?: boolean | undefined) => ", - "BoolQuery" - ], - "path": "src/plugins/data/public/deprecated.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.esQuery.buildQueryFromFilters.$1", - "type": "Array", - "tags": [], - "label": "filters", - "description": [], - "signature": [ - "Filter", - "[] | undefined" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.esQuery.buildQueryFromFilters.$2", - "type": "Object", - "tags": [], - "label": "indexPattern", - "description": [], - "signature": [ - "DataViewBase", - " | undefined" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.esQuery.buildQueryFromFilters.$3", - "type": "CompoundType", - "tags": [], - "label": "ignoreFilterIfFieldNotInIndex", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ] + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/public/common/components/query_bar/index.tsx" }, { - "parentPluginId": "data", - "id": "def-public.esQuery.luceneStringToDsl", - "type": "Function", - "tags": [], - "label": "luceneStringToDsl", - "description": [], - "signature": [ - "(query: string | ", - "QueryDslQueryContainer", - ") => ", - "QueryDslQueryContainer" - ], - "path": "src/plugins/data/public/deprecated.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.esQuery.luceneStringToDsl.$1", - "type": "CompoundType", - "tags": [], - "label": "query", - "description": [], - "signature": [ - "string | ", - "QueryDslQueryContainer" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ] + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/public/common/components/search_bar/index.tsx" }, { - "parentPluginId": "data", - "id": "def-public.esQuery.decorateQuery", - "type": "Function", - "tags": [], - "label": "decorateQuery", - "description": [], - "signature": [ - "(query: ", - "QueryDslQueryContainer", - ", queryStringOptions: string | ", - "SerializableRecord", - ", dateFormatTZ?: string | undefined) => ", - "QueryDslQueryContainer" - ], - "path": "src/plugins/data/public/deprecated.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.esQuery.decorateQuery.$1", - "type": "Object", - "tags": [], - "label": "query", - "description": [], - "signature": [ - "QueryDslQueryContainer" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.esQuery.decorateQuery.$2", - "type": "CompoundType", - "tags": [], - "label": "queryStringOptions", - "description": [], - "signature": [ - "string | ", - "SerializableRecord" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.esQuery.decorateQuery.$3", - "type": "string", - "tags": [], - "label": "dateFormatTZ", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-public.exporters", - "type": "Object", - "tags": [], - "label": "exporters", - "description": [], - "path": "src/plugins/data/public/index.ts", - "deprecated": false, - "children": [ + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/public/common/components/search_bar/index.tsx" + }, { - "parentPluginId": "data", - "id": "def-public.exporters.datatableToCSV", - "type": "Function", - "tags": [], - "label": "datatableToCSV", - "description": [], - "signature": [ - "({ columns, rows }: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.Datatable", - "text": "Datatable" - }, - ", { csvSeparator, quoteValues, formatFactory, raw, escapeFormulaValues }: CSVOptions) => string" - ], - "path": "src/plugins/data/public/index.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.exporters.datatableToCSV.$1", - "type": "Object", - "tags": [], - "label": "__0", - "description": [], - "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.Datatable", - "text": "Datatable" - } - ], - "path": "src/plugins/data/common/exports/export_csv.tsx", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.exporters.datatableToCSV.$2", - "type": "Object", - "tags": [], - "label": "__1", - "description": [], - "signature": [ - "CSVOptions" - ], - "path": "src/plugins/data/common/exports/export_csv.tsx", - "deprecated": false - } - ] + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/public/common/components/search_bar/index.tsx" }, { - "parentPluginId": "data", - "id": "def-public.exporters.CSV_MIME_TYPE", - "type": "string", - "tags": [], - "label": "CSV_MIME_TYPE", - "description": [], - "path": "src/plugins/data/public/index.ts", - "deprecated": false + "plugin": "uiActionsEnhanced", + "path": "x-pack/plugins/ui_actions_enhanced/public/can_inherit_time_range.ts" }, { - "parentPluginId": "data", - "id": "def-public.exporters.cellHasFormulas", - "type": "Function", - "tags": [], - "label": "cellHasFormulas", - "description": [], - "signature": [ - "(val: string) => boolean" - ], - "path": "src/plugins/data/public/index.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.exporters.cellHasFormulas.$1", - "type": "string", - "tags": [], - "label": "val", - "description": [], - "path": "src/plugins/data/common/exports/formula_checks.ts", - "deprecated": false - } - ] + "plugin": "uiActionsEnhanced", + "path": "x-pack/plugins/ui_actions_enhanced/public/can_inherit_time_range.ts" }, { - "parentPluginId": "data", - "id": "def-public.exporters.tableHasFormulas", - "type": "Function", - "tags": [], - "label": "tableHasFormulas", - "description": [], - "signature": [ - "(columns: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.DatatableColumn", - "text": "DatatableColumn" - }, - "[], rows: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.DatatableRow", - "text": "DatatableRow" - }, - "[]) => boolean" - ], - "path": "src/plugins/data/public/index.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.exporters.tableHasFormulas.$1", - "type": "Array", - "tags": [], - "label": "columns", - "description": [], - "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.DatatableColumn", - "text": "DatatableColumn" - }, - "[]" - ], - "path": "src/plugins/data/common/exports/formula_checks.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.exporters.tableHasFormulas.$2", - "type": "Array", - "tags": [], - "label": "rows", - "description": [], - "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.DatatableRow", - "text": "DatatableRow" - }, - "[]" - ], - "path": "src/plugins/data/common/exports/formula_checks.ts", - "deprecated": false - } - ] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-public.indexPatterns", - "type": "Object", - "tags": [], - "label": "indexPatterns", - "description": [], - "path": "src/plugins/data/public/index.ts", - "deprecated": false, - "children": [ + "plugin": "uiActionsEnhanced", + "path": "x-pack/plugins/ui_actions_enhanced/public/test_helpers/time_range_embeddable.ts" + }, { - "parentPluginId": "data", - "id": "def-public.indexPatterns.ILLEGAL_CHARACTERS_KEY", - "type": "string", - "tags": [], - "label": "ILLEGAL_CHARACTERS_KEY", - "description": [], - "path": "src/plugins/data/public/index.ts", - "deprecated": false + "plugin": "uiActionsEnhanced", + "path": "x-pack/plugins/ui_actions_enhanced/public/test_helpers/time_range_embeddable.ts" }, { - "parentPluginId": "data", - "id": "def-public.indexPatterns.CONTAINS_SPACES_KEY", - "type": "string", - "tags": [], - "label": "CONTAINS_SPACES_KEY", - "description": [], - "path": "src/plugins/data/public/index.ts", - "deprecated": false + "plugin": "uiActionsEnhanced", + "path": "x-pack/plugins/ui_actions_enhanced/public/test_helpers/time_range_container.ts" }, { - "parentPluginId": "data", - "id": "def-public.indexPatterns.ILLEGAL_CHARACTERS_VISIBLE", - "type": "Array", - "tags": [], - "label": "ILLEGAL_CHARACTERS_VISIBLE", - "description": [], - "signature": [ - "string[]" - ], - "path": "src/plugins/data/public/index.ts", - "deprecated": false + "plugin": "uiActionsEnhanced", + "path": "x-pack/plugins/ui_actions_enhanced/public/test_helpers/time_range_container.ts" }, { - "parentPluginId": "data", - "id": "def-public.indexPatterns.ILLEGAL_CHARACTERS", - "type": "Array", - "tags": [], - "label": "ILLEGAL_CHARACTERS", - "description": [], - "signature": [ - "string[]" - ], - "path": "src/plugins/data/public/index.ts", - "deprecated": false + "plugin": "uiActionsEnhanced", + "path": "x-pack/plugins/ui_actions_enhanced/public/test_helpers/time_range_container.ts" }, { - "parentPluginId": "data", - "id": "def-public.indexPatterns.isFilterable", - "type": "Function", - "tags": [], - "label": "isFilterable", - "description": [], - "signature": [ - "(field: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" - }, - ") => boolean" - ], - "path": "src/plugins/data/public/index.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.indexPatterns.isFilterable.$1", - "type": "Object", - "tags": [], - "label": "field", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" - } - ], - "path": "src/plugins/data_views/common/fields/utils.ts", - "deprecated": false - } - ] + "plugin": "urlDrilldown", + "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/variables/context_variables.ts" }, { - "parentPluginId": "data", - "id": "def-public.indexPatterns.isNestedField", - "type": "Function", - "tags": [], - "label": "isNestedField", - "description": [], - "signature": [ - "(field: HasSubtype) => boolean" - ], - "path": "src/plugins/data/public/index.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.indexPatterns.isNestedField.$1", - "type": "Object", - "tags": [], - "label": "field", - "description": [], - "signature": [ - "{ subType?: ", - "IFieldSubType", - " | undefined; }" - ], - "path": "src/plugins/data_views/common/fields/utils.ts", - "deprecated": false - } - ] + "plugin": "urlDrilldown", + "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/variables/context_variables.ts" }, { - "parentPluginId": "data", - "id": "def-public.indexPatterns.isMultiField", - "type": "Function", - "tags": [], - "label": "isMultiField", - "description": [], - "signature": [ - "(field: HasSubtype) => boolean" - ], - "path": "src/plugins/data/public/index.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.indexPatterns.isMultiField.$1", - "type": "Object", - "tags": [], - "label": "field", - "description": [], - "signature": [ - "{ subType?: ", - "IFieldSubType", - " | undefined; }" - ], - "path": "src/plugins/data_views/common/fields/utils.ts", - "deprecated": false - } - ] + "plugin": "urlDrilldown", + "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/url_drilldown.tsx" }, { - "parentPluginId": "data", - "id": "def-public.indexPatterns.getFieldSubtypeMulti", - "type": "Function", - "tags": [], - "label": "getFieldSubtypeMulti", - "description": [], - "signature": [ - "(field: HasSubtype) => ", - "IFieldSubTypeMulti", - " | undefined" - ], - "path": "src/plugins/data/public/index.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.indexPatterns.getFieldSubtypeMulti.$1", - "type": "Object", - "tags": [], - "label": "field", - "description": [], - "signature": [ - "{ subType?: ", - "IFieldSubType", - " | undefined; }" - ], - "path": "src/plugins/data_views/common/fields/utils.ts", - "deprecated": false - } - ] + "plugin": "urlDrilldown", + "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/url_drilldown.tsx" }, { - "parentPluginId": "data", - "id": "def-public.indexPatterns.getFieldSubtypeNested", - "type": "Function", - "tags": [], - "label": "getFieldSubtypeNested", - "description": [], - "signature": [ - "(field: HasSubtype) => ", - "IFieldSubTypeNested", - " | undefined" - ], - "path": "src/plugins/data/public/index.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.indexPatterns.getFieldSubtypeNested.$1", - "type": "Object", - "tags": [], - "label": "field", - "description": [], - "signature": [ - "{ subType?: ", - "IFieldSubType", - " | undefined; }" - ], - "path": "src/plugins/data_views/common/fields/utils.ts", - "deprecated": false - } - ] + "plugin": "uiActionsEnhanced", + "path": "x-pack/plugins/ui_actions_enhanced/public/test_helpers/time_range_embeddable_factory.ts" }, { - "parentPluginId": "data", - "id": "def-public.indexPatterns.validate", - "type": "Function", - "tags": [], - "label": "validate", - "description": [], - "signature": [ - "(indexPattern: string) => { ILLEGAL_CHARACTERS?: string[] | undefined; CONTAINS_SPACES?: boolean | undefined; }" - ], - "path": "src/plugins/data/public/index.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.indexPatterns.validate.$1", - "type": "string", - "tags": [], - "label": "indexPattern", - "description": [], - "path": "src/plugins/data_views/common/lib/validate_data_view.ts", - "deprecated": false - } - ] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-public.search", - "type": "Object", - "tags": [], - "label": "search", - "description": [], - "path": "src/plugins/data/public/index.ts", - "deprecated": false, - "children": [ + "plugin": "uiActionsEnhanced", + "path": "x-pack/plugins/ui_actions_enhanced/public/test_helpers/time_range_embeddable_factory.ts" + }, { - "parentPluginId": "data", - "id": "def-public.search.aggs", - "type": "Object", - "tags": [], - "label": "aggs", - "description": [], - "path": "src/plugins/data/public/index.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-public.search.aggs.CidrMask", - "type": "Object", - "tags": [], - "label": "CidrMask", - "description": [], - "signature": [ - "typeof ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.CidrMask", - "text": "CidrMask" - } - ], - "path": "src/plugins/data/public/index.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.search.aggs.dateHistogramInterval", - "type": "Function", - "tags": [], - "label": "dateHistogramInterval", - "description": [], - "signature": [ - "(interval: string) => Interval" - ], - "path": "src/plugins/data/public/index.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.search.aggs.dateHistogramInterval.$1", - "type": "string", - "tags": [], - "label": "interval", - "description": [], - "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/date_histogram_interval.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "data", - "id": "def-public.search.aggs.intervalOptions", - "type": "Array", - "tags": [], - "label": "intervalOptions", - "description": [], - "signature": [ - "({ display: string; val: string; enabled(agg: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.IBucketAggConfig", - "text": "IBucketAggConfig" - }, - "): boolean; } | { display: string; val: string; })[]" - ], - "path": "src/plugins/data/public/index.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.search.aggs.InvalidEsCalendarIntervalError", - "type": "Object", - "tags": [], - "label": "InvalidEsCalendarIntervalError", - "description": [], - "signature": [ - "typeof ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.InvalidEsCalendarIntervalError", - "text": "InvalidEsCalendarIntervalError" - } - ], - "path": "src/plugins/data/public/index.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.search.aggs.InvalidEsIntervalFormatError", - "type": "Object", - "tags": [], - "label": "InvalidEsIntervalFormatError", - "description": [], - "signature": [ - "typeof ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.InvalidEsIntervalFormatError", - "text": "InvalidEsIntervalFormatError" - } - ], - "path": "src/plugins/data/public/index.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.search.aggs.IpAddress", - "type": "Object", - "tags": [], - "label": "IpAddress", - "description": [], - "signature": [ - "typeof ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.IpAddress", - "text": "IpAddress" - } - ], - "path": "src/plugins/data/public/index.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.search.aggs.isDateHistogramBucketAggConfig", - "type": "Function", - "tags": [], - "label": "isDateHistogramBucketAggConfig", - "description": [], - "signature": [ - "(agg: any) => agg is ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.IBucketDateHistogramAggConfig", - "text": "IBucketDateHistogramAggConfig" - } - ], - "path": "src/plugins/data/public/index.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.search.aggs.isDateHistogramBucketAggConfig.$1", - "type": "Any", - "tags": [], - "label": "agg", - "description": [], - "signature": [ - "any" - ], - "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "data", - "id": "def-public.search.aggs.isNumberType", - "type": "Function", - "tags": [], - "label": "isNumberType", - "description": [], - "signature": [ - "(agg: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggConfig", - "text": "AggConfig" - }, - ") => boolean" - ], - "path": "src/plugins/data/public/index.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.search.aggs.isNumberType.$1", - "type": "Object", - "tags": [], - "label": "agg", - "description": [], - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggConfig", - "text": "AggConfig" - } - ], - "path": "src/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "data", - "id": "def-public.search.aggs.isStringType", - "type": "Function", - "tags": [], - "label": "isStringType", - "description": [], - "signature": [ - "(agg: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggConfig", - "text": "AggConfig" - }, - ") => boolean" - ], - "path": "src/plugins/data/public/index.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.search.aggs.isStringType.$1", - "type": "Object", - "tags": [], - "label": "agg", - "description": [], - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggConfig", - "text": "AggConfig" - } - ], - "path": "src/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "data", - "id": "def-public.search.aggs.isType", - "type": "Function", - "tags": [], - "label": "isType", - "description": [], - "signature": [ - "(...types: string[]) => (agg: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggConfig", - "text": "AggConfig" - }, - ") => boolean" - ], - "path": "src/plugins/data/public/index.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.search.aggs.isType.$1", - "type": "Array", - "tags": [], - "label": "types", - "description": [], - "signature": [ - "string[]" - ], - "path": "src/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "data", - "id": "def-public.search.aggs.isValidEsInterval", - "type": "Function", - "tags": [], - "label": "isValidEsInterval", - "description": [], - "signature": [ - "(interval: string) => boolean" - ], - "path": "src/plugins/data/public/index.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.search.aggs.isValidEsInterval.$1", - "type": "string", - "tags": [], - "label": "interval", - "description": [], - "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/is_valid_es_interval.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "data", - "id": "def-public.search.aggs.isValidInterval", - "type": "Function", - "tags": [], - "label": "isValidInterval", - "description": [], - "signature": [ - "(value: string, baseInterval?: string | undefined) => boolean" - ], - "path": "src/plugins/data/public/index.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.search.aggs.isValidInterval.$1", - "type": "string", - "tags": [], - "label": "value", - "description": [], - "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/is_valid_interval.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.search.aggs.isValidInterval.$2", - "type": "string", - "tags": [], - "label": "baseInterval", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/is_valid_interval.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "data", - "id": "def-public.search.aggs.parentPipelineType", - "type": "string", - "tags": [], - "label": "parentPipelineType", - "description": [], - "path": "src/plugins/data/public/index.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.search.aggs.parseEsInterval", - "type": "Function", - "tags": [], - "label": "parseEsInterval", - "description": [], - "signature": [ - "(interval: string) => { value: number; unit: ", - "Unit", - "; type: \"calendar\" | \"fixed\"; }" - ], - "path": "src/plugins/data/public/index.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.search.aggs.parseEsInterval.$1", - "type": "string", - "tags": [], - "label": "interval", - "description": [], - "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_es_interval.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "data", - "id": "def-public.search.aggs.parseInterval", - "type": "Function", - "tags": [], - "label": "parseInterval", - "description": [], - "signature": [ - "(interval: string) => moment.Duration | null" - ], - "path": "src/plugins/data/public/index.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.search.aggs.parseInterval.$1", - "type": "string", - "tags": [], - "label": "interval", - "description": [], - "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_interval.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "data", - "id": "def-public.search.aggs.propFilter", - "type": "Function", - "tags": [], - "label": "propFilter", - "description": [], - "signature": [ - "

(prop: P) => (list: T[], filters?: string | string[] | FilterFunc) => T[]" - ], - "path": "src/plugins/data/public/index.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.search.aggs.propFilter.$1", - "type": "Uncategorized", - "tags": [], - "label": "prop", - "description": [], - "signature": [ - "P" - ], - "path": "src/plugins/data/common/search/aggs/utils/prop_filter.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "data", - "id": "def-public.search.aggs.siblingPipelineType", - "type": "string", - "tags": [], - "label": "siblingPipelineType", - "description": [], - "path": "src/plugins/data/public/index.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.search.aggs.termsAggFilter", - "type": "Array", - "tags": [], - "label": "termsAggFilter", - "description": [], - "signature": [ - "string[]" - ], - "path": "src/plugins/data/public/index.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.search.aggs.toAbsoluteDates", - "type": "Function", - "tags": [], - "label": "toAbsoluteDates", - "description": [], - "signature": [ - "(range: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, - ") => { from: Date; to: Date; } | undefined" - ], - "path": "src/plugins/data/public/index.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.search.aggs.toAbsoluteDates.$1", - "type": "Object", - "tags": [], - "label": "range", - "description": [], - "signature": [ - "{ from: string; to: string; mode?: \"absolute\" | \"relative\" | undefined; }" - ], - "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/to_absolute_dates.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "data", - "id": "def-public.search.aggs.boundsDescendingRaw", - "type": "Array", - "tags": [], - "label": "boundsDescendingRaw", - "description": [], - "signature": [ - "({ bound: number; interval: moment.Duration; boundLabel: string; intervalLabel: string; } | { bound: moment.Duration; interval: moment.Duration; boundLabel: string; intervalLabel: string; })[]" - ], - "path": "src/plugins/data/public/index.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.search.aggs.getNumberHistogramIntervalByDatatableColumn", - "type": "Function", - "tags": [], - "label": "getNumberHistogramIntervalByDatatableColumn", - "description": [], - "signature": [ - "(column: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.DatatableColumn", - "text": "DatatableColumn" - }, - ") => number | undefined" - ], - "path": "src/plugins/data/public/index.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.search.aggs.getNumberHistogramIntervalByDatatableColumn.$1", - "type": "Object", - "tags": [], - "label": "column", - "description": [], - "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.DatatableColumn", - "text": "DatatableColumn" - } - ], - "path": "src/plugins/data/common/search/aggs/utils/get_number_histogram_interval.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "data", - "id": "def-public.search.aggs.getDateHistogramMetaDataByDatatableColumn", - "type": "Function", - "tags": [], - "label": "getDateHistogramMetaDataByDatatableColumn", - "description": [], - "signature": [ - "(column: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.DatatableColumn", - "text": "DatatableColumn" - }, - ", defaults?: Partial<{ timeZone: string; }>) => { interval: string | undefined; timeZone: string | undefined; timeRange: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, - " | undefined; } | undefined" - ], - "path": "src/plugins/data/public/index.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.search.aggs.getDateHistogramMetaDataByDatatableColumn.$1", - "type": "Object", - "tags": [], - "label": "column", - "description": [], - "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.DatatableColumn", - "text": "DatatableColumn" - } - ], - "path": "src/plugins/data/common/search/aggs/utils/get_date_histogram_meta.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.search.aggs.getDateHistogramMetaDataByDatatableColumn.$2", - "type": "Object", - "tags": [], - "label": "defaults", - "description": [], - "signature": [ - "{ timeZone?: string | undefined; }" - ], - "path": "src/plugins/data/common/search/aggs/utils/get_date_histogram_meta.ts", - "deprecated": false - } - ] - } - ] - }, - { - "parentPluginId": "data", - "id": "def-public.search.getResponseInspectorStats", - "type": "Function", - "tags": [], - "label": "getResponseInspectorStats", - "description": [], - "signature": [ - "(resp?: ", - "SearchResponse", - "> | undefined, searchSource?: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.ISearchSource", - "text": "ISearchSource" - }, - " | undefined) => ", - { - "pluginId": "inspector", - "scope": "common", - "docId": "kibInspectorPluginApi", - "section": "def-common.RequestStatistics", - "text": "RequestStatistics" - } - ], - "path": "src/plugins/data/public/index.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.search.getResponseInspectorStats.$1", - "type": "Object", - "tags": [], - "label": "resp", - "description": [], - "signature": [ - "SearchResponse", - "> | undefined" - ], - "path": "src/plugins/data/common/search/search_source/inspect/inspector_stats.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.search.getResponseInspectorStats.$2", - "type": "Object", - "tags": [], - "label": "searchSource", - "description": [], - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.ISearchSource", - "text": "ISearchSource" - }, - " | undefined" - ], - "path": "src/plugins/data/common/search/search_source/inspect/inspector_stats.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "data", - "id": "def-public.search.tabifyAggResponse", - "type": "Function", - "tags": [], - "label": "tabifyAggResponse", - "description": [], - "signature": [ - "(aggConfigs: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggConfigs", - "text": "AggConfigs" - }, - ", esResponse: Record, respOpts?: Partial<", - "TabbedResponseWriterOptions", - "> | undefined) => ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.Datatable", - "text": "Datatable" - } - ], - "path": "src/plugins/data/public/index.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.search.tabifyAggResponse.$1", - "type": "Object", - "tags": [], - "label": "aggConfigs", - "description": [], - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggConfigs", - "text": "AggConfigs" - } - ], - "path": "src/plugins/data/common/search/tabify/tabify.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.search.tabifyAggResponse.$2", - "type": "Object", - "tags": [], - "label": "esResponse", - "description": [], - "signature": [ - "{ [x: string]: any; }" - ], - "path": "src/plugins/data/common/search/tabify/tabify.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.search.tabifyAggResponse.$3", - "type": "Object", - "tags": [], - "label": "respOpts", - "description": [], - "signature": [ - "Partial<", - "TabbedResponseWriterOptions", - "> | undefined" - ], - "path": "src/plugins/data/common/search/tabify/tabify.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "data", - "id": "def-public.search.tabifyGetColumns", - "type": "Function", - "tags": [], - "label": "tabifyGetColumns", - "description": [], - "signature": [ - "(aggs: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggConfig", - "text": "AggConfig" - }, - "[], minimalColumns: boolean) => ", - "TabbedAggColumn", - "[]" - ], - "path": "src/plugins/data/public/index.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.search.tabifyGetColumns.$1", - "type": "Array", - "tags": [], - "label": "aggs", - "description": [], - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggConfig", - "text": "AggConfig" - }, - "[]" - ], - "path": "src/plugins/data/common/search/tabify/get_columns.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.search.tabifyGetColumns.$2", - "type": "boolean", - "tags": [], - "label": "minimalColumns", - "description": [], - "path": "src/plugins/data/common/search/tabify/get_columns.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "data", - "id": "def-public.search.checkColumnForPrecisionError", - "type": "Function", - "tags": [], - "label": "checkColumnForPrecisionError", - "description": [], - "signature": [ - "(column: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.DatatableColumn", - "text": "DatatableColumn" - }, - ") => ", - "Serializable" - ], - "path": "src/plugins/data/public/index.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.search.checkColumnForPrecisionError.$1", - "type": "Object", - "tags": [], - "label": "column", - "description": [], - "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.DatatableColumn", - "text": "DatatableColumn" - } - ], - "path": "src/plugins/data/common/search/tabify/utils.ts", - "deprecated": false - } - ] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-public.UI_SETTINGS", - "type": "Object", - "tags": [], - "label": "UI_SETTINGS", - "description": [], - "signature": [ - "{ readonly META_FIELDS: \"metaFields\"; readonly DOC_HIGHLIGHT: \"doc_table:highlight\"; readonly QUERY_STRING_OPTIONS: \"query:queryString:options\"; readonly QUERY_ALLOW_LEADING_WILDCARDS: \"query:allowLeadingWildcards\"; readonly SEARCH_QUERY_LANGUAGE: \"search:queryLanguage\"; readonly SORT_OPTIONS: \"sort:options\"; readonly COURIER_IGNORE_FILTER_IF_FIELD_NOT_IN_INDEX: \"courier:ignoreFilterIfFieldNotInIndex\"; readonly COURIER_SET_REQUEST_PREFERENCE: \"courier:setRequestPreference\"; readonly COURIER_CUSTOM_REQUEST_PREFERENCE: \"courier:customRequestPreference\"; readonly COURIER_MAX_CONCURRENT_SHARD_REQUESTS: \"courier:maxConcurrentShardRequests\"; readonly SEARCH_INCLUDE_FROZEN: \"search:includeFrozen\"; readonly SEARCH_TIMEOUT: \"search:timeout\"; readonly HISTOGRAM_BAR_TARGET: \"histogram:barTarget\"; readonly HISTOGRAM_MAX_BARS: \"histogram:maxBars\"; readonly HISTORY_LIMIT: \"history:limit\"; readonly TIMEPICKER_REFRESH_INTERVAL_DEFAULTS: \"timepicker:refreshIntervalDefaults\"; readonly TIMEPICKER_QUICK_RANGES: \"timepicker:quickRanges\"; readonly TIMEPICKER_TIME_DEFAULTS: \"timepicker:timeDefaults\"; readonly FILTERS_PINNED_BY_DEFAULT: \"filters:pinnedByDefault\"; readonly FILTERS_EDITOR_SUGGEST_VALUES: \"filterEditor:suggestValues\"; readonly AUTOCOMPLETE_USE_TIMERANGE: \"autocomplete:useTimeRange\"; readonly AUTOCOMPLETE_VALUE_SUGGESTION_METHOD: \"autocomplete:valueSuggestionMethod\"; readonly DATE_FORMAT: \"dateFormat\"; readonly DATEFORMAT_TZ: \"dateFormat:tz\"; }" - ], - "path": "src/plugins/data/common/constants.ts", - "deprecated": false, - "initialIsOpen": false - } - ], - "setup": { - "parentPluginId": "data", - "id": "def-public.DataPublicPluginSetup", - "type": "Interface", - "tags": [], - "label": "DataPublicPluginSetup", - "description": [ - "\nData plugin public Setup contract" - ], - "path": "src/plugins/data/public/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-public.DataPublicPluginSetup.search", - "type": "Object", - "tags": [], - "label": "search", - "description": [], - "signature": [ - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataSearchPluginApi", - "section": "def-public.ISearchSetup", - "text": "ISearchSetup" - } - ], - "path": "src/plugins/data/public/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.DataPublicPluginSetup.query", - "type": "Object", - "tags": [], - "label": "query", - "description": [], - "signature": [ - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.QuerySetup", - "text": "QuerySetup" - } - ], - "path": "src/plugins/data/public/types.ts", - "deprecated": false - } - ], - "lifecycle": "setup", - "initialIsOpen": true - }, - "start": { - "parentPluginId": "data", - "id": "def-public.DataPublicPluginStart", - "type": "Interface", - "tags": [], - "label": "DataPublicPluginStart", - "description": [ - "\nData plugin public Start contract" - ], - "path": "src/plugins/data/public/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-public.DataPublicPluginStart.actions", - "type": "Object", - "tags": [], - "label": "actions", - "description": [ - "\nfilter creation utilities\n{@link DataPublicPluginStartActions}" - ], - "signature": [ - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataPluginApi", - "section": "def-public.DataPublicPluginStartActions", - "text": "DataPublicPluginStartActions" - } - ], - "path": "src/plugins/data/public/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.DataPublicPluginStart.dataViews", - "type": "Object", - "tags": [], - "label": "dataViews", - "description": [ - "\ndata views service\n{@link DataViewsContract}" - ], - "signature": [ - "DataViewsServicePublic" - ], - "path": "src/plugins/data/public/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.DataPublicPluginStart.datatableUtilities", - "type": "Object", - "tags": [], - "label": "datatableUtilities", - "description": [ - "\nDatatable type utility functions." - ], - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.DatatableUtilitiesService", - "text": "DatatableUtilitiesService" - } - ], - "path": "src/plugins/data/public/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.DataPublicPluginStart.indexPatterns", - "type": "Object", - "tags": [ - "deprecated" - ], - "label": "indexPatterns", - "description": [ - "\nindex patterns service\n{@link DataViewsContract}" - ], - "signature": [ - "DataViewsServicePublic" - ], - "path": "src/plugins/data/public/types.ts", - "deprecated": true, - "references": [ - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/query_string_input/query_string_input.tsx" - }, - { - "plugin": "discover", - "path": "src/plugins/discover/public/plugin.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/kibana_services.ts" - }, - { - "plugin": "infra", - "path": "x-pack/plugins/infra/public/hooks/use_kibana_index_patterns.ts" - }, - { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/plugin.ts" - }, - { - "plugin": "securitySolution", - "path": "x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/middleware.ts" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/entity_index_expression.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/boundary_index_expression.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/index.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/index.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/index.tsx" - }, - { - "plugin": "inputControlVis", - "path": "src/plugins/input_control_vis/public/control/list_control_factory.ts" - }, - { - "plugin": "inputControlVis", - "path": "src/plugins/input_control_vis/public/control/range_control_factory.ts" - }, - { - "plugin": "inputControlVis", - "path": "src/plugins/input_control_vis/public/components/editor/controls_tab.tsx" - }, - { - "plugin": "securitySolution", - "path": "x-pack/plugins/security_solution/public/common/mock/endpoint/dependencies_start_mock.ts" - }, - { - "plugin": "savedObjects", - "path": "src/plugins/saved_objects/public/saved_object/saved_object.test.ts" - }, - { - "plugin": "savedObjects", - "path": "src/plugins/saved_objects/public/saved_object/saved_object.test.ts" - } - ] - }, - { - "parentPluginId": "data", - "id": "def-public.DataPublicPluginStart.search", - "type": "Object", - "tags": [], - "label": "search", - "description": [ - "\nsearch service\n{@link ISearchStart}" - ], - "signature": [ - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataSearchPluginApi", - "section": "def-public.ISearchStart", - "text": "ISearchStart" - } - ], - "path": "src/plugins/data/public/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.DataPublicPluginStart.fieldFormats", - "type": "CompoundType", - "tags": [ - "deprecated" - ], - "label": "fieldFormats", - "description": [], - "signature": [ - "Omit<", - { - "pluginId": "fieldFormats", - "scope": "common", - "docId": "kibFieldFormatsPluginApi", - "section": "def-common.FieldFormatsRegistry", - "text": "FieldFormatsRegistry" - }, - ", \"init\" | \"register\"> & { deserialize: ", - { - "pluginId": "fieldFormats", - "scope": "common", - "docId": "kibFieldFormatsPluginApi", - "section": "def-common.FormatFactory", - "text": "FormatFactory" - }, - "; }" - ], - "path": "src/plugins/data/public/types.ts", - "deprecated": true, - "references": [ - { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/actions/export_csv_action.tsx" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/ranges/ranges.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/threshold/expression.tsx" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/indexpattern_datasource/dimension_panel/droppable/droppable.test.ts" - }, - { - "plugin": "visTypeTable", - "path": "src/plugins/vis_types/table/public/plugin.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/plugin.ts" - }, - { - "plugin": "visTypeXy", - "path": "src/plugins/vis_types/xy/public/plugin.ts" - }, - { - "plugin": "visTypeVislib", - "path": "src/plugins/vis_types/vislib/public/plugin.ts" - }, - { - "plugin": "expressionPartitionVis", - "path": "src/plugins/chart_expressions/expression_partition_vis/public/utils/layers/get_layers.test.ts" - }, - { - "plugin": "expressionPartitionVis", - "path": "src/plugins/chart_expressions/expression_partition_vis/public/utils/layers/get_layers.test.ts" - }, - { - "plugin": "expressionPartitionVis", - "path": "src/plugins/chart_expressions/expression_partition_vis/public/utils/layers/get_layers.test.ts" - }, - { - "plugin": "expressionPartitionVis", - "path": "src/plugins/chart_expressions/expression_partition_vis/public/utils/layers/get_layers.test.ts" - }, - { - "plugin": "expressionPartitionVis", - "path": "src/plugins/chart_expressions/expression_partition_vis/public/utils/layers/get_layers.test.ts" - }, - { - "plugin": "expressionPartitionVis", - "path": "src/plugins/chart_expressions/expression_partition_vis/public/utils/layers/get_layers.test.ts" - }, - { - "plugin": "expressionPartitionVis", - "path": "src/plugins/chart_expressions/expression_partition_vis/public/utils/layers/get_layers.test.ts" - }, - { - "plugin": "expressionPartitionVis", - "path": "src/plugins/chart_expressions/expression_partition_vis/public/utils/layers/get_layers.test.ts" - } - ] - }, - { - "parentPluginId": "data", - "id": "def-public.DataPublicPluginStart.query", - "type": "Object", - "tags": [], - "label": "query", - "description": [ - "\nquery service\n{@link QueryStart}" - ], - "signature": [ - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.QueryStart", - "text": "QueryStart" - } - ], - "path": "src/plugins/data/public/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.DataPublicPluginStart.nowProvider", - "type": "Object", - "tags": [], - "label": "nowProvider", - "description": [], - "signature": [ - "{ get: () => Date; }" - ], - "path": "src/plugins/data/public/types.ts", - "deprecated": false - } - ], - "lifecycle": "start", - "initialIsOpen": true - } - }, - "server": { - "classes": [ - { - "parentPluginId": "data", - "id": "def-server.DataServerPlugin", - "type": "Class", - "tags": [], - "label": "DataServerPlugin", - "description": [], - "signature": [ + "plugin": "urlDrilldown", + "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/test/data.ts" + }, { - "pluginId": "data", - "scope": "server", - "docId": "kibDataPluginApi", - "section": "def-server.DataServerPlugin", - "text": "DataServerPlugin" + "plugin": "urlDrilldown", + "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/test/data.ts" + }, + { + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/components/agg.tsx" + }, + { + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/components/agg.tsx" + }, + { + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/components/agg_group.tsx" + }, + { + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/components/agg_group.tsx" + }, + { + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/components/sidebar/data_tab.tsx" + }, + { + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/components/sidebar/data_tab.tsx" + }, + { + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/components/sidebar/sidebar.tsx" + }, + { + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/components/sidebar/sidebar.tsx" + }, + { + "plugin": "visTypeTimelion", + "path": "src/plugins/vis_types/timelion/public/timelion_vis_fn.ts" + }, + { + "plugin": "visTypeTimelion", + "path": "src/plugins/vis_types/timelion/public/timelion_vis_fn.ts" + }, + { + "plugin": "visTypeTimelion", + "path": "src/plugins/vis_types/timelion/public/helpers/timelion_request_handler.ts" + }, + { + "plugin": "visTypeTimelion", + "path": "src/plugins/vis_types/timelion/public/helpers/timelion_request_handler.ts" + }, + { + "plugin": "visTypeTimeseries", + "path": "src/plugins/vis_types/timeseries/public/application/components/vis_editor.tsx" + }, + { + "plugin": "visTypeTimeseries", + "path": "src/plugins/vis_types/timeseries/public/application/components/vis_editor.tsx" + }, + { + "plugin": "visTypeVega", + "path": "src/plugins/vis_types/vega/public/vega_fn.ts" + }, + { + "plugin": "visTypeVega", + "path": "src/plugins/vis_types/vega/public/vega_fn.ts" + }, + { + "plugin": "visTypeVega", + "path": "src/plugins/vis_types/vega/public/vega_request_handler.ts" + }, + { + "plugin": "visTypeVega", + "path": "src/plugins/vis_types/vega/public/vega_request_handler.ts" + }, + { + "plugin": "infra", + "path": "x-pack/plugins/infra/public/pages/logs/log_entry_rate/use_log_entry_rate_results_url_state.tsx" + }, + { + "plugin": "visualizations", + "path": "src/plugins/visualizations/common/locator.ts" + }, + { + "plugin": "visualizations", + "path": "src/plugins/visualizations/common/locator.ts" + }, + { + "plugin": "controls", + "path": "src/plugins/controls/common/types.ts" + }, + { + "plugin": "controls", + "path": "src/plugins/controls/common/types.ts" + }, + { + "plugin": "controls", + "path": "src/plugins/controls/common/control_types/options_list/types.ts" + }, + { + "plugin": "controls", + "path": "src/plugins/controls/common/control_types/options_list/types.ts" + }, + { + "plugin": "cases", + "path": "x-pack/plugins/cases/common/utils/markdown_plugins/lens/serializer.ts" + }, + { + "plugin": "cases", + "path": "x-pack/plugins/cases/common/utils/markdown_plugins/lens/serializer.ts" + }, + { + "plugin": "cases", + "path": "x-pack/plugins/cases/common/utils/markdown_plugins/utils.ts" + }, + { + "plugin": "cases", + "path": "x-pack/plugins/cases/common/utils/markdown_plugins/utils.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/common/descriptor_types/data_request_descriptor_types.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/common/descriptor_types/data_request_descriptor_types.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/common/descriptor_types/data_request_descriptor_types.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/sources/es_source/es_source.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/sources/es_source/es_source.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/sources/es_source/es_source.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/legacy_visualizations/region_map/region_map_fn.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/legacy_visualizations/region_map/region_map_fn.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/embeddable/types.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/embeddable/types.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/connected_components/timeslider/timeslider.tsx" }, - " implements ", { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.Plugin", - "text": "Plugin" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/connected_components/timeslider/timeslider.tsx" }, - "<", { - "pluginId": "data", - "scope": "server", - "docId": "kibDataPluginApi", - "section": "def-server.DataPluginSetup", - "text": "DataPluginSetup" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/routes/map_page/map_app/map_app.tsx" }, - ", ", { - "pluginId": "data", - "scope": "server", - "docId": "kibDataPluginApi", - "section": "def-server.DataPluginStart", - "text": "DataPluginStart" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/routes/map_page/map_app/map_app.tsx" }, - ", ", - "DataPluginSetupDependencies", - ", ", - "DataPluginStartDependencies", - ">" - ], - "path": "src/plugins/data/server/plugin.ts", - "deprecated": false, - "children": [ { - "parentPluginId": "data", - "id": "def-server.DataServerPlugin.Unnamed", - "type": "Function", - "tags": [], - "label": "Constructor", - "description": [], - "signature": [ - "any" - ], - "path": "src/plugins/data/server/plugin.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-server.DataServerPlugin.Unnamed.$1", - "type": "Object", - "tags": [], - "label": "initializerContext", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.PluginInitializerContext", - "text": "PluginInitializerContext" - }, - "; }>; sessions: Readonly<{} & { enabled: boolean; pageSize: number; trackingInterval: moment.Duration; cleanupInterval: moment.Duration; expireInterval: moment.Duration; monitoringTaskTimeout: moment.Duration; notTouchedTimeout: moment.Duration; notTouchedInProgressTimeout: moment.Duration; maxUpdateRetries: number; defaultExpiration: moment.Duration; management: Readonly<{} & { refreshInterval: moment.Duration; maxSessions: number; refreshTimeout: moment.Duration; expiresSoonWarning: moment.Duration; }>; }>; }>; }>>" - ], - "path": "src/plugins/data/server/plugin.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] + "plugin": "maps", + "path": "x-pack/plugins/maps/public/routes/map_page/map_app/map_app.tsx" }, { - "parentPluginId": "data", - "id": "def-server.DataServerPlugin.setup", - "type": "Function", - "tags": [], - "label": "setup", - "description": [], - "signature": [ - "(core: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.CoreSetup", - "text": "CoreSetup" - }, - "<", - "DataPluginStartDependencies", - ", ", - { - "pluginId": "data", - "scope": "server", - "docId": "kibDataPluginApi", - "section": "def-server.DataPluginStart", - "text": "DataPluginStart" - }, - ">, { bfetch, expressions, usageCollection, fieldFormats, taskManager, security, }: ", - "DataPluginSetupDependencies", - ") => { search: ", - "ISearchSetup", - "; query: ", - "QuerySetup", - "; fieldFormats: ", - { - "pluginId": "fieldFormats", - "scope": "server", - "docId": "kibFieldFormatsPluginApi", - "section": "def-server.FieldFormatsSetup", - "text": "FieldFormatsSetup" - }, - "; }" - ], - "path": "src/plugins/data/server/plugin.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-server.DataServerPlugin.setup.$1", - "type": "Object", - "tags": [], - "label": "core", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.CoreSetup", - "text": "CoreSetup" - }, - "<", - "DataPluginStartDependencies", - ", ", - { - "pluginId": "data", - "scope": "server", - "docId": "kibDataPluginApi", - "section": "def-server.DataPluginStart", - "text": "DataPluginStart" - }, - ">" - ], - "path": "src/plugins/data/server/plugin.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "data", - "id": "def-server.DataServerPlugin.setup.$2", - "type": "Object", - "tags": [], - "label": "{\n bfetch,\n expressions,\n usageCollection,\n fieldFormats,\n taskManager,\n security,\n }", - "description": [], - "signature": [ - "DataPluginSetupDependencies" - ], - "path": "src/plugins/data/server/plugin.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] + "plugin": "maps", + "path": "x-pack/plugins/maps/public/routes/map_page/map_app/map_app.tsx" }, { - "parentPluginId": "data", - "id": "def-server.DataServerPlugin.start", - "type": "Function", - "tags": [], - "label": "start", - "description": [], - "signature": [ - "(core: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.CoreStart", - "text": "CoreStart" - }, - ", { fieldFormats, dataViews, taskManager }: ", - "DataPluginStartDependencies", - ") => { datatableUtilities: ", - "DatatableUtilitiesService", - "; search: ", - "ISearchStart", - "<", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.IEsSearchRequest", - "text": "IEsSearchRequest" - }, - ", ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.IEsSearchResponse", - "text": "IEsSearchResponse" - }, - ">; fieldFormats: ", - { - "pluginId": "fieldFormats", - "scope": "server", - "docId": "kibFieldFormatsPluginApi", - "section": "def-server.FieldFormatsStart", - "text": "FieldFormatsStart" - }, - "; indexPatterns: ", - { - "pluginId": "dataViews", - "scope": "server", - "docId": "kibDataViewsPluginApi", - "section": "def-server.DataViewsServerPluginStart", - "text": "DataViewsServerPluginStart" - }, - "; }" - ], - "path": "src/plugins/data/server/plugin.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-server.DataServerPlugin.start.$1", - "type": "Object", - "tags": [], - "label": "core", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.CoreStart", - "text": "CoreStart" - } - ], - "path": "src/plugins/data/server/plugin.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "data", - "id": "def-server.DataServerPlugin.start.$2", - "type": "Object", - "tags": [], - "label": "{ fieldFormats, dataViews, taskManager }", - "description": [], - "signature": [ - "DataPluginStartDependencies" - ], - "path": "src/plugins/data/server/plugin.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] + "plugin": "maps", + "path": "x-pack/plugins/maps/public/embeddable/map_component.tsx" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/embeddable/map_component.tsx" }, { - "parentPluginId": "data", - "id": "def-server.DataServerPlugin.stop", - "type": "Function", - "tags": [], - "label": "stop", - "description": [], - "signature": [ - "() => void" - ], - "path": "src/plugins/data/server/plugin.ts", - "deprecated": false, - "children": [], - "returnComment": [] + "plugin": "maps", + "path": "x-pack/plugins/maps/public/legacy_visualizations/region_map/region_map_visualization.tsx" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/legacy_visualizations/region_map/region_map_visualization.tsx" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/legacy_visualizations/tile_map/tile_map_fn.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/legacy_visualizations/tile_map/tile_map_fn.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/legacy_visualizations/tile_map/tile_map_visualization.tsx" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/legacy_visualizations/tile_map/tile_map_visualization.tsx" + }, + { + "plugin": "dataVisualizer", + "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/search_panel/search_panel.tsx" + }, + { + "plugin": "dataVisualizer", + "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/search_panel/search_panel.tsx" + }, + { + "plugin": "dataVisualizer", + "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/locator/locator.ts" + }, + { + "plugin": "dataVisualizer", + "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/locator/locator.ts" + }, + { + "plugin": "ml", + "path": "x-pack/plugins/ml/common/util/date_utils.ts" + }, + { + "plugin": "ml", + "path": "x-pack/plugins/ml/common/util/date_utils.ts" + }, + { + "plugin": "ml", + "path": "x-pack/plugins/ml/common/util/date_utils.ts" + }, + { + "plugin": "ml", + "path": "x-pack/plugins/ml/public/embeddables/types.ts" + }, + { + "plugin": "ml", + "path": "x-pack/plugins/ml/public/embeddables/types.ts" + }, + { + "plugin": "ml", + "path": "x-pack/plugins/ml/public/embeddables/types.ts" + }, + { + "plugin": "canvas", + "path": "x-pack/plugins/canvas/common/lib/build_embeddable_filters.ts" + }, + { + "plugin": "canvas", + "path": "x-pack/plugins/canvas/common/lib/build_embeddable_filters.ts" + }, + { + "plugin": "canvas", + "path": "x-pack/plugins/canvas/common/lib/build_embeddable_filters.ts" + }, + { + "plugin": "canvas", + "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/external/saved_lens.ts" + }, + { + "plugin": "canvas", + "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/external/saved_lens.ts" + }, + { + "plugin": "canvas", + "path": "x-pack/plugins/canvas/public/functions/timelion.ts" + }, + { + "plugin": "canvas", + "path": "x-pack/plugins/canvas/public/functions/timelion.ts" + }, + { + "plugin": "lens", + "path": "x-pack/plugins/lens/common/expressions/time_scale/time_scale.test.ts" + }, + { + "plugin": "lens", + "path": "x-pack/plugins/lens/common/expressions/time_scale/time_scale.test.ts" + }, + { + "plugin": "visTypeVega", + "path": "src/plugins/vis_types/vega/public/data_model/time_cache.ts" + }, + { + "plugin": "visTypeVega", + "path": "src/plugins/vis_types/vega/public/data_model/time_cache.ts" + }, + { + "plugin": "visTypeVega", + "path": "src/plugins/vis_types/vega/public/data_model/time_cache.ts" } ], "initialIsOpen": false - }, + } + ], + "objects": [ { "parentPluginId": "data", - "id": "def-server.DataView", - "type": "Class", + "id": "def-public.AggGroupLabels", + "type": "Object", "tags": [], - "label": "DataView", + "label": "AggGroupLabels", "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - " implements ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IIndexPattern", - "text": "IIndexPattern" - } - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", + "path": "src/plugins/data/common/search/aggs/agg_groups.ts", "deprecated": false, "children": [ { "parentPluginId": "data", - "id": "def-server.DataView.id", + "id": "def-public.AggGroupLabels.AggGroupNames.Buckets", "type": "string", "tags": [], - "label": "id", + "label": "[AggGroupNames.Buckets]", "description": [], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", + "path": "src/plugins/data/common/search/aggs/agg_groups.ts", "deprecated": false }, { "parentPluginId": "data", - "id": "def-server.DataView.title", + "id": "def-public.AggGroupLabels.AggGroupNames.Metrics", "type": "string", "tags": [], - "label": "title", + "label": "[AggGroupNames.Metrics]", "description": [], - "path": "src/plugins/data_views/common/data_views/data_view.ts", + "path": "src/plugins/data/common/search/aggs/agg_groups.ts", "deprecated": false }, { "parentPluginId": "data", - "id": "def-server.DataView.fieldFormatMap", - "type": "Object", + "id": "def-public.AggGroupLabels.AggGroupNames.None", + "type": "string", "tags": [], - "label": "fieldFormatMap", + "label": "[AggGroupNames.None]", "description": [], - "signature": [ - "{ [x: string]: any; }" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", + "path": "src/plugins/data/common/search/aggs/agg_groups.ts", "deprecated": false - }, + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-public.AggGroupNames", + "type": "Object", + "tags": [], + "label": "AggGroupNames", + "description": [], + "signature": [ + "{ readonly Buckets: \"buckets\"; readonly Metrics: \"metrics\"; readonly None: \"none\"; }" + ], + "path": "src/plugins/data/common/search/aggs/agg_groups.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-public.esFilters", + "type": "Object", + "tags": [ + "deprecated" + ], + "label": "esFilters", + "description": [ + "\nFilter helpers namespace:" + ], + "path": "src/plugins/data/public/deprecated.ts", + "deprecated": true, + "removeBy": "8.1", + "references": [], + "children": [ { "parentPluginId": "data", - "id": "def-server.DataView.typeMeta", + "id": "def-public.esFilters.FILTERS", "type": "Object", "tags": [], - "label": "typeMeta", - "description": [ - "\nOnly used by rollup indices, used by rollup specific endpoint to load field list" - ], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.TypeMeta", - "text": "TypeMeta" - }, - " | undefined" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.DataView.fields", - "type": "CompoundType", - "tags": [], - "label": "fields", + "label": "FILTERS", "description": [], "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IIndexPatternFieldList", - "text": "IIndexPatternFieldList" - }, - " & { toSpec: () => ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewFieldMap", - "text": "DataViewFieldMap" - }, - "; }" + "typeof ", + "FILTERS" ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", + "path": "src/plugins/data/public/deprecated.ts", "deprecated": false }, { "parentPluginId": "data", - "id": "def-server.DataView.timeFieldName", - "type": "string", + "id": "def-public.esFilters.FilterStateStore", + "type": "Object", "tags": [], - "label": "timeFieldName", + "label": "FilterStateStore", "description": [], "signature": [ - "string | undefined" + "typeof ", + "FilterStateStore" ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", + "path": "src/plugins/data/public/deprecated.ts", "deprecated": false }, { "parentPluginId": "data", - "id": "def-server.DataView.type", - "type": "string", + "id": "def-public.esFilters.buildEmptyFilter", + "type": "Function", "tags": [], - "label": "type", - "description": [ - "\nType is used to identify rollup index patterns" - ], + "label": "buildEmptyFilter", + "description": [], "signature": [ - "string | undefined" + "(isPinned: boolean, index?: string | undefined) => ", + "Filter" ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false + "path": "src/plugins/data/public/deprecated.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.esFilters.buildEmptyFilter.$1", + "type": "boolean", + "tags": [], + "label": "isPinned", + "description": [], + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.esFilters.buildEmptyFilter.$2", + "type": "string", + "tags": [], + "label": "index", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false + } + ] }, { "parentPluginId": "data", - "id": "def-server.DataView.flattenHit", + "id": "def-public.esFilters.buildPhrasesFilter", "type": "Function", - "tags": [ - "deprecated" - ], - "label": "flattenHit", + "tags": [], + "label": "buildPhrasesFilter", "description": [], "signature": [ - "(hit: Record, deep?: boolean | undefined) => Record" + "(field: ", + "DataViewFieldBase", + ", params: PhraseFilterValue[], indexPattern: ", + "DataViewBase", + ") => ", + "PhrasesFilter" ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": true, - "references": [ + "path": "src/plugins/data/public/deprecated.ts", + "deprecated": false, + "returnComment": [], + "children": [ { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.ts" + "parentPluginId": "data", + "id": "def-public.esFilters.buildPhrasesFilter.$1", + "type": "Object", + "tags": [], + "label": "field", + "description": [], + "signature": [ + "DataViewFieldBase" + ], + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx" + "parentPluginId": "data", + "id": "def-public.esFilters.buildPhrasesFilter.$2", + "type": "Array", + "tags": [], + "label": "params", + "description": [], + "signature": [ + "PhraseFilterValue[]" + ], + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx" + "parentPluginId": "data", + "id": "def-public.esFilters.buildPhrasesFilter.$3", + "type": "Object", + "tags": [], + "label": "indexPattern", + "description": [], + "signature": [ + "DataViewBase" + ], + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false } + ] + }, + { + "parentPluginId": "data", + "id": "def-public.esFilters.buildExistsFilter", + "type": "Function", + "tags": [], + "label": "buildExistsFilter", + "description": [], + "signature": [ + "(field: ", + "DataViewFieldBase", + ", indexPattern: ", + "DataViewBase", + ") => ", + "ExistsFilter" ], + "path": "src/plugins/data/public/deprecated.ts", + "deprecated": false, "returnComment": [], "children": [ { "parentPluginId": "data", - "id": "def-server.DataView.flattenHit.$1", + "id": "def-public.esFilters.buildExistsFilter.$1", "type": "Object", "tags": [], - "label": "hit", + "label": "field", "description": [], "signature": [ - "{ [x: string]: any; }" + "DataViewFieldBase" ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", + "path": "node_modules/@types/kbn__es-query/index.d.ts", "deprecated": false }, { "parentPluginId": "data", - "id": "def-server.DataView.flattenHit.$2", - "type": "CompoundType", + "id": "def-public.esFilters.buildExistsFilter.$2", + "type": "Object", "tags": [], - "label": "deep", + "label": "indexPattern", "description": [], "signature": [ - "boolean | undefined" + "DataViewBase" ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", + "path": "node_modules/@types/kbn__es-query/index.d.ts", "deprecated": false } ] }, { "parentPluginId": "data", - "id": "def-server.DataView.metaFields", - "type": "Array", + "id": "def-public.esFilters.buildPhraseFilter", + "type": "Function", "tags": [], - "label": "metaFields", + "label": "buildPhraseFilter", "description": [], "signature": [ - "string[]" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.DataView.version", - "type": "string", - "tags": [], - "label": "version", - "description": [ - "\nSavedObject version" - ], - "signature": [ - "string | undefined" + "(field: ", + "DataViewFieldBase", + ", value: PhraseFilterValue, indexPattern: ", + "DataViewBase", + ") => ", + "PhraseFilter", + " | ", + "ScriptedPhraseFilter" ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.DataView.sourceFilters", - "type": "Array", - "tags": [], - "label": "sourceFilters", - "description": [], - "signature": [ + "path": "src/plugins/data/public/deprecated.ts", + "deprecated": false, + "returnComment": [], + "children": [ { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.SourceFilter", - "text": "SourceFilter" + "parentPluginId": "data", + "id": "def-public.esFilters.buildPhraseFilter.$1", + "type": "Object", + "tags": [], + "label": "field", + "description": [], + "signature": [ + "DataViewFieldBase" + ], + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false }, - "[] | undefined" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false + { + "parentPluginId": "data", + "id": "def-public.esFilters.buildPhraseFilter.$2", + "type": "CompoundType", + "tags": [], + "label": "value", + "description": [], + "signature": [ + "string | number | boolean" + ], + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.esFilters.buildPhraseFilter.$3", + "type": "Object", + "tags": [], + "label": "indexPattern", + "description": [], + "signature": [ + "DataViewBase" + ], + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false + } + ] }, { "parentPluginId": "data", - "id": "def-server.DataView.namespaces", - "type": "Array", + "id": "def-public.esFilters.buildQueryFilter", + "type": "Function", "tags": [], - "label": "namespaces", + "label": "buildQueryFilter", "description": [], "signature": [ - "string[]" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.DataView.allowNoIndex", - "type": "boolean", - "tags": [], - "label": "allowNoIndex", - "description": [ - "\nprevents errors when index pattern exists before indices" + "(query: (Record & { query_string?: { query: string; fields?: string[] | undefined; } | undefined; }) | undefined, index: string, alias?: string | undefined, meta?: ", + "FilterMeta", + " | undefined) => { query: (Record & { query_string?: { query: string; fields?: string[] | undefined; } | undefined; }) | undefined; meta: { alias: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index: string; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; }; }" ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false + "path": "src/plugins/data/public/deprecated.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.esFilters.buildQueryFilter.$1", + "type": "CompoundType", + "tags": [], + "label": "query", + "description": [], + "signature": [ + "(Record & { query_string?: { query: string; fields?: string[] | undefined; } | undefined; }) | undefined" + ], + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.esFilters.buildQueryFilter.$2", + "type": "string", + "tags": [], + "label": "index", + "description": [], + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.esFilters.buildQueryFilter.$3", + "type": "string", + "tags": [], + "label": "alias", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.esFilters.buildQueryFilter.$4", + "type": "Object", + "tags": [], + "label": "meta", + "description": [], + "signature": [ + "FilterMeta", + " | undefined" + ], + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false + } + ] }, { "parentPluginId": "data", - "id": "def-server.DataView.Unnamed", + "id": "def-public.esFilters.buildRangeFilter", "type": "Function", "tags": [], - "label": "Constructor", + "label": "buildRangeFilter", "description": [], "signature": [ - "any" + "(field: ", + "DataViewFieldBase", + ", params: ", + "RangeFilterParams", + ", indexPattern?: ", + "DataViewBase", + " | undefined, formattedValue?: string | undefined) => ", + "RangeFilter", + " | ", + "ScriptedRangeFilter", + " | MatchAllRangeFilter" ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", + "path": "src/plugins/data/public/deprecated.ts", "deprecated": false, + "returnComment": [], "children": [ { "parentPluginId": "data", - "id": "def-server.DataView.Unnamed.$1", + "id": "def-public.esFilters.buildRangeFilter.$1", "type": "Object", "tags": [], - "label": "{ spec = {}, fieldFormats, shortDotsEnable = false, metaFields = [] }", + "label": "field", "description": [], "signature": [ - "DataViewDeps" + "DataViewFieldBase" ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-server.DataView.getOriginalSavedObjectBody", - "type": "Function", - "tags": [], - "label": "getOriginalSavedObjectBody", - "description": [ - "\nGet last saved saved object fields" - ], - "signature": [ - "() => { fieldAttrs?: string | undefined; title?: string | undefined; timeFieldName?: string | undefined; fields?: string | undefined; sourceFilters?: string | undefined; fieldFormatMap?: string | undefined; typeMeta?: string | undefined; type?: string | undefined; }" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-server.DataView.resetOriginalSavedObjectBody", - "type": "Function", - "tags": [], - "label": "resetOriginalSavedObjectBody", - "description": [ - "\nReset last saved saved object fields. used after saving" - ], - "signature": [ - "() => void" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-server.DataView.getFieldAttrs", - "type": "Function", - "tags": [], - "label": "getFieldAttrs", - "description": [], - "signature": [ - "() => { [x: string]: ", + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false + }, { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldAttrSet", - "text": "FieldAttrSet" + "parentPluginId": "data", + "id": "def-public.esFilters.buildRangeFilter.$2", + "type": "Object", + "tags": [], + "label": "params", + "description": [], + "signature": [ + "RangeFilterParams" + ], + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false }, - "; }" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [], - "returnComment": [] + { + "parentPluginId": "data", + "id": "def-public.esFilters.buildRangeFilter.$3", + "type": "Object", + "tags": [], + "label": "indexPattern", + "description": [], + "signature": [ + "DataViewBase", + " | undefined" + ], + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.esFilters.buildRangeFilter.$4", + "type": "string", + "tags": [], + "label": "formattedValue", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false + } + ] }, { "parentPluginId": "data", - "id": "def-server.DataView.getComputedFields", + "id": "def-public.esFilters.isPhraseFilter", "type": "Function", "tags": [], - "label": "getComputedFields", + "label": "isPhraseFilter", "description": [], "signature": [ - "() => { storedFields: string[]; scriptFields: Record; docvalueFields: { field: string; format: string; }[]; runtimeFields: ", - "MappingRuntimeFields", - "; }" + "(filter: ", + "Filter", + ") => filter is ", + "PhraseFilter" ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", + "path": "src/plugins/data/public/deprecated.ts", "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-server.DataView.toSpec", - "type": "Function", - "tags": [], - "label": "toSpec", - "description": [ - "\nCreate static representation of index pattern" - ], - "signature": [ - "() => ", + "returnComment": [], + "children": [ { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" + "parentPluginId": "data", + "id": "def-public.esFilters.isPhraseFilter.$1", + "type": "Object", + "tags": [], + "label": "filter", + "description": [], + "signature": [ + "{ $state?: { store: ", + "FilterStateStore", + "; } | undefined; meta: ", + "FilterMeta", + "; query?: Record | undefined; }" + ], + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false } - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [], - "returnComment": [] + ] }, { "parentPluginId": "data", - "id": "def-server.DataView.getSourceFiltering", + "id": "def-public.esFilters.isExistsFilter", "type": "Function", "tags": [], - "label": "getSourceFiltering", - "description": [ - "\nGet the source filtering configuration for that index." - ], + "label": "isExistsFilter", + "description": [], "signature": [ - "() => { excludes: string[]; }" + "(filter: ", + "Filter", + ") => filter is ", + "ExistsFilter" ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", + "path": "src/plugins/data/public/deprecated.ts", "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-server.DataView.removeScriptedField", - "type": "Function", - "tags": [ - "deprecated" - ], - "label": "removeScriptedField", - "description": [ - "\nRemove scripted field from field list" - ], - "signature": [ - "(fieldName: string) => void" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": true, - "references": [ - { - "plugin": "dataViewManagement", - "path": "src/plugins/data_view_management/public/components/edit_index_pattern/scripted_fields_table/scripted_fields_table.tsx" - }, - { - "plugin": "dataViewManagement", - "path": "src/plugins/data_view_management/public/components/field_editor/field_editor.tsx" - }, + "returnComment": [], + "children": [ { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.test.ts" + "parentPluginId": "data", + "id": "def-public.esFilters.isExistsFilter.$1", + "type": "Object", + "tags": [], + "label": "filter", + "description": [], + "signature": [ + "{ $state?: { store: ", + "FilterStateStore", + "; } | undefined; meta: ", + "FilterMeta", + "; query?: Record | undefined; }" + ], + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false } + ] + }, + { + "parentPluginId": "data", + "id": "def-public.esFilters.isPhrasesFilter", + "type": "Function", + "tags": [], + "label": "isPhrasesFilter", + "description": [], + "signature": [ + "(filter: ", + "Filter", + ") => filter is ", + "PhrasesFilter" ], + "path": "src/plugins/data/public/deprecated.ts", + "deprecated": false, + "returnComment": [], "children": [ { "parentPluginId": "data", - "id": "def-server.DataView.removeScriptedField.$1", - "type": "string", + "id": "def-public.esFilters.isPhrasesFilter.$1", + "type": "Object", "tags": [], - "label": "fieldName", + "label": "filter", "description": [], "signature": [ - "string" + "{ $state?: { store: ", + "FilterStateStore", + "; } | undefined; meta: ", + "FilterMeta", + "; query?: Record | undefined; }" ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false } - ], - "returnComment": [] + ] }, { "parentPluginId": "data", - "id": "def-server.DataView.getNonScriptedFields", + "id": "def-public.esFilters.isRangeFilter", "type": "Function", - "tags": [ - "deprecated" - ], - "label": "getNonScriptedFields", - "description": [ - "\n" - ], + "tags": [], + "label": "isRangeFilter", + "description": [], "signature": [ - "() => ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" - }, - "[]" + "(filter?: ", + "Filter", + " | undefined) => filter is ", + "RangeFilter" ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": true, - "references": [ - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/abstract_search_strategy.ts" - }, - { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/services/persistence/deserialize.ts" - }, - { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/state_management/datasource.test.ts" - }, - { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/services/persistence/deserialize.test.ts" - }, - { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/services/persistence/deserialize.test.ts" - }, - { - "plugin": "dataViewManagement", - "path": "src/plugins/data_view_management/public/components/edit_index_pattern/source_filters_table/components/table/table.tsx" - }, - { - "plugin": "dataViewManagement", - "path": "src/plugins/data_view_management/public/components/edit_index_pattern/edit_index_pattern.tsx" - }, - { - "plugin": "dataViewManagement", - "path": "src/plugins/data_view_management/public/components/edit_index_pattern/edit_index_pattern.tsx" - }, - { - "plugin": "dataViewManagement", - "path": "src/plugins/data_view_management/public/components/edit_index_pattern/edit_index_pattern.tsx" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.test.ts" - }, + "path": "src/plugins/data/public/deprecated.ts", + "deprecated": false, + "returnComment": [], + "children": [ { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/lib/fetch_fields.ts" + "parentPluginId": "data", + "id": "def-public.esFilters.isRangeFilter.$1", + "type": "Object", + "tags": [], + "label": "filter", + "description": [], + "signature": [ + "Filter", + " | undefined" + ], + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false } - ], - "children": [], - "returnComment": [] + ] }, { "parentPluginId": "data", - "id": "def-server.DataView.getScriptedFields", + "id": "def-public.esFilters.isMatchAllFilter", "type": "Function", - "tags": [ - "deprecated" - ], - "label": "getScriptedFields", - "description": [ - "\n" - ], + "tags": [], + "label": "isMatchAllFilter", + "description": [], "signature": [ - "() => ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" - }, - "[]" + "(filter: ", + "Filter", + ") => filter is ", + "MatchAllFilter" ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": true, - "references": [ - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_views.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/server/register_index_pattern_usage_collection.ts" - }, - { - "plugin": "dataViewManagement", - "path": "src/plugins/data_view_management/public/components/edit_index_pattern/scripted_fields_table/scripted_fields_table.tsx" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.test.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.test.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.test.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.test.ts" - }, + "path": "src/plugins/data/public/deprecated.ts", + "deprecated": false, + "returnComment": [], + "children": [ { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.test.ts" + "parentPluginId": "data", + "id": "def-public.esFilters.isMatchAllFilter.$1", + "type": "Object", + "tags": [], + "label": "filter", + "description": [], + "signature": [ + "{ $state?: { store: ", + "FilterStateStore", + "; } | undefined; meta: ", + "FilterMeta", + "; query?: Record | undefined; }" + ], + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false } - ], - "children": [], - "returnComment": [] + ] }, { "parentPluginId": "data", - "id": "def-server.DataView.isTimeBased", + "id": "def-public.esFilters.isQueryStringFilter", "type": "Function", "tags": [], - "label": "isTimeBased", + "label": "isQueryStringFilter", "description": [], "signature": [ - "() => this is ", + "(filter: ", + "Filter", + ") => filter is ", + "QueryStringFilter" + ], + "path": "src/plugins/data/public/deprecated.ts", + "deprecated": false, + "returnComment": [], + "children": [ { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.TimeBasedDataView", - "text": "TimeBasedDataView" + "parentPluginId": "data", + "id": "def-public.esFilters.isQueryStringFilter.$1", + "type": "Object", + "tags": [], + "label": "filter", + "description": [], + "signature": [ + "{ $state?: { store: ", + "FilterStateStore", + "; } | undefined; meta: ", + "FilterMeta", + "; query?: Record | undefined; }" + ], + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false } - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [], - "returnComment": [] + ] }, { "parentPluginId": "data", - "id": "def-server.DataView.isTimeNanosBased", + "id": "def-public.esFilters.isFilterPinned", "type": "Function", "tags": [], - "label": "isTimeNanosBased", + "label": "isFilterPinned", "description": [], "signature": [ - "() => this is ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.TimeBasedDataView", - "text": "TimeBasedDataView" - } + "(filter: ", + "Filter", + ") => boolean | undefined" ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", + "path": "src/plugins/data/public/deprecated.ts", "deprecated": false, - "children": [], - "returnComment": [] + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.esFilters.isFilterPinned.$1", + "type": "Object", + "tags": [], + "label": "filter", + "description": [], + "signature": [ + "{ $state?: { store: ", + "FilterStateStore", + "; } | undefined; meta: ", + "FilterMeta", + "; query?: Record | undefined; }" + ], + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false + } + ] }, { "parentPluginId": "data", - "id": "def-server.DataView.getTimeField", + "id": "def-public.esFilters.toggleFilterNegated", "type": "Function", "tags": [], - "label": "getTimeField", + "label": "toggleFilterNegated", "description": [], "signature": [ - "() => ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" - }, - " | undefined" + "(filter: ", + "Filter", + ") => { meta: { negate: boolean; alias?: string | null | undefined; disabled?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; }; $state?: { store: ", + "FilterStateStore", + "; } | undefined; query?: Record | undefined; }" ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", + "path": "src/plugins/data/public/deprecated.ts", "deprecated": false, - "children": [], - "returnComment": [] + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.esFilters.toggleFilterNegated.$1", + "type": "Object", + "tags": [], + "label": "filter", + "description": [], + "signature": [ + "{ $state?: { store: ", + "FilterStateStore", + "; } | undefined; meta: ", + "FilterMeta", + "; query?: Record | undefined; }" + ], + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false + } + ] }, { "parentPluginId": "data", - "id": "def-server.DataView.getFieldByName", + "id": "def-public.esFilters.disableFilter", "type": "Function", "tags": [], - "label": "getFieldByName", + "label": "disableFilter", "description": [], "signature": [ - "(name: string) => ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" - }, - " | undefined" + "(filter: ", + "Filter", + ") => ", + "Filter" ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", + "path": "src/plugins/data/public/deprecated.ts", "deprecated": false, + "returnComment": [], "children": [ { "parentPluginId": "data", - "id": "def-server.DataView.getFieldByName.$1", - "type": "string", + "id": "def-public.esFilters.disableFilter.$1", + "type": "Object", "tags": [], - "label": "name", + "label": "filter", "description": [], "signature": [ - "string" + "{ $state?: { store: ", + "FilterStateStore", + "; } | undefined; meta: ", + "FilterMeta", + "; query?: Record | undefined; }" ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false } - ], - "returnComment": [] + ] }, { "parentPluginId": "data", - "id": "def-server.DataView.getAggregationRestrictions", + "id": "def-public.esFilters.getPhraseFilterField", "type": "Function", "tags": [], - "label": "getAggregationRestrictions", + "label": "getPhraseFilterField", "description": [], "signature": [ - "() => Record | undefined" + "(filter: ", + "PhraseFilter", + ") => string" ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", + "path": "src/plugins/data/public/deprecated.ts", "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-server.DataView.getAsSavedObjectBody", - "type": "Function", - "tags": [], - "label": "getAsSavedObjectBody", - "description": [ - "\nReturns index pattern as saved object body for saving" - ], - "signature": [ - "() => ", + "returnComment": [], + "children": [ { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewAttributes", - "text": "DataViewAttributes" + "parentPluginId": "data", + "id": "def-public.esFilters.getPhraseFilterField.$1", + "type": "CompoundType", + "tags": [], + "label": "filter", + "description": [], + "signature": [ + "Filter", + " & { meta: PhraseFilterMeta; query: { match_phrase?: Partial> | undefined; match?: Partial> | undefined; }; }" + ], + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false } - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [], - "returnComment": [] + ] }, { "parentPluginId": "data", - "id": "def-server.DataView.getFormatterForField", + "id": "def-public.esFilters.getPhraseFilterValue", "type": "Function", "tags": [], - "label": "getFormatterForField", - "description": [ - "\nProvide a field, get its formatter" - ], + "label": "getPhraseFilterValue", + "description": [], "signature": [ - "(field: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" - }, - " | ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, + "(filter: ", + "PhraseFilter", " | ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" - }, - ") => ", - { - "pluginId": "fieldFormats", - "scope": "common", - "docId": "kibFieldFormatsPluginApi", - "section": "def-common.FieldFormat", - "text": "FieldFormat" - } + "ScriptedPhraseFilter", + ") => PhraseFilterValue" ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", + "path": "src/plugins/data/public/deprecated.ts", "deprecated": false, + "returnComment": [], "children": [ { "parentPluginId": "data", - "id": "def-server.DataView.getFormatterForField.$1", + "id": "def-public.esFilters.getPhraseFilterValue.$1", "type": "CompoundType", - "tags": [], - "label": "field", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" - }, - " | ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, + "tags": [], + "label": "filter", + "description": [], + "signature": [ + "PhraseFilter", " | ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" - } + "ScriptedPhraseFilter" ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false } - ], - "returnComment": [] + ] }, { "parentPluginId": "data", - "id": "def-server.DataView.addRuntimeField", + "id": "def-public.esFilters.getDisplayValueFromFilter", "type": "Function", "tags": [], - "label": "addRuntimeField", - "description": [ - "\nAdd a runtime field - Appended to existing mapped field or a new field is\ncreated as appropriate." - ], + "label": "getDisplayValueFromFilter", + "description": [], "signature": [ - "(name: string, runtimeField: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.RuntimeField", - "text": "RuntimeField" - }, - ") => ", + "(filter: ", + "Filter", + ", indexPatterns: ", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" + "section": "def-common.DataView", + "text": "DataView" }, - "[]" + "[]) => string" ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", + "path": "src/plugins/data/public/deprecated.ts", "deprecated": false, + "returnComment": [], "children": [ { "parentPluginId": "data", - "id": "def-server.DataView.addRuntimeField.$1", - "type": "string", + "id": "def-public.esFilters.getDisplayValueFromFilter.$1", + "type": "Object", "tags": [], - "label": "name", - "description": [ - "Field name" - ], + "label": "filter", + "description": [], "signature": [ - "string" + "{ $state?: { store: ", + "FilterStateStore", + "; } | undefined; meta: ", + "FilterMeta", + "; query?: Record | undefined; }" ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true + "path": "src/plugins/data/public/query/filter_manager/lib/get_display_value.ts", + "deprecated": false }, { "parentPluginId": "data", - "id": "def-server.DataView.addRuntimeField.$2", - "type": "Object", + "id": "def-public.esFilters.getDisplayValueFromFilter.$2", + "type": "Array", "tags": [], - "label": "runtimeField", - "description": [ - "Runtime field definition" - ], + "label": "indexPatterns", + "description": [], "signature": [ { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.RuntimeField", - "text": "RuntimeField" - } + "section": "def-common.DataView", + "text": "DataView" + }, + "[]" ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true + "path": "src/plugins/data/public/query/filter_manager/lib/get_display_value.ts", + "deprecated": false } - ], - "returnComment": [] + ] }, { "parentPluginId": "data", - "id": "def-server.DataView.hasRuntimeField", + "id": "def-public.esFilters.compareFilters", "type": "Function", "tags": [], - "label": "hasRuntimeField", - "description": [ - "\nChecks if runtime field exists" - ], + "label": "compareFilters", + "description": [], "signature": [ - "(name: string) => boolean" + "(first: ", + "Filter", + " | ", + "Filter", + "[], second: ", + "Filter", + " | ", + "Filter", + "[], comparatorOptions?: ", + "FilterCompareOptions", + " | undefined) => boolean" ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", + "path": "src/plugins/data/public/deprecated.ts", "deprecated": false, + "returnComment": [], "children": [ { "parentPluginId": "data", - "id": "def-server.DataView.hasRuntimeField.$1", - "type": "string", + "id": "def-public.esFilters.compareFilters.$1", + "type": "CompoundType", "tags": [], - "label": "name", + "label": "first", "description": [], "signature": [ - "string" + "Filter", + " | ", + "Filter", + "[]" ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.esFilters.compareFilters.$2", + "type": "CompoundType", + "tags": [], + "label": "second", + "description": [], + "signature": [ + "Filter", + " | ", + "Filter", + "[]" + ], + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.esFilters.compareFilters.$3", + "type": "Object", + "tags": [], + "label": "comparatorOptions", + "description": [], + "signature": [ + "FilterCompareOptions", + " | undefined" + ], + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false } + ] + }, + { + "parentPluginId": "data", + "id": "def-public.esFilters.COMPARE_ALL_OPTIONS", + "type": "Object", + "tags": [], + "label": "COMPARE_ALL_OPTIONS", + "description": [], + "signature": [ + "FilterCompareOptions" ], - "returnComment": [] + "path": "src/plugins/data/public/deprecated.ts", + "deprecated": false }, { "parentPluginId": "data", - "id": "def-server.DataView.getRuntimeField", + "id": "def-public.esFilters.generateFilters", "type": "Function", "tags": [], - "label": "getRuntimeField", - "description": [ - "\nReturns runtime field if exists" - ], + "label": "generateFilters", + "description": [], "signature": [ - "(name: string) => ", + "(filterManager: ", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.RuntimeField", - "text": "RuntimeField" + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.FilterManager", + "text": "FilterManager" + }, + ", field: string | ", + "DataViewFieldBase", + ", values: any, operation: string, index: string) => ", + "Filter", + "[]" + ], + "path": "src/plugins/data/public/deprecated.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.esFilters.generateFilters.$1", + "type": "Object", + "tags": [], + "label": "filterManager", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.FilterManager", + "text": "FilterManager" + } + ], + "path": "src/plugins/data/public/query/filter_manager/lib/generate_filters.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.esFilters.generateFilters.$2", + "type": "CompoundType", + "tags": [], + "label": "field", + "description": [], + "signature": [ + "string | ", + "DataViewFieldBase" + ], + "path": "src/plugins/data/public/query/filter_manager/lib/generate_filters.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.esFilters.generateFilters.$3", + "type": "Any", + "tags": [], + "label": "values", + "description": [], + "signature": [ + "any" + ], + "path": "src/plugins/data/public/query/filter_manager/lib/generate_filters.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.esFilters.generateFilters.$4", + "type": "string", + "tags": [], + "label": "operation", + "description": [], + "path": "src/plugins/data/public/query/filter_manager/lib/generate_filters.ts", + "deprecated": false }, - " | null" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [ { "parentPluginId": "data", - "id": "def-server.DataView.getRuntimeField.$1", + "id": "def-public.esFilters.generateFilters.$5", "type": "string", "tags": [], - "label": "name", + "label": "index", "description": [], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true + "path": "src/plugins/data/public/query/filter_manager/lib/generate_filters.ts", + "deprecated": false } - ], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-server.DataView.getAllRuntimeFields", - "type": "Function", - "tags": [], - "label": "getAllRuntimeFields", - "description": [], - "signature": [ - "() => Record" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [], - "returnComment": [] + ] }, { "parentPluginId": "data", - "id": "def-server.DataView.getFieldsByRuntimeFieldName", + "id": "def-public.esFilters.onlyDisabledFiltersChanged", "type": "Function", "tags": [], - "label": "getFieldsByRuntimeFieldName", + "label": "onlyDisabledFiltersChanged", "description": [], "signature": [ - "(name: string) => Record | undefined" + "(newFilters?: ", + "Filter", + "[] | undefined, oldFilters?: ", + "Filter", + "[] | undefined) => boolean" ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", + "path": "src/plugins/data/public/deprecated.ts", "deprecated": false, + "returnComment": [], "children": [ { "parentPluginId": "data", - "id": "def-server.DataView.getFieldsByRuntimeFieldName.$1", - "type": "string", + "id": "def-public.esFilters.onlyDisabledFiltersChanged.$1", + "type": "Array", "tags": [], - "label": "name", + "label": "newFilters", "description": [], "signature": [ - "string" + "Filter", + "[] | undefined" ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-server.DataView.replaceAllRuntimeFields", - "type": "Function", - "tags": [], - "label": "replaceAllRuntimeFields", - "description": [ - "\nReplaces all existing runtime fields with new fields" - ], - "signature": [ - "(newFields: Record) => void" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [ { "parentPluginId": "data", - "id": "def-server.DataView.replaceAllRuntimeFields.$1", - "type": "Object", + "id": "def-public.esFilters.onlyDisabledFiltersChanged.$2", + "type": "Array", "tags": [], - "label": "newFields", + "label": "oldFilters", "description": [], "signature": [ - "Record" + "Filter", + "[] | undefined" ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false } - ], - "returnComment": [] + ] }, { "parentPluginId": "data", - "id": "def-server.DataView.removeRuntimeField", + "id": "def-public.esFilters.mapAndFlattenFilters", "type": "Function", "tags": [], - "label": "removeRuntimeField", - "description": [ - "\nRemove a runtime field - removed from mapped field or removed unmapped\nfield as appropriate. Doesn't clear associated field attributes." - ], + "label": "mapAndFlattenFilters", + "description": [], "signature": [ - "(name: string) => void" + "(filters: ", + "Filter", + "[]) => ", + "Filter", + "[]" ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", + "path": "src/plugins/data/public/deprecated.ts", "deprecated": false, + "returnComment": [], "children": [ { "parentPluginId": "data", - "id": "def-server.DataView.removeRuntimeField.$1", - "type": "string", + "id": "def-public.esFilters.mapAndFlattenFilters.$1", + "type": "Array", "tags": [], - "label": "name", - "description": [ - "- Field name to remove" - ], + "label": "filters", + "description": [], "signature": [ - "string" + "Filter", + "[]" ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true + "path": "src/plugins/data/public/query/filter_manager/lib/map_and_flatten_filters.ts", + "deprecated": false } - ], - "returnComment": [] + ] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-public.esKuery", + "type": "Object", + "tags": [ + "deprecated" + ], + "label": "esKuery", + "description": [], + "path": "src/plugins/data/public/deprecated.ts", + "deprecated": true, + "removeBy": "8.1", + "references": [ + { + "plugin": "apm", + "path": "x-pack/plugins/apm/public/components/shared/kuery_bar/index.tsx" + }, + { + "plugin": "apm", + "path": "x-pack/plugins/apm/public/components/shared/kuery_bar/index.tsx" }, + { + "plugin": "apm", + "path": "x-pack/plugins/apm/public/components/shared/kuery_bar/index.tsx" + } + ], + "children": [ { "parentPluginId": "data", - "id": "def-server.DataView.getRuntimeMappings", - "type": "Function", + "id": "def-public.esKuery.nodeTypes", + "type": "Object", "tags": [], - "label": "getRuntimeMappings", - "description": [ - "\nReturn the \"runtime_mappings\" section of the ES search query" - ], + "label": "nodeTypes", + "description": [], "signature": [ - "() => ", - "MappingRuntimeFields" + "NodeTypes" ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [], - "returnComment": [] + "path": "src/plugins/data/public/deprecated.ts", + "deprecated": false }, { "parentPluginId": "data", - "id": "def-server.DataView.getFormatterForFieldNoDefault", + "id": "def-public.esKuery.fromKueryExpression", "type": "Function", "tags": [], - "label": "getFormatterForFieldNoDefault", - "description": [ - "\nGet formatter for a given field name. Return undefined if none exists" - ], + "label": "fromKueryExpression", + "description": [], "signature": [ - "(fieldname: string) => ", + "(expression: string | ", + "QueryDslQueryContainer", + ", parseOptions?: Partial<", + "KueryParseOptions", + "> | undefined) => ", + "KueryNode" + ], + "path": "src/plugins/data/public/deprecated.ts", + "deprecated": false, + "returnComment": [], + "children": [ { - "pluginId": "fieldFormats", - "scope": "common", - "docId": "kibFieldFormatsPluginApi", - "section": "def-common.FieldFormat", - "text": "FieldFormat" + "parentPluginId": "data", + "id": "def-public.esKuery.fromKueryExpression.$1", + "type": "CompoundType", + "tags": [], + "label": "expression", + "description": [], + "signature": [ + "string | ", + "QueryDslQueryContainer" + ], + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false }, - " | undefined" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [ { "parentPluginId": "data", - "id": "def-server.DataView.getFormatterForFieldNoDefault.$1", - "type": "string", + "id": "def-public.esKuery.fromKueryExpression.$2", + "type": "Object", "tags": [], - "label": "fieldname", + "label": "parseOptions", "description": [], "signature": [ - "string" + "Partial<", + "KueryParseOptions", + "> | undefined" ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false } - ], - "returnComment": [] + ] }, { "parentPluginId": "data", - "id": "def-server.DataView.setFieldAttrs", + "id": "def-public.esKuery.toElasticsearchQuery", "type": "Function", "tags": [], - "label": "setFieldAttrs", + "label": "toElasticsearchQuery", "description": [], "signature": [ - "(fieldName: string, attrName: K, value: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldAttrSet", - "text": "FieldAttrSet" - }, - "[K]) => void" + "(node: ", + "KueryNode", + ", indexPattern?: ", + "DataViewBase", + " | undefined, config?: ", + "KueryQueryOptions", + " | undefined, context?: Record | undefined) => ", + "QueryDslQueryContainer" ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", + "path": "src/plugins/data/public/deprecated.ts", "deprecated": false, + "returnComment": [], "children": [ { "parentPluginId": "data", - "id": "def-server.DataView.setFieldAttrs.$1", - "type": "string", + "id": "def-public.esKuery.toElasticsearchQuery.$1", + "type": "Object", "tags": [], - "label": "fieldName", + "label": "node", "description": [], "signature": [ - "string" + "KueryNode" ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false }, { "parentPluginId": "data", - "id": "def-server.DataView.setFieldAttrs.$2", - "type": "Uncategorized", + "id": "def-public.esKuery.toElasticsearchQuery.$2", + "type": "Object", "tags": [], - "label": "attrName", + "label": "indexPattern", "description": [], "signature": [ - "K" + "DataViewBase", + " | undefined" ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false }, { "parentPluginId": "data", - "id": "def-server.DataView.setFieldAttrs.$3", - "type": "Uncategorized", + "id": "def-public.esKuery.toElasticsearchQuery.$3", + "type": "Object", "tags": [], - "label": "value", + "label": "config", "description": [], "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldAttrSet", - "text": "FieldAttrSet" - }, - "[K]" + "KueryQueryOptions", + " | undefined" ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.esKuery.toElasticsearchQuery.$4", + "type": "Object", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "Record | undefined" + ], + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false } - ], - "returnComment": [] - }, + ] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-public.esQuery", + "type": "Object", + "tags": [ + "deprecated" + ], + "label": "esQuery", + "description": [], + "path": "src/plugins/data/public/deprecated.ts", + "deprecated": true, + "removeBy": "8.1", + "references": [], + "children": [ { "parentPluginId": "data", - "id": "def-server.DataView.setFieldCustomLabel", + "id": "def-public.esQuery.buildEsQuery", "type": "Function", "tags": [], - "label": "setFieldCustomLabel", + "label": "buildEsQuery", "description": [], "signature": [ - "(fieldName: string, customLabel: string | null | undefined) => void" + "(indexPattern: ", + "DataViewBase", + " | undefined, queries: ", + "Query", + " | ", + "Query", + "[], filters: ", + "Filter", + " | ", + "Filter", + "[], config?: ", + "EsQueryConfig", + " | undefined) => { bool: ", + "BoolQuery", + "; }" ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", + "path": "src/plugins/data/public/deprecated.ts", "deprecated": false, + "returnComment": [], "children": [ { "parentPluginId": "data", - "id": "def-server.DataView.setFieldCustomLabel.$1", - "type": "string", + "id": "def-public.esQuery.buildEsQuery.$1", + "type": "Object", "tags": [], - "label": "fieldName", + "label": "indexPattern", "description": [], "signature": [ - "string" + "DataViewBase", + " | undefined" ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false }, { "parentPluginId": "data", - "id": "def-server.DataView.setFieldCustomLabel.$2", + "id": "def-public.esQuery.buildEsQuery.$2", "type": "CompoundType", "tags": [], - "label": "customLabel", + "label": "queries", "description": [], "signature": [ - "string | null | undefined" + "Query", + " | ", + "Query", + "[]" ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": false + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.esQuery.buildEsQuery.$3", + "type": "CompoundType", + "tags": [], + "label": "filters", + "description": [], + "signature": [ + "Filter", + " | ", + "Filter", + "[]" + ], + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.esQuery.buildEsQuery.$4", + "type": "CompoundType", + "tags": [], + "label": "config", + "description": [], + "signature": [ + "EsQueryConfig", + " | undefined" + ], + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false } - ], - "returnComment": [] + ] }, { "parentPluginId": "data", - "id": "def-server.DataView.setFieldCount", + "id": "def-public.esQuery.getEsQueryConfig", "type": "Function", "tags": [], - "label": "setFieldCount", + "label": "getEsQueryConfig", "description": [], "signature": [ - "(fieldName: string, count: number | null | undefined) => void" + "(config: KibanaConfig) => ", + "EsQueryConfig" ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", + "path": "src/plugins/data/public/deprecated.ts", "deprecated": false, + "returnComment": [], "children": [ { "parentPluginId": "data", - "id": "def-server.DataView.setFieldCount.$1", - "type": "string", - "tags": [], - "label": "fieldName", - "description": [], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "data", - "id": "def-server.DataView.setFieldCount.$2", - "type": "CompoundType", + "id": "def-public.esQuery.getEsQueryConfig.$1", + "type": "Object", "tags": [], - "label": "count", + "label": "config", "description": [], "signature": [ - "number | null | undefined" + "KibanaConfig" ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": false + "path": "src/plugins/data/common/es_query/get_es_query_config.ts", + "deprecated": false } - ], - "returnComment": [] + ] }, { "parentPluginId": "data", - "id": "def-server.DataView.setFieldFormat", + "id": "def-public.esQuery.buildQueryFromFilters", "type": "Function", "tags": [], - "label": "setFieldFormat", + "label": "buildQueryFromFilters", "description": [], "signature": [ - "(fieldName: string, format: ", - { - "pluginId": "fieldFormats", - "scope": "common", - "docId": "kibFieldFormatsPluginApi", - "section": "def-common.SerializedFieldFormat", - "text": "SerializedFieldFormat" - }, - "<", - { - "pluginId": "fieldFormats", - "scope": "common", - "docId": "kibFieldFormatsPluginApi", - "section": "def-common.FieldFormatParams", - "text": "FieldFormatParams" - }, - ">) => void" + "(filters: ", + "Filter", + "[] | undefined, indexPattern: ", + "DataViewBase", + " | undefined, ignoreFilterIfFieldNotInIndex?: boolean | undefined) => ", + "BoolQuery" ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", + "path": "src/plugins/data/public/deprecated.ts", "deprecated": false, + "returnComment": [], "children": [ { "parentPluginId": "data", - "id": "def-server.DataView.setFieldFormat.$1", - "type": "string", + "id": "def-public.esQuery.buildQueryFromFilters.$1", + "type": "Array", "tags": [], - "label": "fieldName", + "label": "filters", "description": [], "signature": [ - "string" + "Filter", + "[] | undefined" ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false }, { "parentPluginId": "data", - "id": "def-server.DataView.setFieldFormat.$2", + "id": "def-public.esQuery.buildQueryFromFilters.$2", "type": "Object", "tags": [], - "label": "format", + "label": "indexPattern", "description": [], "signature": [ - { - "pluginId": "fieldFormats", - "scope": "common", - "docId": "kibFieldFormatsPluginApi", - "section": "def-common.SerializedFieldFormat", - "text": "SerializedFieldFormat" - }, - "<", - { - "pluginId": "fieldFormats", - "scope": "common", - "docId": "kibFieldFormatsPluginApi", - "section": "def-common.FieldFormatParams", - "text": "FieldFormatParams" - }, - ">" + "DataViewBase", + " | undefined" ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-server.DataView.deleteFieldFormat", - "type": "Function", - "tags": [], - "label": "deleteFieldFormat", - "description": [], - "signature": [ - "(fieldName: string) => void" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [ + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false + }, { "parentPluginId": "data", - "id": "def-server.DataView.deleteFieldFormat.$1", - "type": "string", + "id": "def-public.esQuery.buildQueryFromFilters.$3", + "type": "CompoundType", "tags": [], - "label": "fieldName", + "label": "ignoreFilterIfFieldNotInIndex", "description": [], "signature": [ - "string" + "boolean | undefined" ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false } - ], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-server.IndexPattern", - "type": "Class", - "tags": [ - "deprecated" - ], - "label": "IndexPattern", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" - }, - " extends ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - } - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": true, - "references": [ - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/index.ts" - }, - { - "plugin": "discover", - "path": "src/plugins/discover/public/application/view_alert/view_alert_route.tsx" - }, - { - "plugin": "discover", - "path": "src/plugins/discover/public/application/view_alert/view_alert_route.tsx" - }, - { - "plugin": "ux", - "path": "x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_filters.tsx" - }, - { - "plugin": "ux", - "path": "x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_filters.tsx" - }, - { - "plugin": "ux", - "path": "x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_wildcards.tsx" - }, - { - "plugin": "ux", - "path": "x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_wildcards.tsx" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/fields/data_view_field.test.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/fields/data_view_field.test.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/public/index.ts" - }, - { - "plugin": "savedObjects", - "path": "src/plugins/saved_objects/public/types.ts" - }, - { - "plugin": "savedObjects", - "path": "src/plugins/saved_objects/public/types.ts" - }, - { - "plugin": "savedObjects", - "path": "src/plugins/saved_objects/public/types.ts" - }, - { - "plugin": "savedObjects", - "path": "src/plugins/saved_objects/public/saved_object/helpers/apply_es_resp.ts" - }, - { - "plugin": "savedObjects", - "path": "src/plugins/saved_objects/public/saved_object/helpers/apply_es_resp.ts" - }, - { - "plugin": "dataViewEditor", - "path": "src/plugins/data_view_editor/public/shared_imports.ts" - }, - { - "plugin": "dataViewEditor", - "path": "src/plugins/data_view_editor/public/open_editor.tsx" - }, - { - "plugin": "dataViewEditor", - "path": "src/plugins/data_view_editor/public/open_editor.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/fields/agg/percentile_agg_field.test.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/fields/agg/percentile_agg_field.test.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/agg_filters/agg_type_filters.ts" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/agg_filters/agg_type_filters.ts" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/agg_filters/agg_type_filters.ts" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/utils/editor_config.ts" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/utils/editor_config.ts" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.ts" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.ts" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_select.tsx" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_select.tsx" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_params.tsx" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_params.tsx" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.test.ts" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.test.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.test.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.test.ts" + ] }, { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.test.ts" + "parentPluginId": "data", + "id": "def-public.esQuery.luceneStringToDsl", + "type": "Function", + "tags": [], + "label": "luceneStringToDsl", + "description": [], + "signature": [ + "(query: string | ", + "QueryDslQueryContainer", + ") => ", + "QueryDslQueryContainer" + ], + "path": "src/plugins/data/public/deprecated.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.esQuery.luceneStringToDsl.$1", + "type": "CompoundType", + "tags": [], + "label": "query", + "description": [], + "signature": [ + "string | ", + "QueryDslQueryContainer" + ], + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false + } + ] }, { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.test.ts" + "parentPluginId": "data", + "id": "def-public.esQuery.decorateQuery", + "type": "Function", + "tags": [], + "label": "decorateQuery", + "description": [], + "signature": [ + "(query: ", + "QueryDslQueryContainer", + ", queryStringOptions: string | ", + "SerializableRecord", + ", dateFormatTZ?: string | undefined) => ", + "QueryDslQueryContainer" + ], + "path": "src/plugins/data/public/deprecated.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.esQuery.decorateQuery.$1", + "type": "Object", + "tags": [], + "label": "query", + "description": [], + "signature": [ + "QueryDslQueryContainer" + ], + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.esQuery.decorateQuery.$2", + "type": "CompoundType", + "tags": [], + "label": "queryStringOptions", + "description": [], + "signature": [ + "string | ", + "SerializableRecord" + ], + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.esQuery.decorateQuery.$3", + "type": "string", + "tags": [], + "label": "dateFormatTZ", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false + } + ] } ], - "children": [], "initialIsOpen": false }, { "parentPluginId": "data", - "id": "def-server.IndexPatternField", - "type": "Class", - "tags": [ - "deprecated" - ], - "label": "IndexPatternField", + "id": "def-public.exporters", + "type": "Object", + "tags": [], + "label": "exporters", "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IndexPatternField", - "text": "IndexPatternField" - }, - " extends ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" - } - ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": true, - "references": [ - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/index.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/public/index.ts" - }, - { - "plugin": "dataViewEditor", - "path": "src/plugins/data_view_editor/public/shared_imports.ts" - }, - { - "plugin": "dataViewEditor", - "path": "src/plugins/data_view_editor/public/lib/extract_time_fields.ts" - }, - { - "plugin": "dataViewEditor", - "path": "src/plugins/data_view_editor/public/lib/extract_time_fields.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/metrics_editor/metric_editor.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/metrics_editor/metric_editor.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/metrics_editor/metric_editor.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/fields/es_doc_field.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/fields/es_doc_field.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/metrics_editor/metrics_editor.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/metrics_editor/metrics_editor.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_geo_grid_source/update_source_editor.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_geo_grid_source/update_source_editor.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/top_hits/top_hits_form.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/top_hits/top_hits_form.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/top_hits/top_hits_form.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/top_hits/update_source_editor.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/top_hits/update_source_editor.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/top_hits/update_source_editor.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/geo_field_select.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/geo_field_select.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/connected_components/edit_layer_panel/join_editor/resources/join_expression.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/connected_components/edit_layer_panel/join_editor/resources/join_expression.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/connected_components/edit_layer_panel/join_editor/resources/metrics_expression.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/connected_components/edit_layer_panel/join_editor/resources/metrics_expression.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/index_pattern_util.test.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/index_pattern_util.test.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/index_pattern_util.test.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/index_pattern_util.test.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/index_pattern_util.test.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/index_pattern_util.test.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts" - }, + "path": "src/plugins/data/public/index.ts", + "deprecated": false, + "children": [ { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts" + "parentPluginId": "data", + "id": "def-public.exporters.datatableToCSV", + "type": "Function", + "tags": [], + "label": "datatableToCSV", + "description": [], + "signature": [ + "({ columns, rows }: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + }, + ", { csvSeparator, quoteValues, formatFactory, raw, escapeFormulaValues }: CSVOptions) => string" + ], + "path": "src/plugins/data/public/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.exporters.datatableToCSV.$1", + "type": "Object", + "tags": [], + "label": "__0", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + } + ], + "path": "src/plugins/data/common/exports/export_csv.tsx", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.exporters.datatableToCSV.$2", + "type": "Object", + "tags": [], + "label": "__1", + "description": [], + "signature": [ + "CSVOptions" + ], + "path": "src/plugins/data/common/exports/export_csv.tsx", + "deprecated": false + } + ] }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts" + "parentPluginId": "data", + "id": "def-public.exporters.CSV_MIME_TYPE", + "type": "string", + "tags": [], + "label": "CSV_MIME_TYPE", + "description": [], + "path": "src/plugins/data/public/index.ts", + "deprecated": false }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts" + "parentPluginId": "data", + "id": "def-public.exporters.cellHasFormulas", + "type": "Function", + "tags": [], + "label": "cellHasFormulas", + "description": [], + "signature": [ + "(val: string) => boolean" + ], + "path": "src/plugins/data/public/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.exporters.cellHasFormulas.$1", + "type": "string", + "tags": [], + "label": "val", + "description": [], + "path": "src/plugins/data/common/exports/formula_checks.ts", + "deprecated": false + } + ] }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts" - }, + "parentPluginId": "data", + "id": "def-public.exporters.tableHasFormulas", + "type": "Function", + "tags": [], + "label": "tableHasFormulas", + "description": [], + "signature": [ + "(columns: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" + }, + "[], rows: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableRow", + "text": "DatatableRow" + }, + "[]) => boolean" + ], + "path": "src/plugins/data/public/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.exporters.tableHasFormulas.$1", + "type": "Array", + "tags": [], + "label": "columns", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" + }, + "[]" + ], + "path": "src/plugins/data/common/exports/formula_checks.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.exporters.tableHasFormulas.$2", + "type": "Array", + "tags": [], + "label": "rows", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableRow", + "text": "DatatableRow" + }, + "[]" + ], + "path": "src/plugins/data/common/exports/formula_checks.ts", + "deprecated": false + } + ] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-public.indexPatterns", + "type": "Object", + "tags": [], + "label": "indexPatterns", + "description": [], + "path": "src/plugins/data/public/index.ts", + "deprecated": false, + "children": [ { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts" + "parentPluginId": "data", + "id": "def-public.indexPatterns.ILLEGAL_CHARACTERS_KEY", + "type": "string", + "tags": [], + "label": "ILLEGAL_CHARACTERS_KEY", + "description": [], + "path": "src/plugins/data/public/index.ts", + "deprecated": false }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/agg_filters/agg_type_field_filters.ts" + "parentPluginId": "data", + "id": "def-public.indexPatterns.CONTAINS_SPACES_KEY", + "type": "string", + "tags": [], + "label": "CONTAINS_SPACES_KEY", + "description": [], + "path": "src/plugins/data/public/index.ts", + "deprecated": false }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/agg_filters/agg_type_field_filters.ts" + "parentPluginId": "data", + "id": "def-public.indexPatterns.ILLEGAL_CHARACTERS_VISIBLE", + "type": "Array", + "tags": [], + "label": "ILLEGAL_CHARACTERS_VISIBLE", + "description": [], + "signature": [ + "string[]" + ], + "path": "src/plugins/data/public/index.ts", + "deprecated": false }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/agg_filters/agg_type_field_filters.ts" + "parentPluginId": "data", + "id": "def-public.indexPatterns.ILLEGAL_CHARACTERS", + "type": "Array", + "tags": [], + "label": "ILLEGAL_CHARACTERS", + "description": [], + "signature": [ + "string[]" + ], + "path": "src/plugins/data/public/index.ts", + "deprecated": false }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_param_props.ts" + "parentPluginId": "data", + "id": "def-public.indexPatterns.isFilterable", + "type": "Function", + "tags": [], + "label": "isFilterable", + "description": [], + "signature": [ + "(field: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewField", + "text": "DataViewField" + }, + ") => boolean" + ], + "path": "src/plugins/data/public/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.indexPatterns.isFilterable.$1", + "type": "Object", + "tags": [], + "label": "field", + "description": [], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewField", + "text": "DataViewField" + } + ], + "path": "src/plugins/data_views/common/fields/utils.ts", + "deprecated": false + } + ] }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_param_props.ts" + "parentPluginId": "data", + "id": "def-public.indexPatterns.isNestedField", + "type": "Function", + "tags": [], + "label": "isNestedField", + "description": [], + "signature": [ + "(field: HasSubtype) => boolean" + ], + "path": "src/plugins/data/public/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.indexPatterns.isNestedField.$1", + "type": "Object", + "tags": [], + "label": "field", + "description": [], + "signature": [ + "{ subType?: ", + "IFieldSubType", + " | undefined; }" + ], + "path": "src/plugins/data_views/common/fields/utils.ts", + "deprecated": false + } + ] }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/controls/field.tsx" + "parentPluginId": "data", + "id": "def-public.indexPatterns.isMultiField", + "type": "Function", + "tags": [], + "label": "isMultiField", + "description": [], + "signature": [ + "(field: HasSubtype) => boolean" + ], + "path": "src/plugins/data/public/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.indexPatterns.isMultiField.$1", + "type": "Object", + "tags": [], + "label": "field", + "description": [], + "signature": [ + "{ subType?: ", + "IFieldSubType", + " | undefined; }" + ], + "path": "src/plugins/data_views/common/fields/utils.ts", + "deprecated": false + } + ] }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/controls/field.tsx" + "parentPluginId": "data", + "id": "def-public.indexPatterns.getFieldSubtypeMulti", + "type": "Function", + "tags": [], + "label": "getFieldSubtypeMulti", + "description": [], + "signature": [ + "(field: HasSubtype) => ", + "IFieldSubTypeMulti", + " | undefined" + ], + "path": "src/plugins/data/public/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.indexPatterns.getFieldSubtypeMulti.$1", + "type": "Object", + "tags": [], + "label": "field", + "description": [], + "signature": [ + "{ subType?: ", + "IFieldSubType", + " | undefined; }" + ], + "path": "src/plugins/data_views/common/fields/utils.ts", + "deprecated": false + } + ] }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/controls/field.tsx" + "parentPluginId": "data", + "id": "def-public.indexPatterns.getFieldSubtypeNested", + "type": "Function", + "tags": [], + "label": "getFieldSubtypeNested", + "description": [], + "signature": [ + "(field: HasSubtype) => ", + "IFieldSubTypeNested", + " | undefined" + ], + "path": "src/plugins/data/public/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.indexPatterns.getFieldSubtypeNested.$1", + "type": "Object", + "tags": [], + "label": "field", + "description": [], + "signature": [ + "{ subType?: ", + "IFieldSubType", + " | undefined; }" + ], + "path": "src/plugins/data_views/common/fields/utils.ts", + "deprecated": false + } + ] }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/controls/field.tsx" - }, + "parentPluginId": "data", + "id": "def-public.indexPatterns.validate", + "type": "Function", + "tags": [], + "label": "validate", + "description": [], + "signature": [ + "(indexPattern: string) => { ILLEGAL_CHARACTERS?: string[] | undefined; CONTAINS_SPACES?: boolean | undefined; }" + ], + "path": "src/plugins/data/public/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.indexPatterns.validate.$1", + "type": "string", + "tags": [], + "label": "indexPattern", + "description": [], + "path": "src/plugins/data_views/common/lib/validate_data_view.ts", + "deprecated": false + } + ] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-public.search", + "type": "Object", + "tags": [], + "label": "search", + "description": [], + "path": "src/plugins/data/public/index.ts", + "deprecated": false, + "children": [ { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/controls/top_field.tsx" + "parentPluginId": "data", + "id": "def-public.search.aggs", + "type": "Object", + "tags": [], + "label": "aggs", + "description": [], + "path": "src/plugins/data/public/index.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-public.search.aggs.CidrMask", + "type": "Object", + "tags": [], + "label": "CidrMask", + "description": [], + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.CidrMask", + "text": "CidrMask" + } + ], + "path": "src/plugins/data/public/index.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.search.aggs.dateHistogramInterval", + "type": "Function", + "tags": [], + "label": "dateHistogramInterval", + "description": [], + "signature": [ + "(interval: string) => Interval" + ], + "path": "src/plugins/data/public/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.search.aggs.dateHistogramInterval.$1", + "type": "string", + "tags": [], + "label": "interval", + "description": [], + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/date_histogram_interval.ts", + "deprecated": false + } + ] + }, + { + "parentPluginId": "data", + "id": "def-public.search.aggs.intervalOptions", + "type": "Array", + "tags": [], + "label": "intervalOptions", + "description": [], + "signature": [ + "({ display: string; val: string; enabled(agg: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IBucketAggConfig", + "text": "IBucketAggConfig" + }, + "): boolean; } | { display: string; val: string; })[]" + ], + "path": "src/plugins/data/public/index.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.search.aggs.InvalidEsCalendarIntervalError", + "type": "Object", + "tags": [], + "label": "InvalidEsCalendarIntervalError", + "description": [], + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.InvalidEsCalendarIntervalError", + "text": "InvalidEsCalendarIntervalError" + } + ], + "path": "src/plugins/data/public/index.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.search.aggs.InvalidEsIntervalFormatError", + "type": "Object", + "tags": [], + "label": "InvalidEsIntervalFormatError", + "description": [], + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.InvalidEsIntervalFormatError", + "text": "InvalidEsIntervalFormatError" + } + ], + "path": "src/plugins/data/public/index.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.search.aggs.IpAddress", + "type": "Object", + "tags": [], + "label": "IpAddress", + "description": [], + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IpAddress", + "text": "IpAddress" + } + ], + "path": "src/plugins/data/public/index.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.search.aggs.isDateHistogramBucketAggConfig", + "type": "Function", + "tags": [], + "label": "isDateHistogramBucketAggConfig", + "description": [], + "signature": [ + "(agg: any) => agg is ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IBucketDateHistogramAggConfig", + "text": "IBucketDateHistogramAggConfig" + } + ], + "path": "src/plugins/data/public/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.search.aggs.isDateHistogramBucketAggConfig.$1", + "type": "Any", + "tags": [], + "label": "agg", + "description": [], + "signature": [ + "any" + ], + "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", + "deprecated": false + } + ] + }, + { + "parentPluginId": "data", + "id": "def-public.search.aggs.isNumberType", + "type": "Function", + "tags": [], + "label": "isNumberType", + "description": [], + "signature": [ + "(agg: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + ") => boolean" + ], + "path": "src/plugins/data/public/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.search.aggs.isNumberType.$1", + "type": "Object", + "tags": [], + "label": "agg", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + } + ], + "path": "src/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts", + "deprecated": false + } + ] + }, + { + "parentPluginId": "data", + "id": "def-public.search.aggs.isStringType", + "type": "Function", + "tags": [], + "label": "isStringType", + "description": [], + "signature": [ + "(agg: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + ") => boolean" + ], + "path": "src/plugins/data/public/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.search.aggs.isStringType.$1", + "type": "Object", + "tags": [], + "label": "agg", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + } + ], + "path": "src/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts", + "deprecated": false + } + ] + }, + { + "parentPluginId": "data", + "id": "def-public.search.aggs.isType", + "type": "Function", + "tags": [], + "label": "isType", + "description": [], + "signature": [ + "(...types: string[]) => (agg: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + ") => boolean" + ], + "path": "src/plugins/data/public/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.search.aggs.isType.$1", + "type": "Array", + "tags": [], + "label": "types", + "description": [], + "signature": [ + "string[]" + ], + "path": "src/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts", + "deprecated": false + } + ] + }, + { + "parentPluginId": "data", + "id": "def-public.search.aggs.isValidEsInterval", + "type": "Function", + "tags": [], + "label": "isValidEsInterval", + "description": [], + "signature": [ + "(interval: string) => boolean" + ], + "path": "src/plugins/data/public/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.search.aggs.isValidEsInterval.$1", + "type": "string", + "tags": [], + "label": "interval", + "description": [], + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/is_valid_es_interval.ts", + "deprecated": false + } + ] + }, + { + "parentPluginId": "data", + "id": "def-public.search.aggs.isValidInterval", + "type": "Function", + "tags": [], + "label": "isValidInterval", + "description": [], + "signature": [ + "(value: string, baseInterval?: string | undefined) => boolean" + ], + "path": "src/plugins/data/public/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.search.aggs.isValidInterval.$1", + "type": "string", + "tags": [], + "label": "value", + "description": [], + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/is_valid_interval.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.search.aggs.isValidInterval.$2", + "type": "string", + "tags": [], + "label": "baseInterval", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/is_valid_interval.ts", + "deprecated": false + } + ] + }, + { + "parentPluginId": "data", + "id": "def-public.search.aggs.parentPipelineType", + "type": "string", + "tags": [], + "label": "parentPipelineType", + "description": [], + "path": "src/plugins/data/public/index.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.search.aggs.parseEsInterval", + "type": "Function", + "tags": [], + "label": "parseEsInterval", + "description": [], + "signature": [ + "(interval: string) => { value: number; unit: ", + "Unit", + "; type: \"calendar\" | \"fixed\"; }" + ], + "path": "src/plugins/data/public/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.search.aggs.parseEsInterval.$1", + "type": "string", + "tags": [], + "label": "interval", + "description": [], + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_es_interval.ts", + "deprecated": false + } + ] + }, + { + "parentPluginId": "data", + "id": "def-public.search.aggs.parseInterval", + "type": "Function", + "tags": [], + "label": "parseInterval", + "description": [], + "signature": [ + "(interval: string) => moment.Duration | null" + ], + "path": "src/plugins/data/public/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.search.aggs.parseInterval.$1", + "type": "string", + "tags": [], + "label": "interval", + "description": [], + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_interval.ts", + "deprecated": false + } + ] + }, + { + "parentPluginId": "data", + "id": "def-public.search.aggs.propFilter", + "type": "Function", + "tags": [], + "label": "propFilter", + "description": [], + "signature": [ + "

(prop: P) => (list: T[], filters?: string | string[] | FilterFunc) => T[]" + ], + "path": "src/plugins/data/public/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.search.aggs.propFilter.$1", + "type": "Uncategorized", + "tags": [], + "label": "prop", + "description": [], + "signature": [ + "P" + ], + "path": "src/plugins/data/common/search/aggs/utils/prop_filter.ts", + "deprecated": false + } + ] + }, + { + "parentPluginId": "data", + "id": "def-public.search.aggs.siblingPipelineType", + "type": "string", + "tags": [], + "label": "siblingPipelineType", + "description": [], + "path": "src/plugins/data/public/index.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.search.aggs.termsAggFilter", + "type": "Array", + "tags": [], + "label": "termsAggFilter", + "description": [], + "signature": [ + "string[]" + ], + "path": "src/plugins/data/public/index.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.search.aggs.toAbsoluteDates", + "type": "Function", + "tags": [], + "label": "toAbsoluteDates", + "description": [], + "signature": [ + "(range: ", + "TimeRange", + ") => { from: Date; to: Date; } | undefined" + ], + "path": "src/plugins/data/public/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.search.aggs.toAbsoluteDates.$1", + "type": "Object", + "tags": [], + "label": "range", + "description": [], + "signature": [ + "{ from: string; to: string; mode?: \"absolute\" | \"relative\" | undefined; }" + ], + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/to_absolute_dates.ts", + "deprecated": false + } + ] + }, + { + "parentPluginId": "data", + "id": "def-public.search.aggs.boundsDescendingRaw", + "type": "Array", + "tags": [], + "label": "boundsDescendingRaw", + "description": [], + "signature": [ + "({ bound: number; interval: moment.Duration; boundLabel: string; intervalLabel: string; } | { bound: moment.Duration; interval: moment.Duration; boundLabel: string; intervalLabel: string; })[]" + ], + "path": "src/plugins/data/public/index.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.search.aggs.getNumberHistogramIntervalByDatatableColumn", + "type": "Function", + "tags": [], + "label": "getNumberHistogramIntervalByDatatableColumn", + "description": [], + "signature": [ + "(column: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" + }, + ") => number | undefined" + ], + "path": "src/plugins/data/public/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.search.aggs.getNumberHistogramIntervalByDatatableColumn.$1", + "type": "Object", + "tags": [], + "label": "column", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" + } + ], + "path": "src/plugins/data/common/search/aggs/utils/get_number_histogram_interval.ts", + "deprecated": false + } + ] + }, + { + "parentPluginId": "data", + "id": "def-public.search.aggs.getDateHistogramMetaDataByDatatableColumn", + "type": "Function", + "tags": [], + "label": "getDateHistogramMetaDataByDatatableColumn", + "description": [], + "signature": [ + "(column: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" + }, + ", defaults?: Partial<{ timeZone: string; }>) => { interval: string | undefined; timeZone: string | undefined; timeRange: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + }, + " | undefined; } | undefined" + ], + "path": "src/plugins/data/public/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.search.aggs.getDateHistogramMetaDataByDatatableColumn.$1", + "type": "Object", + "tags": [], + "label": "column", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" + } + ], + "path": "src/plugins/data/common/search/aggs/utils/get_date_histogram_meta.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.search.aggs.getDateHistogramMetaDataByDatatableColumn.$2", + "type": "Object", + "tags": [], + "label": "defaults", + "description": [], + "signature": [ + "{ timeZone?: string | undefined; }" + ], + "path": "src/plugins/data/common/search/aggs/utils/get_date_histogram_meta.ts", + "deprecated": false + } + ] + } + ] }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/controls/top_field.tsx" + "parentPluginId": "data", + "id": "def-public.search.getResponseInspectorStats", + "type": "Function", + "tags": [], + "label": "getResponseInspectorStats", + "description": [], + "signature": [ + "(resp?: ", + "SearchResponse", + "> | undefined, searchSource?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchSource", + "text": "ISearchSource" + }, + " | undefined) => ", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.RequestStatistics", + "text": "RequestStatistics" + } + ], + "path": "src/plugins/data/public/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.search.getResponseInspectorStats.$1", + "type": "Object", + "tags": [], + "label": "resp", + "description": [], + "signature": [ + "SearchResponse", + "> | undefined" + ], + "path": "src/plugins/data/common/search/search_source/inspect/inspector_stats.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.search.getResponseInspectorStats.$2", + "type": "Object", + "tags": [], + "label": "searchSource", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchSource", + "text": "ISearchSource" + }, + " | undefined" + ], + "path": "src/plugins/data/common/search/search_source/inspect/inspector_stats.ts", + "deprecated": false + } + ] }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/controls/top_sort_field.tsx" + "parentPluginId": "data", + "id": "def-public.search.tabifyAggResponse", + "type": "Function", + "tags": [], + "label": "tabifyAggResponse", + "description": [], + "signature": [ + "(aggConfigs: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfigs", + "text": "AggConfigs" + }, + ", esResponse: Record, respOpts?: Partial<", + "TabbedResponseWriterOptions", + "> | undefined) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + } + ], + "path": "src/plugins/data/public/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.search.tabifyAggResponse.$1", + "type": "Object", + "tags": [], + "label": "aggConfigs", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfigs", + "text": "AggConfigs" + } + ], + "path": "src/plugins/data/common/search/tabify/tabify.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.search.tabifyAggResponse.$2", + "type": "Object", + "tags": [], + "label": "esResponse", + "description": [], + "signature": [ + "{ [x: string]: any; }" + ], + "path": "src/plugins/data/common/search/tabify/tabify.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.search.tabifyAggResponse.$3", + "type": "Object", + "tags": [], + "label": "respOpts", + "description": [], + "signature": [ + "Partial<", + "TabbedResponseWriterOptions", + "> | undefined" + ], + "path": "src/plugins/data/common/search/tabify/tabify.ts", + "deprecated": false + } + ] }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/controls/top_sort_field.tsx" + "parentPluginId": "data", + "id": "def-public.search.tabifyGetColumns", + "type": "Function", + "tags": [], + "label": "tabifyGetColumns", + "description": [], + "signature": [ + "(aggs: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + "[], minimalColumns: boolean) => ", + "TabbedAggColumn", + "[]" + ], + "path": "src/plugins/data/public/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.search.tabifyGetColumns.$1", + "type": "Array", + "tags": [], + "label": "aggs", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + "[]" + ], + "path": "src/plugins/data/common/search/tabify/get_columns.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.search.tabifyGetColumns.$2", + "type": "boolean", + "tags": [], + "label": "minimalColumns", + "description": [], + "path": "src/plugins/data/common/search/tabify/get_columns.ts", + "deprecated": false + } + ] }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.ts" - }, + "parentPluginId": "data", + "id": "def-public.search.checkColumnForPrecisionError", + "type": "Function", + "tags": [], + "label": "checkColumnForPrecisionError", + "description": [], + "signature": [ + "(column: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" + }, + ") => ", + "Serializable" + ], + "path": "src/plugins/data/public/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.search.checkColumnForPrecisionError.$1", + "type": "Object", + "tags": [], + "label": "column", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" + } + ], + "path": "src/plugins/data/common/search/tabify/utils.ts", + "deprecated": false + } + ] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-public.UI_SETTINGS", + "type": "Object", + "tags": [], + "label": "UI_SETTINGS", + "description": [], + "signature": [ + "{ readonly META_FIELDS: \"metaFields\"; readonly DOC_HIGHLIGHT: \"doc_table:highlight\"; readonly QUERY_STRING_OPTIONS: \"query:queryString:options\"; readonly QUERY_ALLOW_LEADING_WILDCARDS: \"query:allowLeadingWildcards\"; readonly SEARCH_QUERY_LANGUAGE: \"search:queryLanguage\"; readonly SORT_OPTIONS: \"sort:options\"; readonly COURIER_IGNORE_FILTER_IF_FIELD_NOT_IN_INDEX: \"courier:ignoreFilterIfFieldNotInIndex\"; readonly COURIER_SET_REQUEST_PREFERENCE: \"courier:setRequestPreference\"; readonly COURIER_CUSTOM_REQUEST_PREFERENCE: \"courier:customRequestPreference\"; readonly COURIER_MAX_CONCURRENT_SHARD_REQUESTS: \"courier:maxConcurrentShardRequests\"; readonly SEARCH_INCLUDE_FROZEN: \"search:includeFrozen\"; readonly SEARCH_TIMEOUT: \"search:timeout\"; readonly HISTOGRAM_BAR_TARGET: \"histogram:barTarget\"; readonly HISTOGRAM_MAX_BARS: \"histogram:maxBars\"; readonly HISTORY_LIMIT: \"history:limit\"; readonly TIMEPICKER_REFRESH_INTERVAL_DEFAULTS: \"timepicker:refreshIntervalDefaults\"; readonly TIMEPICKER_QUICK_RANGES: \"timepicker:quickRanges\"; readonly TIMEPICKER_TIME_DEFAULTS: \"timepicker:timeDefaults\"; readonly FILTERS_PINNED_BY_DEFAULT: \"filters:pinnedByDefault\"; readonly FILTERS_EDITOR_SUGGEST_VALUES: \"filterEditor:suggestValues\"; readonly AUTOCOMPLETE_USE_TIMERANGE: \"autocomplete:useTimeRange\"; readonly AUTOCOMPLETE_VALUE_SUGGESTION_METHOD: \"autocomplete:valueSuggestionMethod\"; readonly DATE_FORMAT: \"dateFormat\"; readonly DATEFORMAT_TZ: \"dateFormat:tz\"; }" + ], + "path": "src/plugins/data/common/constants.ts", + "deprecated": false, + "initialIsOpen": false + } + ], + "setup": { + "parentPluginId": "data", + "id": "def-public.DataPublicPluginSetup", + "type": "Interface", + "tags": [], + "label": "DataPublicPluginSetup", + "description": [ + "\nData plugin public Setup contract" + ], + "path": "src/plugins/data/public/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-public.DataPublicPluginSetup.search", + "type": "Object", + "tags": [], + "label": "search", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataSearchPluginApi", + "section": "def-public.ISearchSetup", + "text": "ISearchSetup" + } + ], + "path": "src/plugins/data/public/types.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.DataPublicPluginSetup.query", + "type": "Object", + "tags": [], + "label": "query", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.QuerySetup", + "text": "QuerySetup" + } + ], + "path": "src/plugins/data/public/types.ts", + "deprecated": false + } + ], + "lifecycle": "setup", + "initialIsOpen": true + }, + "start": { + "parentPluginId": "data", + "id": "def-public.DataPublicPluginStart", + "type": "Interface", + "tags": [], + "label": "DataPublicPluginStart", + "description": [ + "\nData plugin public Start contract" + ], + "path": "src/plugins/data/public/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-public.DataPublicPluginStart.actions", + "type": "Object", + "tags": [], + "label": "actions", + "description": [ + "\nfilter creation utilities\n{@link DataPublicPluginStartActions}" + ], + "signature": [ + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataPluginApi", + "section": "def-public.DataPublicPluginStartActions", + "text": "DataPublicPluginStartActions" + } + ], + "path": "src/plugins/data/public/types.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.DataPublicPluginStart.dataViews", + "type": "Object", + "tags": [], + "label": "dataViews", + "description": [ + "\ndata views service\n{@link DataViewsContract}" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "public", + "docId": "kibDataViewsPluginApi", + "section": "def-public.DataViewsServicePublic", + "text": "DataViewsServicePublic" + } + ], + "path": "src/plugins/data/public/types.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.DataPublicPluginStart.datatableUtilities", + "type": "Object", + "tags": [], + "label": "datatableUtilities", + "description": [ + "\nDatatable type utility functions." + ], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.DatatableUtilitiesService", + "text": "DatatableUtilitiesService" + } + ], + "path": "src/plugins/data/public/types.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.DataPublicPluginStart.indexPatterns", + "type": "Object", + "tags": [ + "deprecated" + ], + "label": "indexPatterns", + "description": [ + "\nindex patterns service\n{@link DataViewsContract}" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "public", + "docId": "kibDataViewsPluginApi", + "section": "def-public.DataViewsServicePublic", + "text": "DataViewsServicePublic" + } + ], + "path": "src/plugins/data/public/types.ts", + "deprecated": true, + "references": [ + { + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/query_string_input/query_string_input.tsx" + }, + { + "plugin": "discover", + "path": "src/plugins/discover/public/plugin.tsx" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/kibana_services.ts" + }, + { + "plugin": "infra", + "path": "x-pack/plugins/infra/public/hooks/use_kibana_index_patterns.ts" + }, + { + "plugin": "graph", + "path": "x-pack/plugins/graph/public/plugin.ts" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/middleware.ts" + }, + { + "plugin": "stackAlerts", + "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/entity_index_expression.tsx" + }, + { + "plugin": "stackAlerts", + "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/boundary_index_expression.tsx" + }, + { + "plugin": "stackAlerts", + "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/index.tsx" + }, + { + "plugin": "stackAlerts", + "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/index.tsx" + }, + { + "plugin": "stackAlerts", + "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/index.tsx" + }, + { + "plugin": "inputControlVis", + "path": "src/plugins/input_control_vis/public/control/list_control_factory.ts" + }, + { + "plugin": "inputControlVis", + "path": "src/plugins/input_control_vis/public/control/range_control_factory.ts" + }, + { + "plugin": "inputControlVis", + "path": "src/plugins/input_control_vis/public/components/editor/controls_tab.tsx" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/public/common/mock/endpoint/dependencies_start_mock.ts" + }, + { + "plugin": "savedObjects", + "path": "src/plugins/saved_objects/public/saved_object/saved_object.test.ts" + }, + { + "plugin": "savedObjects", + "path": "src/plugins/saved_objects/public/saved_object/saved_object.test.ts" + } + ] + }, + { + "parentPluginId": "data", + "id": "def-public.DataPublicPluginStart.search", + "type": "Object", + "tags": [], + "label": "search", + "description": [ + "\nsearch service\n{@link ISearchStart}" + ], + "signature": [ + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataSearchPluginApi", + "section": "def-public.ISearchStart", + "text": "ISearchStart" + } + ], + "path": "src/plugins/data/public/types.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.DataPublicPluginStart.fieldFormats", + "type": "CompoundType", + "tags": [ + "deprecated" + ], + "label": "fieldFormats", + "description": [], + "signature": [ + "Omit<", + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.FieldFormatsRegistry", + "text": "FieldFormatsRegistry" + }, + ", \"init\" | \"register\"> & { deserialize: ", + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.FormatFactory", + "text": "FormatFactory" + }, + "; }" + ], + "path": "src/plugins/data/public/types.ts", + "deprecated": true, + "references": [ + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/application/actions/export_csv_action.tsx" + }, + { + "plugin": "lens", + "path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/ranges/ranges.tsx" + }, + { + "plugin": "stackAlerts", + "path": "x-pack/plugins/stack_alerts/public/alert_types/threshold/expression.tsx" + }, + { + "plugin": "lens", + "path": "x-pack/plugins/lens/public/indexpattern_datasource/dimension_panel/droppable/droppable.test.ts" + }, + { + "plugin": "visTypeTable", + "path": "src/plugins/vis_types/table/public/plugin.ts" + }, + { + "plugin": "visTypeTimeseries", + "path": "src/plugins/vis_types/timeseries/public/plugin.ts" + }, + { + "plugin": "visTypeXy", + "path": "src/plugins/vis_types/xy/public/plugin.ts" + }, + { + "plugin": "visTypeVislib", + "path": "src/plugins/vis_types/vislib/public/plugin.ts" + }, + { + "plugin": "expressionPartitionVis", + "path": "src/plugins/chart_expressions/expression_partition_vis/public/utils/layers/get_layers.test.ts" + }, + { + "plugin": "expressionPartitionVis", + "path": "src/plugins/chart_expressions/expression_partition_vis/public/utils/layers/get_layers.test.ts" + }, + { + "plugin": "expressionPartitionVis", + "path": "src/plugins/chart_expressions/expression_partition_vis/public/utils/layers/get_layers.test.ts" + }, + { + "plugin": "expressionPartitionVis", + "path": "src/plugins/chart_expressions/expression_partition_vis/public/utils/layers/get_layers.test.ts" + }, + { + "plugin": "expressionPartitionVis", + "path": "src/plugins/chart_expressions/expression_partition_vis/public/utils/layers/get_layers.test.ts" + }, + { + "plugin": "expressionPartitionVis", + "path": "src/plugins/chart_expressions/expression_partition_vis/public/utils/layers/get_layers.test.ts" + }, + { + "plugin": "expressionPartitionVis", + "path": "src/plugins/chart_expressions/expression_partition_vis/public/utils/layers/get_layers.test.ts" + }, + { + "plugin": "expressionPartitionVis", + "path": "src/plugins/chart_expressions/expression_partition_vis/public/utils/layers/get_layers.test.ts" + } + ] + }, + { + "parentPluginId": "data", + "id": "def-public.DataPublicPluginStart.query", + "type": "Object", + "tags": [], + "label": "query", + "description": [ + "\nquery service\n{@link QueryStart}" + ], + "signature": [ + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.QueryStart", + "text": "QueryStart" + } + ], + "path": "src/plugins/data/public/types.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.DataPublicPluginStart.nowProvider", + "type": "Object", + "tags": [], + "label": "nowProvider", + "description": [], + "signature": [ + "{ get: () => Date; }" + ], + "path": "src/plugins/data/public/types.ts", + "deprecated": false + } + ], + "lifecycle": "start", + "initialIsOpen": true + } + }, + "server": { + "classes": [ + { + "parentPluginId": "data", + "id": "def-server.DataServerPlugin", + "type": "Class", + "tags": [], + "label": "DataServerPlugin", + "description": [], + "signature": [ { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.ts" + "pluginId": "data", + "scope": "server", + "docId": "kibDataPluginApi", + "section": "def-server.DataServerPlugin", + "text": "DataServerPlugin" }, + " implements ", { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.ts" + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.Plugin", + "text": "Plugin" }, + "<", { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.ts" + "pluginId": "data", + "scope": "server", + "docId": "kibDataPluginApi", + "section": "def-server.DataPluginSetup", + "text": "DataPluginSetup" }, + ", ", { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.ts" + "pluginId": "data", + "scope": "server", + "docId": "kibDataPluginApi", + "section": "def-server.DataPluginStart", + "text": "DataPluginStart" }, + ", ", + "DataPluginSetupDependencies", + ", ", + "DataPluginStartDependencies", + ">" + ], + "path": "src/plugins/data/server/plugin.ts", + "deprecated": false, + "children": [ { - "plugin": "dataViewEditor", - "path": "src/plugins/data_view_editor/public/lib/extract_time_fields.test.ts" + "parentPluginId": "data", + "id": "def-server.DataServerPlugin.Unnamed", + "type": "Function", + "tags": [], + "label": "Constructor", + "description": [], + "signature": [ + "any" + ], + "path": "src/plugins/data/server/plugin.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.DataServerPlugin.Unnamed.$1", + "type": "Object", + "tags": [], + "label": "initializerContext", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.PluginInitializerContext", + "text": "PluginInitializerContext" + }, + "; }>; sessions: Readonly<{} & { enabled: boolean; pageSize: number; trackingInterval: moment.Duration; cleanupInterval: moment.Duration; expireInterval: moment.Duration; monitoringTaskTimeout: moment.Duration; notTouchedTimeout: moment.Duration; notTouchedInProgressTimeout: moment.Duration; maxUpdateRetries: number; defaultExpiration: moment.Duration; management: Readonly<{} & { refreshInterval: moment.Duration; maxSessions: number; refreshTimeout: moment.Duration; expiresSoonWarning: moment.Duration; }>; }>; }>; }>>" + ], + "path": "src/plugins/data/server/plugin.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { - "plugin": "dataViewEditor", - "path": "src/plugins/data_view_editor/public/lib/extract_time_fields.test.ts" + "parentPluginId": "data", + "id": "def-server.DataServerPlugin.setup", + "type": "Function", + "tags": [], + "label": "setup", + "description": [], + "signature": [ + "(core: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreSetup", + "text": "CoreSetup" + }, + "<", + "DataPluginStartDependencies", + ", ", + { + "pluginId": "data", + "scope": "server", + "docId": "kibDataPluginApi", + "section": "def-server.DataPluginStart", + "text": "DataPluginStart" + }, + ">, { bfetch, expressions, usageCollection, fieldFormats, taskManager, security, }: ", + "DataPluginSetupDependencies", + ") => { search: ", + "ISearchSetup", + "; query: ", + "QuerySetup", + "; fieldFormats: ", + { + "pluginId": "fieldFormats", + "scope": "server", + "docId": "kibFieldFormatsPluginApi", + "section": "def-server.FieldFormatsSetup", + "text": "FieldFormatsSetup" + }, + "; }" + ], + "path": "src/plugins/data/server/plugin.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.DataServerPlugin.setup.$1", + "type": "Object", + "tags": [], + "label": "core", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreSetup", + "text": "CoreSetup" + }, + "<", + "DataPluginStartDependencies", + ", ", + { + "pluginId": "data", + "scope": "server", + "docId": "kibDataPluginApi", + "section": "def-server.DataPluginStart", + "text": "DataPluginStart" + }, + ">" + ], + "path": "src/plugins/data/server/plugin.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-server.DataServerPlugin.setup.$2", + "type": "Object", + "tags": [], + "label": "{\n bfetch,\n expressions,\n usageCollection,\n fieldFormats,\n taskManager,\n security,\n }", + "description": [], + "signature": [ + "DataPluginSetupDependencies" + ], + "path": "src/plugins/data/server/plugin.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { - "plugin": "dataViewEditor", - "path": "src/plugins/data_view_editor/public/lib/extract_time_fields.test.ts" + "parentPluginId": "data", + "id": "def-server.DataServerPlugin.start", + "type": "Function", + "tags": [], + "label": "start", + "description": [], + "signature": [ + "(core: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreStart", + "text": "CoreStart" + }, + ", { fieldFormats, dataViews, taskManager }: ", + "DataPluginStartDependencies", + ") => { datatableUtilities: ", + "DatatableUtilitiesService", + "; search: ", + "ISearchStart", + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IEsSearchRequest", + "text": "IEsSearchRequest" + }, + ", ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IEsSearchResponse", + "text": "IEsSearchResponse" + }, + ">; fieldFormats: ", + { + "pluginId": "fieldFormats", + "scope": "server", + "docId": "kibFieldFormatsPluginApi", + "section": "def-server.FieldFormatsStart", + "text": "FieldFormatsStart" + }, + "; indexPatterns: ", + { + "pluginId": "dataViews", + "scope": "server", + "docId": "kibDataViewsPluginApi", + "section": "def-server.DataViewsServerPluginStart", + "text": "DataViewsServerPluginStart" + }, + "; }" + ], + "path": "src/plugins/data/server/plugin.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.DataServerPlugin.start.$1", + "type": "Object", + "tags": [], + "label": "core", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreStart", + "text": "CoreStart" + } + ], + "path": "src/plugins/data/server/plugin.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-server.DataServerPlugin.start.$2", + "type": "Object", + "tags": [], + "label": "{ fieldFormats, dataViews, taskManager }", + "description": [], + "signature": [ + "DataPluginStartDependencies" + ], + "path": "src/plugins/data/server/plugin.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.test.ts" - }, + "parentPluginId": "data", + "id": "def-server.DataServerPlugin.stop", + "type": "Function", + "tags": [], + "label": "stop", + "description": [], + "signature": [ + "() => void" + ], + "path": "src/plugins/data/server/plugin.ts", + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-server.DataView", + "type": "Class", + "tags": [], + "label": "DataView", + "description": [ + "\nData view class. Central kibana abstraction around multiple indices." + ], + "signature": [ { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.test.ts" + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" }, + " implements ", + "DataViewBase" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [ { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.test.ts" + "parentPluginId": "data", + "id": "def-server.DataView.id", + "type": "string", + "tags": [], + "label": "id", + "description": [ + "\nSaved object id" + ], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false }, { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.test.ts" + "parentPluginId": "data", + "id": "def-server.DataView.title", + "type": "string", + "tags": [], + "label": "title", + "description": [ + "\nTitle of data view" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false }, { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.test.ts" + "parentPluginId": "data", + "id": "def-server.DataView.fieldFormatMap", + "type": "Object", + "tags": [], + "label": "fieldFormatMap", + "description": [ + "\nMap of field formats by field name" + ], + "signature": [ + "{ [x: string]: any; }" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false }, { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.test.ts" + "parentPluginId": "data", + "id": "def-server.DataView.typeMeta", + "type": "Object", + "tags": [], + "label": "typeMeta", + "description": [ + "\nOnly used by rollup indices, used by rollup specific endpoint to load field list." + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.TypeMeta", + "text": "TypeMeta" + }, + " | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false }, { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/fields/data_view_field.test.ts" + "parentPluginId": "data", + "id": "def-server.DataView.fields", + "type": "CompoundType", + "tags": [], + "label": "fields", + "description": [ + "\nField list, in extended array format" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.IIndexPatternFieldList", + "text": "IIndexPatternFieldList" + }, + " & { toSpec: () => ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewFieldMap", + "text": "DataViewFieldMap" + }, + "; }" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false }, { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/fields/data_view_field.test.ts" + "parentPluginId": "data", + "id": "def-server.DataView.timeFieldName", + "type": "string", + "tags": [], + "label": "timeFieldName", + "description": [ + "\nTimestamp field name" + ], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false }, { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/fields/data_view_field.test.ts" + "parentPluginId": "data", + "id": "def-server.DataView.type", + "type": "string", + "tags": [], + "label": "type", + "description": [ + "\nType is used to identify rollup index patterns." + ], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/fields/data_view_field.test.ts" - } - ], - "children": [], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-server.IndexPatternsFetcher", - "type": "Class", - "tags": [], - "label": "IndexPatternsFetcher", - "description": [], - "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", - "deprecated": false, - "children": [ { "parentPluginId": "data", - "id": "def-server.IndexPatternsFetcher.Unnamed", + "id": "def-server.DataView.flattenHit", "type": "Function", - "tags": [], - "label": "Constructor", + "tags": [ + "deprecated" + ], + "label": "flattenHit", "description": [], "signature": [ - "any" + "(hit: Record, deep?: boolean | undefined) => Record" ], - "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", - "deprecated": false, + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": true, + "references": [ + { + "plugin": "dataViews", + "path": "src/plugins/data_views/common/data_views/data_view.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx" + } + ], + "returnComment": [], "children": [ { "parentPluginId": "data", - "id": "def-server.IndexPatternsFetcher.Unnamed.$1", + "id": "def-server.DataView.flattenHit.$1", "type": "Object", "tags": [], - "label": "elasticsearchClient", + "label": "hit", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ElasticsearchClient", - "text": "ElasticsearchClient" - } + "{ [x: string]: any; }" ], - "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", - "deprecated": false, - "isRequired": true + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false }, { "parentPluginId": "data", - "id": "def-server.IndexPatternsFetcher.Unnamed.$2", - "type": "boolean", + "id": "def-server.DataView.flattenHit.$2", + "type": "CompoundType", "tags": [], - "label": "allowNoIndices", + "label": "deep", "description": [], "signature": [ - "boolean" + "boolean | undefined" ], - "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", - "deprecated": false, - "isRequired": true + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false } - ], - "returnComment": [] + ] }, { "parentPluginId": "data", - "id": "def-server.IndexPatternsFetcher.getFieldsForWildcard", - "type": "Function", - "tags": [ - "property", - "property", - "return" - ], - "label": "getFieldsForWildcard", + "id": "def-server.DataView.metaFields", + "type": "Array", + "tags": [], + "label": "metaFields", "description": [ - "\n Get a list of field objects for an index pattern that may contain wildcards\n" + "\nList of meta fields by name" ], "signature": [ - "(options: { pattern: string | string[]; metaFields?: string[] | undefined; fieldCapsOptions?: { allow_no_indices: boolean; } | undefined; type?: string | undefined; rollupIndex?: string | undefined; filter?: ", - "QueryDslQueryContainer", - " | undefined; }) => Promise<", - { - "pluginId": "dataViews", - "scope": "server", - "docId": "kibDataViewsPluginApi", - "section": "def-server.FieldDescriptor", - "text": "FieldDescriptor" - }, - "[]>" + "string[]" ], - "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-server.IndexPatternsFetcher.getFieldsForWildcard.$1", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-server.IndexPatternsFetcher.getFieldsForWildcard.$1.pattern", - "type": "CompoundType", - "tags": [], - "label": "pattern", - "description": [], - "signature": [ - "string | string[]" - ], - "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.IndexPatternsFetcher.getFieldsForWildcard.$1.metaFields", - "type": "Array", - "tags": [], - "label": "metaFields", - "description": [], - "signature": [ - "string[] | undefined" - ], - "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.IndexPatternsFetcher.getFieldsForWildcard.$1.fieldCapsOptions", - "type": "Object", - "tags": [], - "label": "fieldCapsOptions", - "description": [], - "signature": [ - "{ allow_no_indices: boolean; } | undefined" - ], - "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.IndexPatternsFetcher.getFieldsForWildcard.$1.type", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.IndexPatternsFetcher.getFieldsForWildcard.$1.rollupIndex", - "type": "string", - "tags": [], - "label": "rollupIndex", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.IndexPatternsFetcher.getFieldsForWildcard.$1.filter", - "type": "Object", - "tags": [], - "label": "filter", - "description": [], - "signature": [ - "QueryDslQueryContainer", - " | undefined" - ], - "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", - "deprecated": false - } - ] - } + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.DataView.version", + "type": "string", + "tags": [], + "label": "version", + "description": [ + "\nSavedObject version" ], - "returnComment": [] + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false }, { "parentPluginId": "data", - "id": "def-server.IndexPatternsFetcher.getFieldsForTimePattern", - "type": "Function", - "tags": [ - "property", - "property", - "property", - "return" - ], - "label": "getFieldsForTimePattern", + "id": "def-server.DataView.sourceFilters", + "type": "Array", + "tags": [], + "label": "sourceFilters", "description": [ - "\n Get a list of field objects for a time pattern\n" + "\nArray of filters - hides fields in discover" ], "signature": [ - "(options: { pattern: string; metaFields: string[]; lookBack: number; interval: string; }) => Promise<", { "pluginId": "dataViews", - "scope": "server", + "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-server.FieldDescriptor", - "text": "FieldDescriptor" + "section": "def-common.SourceFilter", + "text": "SourceFilter" }, - "[]>" + "[] | undefined" ], - "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-server.IndexPatternsFetcher.getFieldsForTimePattern.$1", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-server.IndexPatternsFetcher.getFieldsForTimePattern.$1.pattern", - "type": "string", - "tags": [], - "label": "pattern", - "description": [], - "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.IndexPatternsFetcher.getFieldsForTimePattern.$1.metaFields", - "type": "Array", - "tags": [], - "label": "metaFields", - "description": [], - "signature": [ - "string[]" - ], - "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.IndexPatternsFetcher.getFieldsForTimePattern.$1.lookBack", - "type": "number", - "tags": [], - "label": "lookBack", - "description": [], - "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.IndexPatternsFetcher.getFieldsForTimePattern.$1.interval", - "type": "string", - "tags": [], - "label": "interval", - "description": [], - "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", - "deprecated": false - } - ] - } + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.DataView.namespaces", + "type": "Array", + "tags": [], + "label": "namespaces", + "description": [ + "\nArray of namespace ids" ], - "returnComment": [] + "signature": [ + "string[]" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false }, { "parentPluginId": "data", - "id": "def-server.IndexPatternsFetcher.validatePatternListActive", - "type": "Function", - "tags": [ - "return" + "id": "def-server.DataView.allowNoIndex", + "type": "boolean", + "tags": [], + "label": "allowNoIndex", + "description": [ + "\nPrevents errors when index pattern exists before indices" ], - "label": "validatePatternListActive", + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.DataView.Unnamed", + "type": "Function", + "tags": [], + "label": "Constructor", "description": [ - "\n Returns an index pattern list of only those index pattern strings in the given list that return indices\n" + "\nconstructor" ], "signature": [ - "(patternList: string[]) => Promise" + "any" ], - "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", + "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": false, "children": [ { "parentPluginId": "data", - "id": "def-server.IndexPatternsFetcher.validatePatternListActive.$1", - "type": "Array", + "id": "def-server.DataView.Unnamed.$1", + "type": "Object", "tags": [], - "label": "patternList", + "label": "config", "description": [ - "string[]" + "- config data and dependencies" ], "signature": [ - "string[]" + "DataViewDeps" ], - "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", + "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-server.IndexPatternsService", - "type": "Class", - "tags": [ - "deprecated" - ], - "label": "IndexPatternsService", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IndexPatternsService", - "text": "IndexPatternsService" - }, - " extends ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewsService", - "text": "DataViewsService" - } - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": true, - "references": [ - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/index.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/server/data_indexing/create_doc_source.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/server/data_indexing/create_doc_source.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/public/index.ts" - } - ], - "children": [], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-server.IndexPatternsService", - "type": "Class", - "tags": [ - "deprecated" - ], - "label": "IndexPatternsService", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IndexPatternsService", - "text": "IndexPatternsService" - }, - " extends ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewsService", - "text": "DataViewsService" - } - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": true, - "references": [ - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/index.ts" }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/server/data_indexing/create_doc_source.ts" + "parentPluginId": "data", + "id": "def-server.DataView.getOriginalSavedObjectBody", + "type": "Function", + "tags": [], + "label": "getOriginalSavedObjectBody", + "description": [ + "\nGet last saved saved object fields" + ], + "signature": [ + "() => { fieldAttrs?: string | undefined; title?: string | undefined; timeFieldName?: string | undefined; fields?: string | undefined; sourceFilters?: string | undefined; fieldFormatMap?: string | undefined; typeMeta?: string | undefined; type?: string | undefined; }" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/server/data_indexing/create_doc_source.ts" + "parentPluginId": "data", + "id": "def-server.DataView.resetOriginalSavedObjectBody", + "type": "Function", + "tags": [], + "label": "resetOriginalSavedObjectBody", + "description": [ + "\nReset last saved saved object fields. Used after saving." + ], + "signature": [ + "() => void" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { - "plugin": "dataViews", - "path": "src/plugins/data_views/public/index.ts" - } - ], - "children": [], - "initialIsOpen": false - } - ], - "functions": [ - { - "parentPluginId": "data", - "id": "def-server.getCapabilitiesForRollupIndices", - "type": "Function", - "tags": [], - "label": "getCapabilitiesForRollupIndices", - "description": [], - "signature": [ - "(indices: Record) => { [key: string]: any; }" - ], - "path": "src/plugins/data_views/server/fetcher/lib/map_capabilities.ts", - "deprecated": false, - "children": [ + "parentPluginId": "data", + "id": "def-server.DataView.getFieldAttrs", + "type": "Function", + "tags": [], + "label": "getFieldAttrs", + "description": [ + "\nReturns field attributes map" + ], + "signature": [ + "() => { [x: string]: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldAttrSet", + "text": "FieldAttrSet" + }, + "; }" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, { "parentPluginId": "data", - "id": "def-server.getCapabilitiesForRollupIndices.$1", - "type": "Object", + "id": "def-server.DataView.getComputedFields", + "type": "Function", "tags": [], - "label": "indices", - "description": [], + "label": "getComputedFields", + "description": [ + "\nReturns scripted fields" + ], "signature": [ - "Record" + "() => { storedFields: string[]; scriptFields: Record; docvalueFields: { field: string; format: string; }[]; runtimeFields: ", + "MappingRuntimeFields", + "; }" ], - "path": "src/plugins/data_views/server/fetcher/lib/map_capabilities.ts", + "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-server.getEsQueryConfig", - "type": "Function", - "tags": [], - "label": "getEsQueryConfig", - "description": [], - "signature": [ - "(config: KibanaConfig) => ", - "EsQueryConfig" - ], - "path": "src/plugins/data/common/es_query/get_es_query_config.ts", - "deprecated": false, - "children": [ + "children": [], + "returnComment": [] + }, { "parentPluginId": "data", - "id": "def-server.getEsQueryConfig.$1", - "type": "Object", + "id": "def-server.DataView.toSpec", + "type": "Function", "tags": [], - "label": "config", - "description": [], + "label": "toSpec", + "description": [ + "\nCreates static representation of the data view." + ], "signature": [ - "KibanaConfig" + "() => ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewSpec", + "text": "DataViewSpec" + } ], - "path": "src/plugins/data/common/es_query/get_es_query_config.ts", + "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-server.getRequestAbortedSignal", - "type": "Function", - "tags": [], - "label": "getRequestAbortedSignal", - "description": [ - "\nA simple utility function that returns an `AbortSignal` corresponding to an `AbortController`\nwhich aborts when the given request is aborted." - ], - "signature": [ - "(aborted$: ", - "Observable", - ") => AbortSignal" - ], - "path": "src/plugins/data/server/lib/get_request_aborted_signal.ts", - "deprecated": false, - "children": [ + "children": [], + "returnComment": [] + }, { "parentPluginId": "data", - "id": "def-server.getRequestAbortedSignal.$1", - "type": "Object", + "id": "def-server.DataView.getSourceFiltering", + "type": "Function", "tags": [], - "label": "aborted$", + "label": "getSourceFiltering", "description": [ - "The observable of abort events (usually `request.events.aborted$`)" + "\nGet the source filtering configuration for that index." ], "signature": [ - "Observable", - "" + "() => { excludes: string[]; }" ], - "path": "src/plugins/data/server/lib/get_request_aborted_signal.ts", + "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-server.getTime", - "type": "Function", - "tags": [], - "label": "getTime", - "description": [], - "signature": [ - "(indexPattern: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IIndexPattern", - "text": "IIndexPattern" + "children": [], + "returnComment": [] }, - " | undefined, timeRange: ", { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" + "parentPluginId": "data", + "id": "def-server.DataView.removeScriptedField", + "type": "Function", + "tags": [ + "deprecated" + ], + "label": "removeScriptedField", + "description": [ + "\nRemoves scripted field from field list." + ], + "signature": [ + "(fieldName: string) => void" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": true, + "references": [ + { + "plugin": "dataViewManagement", + "path": "src/plugins/data_view_management/public/components/edit_index_pattern/scripted_fields_table/scripted_fields_table.tsx" + }, + { + "plugin": "dataViewManagement", + "path": "src/plugins/data_view_management/public/components/field_editor/field_editor.tsx" + }, + { + "plugin": "dataViews", + "path": "src/plugins/data_views/common/data_views/data_view.test.ts" + } + ], + "children": [ + { + "parentPluginId": "data", + "id": "def-server.DataView.removeScriptedField.$1", + "type": "string", + "tags": [], + "label": "fieldName", + "description": [ + "name of scripted field to remove" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "data", + "id": "def-server.DataView.getNonScriptedFields", + "type": "Function", + "tags": [ + "deprecated" + ], + "label": "getNonScriptedFields", + "description": [ + "\n" + ], + "signature": [ + "() => ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewField", + "text": "DataViewField" + }, + "[]" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": true, + "references": [ + { + "plugin": "visTypeTimeseries", + "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/abstract_search_strategy.ts" + }, + { + "plugin": "graph", + "path": "x-pack/plugins/graph/public/services/persistence/deserialize.ts" + }, + { + "plugin": "graph", + "path": "x-pack/plugins/graph/public/state_management/datasource.test.ts" + }, + { + "plugin": "graph", + "path": "x-pack/plugins/graph/public/services/persistence/deserialize.test.ts" + }, + { + "plugin": "graph", + "path": "x-pack/plugins/graph/public/services/persistence/deserialize.test.ts" + }, + { + "plugin": "dataViewManagement", + "path": "src/plugins/data_view_management/public/components/edit_index_pattern/source_filters_table/components/table/table.tsx" + }, + { + "plugin": "dataViewManagement", + "path": "src/plugins/data_view_management/public/components/edit_index_pattern/edit_index_pattern.tsx" + }, + { + "plugin": "dataViewManagement", + "path": "src/plugins/data_view_management/public/components/edit_index_pattern/edit_index_pattern.tsx" + }, + { + "plugin": "dataViewManagement", + "path": "src/plugins/data_view_management/public/components/edit_index_pattern/edit_index_pattern.tsx" + }, + { + "plugin": "dataViews", + "path": "src/plugins/data_views/common/data_views/data_view.test.ts" + }, + { + "plugin": "visTypeTimeseries", + "path": "src/plugins/vis_types/timeseries/public/application/lib/fetch_fields.ts" + } + ], + "children": [], + "returnComment": [] }, - ", options: { forceNow?: Date | undefined; fieldName?: string | undefined; } | undefined) => ", - "RangeFilter", - " | ", - "ScriptedRangeFilter", - " | MatchAllRangeFilter | undefined" - ], - "path": "src/plugins/data/common/query/timefilter/get_time.ts", - "deprecated": false, - "children": [ { "parentPluginId": "data", - "id": "def-server.getTime.$1", - "type": "Object", - "tags": [], - "label": "indexPattern", - "description": [], + "id": "def-server.DataView.getScriptedFields", + "type": "Function", + "tags": [ + "deprecated" + ], + "label": "getScriptedFields", + "description": [ + "\n" + ], "signature": [ + "() => ", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.IIndexPattern", - "text": "IIndexPattern" + "section": "def-common.DataViewField", + "text": "DataViewField" }, - " | undefined" + "[]" ], - "path": "src/plugins/data/common/query/timefilter/get_time.ts", - "deprecated": false, - "isRequired": false - }, - { - "parentPluginId": "data", - "id": "def-server.getTime.$2", - "type": "Object", - "tags": [], - "label": "timeRange", - "description": [], - "signature": [ + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": true, + "references": [ { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - } - ], - "path": "src/plugins/data/common/query/timefilter/get_time.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "data", - "id": "def-server.getTime.$3", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "path": "src/plugins/data/common/query/timefilter/get_time.ts", - "deprecated": false, - "children": [ + "plugin": "dataViews", + "path": "src/plugins/data_views/common/data_views/data_view.ts" + }, { - "parentPluginId": "data", - "id": "def-server.getTime.$3.forceNow", - "type": "Object", - "tags": [], - "label": "forceNow", - "description": [], - "signature": [ - "Date | undefined" - ], - "path": "src/plugins/data/common/query/timefilter/get_time.ts", - "deprecated": false + "plugin": "dataViews", + "path": "src/plugins/data_views/common/data_views/data_view.ts" }, { - "parentPluginId": "data", - "id": "def-server.getTime.$3.fieldName", - "type": "string", - "tags": [], - "label": "fieldName", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/data/common/query/timefilter/get_time.ts", - "deprecated": false + "plugin": "dataViews", + "path": "src/plugins/data_views/common/data_views/data_views.ts" + }, + { + "plugin": "dataViews", + "path": "src/plugins/data_views/server/register_index_pattern_usage_collection.ts" + }, + { + "plugin": "dataViewManagement", + "path": "src/plugins/data_view_management/public/components/edit_index_pattern/scripted_fields_table/scripted_fields_table.tsx" + }, + { + "plugin": "dataViews", + "path": "src/plugins/data_views/common/data_views/data_view.test.ts" + }, + { + "plugin": "dataViews", + "path": "src/plugins/data_views/common/data_views/data_view.test.ts" + }, + { + "plugin": "dataViews", + "path": "src/plugins/data_views/common/data_views/data_view.test.ts" + }, + { + "plugin": "dataViews", + "path": "src/plugins/data_views/common/data_views/data_view.test.ts" + }, + { + "plugin": "dataViews", + "path": "src/plugins/data_views/common/data_views/data_view.test.ts" } - ] - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-server.parseInterval", - "type": "Function", - "tags": [], - "label": "parseInterval", - "description": [], - "signature": [ - "(interval: string) => moment.Duration | null" - ], - "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_interval.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-server.parseInterval.$1", - "type": "string", - "tags": [], - "label": "interval", - "description": [], - "signature": [ - "string" ], - "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_interval.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-server.shouldReadFieldFromDocValues", - "type": "Function", - "tags": [], - "label": "shouldReadFieldFromDocValues", - "description": [], - "signature": [ - "(aggregatable: boolean, esType: string) => boolean" - ], - "path": "src/plugins/data_views/server/fetcher/lib/field_capabilities/should_read_field_from_doc_values.ts", - "deprecated": false, - "children": [ + "children": [], + "returnComment": [] + }, { "parentPluginId": "data", - "id": "def-server.shouldReadFieldFromDocValues.$1", - "type": "boolean", + "id": "def-server.DataView.isTimeBased", + "type": "Function", "tags": [], - "label": "aggregatable", - "description": [], + "label": "isTimeBased", + "description": [ + "\nDoes the data view have a timestamp field?" + ], "signature": [ - "boolean" + "() => this is ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.TimeBasedDataView", + "text": "TimeBasedDataView" + } ], - "path": "src/plugins/data_views/server/fetcher/lib/field_capabilities/should_read_field_from_doc_values.ts", + "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": false, - "isRequired": true + "children": [], + "returnComment": [] }, { "parentPluginId": "data", - "id": "def-server.shouldReadFieldFromDocValues.$2", - "type": "string", + "id": "def-server.DataView.isTimeNanosBased", + "type": "Function", "tags": [], - "label": "esType", - "description": [], + "label": "isTimeNanosBased", + "description": [ + "\nDoes the data view have a timestamp field and is it a date nanos field?" + ], "signature": [ - "string" + "() => this is ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.TimeBasedDataView", + "text": "TimeBasedDataView" + } ], - "path": "src/plugins/data_views/server/fetcher/lib/field_capabilities/should_read_field_from_doc_values.ts", + "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - } - ], - "interfaces": [ - { - "parentPluginId": "data", - "id": "def-server.FieldDescriptor", - "type": "Interface", - "tags": [], - "label": "FieldDescriptor", - "description": [], - "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-server.FieldDescriptor.aggregatable", - "type": "boolean", - "tags": [], - "label": "aggregatable", - "description": [], - "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.FieldDescriptor.name", - "type": "string", - "tags": [], - "label": "name", - "description": [], - "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", - "deprecated": false + "children": [], + "returnComment": [] }, { "parentPluginId": "data", - "id": "def-server.FieldDescriptor.readFromDocValues", - "type": "boolean", + "id": "def-server.DataView.getTimeField", + "type": "Function", "tags": [], - "label": "readFromDocValues", - "description": [], - "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", - "deprecated": false + "label": "getTimeField", + "description": [ + "\nGet timestamp field as DataViewField or return undefined" + ], + "signature": [ + "() => ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewField", + "text": "DataViewField" + }, + " | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "data", - "id": "def-server.FieldDescriptor.searchable", - "type": "boolean", + "id": "def-server.DataView.getFieldByName", + "type": "Function", "tags": [], - "label": "searchable", - "description": [], - "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", - "deprecated": false + "label": "getFieldByName", + "description": [ + "\nGet field by name." + ], + "signature": [ + "(name: string) => ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewField", + "text": "DataViewField" + }, + " | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.DataView.getFieldByName.$1", + "type": "string", + "tags": [], + "label": "name", + "description": [ + "field name" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "data", - "id": "def-server.FieldDescriptor.type", - "type": "string", + "id": "def-server.DataView.getAggregationRestrictions", + "type": "Function", "tags": [], - "label": "type", - "description": [], - "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", - "deprecated": false + "label": "getAggregationRestrictions", + "description": [ + "\nGet aggregation restrictions. Rollup fields can only perform a subset of aggregations." + ], + "signature": [ + "() => Record | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "data", - "id": "def-server.FieldDescriptor.esTypes", - "type": "Array", + "id": "def-server.DataView.getAsSavedObjectBody", + "type": "Function", "tags": [], - "label": "esTypes", - "description": [], + "label": "getAsSavedObjectBody", + "description": [ + "\nReturns index pattern as saved object body for saving" + ], "signature": [ - "string[]" + "() => ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewAttributes", + "text": "DataViewAttributes" + } ], - "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", - "deprecated": false + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "data", - "id": "def-server.FieldDescriptor.subType", - "type": "Object", + "id": "def-server.DataView.getFormatterForField", + "type": "Function", "tags": [], - "label": "subType", - "description": [], + "label": "getFormatterForField", + "description": [ + "\nProvide a field, get its formatter" + ], "signature": [ - "FieldSubType | undefined" + "(field: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewField", + "text": "DataViewField" + }, + " | ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + ") => ", + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.FieldFormat", + "text": "FieldFormat" + } ], - "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", - "deprecated": false + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.DataView.getFormatterForField.$1", + "type": "CompoundType", + "tags": [], + "label": "field", + "description": [ + "field to get formatter for" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewField", + "text": "DataViewField" + }, + " | ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + } + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "data", - "id": "def-server.FieldDescriptor.metadata_field", - "type": "CompoundType", + "id": "def-server.DataView.addRuntimeField", + "type": "Function", "tags": [], - "label": "metadata_field", - "description": [], + "label": "addRuntimeField", + "description": [ + "\nAdd a runtime field - Appended to existing mapped field or a new field is\ncreated as appropriate." + ], "signature": [ - "boolean | undefined" + "(name: string, runtimeField: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.RuntimeField", + "text": "RuntimeField" + }, + ") => ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewField", + "text": "DataViewField" + }, + "[]" ], - "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-server.IEsSearchRequest", - "type": "Interface", - "tags": [], - "label": "IEsSearchRequest", - "description": [], - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.IEsSearchRequest", - "text": "IEsSearchRequest" - }, - " extends ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.IKibanaSearchRequest", - "text": "IKibanaSearchRequest" - }, - "<", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.ISearchRequestParams", - "text": "ISearchRequestParams" + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.DataView.addRuntimeField.$1", + "type": "string", + "tags": [], + "label": "name", + "description": [ + "Field name" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-server.DataView.addRuntimeField.$2", + "type": "Object", + "tags": [], + "label": "runtimeField", + "description": [ + "Runtime field definition" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.RuntimeField", + "text": "RuntimeField" + } + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, - ">" - ], - "path": "src/plugins/data/common/search/strategies/es_search/types.ts", - "deprecated": false, - "children": [ { "parentPluginId": "data", - "id": "def-server.IEsSearchRequest.indexType", - "type": "string", + "id": "def-server.DataView.hasRuntimeField", + "type": "Function", "tags": [], - "label": "indexType", - "description": [], + "label": "hasRuntimeField", + "description": [ + "\nChecks if runtime field exists" + ], "signature": [ - "string | undefined" + "(name: string) => boolean" ], - "path": "src/plugins/data/common/search/strategies/es_search/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-server.ISearchOptions", - "type": "Interface", - "tags": [], - "label": "ISearchOptions", - "description": [], - "path": "src/plugins/data/common/search/types.ts", - "deprecated": false, - "children": [ + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.DataView.hasRuntimeField.$1", + "type": "string", + "tags": [], + "label": "name", + "description": [ + "field name" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, { "parentPluginId": "data", - "id": "def-server.ISearchOptions.abortSignal", - "type": "Object", + "id": "def-server.DataView.getRuntimeField", + "type": "Function", "tags": [], - "label": "abortSignal", + "label": "getRuntimeField", "description": [ - "\nAn `AbortSignal` that allows the caller of `search` to abort a search request." + "\nReturns runtime field if exists" ], "signature": [ - "AbortSignal | undefined" + "(name: string) => ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.RuntimeField", + "text": "RuntimeField" + }, + " | null" ], - "path": "src/plugins/data/common/search/types.ts", - "deprecated": false + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.DataView.getRuntimeField.$1", + "type": "string", + "tags": [], + "label": "name", + "description": [ + "Runtime field name" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "data", - "id": "def-server.ISearchOptions.strategy", - "type": "string", + "id": "def-server.DataView.getAllRuntimeFields", + "type": "Function", "tags": [], - "label": "strategy", + "label": "getAllRuntimeFields", "description": [ - "\nUse this option to force using a specific server side search strategy. Leave empty to use the default strategy." + "\nGet all runtime field definitions." ], "signature": [ - "string | undefined" + "() => Record" ], - "path": "src/plugins/data/common/search/types.ts", - "deprecated": false + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [], + "returnComment": [ + "map of runtime field definitions by field name" + ] }, { "parentPluginId": "data", - "id": "def-server.ISearchOptions.legacyHitsTotal", - "type": "CompoundType", + "id": "def-server.DataView.getFieldsByRuntimeFieldName", + "type": "Function", "tags": [], - "label": "legacyHitsTotal", + "label": "getFieldsByRuntimeFieldName", "description": [ - "\nRequest the legacy format for the total number of hits. If sending `rest_total_hits_as_int` to\nsomething other than `true`, this should be set to `false`." + "\nReturns data view fields backed by runtime fields." ], "signature": [ - "boolean | undefined" + "(name: string) => Record | undefined" ], - "path": "src/plugins/data/common/search/types.ts", - "deprecated": false + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.DataView.getFieldsByRuntimeFieldName.$1", + "type": "string", + "tags": [], + "label": "name", + "description": [ + "runtime field name" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [ + "map of DataViewFields (that are runtime fields) by field name" + ] }, { "parentPluginId": "data", - "id": "def-server.ISearchOptions.sessionId", - "type": "string", + "id": "def-server.DataView.replaceAllRuntimeFields", + "type": "Function", "tags": [], - "label": "sessionId", + "label": "replaceAllRuntimeFields", "description": [ - "\nA session ID, grouping multiple search requests into a single session." + "\nReplaces all existing runtime fields with new fields." ], "signature": [ - "string | undefined" + "(newFields: Record) => void" ], - "path": "src/plugins/data/common/search/types.ts", - "deprecated": false + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.DataView.replaceAllRuntimeFields.$1", + "type": "Object", + "tags": [], + "label": "newFields", + "description": [ + "Map of runtime field definitions by field name" + ], + "signature": [ + "Record" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "data", - "id": "def-server.ISearchOptions.isStored", - "type": "CompoundType", + "id": "def-server.DataView.removeRuntimeField", + "type": "Function", "tags": [], - "label": "isStored", + "label": "removeRuntimeField", "description": [ - "\nWhether the session is already saved (i.e. sent to background)" + "\nRemove a runtime field - removed from mapped field or removed unmapped\nfield as appropriate. Doesn't clear associated field attributes." ], "signature": [ - "boolean | undefined" + "(name: string) => void" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.DataView.removeRuntimeField.$1", + "type": "string", + "tags": [], + "label": "name", + "description": [ + "- Field name to remove" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + } ], - "path": "src/plugins/data/common/search/types.ts", - "deprecated": false + "returnComment": [] }, { "parentPluginId": "data", - "id": "def-server.ISearchOptions.isRestore", - "type": "CompoundType", + "id": "def-server.DataView.getRuntimeMappings", + "type": "Function", "tags": [], - "label": "isRestore", + "label": "getRuntimeMappings", "description": [ - "\nWhether the session is restored (i.e. search requests should re-use the stored search IDs,\nrather than starting from scratch)" + "\nReturn the \"runtime_mappings\" section of the ES search query." ], "signature": [ - "boolean | undefined" + "() => ", + "MappingRuntimeFields" ], - "path": "src/plugins/data/common/search/types.ts", - "deprecated": false + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "data", - "id": "def-server.ISearchOptions.indexPattern", - "type": "Object", + "id": "def-server.DataView.getFormatterForFieldNoDefault", + "type": "Function", "tags": [], - "label": "indexPattern", + "label": "getFormatterForFieldNoDefault", "description": [ - "\nIndex pattern reference is used for better error messages" + "\nGet formatter for a given field name. Return undefined if none exists." ], "signature": [ + "(fieldname: string) => ", { - "pluginId": "dataViews", + "pluginId": "fieldFormats", "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.FieldFormat", + "text": "FieldFormat" }, " | undefined" ], - "path": "src/plugins/data/common/search/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.ISearchOptions.inspector", - "type": "Object", - "tags": [], - "label": "inspector", - "description": [ - "\nInspector integration options" - ], - "signature": [ + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [ { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.IInspectorInfo", - "text": "IInspectorInfo" - }, - " | undefined" - ], - "path": "src/plugins/data/common/search/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.ISearchOptions.executionContext", - "type": "Object", - "tags": [], - "label": "executionContext", - "description": [], - "signature": [ - "KibanaExecutionContext", - " | undefined" - ], - "path": "src/plugins/data/common/search/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - } - ], - "enums": [ - { - "parentPluginId": "data", - "id": "def-server.ES_FIELD_TYPES", - "type": "Enum", - "tags": [], - "label": "ES_FIELD_TYPES", - "description": [], - "path": "node_modules/@types/kbn__field-types/index.d.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-server.KBN_FIELD_TYPES", - "type": "Enum", - "tags": [], - "label": "KBN_FIELD_TYPES", - "description": [], - "path": "node_modules/@types/kbn__field-types/index.d.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-server.METRIC_TYPES", - "type": "Enum", - "tags": [], - "label": "METRIC_TYPES", - "description": [], - "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_types.ts", - "deprecated": false, - "initialIsOpen": false - } - ], - "misc": [ - { - "parentPluginId": "data", - "id": "def-server.DATA_VIEW_SAVED_OBJECT_TYPE", - "type": "string", - "tags": [], - "label": "DATA_VIEW_SAVED_OBJECT_TYPE", - "description": [], - "signature": [ - "\"index-pattern\"" - ], - "path": "src/plugins/data_views/common/constants.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-server.DEFAULT_QUERY_LANGUAGE", - "type": "string", - "tags": [], - "label": "DEFAULT_QUERY_LANGUAGE", - "description": [], - "signature": [ - "\"kuery\"" - ], - "path": "src/plugins/data/common/constants.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-server.ES_SEARCH_STRATEGY", - "type": "string", - "tags": [], - "label": "ES_SEARCH_STRATEGY", - "description": [], - "signature": [ - "\"es\"" - ], - "path": "src/plugins/data/common/search/strategies/es_search/types.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-server.EsQueryConfig", - "type": "Type", - "tags": [ - "deprecated" - ], - "label": "EsQueryConfig", - "description": [], - "signature": [ - "KueryQueryOptions", - " & { allowLeadingWildcards: boolean; queryStringOptions: ", - "SerializableRecord", - "; ignoreFilterIfFieldNotInIndex: boolean; }" - ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-server.Filter", - "type": "Type", - "tags": [ - "deprecated" - ], - "label": "Filter", - "description": [], - "signature": [ - "{ $state?: { store: ", - "FilterStateStore", - "; } | undefined; meta: ", - "FilterMeta", - "; query?: Record | undefined; }" - ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [ - { - "plugin": "discover", - "path": "src/plugins/discover/public/application/view_alert/view_alert_route.tsx" - }, - { - "plugin": "discover", - "path": "src/plugins/discover/public/application/view_alert/view_alert_route.tsx" - }, - { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/lib/filter_utils.ts" - }, - { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/lib/filter_utils.ts" - }, - { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/lib/filter_utils.ts" - }, - { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/lib/filter_utils.ts" - }, - { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/lib/filter_utils.ts" - }, - { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts" - }, - { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts" - }, - { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/state/dashboard_state_slice.ts" - }, - { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/state/dashboard_state_slice.ts" - }, - { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/state/dashboard_state_slice.ts" - }, - { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/lib/sync_dashboard_filter_state.ts" + "parentPluginId": "data", + "id": "def-server.DataView.getFormatterForFieldNoDefault.$1", + "type": "string", + "tags": [], + "label": "fieldname", + "description": [ + "name of field to get formatter for" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/lib/sync_dashboard_filter_state.ts" + "parentPluginId": "data", + "id": "def-server.DataView.setFieldAttrs", + "type": "Function", + "tags": [], + "label": "setFieldAttrs", + "description": [ + "\nSet field attribute" + ], + "signature": [ + "(fieldName: string, attrName: K, value: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldAttrSet", + "text": "FieldAttrSet" + }, + "[K]) => void" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.DataView.setFieldAttrs.$1", + "type": "string", + "tags": [], + "label": "fieldName", + "description": [ + "name of field to set attribute on" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-server.DataView.setFieldAttrs.$2", + "type": "Uncategorized", + "tags": [], + "label": "attrName", + "description": [ + "name of attribute to set" + ], + "signature": [ + "K" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-server.DataView.setFieldAttrs.$3", + "type": "Uncategorized", + "tags": [], + "label": "value", + "description": [ + "value of attribute" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldAttrSet", + "text": "FieldAttrSet" + }, + "[K]" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/lib/sync_dashboard_filter_state.ts" + "parentPluginId": "data", + "id": "def-server.DataView.setFieldCustomLabel", + "type": "Function", + "tags": [], + "label": "setFieldCustomLabel", + "description": [ + "\nSet field custom label" + ], + "signature": [ + "(fieldName: string, customLabel: string | null | undefined) => void" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.DataView.setFieldCustomLabel.$1", + "type": "string", + "tags": [], + "label": "fieldName", + "description": [ + "name of field to set custom label on" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-server.DataView.setFieldCustomLabel.$2", + "type": "CompoundType", + "tags": [], + "label": "customLabel", + "description": [ + "custom label value. If undefined, custom label is removed" + ], + "signature": [ + "string | null | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] }, { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx" + "parentPluginId": "data", + "id": "def-server.DataView.setFieldCount", + "type": "Function", + "tags": [], + "label": "setFieldCount", + "description": [ + "\nSet field count" + ], + "signature": [ + "(fieldName: string, count: number | null | undefined) => void" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.DataView.setFieldCount.$1", + "type": "string", + "tags": [], + "label": "fieldName", + "description": [ + "name of field to set count on" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-server.DataView.setFieldCount.$2", + "type": "CompoundType", + "tags": [], + "label": "count", + "description": [ + "count value. If undefined, count is removed" + ], + "signature": [ + "number | null | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] }, { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx" + "parentPluginId": "data", + "id": "def-server.DataView.setFieldFormat", + "type": "Function", + "tags": [], + "label": "setFieldFormat", + "description": [ + "\nSet field formatter" + ], + "signature": [ + "(fieldName: string, format: ", + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.SerializedFieldFormat", + "text": "SerializedFieldFormat" + }, + "<", + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.FieldFormatParams", + "text": "FieldFormatParams" + }, + ">) => void" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.DataView.setFieldFormat.$1", + "type": "string", + "tags": [], + "label": "fieldName", + "description": [ + "name of field to set format on" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-server.DataView.setFieldFormat.$2", + "type": "Object", + "tags": [], + "label": "format", + "description": [ + "field format in serialized form" + ], + "signature": [ + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.SerializedFieldFormat", + "text": "SerializedFieldFormat" + }, + "<", + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.FieldFormatParams", + "text": "FieldFormatParams" + }, + ">" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/trigger_actions/open_in_discover_drilldown.tsx" - }, + "parentPluginId": "data", + "id": "def-server.DataView.deleteFieldFormat", + "type": "Function", + "tags": [], + "label": "deleteFieldFormat", + "description": [ + "\nRemove field format from the field format map." + ], + "signature": [ + "(fieldName: string) => void" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.DataView.deleteFieldFormat.$1", + "type": "string", + "tags": [], + "label": "fieldName", + "description": [ + "field name associated with the format for removal" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-server.DataViewsService", + "type": "Class", + "tags": [], + "label": "DataViewsService", + "description": [ + "\nData views service, providing CRUD operations for data views." + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/trigger_actions/open_in_discover_drilldown.tsx" + "parentPluginId": "data", + "id": "def-server.DataViewsService.getCanSave", + "type": "Function", + "tags": [], + "label": "getCanSave", + "description": [ + "\nCan the user save data views?" + ], + "signature": [ + "() => Promise" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "returnComment": [], + "children": [] }, { - "plugin": "urlDrilldown", - "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/variables/context_variables.ts" + "parentPluginId": "data", + "id": "def-server.DataViewsService.Unnamed", + "type": "Function", + "tags": [], + "label": "Constructor", + "description": [ + "\nDataViewsService constructor" + ], + "signature": [ + "any" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.DataViewsService.Unnamed.$1", + "type": "Object", + "tags": [], + "label": "deps", + "description": [ + "Service dependencies" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewsServiceDeps", + "text": "DataViewsServiceDeps" + } + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { - "plugin": "urlDrilldown", - "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/variables/context_variables.ts" + "parentPluginId": "data", + "id": "def-server.DataViewsService.getIds", + "type": "Function", + "tags": [], + "label": "getIds", + "description": [ + "\nGets list of index pattern ids." + ], + "signature": [ + "(refresh?: boolean) => Promise" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.DataViewsService.getIds.$1", + "type": "boolean", + "tags": [], + "label": "refresh", + "description": [ + "Force refresh of index pattern list" + ], + "signature": [ + "boolean" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { - "plugin": "urlDrilldown", - "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/url_drilldown.tsx" + "parentPluginId": "data", + "id": "def-server.DataViewsService.getTitles", + "type": "Function", + "tags": [], + "label": "getTitles", + "description": [ + "\nGets list of index pattern titles." + ], + "signature": [ + "(refresh?: boolean) => Promise" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.DataViewsService.getTitles.$1", + "type": "boolean", + "tags": [], + "label": "refresh", + "description": [ + "Force refresh of index pattern list" + ], + "signature": [ + "boolean" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { - "plugin": "urlDrilldown", - "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/url_drilldown.tsx" + "parentPluginId": "data", + "id": "def-server.DataViewsService.find", + "type": "Function", + "tags": [], + "label": "find", + "description": [ + "\nFind and load index patterns by title." + ], + "signature": [ + "(search: string, size?: number) => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + "[]>" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.DataViewsService.find.$1", + "type": "string", + "tags": [], + "label": "search", + "description": [ + "Search string" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-server.DataViewsService.find.$2", + "type": "number", + "tags": [], + "label": "size", + "description": [ + "Number of data views to return" + ], + "signature": [ + "number" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [ + "DataView[]" + ] }, { - "plugin": "urlDrilldown", - "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/test/data.ts" + "parentPluginId": "data", + "id": "def-server.DataViewsService.getIdsWithTitle", + "type": "Function", + "tags": [], + "label": "getIdsWithTitle", + "description": [ + "\nGets list of index pattern ids with titles." + ], + "signature": [ + "(refresh?: boolean) => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewListItem", + "text": "DataViewListItem" + }, + "[]>" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.DataViewsService.getIdsWithTitle.$1", + "type": "boolean", + "tags": [], + "label": "refresh", + "description": [ + "Force refresh of index pattern list" + ], + "signature": [ + "boolean" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { - "plugin": "urlDrilldown", - "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/test/data.ts" - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-server.IEsSearchResponse", - "type": "Type", - "tags": [], - "label": "IEsSearchResponse", - "description": [], - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.IKibanaSearchResponse", - "text": "IKibanaSearchResponse" + "parentPluginId": "data", + "id": "def-server.DataViewsService.clearCache", + "type": "Function", + "tags": [], + "label": "clearCache", + "description": [ + "\nClear index pattern list cache." + ], + "signature": [ + "(id?: string | undefined) => void" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.DataViewsService.clearCache.$1", + "type": "string", + "tags": [], + "label": "id", + "description": [ + "optionally clear a single id" + ], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] }, - "<", - "SearchResponse", - ">>" - ], - "path": "src/plugins/data/common/search/strategies/es_search/types.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-server.IndexPatternAttributes", - "type": "Type", - "tags": [ - "deprecated" - ], - "label": "IndexPatternAttributes", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewAttributes", - "text": "DataViewAttributes" - } - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": true, - "references": [ { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/index.ts" + "parentPluginId": "data", + "id": "def-server.DataViewsService.getCache", + "type": "Function", + "tags": [], + "label": "getCache", + "description": [ + "\nGet cache, contains data view saved objects." + ], + "signature": [ + "() => Promise<", + "SavedObject", + "<", + "DataViewSavedObjectAttrs", + ">[] | null | undefined>" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { - "plugin": "canvas", - "path": "x-pack/plugins/canvas/public/lib/es_service.ts" + "parentPluginId": "data", + "id": "def-server.DataViewsService.getDefault", + "type": "Function", + "tags": [], + "label": "getDefault", + "description": [ + "\nGet default index pattern" + ], + "signature": [ + "() => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + " | null>" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { - "plugin": "canvas", - "path": "x-pack/plugins/canvas/public/lib/es_service.ts" + "parentPluginId": "data", + "id": "def-server.DataViewsService.getDefaultId", + "type": "Function", + "tags": [], + "label": "getDefaultId", + "description": [ + "\nGet default index pattern id" + ], + "signature": [ + "() => Promise" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { - "plugin": "canvas", - "path": "x-pack/plugins/canvas/public/lib/es_service.ts" - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-server.IndexPatternsServiceStart", - "type": "Type", - "tags": [], - "label": "IndexPatternsServiceStart", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "server", - "docId": "kibDataViewsPluginApi", - "section": "def-server.DataViewsServerPluginStart", - "text": "DataViewsServerPluginStart" - } - ], - "path": "src/plugins/data_views/server/types.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-server.KueryNode", - "type": "Type", - "tags": [ - "deprecated" - ], - "label": "KueryNode", - "description": [], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-server.ParsedInterval", - "type": "Type", - "tags": [], - "label": "ParsedInterval", - "description": [], - "signature": [ - "{ value: number; unit: ", - "Unit", - "; type: \"calendar\" | \"fixed\"; }" - ], - "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_es_interval.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-server.Query", - "type": "Type", - "tags": [], - "label": "Query", - "description": [], - "signature": [ - "{ query: string | { [key: string]: any; }; language: string; }" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-server.TimeRange", - "type": "Type", - "tags": [], - "label": "TimeRange", - "description": [], - "signature": [ - "{ from: string; to: string; mode?: \"absolute\" | \"relative\" | undefined; }" - ], - "path": "src/plugins/data/common/query/timefilter/types.ts", - "deprecated": false, - "initialIsOpen": false - } - ], - "objects": [ - { - "parentPluginId": "data", - "id": "def-server.esFilters", - "type": "Object", - "tags": [], - "label": "esFilters", - "description": [], - "path": "src/plugins/data/server/deprecated.ts", - "deprecated": false, - "children": [ + "parentPluginId": "data", + "id": "def-server.DataViewsService.setDefault", + "type": "Function", + "tags": [], + "label": "setDefault", + "description": [ + "\nOptionally set default index pattern, unless force = true" + ], + "signature": [ + "(id: string | null, force?: boolean) => Promise" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.DataViewsService.setDefault.$1", + "type": "CompoundType", + "tags": [], + "label": "id", + "description": [ + "data view id" + ], + "signature": [ + "string | null" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": false + }, + { + "parentPluginId": "data", + "id": "def-server.DataViewsService.setDefault.$2", + "type": "boolean", + "tags": [], + "label": "force", + "description": [ + "set default data view even if there's an existing default" + ], + "signature": [ + "boolean" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, { "parentPluginId": "data", - "id": "def-server.esFilters.buildQueryFilter", + "id": "def-server.DataViewsService.hasUserDataView", "type": "Function", "tags": [], - "label": "buildQueryFilter", - "description": [], + "label": "hasUserDataView", + "description": [ + "\nChecks if current user has a user created index pattern ignoring fleet's server default index patterns." + ], "signature": [ - "(query: (Record & { query_string?: { query: string; fields?: string[] | undefined; } | undefined; }) | undefined, index: string, alias?: string | undefined, meta?: ", - "FilterMeta", - " | undefined) => { query: (Record & { query_string?: { query: string; fields?: string[] | undefined; } | undefined; }) | undefined; meta: { alias: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index: string; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; }; }" + "() => Promise" ], - "path": "src/plugins/data/server/deprecated.ts", + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "data", + "id": "def-server.DataViewsService.getFieldsForWildcard", + "type": "Function", + "tags": [], + "label": "getFieldsForWildcard", + "description": [ + "\nGet field list by providing { pattern }." + ], + "signature": [ + "(options: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.GetFieldsOptions", + "text": "GetFieldsOptions" + }, + ") => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + "[]>" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "data", - "id": "def-server.esFilters.buildQueryFilter.$1", + "id": "def-server.DataViewsService.getFieldsForWildcard.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [ + "options for getting field list" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.GetFieldsOptions", + "text": "GetFieldsOptions" + } + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [ + "FieldSpec[]" + ] + }, + { + "parentPluginId": "data", + "id": "def-server.DataViewsService.getFieldsForIndexPattern", + "type": "Function", + "tags": [], + "label": "getFieldsForIndexPattern", + "description": [ + "\nGet field list by providing an index patttern (or spec)." + ], + "signature": [ + "(indexPattern: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + " | ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewSpec", + "text": "DataViewSpec" + }, + ", options?: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.GetFieldsOptions", + "text": "GetFieldsOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + "[]>" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.DataViewsService.getFieldsForIndexPattern.$1", "type": "CompoundType", "tags": [], - "label": "query", + "label": "indexPattern", "description": [], "signature": [ - "(Record & { query_string?: { query: string; fields?: string[] | undefined; } | undefined; }) | undefined" + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + " | ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewSpec", + "text": "DataViewSpec" + } ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true }, { "parentPluginId": "data", - "id": "def-server.esFilters.buildQueryFilter.$2", - "type": "string", + "id": "def-server.DataViewsService.getFieldsForIndexPattern.$2", + "type": "Object", "tags": [], - "label": "index", + "label": "options", + "description": [ + "options for getting field list" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.GetFieldsOptions", + "text": "GetFieldsOptions" + }, + " | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [ + "FieldSpec[]" + ] + }, + { + "parentPluginId": "data", + "id": "def-server.DataViewsService.refreshFields", + "type": "Function", + "tags": [], + "label": "refreshFields", + "description": [ + "\nRefresh field list for a given index pattern." + ], + "signature": [ + "(indexPattern: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + ") => Promise" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.DataViewsService.refreshFields.$1", + "type": "Object", + "tags": [], + "label": "indexPattern", "description": [], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + } + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "data", + "id": "def-server.DataViewsService.fieldArrayToMap", + "type": "Function", + "tags": [], + "label": "fieldArrayToMap", + "description": [ + "\nConverts field array to map." + ], + "signature": [ + "(fields: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + "[], fieldAttrs?: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldAttrs", + "text": "FieldAttrs" }, + " | undefined) => ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewFieldMap", + "text": "DataViewFieldMap" + } + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ { "parentPluginId": "data", - "id": "def-server.esFilters.buildQueryFilter.$3", - "type": "string", + "id": "def-server.DataViewsService.fieldArrayToMap.$1", + "type": "Array", "tags": [], - "label": "alias", - "description": [], + "label": "fields", + "description": [ + ": FieldSpec[]" + ], "signature": [ - "string | undefined" + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + "[]" ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true }, { "parentPluginId": "data", - "id": "def-server.esFilters.buildQueryFilter.$4", + "id": "def-server.DataViewsService.fieldArrayToMap.$2", "type": "Object", "tags": [], - "label": "meta", - "description": [], + "label": "fieldAttrs", + "description": [ + ": FieldAttrs" + ], "signature": [ - "FilterMeta", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldAttrs", + "text": "FieldAttrs" + }, " | undefined" ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": false } + ], + "returnComment": [ + "Record" ] }, { "parentPluginId": "data", - "id": "def-server.esFilters.buildCustomFilter", + "id": "def-server.DataViewsService.savedObjectToSpec", "type": "Function", "tags": [], - "label": "buildCustomFilter", - "description": [], + "label": "savedObjectToSpec", + "description": [ + "\nConverts data view saved object to data view spec." + ], "signature": [ - "(indexPatternString: string, queryDsl: ", - "QueryDslQueryContainer", - ", disabled: boolean, negate: boolean, alias: string | null, store: ", - "FilterStateStore", - ") => ", - "Filter" + "(savedObject: ", + "SavedObject", + "<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewAttributes", + "text": "DataViewAttributes" + }, + ">) => ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewSpec", + "text": "DataViewSpec" + } ], - "path": "src/plugins/data/server/deprecated.ts", + "path": "src/plugins/data_views/common/data_views/data_views.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "data", - "id": "def-server.esFilters.buildCustomFilter.$1", - "type": "string", - "tags": [], - "label": "indexPatternString", - "description": [], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.esFilters.buildCustomFilter.$2", + "id": "def-server.DataViewsService.savedObjectToSpec.$1", "type": "Object", "tags": [], - "label": "queryDsl", - "description": [], - "signature": [ - "QueryDslQueryContainer" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.esFilters.buildCustomFilter.$3", - "type": "boolean", - "tags": [], - "label": "disabled", - "description": [], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.esFilters.buildCustomFilter.$4", - "type": "boolean", - "tags": [], - "label": "negate", - "description": [], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.esFilters.buildCustomFilter.$5", - "type": "CompoundType", - "tags": [], - "label": "alias", - "description": [], - "signature": [ - "string | null" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.esFilters.buildCustomFilter.$6", - "type": "Enum", - "tags": [], - "label": "store", + "label": "savedObject", "description": [], "signature": [ - "FilterStateStore" + "SavedObject", + "<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewAttributes", + "text": "DataViewAttributes" + }, + ">" ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true } + ], + "returnComment": [ + "DataViewSpec" ] }, { "parentPluginId": "data", - "id": "def-server.esFilters.buildEmptyFilter", + "id": "def-server.DataViewsService.get", "type": "Function", "tags": [], - "label": "buildEmptyFilter", - "description": [], + "label": "get", + "description": [ + "\nGet an index pattern by id, cache optimized." + ], "signature": [ - "(isPinned: boolean, index?: string | undefined) => ", - "Filter" + "(id: string) => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + ">" ], - "path": "src/plugins/data/server/deprecated.ts", + "path": "src/plugins/data_views/common/data_views/data_views.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "data", - "id": "def-server.esFilters.buildEmptyFilter.$1", - "type": "boolean", - "tags": [], - "label": "isPinned", - "description": [], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.esFilters.buildEmptyFilter.$2", + "id": "def-server.DataViewsService.get.$1", "type": "string", "tags": [], - "label": "index", + "label": "id", "description": [], "signature": [ - "string | undefined" + "string" ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "data", - "id": "def-server.esFilters.buildExistsFilter", + "id": "def-server.DataViewsService.create", "type": "Function", "tags": [], - "label": "buildExistsFilter", - "description": [], + "label": "create", + "description": [ + "\nCreate a new data view instance." + ], "signature": [ - "(field: ", - "DataViewFieldBase", - ", indexPattern: ", - "DataViewBase", - ") => ", - "ExistsFilter" + "(spec: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewSpec", + "text": "DataViewSpec" + }, + ", skipFetchFields?: boolean) => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + ">" ], - "path": "src/plugins/data/server/deprecated.ts", + "path": "src/plugins/data_views/common/data_views/data_views.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "data", - "id": "def-server.esFilters.buildExistsFilter.$1", + "id": "def-server.DataViewsService.create.$1", "type": "Object", "tags": [], - "label": "field", - "description": [], + "label": "spec", + "description": [ + "data view spec" + ], "signature": [ - "DataViewFieldBase" + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewSpec", + "text": "DataViewSpec" + } ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true }, { "parentPluginId": "data", - "id": "def-server.esFilters.buildExistsFilter.$2", - "type": "Object", + "id": "def-server.DataViewsService.create.$2", + "type": "boolean", "tags": [], - "label": "indexPattern", - "description": [], + "label": "skipFetchFields", + "description": [ + "if true, will not fetch fields" + ], "signature": [ - "DataViewBase" + "boolean" ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true } + ], + "returnComment": [ + "DataView" ] }, { "parentPluginId": "data", - "id": "def-server.esFilters.buildFilter", + "id": "def-server.DataViewsService.createAndSave", "type": "Function", "tags": [], - "label": "buildFilter", - "description": [], + "label": "createAndSave", + "description": [ + "\nCreate a new data view and save it right away." + ], "signature": [ - "(indexPattern: ", - "DataViewBase", - ", field: ", - "DataViewFieldBase", - ", type: ", - "FILTERS", - ", negate: boolean, disabled: boolean, params: ", - "Serializable", - ", alias: string | null, store?: ", - "FilterStateStore", - " | undefined) => ", - "Filter" + "(spec: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewSpec", + "text": "DataViewSpec" + }, + ", override?: boolean, skipFetchFields?: boolean) => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + ">" ], - "path": "src/plugins/data/server/deprecated.ts", + "path": "src/plugins/data_views/common/data_views/data_views.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "data", - "id": "def-server.esFilters.buildFilter.$1", + "id": "def-server.DataViewsService.createAndSave.$1", "type": "Object", "tags": [], - "label": "indexPattern", - "description": [], + "label": "spec", + "description": [ + "data view spec" + ], "signature": [ - "DataViewBase" + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewSpec", + "text": "DataViewSpec" + } ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true }, { "parentPluginId": "data", - "id": "def-server.esFilters.buildFilter.$2", - "type": "Object", + "id": "def-server.DataViewsService.createAndSave.$2", + "type": "boolean", "tags": [], - "label": "field", - "description": [], + "label": "override", + "description": [ + "Overwrite if existing index pattern exists." + ], "signature": [ - "DataViewFieldBase" + "boolean" ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true }, { "parentPluginId": "data", - "id": "def-server.esFilters.buildFilter.$3", - "type": "Enum", + "id": "def-server.DataViewsService.createAndSave.$3", + "type": "boolean", "tags": [], - "label": "type", - "description": [], + "label": "skipFetchFields", + "description": [ + "Whether to skip field refresh step." + ], "signature": [ - "FILTERS" + "boolean" ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "data", + "id": "def-server.DataViewsService.createSavedObject", + "type": "Function", + "tags": [], + "label": "createSavedObject", + "description": [ + "\nSave a new data view." + ], + "signature": [ + "(dataView: ", { - "parentPluginId": "data", - "id": "def-server.esFilters.buildFilter.$4", - "type": "boolean", - "tags": [], - "label": "negate", - "description": [], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" }, + ", override?: boolean) => Promise<", { - "parentPluginId": "data", - "id": "def-server.esFilters.buildFilter.$5", - "type": "boolean", - "tags": [], - "label": "disabled", - "description": [], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" }, + ">" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ { "parentPluginId": "data", - "id": "def-server.esFilters.buildFilter.$6", - "type": "CompoundType", + "id": "def-server.DataViewsService.createSavedObject.$1", + "type": "Object", "tags": [], - "label": "params", - "description": [], - "signature": [ - "string | number | boolean | ", - "SerializableRecord", - " | SerializableArray | null | undefined" + "label": "dataView", + "description": [ + "data view instance" ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.esFilters.buildFilter.$7", - "type": "CompoundType", - "tags": [], - "label": "alias", - "description": [], "signature": [ - "string | null" + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + } ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true }, { "parentPluginId": "data", - "id": "def-server.esFilters.buildFilter.$8", - "type": "CompoundType", + "id": "def-server.DataViewsService.createSavedObject.$2", + "type": "boolean", "tags": [], - "label": "store", - "description": [], + "label": "override", + "description": [ + "Overwrite if existing index pattern exists" + ], "signature": [ - "FilterStateStore", - " | undefined" + "boolean" ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "data", - "id": "def-server.esFilters.buildPhraseFilter", + "id": "def-server.DataViewsService.updateSavedObject", "type": "Function", "tags": [], - "label": "buildPhraseFilter", - "description": [], + "label": "updateSavedObject", + "description": [ + "\nSave existing dat aview. Will attempt to merge differences if there are conflicts." + ], "signature": [ - "(field: ", - "DataViewFieldBase", - ", value: PhraseFilterValue, indexPattern: ", - "DataViewBase", - ") => ", - "PhraseFilter", - " | ", - "ScriptedPhraseFilter" + "(indexPattern: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + ", saveAttempts?: number, ignoreErrors?: boolean) => Promise" ], - "path": "src/plugins/data/server/deprecated.ts", + "path": "src/plugins/data_views/common/data_views/data_views.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "data", - "id": "def-server.esFilters.buildPhraseFilter.$1", + "id": "def-server.DataViewsService.updateSavedObject.$1", "type": "Object", "tags": [], - "label": "field", + "label": "indexPattern", "description": [], "signature": [ - "DataViewFieldBase" + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + } ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-server.DataViewsService.updateSavedObject.$2", + "type": "number", + "tags": [], + "label": "saveAttempts", + "description": [], + "signature": [ + "number" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true }, { "parentPluginId": "data", - "id": "def-server.esFilters.buildPhraseFilter.$2", - "type": "CompoundType", + "id": "def-server.DataViewsService.updateSavedObject.$3", + "type": "boolean", "tags": [], - "label": "value", + "label": "ignoreErrors", "description": [], "signature": [ - "string | number | boolean" + "boolean" ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "data", + "id": "def-server.DataViewsService.delete", + "type": "Function", + "tags": [], + "label": "delete", + "description": [ + "\nDeletes an index pattern from .kibana index." + ], + "signature": [ + "(indexPatternId: string) => Promise<{}>" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ { "parentPluginId": "data", - "id": "def-server.esFilters.buildPhraseFilter.$3", - "type": "Object", + "id": "def-server.DataViewsService.delete.$1", + "type": "string", "tags": [], - "label": "indexPattern", - "description": [], + "label": "indexPatternId", + "description": [ + ": Id of kibana Index Pattern to delete" + ], "signature": [ - "DataViewBase" + "string" ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "data", - "id": "def-server.esFilters.buildPhrasesFilter", + "id": "def-server.DataViewsService.getDefaultDataView", "type": "Function", "tags": [], - "label": "buildPhrasesFilter", + "label": "getDefaultDataView", + "description": [ + "\nReturns the default data view as an object.\nIf no default is found, or it is missing\nanother data view is selected as default and returned.\nIf no possible data view found to become a default returns null.\n" + ], + "signature": [ + "() => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + " | null>" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [], + "returnComment": [ + "default data view" + ] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-server.IndexPatternsFetcher", + "type": "Class", + "tags": [], + "label": "IndexPatternsFetcher", + "description": [], + "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.IndexPatternsFetcher.Unnamed", + "type": "Function", + "tags": [], + "label": "Constructor", "description": [], "signature": [ - "(field: ", - "DataViewFieldBase", - ", params: PhraseFilterValue[], indexPattern: ", - "DataViewBase", - ") => ", - "PhrasesFilter" + "any" ], - "path": "src/plugins/data/server/deprecated.ts", + "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "data", - "id": "def-server.esFilters.buildPhrasesFilter.$1", + "id": "def-server.IndexPatternsFetcher.Unnamed.$1", "type": "Object", "tags": [], - "label": "field", + "label": "elasticsearchClient", "description": [], "signature": [ - "DataViewFieldBase" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ElasticsearchClient", + "text": "ElasticsearchClient" + } ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false + "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", + "deprecated": false, + "isRequired": true }, { "parentPluginId": "data", - "id": "def-server.esFilters.buildPhrasesFilter.$2", - "type": "Array", + "id": "def-server.IndexPatternsFetcher.Unnamed.$2", + "type": "boolean", "tags": [], - "label": "params", + "label": "allowNoIndices", "description": [], "signature": [ - "PhraseFilterValue[]" + "boolean" ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false + "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "data", + "id": "def-server.IndexPatternsFetcher.getFieldsForWildcard", + "type": "Function", + "tags": [ + "property", + "property", + "return" + ], + "label": "getFieldsForWildcard", + "description": [ + "\n Get a list of field objects for an index pattern that may contain wildcards\n" + ], + "signature": [ + "(options: { pattern: string | string[]; metaFields?: string[] | undefined; fieldCapsOptions?: { allow_no_indices: boolean; } | undefined; type?: string | undefined; rollupIndex?: string | undefined; filter?: ", + "QueryDslQueryContainer", + " | undefined; }) => Promise<", + { + "pluginId": "dataViews", + "scope": "server", + "docId": "kibDataViewsPluginApi", + "section": "def-server.FieldDescriptor", + "text": "FieldDescriptor" }, + "[]>" + ], + "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", + "deprecated": false, + "children": [ { "parentPluginId": "data", - "id": "def-server.esFilters.buildPhrasesFilter.$3", + "id": "def-server.IndexPatternsFetcher.getFieldsForWildcard.$1", "type": "Object", "tags": [], - "label": "indexPattern", + "label": "options", "description": [], - "signature": [ - "DataViewBase" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false + "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.IndexPatternsFetcher.getFieldsForWildcard.$1.pattern", + "type": "CompoundType", + "tags": [], + "label": "pattern", + "description": [], + "signature": [ + "string | string[]" + ], + "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.IndexPatternsFetcher.getFieldsForWildcard.$1.metaFields", + "type": "Array", + "tags": [], + "label": "metaFields", + "description": [], + "signature": [ + "string[] | undefined" + ], + "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.IndexPatternsFetcher.getFieldsForWildcard.$1.fieldCapsOptions", + "type": "Object", + "tags": [], + "label": "fieldCapsOptions", + "description": [], + "signature": [ + "{ allow_no_indices: boolean; } | undefined" + ], + "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.IndexPatternsFetcher.getFieldsForWildcard.$1.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.IndexPatternsFetcher.getFieldsForWildcard.$1.rollupIndex", + "type": "string", + "tags": [], + "label": "rollupIndex", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.IndexPatternsFetcher.getFieldsForWildcard.$1.filter", + "type": "Object", + "tags": [], + "label": "filter", + "description": [], + "signature": [ + "QueryDslQueryContainer", + " | undefined" + ], + "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", + "deprecated": false + } + ] } - ] + ], + "returnComment": [] }, { "parentPluginId": "data", - "id": "def-server.esFilters.buildRangeFilter", + "id": "def-server.IndexPatternsFetcher.validatePatternListActive", "type": "Function", - "tags": [], - "label": "buildRangeFilter", - "description": [], + "tags": [ + "return" + ], + "label": "validatePatternListActive", + "description": [ + "\n Returns an index pattern list of only those index pattern strings in the given list that return indices\n" + ], "signature": [ - "(field: ", - "DataViewFieldBase", - ", params: ", - "RangeFilterParams", - ", indexPattern: ", - "DataViewBase", - ", formattedValue?: string | undefined) => ", - "RangeFilter", - " | ", - "ScriptedRangeFilter", - " | MatchAllRangeFilter" + "(patternList: string[]) => Promise" ], - "path": "src/plugins/data/server/deprecated.ts", + "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "data", - "id": "def-server.esFilters.buildRangeFilter.$1", - "type": "Object", - "tags": [], - "label": "field", - "description": [], - "signature": [ - "DataViewFieldBase" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.esFilters.buildRangeFilter.$2", - "type": "Object", - "tags": [], - "label": "params", - "description": [], - "signature": [ - "RangeFilterParams" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.esFilters.buildRangeFilter.$3", - "type": "Object", + "id": "def-server.IndexPatternsFetcher.validatePatternListActive.$1", + "type": "Array", "tags": [], - "label": "indexPattern", - "description": [], - "signature": [ - "DataViewBase" + "label": "patternList", + "description": [ + "string[]" ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.esFilters.buildRangeFilter.$4", - "type": "string", - "tags": [], - "label": "formattedValue", - "description": [], "signature": [ - "string | undefined" + "string[]" ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false + "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", + "deprecated": false, + "isRequired": true } - ] - }, + ], + "returnComment": [] + } + ], + "initialIsOpen": false + } + ], + "functions": [ + { + "parentPluginId": "data", + "id": "def-server.getCapabilitiesForRollupIndices", + "type": "Function", + "tags": [], + "label": "getCapabilitiesForRollupIndices", + "description": [ + "\nGet rollup job capabilities" + ], + "signature": [ + "(indices: Record) => { [key: string]: any; }" + ], + "path": "src/plugins/data_views/server/fetcher/lib/map_capabilities.ts", + "deprecated": false, + "children": [ { "parentPluginId": "data", - "id": "def-server.esFilters.isFilterDisabled", - "type": "Function", + "id": "def-server.getCapabilitiesForRollupIndices.$1", + "type": "Object", "tags": [], - "label": "isFilterDisabled", + "label": "indices", + "description": [ + "rollup job index capabilites" + ], + "signature": [ + "Record" + ], + "path": "src/plugins/data_views/server/fetcher/lib/map_capabilities.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-server.getEsQueryConfig", + "type": "Function", + "tags": [], + "label": "getEsQueryConfig", + "description": [], + "signature": [ + "(config: KibanaConfig) => ", + "EsQueryConfig" + ], + "path": "src/plugins/data/common/es_query/get_es_query_config.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.getEsQueryConfig.$1", + "type": "Object", + "tags": [], + "label": "config", "description": [], "signature": [ - "(filter: ", - "Filter", - ") => boolean" + "KibanaConfig" ], - "path": "src/plugins/data/server/deprecated.ts", + "path": "src/plugins/data/common/es_query/get_es_query_config.ts", "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-server.esFilters.isFilterDisabled.$1", - "type": "Object", - "tags": [], - "label": "filter", - "description": [], - "signature": [ - "{ $state?: { store: ", - "FilterStateStore", - "; } | undefined; meta: ", - "FilterMeta", - "; query?: Record | undefined; }" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ] + "isRequired": true } ], + "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", - "id": "def-server.esKuery", - "type": "Object", + "id": "def-server.getRequestAbortedSignal", + "type": "Function", "tags": [], - "label": "esKuery", + "label": "getRequestAbortedSignal", + "description": [ + "\nA simple utility function that returns an `AbortSignal` corresponding to an `AbortController`\nwhich aborts when the given request is aborted." + ], + "signature": [ + "(aborted$: ", + "Observable", + ") => AbortSignal" + ], + "path": "src/plugins/data/server/lib/get_request_aborted_signal.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.getRequestAbortedSignal.$1", + "type": "Object", + "tags": [], + "label": "aborted$", + "description": [ + "The observable of abort events (usually `request.events.aborted$`)" + ], + "signature": [ + "Observable", + "" + ], + "path": "src/plugins/data/server/lib/get_request_aborted_signal.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-server.getTime", + "type": "Function", + "tags": [], + "label": "getTime", "description": [], - "path": "src/plugins/data/server/deprecated.ts", + "signature": [ + "(indexPattern: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + " | undefined, timeRange: ", + "TimeRange", + ", options: { forceNow?: Date | undefined; fieldName?: string | undefined; } | undefined) => ", + "RangeFilter", + " | ", + "ScriptedRangeFilter", + " | MatchAllRangeFilter | undefined" + ], + "path": "src/plugins/data/common/query/timefilter/get_time.ts", "deprecated": false, "children": [ { "parentPluginId": "data", - "id": "def-server.esKuery.nodeTypes", + "id": "def-server.getTime.$1", + "type": "Object", + "tags": [], + "label": "indexPattern", + "description": [], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + " | undefined" + ], + "path": "src/plugins/data/common/query/timefilter/get_time.ts", + "deprecated": false, + "isRequired": false + }, + { + "parentPluginId": "data", + "id": "def-server.getTime.$2", "type": "Object", "tags": [], - "label": "nodeTypes", + "label": "timeRange", "description": [], "signature": [ - "NodeTypes" + "TimeRange" ], - "path": "src/plugins/data/server/deprecated.ts", - "deprecated": false + "path": "src/plugins/data/common/query/timefilter/get_time.ts", + "deprecated": false, + "isRequired": true }, { "parentPluginId": "data", - "id": "def-server.esKuery.fromKueryExpression", - "type": "Function", + "id": "def-server.getTime.$3", + "type": "Object", "tags": [], - "label": "fromKueryExpression", + "label": "options", "description": [], - "signature": [ - "(expression: string | ", - "QueryDslQueryContainer", - ", parseOptions?: Partial<", - "KueryParseOptions", - "> | undefined) => ", - "KueryNode" - ], - "path": "src/plugins/data/server/deprecated.ts", + "path": "src/plugins/data/common/query/timefilter/get_time.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "data", - "id": "def-server.esKuery.fromKueryExpression.$1", - "type": "CompoundType", + "id": "def-server.getTime.$3.forceNow", + "type": "Object", "tags": [], - "label": "expression", + "label": "forceNow", "description": [], "signature": [ - "string | ", - "QueryDslQueryContainer" + "Date | undefined" ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", + "path": "src/plugins/data/common/query/timefilter/get_time.ts", "deprecated": false }, { "parentPluginId": "data", - "id": "def-server.esKuery.fromKueryExpression.$2", - "type": "Object", + "id": "def-server.getTime.$3.fieldName", + "type": "string", "tags": [], - "label": "parseOptions", + "label": "fieldName", "description": [], "signature": [ - "Partial<", - "KueryParseOptions", - "> | undefined" + "string | undefined" ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", + "path": "src/plugins/data/common/query/timefilter/get_time.ts", "deprecated": false } ] - }, + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-server.parseInterval", + "type": "Function", + "tags": [], + "label": "parseInterval", + "description": [], + "signature": [ + "(interval: string) => moment.Duration | null" + ], + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_interval.ts", + "deprecated": false, + "children": [ { "parentPluginId": "data", - "id": "def-server.esKuery.toElasticsearchQuery", - "type": "Function", + "id": "def-server.parseInterval.$1", + "type": "string", "tags": [], - "label": "toElasticsearchQuery", + "label": "interval", "description": [], "signature": [ - "(node: ", - "KueryNode", - ", indexPattern?: ", - "DataViewBase", - " | undefined, config?: ", - "KueryQueryOptions", - " | undefined, context?: Record | undefined) => ", - "QueryDslQueryContainer" + "string" ], - "path": "src/plugins/data/server/deprecated.ts", + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_interval.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [ + { + "parentPluginId": "data", + "id": "def-server.DataViewsServerPluginStart", + "type": "Interface", + "tags": [], + "label": "DataViewsServerPluginStart", + "description": [ + "\nDataViews server plugin start api" + ], + "path": "src/plugins/data_views/server/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.DataViewsServerPluginStart.dataViewsServiceFactory", + "type": "Function", + "tags": [], + "label": "dataViewsServiceFactory", + "description": [ + "\nReturns a DataViews service instance" + ], + "signature": [ + "(savedObjectsClient: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClientContract", + "text": "SavedObjectsClientContract" + }, + ", elasticsearchClient: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ElasticsearchClient", + "text": "ElasticsearchClient" + }, + ", request?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + " | undefined, byPassCapabilities?: boolean | undefined) => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewsService", + "text": "DataViewsService" + }, + ">" + ], + "path": "src/plugins/data_views/server/types.ts", "deprecated": false, "returnComment": [], "children": [ { "parentPluginId": "data", - "id": "def-server.esKuery.toElasticsearchQuery.$1", + "id": "def-server.DataViewsServerPluginStart.dataViewsServiceFactory.$1", "type": "Object", "tags": [], - "label": "node", + "label": "savedObjectsClient", "description": [], "signature": [ - "KueryNode" + "{ create: (type: string, attributes: T, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCreateOptions", + "text": "SavedObjectsCreateOptions" + }, + " | undefined) => Promise<", + "SavedObject", + ">; bulkCreate: (objects: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkCreateObject", + "text": "SavedObjectsBulkCreateObject" + }, + "[], options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCreateOptions", + "text": "SavedObjectsCreateOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkResponse", + "text": "SavedObjectsBulkResponse" + }, + ">; checkConflicts: (objects?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCheckConflictsObject", + "text": "SavedObjectsCheckConflictsObject" + }, + "[], options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCheckConflictsResponse", + "text": "SavedObjectsCheckConflictsResponse" + }, + ">; delete: (type: string, id: string, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsDeleteOptions", + "text": "SavedObjectsDeleteOptions" + }, + ") => Promise<{}>; find: (options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsFindOptions", + "text": "SavedObjectsFindOptions" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsFindResponse", + "text": "SavedObjectsFindResponse" + }, + ">; bulkGet: (objects?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkGetObject", + "text": "SavedObjectsBulkGetObject" + }, + "[], options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkResponse", + "text": "SavedObjectsBulkResponse" + }, + ">; bulkResolve: (objects: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkResolveObject", + "text": "SavedObjectsBulkResolveObject" + }, + "[], options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkResolveResponse", + "text": "SavedObjectsBulkResolveResponse" + }, + ">; get: (type: string, id: string, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + ") => Promise<", + "SavedObject", + ">; resolve: (type: string, id: string, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsResolveResponse", + "text": "SavedObjectsResolveResponse" + }, + ">; update: (type: string, id: string, attributes: Partial, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsUpdateOptions", + "text": "SavedObjectsUpdateOptions" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsUpdateResponse", + "text": "SavedObjectsUpdateResponse" + }, + ">; collectMultiNamespaceReferences: (objects: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesObject", + "text": "SavedObjectsCollectMultiNamespaceReferencesObject" + }, + "[], options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesOptions", + "text": "SavedObjectsCollectMultiNamespaceReferencesOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesResponse", + "text": "SavedObjectsCollectMultiNamespaceReferencesResponse" + }, + ">; updateObjectsSpaces: (objects: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsUpdateObjectsSpacesObject", + "text": "SavedObjectsUpdateObjectsSpacesObject" + }, + "[], spacesToAdd: string[], spacesToRemove: string[], options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsUpdateObjectsSpacesOptions", + "text": "SavedObjectsUpdateObjectsSpacesOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsUpdateObjectsSpacesResponse", + "text": "SavedObjectsUpdateObjectsSpacesResponse" + }, + ">; bulkUpdate: (objects: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkUpdateObject", + "text": "SavedObjectsBulkUpdateObject" + }, + "[], options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkUpdateOptions", + "text": "SavedObjectsBulkUpdateOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkUpdateResponse", + "text": "SavedObjectsBulkUpdateResponse" + }, + ">; removeReferencesTo: (type: string, id: string, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsRemoveReferencesToOptions", + "text": "SavedObjectsRemoveReferencesToOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsRemoveReferencesToResponse", + "text": "SavedObjectsRemoveReferencesToResponse" + }, + ">; openPointInTimeForType: (type: string | string[], options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsOpenPointInTimeOptions", + "text": "SavedObjectsOpenPointInTimeOptions" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsOpenPointInTimeResponse", + "text": "SavedObjectsOpenPointInTimeResponse" + }, + ">; closePointInTime: (id: string, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClosePointInTimeResponse", + "text": "SavedObjectsClosePointInTimeResponse" + }, + ">; createPointInTimeFinder: (findOptions: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCreatePointInTimeFinderOptions", + "text": "SavedObjectsCreatePointInTimeFinderOptions" + }, + ", dependencies?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCreatePointInTimeFinderDependencies", + "text": "SavedObjectsCreatePointInTimeFinderDependencies" + }, + " | undefined) => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.ISavedObjectsPointInTimeFinder", + "text": "ISavedObjectsPointInTimeFinder" + }, + "; errors: typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsErrorHelpers", + "text": "SavedObjectsErrorHelpers" + }, + "; }" ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", + "path": "src/plugins/data_views/server/types.ts", "deprecated": false }, { "parentPluginId": "data", - "id": "def-server.esKuery.toElasticsearchQuery.$2", + "id": "def-server.DataViewsServerPluginStart.dataViewsServiceFactory.$2", "type": "Object", "tags": [], - "label": "indexPattern", + "label": "elasticsearchClient", "description": [], "signature": [ - "DataViewBase", - " | undefined" + "{ eql: ", + "default", + "; search: { >(this: That, params?: ", + "SearchRequest", + " | ", + "SearchRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "SearchResponse", + ">; >(this: That, params?: ", + "SearchRequest", + " | ", + "SearchRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "SearchResponse", + ", unknown>>; >(this: That, params?: ", + "SearchRequest", + " | ", + "SearchRequest", + " | undefined, options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "SearchResponse", + ">; }; create: { (this: That, params: ", + "CreateRequest", + " | ", + "CreateRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "WriteResponseBase", + ">; (this: That, params: ", + "CreateRequest", + " | ", + "CreateRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "WriteResponseBase", + ", unknown>>; (this: That, params: ", + "CreateRequest", + " | ", + "CreateRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "WriteResponseBase", + ">; }; monitoring: ", + "default", + "; security: ", + "default", + "; name: string | symbol; index: { (this: That, params: ", + "IndexRequest", + " | ", + "IndexRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "WriteResponseBase", + ">; (this: That, params: ", + "IndexRequest", + " | ", + "IndexRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "WriteResponseBase", + ", unknown>>; (this: That, params: ", + "IndexRequest", + " | ", + "IndexRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "WriteResponseBase", + ">; }; delete: { (this: That, params: ", + "DeleteRequest", + " | ", + "DeleteRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "WriteResponseBase", + ">; (this: That, params: ", + "DeleteRequest", + " | ", + "DeleteRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "WriteResponseBase", + ", unknown>>; (this: That, params: ", + "DeleteRequest", + " | ", + "DeleteRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "WriteResponseBase", + ">; }; get: { (this: That, params: ", + "GetRequest", + " | ", + "GetRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "GetResponse", + ">; (this: That, params: ", + "GetRequest", + " | ", + "GetRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "GetResponse", + ", unknown>>; (this: That, params: ", + "GetRequest", + " | ", + "GetRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "GetResponse", + ">; }; update: { (this: That, params: ", + "UpdateRequest", + " | ", + "UpdateRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "UpdateResponse", + ">; (this: That, params: ", + "UpdateRequest", + " | ", + "UpdateRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "UpdateResponse", + ", unknown>>; (this: That, params: ", + "UpdateRequest", + " | ", + "UpdateRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "UpdateResponse", + ">; }; closePointInTime: { (this: That, params: ", + "ClosePointInTimeRequest", + " | ", + "ClosePointInTimeRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "ClosePointInTimeResponse", + ">; (this: That, params: ", + "ClosePointInTimeRequest", + " | ", + "ClosePointInTimeRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "ClosePointInTimeResponse", + ", unknown>>; (this: That, params: ", + "ClosePointInTimeRequest", + " | ", + "ClosePointInTimeRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "ClosePointInTimeResponse", + ">; }; helpers: ", + "default", + "; [kInternal]: symbol | null; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", + "default", + "; child: (opts: ", + "ClientOptions", + ") => ", + "default", + "; Internal: ", + "default", + "; asyncSearch: ", + "default", + "; autoscaling: ", + "default", + "; bulk: { (this: That, params: ", + "BulkRequest", + " | ", + "BulkRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "BulkResponse", + ">; (this: That, params: ", + "BulkRequest", + " | ", + "BulkRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "BulkResponse", + ", unknown>>; (this: That, params: ", + "BulkRequest", + " | ", + "BulkRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "BulkResponse", + ">; }; cat: ", + "default", + "; ccr: ", + "default", + "; clearScroll: { (this: That, params?: ", + "ClearScrollRequest", + " | ", + "ClearScrollRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "ClearScrollResponse", + ">; (this: That, params?: ", + "ClearScrollRequest", + " | ", + "ClearScrollRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "ClearScrollResponse", + ", unknown>>; (this: That, params?: ", + "ClearScrollRequest", + " | ", + "ClearScrollRequest", + " | undefined, options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "ClearScrollResponse", + ">; }; cluster: ", + "default", + "; count: { (this: That, params?: ", + "CountRequest", + " | ", + "CountRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "CountResponse", + ">; (this: That, params?: ", + "CountRequest", + " | ", + "CountRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "CountResponse", + ", unknown>>; (this: That, params?: ", + "CountRequest", + " | ", + "CountRequest", + " | undefined, options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "CountResponse", + ">; }; danglingIndices: ", + "default", + "; deleteByQuery: { (this: That, params: ", + "DeleteByQueryRequest", + " | ", + "DeleteByQueryRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "DeleteByQueryResponse", + ">; (this: That, params: ", + "DeleteByQueryRequest", + " | ", + "DeleteByQueryRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "DeleteByQueryResponse", + ", unknown>>; (this: That, params: ", + "DeleteByQueryRequest", + " | ", + "DeleteByQueryRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "DeleteByQueryResponse", + ">; }; deleteByQueryRethrottle: { (this: That, params: ", + "DeleteByQueryRethrottleRequest", + " | ", + "DeleteByQueryRethrottleRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "TasksTaskListResponseBase", + ">; (this: That, params: ", + "DeleteByQueryRethrottleRequest", + " | ", + "DeleteByQueryRethrottleRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "TasksTaskListResponseBase", + ", unknown>>; (this: That, params: ", + "DeleteByQueryRethrottleRequest", + " | ", + "DeleteByQueryRethrottleRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "TasksTaskListResponseBase", + ">; }; deleteScript: { (this: That, params: ", + "DeleteScriptRequest", + " | ", + "DeleteScriptRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "AcknowledgedResponseBase", + ">; (this: That, params: ", + "DeleteScriptRequest", + " | ", + "DeleteScriptRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "AcknowledgedResponseBase", + ", unknown>>; (this: That, params: ", + "DeleteScriptRequest", + " | ", + "DeleteScriptRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "AcknowledgedResponseBase", + ">; }; enrich: ", + "default", + "; exists: { (this: That, params: ", + "ExistsRequest", + " | ", + "ExistsRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise; (this: That, params: ", + "ExistsRequest", + " | ", + "ExistsRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + ">; (this: That, params: ", + "ExistsRequest", + " | ", + "ExistsRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise; }; existsSource: { (this: That, params: ", + "ExistsSourceRequest", + " | ", + "ExistsSourceRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise; (this: That, params: ", + "ExistsSourceRequest", + " | ", + "ExistsSourceRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + ">; (this: That, params: ", + "ExistsSourceRequest", + " | ", + "ExistsSourceRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise; }; explain: { (this: That, params: ", + "ExplainRequest", + " | ", + "ExplainRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "ExplainResponse", + ">; (this: That, params: ", + "ExplainRequest", + " | ", + "ExplainRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "ExplainResponse", + ", unknown>>; (this: That, params: ", + "ExplainRequest", + " | ", + "ExplainRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "ExplainResponse", + ">; }; features: ", + "default", + "; fieldCaps: { (this: That, params: ", + "FieldCapsRequest", + " | ", + "FieldCapsRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "FieldCapsResponse", + ">; (this: That, params: ", + "FieldCapsRequest", + " | ", + "FieldCapsRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "FieldCapsResponse", + ", unknown>>; (this: That, params: ", + "FieldCapsRequest", + " | ", + "FieldCapsRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "FieldCapsResponse", + ">; }; fleet: ", + "default", + "; getScript: { (this: That, params: ", + "GetScriptRequest", + " | ", + "GetScriptRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "GetScriptResponse", + ">; (this: That, params: ", + "GetScriptRequest", + " | ", + "GetScriptRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "GetScriptResponse", + ", unknown>>; (this: That, params: ", + "GetScriptRequest", + " | ", + "GetScriptRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "GetScriptResponse", + ">; }; getScriptContext: { (this: That, params?: ", + "GetScriptContextRequest", + " | ", + "GetScriptContextRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "GetScriptContextResponse", + ">; (this: That, params?: ", + "GetScriptContextRequest", + " | ", + "GetScriptContextRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "GetScriptContextResponse", + ", unknown>>; (this: That, params?: ", + "GetScriptContextRequest", + " | ", + "GetScriptContextRequest", + " | undefined, options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "GetScriptContextResponse", + ">; }; getScriptLanguages: { (this: That, params?: ", + "GetScriptLanguagesRequest", + " | ", + "GetScriptLanguagesRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "GetScriptLanguagesResponse", + ">; (this: That, params?: ", + "GetScriptLanguagesRequest", + " | ", + "GetScriptLanguagesRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "GetScriptLanguagesResponse", + ", unknown>>; (this: That, params?: ", + "GetScriptLanguagesRequest", + " | ", + "GetScriptLanguagesRequest", + " | undefined, options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "GetScriptLanguagesResponse", + ">; }; getSource: { (this: That, params: ", + "GetSourceRequest", + " | ", + "GetSourceRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise; (this: That, params: ", + "GetSourceRequest", + " | ", + "GetSourceRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + ">; (this: That, params: ", + "GetSourceRequest", + " | ", + "GetSourceRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise; }; graph: ", + "default", + "; ilm: ", + "default", + "; indices: ", + "default", + "; info: { (this: That, params?: ", + "InfoRequest", + " | ", + "InfoRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "InfoResponse", + ">; (this: That, params?: ", + "InfoRequest", + " | ", + "InfoRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "InfoResponse", + ", unknown>>; (this: That, params?: ", + "InfoRequest", + " | ", + "InfoRequest", + " | undefined, options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "InfoResponse", + ">; }; ingest: ", + "default", + "; knnSearch: { (this: That, params: ", + "KnnSearchRequest", + " | ", + "KnnSearchRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "KnnSearchResponse", + ">; (this: That, params: ", + "KnnSearchRequest", + " | ", + "KnnSearchRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "KnnSearchResponse", + ", unknown>>; (this: That, params: ", + "KnnSearchRequest", + " | ", + "KnnSearchRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "KnnSearchResponse", + ">; }; license: ", + "default", + "; logstash: ", + "default", + "; mget: { (this: That, params?: ", + "MgetRequest", + " | ", + "MgetRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "MgetResponse", + ">; (this: That, params?: ", + "MgetRequest", + " | ", + "MgetRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "MgetResponse", + ", unknown>>; (this: That, params?: ", + "MgetRequest", + " | ", + "MgetRequest", + " | undefined, options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "MgetResponse", + ">; }; migration: ", + "default", + "; ml: ", + "default", + "; msearch: { >(this: That, params: ", + "MsearchRequest", + " | ", + "MsearchRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "MsearchResponse", + ">; >(this: That, params: ", + "MsearchRequest", + " | ", + "MsearchRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "MsearchResponse", + ", unknown>>; >(this: That, params: ", + "MsearchRequest", + " | ", + "MsearchRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "MsearchResponse", + ">; }; msearchTemplate: { >(this: That, params: ", + "MsearchTemplateRequest", + " | ", + "MsearchTemplateRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "MsearchTemplateResponse", + ">; >(this: That, params: ", + "MsearchTemplateRequest", + " | ", + "MsearchTemplateRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "MsearchTemplateResponse", + ", unknown>>; >(this: That, params: ", + "MsearchTemplateRequest", + " | ", + "MsearchTemplateRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "MsearchTemplateResponse", + ">; }; mtermvectors: { (this: That, params?: ", + "MtermvectorsRequest", + " | ", + "MtermvectorsRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "MtermvectorsResponse", + ">; (this: That, params?: ", + "MtermvectorsRequest", + " | ", + "MtermvectorsRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "MtermvectorsResponse", + ", unknown>>; (this: That, params?: ", + "MtermvectorsRequest", + " | ", + "MtermvectorsRequest", + " | undefined, options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "MtermvectorsResponse", + ">; }; nodes: ", + "default", + "; openPointInTime: { (this: That, params: ", + "OpenPointInTimeRequest", + " | ", + "OpenPointInTimeRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "OpenPointInTimeResponse", + ">; (this: That, params: ", + "OpenPointInTimeRequest", + " | ", + "OpenPointInTimeRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "OpenPointInTimeResponse", + ", unknown>>; (this: That, params: ", + "OpenPointInTimeRequest", + " | ", + "OpenPointInTimeRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "OpenPointInTimeResponse", + ">; }; ping: { (this: That, params?: ", + "PingRequest", + " | ", + "PingRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise; (this: That, params?: ", + "PingRequest", + " | ", + "PingRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + ">; (this: That, params?: ", + "PingRequest", + " | ", + "PingRequest", + " | undefined, options?: ", + "TransportRequestOptions", + " | undefined): Promise; }; putScript: { (this: That, params: ", + "PutScriptRequest", + " | ", + "PutScriptRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "AcknowledgedResponseBase", + ">; (this: That, params: ", + "PutScriptRequest", + " | ", + "PutScriptRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "AcknowledgedResponseBase", + ", unknown>>; (this: That, params: ", + "PutScriptRequest", + " | ", + "PutScriptRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "AcknowledgedResponseBase", + ">; }; rankEval: { (this: That, params: ", + "RankEvalRequest", + " | ", + "RankEvalRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "RankEvalResponse", + ">; (this: That, params: ", + "RankEvalRequest", + " | ", + "RankEvalRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "RankEvalResponse", + ", unknown>>; (this: That, params: ", + "RankEvalRequest", + " | ", + "RankEvalRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "RankEvalResponse", + ">; }; reindex: { (this: That, params: ", + "ReindexRequest", + " | ", + "ReindexRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "ReindexResponse", + ">; (this: That, params: ", + "ReindexRequest", + " | ", + "ReindexRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "ReindexResponse", + ", unknown>>; (this: That, params: ", + "ReindexRequest", + " | ", + "ReindexRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "ReindexResponse", + ">; }; reindexRethrottle: { (this: That, params: ", + "ReindexRethrottleRequest", + " | ", + "ReindexRethrottleRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "ReindexRethrottleResponse", + ">; (this: That, params: ", + "ReindexRethrottleRequest", + " | ", + "ReindexRethrottleRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "ReindexRethrottleResponse", + ", unknown>>; (this: That, params: ", + "ReindexRethrottleRequest", + " | ", + "ReindexRethrottleRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "ReindexRethrottleResponse", + ">; }; renderSearchTemplate: { (this: That, params?: ", + "RenderSearchTemplateRequest", + " | ", + "RenderSearchTemplateRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "RenderSearchTemplateResponse", + ">; (this: That, params?: ", + "RenderSearchTemplateRequest", + " | ", + "RenderSearchTemplateRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "RenderSearchTemplateResponse", + ", unknown>>; (this: That, params?: ", + "RenderSearchTemplateRequest", + " | ", + "RenderSearchTemplateRequest", + " | undefined, options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "RenderSearchTemplateResponse", + ">; }; rollup: ", + "default", + "; scriptsPainlessExecute: { (this: That, params?: ", + "ScriptsPainlessExecuteRequest", + " | ", + "ScriptsPainlessExecuteRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "ScriptsPainlessExecuteResponse", + ">; (this: That, params?: ", + "ScriptsPainlessExecuteRequest", + " | ", + "ScriptsPainlessExecuteRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "ScriptsPainlessExecuteResponse", + ", unknown>>; (this: That, params?: ", + "ScriptsPainlessExecuteRequest", + " | ", + "ScriptsPainlessExecuteRequest", + " | undefined, options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "ScriptsPainlessExecuteResponse", + ">; }; scroll: { >(this: That, params: ", + "ScrollRequest", + " | ", + "ScrollRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "ScrollResponse", + ">; >(this: That, params: ", + "ScrollRequest", + " | ", + "ScrollRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "ScrollResponse", + ", unknown>>; >(this: That, params: ", + "ScrollRequest", + " | ", + "ScrollRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "ScrollResponse", + ">; }; searchMvt: { (this: That, params: ", + "SearchMvtRequest", + " | ", + "SearchMvtRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise; (this: That, params: ", + "SearchMvtRequest", + " | ", + "SearchMvtRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + ">; (this: That, params: ", + "SearchMvtRequest", + " | ", + "SearchMvtRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise; }; searchShards: { (this: That, params?: ", + "SearchShardsRequest", + " | ", + "SearchShardsRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "SearchShardsResponse", + ">; (this: That, params?: ", + "SearchShardsRequest", + " | ", + "SearchShardsRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "SearchShardsResponse", + ", unknown>>; (this: That, params?: ", + "SearchShardsRequest", + " | ", + "SearchShardsRequest", + " | undefined, options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "SearchShardsResponse", + ">; }; searchTemplate: { (this: That, params?: ", + "SearchTemplateRequest", + " | ", + "SearchTemplateRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "SearchTemplateResponse", + ">; (this: That, params?: ", + "SearchTemplateRequest", + " | ", + "SearchTemplateRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "SearchTemplateResponse", + ", unknown>>; (this: That, params?: ", + "SearchTemplateRequest", + " | ", + "SearchTemplateRequest", + " | undefined, options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "SearchTemplateResponse", + ">; }; searchableSnapshots: ", + "default", + "; shutdown: ", + "default", + "; slm: ", + "default", + "; snapshot: ", + "default", + "; sql: ", + "default", + "; ssl: ", + "default", + "; tasks: ", + "default", + "; termsEnum: { (this: That, params: ", + "TermsEnumRequest", + " | ", + "TermsEnumRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "TermsEnumResponse", + ">; (this: That, params: ", + "TermsEnumRequest", + " | ", + "TermsEnumRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "TermsEnumResponse", + ", unknown>>; (this: That, params: ", + "TermsEnumRequest", + " | ", + "TermsEnumRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "TermsEnumResponse", + ">; }; termvectors: { (this: That, params: ", + "TermvectorsRequest", + " | ", + "TermvectorsRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "TermvectorsResponse", + ">; (this: That, params: ", + "TermvectorsRequest", + " | ", + "TermvectorsRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "TermvectorsResponse", + ", unknown>>; (this: That, params: ", + "TermvectorsRequest", + " | ", + "TermvectorsRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "TermvectorsResponse", + ">; }; textStructure: ", + "default", + "; transform: ", + "default", + "; updateByQuery: { (this: That, params: ", + "UpdateByQueryRequest", + " | ", + "UpdateByQueryRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "UpdateByQueryResponse", + ">; (this: That, params: ", + "UpdateByQueryRequest", + " | ", + "UpdateByQueryRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "UpdateByQueryResponse", + ", unknown>>; (this: That, params: ", + "UpdateByQueryRequest", + " | ", + "UpdateByQueryRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "UpdateByQueryResponse", + ">; }; updateByQueryRethrottle: { (this: That, params: ", + "UpdateByQueryRethrottleRequest", + " | ", + "UpdateByQueryRethrottleRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "UpdateByQueryRethrottleResponse", + ">; (this: That, params: ", + "UpdateByQueryRethrottleRequest", + " | ", + "UpdateByQueryRethrottleRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "UpdateByQueryRethrottleResponse", + ", unknown>>; (this: That, params: ", + "UpdateByQueryRethrottleRequest", + " | ", + "UpdateByQueryRethrottleRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "UpdateByQueryRethrottleResponse", + ">; }; watcher: ", + "default", + "; xpack: ", + "default", + "; }" ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", + "path": "src/plugins/data_views/server/types.ts", "deprecated": false }, { "parentPluginId": "data", - "id": "def-server.esKuery.toElasticsearchQuery.$3", + "id": "def-server.DataViewsServerPluginStart.dataViewsServiceFactory.$3", "type": "Object", "tags": [], - "label": "config", + "label": "request", "description": [], "signature": [ - "KueryQueryOptions", - " | undefined" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + " | undefined" ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", + "path": "src/plugins/data_views/server/types.ts", "deprecated": false }, { "parentPluginId": "data", - "id": "def-server.esKuery.toElasticsearchQuery.$4", - "type": "Object", + "id": "def-server.DataViewsServerPluginStart.dataViewsServiceFactory.$4", + "type": "CompoundType", "tags": [], - "label": "context", + "label": "byPassCapabilities", "description": [], "signature": [ - "Record | undefined" + "boolean | undefined" ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", + "path": "src/plugins/data_views/server/types.ts", "deprecated": false } ] @@ -19417,2298 +19110,2906 @@ }, { "parentPluginId": "data", - "id": "def-server.esQuery", - "type": "Object", + "id": "def-server.FieldDescriptor", + "type": "Interface", "tags": [], - "label": "esQuery", + "label": "FieldDescriptor", "description": [], - "path": "src/plugins/data/server/deprecated.ts", + "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", "deprecated": false, "children": [ { "parentPluginId": "data", - "id": "def-server.esQuery.buildQueryFromFilters", - "type": "Function", + "id": "def-server.FieldDescriptor.aggregatable", + "type": "boolean", "tags": [], - "label": "buildQueryFromFilters", + "label": "aggregatable", + "description": [], + "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.FieldDescriptor.name", + "type": "string", + "tags": [], + "label": "name", + "description": [], + "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.FieldDescriptor.readFromDocValues", + "type": "boolean", + "tags": [], + "label": "readFromDocValues", + "description": [], + "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.FieldDescriptor.searchable", + "type": "boolean", + "tags": [], + "label": "searchable", + "description": [], + "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.FieldDescriptor.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.FieldDescriptor.esTypes", + "type": "Array", + "tags": [], + "label": "esTypes", "description": [], "signature": [ - "(filters: ", - "Filter", - "[] | undefined, indexPattern: ", - "DataViewBase", - " | undefined, ignoreFilterIfFieldNotInIndex?: boolean | undefined) => ", - "BoolQuery" + "string[]" ], - "path": "src/plugins/data/server/deprecated.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-server.esQuery.buildQueryFromFilters.$1", - "type": "Array", - "tags": [], - "label": "filters", - "description": [], - "signature": [ - "Filter", - "[] | undefined" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.esQuery.buildQueryFromFilters.$2", - "type": "Object", - "tags": [], - "label": "indexPattern", - "description": [], - "signature": [ - "DataViewBase", - " | undefined" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.esQuery.buildQueryFromFilters.$3", - "type": "CompoundType", - "tags": [], - "label": "ignoreFilterIfFieldNotInIndex", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ] + "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", + "deprecated": false }, { "parentPluginId": "data", - "id": "def-server.esQuery.getEsQueryConfig", - "type": "Function", + "id": "def-server.FieldDescriptor.subType", + "type": "Object", "tags": [], - "label": "getEsQueryConfig", + "label": "subType", "description": [], "signature": [ - "(config: KibanaConfig) => ", - "EsQueryConfig" + "FieldSubType | undefined" ], - "path": "src/plugins/data/server/deprecated.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-server.esQuery.getEsQueryConfig.$1", - "type": "Object", - "tags": [], - "label": "config", - "description": [], - "signature": [ - "KibanaConfig" - ], - "path": "src/plugins/data/common/es_query/get_es_query_config.ts", - "deprecated": false - } - ] + "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", + "deprecated": false }, { "parentPluginId": "data", - "id": "def-server.esQuery.buildEsQuery", - "type": "Function", + "id": "def-server.FieldDescriptor.metadata_field", + "type": "CompoundType", + "tags": [], + "label": "metadata_field", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-server.IEsSearchRequest", + "type": "Interface", + "tags": [], + "label": "IEsSearchRequest", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IEsSearchRequest", + "text": "IEsSearchRequest" + }, + " extends ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IKibanaSearchRequest", + "text": "IKibanaSearchRequest" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchRequestParams", + "text": "ISearchRequestParams" + }, + ">" + ], + "path": "src/plugins/data/common/search/strategies/es_search/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.IEsSearchRequest.indexType", + "type": "string", "tags": [], - "label": "buildEsQuery", + "label": "indexType", "description": [], "signature": [ - "(indexPattern: ", - "DataViewBase", - " | undefined, queries: ", - "Query", - " | ", - "Query", - "[], filters: ", - "Filter", - " | ", - "Filter", - "[], config?: ", - "EsQueryConfig", - " | undefined) => { bool: ", - "BoolQuery", - "; }" + "string | undefined" ], - "path": "src/plugins/data/server/deprecated.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-server.esQuery.buildEsQuery.$1", - "type": "Object", - "tags": [], - "label": "indexPattern", - "description": [], - "signature": [ - "DataViewBase", - " | undefined" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.esQuery.buildEsQuery.$2", - "type": "CompoundType", - "tags": [], - "label": "queries", - "description": [], - "signature": [ - "Query", - " | ", - "Query", - "[]" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.esQuery.buildEsQuery.$3", - "type": "CompoundType", - "tags": [], - "label": "filters", - "description": [], - "signature": [ - "Filter", - " | ", - "Filter", - "[]" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.esQuery.buildEsQuery.$4", - "type": "CompoundType", - "tags": [], - "label": "config", - "description": [], - "signature": [ - "EsQueryConfig", - " | undefined" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ] + "path": "src/plugins/data/common/search/strategies/es_search/types.ts", + "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "data", - "id": "def-server.exporters", - "type": "Object", + "id": "def-server.ISearchOptions", + "type": "Interface", "tags": [], - "label": "exporters", + "label": "ISearchOptions", "description": [], - "path": "src/plugins/data/server/index.ts", + "path": "src/plugins/data/common/search/types.ts", "deprecated": false, "children": [ { "parentPluginId": "data", - "id": "def-server.exporters.datatableToCSV", - "type": "Function", + "id": "def-server.ISearchOptions.abortSignal", + "type": "Object", "tags": [], - "label": "datatableToCSV", - "description": [], + "label": "abortSignal", + "description": [ + "\nAn `AbortSignal` that allows the caller of `search` to abort a search request." + ], + "signature": [ + "AbortSignal | undefined" + ], + "path": "src/plugins/data/common/search/types.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.ISearchOptions.strategy", + "type": "string", + "tags": [], + "label": "strategy", + "description": [ + "\nUse this option to force using a specific server side search strategy. Leave empty to use the default strategy." + ], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data/common/search/types.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.ISearchOptions.legacyHitsTotal", + "type": "CompoundType", + "tags": [], + "label": "legacyHitsTotal", + "description": [ + "\nRequest the legacy format for the total number of hits. If sending `rest_total_hits_as_int` to\nsomething other than `true`, this should be set to `false`." + ], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/data/common/search/types.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.ISearchOptions.sessionId", + "type": "string", + "tags": [], + "label": "sessionId", + "description": [ + "\nA session ID, grouping multiple search requests into a single session." + ], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data/common/search/types.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.ISearchOptions.isStored", + "type": "CompoundType", + "tags": [], + "label": "isStored", + "description": [ + "\nWhether the session is already saved (i.e. sent to background)" + ], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/data/common/search/types.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.ISearchOptions.isRestore", + "type": "CompoundType", + "tags": [], + "label": "isRestore", + "description": [ + "\nWhether the session is restored (i.e. search requests should re-use the stored search IDs,\nrather than starting from scratch)" + ], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/data/common/search/types.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.ISearchOptions.indexPattern", + "type": "Object", + "tags": [], + "label": "indexPattern", + "description": [ + "\nIndex pattern reference is used for better error messages" + ], "signature": [ - "({ columns, rows }: ", { - "pluginId": "expressions", + "pluginId": "dataViews", "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.Datatable", - "text": "Datatable" + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" }, - ", { csvSeparator, quoteValues, formatFactory, raw, escapeFormulaValues }: CSVOptions) => string" + " | undefined" ], - "path": "src/plugins/data/server/index.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-server.exporters.datatableToCSV.$1", - "type": "Object", - "tags": [], - "label": "__0", - "description": [], - "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.Datatable", - "text": "Datatable" - } - ], - "path": "src/plugins/data/common/exports/export_csv.tsx", - "deprecated": false - }, + "path": "src/plugins/data/common/search/types.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.ISearchOptions.inspector", + "type": "Object", + "tags": [], + "label": "inspector", + "description": [ + "\nInspector integration options" + ], + "signature": [ { - "parentPluginId": "data", - "id": "def-server.exporters.datatableToCSV.$2", - "type": "Object", - "tags": [], - "label": "__1", - "description": [], - "signature": [ - "CSVOptions" - ], - "path": "src/plugins/data/common/exports/export_csv.tsx", - "deprecated": false - } - ] + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IInspectorInfo", + "text": "IInspectorInfo" + }, + " | undefined" + ], + "path": "src/plugins/data/common/search/types.ts", + "deprecated": false }, { "parentPluginId": "data", - "id": "def-server.exporters.CSV_MIME_TYPE", - "type": "string", + "id": "def-server.ISearchOptions.executionContext", + "type": "Object", "tags": [], - "label": "CSV_MIME_TYPE", + "label": "executionContext", "description": [], - "path": "src/plugins/data/server/index.ts", + "signature": [ + "KibanaExecutionContext", + " | undefined" + ], + "path": "src/plugins/data/common/search/types.ts", "deprecated": false } ], "initialIsOpen": false + } + ], + "enums": [ + { + "parentPluginId": "data", + "id": "def-server.ES_FIELD_TYPES", + "type": "Enum", + "tags": [], + "label": "ES_FIELD_TYPES", + "description": [], + "signature": [ + "ES_FIELD_TYPES" + ], + "path": "node_modules/@types/kbn__field-types/index.d.ts", + "deprecated": false, + "initialIsOpen": false }, { "parentPluginId": "data", - "id": "def-server.search", - "type": "Object", + "id": "def-server.KBN_FIELD_TYPES", + "type": "Enum", "tags": [], - "label": "search", + "label": "KBN_FIELD_TYPES", "description": [], - "path": "src/plugins/data/server/index.ts", + "signature": [ + "KBN_FIELD_TYPES" + ], + "path": "node_modules/@types/kbn__field-types/index.d.ts", "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-server.search.aggs", - "type": "Object", - "tags": [], - "label": "aggs", - "description": [], - "path": "src/plugins/data/server/index.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-server.search.aggs.CidrMask", - "type": "Object", - "tags": [], - "label": "CidrMask", - "description": [], - "signature": [ - "typeof ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.CidrMask", - "text": "CidrMask" - } - ], - "path": "src/plugins/data/server/index.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.search.aggs.dateHistogramInterval", - "type": "Function", - "tags": [], - "label": "dateHistogramInterval", - "description": [], - "signature": [ - "(interval: string) => Interval" - ], - "path": "src/plugins/data/server/index.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-server.search.aggs.dateHistogramInterval.$1", - "type": "string", - "tags": [], - "label": "interval", - "description": [], - "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/date_histogram_interval.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "data", - "id": "def-server.search.aggs.IpAddress", - "type": "Object", - "tags": [], - "label": "IpAddress", - "description": [], - "signature": [ - "typeof ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.IpAddress", - "text": "IpAddress" - } - ], - "path": "src/plugins/data/server/index.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.search.aggs.parseInterval", - "type": "Function", - "tags": [], - "label": "parseInterval", - "description": [], - "signature": [ - "(interval: string) => moment.Duration | null" - ], - "path": "src/plugins/data/server/index.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-server.search.aggs.parseInterval.$1", - "type": "string", - "tags": [], - "label": "interval", - "description": [], - "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_interval.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "data", - "id": "def-server.search.aggs.calcAutoIntervalLessThan", - "type": "Function", - "tags": [], - "label": "calcAutoIntervalLessThan", - "description": [], - "signature": [ - "(maxBucketCount: number, duration: number) => moment.Duration" - ], - "path": "src/plugins/data/server/index.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-server.search.aggs.calcAutoIntervalLessThan.$1", - "type": "number", - "tags": [], - "label": "maxBucketCount", - "description": [], - "path": "src/plugins/data/common/search/aggs/buckets/lib/time_buckets/calc_auto_interval.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.search.aggs.calcAutoIntervalLessThan.$2", - "type": "number", - "tags": [], - "label": "duration", - "description": [], - "path": "src/plugins/data/common/search/aggs/buckets/lib/time_buckets/calc_auto_interval.ts", - "deprecated": false - } - ] - } - ] - } + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-server.METRIC_TYPES", + "type": "Enum", + "tags": [], + "label": "METRIC_TYPES", + "description": [], + "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_types.ts", + "deprecated": false, + "initialIsOpen": false + } + ], + "misc": [ + { + "parentPluginId": "data", + "id": "def-server.DEFAULT_QUERY_LANGUAGE", + "type": "string", + "tags": [], + "label": "DEFAULT_QUERY_LANGUAGE", + "description": [], + "signature": [ + "\"kuery\"" ], + "path": "src/plugins/data/common/constants.ts", + "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", - "id": "def-server.UI_SETTINGS", - "type": "Object", + "id": "def-server.ES_SEARCH_STRATEGY", + "type": "string", "tags": [], - "label": "UI_SETTINGS", + "label": "ES_SEARCH_STRATEGY", + "description": [], + "signature": [ + "\"es\"" + ], + "path": "src/plugins/data/common/search/strategies/es_search/types.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-server.EsQueryConfig", + "type": "Type", + "tags": [ + "deprecated" + ], + "label": "EsQueryConfig", + "description": [], + "signature": [ + "KueryQueryOptions", + " & { allowLeadingWildcards: boolean; queryStringOptions: ", + "SerializableRecord", + "; ignoreFilterIfFieldNotInIndex: boolean; }" + ], + "path": "src/plugins/data/common/es_query/index.ts", + "deprecated": true, + "removeBy": "8.1", + "references": [], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-server.Filter", + "type": "Type", + "tags": [ + "deprecated" + ], + "label": "Filter", "description": [], "signature": [ - "{ readonly META_FIELDS: \"metaFields\"; readonly DOC_HIGHLIGHT: \"doc_table:highlight\"; readonly QUERY_STRING_OPTIONS: \"query:queryString:options\"; readonly QUERY_ALLOW_LEADING_WILDCARDS: \"query:allowLeadingWildcards\"; readonly SEARCH_QUERY_LANGUAGE: \"search:queryLanguage\"; readonly SORT_OPTIONS: \"sort:options\"; readonly COURIER_IGNORE_FILTER_IF_FIELD_NOT_IN_INDEX: \"courier:ignoreFilterIfFieldNotInIndex\"; readonly COURIER_SET_REQUEST_PREFERENCE: \"courier:setRequestPreference\"; readonly COURIER_CUSTOM_REQUEST_PREFERENCE: \"courier:customRequestPreference\"; readonly COURIER_MAX_CONCURRENT_SHARD_REQUESTS: \"courier:maxConcurrentShardRequests\"; readonly SEARCH_INCLUDE_FROZEN: \"search:includeFrozen\"; readonly SEARCH_TIMEOUT: \"search:timeout\"; readonly HISTOGRAM_BAR_TARGET: \"histogram:barTarget\"; readonly HISTOGRAM_MAX_BARS: \"histogram:maxBars\"; readonly HISTORY_LIMIT: \"history:limit\"; readonly TIMEPICKER_REFRESH_INTERVAL_DEFAULTS: \"timepicker:refreshIntervalDefaults\"; readonly TIMEPICKER_QUICK_RANGES: \"timepicker:quickRanges\"; readonly TIMEPICKER_TIME_DEFAULTS: \"timepicker:timeDefaults\"; readonly FILTERS_PINNED_BY_DEFAULT: \"filters:pinnedByDefault\"; readonly FILTERS_EDITOR_SUGGEST_VALUES: \"filterEditor:suggestValues\"; readonly AUTOCOMPLETE_USE_TIMERANGE: \"autocomplete:useTimeRange\"; readonly AUTOCOMPLETE_VALUE_SUGGESTION_METHOD: \"autocomplete:valueSuggestionMethod\"; readonly DATE_FORMAT: \"dateFormat\"; readonly DATEFORMAT_TZ: \"dateFormat:tz\"; }" + "{ $state?: { store: ", + "FilterStateStore", + "; } | undefined; meta: ", + "FilterMeta", + "; query?: Record | undefined; }" ], - "path": "src/plugins/data/common/constants.ts", - "deprecated": false, - "initialIsOpen": false - } - ], - "setup": { - "parentPluginId": "data", - "id": "def-server.DataPluginSetup", - "type": "Interface", - "tags": [], - "label": "DataPluginSetup", - "description": [], - "path": "src/plugins/data/server/plugin.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-server.DataPluginSetup.search", - "type": "Object", - "tags": [], - "label": "search", - "description": [], - "signature": [ - "ISearchSetup" - ], - "path": "src/plugins/data/server/plugin.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.DataPluginSetup.query", - "type": "Object", - "tags": [], - "label": "query", - "description": [], - "signature": [ - "QuerySetup" - ], - "path": "src/plugins/data/server/plugin.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.DataPluginSetup.fieldFormats", - "type": "Object", - "tags": [ - "deprecated" - ], - "label": "fieldFormats", - "description": [], - "signature": [ - { - "pluginId": "fieldFormats", - "scope": "server", - "docId": "kibFieldFormatsPluginApi", - "section": "def-server.FieldFormatsSetup", - "text": "FieldFormatsSetup" - } - ], - "path": "src/plugins/data/server/plugin.ts", - "deprecated": true, - "references": [] - } - ], - "lifecycle": "setup", - "initialIsOpen": true - }, - "start": { - "parentPluginId": "data", - "id": "def-server.DataPluginStart", - "type": "Interface", - "tags": [], - "label": "DataPluginStart", - "description": [], - "path": "src/plugins/data/server/plugin.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-server.DataPluginStart.search", - "type": "Object", - "tags": [], - "label": "search", - "description": [], - "signature": [ - "ISearchStart", - "<", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.IEsSearchRequest", - "text": "IEsSearchRequest" - }, - ", ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.IEsSearchResponse", - "text": "IEsSearchResponse" - }, - ">" - ], - "path": "src/plugins/data/server/plugin.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.DataPluginStart.fieldFormats", - "type": "Object", - "tags": [ - "deprecated" - ], - "label": "fieldFormats", - "description": [], - "signature": [ - { - "pluginId": "fieldFormats", - "scope": "server", - "docId": "kibFieldFormatsPluginApi", - "section": "def-server.FieldFormatsStart", - "text": "FieldFormatsStart" - } - ], - "path": "src/plugins/data/server/plugin.ts", - "deprecated": true, - "references": [ - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/plugin.ts" - } - ] - }, - { - "parentPluginId": "data", - "id": "def-server.DataPluginStart.indexPatterns", - "type": "Object", - "tags": [], - "label": "indexPatterns", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "server", - "docId": "kibDataViewsPluginApi", - "section": "def-server.DataViewsServerPluginStart", - "text": "DataViewsServerPluginStart" - } - ], - "path": "src/plugins/data/server/plugin.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.DataPluginStart.datatableUtilities", - "type": "Object", - "tags": [], - "label": "datatableUtilities", - "description": [ - "\nDatatable type utility functions." - ], - "signature": [ - "DatatableUtilitiesService" - ], - "path": "src/plugins/data/server/plugin.ts", - "deprecated": false - } - ], - "lifecycle": "start", - "initialIsOpen": true - } - }, - "common": { - "classes": [ + "path": "src/plugins/data/common/es_query/index.ts", + "deprecated": true, + "removeBy": "8.1", + "references": [ + { + "plugin": "discover", + "path": "src/plugins/discover/public/application/view_alert/view_alert_route.tsx" + }, + { + "plugin": "discover", + "path": "src/plugins/discover/public/application/view_alert/view_alert_route.tsx" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/application/lib/filter_utils.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/application/lib/filter_utils.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/application/lib/filter_utils.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/application/lib/filter_utils.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/application/lib/filter_utils.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/application/state/dashboard_state_slice.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/application/state/dashboard_state_slice.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/application/state/dashboard_state_slice.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/application/lib/sync_dashboard_filter_state.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/application/lib/sync_dashboard_filter_state.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/application/lib/sync_dashboard_filter_state.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx" + }, + { + "plugin": "lens", + "path": "x-pack/plugins/lens/public/trigger_actions/open_in_discover_drilldown.tsx" + }, + { + "plugin": "lens", + "path": "x-pack/plugins/lens/public/trigger_actions/open_in_discover_drilldown.tsx" + }, + { + "plugin": "urlDrilldown", + "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/variables/context_variables.ts" + }, + { + "plugin": "urlDrilldown", + "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/variables/context_variables.ts" + }, + { + "plugin": "urlDrilldown", + "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/url_drilldown.tsx" + }, + { + "plugin": "urlDrilldown", + "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/url_drilldown.tsx" + }, + { + "plugin": "urlDrilldown", + "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/test/data.ts" + }, + { + "plugin": "urlDrilldown", + "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/test/data.ts" + } + ], + "initialIsOpen": false + }, { "parentPluginId": "data", - "id": "def-common.DatatableUtilitiesService", - "type": "Class", + "id": "def-server.IEsSearchResponse", + "type": "Type", "tags": [], - "label": "DatatableUtilitiesService", + "label": "IEsSearchResponse", "description": [], - "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IKibanaSearchResponse", + "text": "IKibanaSearchResponse" + }, + "<", + "SearchResponse", + ">>" + ], + "path": "src/plugins/data/common/search/strategies/es_search/types.ts", "deprecated": false, - "children": [ + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-server.KueryNode", + "type": "Type", + "tags": [ + "deprecated" + ], + "label": "KueryNode", + "description": [], + "signature": [ + "KueryNode" + ], + "path": "src/plugins/data/common/es_query/index.ts", + "deprecated": true, + "removeBy": "8.1", + "references": [], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-server.ParsedInterval", + "type": "Type", + "tags": [], + "label": "ParsedInterval", + "description": [], + "signature": [ + "{ value: number; unit: ", + "Unit", + "; type: \"calendar\" | \"fixed\"; }" + ], + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_es_interval.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-server.Query", + "type": "Type", + "tags": [], + "label": "Query", + "description": [], + "signature": [ + "{ query: string | { [key: string]: any; }; language: string; }" + ], + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-server.TimeRange", + "type": "Type", + "tags": [ + "deprecated", + "deprecated" + ], + "label": "TimeRange", + "description": [ + "\n" + ], + "signature": [ + "{ from: string; to: string; mode?: \"absolute\" | \"relative\" | undefined; }" + ], + "path": "src/plugins/data/common/es_query/index.ts", + "deprecated": true, + "removeBy": "8.1", + "references": [ + { + "plugin": "infra", + "path": "x-pack/plugins/infra/public/pages/logs/log_entry_rate/use_log_entry_rate_results_url_state.tsx" + }, + { + "plugin": "discover", + "path": "src/plugins/discover/public/locator.ts" + }, + { + "plugin": "discover", + "path": "src/plugins/discover/public/locator.ts" + }, + { + "plugin": "discover", + "path": "src/plugins/discover/public/embeddable/types.ts" + }, + { + "plugin": "discover", + "path": "src/plugins/discover/public/embeddable/types.ts" + }, + { + "plugin": "discover", + "path": "src/plugins/discover/public/embeddable/saved_search_embeddable.tsx" + }, + { + "plugin": "discover", + "path": "src/plugins/discover/public/embeddable/saved_search_embeddable.tsx" + }, + { + "plugin": "discover", + "path": "src/plugins/discover/public/embeddable/search_embeddable_factory.ts" + }, + { + "plugin": "discover", + "path": "src/plugins/discover/public/embeddable/search_embeddable_factory.ts" + }, + { + "plugin": "discover", + "path": "src/plugins/discover/public/application/main/components/layout/types.ts" + }, + { + "plugin": "discover", + "path": "src/plugins/discover/public/application/main/components/layout/types.ts" + }, + { + "plugin": "discover", + "path": "src/plugins/discover/public/application/main/components/top_nav/discover_topnav.tsx" + }, + { + "plugin": "discover", + "path": "src/plugins/discover/public/application/main/components/top_nav/discover_topnav.tsx" + }, + { + "plugin": "visualizations", + "path": "src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx" + }, + { + "plugin": "visualizations", + "path": "src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx" + }, + { + "plugin": "visualizations", + "path": "src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx" + }, + { + "plugin": "visualizations", + "path": "src/plugins/visualizations/public/visualize_app/types.ts" + }, + { + "plugin": "visualizations", + "path": "src/plugins/visualizations/public/visualize_app/types.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/application/lib/filter_utils.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/application/lib/filter_utils.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/application/state/dashboard_state_slice.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/application/state/dashboard_state_slice.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/application/lib/convert_dashboard_state.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/application/lib/convert_dashboard_state.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/types.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/types.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/types.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/application/top_nav/show_share_modal.tsx" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/application/top_nav/show_share_modal.tsx" + }, + { + "plugin": "controls", + "path": "src/plugins/controls/public/services/kibana/options_list.ts" + }, + { + "plugin": "controls", + "path": "src/plugins/controls/public/services/kibana/options_list.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/locator.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/locator.ts" + }, + { + "plugin": "uiActionsEnhanced", + "path": "x-pack/plugins/ui_actions_enhanced/public/customize_time_range_modal.tsx" + }, + { + "plugin": "uiActionsEnhanced", + "path": "x-pack/plugins/ui_actions_enhanced/public/customize_time_range_modal.tsx" + }, + { + "plugin": "uiActionsEnhanced", + "path": "x-pack/plugins/ui_actions_enhanced/public/custom_time_range_action.tsx" + }, + { + "plugin": "uiActionsEnhanced", + "path": "x-pack/plugins/ui_actions_enhanced/public/custom_time_range_action.tsx" + }, + { + "plugin": "uiActionsEnhanced", + "path": "x-pack/plugins/ui_actions_enhanced/public/custom_time_range_badge.tsx" + }, + { + "plugin": "uiActionsEnhanced", + "path": "x-pack/plugins/ui_actions_enhanced/public/custom_time_range_badge.tsx" + }, + { + "plugin": "lens", + "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx" + }, + { + "plugin": "lens", + "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx" + }, + { + "plugin": "lens", + "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx" + }, + { + "plugin": "lens", + "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx" + }, + { + "plugin": "lens", + "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx" + }, + { + "plugin": "lens", + "path": "x-pack/plugins/lens/public/trigger_actions/open_in_discover_helpers.ts" + }, + { + "plugin": "lens", + "path": "x-pack/plugins/lens/public/trigger_actions/open_in_discover_helpers.ts" + }, + { + "plugin": "lens", + "path": "x-pack/plugins/lens/public/trigger_actions/open_in_discover_drilldown.tsx" + }, + { + "plugin": "lens", + "path": "x-pack/plugins/lens/public/trigger_actions/open_in_discover_drilldown.tsx" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/reducers/map/types.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/reducers/map/types.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/selectors/map_selectors.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/selectors/map_selectors.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/actions/map_actions.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/actions/map_actions.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/routes/map_page/saved_map/types.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/routes/map_page/saved_map/types.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/routes/map_page/url_state/global_sync.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/routes/map_page/url_state/global_sync.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/routes/map_page/map_app/index.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/routes/map_page/map_app/index.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/locators.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/locators.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/locators.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/locators.ts" + }, + { + "plugin": "dataVisualizer", + "path": "x-pack/plugins/data_visualizer/public/application/common/components/results_links/results_links.tsx" + }, + { + "plugin": "dataVisualizer", + "path": "x-pack/plugins/data_visualizer/public/application/common/components/results_links/results_links.tsx" + }, + { + "plugin": "dataVisualizer", + "path": "x-pack/plugins/data_visualizer/public/application/common/components/date_picker_wrapper/date_picker_wrapper.tsx" + }, + { + "plugin": "dataVisualizer", + "path": "x-pack/plugins/data_visualizer/public/application/common/components/date_picker_wrapper/date_picker_wrapper.tsx" + }, + { + "plugin": "ml", + "path": "x-pack/plugins/ml/public/application/services/anomaly_timeline_service.ts" + }, + { + "plugin": "ml", + "path": "x-pack/plugins/ml/public/application/services/anomaly_timeline_service.ts" + }, + { + "plugin": "ml", + "path": "x-pack/plugins/ml/public/application/services/anomaly_timeline_service.ts" + }, + { + "plugin": "ml", + "path": "x-pack/plugins/ml/public/application/services/anomaly_explorer_charts_service.ts" + }, + { + "plugin": "ml", + "path": "x-pack/plugins/ml/public/application/services/anomaly_explorer_charts_service.ts" + }, + { + "plugin": "ml", + "path": "x-pack/plugins/ml/public/application/services/anomaly_explorer_charts_service.ts" + }, + { + "plugin": "ml", + "path": "x-pack/plugins/ml/public/application/components/navigation_menu/date_picker_wrapper/date_picker_wrapper.tsx" + }, + { + "plugin": "ml", + "path": "x-pack/plugins/ml/public/application/components/navigation_menu/date_picker_wrapper/date_picker_wrapper.tsx" + }, + { + "plugin": "infra", + "path": "x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx" + }, + { + "plugin": "infra", + "path": "x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx" + }, + { + "plugin": "infra", + "path": "x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx" + }, + { + "plugin": "infra", + "path": "x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx" + }, + { + "plugin": "infra", + "path": "x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx" + }, + { + "plugin": "infra", + "path": "x-pack/plugins/infra/public/components/log_stream/log_stream_embeddable.tsx" + }, + { + "plugin": "infra", + "path": "x-pack/plugins/infra/public/components/log_stream/log_stream_embeddable.tsx" + }, + { + "plugin": "infra", + "path": "x-pack/plugins/infra/public/pages/logs/log_entry_rate/use_log_entry_rate_results_url_state.tsx" + }, + { + "plugin": "infra", + "path": "x-pack/plugins/infra/public/pages/logs/log_entry_rate/use_log_entry_rate_results_url_state.tsx" + }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/agent_logs.tsx" + }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/agent_logs.tsx" + }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/agent_logs.tsx" + }, + { + "plugin": "canvas", + "path": "x-pack/plugins/canvas/types/embeddables.ts" + }, + { + "plugin": "canvas", + "path": "x-pack/plugins/canvas/types/embeddables.ts" + }, + { + "plugin": "dashboardEnhanced", + "path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/embeddable_to_dashboard_drilldown/embeddable_to_dashboard_drilldown.tsx" + }, + { + "plugin": "dashboardEnhanced", + "path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/embeddable_to_dashboard_drilldown/embeddable_to_dashboard_drilldown.tsx" + }, + { + "plugin": "discoverEnhanced", + "path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts" + }, + { + "plugin": "discoverEnhanced", + "path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts" + }, + { + "plugin": "monitoring", + "path": "x-pack/plugins/monitoring/public/url_state.ts" + }, + { + "plugin": "monitoring", + "path": "x-pack/plugins/monitoring/public/url_state.ts" + }, + { + "plugin": "monitoring", + "path": "x-pack/plugins/monitoring/public/application/contexts/global_state_context.tsx" + }, + { + "plugin": "monitoring", + "path": "x-pack/plugins/monitoring/public/application/contexts/global_state_context.tsx" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/public/common/components/query_bar/index.tsx" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/public/common/components/query_bar/index.tsx" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/public/common/components/query_bar/index.tsx" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/public/common/components/search_bar/index.tsx" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/public/common/components/search_bar/index.tsx" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/public/common/components/search_bar/index.tsx" + }, + { + "plugin": "uiActionsEnhanced", + "path": "x-pack/plugins/ui_actions_enhanced/public/can_inherit_time_range.ts" + }, + { + "plugin": "uiActionsEnhanced", + "path": "x-pack/plugins/ui_actions_enhanced/public/can_inherit_time_range.ts" + }, + { + "plugin": "uiActionsEnhanced", + "path": "x-pack/plugins/ui_actions_enhanced/public/test_helpers/time_range_embeddable.ts" + }, + { + "plugin": "uiActionsEnhanced", + "path": "x-pack/plugins/ui_actions_enhanced/public/test_helpers/time_range_embeddable.ts" + }, + { + "plugin": "uiActionsEnhanced", + "path": "x-pack/plugins/ui_actions_enhanced/public/test_helpers/time_range_container.ts" + }, + { + "plugin": "uiActionsEnhanced", + "path": "x-pack/plugins/ui_actions_enhanced/public/test_helpers/time_range_container.ts" + }, + { + "plugin": "uiActionsEnhanced", + "path": "x-pack/plugins/ui_actions_enhanced/public/test_helpers/time_range_container.ts" + }, + { + "plugin": "urlDrilldown", + "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/variables/context_variables.ts" + }, + { + "plugin": "urlDrilldown", + "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/variables/context_variables.ts" + }, + { + "plugin": "urlDrilldown", + "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/url_drilldown.tsx" + }, + { + "plugin": "urlDrilldown", + "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/url_drilldown.tsx" + }, + { + "plugin": "uiActionsEnhanced", + "path": "x-pack/plugins/ui_actions_enhanced/public/test_helpers/time_range_embeddable_factory.ts" + }, + { + "plugin": "uiActionsEnhanced", + "path": "x-pack/plugins/ui_actions_enhanced/public/test_helpers/time_range_embeddable_factory.ts" + }, + { + "plugin": "urlDrilldown", + "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/test/data.ts" + }, + { + "plugin": "urlDrilldown", + "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/test/data.ts" + }, + { + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/components/agg.tsx" + }, + { + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/components/agg.tsx" + }, + { + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/components/agg_group.tsx" + }, + { + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/components/agg_group.tsx" + }, + { + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/components/sidebar/data_tab.tsx" + }, + { + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/components/sidebar/data_tab.tsx" + }, + { + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/components/sidebar/sidebar.tsx" + }, + { + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/components/sidebar/sidebar.tsx" + }, + { + "plugin": "visTypeTimelion", + "path": "src/plugins/vis_types/timelion/public/timelion_vis_fn.ts" + }, + { + "plugin": "visTypeTimelion", + "path": "src/plugins/vis_types/timelion/public/timelion_vis_fn.ts" + }, + { + "plugin": "visTypeTimelion", + "path": "src/plugins/vis_types/timelion/public/helpers/timelion_request_handler.ts" + }, + { + "plugin": "visTypeTimelion", + "path": "src/plugins/vis_types/timelion/public/helpers/timelion_request_handler.ts" + }, + { + "plugin": "visTypeTimeseries", + "path": "src/plugins/vis_types/timeseries/public/application/components/vis_editor.tsx" + }, + { + "plugin": "visTypeTimeseries", + "path": "src/plugins/vis_types/timeseries/public/application/components/vis_editor.tsx" + }, + { + "plugin": "visTypeVega", + "path": "src/plugins/vis_types/vega/public/vega_fn.ts" + }, + { + "plugin": "visTypeVega", + "path": "src/plugins/vis_types/vega/public/vega_fn.ts" + }, + { + "plugin": "visTypeVega", + "path": "src/plugins/vis_types/vega/public/vega_request_handler.ts" + }, + { + "plugin": "visTypeVega", + "path": "src/plugins/vis_types/vega/public/vega_request_handler.ts" + }, + { + "plugin": "infra", + "path": "x-pack/plugins/infra/public/pages/logs/log_entry_rate/use_log_entry_rate_results_url_state.tsx" + }, + { + "plugin": "visualizations", + "path": "src/plugins/visualizations/common/locator.ts" + }, + { + "plugin": "visualizations", + "path": "src/plugins/visualizations/common/locator.ts" + }, + { + "plugin": "controls", + "path": "src/plugins/controls/common/types.ts" + }, + { + "plugin": "controls", + "path": "src/plugins/controls/common/types.ts" + }, + { + "plugin": "controls", + "path": "src/plugins/controls/common/control_types/options_list/types.ts" + }, + { + "plugin": "controls", + "path": "src/plugins/controls/common/control_types/options_list/types.ts" + }, + { + "plugin": "cases", + "path": "x-pack/plugins/cases/common/utils/markdown_plugins/lens/serializer.ts" + }, + { + "plugin": "cases", + "path": "x-pack/plugins/cases/common/utils/markdown_plugins/lens/serializer.ts" + }, { - "parentPluginId": "data", - "id": "def-common.DatatableUtilitiesService.Unnamed", - "type": "Function", - "tags": [], - "label": "Constructor", - "description": [], - "signature": [ - "any" - ], - "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.DatatableUtilitiesService.Unnamed.$1", - "type": "Object", - "tags": [], - "label": "aggs", - "description": [], - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggsCommonStart", - "text": "AggsCommonStart" - } - ], - "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "data", - "id": "def-common.DatatableUtilitiesService.Unnamed.$2", - "type": "Object", - "tags": [], - "label": "dataViews", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewsContract", - "text": "DataViewsContract" - } - ], - "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "data", - "id": "def-common.DatatableUtilitiesService.Unnamed.$3", - "type": "Object", - "tags": [], - "label": "fieldFormats", - "description": [], - "signature": [ - { - "pluginId": "fieldFormats", - "scope": "common", - "docId": "kibFieldFormatsPluginApi", - "section": "def-common.FieldFormatsStartCommon", - "text": "FieldFormatsStartCommon" - } - ], - "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] + "plugin": "cases", + "path": "x-pack/plugins/cases/common/utils/markdown_plugins/utils.ts" }, { - "parentPluginId": "data", - "id": "def-common.DatatableUtilitiesService.clearField", - "type": "Function", - "tags": [], - "label": "clearField", - "description": [], - "signature": [ - "(column: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.DatatableColumn", - "text": "DatatableColumn" - }, - ") => void" - ], - "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.DatatableUtilitiesService.clearField.$1", - "type": "Object", - "tags": [], - "label": "column", - "description": [], - "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.DatatableColumn", - "text": "DatatableColumn" - } - ], - "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] + "plugin": "cases", + "path": "x-pack/plugins/cases/common/utils/markdown_plugins/utils.ts" }, { - "parentPluginId": "data", - "id": "def-common.DatatableUtilitiesService.clearFieldFormat", - "type": "Function", - "tags": [], - "label": "clearFieldFormat", - "description": [], - "signature": [ - "(column: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.DatatableColumn", - "text": "DatatableColumn" - }, - ") => void" - ], - "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.DatatableUtilitiesService.clearFieldFormat.$1", - "type": "Object", - "tags": [], - "label": "column", - "description": [], - "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.DatatableColumn", - "text": "DatatableColumn" - } - ], - "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] + "plugin": "maps", + "path": "x-pack/plugins/maps/common/descriptor_types/data_request_descriptor_types.ts" }, { - "parentPluginId": "data", - "id": "def-common.DatatableUtilitiesService.getAggConfig", - "type": "Function", - "tags": [], - "label": "getAggConfig", - "description": [], - "signature": [ - "(column: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.DatatableColumn", - "text": "DatatableColumn" - }, - ") => Promise<", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggConfig", - "text": "AggConfig" - }, - " | undefined>" - ], - "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.DatatableUtilitiesService.getAggConfig.$1", - "type": "Object", - "tags": [], - "label": "column", - "description": [], - "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.DatatableColumn", - "text": "DatatableColumn" - } - ], - "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] + "plugin": "maps", + "path": "x-pack/plugins/maps/common/descriptor_types/data_request_descriptor_types.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/common/descriptor_types/data_request_descriptor_types.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/sources/es_source/es_source.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/sources/es_source/es_source.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/sources/es_source/es_source.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/legacy_visualizations/region_map/region_map_fn.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/legacy_visualizations/region_map/region_map_fn.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/embeddable/types.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/embeddable/types.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/connected_components/timeslider/timeslider.tsx" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/connected_components/timeslider/timeslider.tsx" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/routes/map_page/map_app/map_app.tsx" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/routes/map_page/map_app/map_app.tsx" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/routes/map_page/map_app/map_app.tsx" }, { - "parentPluginId": "data", - "id": "def-common.DatatableUtilitiesService.getDataView", - "type": "Function", - "tags": [], - "label": "getDataView", - "description": [], - "signature": [ - "(column: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.DatatableColumn", - "text": "DatatableColumn" - }, - ") => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - " | undefined>" - ], - "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.DatatableUtilitiesService.getDataView.$1", - "type": "Object", - "tags": [], - "label": "column", - "description": [], - "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.DatatableColumn", - "text": "DatatableColumn" - } - ], - "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] + "plugin": "maps", + "path": "x-pack/plugins/maps/public/routes/map_page/map_app/map_app.tsx" }, { - "parentPluginId": "data", - "id": "def-common.DatatableUtilitiesService.getField", - "type": "Function", - "tags": [], - "label": "getField", - "description": [], - "signature": [ - "(column: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.DatatableColumn", - "text": "DatatableColumn" - }, - ") => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" - }, - " | undefined>" - ], - "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.DatatableUtilitiesService.getField.$1", - "type": "Object", - "tags": [], - "label": "column", - "description": [], - "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.DatatableColumn", - "text": "DatatableColumn" - } - ], - "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] + "plugin": "maps", + "path": "x-pack/plugins/maps/public/embeddable/map_component.tsx" }, { - "parentPluginId": "data", - "id": "def-common.DatatableUtilitiesService.getFieldFormat", - "type": "Function", - "tags": [], - "label": "getFieldFormat", - "description": [], - "signature": [ - "(column: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.DatatableColumn", - "text": "DatatableColumn" - }, - ") => ", - { - "pluginId": "fieldFormats", - "scope": "common", - "docId": "kibFieldFormatsPluginApi", - "section": "def-common.FieldFormat", - "text": "FieldFormat" - }, - " | undefined" - ], - "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.DatatableUtilitiesService.getFieldFormat.$1", - "type": "Object", - "tags": [], - "label": "column", - "description": [], - "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.DatatableColumn", - "text": "DatatableColumn" - } - ], - "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] + "plugin": "maps", + "path": "x-pack/plugins/maps/public/embeddable/map_component.tsx" }, { - "parentPluginId": "data", - "id": "def-common.DatatableUtilitiesService.getInterval", - "type": "Function", - "tags": [], - "label": "getInterval", - "description": [], - "signature": [ - "(column: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.DatatableColumn", - "text": "DatatableColumn" - }, - ") => string | undefined" - ], - "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.DatatableUtilitiesService.getInterval.$1", - "type": "Object", - "tags": [], - "label": "column", - "description": [], - "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.DatatableColumn", - "text": "DatatableColumn" - } - ], - "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] + "plugin": "maps", + "path": "x-pack/plugins/maps/public/legacy_visualizations/region_map/region_map_visualization.tsx" }, { - "parentPluginId": "data", - "id": "def-common.DatatableUtilitiesService.getTotalCount", - "type": "Function", - "tags": [], - "label": "getTotalCount", - "description": [], - "signature": [ - "(table: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.Datatable", - "text": "Datatable" - }, - ") => number | undefined" - ], - "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.DatatableUtilitiesService.getTotalCount.$1", - "type": "Object", - "tags": [], - "label": "table", - "description": [], - "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.Datatable", - "text": "Datatable" - } - ], - "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] + "plugin": "maps", + "path": "x-pack/plugins/maps/public/legacy_visualizations/region_map/region_map_visualization.tsx" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/legacy_visualizations/tile_map/tile_map_fn.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/legacy_visualizations/tile_map/tile_map_fn.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/legacy_visualizations/tile_map/tile_map_visualization.tsx" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/legacy_visualizations/tile_map/tile_map_visualization.tsx" + }, + { + "plugin": "dataVisualizer", + "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/search_panel/search_panel.tsx" + }, + { + "plugin": "dataVisualizer", + "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/search_panel/search_panel.tsx" + }, + { + "plugin": "dataVisualizer", + "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/locator/locator.ts" }, { - "parentPluginId": "data", - "id": "def-common.DatatableUtilitiesService.isFilterable", - "type": "Function", - "tags": [], - "label": "isFilterable", - "description": [], - "signature": [ - "(column: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.DatatableColumn", - "text": "DatatableColumn" - }, - ") => boolean" - ], - "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.DatatableUtilitiesService.isFilterable.$1", - "type": "Object", - "tags": [], - "label": "column", - "description": [], - "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.DatatableColumn", - "text": "DatatableColumn" - } - ], - "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] + "plugin": "dataVisualizer", + "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/locator/locator.ts" }, { - "parentPluginId": "data", - "id": "def-common.DatatableUtilitiesService.setFieldFormat", - "type": "Function", - "tags": [], - "label": "setFieldFormat", - "description": [], - "signature": [ - "(column: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.DatatableColumn", - "text": "DatatableColumn" - }, - ", fieldFormat: ", - { - "pluginId": "fieldFormats", - "scope": "common", - "docId": "kibFieldFormatsPluginApi", - "section": "def-common.FieldFormat", - "text": "FieldFormat" - }, - ") => void" - ], - "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.DatatableUtilitiesService.setFieldFormat.$1", - "type": "Object", - "tags": [], - "label": "column", - "description": [], - "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.DatatableColumn", - "text": "DatatableColumn" - } - ], - "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "data", - "id": "def-common.DatatableUtilitiesService.setFieldFormat.$2", - "type": "Object", - "tags": [], - "label": "fieldFormat", - "description": [], - "signature": [ - { - "pluginId": "fieldFormats", - "scope": "common", - "docId": "kibFieldFormatsPluginApi", - "section": "def-common.FieldFormat", - "text": "FieldFormat" - } - ], - "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataView", - "type": "Class", - "tags": [], - "label": "DataView", - "description": [], - "signature": [ + "plugin": "ml", + "path": "x-pack/plugins/ml/common/util/date_utils.ts" + }, { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" + "plugin": "ml", + "path": "x-pack/plugins/ml/common/util/date_utils.ts" }, - " implements ", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IIndexPattern", - "text": "IIndexPattern" - } - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [ + "plugin": "ml", + "path": "x-pack/plugins/ml/common/util/date_utils.ts" + }, { - "parentPluginId": "data", - "id": "def-common.DataView.id", - "type": "string", - "tags": [], - "label": "id", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false + "plugin": "ml", + "path": "x-pack/plugins/ml/public/embeddables/types.ts" }, { - "parentPluginId": "data", - "id": "def-common.DataView.title", - "type": "string", - "tags": [], - "label": "title", - "description": [], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false + "plugin": "ml", + "path": "x-pack/plugins/ml/public/embeddables/types.ts" }, { - "parentPluginId": "data", - "id": "def-common.DataView.fieldFormatMap", - "type": "Object", - "tags": [], - "label": "fieldFormatMap", - "description": [], - "signature": [ - "{ [x: string]: any; }" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false + "plugin": "ml", + "path": "x-pack/plugins/ml/public/embeddables/types.ts" }, { - "parentPluginId": "data", - "id": "def-common.DataView.typeMeta", - "type": "Object", - "tags": [], - "label": "typeMeta", - "description": [ - "\nOnly used by rollup indices, used by rollup specific endpoint to load field list" - ], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.TypeMeta", - "text": "TypeMeta" - }, - " | undefined" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false + "plugin": "canvas", + "path": "x-pack/plugins/canvas/common/lib/build_embeddable_filters.ts" }, { - "parentPluginId": "data", - "id": "def-common.DataView.fields", - "type": "CompoundType", - "tags": [], - "label": "fields", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IIndexPatternFieldList", - "text": "IIndexPatternFieldList" - }, - " & { toSpec: () => ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewFieldMap", - "text": "DataViewFieldMap" - }, - "; }" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false + "plugin": "canvas", + "path": "x-pack/plugins/canvas/common/lib/build_embeddable_filters.ts" }, { - "parentPluginId": "data", - "id": "def-common.DataView.timeFieldName", - "type": "string", - "tags": [], - "label": "timeFieldName", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false + "plugin": "canvas", + "path": "x-pack/plugins/canvas/common/lib/build_embeddable_filters.ts" }, { - "parentPluginId": "data", - "id": "def-common.DataView.type", - "type": "string", - "tags": [], - "label": "type", - "description": [ - "\nType is used to identify rollup index patterns" - ], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false + "plugin": "canvas", + "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/external/saved_lens.ts" + }, + { + "plugin": "canvas", + "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/external/saved_lens.ts" + }, + { + "plugin": "canvas", + "path": "x-pack/plugins/canvas/public/functions/timelion.ts" + }, + { + "plugin": "canvas", + "path": "x-pack/plugins/canvas/public/functions/timelion.ts" + }, + { + "plugin": "lens", + "path": "x-pack/plugins/lens/common/expressions/time_scale/time_scale.test.ts" + }, + { + "plugin": "lens", + "path": "x-pack/plugins/lens/common/expressions/time_scale/time_scale.test.ts" + }, + { + "plugin": "visTypeVega", + "path": "src/plugins/vis_types/vega/public/data_model/time_cache.ts" }, + { + "plugin": "visTypeVega", + "path": "src/plugins/vis_types/vega/public/data_model/time_cache.ts" + }, + { + "plugin": "visTypeVega", + "path": "src/plugins/vis_types/vega/public/data_model/time_cache.ts" + } + ], + "initialIsOpen": false + } + ], + "objects": [ + { + "parentPluginId": "data", + "id": "def-server.esFilters", + "type": "Object", + "tags": [], + "label": "esFilters", + "description": [], + "path": "src/plugins/data/server/deprecated.ts", + "deprecated": false, + "children": [ { "parentPluginId": "data", - "id": "def-common.DataView.flattenHit", + "id": "def-server.esFilters.buildQueryFilter", "type": "Function", - "tags": [ - "deprecated" - ], - "label": "flattenHit", + "tags": [], + "label": "buildQueryFilter", "description": [], "signature": [ - "(hit: Record, deep?: boolean | undefined) => Record" + "(query: (Record & { query_string?: { query: string; fields?: string[] | undefined; } | undefined; }) | undefined, index: string, alias?: string | undefined, meta?: ", + "FilterMeta", + " | undefined) => { query: (Record & { query_string?: { query: string; fields?: string[] | undefined; } | undefined; }) | undefined; meta: { alias: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index: string; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; }; }" ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": true, - "references": [ + "path": "src/plugins/data/server/deprecated.ts", + "deprecated": false, + "returnComment": [], + "children": [ { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.ts" + "parentPluginId": "data", + "id": "def-server.esFilters.buildQueryFilter.$1", + "type": "CompoundType", + "tags": [], + "label": "query", + "description": [], + "signature": [ + "(Record & { query_string?: { query: string; fields?: string[] | undefined; } | undefined; }) | undefined" + ], + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx" + "parentPluginId": "data", + "id": "def-server.esFilters.buildQueryFilter.$2", + "type": "string", + "tags": [], + "label": "index", + "description": [], + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx" - } - ], - "returnComment": [], - "children": [ { "parentPluginId": "data", - "id": "def-common.DataView.flattenHit.$1", - "type": "Object", + "id": "def-server.esFilters.buildQueryFilter.$3", + "type": "string", "tags": [], - "label": "hit", + "label": "alias", "description": [], "signature": [ - "{ [x: string]: any; }" + "string | undefined" ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", + "path": "node_modules/@types/kbn__es-query/index.d.ts", "deprecated": false }, { "parentPluginId": "data", - "id": "def-common.DataView.flattenHit.$2", - "type": "CompoundType", + "id": "def-server.esFilters.buildQueryFilter.$4", + "type": "Object", "tags": [], - "label": "deep", + "label": "meta", "description": [], "signature": [ - "boolean | undefined" + "FilterMeta", + " | undefined" ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", + "path": "node_modules/@types/kbn__es-query/index.d.ts", "deprecated": false } ] }, { "parentPluginId": "data", - "id": "def-common.DataView.metaFields", - "type": "Array", - "tags": [], - "label": "metaFields", - "description": [], - "signature": [ - "string[]" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataView.version", - "type": "string", - "tags": [], - "label": "version", - "description": [ - "\nSavedObject version" - ], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataView.sourceFilters", - "type": "Array", - "tags": [], - "label": "sourceFilters", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.SourceFilter", - "text": "SourceFilter" - }, - "[] | undefined" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataView.namespaces", - "type": "Array", - "tags": [], - "label": "namespaces", - "description": [], - "signature": [ - "string[]" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataView.allowNoIndex", - "type": "boolean", - "tags": [], - "label": "allowNoIndex", - "description": [ - "\nprevents errors when index pattern exists before indices" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataView.Unnamed", + "id": "def-server.esFilters.buildCustomFilter", "type": "Function", "tags": [], - "label": "Constructor", + "label": "buildCustomFilter", "description": [], "signature": [ - "any" + "(indexPatternString: string, queryDsl: ", + "QueryDslQueryContainer", + ", disabled: boolean, negate: boolean, alias: string | null, store: ", + "FilterStateStore", + ") => ", + "Filter" ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", + "path": "src/plugins/data/server/deprecated.ts", "deprecated": false, + "returnComment": [], "children": [ { "parentPluginId": "data", - "id": "def-common.DataView.Unnamed.$1", + "id": "def-server.esFilters.buildCustomFilter.$1", + "type": "string", + "tags": [], + "label": "indexPatternString", + "description": [], + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.esFilters.buildCustomFilter.$2", "type": "Object", "tags": [], - "label": "{ spec = {}, fieldFormats, shortDotsEnable = false, metaFields = [] }", + "label": "queryDsl", + "description": [], + "signature": [ + "QueryDslQueryContainer" + ], + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.esFilters.buildCustomFilter.$3", + "type": "boolean", + "tags": [], + "label": "disabled", + "description": [], + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.esFilters.buildCustomFilter.$4", + "type": "boolean", + "tags": [], + "label": "negate", + "description": [], + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.esFilters.buildCustomFilter.$5", + "type": "CompoundType", + "tags": [], + "label": "alias", "description": [], "signature": [ - "DataViewDeps" + "string | null" ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-common.DataView.getOriginalSavedObjectBody", - "type": "Function", - "tags": [], - "label": "getOriginalSavedObjectBody", - "description": [ - "\nGet last saved saved object fields" - ], - "signature": [ - "() => { fieldAttrs?: string | undefined; title?: string | undefined; timeFieldName?: string | undefined; fields?: string | undefined; sourceFilters?: string | undefined; fieldFormatMap?: string | undefined; typeMeta?: string | undefined; type?: string | undefined; }" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [], - "returnComment": [] + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.esFilters.buildCustomFilter.$6", + "type": "Enum", + "tags": [], + "label": "store", + "description": [], + "signature": [ + "FilterStateStore" + ], + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false + } + ] }, { "parentPluginId": "data", - "id": "def-common.DataView.resetOriginalSavedObjectBody", + "id": "def-server.esFilters.buildEmptyFilter", "type": "Function", "tags": [], - "label": "resetOriginalSavedObjectBody", - "description": [ - "\nReset last saved saved object fields. used after saving" - ], + "label": "buildEmptyFilter", + "description": [], "signature": [ - "() => void" + "(isPinned: boolean, index?: string | undefined) => ", + "Filter" ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", + "path": "src/plugins/data/server/deprecated.ts", "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-common.DataView.getFieldAttrs", - "type": "Function", - "tags": [], - "label": "getFieldAttrs", - "description": [], - "signature": [ - "() => { [x: string]: ", + "returnComment": [], + "children": [ { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldAttrSet", - "text": "FieldAttrSet" + "parentPluginId": "data", + "id": "def-server.esFilters.buildEmptyFilter.$1", + "type": "boolean", + "tags": [], + "label": "isPinned", + "description": [], + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false }, - "; }" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [], - "returnComment": [] + { + "parentPluginId": "data", + "id": "def-server.esFilters.buildEmptyFilter.$2", + "type": "string", + "tags": [], + "label": "index", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false + } + ] }, { "parentPluginId": "data", - "id": "def-common.DataView.getComputedFields", + "id": "def-server.esFilters.buildExistsFilter", "type": "Function", "tags": [], - "label": "getComputedFields", + "label": "buildExistsFilter", "description": [], "signature": [ - "() => { storedFields: string[]; scriptFields: Record; docvalueFields: { field: string; format: string; }[]; runtimeFields: ", - "MappingRuntimeFields", - "; }" + "(field: ", + "DataViewFieldBase", + ", indexPattern: ", + "DataViewBase", + ") => ", + "ExistsFilter" ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", + "path": "src/plugins/data/server/deprecated.ts", "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-common.DataView.toSpec", - "type": "Function", - "tags": [], - "label": "toSpec", - "description": [ - "\nCreate static representation of index pattern" - ], - "signature": [ - "() => ", + "returnComment": [], + "children": [ { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" + "parentPluginId": "data", + "id": "def-server.esFilters.buildExistsFilter.$1", + "type": "Object", + "tags": [], + "label": "field", + "description": [], + "signature": [ + "DataViewFieldBase" + ], + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.esFilters.buildExistsFilter.$2", + "type": "Object", + "tags": [], + "label": "indexPattern", + "description": [], + "signature": [ + "DataViewBase" + ], + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false } - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [], - "returnComment": [] + ] }, { "parentPluginId": "data", - "id": "def-common.DataView.getSourceFiltering", + "id": "def-server.esFilters.buildFilter", "type": "Function", "tags": [], - "label": "getSourceFiltering", - "description": [ - "\nGet the source filtering configuration for that index." - ], + "label": "buildFilter", + "description": [], "signature": [ - "() => { excludes: string[]; }" + "(indexPattern: ", + "DataViewBase", + ", field: ", + "DataViewFieldBase", + ", type: ", + "FILTERS", + ", negate: boolean, disabled: boolean, params: ", + "Serializable", + ", alias: string | null, store?: ", + "FilterStateStore", + " | undefined) => ", + "Filter" ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", + "path": "src/plugins/data/server/deprecated.ts", "deprecated": false, - "children": [], - "returnComment": [] + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-server.esFilters.buildFilter.$1", + "type": "Object", + "tags": [], + "label": "indexPattern", + "description": [], + "signature": [ + "DataViewBase" + ], + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.esFilters.buildFilter.$2", + "type": "Object", + "tags": [], + "label": "field", + "description": [], + "signature": [ + "DataViewFieldBase" + ], + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.esFilters.buildFilter.$3", + "type": "Enum", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "FILTERS" + ], + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.esFilters.buildFilter.$4", + "type": "boolean", + "tags": [], + "label": "negate", + "description": [], + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.esFilters.buildFilter.$5", + "type": "boolean", + "tags": [], + "label": "disabled", + "description": [], + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.esFilters.buildFilter.$6", + "type": "CompoundType", + "tags": [], + "label": "params", + "description": [], + "signature": [ + "string | number | boolean | ", + "SerializableRecord", + " | SerializableArray | null | undefined" + ], + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.esFilters.buildFilter.$7", + "type": "CompoundType", + "tags": [], + "label": "alias", + "description": [], + "signature": [ + "string | null" + ], + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.esFilters.buildFilter.$8", + "type": "CompoundType", + "tags": [], + "label": "store", + "description": [], + "signature": [ + "FilterStateStore", + " | undefined" + ], + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false + } + ] }, { "parentPluginId": "data", - "id": "def-common.DataView.removeScriptedField", + "id": "def-server.esFilters.buildPhraseFilter", "type": "Function", - "tags": [ - "deprecated" - ], - "label": "removeScriptedField", - "description": [ - "\nRemove scripted field from field list" - ], + "tags": [], + "label": "buildPhraseFilter", + "description": [], "signature": [ - "(fieldName: string) => void" + "(field: ", + "DataViewFieldBase", + ", value: PhraseFilterValue, indexPattern: ", + "DataViewBase", + ") => ", + "PhraseFilter", + " | ", + "ScriptedPhraseFilter" ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": true, - "references": [ + "path": "src/plugins/data/server/deprecated.ts", + "deprecated": false, + "returnComment": [], + "children": [ { - "plugin": "dataViewManagement", - "path": "src/plugins/data_view_management/public/components/edit_index_pattern/scripted_fields_table/scripted_fields_table.tsx" + "parentPluginId": "data", + "id": "def-server.esFilters.buildPhraseFilter.$1", + "type": "Object", + "tags": [], + "label": "field", + "description": [], + "signature": [ + "DataViewFieldBase" + ], + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false }, { - "plugin": "dataViewManagement", - "path": "src/plugins/data_view_management/public/components/field_editor/field_editor.tsx" + "parentPluginId": "data", + "id": "def-server.esFilters.buildPhraseFilter.$2", + "type": "CompoundType", + "tags": [], + "label": "value", + "description": [], + "signature": [ + "string | number | boolean" + ], + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.test.ts" - } - ], - "children": [ { "parentPluginId": "data", - "id": "def-common.DataView.removeScriptedField.$1", - "type": "string", + "id": "def-server.esFilters.buildPhraseFilter.$3", + "type": "Object", "tags": [], - "label": "fieldName", + "label": "indexPattern", "description": [], "signature": [ - "string" + "DataViewBase" ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false } - ], - "returnComment": [] + ] }, { "parentPluginId": "data", - "id": "def-common.DataView.getNonScriptedFields", + "id": "def-server.esFilters.buildPhrasesFilter", "type": "Function", - "tags": [ - "deprecated" - ], - "label": "getNonScriptedFields", - "description": [ - "\n" - ], + "tags": [], + "label": "buildPhrasesFilter", + "description": [], "signature": [ - "() => ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" - }, - "[]" + "(field: ", + "DataViewFieldBase", + ", params: PhraseFilterValue[], indexPattern: ", + "DataViewBase", + ") => ", + "PhrasesFilter" ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": true, - "references": [ - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/abstract_search_strategy.ts" - }, - { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/services/persistence/deserialize.ts" - }, - { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/state_management/datasource.test.ts" - }, - { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/services/persistence/deserialize.test.ts" - }, - { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/services/persistence/deserialize.test.ts" - }, - { - "plugin": "dataViewManagement", - "path": "src/plugins/data_view_management/public/components/edit_index_pattern/source_filters_table/components/table/table.tsx" - }, - { - "plugin": "dataViewManagement", - "path": "src/plugins/data_view_management/public/components/edit_index_pattern/edit_index_pattern.tsx" - }, - { - "plugin": "dataViewManagement", - "path": "src/plugins/data_view_management/public/components/edit_index_pattern/edit_index_pattern.tsx" - }, + "path": "src/plugins/data/server/deprecated.ts", + "deprecated": false, + "returnComment": [], + "children": [ { - "plugin": "dataViewManagement", - "path": "src/plugins/data_view_management/public/components/edit_index_pattern/edit_index_pattern.tsx" + "parentPluginId": "data", + "id": "def-server.esFilters.buildPhrasesFilter.$1", + "type": "Object", + "tags": [], + "label": "field", + "description": [], + "signature": [ + "DataViewFieldBase" + ], + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false }, { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.test.ts" + "parentPluginId": "data", + "id": "def-server.esFilters.buildPhrasesFilter.$2", + "type": "Array", + "tags": [], + "label": "params", + "description": [], + "signature": [ + "PhraseFilterValue[]" + ], + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/lib/fetch_fields.ts" + "parentPluginId": "data", + "id": "def-server.esFilters.buildPhrasesFilter.$3", + "type": "Object", + "tags": [], + "label": "indexPattern", + "description": [], + "signature": [ + "DataViewBase" + ], + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false } - ], - "children": [], - "returnComment": [] + ] }, { "parentPluginId": "data", - "id": "def-common.DataView.getScriptedFields", + "id": "def-server.esFilters.buildRangeFilter", "type": "Function", - "tags": [ - "deprecated" - ], - "label": "getScriptedFields", - "description": [ - "\n" - ], + "tags": [], + "label": "buildRangeFilter", + "description": [], "signature": [ - "() => ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" - }, - "[]" + "(field: ", + "DataViewFieldBase", + ", params: ", + "RangeFilterParams", + ", indexPattern?: ", + "DataViewBase", + " | undefined, formattedValue?: string | undefined) => ", + "RangeFilter", + " | ", + "ScriptedRangeFilter", + " | MatchAllRangeFilter" ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": true, - "references": [ - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_views.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/server/register_index_pattern_usage_collection.ts" - }, - { - "plugin": "dataViewManagement", - "path": "src/plugins/data_view_management/public/components/edit_index_pattern/scripted_fields_table/scripted_fields_table.tsx" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.test.ts" - }, + "path": "src/plugins/data/server/deprecated.ts", + "deprecated": false, + "returnComment": [], + "children": [ { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.test.ts" + "parentPluginId": "data", + "id": "def-server.esFilters.buildRangeFilter.$1", + "type": "Object", + "tags": [], + "label": "field", + "description": [], + "signature": [ + "DataViewFieldBase" + ], + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false }, { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.test.ts" + "parentPluginId": "data", + "id": "def-server.esFilters.buildRangeFilter.$2", + "type": "Object", + "tags": [], + "label": "params", + "description": [], + "signature": [ + "RangeFilterParams" + ], + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false }, { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.test.ts" + "parentPluginId": "data", + "id": "def-server.esFilters.buildRangeFilter.$3", + "type": "Object", + "tags": [], + "label": "indexPattern", + "description": [], + "signature": [ + "DataViewBase", + " | undefined" + ], + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false }, { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.test.ts" + "parentPluginId": "data", + "id": "def-server.esFilters.buildRangeFilter.$4", + "type": "string", + "tags": [], + "label": "formattedValue", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false } - ], - "children": [], - "returnComment": [] + ] }, { "parentPluginId": "data", - "id": "def-common.DataView.isTimeBased", + "id": "def-server.esFilters.isFilterDisabled", "type": "Function", "tags": [], - "label": "isTimeBased", + "label": "isFilterDisabled", "description": [], "signature": [ - "() => this is ", + "(filter: ", + "Filter", + ") => boolean" + ], + "path": "src/plugins/data/server/deprecated.ts", + "deprecated": false, + "returnComment": [], + "children": [ { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.TimeBasedDataView", - "text": "TimeBasedDataView" + "parentPluginId": "data", + "id": "def-server.esFilters.isFilterDisabled.$1", + "type": "Object", + "tags": [], + "label": "filter", + "description": [], + "signature": [ + "{ $state?: { store: ", + "FilterStateStore", + "; } | undefined; meta: ", + "FilterMeta", + "; query?: Record | undefined; }" + ], + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false } + ] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-server.esKuery", + "type": "Object", + "tags": [], + "label": "esKuery", + "description": [], + "path": "src/plugins/data/server/deprecated.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.esKuery.nodeTypes", + "type": "Object", + "tags": [], + "label": "nodeTypes", + "description": [], + "signature": [ + "NodeTypes" ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [], - "returnComment": [] + "path": "src/plugins/data/server/deprecated.ts", + "deprecated": false }, { "parentPluginId": "data", - "id": "def-common.DataView.isTimeNanosBased", + "id": "def-server.esKuery.fromKueryExpression", "type": "Function", "tags": [], - "label": "isTimeNanosBased", + "label": "fromKueryExpression", "description": [], "signature": [ - "() => this is ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.TimeBasedDataView", - "text": "TimeBasedDataView" - } + "(expression: string | ", + "QueryDslQueryContainer", + ", parseOptions?: Partial<", + "KueryParseOptions", + "> | undefined) => ", + "KueryNode" ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", + "path": "src/plugins/data/server/deprecated.ts", "deprecated": false, - "children": [], - "returnComment": [] + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-server.esKuery.fromKueryExpression.$1", + "type": "CompoundType", + "tags": [], + "label": "expression", + "description": [], + "signature": [ + "string | ", + "QueryDslQueryContainer" + ], + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.esKuery.fromKueryExpression.$2", + "type": "Object", + "tags": [], + "label": "parseOptions", + "description": [], + "signature": [ + "Partial<", + "KueryParseOptions", + "> | undefined" + ], + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false + } + ] }, { "parentPluginId": "data", - "id": "def-common.DataView.getTimeField", + "id": "def-server.esKuery.toElasticsearchQuery", "type": "Function", "tags": [], - "label": "getTimeField", + "label": "toElasticsearchQuery", "description": [], "signature": [ - "() => ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" - }, - " | undefined" + "(node: ", + "KueryNode", + ", indexPattern?: ", + "DataViewBase", + " | undefined, config?: ", + "KueryQueryOptions", + " | undefined, context?: Record | undefined) => ", + "QueryDslQueryContainer" ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", + "path": "src/plugins/data/server/deprecated.ts", "deprecated": false, - "children": [], - "returnComment": [] - }, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-server.esKuery.toElasticsearchQuery.$1", + "type": "Object", + "tags": [], + "label": "node", + "description": [], + "signature": [ + "KueryNode" + ], + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.esKuery.toElasticsearchQuery.$2", + "type": "Object", + "tags": [], + "label": "indexPattern", + "description": [], + "signature": [ + "DataViewBase", + " | undefined" + ], + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.esKuery.toElasticsearchQuery.$3", + "type": "Object", + "tags": [], + "label": "config", + "description": [], + "signature": [ + "KueryQueryOptions", + " | undefined" + ], + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.esKuery.toElasticsearchQuery.$4", + "type": "Object", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "Record | undefined" + ], + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false + } + ] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-server.esQuery", + "type": "Object", + "tags": [], + "label": "esQuery", + "description": [], + "path": "src/plugins/data/server/deprecated.ts", + "deprecated": false, + "children": [ { "parentPluginId": "data", - "id": "def-common.DataView.getFieldByName", + "id": "def-server.esQuery.buildQueryFromFilters", "type": "Function", "tags": [], - "label": "getFieldByName", + "label": "buildQueryFromFilters", "description": [], "signature": [ - "(name: string) => ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" - }, - " | undefined" + "(filters: ", + "Filter", + "[] | undefined, indexPattern: ", + "DataViewBase", + " | undefined, ignoreFilterIfFieldNotInIndex?: boolean | undefined) => ", + "BoolQuery" ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", + "path": "src/plugins/data/server/deprecated.ts", "deprecated": false, + "returnComment": [], "children": [ { "parentPluginId": "data", - "id": "def-common.DataView.getFieldByName.$1", - "type": "string", + "id": "def-server.esQuery.buildQueryFromFilters.$1", + "type": "Array", "tags": [], - "label": "name", + "label": "filters", "description": [], "signature": [ - "string" + "Filter", + "[] | undefined" ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.esQuery.buildQueryFromFilters.$2", + "type": "Object", + "tags": [], + "label": "indexPattern", + "description": [], + "signature": [ + "DataViewBase", + " | undefined" + ], + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.esQuery.buildQueryFromFilters.$3", + "type": "CompoundType", + "tags": [], + "label": "ignoreFilterIfFieldNotInIndex", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false } - ], - "returnComment": [] + ] }, { "parentPluginId": "data", - "id": "def-common.DataView.getAggregationRestrictions", + "id": "def-server.esQuery.getEsQueryConfig", "type": "Function", "tags": [], - "label": "getAggregationRestrictions", + "label": "getEsQueryConfig", "description": [], "signature": [ - "() => Record | undefined" + "(config: KibanaConfig) => ", + "EsQueryConfig" ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", + "path": "src/plugins/data/server/deprecated.ts", "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-common.DataView.getAsSavedObjectBody", - "type": "Function", - "tags": [], - "label": "getAsSavedObjectBody", - "description": [ - "\nReturns index pattern as saved object body for saving" - ], - "signature": [ - "() => ", + "returnComment": [], + "children": [ { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewAttributes", - "text": "DataViewAttributes" + "parentPluginId": "data", + "id": "def-server.esQuery.getEsQueryConfig.$1", + "type": "Object", + "tags": [], + "label": "config", + "description": [], + "signature": [ + "KibanaConfig" + ], + "path": "src/plugins/data/common/es_query/get_es_query_config.ts", + "deprecated": false } - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [], - "returnComment": [] + ] }, { "parentPluginId": "data", - "id": "def-common.DataView.getFormatterForField", + "id": "def-server.esQuery.buildEsQuery", "type": "Function", "tags": [], - "label": "getFormatterForField", - "description": [ - "\nProvide a field, get its formatter" - ], + "label": "buildEsQuery", + "description": [], "signature": [ - "(field: ", + "(indexPattern: ", + "DataViewBase", + " | undefined, queries: ", + "Query", + " | ", + "Query", + "[], filters: ", + "Filter", + " | ", + "Filter", + "[], config?: ", + "EsQueryConfig", + " | undefined) => { bool: ", + "BoolQuery", + "; }" + ], + "path": "src/plugins/data/server/deprecated.ts", + "deprecated": false, + "returnComment": [], + "children": [ { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" + "parentPluginId": "data", + "id": "def-server.esQuery.buildEsQuery.$1", + "type": "Object", + "tags": [], + "label": "indexPattern", + "description": [], + "signature": [ + "DataViewBase", + " | undefined" + ], + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false }, - " | ", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" + "parentPluginId": "data", + "id": "def-server.esQuery.buildEsQuery.$2", + "type": "CompoundType", + "tags": [], + "label": "queries", + "description": [], + "signature": [ + "Query", + " | ", + "Query", + "[]" + ], + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false }, - " | ", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" + "parentPluginId": "data", + "id": "def-server.esQuery.buildEsQuery.$3", + "type": "CompoundType", + "tags": [], + "label": "filters", + "description": [], + "signature": [ + "Filter", + " | ", + "Filter", + "[]" + ], + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false }, - ") => ", { - "pluginId": "fieldFormats", + "parentPluginId": "data", + "id": "def-server.esQuery.buildEsQuery.$4", + "type": "CompoundType", + "tags": [], + "label": "config", + "description": [], + "signature": [ + "EsQueryConfig", + " | undefined" + ], + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false + } + ] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-server.exporters", + "type": "Object", + "tags": [], + "label": "exporters", + "description": [], + "path": "src/plugins/data/server/index.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.exporters.datatableToCSV", + "type": "Function", + "tags": [], + "label": "datatableToCSV", + "description": [], + "signature": [ + "({ columns, rows }: ", + { + "pluginId": "expressions", "scope": "common", - "docId": "kibFieldFormatsPluginApi", - "section": "def-common.FieldFormat", - "text": "FieldFormat" - } + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + }, + ", { csvSeparator, quoteValues, formatFactory, raw, escapeFormulaValues }: CSVOptions) => string" ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", + "path": "src/plugins/data/server/index.ts", "deprecated": false, + "returnComment": [], "children": [ { "parentPluginId": "data", - "id": "def-common.DataView.getFormatterForField.$1", - "type": "CompoundType", + "id": "def-server.exporters.datatableToCSV.$1", + "type": "Object", "tags": [], - "label": "field", + "label": "__0", "description": [], "signature": [ { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" - }, - " | ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - " | ", - { - "pluginId": "dataViews", + "pluginId": "expressions", "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" } ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true + "path": "src/plugins/data/common/exports/export_csv.tsx", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.exporters.datatableToCSV.$2", + "type": "Object", + "tags": [], + "label": "__1", + "description": [], + "signature": [ + "CSVOptions" + ], + "path": "src/plugins/data/common/exports/export_csv.tsx", + "deprecated": false } - ], - "returnComment": [] + ] }, { "parentPluginId": "data", - "id": "def-common.DataView.addRuntimeField", - "type": "Function", + "id": "def-server.exporters.CSV_MIME_TYPE", + "type": "string", "tags": [], - "label": "addRuntimeField", - "description": [ - "\nAdd a runtime field - Appended to existing mapped field or a new field is\ncreated as appropriate." - ], - "signature": [ - "(name: string, runtimeField: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.RuntimeField", - "text": "RuntimeField" - }, - ") => ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" - }, - "[]" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", + "label": "CSV_MIME_TYPE", + "description": [], + "path": "src/plugins/data/server/index.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-server.search", + "type": "Object", + "tags": [], + "label": "search", + "description": [], + "path": "src/plugins/data/server/index.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.search.aggs", + "type": "Object", + "tags": [], + "label": "aggs", + "description": [], + "path": "src/plugins/data/server/index.ts", "deprecated": false, "children": [ { "parentPluginId": "data", - "id": "def-common.DataView.addRuntimeField.$1", - "type": "string", + "id": "def-server.search.aggs.CidrMask", + "type": "Object", "tags": [], - "label": "name", - "description": [ - "Field name" + "label": "CidrMask", + "description": [], + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.CidrMask", + "text": "CidrMask" + } ], + "path": "src/plugins/data/server/index.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.search.aggs.dateHistogramInterval", + "type": "Function", + "tags": [], + "label": "dateHistogramInterval", + "description": [], "signature": [ - "string" + "(interval: string) => Interval" ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", + "path": "src/plugins/data/server/index.ts", "deprecated": false, - "isRequired": true + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-server.search.aggs.dateHistogramInterval.$1", + "type": "string", + "tags": [], + "label": "interval", + "description": [], + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/date_histogram_interval.ts", + "deprecated": false + } + ] }, { "parentPluginId": "data", - "id": "def-common.DataView.addRuntimeField.$2", + "id": "def-server.search.aggs.IpAddress", "type": "Object", "tags": [], - "label": "runtimeField", - "description": [ - "Runtime field definition" - ], + "label": "IpAddress", + "description": [], "signature": [ + "typeof ", { - "pluginId": "dataViews", + "pluginId": "data", "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.RuntimeField", - "text": "RuntimeField" + "docId": "kibDataSearchPluginApi", + "section": "def-common.IpAddress", + "text": "IpAddress" } ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-common.DataView.hasRuntimeField", - "type": "Function", - "tags": [], - "label": "hasRuntimeField", - "description": [ - "\nChecks if runtime field exists" - ], - "signature": [ - "(name: string) => boolean" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [ + "path": "src/plugins/data/server/index.ts", + "deprecated": false + }, { "parentPluginId": "data", - "id": "def-common.DataView.hasRuntimeField.$1", - "type": "string", + "id": "def-server.search.aggs.parseInterval", + "type": "Function", "tags": [], - "label": "name", + "label": "parseInterval", "description": [], "signature": [ - "string" + "(interval: string) => moment.Duration | null" ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", + "path": "src/plugins/data/server/index.ts", "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-common.DataView.getRuntimeField", - "type": "Function", - "tags": [], - "label": "getRuntimeField", - "description": [ - "\nReturns runtime field if exists" - ], - "signature": [ - "(name: string) => ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.RuntimeField", - "text": "RuntimeField" - }, - " | null" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [ + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-server.search.aggs.parseInterval.$1", + "type": "string", + "tags": [], + "label": "interval", + "description": [], + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_interval.ts", + "deprecated": false + } + ] + }, { "parentPluginId": "data", - "id": "def-common.DataView.getRuntimeField.$1", - "type": "string", + "id": "def-server.search.aggs.calcAutoIntervalLessThan", + "type": "Function", "tags": [], - "label": "name", + "label": "calcAutoIntervalLessThan", "description": [], "signature": [ - "string" + "(maxBucketCount: number, duration: number) => moment.Duration" ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", + "path": "src/plugins/data/server/index.ts", "deprecated": false, - "isRequired": true + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-server.search.aggs.calcAutoIntervalLessThan.$1", + "type": "number", + "tags": [], + "label": "maxBucketCount", + "description": [], + "path": "src/plugins/data/common/search/aggs/buckets/lib/time_buckets/calc_auto_interval.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.search.aggs.calcAutoIntervalLessThan.$2", + "type": "number", + "tags": [], + "label": "duration", + "description": [], + "path": "src/plugins/data/common/search/aggs/buckets/lib/time_buckets/calc_auto_interval.ts", + "deprecated": false + } + ] } - ], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-common.DataView.getAllRuntimeFields", - "type": "Function", - "tags": [], - "label": "getAllRuntimeFields", - "description": [], - "signature": [ - "() => Record" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, + ] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-server.UI_SETTINGS", + "type": "Object", + "tags": [], + "label": "UI_SETTINGS", + "description": [], + "signature": [ + "{ readonly META_FIELDS: \"metaFields\"; readonly DOC_HIGHLIGHT: \"doc_table:highlight\"; readonly QUERY_STRING_OPTIONS: \"query:queryString:options\"; readonly QUERY_ALLOW_LEADING_WILDCARDS: \"query:allowLeadingWildcards\"; readonly SEARCH_QUERY_LANGUAGE: \"search:queryLanguage\"; readonly SORT_OPTIONS: \"sort:options\"; readonly COURIER_IGNORE_FILTER_IF_FIELD_NOT_IN_INDEX: \"courier:ignoreFilterIfFieldNotInIndex\"; readonly COURIER_SET_REQUEST_PREFERENCE: \"courier:setRequestPreference\"; readonly COURIER_CUSTOM_REQUEST_PREFERENCE: \"courier:customRequestPreference\"; readonly COURIER_MAX_CONCURRENT_SHARD_REQUESTS: \"courier:maxConcurrentShardRequests\"; readonly SEARCH_INCLUDE_FROZEN: \"search:includeFrozen\"; readonly SEARCH_TIMEOUT: \"search:timeout\"; readonly HISTOGRAM_BAR_TARGET: \"histogram:barTarget\"; readonly HISTOGRAM_MAX_BARS: \"histogram:maxBars\"; readonly HISTORY_LIMIT: \"history:limit\"; readonly TIMEPICKER_REFRESH_INTERVAL_DEFAULTS: \"timepicker:refreshIntervalDefaults\"; readonly TIMEPICKER_QUICK_RANGES: \"timepicker:quickRanges\"; readonly TIMEPICKER_TIME_DEFAULTS: \"timepicker:timeDefaults\"; readonly FILTERS_PINNED_BY_DEFAULT: \"filters:pinnedByDefault\"; readonly FILTERS_EDITOR_SUGGEST_VALUES: \"filterEditor:suggestValues\"; readonly AUTOCOMPLETE_USE_TIMERANGE: \"autocomplete:useTimeRange\"; readonly AUTOCOMPLETE_VALUE_SUGGESTION_METHOD: \"autocomplete:valueSuggestionMethod\"; readonly DATE_FORMAT: \"dateFormat\"; readonly DATEFORMAT_TZ: \"dateFormat:tz\"; }" + ], + "path": "src/plugins/data/common/constants.ts", + "deprecated": false, + "initialIsOpen": false + } + ], + "setup": { + "parentPluginId": "data", + "id": "def-server.DataPluginSetup", + "type": "Interface", + "tags": [], + "label": "DataPluginSetup", + "description": [], + "path": "src/plugins/data/server/plugin.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.DataPluginSetup.search", + "type": "Object", + "tags": [], + "label": "search", + "description": [], + "signature": [ + "ISearchSetup" + ], + "path": "src/plugins/data/server/plugin.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.DataPluginSetup.query", + "type": "Object", + "tags": [], + "label": "query", + "description": [], + "signature": [ + "QuerySetup" + ], + "path": "src/plugins/data/server/plugin.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.DataPluginSetup.fieldFormats", + "type": "Object", + "tags": [ + "deprecated" + ], + "label": "fieldFormats", + "description": [], + "signature": [ + { + "pluginId": "fieldFormats", + "scope": "server", + "docId": "kibFieldFormatsPluginApi", + "section": "def-server.FieldFormatsSetup", + "text": "FieldFormatsSetup" + } + ], + "path": "src/plugins/data/server/plugin.ts", + "deprecated": true, + "references": [] + } + ], + "lifecycle": "setup", + "initialIsOpen": true + }, + "start": { + "parentPluginId": "data", + "id": "def-server.DataPluginStart", + "type": "Interface", + "tags": [], + "label": "DataPluginStart", + "description": [], + "path": "src/plugins/data/server/plugin.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.DataPluginStart.search", + "type": "Object", + "tags": [], + "label": "search", + "description": [], + "signature": [ + "ISearchStart", + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IEsSearchRequest", + "text": "IEsSearchRequest" + }, + ", ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IEsSearchResponse", + "text": "IEsSearchResponse" + }, + ">" + ], + "path": "src/plugins/data/server/plugin.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.DataPluginStart.fieldFormats", + "type": "Object", + "tags": [ + "deprecated" + ], + "label": "fieldFormats", + "description": [], + "signature": [ + { + "pluginId": "fieldFormats", + "scope": "server", + "docId": "kibFieldFormatsPluginApi", + "section": "def-server.FieldFormatsStart", + "text": "FieldFormatsStart" + } + ], + "path": "src/plugins/data/server/plugin.ts", + "deprecated": true, + "references": [ + { + "plugin": "visTypeTimeseries", + "path": "src/plugins/vis_types/timeseries/server/plugin.ts" + } + ] + }, + { + "parentPluginId": "data", + "id": "def-server.DataPluginStart.indexPatterns", + "type": "Object", + "tags": [], + "label": "indexPatterns", + "description": [], + "signature": [ + { + "pluginId": "dataViews", + "scope": "server", + "docId": "kibDataViewsPluginApi", + "section": "def-server.DataViewsServerPluginStart", + "text": "DataViewsServerPluginStart" + } + ], + "path": "src/plugins/data/server/plugin.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.DataPluginStart.datatableUtilities", + "type": "Object", + "tags": [], + "label": "datatableUtilities", + "description": [ + "\nDatatable type utility functions." + ], + "signature": [ + "DatatableUtilitiesService" + ], + "path": "src/plugins/data/server/plugin.ts", + "deprecated": false + } + ], + "lifecycle": "start", + "initialIsOpen": true + } + }, + "common": { + "classes": [ + { + "parentPluginId": "data", + "id": "def-common.DatatableUtilitiesService", + "type": "Class", + "tags": [], + "label": "DatatableUtilitiesService", + "description": [], + "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", + "deprecated": false, + "children": [ { "parentPluginId": "data", - "id": "def-common.DataView.getFieldsByRuntimeFieldName", + "id": "def-common.DatatableUtilitiesService.Unnamed", "type": "Function", "tags": [], - "label": "getFieldsByRuntimeFieldName", + "label": "Constructor", "description": [], "signature": [ - "(name: string) => Record | undefined" + "any" ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", + "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", "deprecated": false, "children": [ { "parentPluginId": "data", - "id": "def-common.DataView.getFieldsByRuntimeFieldName.$1", - "type": "string", + "id": "def-common.DatatableUtilitiesService.Unnamed.$1", + "type": "Object", "tags": [], - "label": "name", + "label": "aggs", "description": [], "signature": [ - "string" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggsCommonStart", + "text": "AggsCommonStart" + } ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", + "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", "deprecated": false, "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-common.DataView.replaceAllRuntimeFields", - "type": "Function", - "tags": [], - "label": "replaceAllRuntimeFields", - "description": [ - "\nReplaces all existing runtime fields with new fields" - ], - "signature": [ - "(newFields: Record) => void" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [ { "parentPluginId": "data", - "id": "def-common.DataView.replaceAllRuntimeFields.$1", + "id": "def-common.DatatableUtilitiesService.Unnamed.$2", "type": "Object", "tags": [], - "label": "newFields", + "label": "dataViews", "description": [], "signature": [ - "Record" + "section": "def-common.DataViewsContract", + "text": "DataViewsContract" + } ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", + "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-common.DatatableUtilitiesService.Unnamed.$3", + "type": "Object", + "tags": [], + "label": "fieldFormats", + "description": [], + "signature": [ + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.FieldFormatsStartCommon", + "text": "FieldFormatsStartCommon" + } + ], + "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", "deprecated": false, "isRequired": true } @@ -21717,32 +22018,42 @@ }, { "parentPluginId": "data", - "id": "def-common.DataView.removeRuntimeField", + "id": "def-common.DatatableUtilitiesService.clearField", "type": "Function", "tags": [], - "label": "removeRuntimeField", - "description": [ - "\nRemove a runtime field - removed from mapped field or removed unmapped\nfield as appropriate. Doesn't clear associated field attributes." - ], + "label": "clearField", + "description": [], "signature": [ - "(name: string) => void" + "(column: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" + }, + ") => void" ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", + "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", "deprecated": false, "children": [ { "parentPluginId": "data", - "id": "def-common.DataView.removeRuntimeField.$1", - "type": "string", + "id": "def-common.DatatableUtilitiesService.clearField.$1", + "type": "Object", "tags": [], - "label": "name", - "description": [ - "- Field name to remove" - ], + "label": "column", + "description": [], "signature": [ - "string" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" + } ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", + "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", "deprecated": false, "isRequired": true } @@ -21751,56 +22062,42 @@ }, { "parentPluginId": "data", - "id": "def-common.DataView.getRuntimeMappings", - "type": "Function", - "tags": [], - "label": "getRuntimeMappings", - "description": [ - "\nReturn the \"runtime_mappings\" section of the ES search query" - ], - "signature": [ - "() => ", - "MappingRuntimeFields" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-common.DataView.getFormatterForFieldNoDefault", + "id": "def-common.DatatableUtilitiesService.clearFieldFormat", "type": "Function", "tags": [], - "label": "getFormatterForFieldNoDefault", - "description": [ - "\nGet formatter for a given field name. Return undefined if none exists" - ], + "label": "clearFieldFormat", + "description": [], "signature": [ - "(fieldname: string) => ", + "(column: ", { - "pluginId": "fieldFormats", + "pluginId": "expressions", "scope": "common", - "docId": "kibFieldFormatsPluginApi", - "section": "def-common.FieldFormat", - "text": "FieldFormat" + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" }, - " | undefined" + ") => void" ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", + "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", "deprecated": false, "children": [ { "parentPluginId": "data", - "id": "def-common.DataView.getFormatterForFieldNoDefault.$1", - "type": "string", + "id": "def-common.DatatableUtilitiesService.clearFieldFormat.$1", + "type": "Object", "tags": [], - "label": "fieldname", + "label": "column", "description": [], "signature": [ - "string" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" + } ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", + "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", "deprecated": false, "isRequired": true } @@ -21809,79 +22106,50 @@ }, { "parentPluginId": "data", - "id": "def-common.DataView.setFieldAttrs", + "id": "def-common.DatatableUtilitiesService.getAggConfig", "type": "Function", "tags": [], - "label": "setFieldAttrs", + "label": "getAggConfig", "description": [], "signature": [ - "(fieldName: string, attrName: K, value: ", + ") => Promise<", { - "pluginId": "dataViews", + "pluginId": "data", "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldAttrSet", - "text": "FieldAttrSet" + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" }, - "[K]) => void" + " | undefined>" ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", + "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", "deprecated": false, "children": [ { "parentPluginId": "data", - "id": "def-common.DataView.setFieldAttrs.$1", - "type": "string", - "tags": [], - "label": "fieldName", - "description": [], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "data", - "id": "def-common.DataView.setFieldAttrs.$2", - "type": "Uncategorized", - "tags": [], - "label": "attrName", - "description": [], - "signature": [ - "K" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "data", - "id": "def-common.DataView.setFieldAttrs.$3", - "type": "Uncategorized", + "id": "def-common.DatatableUtilitiesService.getAggConfig.$1", + "type": "Object", "tags": [], - "label": "value", + "label": "column", "description": [], "signature": [ { - "pluginId": "dataViews", + "pluginId": "expressions", "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldAttrSet", - "text": "FieldAttrSet" - }, - "[K]" + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" + } ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", + "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", "deprecated": false, "isRequired": true } @@ -21890,161 +22158,154 @@ }, { "parentPluginId": "data", - "id": "def-common.DataView.setFieldCustomLabel", + "id": "def-common.DatatableUtilitiesService.getDataView", "type": "Function", "tags": [], - "label": "setFieldCustomLabel", + "label": "getDataView", "description": [], "signature": [ - "(fieldName: string, customLabel: string | null | undefined) => void" + "(column: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" + }, + ") => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + " | undefined>" ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", + "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", "deprecated": false, "children": [ { "parentPluginId": "data", - "id": "def-common.DataView.setFieldCustomLabel.$1", - "type": "string", + "id": "def-common.DatatableUtilitiesService.getDataView.$1", + "type": "Object", "tags": [], - "label": "fieldName", + "label": "column", "description": [], "signature": [ - "string" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" + } ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", + "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", "deprecated": false, "isRequired": true - }, - { - "parentPluginId": "data", - "id": "def-common.DataView.setFieldCustomLabel.$2", - "type": "CompoundType", - "tags": [], - "label": "customLabel", - "description": [], - "signature": [ - "string | null | undefined" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "data", - "id": "def-common.DataView.setFieldCount", + "id": "def-common.DatatableUtilitiesService.getField", "type": "Function", "tags": [], - "label": "setFieldCount", + "label": "getField", "description": [], "signature": [ - "(fieldName: string, count: number | null | undefined) => void" + "(column: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" + }, + ") => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewField", + "text": "DataViewField" + }, + " | undefined>" ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", + "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", "deprecated": false, "children": [ { "parentPluginId": "data", - "id": "def-common.DataView.setFieldCount.$1", - "type": "string", + "id": "def-common.DatatableUtilitiesService.getField.$1", + "type": "Object", "tags": [], - "label": "fieldName", + "label": "column", "description": [], "signature": [ - "string" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" + } ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", + "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", "deprecated": false, "isRequired": true - }, - { - "parentPluginId": "data", - "id": "def-common.DataView.setFieldCount.$2", - "type": "CompoundType", - "tags": [], - "label": "count", - "description": [], - "signature": [ - "number | null | undefined" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "data", - "id": "def-common.DataView.setFieldFormat", + "id": "def-common.DatatableUtilitiesService.getFieldFormat", "type": "Function", "tags": [], - "label": "setFieldFormat", + "label": "getFieldFormat", "description": [], "signature": [ - "(fieldName: string, format: ", + "(column: ", { - "pluginId": "fieldFormats", + "pluginId": "expressions", "scope": "common", - "docId": "kibFieldFormatsPluginApi", - "section": "def-common.SerializedFieldFormat", - "text": "SerializedFieldFormat" + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" }, - "<", + ") => ", { "pluginId": "fieldFormats", "scope": "common", "docId": "kibFieldFormatsPluginApi", - "section": "def-common.FieldFormatParams", - "text": "FieldFormatParams" + "section": "def-common.FieldFormat", + "text": "FieldFormat" }, - ">) => void" + " | undefined" ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", + "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", "deprecated": false, "children": [ { "parentPluginId": "data", - "id": "def-common.DataView.setFieldFormat.$1", - "type": "string", - "tags": [], - "label": "fieldName", - "description": [], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "data", - "id": "def-common.DataView.setFieldFormat.$2", + "id": "def-common.DatatableUtilitiesService.getFieldFormat.$1", "type": "Object", "tags": [], - "label": "format", + "label": "column", "description": [], "signature": [ { - "pluginId": "fieldFormats", - "scope": "common", - "docId": "kibFieldFormatsPluginApi", - "section": "def-common.SerializedFieldFormat", - "text": "SerializedFieldFormat" - }, - "<", - { - "pluginId": "fieldFormats", + "pluginId": "expressions", "scope": "common", - "docId": "kibFieldFormatsPluginApi", - "section": "def-common.FieldFormatParams", - "text": "FieldFormatParams" - }, - ">" + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" + } ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", + "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", "deprecated": false, "isRequired": true } @@ -22053,113 +22314,86 @@ }, { "parentPluginId": "data", - "id": "def-common.DataView.deleteFieldFormat", + "id": "def-common.DatatableUtilitiesService.getInterval", "type": "Function", "tags": [], - "label": "deleteFieldFormat", + "label": "getInterval", "description": [], "signature": [ - "(fieldName: string) => void" + "(column: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" + }, + ") => string | undefined" ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", + "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", "deprecated": false, "children": [ { "parentPluginId": "data", - "id": "def-common.DataView.deleteFieldFormat.$1", - "type": "string", + "id": "def-common.DatatableUtilitiesService.getInterval.$1", + "type": "Object", "tags": [], - "label": "fieldName", + "label": "column", "description": [], "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewField", - "type": "Class", - "tags": [], - "label": "DataViewField", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" - }, - " implements ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" - } - ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.DataViewField.spec", - "type": "Object", - "tags": [], - "label": "spec", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" + } + ], + "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", + "deprecated": false, + "isRequired": true } ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false + "returnComment": [] }, { "parentPluginId": "data", - "id": "def-common.DataViewField.Unnamed", + "id": "def-common.DatatableUtilitiesService.getTotalCount", "type": "Function", "tags": [], - "label": "Constructor", + "label": "getTotalCount", "description": [], "signature": [ - "any" + "(table: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + }, + ") => number | undefined" ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", "deprecated": false, "children": [ { "parentPluginId": "data", - "id": "def-common.DataViewField.Unnamed.$1", + "id": "def-common.DatatableUtilitiesService.getTotalCount.$1", "type": "Object", "tags": [], - "label": "spec", + "label": "table", "description": [], "signature": [ { - "pluginId": "dataViews", + "pluginId": "expressions", "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" } ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", "deprecated": false, "isRequired": true } @@ -22168,679 +22402,435 @@ }, { "parentPluginId": "data", - "id": "def-common.DataViewField.count", - "type": "number", - "tags": [], - "label": "count", - "description": [ - "\nCount is used for field popularity" - ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewField.count", - "type": "number", - "tags": [], - "label": "count", - "description": [], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewField.runtimeField", - "type": "Object", + "id": "def-common.DatatableUtilitiesService.isFilterable", + "type": "Function", "tags": [], - "label": "runtimeField", + "label": "isFilterable", "description": [], "signature": [ + "(column: ", { - "pluginId": "dataViews", + "pluginId": "expressions", "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.RuntimeFieldSpec", - "text": "RuntimeFieldSpec" + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" }, - " | undefined" + ") => boolean" ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false + "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.DatatableUtilitiesService.isFilterable.$1", + "type": "Object", + "tags": [], + "label": "column", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" + } + ], + "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "data", - "id": "def-common.DataViewField.runtimeField", - "type": "Object", + "id": "def-common.DatatableUtilitiesService.setFieldFormat", + "type": "Function", "tags": [], - "label": "runtimeField", + "label": "setFieldFormat", "description": [], "signature": [ + "(column: ", { - "pluginId": "dataViews", + "pluginId": "expressions", "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.RuntimeFieldSpec", - "text": "RuntimeFieldSpec" + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" }, - " | undefined" - ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewField.script", - "type": "string", - "tags": [], - "label": "script", - "description": [ - "\nScript field code" - ], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewField.script", - "type": "string", - "tags": [], - "label": "script", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewField.lang", - "type": "string", - "tags": [], - "label": "lang", - "description": [ - "\nScript field language" + ", fieldFormat: ", + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.FieldFormat", + "text": "FieldFormat" + }, + ") => void" ], - "signature": [ - "string | undefined" + "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.DatatableUtilitiesService.setFieldFormat.$1", + "type": "Object", + "tags": [], + "label": "column", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" + } + ], + "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-common.DatatableUtilitiesService.setFieldFormat.$2", + "type": "Object", + "tags": [], + "label": "fieldFormat", + "description": [], + "signature": [ + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.FieldFormat", + "text": "FieldFormat" + } + ], + "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", + "deprecated": false, + "isRequired": true + } ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false - }, + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.DataView", + "type": "Class", + "tags": [], + "label": "DataView", + "description": [ + "\nData view class. Central kibana abstraction around multiple indices." + ], + "signature": [ { - "parentPluginId": "data", - "id": "def-common.DataViewField.lang", - "type": "string", - "tags": [], - "label": "lang", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" }, + " implements ", + "DataViewBase" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [ { "parentPluginId": "data", - "id": "def-common.DataViewField.customLabel", + "id": "def-common.DataView.id", "type": "string", "tags": [], - "label": "customLabel", - "description": [], + "label": "id", + "description": [ + "\nSaved object id" + ], "signature": [ "string | undefined" ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": false }, { "parentPluginId": "data", - "id": "def-common.DataViewField.customLabel", + "id": "def-common.DataView.title", "type": "string", "tags": [], - "label": "customLabel", - "description": [], - "signature": [ - "string | undefined" + "label": "title", + "description": [ + "\nTitle of data view" ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": false }, { "parentPluginId": "data", - "id": "def-common.DataViewField.conflictDescriptions", + "id": "def-common.DataView.fieldFormatMap", "type": "Object", "tags": [], - "label": "conflictDescriptions", + "label": "fieldFormatMap", "description": [ - "\nDescription of field type conflicts across different indices in the same index pattern" + "\nMap of field formats by field name" ], "signature": [ - "Record | undefined" + "{ [x: string]: any; }" ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": false }, { "parentPluginId": "data", - "id": "def-common.DataViewField.conflictDescriptions", + "id": "def-common.DataView.typeMeta", "type": "Object", "tags": [], - "label": "conflictDescriptions", - "description": [], - "signature": [ - "Record | undefined" - ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewField.name", - "type": "string", - "tags": [], - "label": "name", - "description": [], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewField.displayName", - "type": "string", - "tags": [], - "label": "displayName", - "description": [], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewField.type", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewField.esTypes", - "type": "Array", - "tags": [], - "label": "esTypes", - "description": [], - "signature": [ - "string[] | undefined" + "label": "typeMeta", + "description": [ + "\nOnly used by rollup indices, used by rollup specific endpoint to load field list." ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewField.scripted", - "type": "boolean", - "tags": [], - "label": "scripted", - "description": [], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewField.searchable", - "type": "boolean", - "tags": [], - "label": "searchable", - "description": [], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewField.aggregatable", - "type": "boolean", - "tags": [], - "label": "aggregatable", - "description": [], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewField.readFromDocValues", - "type": "boolean", - "tags": [], - "label": "readFromDocValues", - "description": [], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewField.subType", - "type": "CompoundType", - "tags": [], - "label": "subType", - "description": [], "signature": [ - "IFieldSubType", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.TypeMeta", + "text": "TypeMeta" + }, " | undefined" ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": false }, { "parentPluginId": "data", - "id": "def-common.DataViewField.isMapped", + "id": "def-common.DataView.fields", "type": "CompoundType", "tags": [], - "label": "isMapped", + "label": "fields", "description": [ - "\nIs the field part of the index mapping?" - ], - "signature": [ - "boolean | undefined" - ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewField.isRuntimeField", - "type": "boolean", - "tags": [], - "label": "isRuntimeField", - "description": [], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewField.sortable", - "type": "boolean", - "tags": [], - "label": "sortable", - "description": [], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewField.filterable", - "type": "boolean", - "tags": [], - "label": "filterable", - "description": [], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewField.visualizable", - "type": "boolean", - "tags": [], - "label": "visualizable", - "description": [], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewField.isSubtypeNested", - "type": "Function", - "tags": [], - "label": "isSubtypeNested", - "description": [], - "signature": [ - "() => boolean" - ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewField.isSubtypeMulti", - "type": "Function", - "tags": [], - "label": "isSubtypeMulti", - "description": [], - "signature": [ - "() => boolean" - ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewField.getSubtypeNested", - "type": "Function", - "tags": [], - "label": "getSubtypeNested", - "description": [], - "signature": [ - "() => ", - "IFieldSubTypeNested", - " | undefined" + "\nField list, in extended array format" ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewField.getSubtypeMulti", - "type": "Function", - "tags": [], - "label": "getSubtypeMulti", - "description": [], "signature": [ - "() => ", - "IFieldSubTypeMulti", - " | undefined" + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.IIndexPatternFieldList", + "text": "IIndexPatternFieldList" + }, + " & { toSpec: () => ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewFieldMap", + "text": "DataViewFieldMap" + }, + "; }" ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false, - "children": [], - "returnComment": [] + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false }, { "parentPluginId": "data", - "id": "def-common.DataViewField.deleteCount", - "type": "Function", + "id": "def-common.DataView.timeFieldName", + "type": "string", "tags": [], - "label": "deleteCount", - "description": [], + "label": "timeFieldName", + "description": [ + "\nTimestamp field name" + ], "signature": [ - "() => void" + "string | undefined" ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false, - "children": [], - "returnComment": [] + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false }, { "parentPluginId": "data", - "id": "def-common.DataViewField.toJSON", - "type": "Function", + "id": "def-common.DataView.type", + "type": "string", "tags": [], - "label": "toJSON", - "description": [], + "label": "type", + "description": [ + "\nType is used to identify rollup index patterns." + ], "signature": [ - "() => { count: number; script: string | undefined; lang: string | undefined; conflictDescriptions: Record | undefined; name: string; type: string; esTypes: string[] | undefined; scripted: boolean; searchable: boolean; aggregatable: boolean; readFromDocValues: boolean; subType: ", - "IFieldSubType", - " | undefined; customLabel: string | undefined; }" + "string | undefined" ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false, - "children": [], - "returnComment": [] + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false }, { "parentPluginId": "data", - "id": "def-common.DataViewField.toSpec", + "id": "def-common.DataView.flattenHit", "type": "Function", - "tags": [], - "label": "toSpec", + "tags": [ + "deprecated" + ], + "label": "flattenHit", "description": [], "signature": [ - "({ getFormatterForField, }?: { getFormatterForField?: ((field: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" - }, - " | ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - " | ", + "(hit: Record, deep?: boolean | undefined) => Record" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": true, + "references": [ { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" + "plugin": "dataViews", + "path": "src/plugins/data_views/common/data_views/data_view.ts" }, - ") => ", { - "pluginId": "fieldFormats", - "scope": "common", - "docId": "kibFieldFormatsPluginApi", - "section": "def-common.FieldFormat", - "text": "FieldFormat" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx" }, - ") | undefined; }) => ", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx" } ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false, + "returnComment": [], "children": [ { "parentPluginId": "data", - "id": "def-common.DataViewField.toSpec.$1", + "id": "def-common.DataView.flattenHit.$1", "type": "Object", "tags": [], - "label": "{\n getFormatterForField,\n }", + "label": "hit", "description": [], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.DataViewField.toSpec.$1.getFormatterForField", - "type": "Function", - "tags": [], - "label": "getFormatterForField", - "description": [], - "signature": [ - "((field: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" - }, - " | ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - " | ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" - }, - ") => ", - { - "pluginId": "fieldFormats", - "scope": "common", - "docId": "kibFieldFormatsPluginApi", - "section": "def-common.FieldFormat", - "text": "FieldFormat" - }, - ") | undefined" - ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false - } - ] + "signature": [ + "{ [x: string]: any; }" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.DataView.flattenHit.$2", + "type": "CompoundType", + "tags": [], + "label": "deep", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false } - ], - "returnComment": [] + ] }, { "parentPluginId": "data", - "id": "def-common.DataViewField.isRuntimeCompositeSubField", - "type": "Function", + "id": "def-common.DataView.metaFields", + "type": "Array", "tags": [], - "label": "isRuntimeCompositeSubField", - "description": [], + "label": "metaFields", + "description": [ + "\nList of meta fields by name" + ], "signature": [ - "() => boolean" + "string[]" ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false, - "children": [], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewSavedObjectConflictError", - "type": "Class", - "tags": [], - "label": "DataViewSavedObjectConflictError", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSavedObjectConflictError", - "text": "DataViewSavedObjectConflictError" + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false }, - " extends Error" - ], - "path": "src/plugins/data_views/common/errors/data_view_saved_object_conflict.ts", - "deprecated": false, - "children": [ { "parentPluginId": "data", - "id": "def-common.DataViewSavedObjectConflictError.Unnamed", - "type": "Function", + "id": "def-common.DataView.version", + "type": "string", "tags": [], - "label": "Constructor", - "description": [], - "signature": [ - "any" + "label": "version", + "description": [ + "\nSavedObject version" ], - "path": "src/plugins/data_views/common/errors/data_view_saved_object_conflict.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.DataViewSavedObjectConflictError.Unnamed.$1", - "type": "string", - "tags": [], - "label": "savedObjectId", - "description": [], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/errors/data_view_saved_object_conflict.ts", - "deprecated": false, - "isRequired": true - } + "signature": [ + "string | undefined" ], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewsService", - "type": "Class", - "tags": [], - "label": "DataViewsService", - "description": [], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [ + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false + }, { "parentPluginId": "data", - "id": "def-common.DataViewsService.getCanSave", - "type": "Function", + "id": "def-common.DataView.sourceFilters", + "type": "Array", "tags": [], - "label": "getCanSave", - "description": [], + "label": "sourceFilters", + "description": [ + "\nArray of filters - hides fields in discover" + ], "signature": [ - "() => Promise" + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.SourceFilter", + "text": "SourceFilter" + }, + "[] | undefined" ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "returnComment": [], - "children": [] + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false }, { "parentPluginId": "data", - "id": "def-common.DataViewsService.ensureDefaultDataView", - "type": "Function", - "tags": [ - "deprecated" + "id": "def-common.DataView.namespaces", + "type": "Array", + "tags": [], + "label": "namespaces", + "description": [ + "\nArray of namespace ids" ], - "label": "ensureDefaultDataView", - "description": [], "signature": [ - "() => Promise | undefined" + "string[]" ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": true, - "references": [ - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_views.ts" - } + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.DataView.allowNoIndex", + "type": "boolean", + "tags": [], + "label": "allowNoIndex", + "description": [ + "\nPrevents errors when index pattern exists before indices" ], - "returnComment": [], - "children": [] + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false }, { "parentPluginId": "data", - "id": "def-common.DataViewsService.Unnamed", + "id": "def-common.DataView.Unnamed", "type": "Function", "tags": [], "label": "Constructor", - "description": [], + "description": [ + "\nconstructor" + ], "signature": [ "any" ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", + "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": false, "children": [ { "parentPluginId": "data", - "id": "def-common.DataViewsService.Unnamed.$1", + "id": "def-common.DataView.Unnamed.$1", "type": "Object", "tags": [], - "label": "{\n uiSettings,\n savedObjectsClient,\n apiClient,\n fieldFormats,\n onNotification,\n onError,\n onRedirectNoIndexPattern = () => {},\n getCanSave = () => Promise.resolve(false),\n }", - "description": [], + "label": "config", + "description": [ + "- config data and dependencies" + ], "signature": [ - "DataViewsServiceDeps" + "DataViewDeps" ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", + "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": false, "isRequired": true } @@ -22849,419 +22839,500 @@ }, { "parentPluginId": "data", - "id": "def-common.DataViewsService.getIds", + "id": "def-common.DataView.getOriginalSavedObjectBody", "type": "Function", "tags": [], - "label": "getIds", + "label": "getOriginalSavedObjectBody", "description": [ - "\nGet list of index pattern ids" + "\nGet last saved saved object fields" ], "signature": [ - "(refresh?: boolean) => Promise" + "() => { fieldAttrs?: string | undefined; title?: string | undefined; timeFieldName?: string | undefined; fields?: string | undefined; sourceFilters?: string | undefined; fieldFormatMap?: string | undefined; typeMeta?: string | undefined; type?: string | undefined; }" ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", + "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.DataViewsService.getIds.$1", - "type": "boolean", - "tags": [], - "label": "refresh", - "description": [ - "Force refresh of index pattern list" - ], - "signature": [ - "boolean" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true - } - ], + "children": [], "returnComment": [] }, { "parentPluginId": "data", - "id": "def-common.DataViewsService.getTitles", + "id": "def-common.DataView.resetOriginalSavedObjectBody", "type": "Function", "tags": [], - "label": "getTitles", + "label": "resetOriginalSavedObjectBody", "description": [ - "\nGet list of index pattern titles" + "\nReset last saved saved object fields. Used after saving." ], "signature": [ - "(refresh?: boolean) => Promise" + "() => void" ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", + "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.DataViewsService.getTitles.$1", - "type": "boolean", - "tags": [], - "label": "refresh", - "description": [ - "Force refresh of index pattern list" - ], - "signature": [ - "boolean" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true - } - ], + "children": [], "returnComment": [] }, { "parentPluginId": "data", - "id": "def-common.DataViewsService.find", + "id": "def-common.DataView.getFieldAttrs", "type": "Function", "tags": [], - "label": "find", + "label": "getFieldAttrs", "description": [ - "\nFind and load index patterns by title" + "\nReturns field attributes map" ], "signature": [ - "(search: string, size?: number) => Promise<", + "() => { [x: string]: ", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" + "section": "def-common.FieldAttrSet", + "text": "FieldAttrSet" }, - "[]>" + "; }" ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", + "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.DataViewsService.find.$1", - "type": "string", - "tags": [], - "label": "search", - "description": [], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewsService.find.$2", - "type": "number", - "tags": [], - "label": "size", - "description": [], - "signature": [ - "number" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true - } + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "data", + "id": "def-common.DataView.getComputedFields", + "type": "Function", + "tags": [], + "label": "getComputedFields", + "description": [ + "\nReturns scripted fields" ], - "returnComment": [ - "IndexPattern[]" - ] + "signature": [ + "() => { storedFields: string[]; scriptFields: Record; docvalueFields: { field: string; format: string; }[]; runtimeFields: ", + "MappingRuntimeFields", + "; }" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "data", - "id": "def-common.DataViewsService.getIdsWithTitle", + "id": "def-common.DataView.toSpec", "type": "Function", "tags": [], - "label": "getIdsWithTitle", + "label": "toSpec", "description": [ - "\nGet list of index pattern ids with titles" + "\nCreates static representation of the data view." ], "signature": [ - "(refresh?: boolean) => Promise<", + "() => ", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewListItem", - "text": "DataViewListItem" - }, - "[]>" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.DataViewsService.getIdsWithTitle.$1", - "type": "boolean", - "tags": [], - "label": "refresh", - "description": [ - "Force refresh of index pattern list" - ], - "signature": [ - "boolean" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true + "section": "def-common.DataViewSpec", + "text": "DataViewSpec" } ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [], "returnComment": [] }, { "parentPluginId": "data", - "id": "def-common.DataViewsService.clearCache", + "id": "def-common.DataView.getSourceFiltering", "type": "Function", "tags": [], - "label": "clearCache", + "label": "getSourceFiltering", "description": [ - "\nClear index pattern list cache" + "\nGet the source filtering configuration for that index." ], "signature": [ - "(id?: string | undefined) => void" + "() => { excludes: string[]; }" ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", + "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "data", + "id": "def-common.DataView.removeScriptedField", + "type": "Function", + "tags": [ + "deprecated" + ], + "label": "removeScriptedField", + "description": [ + "\nRemoves scripted field from field list." + ], + "signature": [ + "(fieldName: string) => void" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": true, + "references": [ + { + "plugin": "dataViewManagement", + "path": "src/plugins/data_view_management/public/components/edit_index_pattern/scripted_fields_table/scripted_fields_table.tsx" + }, + { + "plugin": "dataViewManagement", + "path": "src/plugins/data_view_management/public/components/field_editor/field_editor.tsx" + }, + { + "plugin": "dataViews", + "path": "src/plugins/data_views/common/data_views/data_view.test.ts" + } + ], "children": [ { "parentPluginId": "data", - "id": "def-common.DataViewsService.clearCache.$1", + "id": "def-common.DataView.removeScriptedField.$1", "type": "string", "tags": [], - "label": "id", + "label": "fieldName", "description": [ - "optionally clear a single id" + "name of scripted field to remove" ], "signature": [ - "string | undefined" + "string" ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", + "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": false, - "isRequired": false + "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "data", - "id": "def-common.DataViewsService.getCache", + "id": "def-common.DataView.getNonScriptedFields", "type": "Function", - "tags": [], - "label": "getCache", - "description": [], + "tags": [ + "deprecated" + ], + "label": "getNonScriptedFields", + "description": [ + "\n" + ], "signature": [ - "() => Promise<", - "SavedObject", - "<", - "IndexPatternSavedObjectAttrs", - ">[] | null | undefined>" + "() => ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewField", + "text": "DataViewField" + }, + "[]" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": true, + "references": [ + { + "plugin": "visTypeTimeseries", + "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/abstract_search_strategy.ts" + }, + { + "plugin": "graph", + "path": "x-pack/plugins/graph/public/services/persistence/deserialize.ts" + }, + { + "plugin": "graph", + "path": "x-pack/plugins/graph/public/state_management/datasource.test.ts" + }, + { + "plugin": "graph", + "path": "x-pack/plugins/graph/public/services/persistence/deserialize.test.ts" + }, + { + "plugin": "graph", + "path": "x-pack/plugins/graph/public/services/persistence/deserialize.test.ts" + }, + { + "plugin": "dataViewManagement", + "path": "src/plugins/data_view_management/public/components/edit_index_pattern/source_filters_table/components/table/table.tsx" + }, + { + "plugin": "dataViewManagement", + "path": "src/plugins/data_view_management/public/components/edit_index_pattern/edit_index_pattern.tsx" + }, + { + "plugin": "dataViewManagement", + "path": "src/plugins/data_view_management/public/components/edit_index_pattern/edit_index_pattern.tsx" + }, + { + "plugin": "dataViewManagement", + "path": "src/plugins/data_view_management/public/components/edit_index_pattern/edit_index_pattern.tsx" + }, + { + "plugin": "dataViews", + "path": "src/plugins/data_views/common/data_views/data_view.test.ts" + }, + { + "plugin": "visTypeTimeseries", + "path": "src/plugins/vis_types/timeseries/public/application/lib/fetch_fields.ts" + } ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "data", - "id": "def-common.DataViewsService.getDefault", + "id": "def-common.DataView.getScriptedFields", "type": "Function", - "tags": [], - "label": "getDefault", + "tags": [ + "deprecated" + ], + "label": "getScriptedFields", "description": [ - "\nGet default index pattern" + "\n" ], "signature": [ - "() => Promise<", + "() => ", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" + "section": "def-common.DataViewField", + "text": "DataViewField" }, - " | null>" + "[]" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": true, + "references": [ + { + "plugin": "dataViews", + "path": "src/plugins/data_views/common/data_views/data_view.ts" + }, + { + "plugin": "dataViews", + "path": "src/plugins/data_views/common/data_views/data_view.ts" + }, + { + "plugin": "dataViews", + "path": "src/plugins/data_views/common/data_views/data_views.ts" + }, + { + "plugin": "dataViews", + "path": "src/plugins/data_views/server/register_index_pattern_usage_collection.ts" + }, + { + "plugin": "dataViewManagement", + "path": "src/plugins/data_view_management/public/components/edit_index_pattern/scripted_fields_table/scripted_fields_table.tsx" + }, + { + "plugin": "dataViews", + "path": "src/plugins/data_views/common/data_views/data_view.test.ts" + }, + { + "plugin": "dataViews", + "path": "src/plugins/data_views/common/data_views/data_view.test.ts" + }, + { + "plugin": "dataViews", + "path": "src/plugins/data_views/common/data_views/data_view.test.ts" + }, + { + "plugin": "dataViews", + "path": "src/plugins/data_views/common/data_views/data_view.test.ts" + }, + { + "plugin": "dataViews", + "path": "src/plugins/data_views/common/data_views/data_view.test.ts" + } ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "data", - "id": "def-common.DataViewsService.getDefaultId", + "id": "def-common.DataView.isTimeBased", "type": "Function", "tags": [], - "label": "getDefaultId", + "label": "isTimeBased", "description": [ - "\nGet default index pattern id" + "\nDoes the data view have a timestamp field?" ], "signature": [ - "() => Promise" + "() => this is ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.TimeBasedDataView", + "text": "TimeBasedDataView" + } ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", + "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "data", - "id": "def-common.DataViewsService.setDefault", + "id": "def-common.DataView.isTimeNanosBased", "type": "Function", "tags": [], - "label": "setDefault", + "label": "isTimeNanosBased", "description": [ - "\nOptionally set default index pattern, unless force = true" + "\nDoes the data view have a timestamp field and is it a date nanos field?" ], "signature": [ - "(id: string | null, force?: boolean) => Promise" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.DataViewsService.setDefault.$1", - "type": "CompoundType", - "tags": [], - "label": "id", - "description": [], - "signature": [ - "string | null" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": false - }, + "() => this is ", { - "parentPluginId": "data", - "id": "def-common.DataViewsService.setDefault.$2", - "type": "boolean", - "tags": [], - "label": "force", - "description": [], - "signature": [ - "boolean" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.TimeBasedDataView", + "text": "TimeBasedDataView" } ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [], "returnComment": [] }, { "parentPluginId": "data", - "id": "def-common.DataViewsService.hasUserDataView", + "id": "def-common.DataView.getTimeField", "type": "Function", "tags": [], - "label": "hasUserDataView", + "label": "getTimeField", "description": [ - "\nChecks if current user has a user created index pattern ignoring fleet's server default index patterns" + "\nGet timestamp field as DataViewField or return undefined" ], "signature": [ - "() => Promise" + "() => ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewField", + "text": "DataViewField" + }, + " | undefined" ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", + "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "data", - "id": "def-common.DataViewsService.getFieldsForWildcard", + "id": "def-common.DataView.getFieldByName", "type": "Function", "tags": [], - "label": "getFieldsForWildcard", + "label": "getFieldByName", "description": [ - "\nGet field list by providing { pattern }" + "\nGet field by name." ], "signature": [ - "(options: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.GetFieldsOptions", - "text": "GetFieldsOptions" - }, - ") => Promise<", + "(name: string) => ", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" + "section": "def-common.DataViewField", + "text": "DataViewField" }, - "[]>" + " | undefined" ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", + "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": false, "children": [ { "parentPluginId": "data", - "id": "def-common.DataViewsService.getFieldsForWildcard.$1", - "type": "Object", + "id": "def-common.DataView.getFieldByName.$1", + "type": "string", "tags": [], - "label": "options", - "description": [], + "label": "name", + "description": [ + "field name" + ], "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.GetFieldsOptions", - "text": "GetFieldsOptions" - } + "string" ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", + "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": false, "isRequired": true } ], - "returnComment": [ - "FieldSpec[]" - ] + "returnComment": [] }, { "parentPluginId": "data", - "id": "def-common.DataViewsService.getFieldsForIndexPattern", + "id": "def-common.DataView.getAggregationRestrictions", "type": "Function", "tags": [], - "label": "getFieldsForIndexPattern", + "label": "getAggregationRestrictions", "description": [ - "\nGet field list by providing an index patttern (or spec)" + "\nGet aggregation restrictions. Rollup fields can only perform a subset of aggregations." ], "signature": [ - "(indexPattern: ", + "() => Record | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "data", + "id": "def-common.DataView.getAsSavedObjectBody", + "type": "Function", + "tags": [], + "label": "getAsSavedObjectBody", + "description": [ + "\nReturns index pattern as saved object body for saving" + ], + "signature": [ + "() => ", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" - }, - ", options?: ", + "section": "def-common.DataViewAttributes", + "text": "DataViewAttributes" + } + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "data", + "id": "def-common.DataView.getFormatterForField", + "type": "Function", + "tags": [], + "label": "getFormatterForField", + "description": [ + "\nProvide a field, get its formatter" + ], + "signature": [ + "(field: ", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.GetFieldsOptions", - "text": "GetFieldsOptions" + "section": "def-common.DataViewField", + "text": "DataViewField" }, - " | undefined) => Promise<", + " | ", { "pluginId": "dataViews", "scope": "common", @@ -23269,105 +23340,45 @@ "section": "def-common.FieldSpec", "text": "FieldSpec" }, - "[]>" + ") => ", + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.FieldFormat", + "text": "FieldFormat" + } ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", + "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": false, "children": [ { "parentPluginId": "data", - "id": "def-common.DataViewsService.getFieldsForIndexPattern.$1", + "id": "def-common.DataView.getFormatterForField.$1", "type": "CompoundType", "tags": [], - "label": "indexPattern", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - " | ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" - } + "label": "field", + "description": [ + "field to get formatter for" ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewsService.getFieldsForIndexPattern.$2", - "type": "Object", - "tags": [], - "label": "options", - "description": [], "signature": [ { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.GetFieldsOptions", - "text": "GetFieldsOptions" + "section": "def-common.DataViewField", + "text": "DataViewField" }, - " | undefined" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": false - } - ], - "returnComment": [ - "FieldSpec[]" - ] - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewsService.refreshFields", - "type": "Function", - "tags": [], - "label": "refreshFields", - "description": [ - "\nRefresh field list for a given index pattern" - ], - "signature": [ - "(indexPattern: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - ") => Promise" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.DataViewsService.refreshFields.$1", - "type": "Object", - "tags": [], - "label": "indexPattern", - "description": [], - "signature": [ + " | ", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" + "section": "def-common.FieldSpec", + "text": "FieldSpec" } ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", + "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": false, "isRequired": true } @@ -23376,187 +23387,146 @@ }, { "parentPluginId": "data", - "id": "def-common.DataViewsService.fieldArrayToMap", + "id": "def-common.DataView.addRuntimeField", "type": "Function", "tags": [], - "label": "fieldArrayToMap", + "label": "addRuntimeField", "description": [ - "\nConverts field array to map" + "\nAdd a runtime field - Appended to existing mapped field or a new field is\ncreated as appropriate." ], "signature": [ - "(fields: ", + "(name: string, runtimeField: ", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" + "section": "def-common.RuntimeField", + "text": "RuntimeField" }, - "[], fieldAttrs?: ", + ") => ", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldAttrs", - "text": "FieldAttrs" + "section": "def-common.DataViewField", + "text": "DataViewField" }, - " | undefined) => ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewFieldMap", - "text": "DataViewFieldMap" - } + "[]" ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", + "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": false, "children": [ { "parentPluginId": "data", - "id": "def-common.DataViewsService.fieldArrayToMap.$1", - "type": "Array", + "id": "def-common.DataView.addRuntimeField.$1", + "type": "string", "tags": [], - "label": "fields", + "label": "name", "description": [ - ": FieldSpec[]" + "Field name" ], "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - "[]" + "string" ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", + "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "data", - "id": "def-common.DataViewsService.fieldArrayToMap.$2", + "id": "def-common.DataView.addRuntimeField.$2", "type": "Object", "tags": [], - "label": "fieldAttrs", + "label": "runtimeField", "description": [ - ": FieldAttrs" + "Runtime field definition" ], "signature": [ { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldAttrs", - "text": "FieldAttrs" - }, - " | undefined" + "section": "def-common.RuntimeField", + "text": "RuntimeField" + } ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", + "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": false, - "isRequired": false + "isRequired": true } ], - "returnComment": [ - "Record" - ] - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewsService.savedObjectToSpec", - "type": "Function", - "tags": [], - "label": "savedObjectToSpec", - "description": [ - "\nConverts index pattern saved object to index pattern spec" - ], - "signature": [ - "(savedObject: ", - "SavedObject", - "<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewAttributes", - "text": "DataViewAttributes" - }, - ">) => ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" - } + "returnComment": [] + }, + { + "parentPluginId": "data", + "id": "def-common.DataView.hasRuntimeField", + "type": "Function", + "tags": [], + "label": "hasRuntimeField", + "description": [ + "\nChecks if runtime field exists" ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", + "signature": [ + "(name: string) => boolean" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": false, "children": [ { "parentPluginId": "data", - "id": "def-common.DataViewsService.savedObjectToSpec.$1", - "type": "Object", + "id": "def-common.DataView.hasRuntimeField.$1", + "type": "string", "tags": [], - "label": "savedObject", - "description": [], + "label": "name", + "description": [ + "field name" + ], "signature": [ - "SavedObject", - "<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewAttributes", - "text": "DataViewAttributes" - }, - ">" + "string" ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", + "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": false, "isRequired": true } ], - "returnComment": [ - "DataViewSpec" - ] + "returnComment": [] }, { "parentPluginId": "data", - "id": "def-common.DataViewsService.get", + "id": "def-common.DataView.getRuntimeField", "type": "Function", "tags": [], - "label": "get", + "label": "getRuntimeField", "description": [ - "\nGet an index pattern by id. Cache optimized" + "\nReturns runtime field if exists" ], "signature": [ - "(id: string) => Promise<", + "(name: string) => ", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" + "section": "def-common.RuntimeField", + "text": "RuntimeField" }, - ">" + " | null" ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", + "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": false, "children": [ { "parentPluginId": "data", - "id": "def-common.DataViewsService.get.$1", + "id": "def-common.DataView.getRuntimeField.$1", "type": "string", "tags": [], - "label": "id", - "description": [], + "label": "name", + "description": [ + "Runtime field name" + ], "signature": [ "string" ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", + "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": false, "isRequired": true } @@ -23565,154 +23535,213 @@ }, { "parentPluginId": "data", - "id": "def-common.DataViewsService.create", + "id": "def-common.DataView.getAllRuntimeFields", "type": "Function", "tags": [], - "label": "create", + "label": "getAllRuntimeFields", "description": [ - "\nCreate a new index pattern instance" + "\nGet all runtime field definitions." ], "signature": [ - "(spec: ", + "() => Record Promise<", + ">" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [], + "returnComment": [ + "map of runtime field definitions by field name" + ] + }, + { + "parentPluginId": "data", + "id": "def-common.DataView.getFieldsByRuntimeFieldName", + "type": "Function", + "tags": [], + "label": "getFieldsByRuntimeFieldName", + "description": [ + "\nReturns data view fields backed by runtime fields." + ], + "signature": [ + "(name: string) => Record" + "> | undefined" ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", + "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": false, "children": [ { "parentPluginId": "data", - "id": "def-common.DataViewsService.create.$1", - "type": "Object", + "id": "def-common.DataView.getFieldsByRuntimeFieldName.$1", + "type": "string", "tags": [], - "label": "spec", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" - } + "label": "name", + "description": [ + "runtime field name" ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewsService.create.$2", - "type": "boolean", - "tags": [], - "label": "skipFetchFields", - "description": [], "signature": [ - "boolean" + "string" ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", + "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": false, "isRequired": true } ], "returnComment": [ - "IndexPattern" + "map of DataViewFields (that are runtime fields) by field name" ] }, { "parentPluginId": "data", - "id": "def-common.DataViewsService.createAndSave", + "id": "def-common.DataView.replaceAllRuntimeFields", "type": "Function", "tags": [], - "label": "createAndSave", + "label": "replaceAllRuntimeFields", "description": [ - "\nCreate a new index pattern and save it right away" + "\nReplaces all existing runtime fields with new fields." ], "signature": [ - "(spec: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" - }, - ", override?: boolean, skipFetchFields?: boolean) => Promise<", + "(newFields: Record" + ">) => void" ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", + "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": false, "children": [ { "parentPluginId": "data", - "id": "def-common.DataViewsService.createAndSave.$1", + "id": "def-common.DataView.replaceAllRuntimeFields.$1", "type": "Object", "tags": [], - "label": "spec", - "description": [], + "label": "newFields", + "description": [ + "Map of runtime field definitions by field name" + ], "signature": [ + "Record" ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", + "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": false, "isRequired": true - }, + } + ], + "returnComment": [] + }, + { + "parentPluginId": "data", + "id": "def-common.DataView.removeRuntimeField", + "type": "Function", + "tags": [], + "label": "removeRuntimeField", + "description": [ + "\nRemove a runtime field - removed from mapped field or removed unmapped\nfield as appropriate. Doesn't clear associated field attributes." + ], + "signature": [ + "(name: string) => void" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [ { "parentPluginId": "data", - "id": "def-common.DataViewsService.createAndSave.$2", - "type": "boolean", + "id": "def-common.DataView.removeRuntimeField.$1", + "type": "string", "tags": [], - "label": "override", + "label": "name", "description": [ - "Overwrite if existing index pattern exists." + "- Field name to remove" ], "signature": [ - "boolean" + "string" ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", + "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": false, "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "data", + "id": "def-common.DataView.getRuntimeMappings", + "type": "Function", + "tags": [], + "label": "getRuntimeMappings", + "description": [ + "\nReturn the \"runtime_mappings\" section of the ES search query." + ], + "signature": [ + "() => ", + "MappingRuntimeFields" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "data", + "id": "def-common.DataView.getFormatterForFieldNoDefault", + "type": "Function", + "tags": [], + "label": "getFormatterForFieldNoDefault", + "description": [ + "\nGet formatter for a given field name. Return undefined if none exists." + ], + "signature": [ + "(fieldname: string) => ", + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.FieldFormat", + "text": "FieldFormat" }, + " | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [ { "parentPluginId": "data", - "id": "def-common.DataViewsService.createAndSave.$3", - "type": "boolean", + "id": "def-common.DataView.getFormatterForFieldNoDefault.$1", + "type": "string", "tags": [], - "label": "skipFetchFields", + "label": "fieldname", "description": [ - "Whether to skip field refresh step." + "name of field to get formatter for" ], "signature": [ - "boolean" + "string" ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", + "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": false, "isRequired": true } @@ -23721,68 +23750,87 @@ }, { "parentPluginId": "data", - "id": "def-common.DataViewsService.createSavedObject", + "id": "def-common.DataView.setFieldAttrs", "type": "Function", "tags": [], - "label": "createSavedObject", + "label": "setFieldAttrs", "description": [ - "\nSave a new index pattern" + "\nSet field attribute" ], "signature": [ - "(indexPattern: ", + " Promise<", + ">(fieldName: string, attrName: K, value: ", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" + "section": "def-common.FieldAttrSet", + "text": "FieldAttrSet" }, - ">" + "[K]) => void" ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", + "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": false, "children": [ { "parentPluginId": "data", - "id": "def-common.DataViewsService.createSavedObject.$1", - "type": "Object", + "id": "def-common.DataView.setFieldAttrs.$1", + "type": "string", "tags": [], - "label": "indexPattern", - "description": [], + "label": "fieldName", + "description": [ + "name of field to set attribute on" + ], "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - } + "string" ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", + "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "data", - "id": "def-common.DataViewsService.createSavedObject.$2", - "type": "boolean", + "id": "def-common.DataView.setFieldAttrs.$2", + "type": "Uncategorized", "tags": [], - "label": "override", + "label": "attrName", "description": [ - "Overwrite if existing index pattern exists" + "name of attribute to set" ], "signature": [ - "boolean" + "K" ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-common.DataView.setFieldAttrs.$3", + "type": "Uncategorized", + "tags": [], + "label": "value", + "description": [ + "value of attribute" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldAttrSet", + "text": "FieldAttrSet" + }, + "[K]" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": false, "isRequired": true } @@ -23791,186 +23839,213 @@ }, { "parentPluginId": "data", - "id": "def-common.DataViewsService.updateSavedObject", + "id": "def-common.DataView.setFieldCustomLabel", "type": "Function", "tags": [], - "label": "updateSavedObject", + "label": "setFieldCustomLabel", "description": [ - "\nSave existing index pattern. Will attempt to merge differences if there are conflicts" + "\nSet field custom label" ], "signature": [ - "(indexPattern: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - ", saveAttempts?: number, ignoreErrors?: boolean) => Promise" + "(fieldName: string, customLabel: string | null | undefined) => void" ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", + "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": false, "children": [ { "parentPluginId": "data", - "id": "def-common.DataViewsService.updateSavedObject.$1", - "type": "Object", + "id": "def-common.DataView.setFieldCustomLabel.$1", + "type": "string", "tags": [], - "label": "indexPattern", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - } + "label": "fieldName", + "description": [ + "name of field to set custom label on" ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewsService.updateSavedObject.$2", - "type": "number", - "tags": [], - "label": "saveAttempts", - "description": [], "signature": [ - "number" + "string" ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", + "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "data", - "id": "def-common.DataViewsService.updateSavedObject.$3", - "type": "boolean", + "id": "def-common.DataView.setFieldCustomLabel.$2", + "type": "CompoundType", "tags": [], - "label": "ignoreErrors", - "description": [], + "label": "customLabel", + "description": [ + "custom label value. If undefined, custom label is removed" + ], "signature": [ - "boolean" + "string | null | undefined" ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", + "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": false, - "isRequired": true + "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "data", - "id": "def-common.DataViewsService.delete", + "id": "def-common.DataView.setFieldCount", "type": "Function", "tags": [], - "label": "delete", + "label": "setFieldCount", "description": [ - "\nDeletes an index pattern from .kibana index" + "\nSet field count" ], "signature": [ - "(indexPatternId: string) => Promise<{}>" + "(fieldName: string, count: number | null | undefined) => void" ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", + "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": false, "children": [ { "parentPluginId": "data", - "id": "def-common.DataViewsService.delete.$1", + "id": "def-common.DataView.setFieldCount.$1", "type": "string", "tags": [], - "label": "indexPatternId", + "label": "fieldName", "description": [ - ": Id of kibana Index Pattern to delete" + "name of field to set count on" ], "signature": [ "string" ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", + "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": false, "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-common.DataView.setFieldCount.$2", + "type": "CompoundType", + "tags": [], + "label": "count", + "description": [ + "count value. If undefined, count is removed" + ], + "signature": [ + "number | null | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "data", - "id": "def-common.DataViewsService.getDefaultDataView", + "id": "def-common.DataView.setFieldFormat", "type": "Function", "tags": [], - "label": "getDefaultDataView", + "label": "setFieldFormat", "description": [ - "\nReturns the default data view as an object.\nIf no default is found, or it is missing\nanother data view is selected as default and returned.\nIf no possible data view found to become a default returns null\n" + "\nSet field formatter" ], "signature": [ - "() => Promise<", + "(fieldName: string, format: ", { - "pluginId": "dataViews", + "pluginId": "fieldFormats", "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.SerializedFieldFormat", + "text": "SerializedFieldFormat" }, - " | null>" + "<", + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.FieldFormatParams", + "text": "FieldFormatParams" + }, + ">) => void" ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", + "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": false, - "children": [], - "returnComment": [ - "default data view" - ] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.DuplicateDataViewError", - "type": "Class", - "tags": [], - "label": "DuplicateDataViewError", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DuplicateDataViewError", - "text": "DuplicateDataViewError" + "children": [ + { + "parentPluginId": "data", + "id": "def-common.DataView.setFieldFormat.$1", + "type": "string", + "tags": [], + "label": "fieldName", + "description": [ + "name of field to set format on" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-common.DataView.setFieldFormat.$2", + "type": "Object", + "tags": [], + "label": "format", + "description": [ + "field format in serialized form" + ], + "signature": [ + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.SerializedFieldFormat", + "text": "SerializedFieldFormat" + }, + "<", + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.FieldFormatParams", + "text": "FieldFormatParams" + }, + ">" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, - " extends Error" - ], - "path": "src/plugins/data_views/common/errors/duplicate_index_pattern.ts", - "deprecated": false, - "children": [ { "parentPluginId": "data", - "id": "def-common.DuplicateDataViewError.Unnamed", + "id": "def-common.DataView.deleteFieldFormat", "type": "Function", "tags": [], - "label": "Constructor", - "description": [], + "label": "deleteFieldFormat", + "description": [ + "\nRemove field format from the field format map." + ], "signature": [ - "any" + "(fieldName: string) => void" ], - "path": "src/plugins/data_views/common/errors/duplicate_index_pattern.ts", + "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": false, "children": [ { "parentPluginId": "data", - "id": "def-common.DuplicateDataViewError.Unnamed.$1", + "id": "def-common.DataView.deleteFieldFormat.$1", "type": "string", "tags": [], - "label": "message", - "description": [], + "label": "fieldName", + "description": [ + "field name associated with the format for removal" + ], "signature": [ "string" ], - "path": "src/plugins/data_views/common/errors/duplicate_index_pattern.ts", + "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": false, "isRequired": true } @@ -23982,617 +24057,1926 @@ }, { "parentPluginId": "data", - "id": "def-common.IndexPattern", - "type": "Class", - "tags": [ - "deprecated" - ], - "label": "IndexPattern", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" - }, - " extends ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - } - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": true, - "references": [ - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/index.ts" - }, - { - "plugin": "discover", - "path": "src/plugins/discover/public/application/view_alert/view_alert_route.tsx" - }, - { - "plugin": "discover", - "path": "src/plugins/discover/public/application/view_alert/view_alert_route.tsx" - }, - { - "plugin": "ux", - "path": "x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_filters.tsx" - }, - { - "plugin": "ux", - "path": "x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_filters.tsx" - }, - { - "plugin": "ux", - "path": "x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_wildcards.tsx" - }, - { - "plugin": "ux", - "path": "x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_wildcards.tsx" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/fields/data_view_field.test.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/fields/data_view_field.test.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/public/index.ts" - }, - { - "plugin": "savedObjects", - "path": "src/plugins/saved_objects/public/types.ts" - }, - { - "plugin": "savedObjects", - "path": "src/plugins/saved_objects/public/types.ts" - }, - { - "plugin": "savedObjects", - "path": "src/plugins/saved_objects/public/types.ts" - }, - { - "plugin": "savedObjects", - "path": "src/plugins/saved_objects/public/saved_object/helpers/apply_es_resp.ts" - }, - { - "plugin": "savedObjects", - "path": "src/plugins/saved_objects/public/saved_object/helpers/apply_es_resp.ts" - }, - { - "plugin": "dataViewEditor", - "path": "src/plugins/data_view_editor/public/shared_imports.ts" - }, - { - "plugin": "dataViewEditor", - "path": "src/plugins/data_view_editor/public/open_editor.tsx" - }, - { - "plugin": "dataViewEditor", - "path": "src/plugins/data_view_editor/public/open_editor.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/fields/agg/percentile_agg_field.test.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/fields/agg/percentile_agg_field.test.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/agg_filters/agg_type_filters.ts" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/agg_filters/agg_type_filters.ts" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/agg_filters/agg_type_filters.ts" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/utils/editor_config.ts" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/utils/editor_config.ts" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.ts" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.ts" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_select.tsx" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_select.tsx" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_params.tsx" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_params.tsx" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.test.ts" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.test.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.test.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.test.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.test.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.test.ts" - } - ], - "children": [], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.IndexPatternField", + "id": "def-common.DataViewField", "type": "Class", - "tags": [ - "deprecated" + "tags": [], + "label": "DataViewField", + "description": [ + "\nData view field class" ], - "label": "IndexPatternField", - "description": [], "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IndexPatternField", - "text": "IndexPatternField" - }, - " extends ", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", "section": "def-common.DataViewField", "text": "DataViewField" - } + }, + " implements ", + "DataViewFieldBase" ], "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": true, - "references": [ - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/index.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/public/index.ts" - }, - { - "plugin": "dataViewEditor", - "path": "src/plugins/data_view_editor/public/shared_imports.ts" - }, - { - "plugin": "dataViewEditor", - "path": "src/plugins/data_view_editor/public/lib/extract_time_fields.ts" - }, - { - "plugin": "dataViewEditor", - "path": "src/plugins/data_view_editor/public/lib/extract_time_fields.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/metrics_editor/metric_editor.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/metrics_editor/metric_editor.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/metrics_editor/metric_editor.tsx" - }, + "deprecated": false, + "children": [ { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/fields/es_doc_field.ts" + "parentPluginId": "data", + "id": "def-common.DataViewField.spec", + "type": "Object", + "tags": [], + "label": "spec", + "description": [], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + } + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/fields/es_doc_field.ts" + "parentPluginId": "data", + "id": "def-common.DataViewField.Unnamed", + "type": "Function", + "tags": [ + "constructor" + ], + "label": "Constructor", + "description": [ + "\nDataView constructor" + ], + "signature": [ + "any" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.DataViewField.Unnamed.$1", + "type": "Object", + "tags": [], + "label": "spec", + "description": [ + "Configuration for the field" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + } + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/metrics_editor/metrics_editor.tsx" + "parentPluginId": "data", + "id": "def-common.DataViewField.count", + "type": "number", + "tags": [], + "label": "count", + "description": [ + "\nCount is used for field popularity in discover." + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/metrics_editor/metrics_editor.tsx" + "parentPluginId": "data", + "id": "def-common.DataViewField.count", + "type": "number", + "tags": [], + "label": "count", + "description": [ + "\nSet count, which is used for field popularity in discover." + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_geo_grid_source/update_source_editor.tsx" + "parentPluginId": "data", + "id": "def-common.DataViewField.runtimeField", + "type": "Object", + "tags": [], + "label": "runtimeField", + "description": [ + "\nReturns runtime field definition or undefined if field is not runtime field." + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.RuntimeFieldSpec", + "text": "RuntimeFieldSpec" + }, + " | undefined" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_geo_grid_source/update_source_editor.tsx" + "parentPluginId": "data", + "id": "def-common.DataViewField.runtimeField", + "type": "Object", + "tags": [], + "label": "runtimeField", + "description": [ + "\nSets runtime field definition or unsets if undefined is provided." + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.RuntimeFieldSpec", + "text": "RuntimeFieldSpec" + }, + " | undefined" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/top_hits/top_hits_form.tsx" + "parentPluginId": "data", + "id": "def-common.DataViewField.script", + "type": "string", + "tags": [], + "label": "script", + "description": [ + "\nScript field code" + ], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/top_hits/top_hits_form.tsx" + "parentPluginId": "data", + "id": "def-common.DataViewField.script", + "type": "string", + "tags": [], + "label": "script", + "description": [ + "\nSets scripted field painless code" + ], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/top_hits/top_hits_form.tsx" + "parentPluginId": "data", + "id": "def-common.DataViewField.lang", + "type": "string", + "tags": [], + "label": "lang", + "description": [ + "\nScript field language" + ], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/top_hits/update_source_editor.tsx" + "parentPluginId": "data", + "id": "def-common.DataViewField.lang", + "type": "string", + "tags": [], + "label": "lang", + "description": [ + "\nSets scripted field langauge." + ], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/top_hits/update_source_editor.tsx" + "parentPluginId": "data", + "id": "def-common.DataViewField.customLabel", + "type": "string", + "tags": [], + "label": "customLabel", + "description": [ + "\nReturns custom label if set, otherwise undefined." + ], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/top_hits/update_source_editor.tsx" + "parentPluginId": "data", + "id": "def-common.DataViewField.customLabel", + "type": "string", + "tags": [], + "label": "customLabel", + "description": [ + "\nSets custom label for field, or unsets if passed undefined." + ], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/geo_field_select.tsx" + "parentPluginId": "data", + "id": "def-common.DataViewField.conflictDescriptions", + "type": "Object", + "tags": [], + "label": "conflictDescriptions", + "description": [ + "\nDescription of field type conflicts across different indices in the same index pattern." + ], + "signature": [ + "Record | undefined" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/geo_field_select.tsx" + "parentPluginId": "data", + "id": "def-common.DataViewField.conflictDescriptions", + "type": "Object", + "tags": [], + "label": "conflictDescriptions", + "description": [ + "\nSets conflict descriptions for field." + ], + "signature": [ + "Record | undefined" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/connected_components/edit_layer_panel/join_editor/resources/join_expression.tsx" + "parentPluginId": "data", + "id": "def-common.DataViewField.name", + "type": "string", + "tags": [], + "label": "name", + "description": [ + "\nGet field name" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/connected_components/edit_layer_panel/join_editor/resources/join_expression.tsx" + "parentPluginId": "data", + "id": "def-common.DataViewField.displayName", + "type": "string", + "tags": [], + "label": "displayName", + "description": [ + "\nGets display name, calcualted based on name, custom label and shortDotsEnable." + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/connected_components/edit_layer_panel/join_editor/resources/metrics_expression.tsx" + "parentPluginId": "data", + "id": "def-common.DataViewField.type", + "type": "string", + "tags": [], + "label": "type", + "description": [ + "\nGets field type" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/connected_components/edit_layer_panel/join_editor/resources/metrics_expression.tsx" + "parentPluginId": "data", + "id": "def-common.DataViewField.esTypes", + "type": "Array", + "tags": [], + "label": "esTypes", + "description": [ + "\nGets ES types as string array" + ], + "signature": [ + "string[] | undefined" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/index_pattern_util.test.ts" + "parentPluginId": "data", + "id": "def-common.DataViewField.scripted", + "type": "boolean", + "tags": [], + "label": "scripted", + "description": [ + "\nReturns true if scripted field" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/index_pattern_util.test.ts" + "parentPluginId": "data", + "id": "def-common.DataViewField.searchable", + "type": "boolean", + "tags": [], + "label": "searchable", + "description": [ + "\nReturns true if field is searchable" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/index_pattern_util.test.ts" + "parentPluginId": "data", + "id": "def-common.DataViewField.aggregatable", + "type": "boolean", + "tags": [], + "label": "aggregatable", + "description": [ + "\nReturns true if field is aggregatable" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/index_pattern_util.test.ts" + "parentPluginId": "data", + "id": "def-common.DataViewField.readFromDocValues", + "type": "boolean", + "tags": [], + "label": "readFromDocValues", + "description": [ + "\nReturns true if field is available via doc values" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/index_pattern_util.test.ts" + "parentPluginId": "data", + "id": "def-common.DataViewField.subType", + "type": "CompoundType", + "tags": [], + "label": "subType", + "description": [ + "\nReturns field subtype, multi, nested, or undefined if neither" + ], + "signature": [ + "IFieldSubType", + " | undefined" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/index_pattern_util.test.ts" + "parentPluginId": "data", + "id": "def-common.DataViewField.isMapped", + "type": "CompoundType", + "tags": [], + "label": "isMapped", + "description": [ + "\nIs the field part of the index mapping?" + ], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts" + "parentPluginId": "data", + "id": "def-common.DataViewField.isRuntimeField", + "type": "boolean", + "tags": [], + "label": "isRuntimeField", + "description": [ + "\nReturns true if runtime field defined on data view" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts" + "parentPluginId": "data", + "id": "def-common.DataViewField.sortable", + "type": "boolean", + "tags": [], + "label": "sortable", + "description": [ + "\nReturns true if field is sortable" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts" + "parentPluginId": "data", + "id": "def-common.DataViewField.filterable", + "type": "boolean", + "tags": [], + "label": "filterable", + "description": [ + "\nReturns true if field is filterable" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts" + "parentPluginId": "data", + "id": "def-common.DataViewField.visualizable", + "type": "boolean", + "tags": [], + "label": "visualizable", + "description": [ + "\nReturns true if field is visualizable" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts" + "parentPluginId": "data", + "id": "def-common.DataViewField.isSubtypeNested", + "type": "Function", + "tags": [], + "label": "isSubtypeNested", + "description": [ + "\nReturns true if field is subtype nested" + ], + "signature": [ + "() => boolean" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts" + "parentPluginId": "data", + "id": "def-common.DataViewField.isSubtypeMulti", + "type": "Function", + "tags": [], + "label": "isSubtypeMulti", + "description": [ + "\nReturns true if field is subtype multi" + ], + "signature": [ + "() => boolean" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts" + "parentPluginId": "data", + "id": "def-common.DataViewField.getSubtypeNested", + "type": "Function", + "tags": [], + "label": "getSubtypeNested", + "description": [ + "\nReturns subtype nested data if exists" + ], + "signature": [ + "() => ", + "IFieldSubTypeNested", + " | undefined" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/agg_filters/agg_type_field_filters.ts" + "parentPluginId": "data", + "id": "def-common.DataViewField.getSubtypeMulti", + "type": "Function", + "tags": [], + "label": "getSubtypeMulti", + "description": [ + "\nReturns subtype multi data if exists" + ], + "signature": [ + "() => ", + "IFieldSubTypeMulti", + " | undefined" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/agg_filters/agg_type_field_filters.ts" + "parentPluginId": "data", + "id": "def-common.DataViewField.deleteCount", + "type": "Function", + "tags": [], + "label": "deleteCount", + "description": [ + "\nDeletes count value. Popularity as used by discover" + ], + "signature": [ + "() => void" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/agg_filters/agg_type_field_filters.ts" + "parentPluginId": "data", + "id": "def-common.DataViewField.toJSON", + "type": "Function", + "tags": [], + "label": "toJSON", + "description": [ + "\nJSON version of field" + ], + "signature": [ + "() => { count: number; script: string | undefined; lang: string | undefined; conflictDescriptions: Record | undefined; name: string; type: string; esTypes: string[] | undefined; scripted: boolean; searchable: boolean; aggregatable: boolean; readFromDocValues: boolean; subType: ", + "IFieldSubType", + " | undefined; customLabel: string | undefined; }" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_param_props.ts" + "parentPluginId": "data", + "id": "def-common.DataViewField.toSpec", + "type": "Function", + "tags": [], + "label": "toSpec", + "description": [ + "\nGet field in serialized form - fieldspec." + ], + "signature": [ + "(config?: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.ToSpecConfig", + "text": "ToSpecConfig" + }, + ") => ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + } + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.DataViewField.toSpec.$1", + "type": "Object", + "tags": [], + "label": "config", + "description": [ + "provide a method to get a field formatter" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.ToSpecConfig", + "text": "ToSpecConfig" + } + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [ + "field in serialized form - field spec" + ] }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_param_props.ts" - }, + "parentPluginId": "data", + "id": "def-common.DataViewField.isRuntimeCompositeSubField", + "type": "Function", + "tags": [], + "label": "isRuntimeCompositeSubField", + "description": [ + "\nReturns true if composite runtime field" + ], + "signature": [ + "() => boolean" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.DataViewSavedObjectConflictError", + "type": "Class", + "tags": [], + "label": "DataViewSavedObjectConflictError", + "description": [ + "\nError thrown when saved object has been changed when attempting to save." + ], + "signature": [ { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/controls/field.tsx" + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewSavedObjectConflictError", + "text": "DataViewSavedObjectConflictError" }, + " extends Error" + ], + "path": "src/plugins/data_views/common/errors/data_view_saved_object_conflict.ts", + "deprecated": false, + "children": [ { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/controls/field.tsx" - }, + "parentPluginId": "data", + "id": "def-common.DataViewSavedObjectConflictError.Unnamed", + "type": "Function", + "tags": [], + "label": "Constructor", + "description": [ + "\nconstructor" + ], + "signature": [ + "any" + ], + "path": "src/plugins/data_views/common/errors/data_view_saved_object_conflict.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.DataViewSavedObjectConflictError.Unnamed.$1", + "type": "string", + "tags": [], + "label": "savedObjectId", + "description": [ + "saved object id with conflict" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/errors/data_view_saved_object_conflict.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.DataViewsService", + "type": "Class", + "tags": [], + "label": "DataViewsService", + "description": [ + "\nData views service, providing CRUD operations for data views." + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/controls/field.tsx" + "parentPluginId": "data", + "id": "def-common.DataViewsService.getCanSave", + "type": "Function", + "tags": [], + "label": "getCanSave", + "description": [ + "\nCan the user save data views?" + ], + "signature": [ + "() => Promise" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "returnComment": [], + "children": [] }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/controls/field.tsx" + "parentPluginId": "data", + "id": "def-common.DataViewsService.Unnamed", + "type": "Function", + "tags": [], + "label": "Constructor", + "description": [ + "\nDataViewsService constructor" + ], + "signature": [ + "any" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.DataViewsService.Unnamed.$1", + "type": "Object", + "tags": [], + "label": "deps", + "description": [ + "Service dependencies" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewsServiceDeps", + "text": "DataViewsServiceDeps" + } + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/controls/top_field.tsx" + "parentPluginId": "data", + "id": "def-common.DataViewsService.getIds", + "type": "Function", + "tags": [], + "label": "getIds", + "description": [ + "\nGets list of index pattern ids." + ], + "signature": [ + "(refresh?: boolean) => Promise" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.DataViewsService.getIds.$1", + "type": "boolean", + "tags": [], + "label": "refresh", + "description": [ + "Force refresh of index pattern list" + ], + "signature": [ + "boolean" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/controls/top_field.tsx" + "parentPluginId": "data", + "id": "def-common.DataViewsService.getTitles", + "type": "Function", + "tags": [], + "label": "getTitles", + "description": [ + "\nGets list of index pattern titles." + ], + "signature": [ + "(refresh?: boolean) => Promise" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.DataViewsService.getTitles.$1", + "type": "boolean", + "tags": [], + "label": "refresh", + "description": [ + "Force refresh of index pattern list" + ], + "signature": [ + "boolean" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/controls/top_sort_field.tsx" + "parentPluginId": "data", + "id": "def-common.DataViewsService.find", + "type": "Function", + "tags": [], + "label": "find", + "description": [ + "\nFind and load index patterns by title." + ], + "signature": [ + "(search: string, size?: number) => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + "[]>" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.DataViewsService.find.$1", + "type": "string", + "tags": [], + "label": "search", + "description": [ + "Search string" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-common.DataViewsService.find.$2", + "type": "number", + "tags": [], + "label": "size", + "description": [ + "Number of data views to return" + ], + "signature": [ + "number" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [ + "DataView[]" + ] }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/controls/top_sort_field.tsx" + "parentPluginId": "data", + "id": "def-common.DataViewsService.getIdsWithTitle", + "type": "Function", + "tags": [], + "label": "getIdsWithTitle", + "description": [ + "\nGets list of index pattern ids with titles." + ], + "signature": [ + "(refresh?: boolean) => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewListItem", + "text": "DataViewListItem" + }, + "[]>" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.DataViewsService.getIdsWithTitle.$1", + "type": "boolean", + "tags": [], + "label": "refresh", + "description": [ + "Force refresh of index pattern list" + ], + "signature": [ + "boolean" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.ts" + "parentPluginId": "data", + "id": "def-common.DataViewsService.clearCache", + "type": "Function", + "tags": [], + "label": "clearCache", + "description": [ + "\nClear index pattern list cache." + ], + "signature": [ + "(id?: string | undefined) => void" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.DataViewsService.clearCache.$1", + "type": "string", + "tags": [], + "label": "id", + "description": [ + "optionally clear a single id" + ], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.ts" + "parentPluginId": "data", + "id": "def-common.DataViewsService.getCache", + "type": "Function", + "tags": [], + "label": "getCache", + "description": [ + "\nGet cache, contains data view saved objects." + ], + "signature": [ + "() => Promise<", + "SavedObject", + "<", + "DataViewSavedObjectAttrs", + ">[] | null | undefined>" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.ts" + "parentPluginId": "data", + "id": "def-common.DataViewsService.getDefault", + "type": "Function", + "tags": [], + "label": "getDefault", + "description": [ + "\nGet default index pattern" + ], + "signature": [ + "() => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + " | null>" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.ts" + "parentPluginId": "data", + "id": "def-common.DataViewsService.getDefaultId", + "type": "Function", + "tags": [], + "label": "getDefaultId", + "description": [ + "\nGet default index pattern id" + ], + "signature": [ + "() => Promise" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.ts" + "parentPluginId": "data", + "id": "def-common.DataViewsService.setDefault", + "type": "Function", + "tags": [], + "label": "setDefault", + "description": [ + "\nOptionally set default index pattern, unless force = true" + ], + "signature": [ + "(id: string | null, force?: boolean) => Promise" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.DataViewsService.setDefault.$1", + "type": "CompoundType", + "tags": [], + "label": "id", + "description": [ + "data view id" + ], + "signature": [ + "string | null" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": false + }, + { + "parentPluginId": "data", + "id": "def-common.DataViewsService.setDefault.$2", + "type": "boolean", + "tags": [], + "label": "force", + "description": [ + "set default data view even if there's an existing default" + ], + "signature": [ + "boolean" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { - "plugin": "dataViewEditor", - "path": "src/plugins/data_view_editor/public/lib/extract_time_fields.test.ts" + "parentPluginId": "data", + "id": "def-common.DataViewsService.hasUserDataView", + "type": "Function", + "tags": [], + "label": "hasUserDataView", + "description": [ + "\nChecks if current user has a user created index pattern ignoring fleet's server default index patterns." + ], + "signature": [ + "() => Promise" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { - "plugin": "dataViewEditor", - "path": "src/plugins/data_view_editor/public/lib/extract_time_fields.test.ts" + "parentPluginId": "data", + "id": "def-common.DataViewsService.getFieldsForWildcard", + "type": "Function", + "tags": [], + "label": "getFieldsForWildcard", + "description": [ + "\nGet field list by providing { pattern }." + ], + "signature": [ + "(options: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.GetFieldsOptions", + "text": "GetFieldsOptions" + }, + ") => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + "[]>" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.DataViewsService.getFieldsForWildcard.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [ + "options for getting field list" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.GetFieldsOptions", + "text": "GetFieldsOptions" + } + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [ + "FieldSpec[]" + ] }, { - "plugin": "dataViewEditor", - "path": "src/plugins/data_view_editor/public/lib/extract_time_fields.test.ts" + "parentPluginId": "data", + "id": "def-common.DataViewsService.getFieldsForIndexPattern", + "type": "Function", + "tags": [], + "label": "getFieldsForIndexPattern", + "description": [ + "\nGet field list by providing an index patttern (or spec)." + ], + "signature": [ + "(indexPattern: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + " | ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewSpec", + "text": "DataViewSpec" + }, + ", options?: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.GetFieldsOptions", + "text": "GetFieldsOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + "[]>" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.DataViewsService.getFieldsForIndexPattern.$1", + "type": "CompoundType", + "tags": [], + "label": "indexPattern", + "description": [], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + " | ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewSpec", + "text": "DataViewSpec" + } + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-common.DataViewsService.getFieldsForIndexPattern.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [ + "options for getting field list" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.GetFieldsOptions", + "text": "GetFieldsOptions" + }, + " | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [ + "FieldSpec[]" + ] }, { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.test.ts" + "parentPluginId": "data", + "id": "def-common.DataViewsService.refreshFields", + "type": "Function", + "tags": [], + "label": "refreshFields", + "description": [ + "\nRefresh field list for a given index pattern." + ], + "signature": [ + "(indexPattern: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + ") => Promise" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.DataViewsService.refreshFields.$1", + "type": "Object", + "tags": [], + "label": "indexPattern", + "description": [], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + } + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.test.ts" + "parentPluginId": "data", + "id": "def-common.DataViewsService.fieldArrayToMap", + "type": "Function", + "tags": [], + "label": "fieldArrayToMap", + "description": [ + "\nConverts field array to map." + ], + "signature": [ + "(fields: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + "[], fieldAttrs?: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldAttrs", + "text": "FieldAttrs" + }, + " | undefined) => ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewFieldMap", + "text": "DataViewFieldMap" + } + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.DataViewsService.fieldArrayToMap.$1", + "type": "Array", + "tags": [], + "label": "fields", + "description": [ + ": FieldSpec[]" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + "[]" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-common.DataViewsService.fieldArrayToMap.$2", + "type": "Object", + "tags": [], + "label": "fieldAttrs", + "description": [ + ": FieldAttrs" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldAttrs", + "text": "FieldAttrs" + }, + " | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [ + "Record" + ] }, { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.test.ts" + "parentPluginId": "data", + "id": "def-common.DataViewsService.savedObjectToSpec", + "type": "Function", + "tags": [], + "label": "savedObjectToSpec", + "description": [ + "\nConverts data view saved object to data view spec." + ], + "signature": [ + "(savedObject: ", + "SavedObject", + "<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewAttributes", + "text": "DataViewAttributes" + }, + ">) => ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewSpec", + "text": "DataViewSpec" + } + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.DataViewsService.savedObjectToSpec.$1", + "type": "Object", + "tags": [], + "label": "savedObject", + "description": [], + "signature": [ + "SavedObject", + "<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewAttributes", + "text": "DataViewAttributes" + }, + ">" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [ + "DataViewSpec" + ] }, { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.test.ts" + "parentPluginId": "data", + "id": "def-common.DataViewsService.get", + "type": "Function", + "tags": [], + "label": "get", + "description": [ + "\nGet an index pattern by id, cache optimized." + ], + "signature": [ + "(id: string) => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + ">" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.DataViewsService.get.$1", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.test.ts" + "parentPluginId": "data", + "id": "def-common.DataViewsService.create", + "type": "Function", + "tags": [], + "label": "create", + "description": [ + "\nCreate a new data view instance." + ], + "signature": [ + "(spec: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewSpec", + "text": "DataViewSpec" + }, + ", skipFetchFields?: boolean) => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + ">" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.DataViewsService.create.$1", + "type": "Object", + "tags": [], + "label": "spec", + "description": [ + "data view spec" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewSpec", + "text": "DataViewSpec" + } + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-common.DataViewsService.create.$2", + "type": "boolean", + "tags": [], + "label": "skipFetchFields", + "description": [ + "if true, will not fetch fields" + ], + "signature": [ + "boolean" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [ + "DataView" + ] }, { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.test.ts" + "parentPluginId": "data", + "id": "def-common.DataViewsService.createAndSave", + "type": "Function", + "tags": [], + "label": "createAndSave", + "description": [ + "\nCreate a new data view and save it right away." + ], + "signature": [ + "(spec: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewSpec", + "text": "DataViewSpec" + }, + ", override?: boolean, skipFetchFields?: boolean) => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + ">" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.DataViewsService.createAndSave.$1", + "type": "Object", + "tags": [], + "label": "spec", + "description": [ + "data view spec" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewSpec", + "text": "DataViewSpec" + } + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-common.DataViewsService.createAndSave.$2", + "type": "boolean", + "tags": [], + "label": "override", + "description": [ + "Overwrite if existing index pattern exists." + ], + "signature": [ + "boolean" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-common.DataViewsService.createAndSave.$3", + "type": "boolean", + "tags": [], + "label": "skipFetchFields", + "description": [ + "Whether to skip field refresh step." + ], + "signature": [ + "boolean" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/fields/data_view_field.test.ts" + "parentPluginId": "data", + "id": "def-common.DataViewsService.createSavedObject", + "type": "Function", + "tags": [], + "label": "createSavedObject", + "description": [ + "\nSave a new data view." + ], + "signature": [ + "(dataView: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + ", override?: boolean) => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + ">" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.DataViewsService.createSavedObject.$1", + "type": "Object", + "tags": [], + "label": "dataView", + "description": [ + "data view instance" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + } + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-common.DataViewsService.createSavedObject.$2", + "type": "boolean", + "tags": [], + "label": "override", + "description": [ + "Overwrite if existing index pattern exists" + ], + "signature": [ + "boolean" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/fields/data_view_field.test.ts" + "parentPluginId": "data", + "id": "def-common.DataViewsService.updateSavedObject", + "type": "Function", + "tags": [], + "label": "updateSavedObject", + "description": [ + "\nSave existing dat aview. Will attempt to merge differences if there are conflicts." + ], + "signature": [ + "(indexPattern: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + ", saveAttempts?: number, ignoreErrors?: boolean) => Promise" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.DataViewsService.updateSavedObject.$1", + "type": "Object", + "tags": [], + "label": "indexPattern", + "description": [], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + } + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-common.DataViewsService.updateSavedObject.$2", + "type": "number", + "tags": [], + "label": "saveAttempts", + "description": [], + "signature": [ + "number" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-common.DataViewsService.updateSavedObject.$3", + "type": "boolean", + "tags": [], + "label": "ignoreErrors", + "description": [], + "signature": [ + "boolean" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/fields/data_view_field.test.ts" + "parentPluginId": "data", + "id": "def-common.DataViewsService.delete", + "type": "Function", + "tags": [], + "label": "delete", + "description": [ + "\nDeletes an index pattern from .kibana index." + ], + "signature": [ + "(indexPatternId: string) => Promise<{}>" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.DataViewsService.delete.$1", + "type": "string", + "tags": [], + "label": "indexPatternId", + "description": [ + ": Id of kibana Index Pattern to delete" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/fields/data_view_field.test.ts" + "parentPluginId": "data", + "id": "def-common.DataViewsService.getDefaultDataView", + "type": "Function", + "tags": [], + "label": "getDefaultDataView", + "description": [ + "\nReturns the default data view as an object.\nIf no default is found, or it is missing\nanother data view is selected as default and returned.\nIf no possible data view found to become a default returns null.\n" + ], + "signature": [ + "() => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + " | null>" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [], + "returnComment": [ + "default data view" + ] } ], - "children": [], "initialIsOpen": false }, { "parentPluginId": "data", - "id": "def-common.IndexPatternsService", + "id": "def-common.DuplicateDataViewError", "type": "Class", - "tags": [ - "deprecated" + "tags": [], + "label": "DuplicateDataViewError", + "description": [ + "\nError thrown when attempting to create duplicate index pattern based on title." ], - "label": "IndexPatternsService", - "description": [], "signature": [ { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.IndexPatternsService", - "text": "IndexPatternsService" + "section": "def-common.DuplicateDataViewError", + "text": "DuplicateDataViewError" }, - " extends ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewsService", - "text": "DataViewsService" - } + " extends Error" ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": true, - "references": [ - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/index.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/server/data_indexing/create_doc_source.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/server/data_indexing/create_doc_source.ts" - }, + "path": "src/plugins/data_views/common/errors/duplicate_index_pattern.ts", + "deprecated": false, + "children": [ { - "plugin": "dataViews", - "path": "src/plugins/data_views/public/index.ts" + "parentPluginId": "data", + "id": "def-common.DuplicateDataViewError.Unnamed", + "type": "Function", + "tags": [], + "label": "Constructor", + "description": [ + "\nconstructor" + ], + "signature": [ + "any" + ], + "path": "src/plugins/data_views/common/errors/duplicate_index_pattern.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.DuplicateDataViewError.Unnamed.$1", + "type": "string", + "tags": [], + "label": "message", + "description": [ + "- Error message" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/errors/duplicate_index_pattern.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] } ], - "children": [], "initialIsOpen": false }, { @@ -24602,6 +25986,9 @@ "tags": [], "label": "KbnFieldType", "description": [], + "signature": [ + "KbnFieldType" + ], "path": "node_modules/@types/kbn__field-types/index.d.ts", "deprecated": false, "children": [ @@ -25393,9 +26780,9 @@ "DataViewFieldBase", ", params: ", "RangeFilterParams", - ", indexPattern: ", + ", indexPattern?: ", "DataViewBase", - ", formattedValue?: string | undefined) => ", + " | undefined, formattedValue?: string | undefined) => ", "RangeFilter", " | ", "ScriptedRangeFilter", @@ -25441,7 +26828,8 @@ "label": "indexPattern", "description": [], "signature": [ - "DataViewBase" + "DataViewBase", + " | undefined" ], "path": "node_modules/@types/kbn__es-query/index.d.ts", "deprecated": false @@ -26276,8 +27664,8 @@ "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" + "section": "def-common.DataViewField", + "text": "DataViewField" }, ") => boolean" ], @@ -26296,8 +27684,8 @@ "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" + "section": "def-common.DataViewField", + "text": "DataViewField" } ], "path": "src/plugins/data_views/common/fields/utils.ts", @@ -27127,7 +28515,7 @@ "tags": [], "label": "DataViewAttributes", "description": [ - "\nInterface for an index pattern saved object" + "\nInterface for the data view saved object" ], "path": "src/plugins/data_views/common/types.ts", "deprecated": false, @@ -27138,7 +28526,9 @@ "type": "string", "tags": [], "label": "fields", - "description": [], + "description": [ + "\nFields as a serialized array of field specs" + ], "path": "src/plugins/data_views/common/types.ts", "deprecated": false }, @@ -27148,7 +28538,9 @@ "type": "string", "tags": [], "label": "title", - "description": [], + "description": [ + "\nData view title" + ], "path": "src/plugins/data_views/common/types.ts", "deprecated": false }, @@ -27158,7 +28550,9 @@ "type": "string", "tags": [], "label": "type", - "description": [], + "description": [ + "\nData view type, default or rollup" + ], "signature": [ "string | undefined" ], @@ -27171,7 +28565,9 @@ "type": "string", "tags": [], "label": "typeMeta", - "description": [], + "description": [ + "\nType metadata information, serialized. Only used by rollup data views." + ], "signature": [ "string | undefined" ], @@ -27184,7 +28580,9 @@ "type": "string", "tags": [], "label": "timeFieldName", - "description": [], + "description": [ + "\nTime field name" + ], "signature": [ "string | undefined" ], @@ -27197,7 +28595,9 @@ "type": "string", "tags": [], "label": "sourceFilters", - "description": [], + "description": [ + "\nSerialized array of filters. Used by discover to hide fields." + ], "signature": [ "string | undefined" ], @@ -27210,7 +28610,9 @@ "type": "string", "tags": [], "label": "fieldFormatMap", - "description": [], + "description": [ + "\nSerialized map of field formats by field name" + ], "signature": [ "string | undefined" ], @@ -27223,7 +28625,9 @@ "type": "string", "tags": [], "label": "fieldAttrs", - "description": [], + "description": [ + "\nSerialized map of field attributes, currently field count and name" + ], "signature": [ "string | undefined" ], @@ -27236,7 +28640,9 @@ "type": "string", "tags": [], "label": "runtimeFieldMap", - "description": [], + "description": [ + "\nSerialized map of runtime field definitions, by field name" + ], "signature": [ "string | undefined" ], @@ -27250,7 +28656,7 @@ "tags": [], "label": "allowNoIndex", "description": [ - "\nprevents errors when index pattern exists before indices" + "\nPrevents errors when index pattern exists before indices" ], "signature": [ "boolean | undefined" @@ -27267,7 +28673,9 @@ "type": "Interface", "tags": [], "label": "DataViewListItem", - "description": [], + "description": [ + "\nResult from data view search - summary data." + ], "path": "src/plugins/data_views/common/data_views/data_views.ts", "deprecated": false, "children": [ @@ -27277,7 +28685,9 @@ "type": "string", "tags": [], "label": "id", - "description": [], + "description": [ + "\nSaved object id" + ], "path": "src/plugins/data_views/common/data_views/data_views.ts", "deprecated": false }, @@ -27287,7 +28697,9 @@ "type": "Array", "tags": [], "label": "namespaces", - "description": [], + "description": [ + "\nNamespace ids" + ], "signature": [ "string[] | undefined" ], @@ -27300,7 +28712,9 @@ "type": "string", "tags": [], "label": "title", - "description": [], + "description": [ + "\nData view title" + ], "path": "src/plugins/data_views/common/data_views/data_views.ts", "deprecated": false }, @@ -27310,7 +28724,9 @@ "type": "string", "tags": [], "label": "type", - "description": [], + "description": [ + "\nData view type" + ], "signature": [ "string | undefined" ], @@ -27323,7 +28739,9 @@ "type": "Object", "tags": [], "label": "typeMeta", - "description": [], + "description": [ + "\nData view type meta" + ], "signature": [ { "pluginId": "dataViews", @@ -27347,7 +28765,7 @@ "tags": [], "label": "DataViewSpec", "description": [ - "\nStatic index pattern format\nSerialized data object, representing index pattern attributes and state" + "\nStatic data view format\nSerialized data object, representing data view attributes and state" ], "path": "src/plugins/data_views/common/types.ts", "deprecated": false, @@ -27359,7 +28777,7 @@ "tags": [], "label": "id", "description": [ - "\nsaved object id" + "\nSaved object id" ], "signature": [ "string | undefined" @@ -27374,7 +28792,7 @@ "tags": [], "label": "version", "description": [ - "\nsaved object version string" + "\nSaved object version string" ], "signature": [ "string | undefined" @@ -27388,7 +28806,9 @@ "type": "string", "tags": [], "label": "title", - "description": [], + "description": [ + "\nData view title" + ], "signature": [ "string | undefined" ], @@ -27401,7 +28821,9 @@ "type": "string", "tags": [], "label": "timeFieldName", - "description": [], + "description": [ + "\nName of timestamp field" + ], "signature": [ "string | undefined" ], @@ -27414,7 +28836,9 @@ "type": "Array", "tags": [], "label": "sourceFilters", - "description": [], + "description": [ + "\nList of filters which discover uses to hide fields" + ], "signature": [ { "pluginId": "dataViews", @@ -27434,7 +28858,9 @@ "type": "Object", "tags": [], "label": "fields", - "description": [], + "description": [ + "\nMap of fields by name" + ], "signature": [ { "pluginId": "dataViews", @@ -27454,7 +28880,9 @@ "type": "Object", "tags": [], "label": "typeMeta", - "description": [], + "description": [ + "\nMetadata about data view, only used by rollup data views" + ], "signature": [ { "pluginId": "dataViews", @@ -27474,7 +28902,9 @@ "type": "string", "tags": [], "label": "type", - "description": [], + "description": [ + "\nDefault or rollup" + ], "signature": [ "string | undefined" ], @@ -27487,7 +28917,9 @@ "type": "Object", "tags": [], "label": "fieldFormats", - "description": [], + "description": [ + "\nMap of serialized field formats by field name" + ], "signature": [ "Record | undefined" ], @@ -27709,7 +29159,9 @@ "type": "Object", "tags": [], "label": "format", - "description": [], + "description": [ + "\nField formatting in serialized format" + ], "signature": [ { "pluginId": "fieldFormats", @@ -27737,7 +29189,9 @@ "type": "Array", "tags": [], "label": "esTypes", - "description": [], + "description": [ + "\nElasticsearch field types used by backing indices" + ], "signature": [ "string[] | undefined" ], @@ -27750,7 +29204,9 @@ "type": "boolean", "tags": [], "label": "searchable", - "description": [], + "description": [ + "\nTrue if field is searchable" + ], "path": "src/plugins/data_views/common/types.ts", "deprecated": false }, @@ -27760,7 +29216,9 @@ "type": "boolean", "tags": [], "label": "aggregatable", - "description": [], + "description": [ + "\nTrue if field is aggregatable" + ], "path": "src/plugins/data_views/common/types.ts", "deprecated": false }, @@ -27770,7 +29228,9 @@ "type": "CompoundType", "tags": [], "label": "readFromDocValues", - "description": [], + "description": [ + "\nTrue if can be read from doc values" + ], "signature": [ "boolean | undefined" ], @@ -27783,7 +29243,9 @@ "type": "CompoundType", "tags": [], "label": "indexed", - "description": [], + "description": [ + "\nTrue if field is indexed" + ], "signature": [ "boolean | undefined" ], @@ -27796,105 +29258,9 @@ "type": "string", "tags": [], "label": "customLabel", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.FieldSpec.runtimeField", - "type": "Object", - "tags": [], - "label": "runtimeField", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.RuntimeFieldSpec", - "text": "RuntimeFieldSpec" - }, - " | undefined" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.FieldSpec.shortDotsEnable", - "type": "CompoundType", - "tags": [], - "label": "shortDotsEnable", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.FieldSpec.isMapped", - "type": "CompoundType", - "tags": [], - "label": "isMapped", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.FieldSpecExportFmt", - "type": "Interface", - "tags": [], - "label": "FieldSpecExportFmt", - "description": [], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.FieldSpecExportFmt.count", - "type": "number", - "tags": [], - "label": "count", - "description": [], - "signature": [ - "number | undefined" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.FieldSpecExportFmt.script", - "type": "string", - "tags": [], - "label": "script", - "description": [], - "signature": [ - "string | undefined" + "description": [ + "\nCustom label for field, used for display in kibana" ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.FieldSpecExportFmt.lang", - "type": "string", - "tags": [], - "label": "lang", - "description": [], "signature": [ "string | undefined" ], @@ -27903,112 +29269,21 @@ }, { "parentPluginId": "data", - "id": "def-common.FieldSpecExportFmt.conflictDescriptions", + "id": "def-common.FieldSpec.runtimeField", "type": "Object", - "tags": [], - "label": "conflictDescriptions", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpecConflictDescriptions", - "text": "FieldSpecConflictDescriptions" - }, - " | undefined" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.FieldSpecExportFmt.name", - "type": "string", - "tags": [], - "label": "name", - "description": [], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.FieldSpecExportFmt.type", - "type": "Enum", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "KBN_FIELD_TYPES" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.FieldSpecExportFmt.esTypes", - "type": "Array", - "tags": [], - "label": "esTypes", - "description": [], - "signature": [ - "string[] | undefined" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.FieldSpecExportFmt.scripted", - "type": "boolean", - "tags": [], - "label": "scripted", - "description": [], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.FieldSpecExportFmt.searchable", - "type": "boolean", - "tags": [], - "label": "searchable", - "description": [], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.FieldSpecExportFmt.aggregatable", - "type": "boolean", - "tags": [], - "label": "aggregatable", - "description": [], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.FieldSpecExportFmt.readFromDocValues", - "type": "CompoundType", - "tags": [], - "label": "readFromDocValues", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.FieldSpecExportFmt.subType", - "type": "CompoundType", - "tags": [], - "label": "subType", - "description": [], + "tags": [], + "label": "runtimeField", + "description": [ + "\nRuntime field definition" + ], "signature": [ - "IFieldSubType", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.RuntimeFieldSpec", + "text": "RuntimeFieldSpec" + }, " | undefined" ], "path": "src/plugins/data_views/common/types.ts", @@ -28016,39 +29291,28 @@ }, { "parentPluginId": "data", - "id": "def-common.FieldSpecExportFmt.format", - "type": "Object", + "id": "def-common.FieldSpec.shortDotsEnable", + "type": "CompoundType", "tags": [], - "label": "format", - "description": [], + "label": "shortDotsEnable", + "description": [ + "\nWhether short dots are enabled, based on uiSettings." + ], "signature": [ - { - "pluginId": "fieldFormats", - "scope": "common", - "docId": "kibFieldFormatsPluginApi", - "section": "def-common.SerializedFieldFormat", - "text": "SerializedFieldFormat" - }, - "<", - { - "pluginId": "fieldFormats", - "scope": "common", - "docId": "kibFieldFormatsPluginApi", - "section": "def-common.FieldFormatParams", - "text": "FieldFormatParams" - }, - "> | undefined" + "boolean | undefined" ], "path": "src/plugins/data_views/common/types.ts", "deprecated": false }, { "parentPluginId": "data", - "id": "def-common.FieldSpecExportFmt.indexed", + "id": "def-common.FieldSpec.isMapped", "type": "CompoundType", "tags": [], - "label": "indexed", - "description": [], + "label": "isMapped", + "description": [ + "\nIs this field in the mapping? False if a scripted or runtime field defined on the data view." + ], "signature": [ "boolean | undefined" ], @@ -28232,62 +29496,6 @@ ], "initialIsOpen": false }, - { - "parentPluginId": "data", - "id": "def-common.GetFieldsOptionsTimePattern", - "type": "Interface", - "tags": [], - "label": "GetFieldsOptionsTimePattern", - "description": [], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.GetFieldsOptionsTimePattern.pattern", - "type": "string", - "tags": [], - "label": "pattern", - "description": [], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.GetFieldsOptionsTimePattern.metaFields", - "type": "Array", - "tags": [], - "label": "metaFields", - "description": [], - "signature": [ - "string[]" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.GetFieldsOptionsTimePattern.lookBack", - "type": "number", - "tags": [], - "label": "lookBack", - "description": [], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.GetFieldsOptionsTimePattern.interval", - "type": "string", - "tags": [], - "label": "interval", - "description": [], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, { "parentPluginId": "data", "id": "def-common.IDataViewsApiClient", @@ -28298,50 +29506,6 @@ "path": "src/plugins/data_views/common/types.ts", "deprecated": false, "children": [ - { - "parentPluginId": "data", - "id": "def-common.IDataViewsApiClient.getFieldsForTimePattern", - "type": "Function", - "tags": [], - "label": "getFieldsForTimePattern", - "description": [], - "signature": [ - "(options: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.GetFieldsOptionsTimePattern", - "text": "GetFieldsOptionsTimePattern" - }, - ") => Promise" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.IDataViewsApiClient.getFieldsForTimePattern.$1", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.GetFieldsOptionsTimePattern", - "text": "GetFieldsOptionsTimePattern" - } - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, { "parentPluginId": "data", "id": "def-common.IDataViewsApiClient.getFieldsForWildcard", @@ -28406,865 +29570,408 @@ }, { "parentPluginId": "data", - "id": "def-common.IFieldType", + "id": "def-common.IndexPatternExpressionType", "type": "Interface", - "tags": [ - "deprecated" - ], - "label": "IFieldType", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" - }, - " extends ", - "DataViewFieldBase" - ], - "path": "src/plugins/data_views/common/fields/types.ts", - "deprecated": true, - "removeBy": "8.2", - "references": [ - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/fields/utils.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/fields/utils.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/fields/data_view_field.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/fields/data_view_field.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/fields/field_list.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/fields/field_list.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/fields/field_list.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/fields/field_list.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/index.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/types.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/types.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/types.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/types.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/utils.test.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/utils.test.ts" - } + "tags": [], + "label": "IndexPatternExpressionType", + "description": [ + "\nIndex pattern expression interface" ], + "path": "src/plugins/data_views/common/expressions/load_index_pattern.ts", + "deprecated": false, "children": [ { "parentPluginId": "data", - "id": "def-common.IFieldType.count", - "type": "number", + "id": "def-common.IndexPatternExpressionType.type", + "type": "string", "tags": [], - "label": "count", - "description": [], + "label": "type", + "description": [ + "\nExpression type" + ], "signature": [ - "number | undefined" + "\"index_pattern\"" ], - "path": "src/plugins/data_views/common/fields/types.ts", + "path": "src/plugins/data_views/common/expressions/load_index_pattern.ts", "deprecated": false }, { "parentPluginId": "data", - "id": "def-common.IFieldType.esTypes", - "type": "Array", + "id": "def-common.IndexPatternExpressionType.value", + "type": "Object", "tags": [], - "label": "esTypes", - "description": [], + "label": "value", + "description": [ + "\nValue - DataViewSpec" + ], "signature": [ - "string[] | undefined" + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewSpec", + "text": "DataViewSpec" + } ], - "path": "src/plugins/data_views/common/fields/types.ts", + "path": "src/plugins/data_views/common/expressions/load_index_pattern.ts", "deprecated": false - }, + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.KbnFieldTypeOptions", + "type": "Interface", + "tags": [], + "label": "KbnFieldTypeOptions", + "description": [], + "signature": [ + "KbnFieldTypeOptions" + ], + "path": "node_modules/@types/kbn__field-types/index.d.ts", + "deprecated": false, + "children": [ { "parentPluginId": "data", - "id": "def-common.IFieldType.aggregatable", - "type": "CompoundType", + "id": "def-common.KbnFieldTypeOptions.sortable", + "type": "boolean", "tags": [], - "label": "aggregatable", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "src/plugins/data_views/common/fields/types.ts", + "label": "sortable", + "description": [], + "path": "node_modules/@types/kbn__field-types/index.d.ts", "deprecated": false }, { "parentPluginId": "data", - "id": "def-common.IFieldType.filterable", - "type": "CompoundType", + "id": "def-common.KbnFieldTypeOptions.filterable", + "type": "boolean", "tags": [], "label": "filterable", "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "src/plugins/data_views/common/fields/types.ts", + "path": "node_modules/@types/kbn__field-types/index.d.ts", "deprecated": false }, { "parentPluginId": "data", - "id": "def-common.IFieldType.searchable", - "type": "CompoundType", + "id": "def-common.KbnFieldTypeOptions.name", + "type": "string", "tags": [], - "label": "searchable", + "label": "name", "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "src/plugins/data_views/common/fields/types.ts", + "path": "node_modules/@types/kbn__field-types/index.d.ts", "deprecated": false }, { "parentPluginId": "data", - "id": "def-common.IFieldType.sortable", - "type": "CompoundType", + "id": "def-common.KbnFieldTypeOptions.esTypes", + "type": "Array", "tags": [], - "label": "sortable", + "label": "esTypes", "description": [], "signature": [ - "boolean | undefined" + "ES_FIELD_TYPES", + "[]" ], - "path": "src/plugins/data_views/common/fields/types.ts", + "path": "node_modules/@types/kbn__field-types/index.d.ts", "deprecated": false - }, + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.SavedObject", + "type": "Interface", + "tags": [], + "label": "SavedObject", + "description": [], + "signature": [ + "SavedObject", + "" + ], + "path": "src/core/types/saved_objects.ts", + "deprecated": false, + "children": [ { "parentPluginId": "data", - "id": "def-common.IFieldType.visualizable", - "type": "CompoundType", + "id": "def-common.SavedObject.id", + "type": "string", "tags": [], - "label": "visualizable", - "description": [], - "signature": [ - "boolean | undefined" + "label": "id", + "description": [ + "The ID of this Saved Object, guaranteed to be unique for all objects of the same `type`" ], - "path": "src/plugins/data_views/common/fields/types.ts", + "path": "src/core/types/saved_objects.ts", "deprecated": false }, { "parentPluginId": "data", - "id": "def-common.IFieldType.readFromDocValues", - "type": "CompoundType", + "id": "def-common.SavedObject.type", + "type": "string", "tags": [], - "label": "readFromDocValues", - "description": [], - "signature": [ - "boolean | undefined" + "label": "type", + "description": [ + " The type of Saved Object. Each plugin can define it's own custom Saved Object types." ], - "path": "src/plugins/data_views/common/fields/types.ts", + "path": "src/core/types/saved_objects.ts", "deprecated": false }, { "parentPluginId": "data", - "id": "def-common.IFieldType.displayName", + "id": "def-common.SavedObject.version", "type": "string", "tags": [], - "label": "displayName", - "description": [], + "label": "version", + "description": [ + "An opaque version number which changes on each successful write operation. Can be used for implementing optimistic concurrency control." + ], "signature": [ "string | undefined" ], - "path": "src/plugins/data_views/common/fields/types.ts", + "path": "src/core/types/saved_objects.ts", "deprecated": false }, { "parentPluginId": "data", - "id": "def-common.IFieldType.customLabel", + "id": "def-common.SavedObject.updated_at", "type": "string", "tags": [], - "label": "customLabel", - "description": [], + "label": "updated_at", + "description": [ + "Timestamp of the last time this document had been updated." + ], "signature": [ "string | undefined" ], - "path": "src/plugins/data_views/common/fields/types.ts", + "path": "src/core/types/saved_objects.ts", "deprecated": false }, { "parentPluginId": "data", - "id": "def-common.IFieldType.format", - "type": "Any", + "id": "def-common.SavedObject.error", + "type": "Object", "tags": [], - "label": "format", + "label": "error", "description": [], "signature": [ - "any" + "SavedObjectError", + " | undefined" ], - "path": "src/plugins/data_views/common/fields/types.ts", + "path": "src/core/types/saved_objects.ts", "deprecated": false }, { "parentPluginId": "data", - "id": "def-common.IFieldType.toSpec", - "type": "Function", + "id": "def-common.SavedObject.attributes", + "type": "Uncategorized", "tags": [], - "label": "toSpec", - "description": [], - "signature": [ - "((options?: { getFormatterForField?: ((field: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" - }, - " | ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - " | ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" - }, - ") => ", - { - "pluginId": "fieldFormats", - "scope": "common", - "docId": "kibFieldFormatsPluginApi", - "section": "def-common.FieldFormat", - "text": "FieldFormat" - }, - ") | undefined; } | undefined) => ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - ") | undefined" + "label": "attributes", + "description": [ + "{@inheritdoc SavedObjectAttributes}" ], - "path": "src/plugins/data_views/common/fields/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.IFieldType.toSpec.$1", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "path": "src/plugins/data_views/common/fields/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.IFieldType.toSpec.$1.getFormatterForField", - "type": "Function", - "tags": [], - "label": "getFormatterForField", - "description": [], - "signature": [ - "((field: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" - }, - " | ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - " | ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" - }, - ") => ", - { - "pluginId": "fieldFormats", - "scope": "common", - "docId": "kibFieldFormatsPluginApi", - "section": "def-common.FieldFormat", - "text": "FieldFormat" - }, - ") | undefined" - ], - "path": "src/plugins/data_views/common/fields/types.ts", - "deprecated": false - } - ] - } + "signature": [ + "T" ], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.IIndexPattern", - "type": "Interface", - "tags": [ - "deprecated" - ], - "label": "IIndexPattern", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IIndexPattern", - "text": "IIndexPattern" - }, - " extends ", - "DataViewBase" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": true, - "references": [ - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/index.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts" - } - ], - "children": [ - { - "parentPluginId": "data", - "id": "def-common.IIndexPattern.title", - "type": "string", - "tags": [], - "label": "title", - "description": [], - "path": "src/plugins/data_views/common/types.ts", + "path": "src/core/types/saved_objects.ts", "deprecated": false }, { "parentPluginId": "data", - "id": "def-common.IIndexPattern.fields", + "id": "def-common.SavedObject.references", "type": "Array", "tags": [], - "label": "fields", - "description": [], + "label": "references", + "description": [ + "{@inheritdoc SavedObjectReference}" + ], "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" - }, + "SavedObjectReference", "[]" ], - "path": "src/plugins/data_views/common/types.ts", + "path": "src/core/types/saved_objects.ts", "deprecated": false }, { "parentPluginId": "data", - "id": "def-common.IIndexPattern.type", - "type": "string", + "id": "def-common.SavedObject.migrationVersion", + "type": "Object", "tags": [], - "label": "type", + "label": "migrationVersion", "description": [ - "\nType is used for identifying rollup indices, otherwise left undefined" + "{@inheritdoc SavedObjectsMigrationVersion}" ], "signature": [ - "string | undefined" + "SavedObjectsMigrationVersion", + " | undefined" ], - "path": "src/plugins/data_views/common/types.ts", + "path": "src/core/types/saved_objects.ts", "deprecated": false }, { "parentPluginId": "data", - "id": "def-common.IIndexPattern.timeFieldName", + "id": "def-common.SavedObject.coreMigrationVersion", "type": "string", "tags": [], - "label": "timeFieldName", - "description": [], + "label": "coreMigrationVersion", + "description": [ + "A semver value that is used when upgrading objects between Kibana versions." + ], "signature": [ "string | undefined" ], - "path": "src/plugins/data_views/common/types.ts", + "path": "src/core/types/saved_objects.ts", "deprecated": false }, { "parentPluginId": "data", - "id": "def-common.IIndexPattern.getTimeField", - "type": "Function", + "id": "def-common.SavedObject.namespaces", + "type": "Array", "tags": [], - "label": "getTimeField", - "description": [], - "signature": [ - "(() => ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" - }, - " | undefined) | undefined" + "label": "namespaces", + "description": [ + "\nSpace(s) that this saved object exists in. This attribute is not used for \"global\" saved object types which are registered with\n`namespaceType: 'agnostic'`." ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-common.IIndexPattern.fieldFormatMap", - "type": "Object", - "tags": [], - "label": "fieldFormatMap", - "description": [], "signature": [ - "Record | undefined> | undefined" + "string[] | undefined" ], - "path": "src/plugins/data_views/common/types.ts", + "path": "src/core/types/saved_objects.ts", "deprecated": false }, { "parentPluginId": "data", - "id": "def-common.IIndexPattern.getFormatterForField", - "type": "Function", + "id": "def-common.SavedObject.originId", + "type": "string", "tags": [], - "label": "getFormatterForField", + "label": "originId", "description": [ - "\nLook up a formatter for a given field" + "\nThe ID of the saved object this originated from. This is set if this object's `id` was regenerated; that can happen during migration\nfrom a legacy single-namespace type, or during import. It is only set during migration or create operations. This is used during import\nto ensure that ID regeneration is deterministic, so saved objects will be overwritten if they are imported multiple times into a given\nspace." ], "signature": [ - "((field: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" - }, - " | ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - " | ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" - }, - ") => ", - { - "pluginId": "fieldFormats", - "scope": "common", - "docId": "kibFieldFormatsPluginApi", - "section": "def-common.FieldFormat", - "text": "FieldFormat" - }, - ") | undefined" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.IIndexPattern.getFormatterForField.$1", - "type": "CompoundType", - "tags": [], - "label": "field", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" - }, - " | ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - " | ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" - } - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "isRequired": true - } + "string | undefined" ], - "returnComment": [] + "path": "src/core/types/saved_objects.ts", + "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "data", - "id": "def-common.IIndexPatternFieldList", + "id": "def-common.SourceFilter", "type": "Interface", "tags": [], - "label": "IIndexPatternFieldList", + "label": "SourceFilter", "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IIndexPatternFieldList", - "text": "IIndexPatternFieldList" - }, - " extends ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" - }, - "[]" - ], - "path": "src/plugins/data_views/common/fields/field_list.ts", + "path": "src/plugins/data_views/common/types.ts", "deprecated": false, "children": [ { "parentPluginId": "data", - "id": "def-common.IIndexPatternFieldList.add", - "type": "Function", - "tags": [], - "label": "add", - "description": [], - "signature": [ - "(field: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - ") => ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" - } - ], - "path": "src/plugins/data_views/common/fields/field_list.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.IIndexPatternFieldList.add.$1", - "type": "Object", - "tags": [], - "label": "field", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - } - ], - "path": "src/plugins/data_views/common/fields/field_list.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-common.IIndexPatternFieldList.getAll", - "type": "Function", - "tags": [], - "label": "getAll", - "description": [], - "signature": [ - "() => ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" - }, - "[]" - ], - "path": "src/plugins/data_views/common/fields/field_list.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-common.IIndexPatternFieldList.getByName", - "type": "Function", + "id": "def-common.SourceFilter.value", + "type": "string", "tags": [], - "label": "getByName", + "label": "value", "description": [], - "signature": [ - "(name: string) => ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" - }, - " | undefined" - ], - "path": "src/plugins/data_views/common/fields/field_list.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.IIndexPatternFieldList.getByName.$1", - "type": "string", - "tags": [], - "label": "name", - "description": [], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/fields/field_list.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.TypeMeta", + "type": "Interface", + "tags": [], + "label": "TypeMeta", + "description": [ + "\nInterface for metadata about rollup indices" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "children": [ { "parentPluginId": "data", - "id": "def-common.IIndexPatternFieldList.getByType", - "type": "Function", + "id": "def-common.TypeMeta.aggs", + "type": "Object", "tags": [], - "label": "getByType", - "description": [], + "label": "aggs", + "description": [ + "\nAggregation restrictions for rollup fields" + ], "signature": [ - "(type: string) => ", + "Record | undefined" ], - "returnComment": [] + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, { "parentPluginId": "data", - "id": "def-common.IIndexPatternFieldList.remove", + "id": "def-common.TypeMeta.params", + "type": "Object", + "tags": [], + "label": "params", + "description": [ + "\nParams for retrieving rollup field data" + ], + "signature": [ + "{ rollup_index: string; } | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.UiSettingsCommon", + "type": "Interface", + "tags": [], + "label": "UiSettingsCommon", + "description": [ + "\nInterface for UiSettings common interface {@link UiSettingsClient}" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.UiSettingsCommon.get", "type": "Function", "tags": [], - "label": "remove", - "description": [], + "label": "get", + "description": [ + "\nGet a setting value" + ], "signature": [ - "(field: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" - }, - ") => void" + "(key: string) => Promise" ], - "path": "src/plugins/data_views/common/fields/field_list.ts", + "path": "src/plugins/data_views/common/types.ts", "deprecated": false, "children": [ { "parentPluginId": "data", - "id": "def-common.IIndexPatternFieldList.remove.$1", - "type": "Object", + "id": "def-common.UiSettingsCommon.get.$1", + "type": "string", "tags": [], - "label": "field", - "description": [], + "label": "key", + "description": [ + "name of value" + ], "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" - } + "string" ], - "path": "src/plugins/data_views/common/fields/field_list.ts", + "path": "src/plugins/data_views/common/types.ts", "deprecated": false, "isRequired": true } @@ -29273,102 +29980,65 @@ }, { "parentPluginId": "data", - "id": "def-common.IIndexPatternFieldList.removeAll", + "id": "def-common.UiSettingsCommon.getAll", "type": "Function", "tags": [], - "label": "removeAll", - "description": [], + "label": "getAll", + "description": [ + "\nGet all settings values" + ], "signature": [ - "() => void" + "() => Promise>" ], - "path": "src/plugins/data_views/common/fields/field_list.ts", + "path": "src/plugins/data_views/common/types.ts", "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "data", - "id": "def-common.IIndexPatternFieldList.replaceAll", + "id": "def-common.UiSettingsCommon.set", "type": "Function", "tags": [], - "label": "replaceAll", - "description": [], + "label": "set", + "description": [ + "\nSet a setting value" + ], "signature": [ - "(specs: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - "[]) => void" + "(key: string, value: T) => Promise" ], - "path": "src/plugins/data_views/common/fields/field_list.ts", + "path": "src/plugins/data_views/common/types.ts", "deprecated": false, "children": [ { "parentPluginId": "data", - "id": "def-common.IIndexPatternFieldList.replaceAll.$1", - "type": "Array", + "id": "def-common.UiSettingsCommon.set.$1", + "type": "string", "tags": [], - "label": "specs", - "description": [], + "label": "key", + "description": [ + "name of value" + ], "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - "[]" + "string" ], - "path": "src/plugins/data_views/common/fields/field_list.ts", + "path": "src/plugins/data_views/common/types.ts", "deprecated": false, "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-common.IIndexPatternFieldList.update", - "type": "Function", - "tags": [], - "label": "update", - "description": [], - "signature": [ - "(field: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" }, - ") => void" - ], - "path": "src/plugins/data_views/common/fields/field_list.ts", - "deprecated": false, - "children": [ { "parentPluginId": "data", - "id": "def-common.IIndexPatternFieldList.update.$1", - "type": "Object", + "id": "def-common.UiSettingsCommon.set.$2", + "type": "Uncategorized", "tags": [], - "label": "field", - "description": [], + "label": "value", + "description": [ + "value to set" + ], "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - } + "T" ], - "path": "src/plugins/data_views/common/fields/field_list.ts", + "path": "src/plugins/data_views/common/types.ts", "deprecated": false, "isRequired": true } @@ -29377,875 +30047,644 @@ }, { "parentPluginId": "data", - "id": "def-common.IIndexPatternFieldList.toSpec", + "id": "def-common.UiSettingsCommon.remove", "type": "Function", "tags": [], - "label": "toSpec", - "description": [], + "label": "remove", + "description": [ + "\nRemove a setting value" + ], "signature": [ - "(options?: { getFormatterForField?: ((field: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" - }, - " | ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - " | ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" - }, - ") => ", - { - "pluginId": "fieldFormats", - "scope": "common", - "docId": "kibFieldFormatsPluginApi", - "section": "def-common.FieldFormat", - "text": "FieldFormat" - }, - ") | undefined; } | undefined) => ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewFieldMap", - "text": "DataViewFieldMap" - } + "(key: string) => Promise" ], - "path": "src/plugins/data_views/common/fields/field_list.ts", + "path": "src/plugins/data_views/common/types.ts", "deprecated": false, "children": [ { "parentPluginId": "data", - "id": "def-common.IIndexPatternFieldList.toSpec.$1", - "type": "Object", + "id": "def-common.UiSettingsCommon.remove.$1", + "type": "string", "tags": [], - "label": "options", - "description": [], - "path": "src/plugins/data_views/common/fields/field_list.ts", + "label": "key", + "description": [ + "name of value" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/types.ts", "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.IIndexPatternFieldList.toSpec.$1.getFormatterForField", - "type": "Function", - "tags": [], - "label": "getFormatterForField", - "description": [], - "signature": [ - "((field: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" - }, - " | ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - " | ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" - }, - ") => ", - { - "pluginId": "fieldFormats", - "scope": "common", - "docId": "kibFieldFormatsPluginApi", - "section": "def-common.FieldFormat", - "text": "FieldFormat" - }, - ") | undefined" - ], - "path": "src/plugins/data_views/common/fields/field_list.ts", - "deprecated": false - } - ] + "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false + } + ], + "enums": [ + { + "parentPluginId": "data", + "id": "def-common.DataViewType", + "type": "Enum", + "tags": [], + "label": "DataViewType", + "description": [ + "\nData View type. Default or rollup" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "initialIsOpen": false }, { "parentPluginId": "data", - "id": "def-common.IndexPatternExpressionType", - "type": "Interface", + "id": "def-common.ES_FIELD_TYPES", + "type": "Enum", "tags": [], - "label": "IndexPatternExpressionType", + "label": "ES_FIELD_TYPES", "description": [], - "path": "src/plugins/data_views/common/expressions/load_index_pattern.ts", + "signature": [ + "ES_FIELD_TYPES" + ], + "path": "node_modules/@types/kbn__field-types/index.d.ts", "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.IndexPatternExpressionType.type", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "\"index_pattern\"" - ], - "path": "src/plugins/data_views/common/expressions/load_index_pattern.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.IndexPatternExpressionType.value", - "type": "Object", - "tags": [], - "label": "value", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" - } - ], - "path": "src/plugins/data_views/common/expressions/load_index_pattern.ts", - "deprecated": false - } + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.FilterStateStore", + "type": "Enum", + "tags": [], + "label": "FilterStateStore", + "description": [ + "\r\n Filter,\r\nAn enum to denote whether a filter is specific to an application's context or whether it should be applied globally." + ], + "signature": [ + "FilterStateStore" ], + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", - "id": "def-common.KbnFieldTypeOptions", - "type": "Interface", + "id": "def-common.KBN_FIELD_TYPES", + "type": "Enum", "tags": [], - "label": "KbnFieldTypeOptions", + "label": "KBN_FIELD_TYPES", "description": [], + "signature": [ + "KBN_FIELD_TYPES" + ], "path": "node_modules/@types/kbn__field-types/index.d.ts", "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.KbnFieldTypeOptions.sortable", - "type": "boolean", - "tags": [], - "label": "sortable", - "description": [], - "path": "node_modules/@types/kbn__field-types/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.KbnFieldTypeOptions.filterable", - "type": "boolean", - "tags": [], - "label": "filterable", - "description": [], - "path": "node_modules/@types/kbn__field-types/index.d.ts", - "deprecated": false - }, + "initialIsOpen": false + } + ], + "misc": [ + { + "parentPluginId": "data", + "id": "def-common.AggregationRestrictions", + "type": "Type", + "tags": [], + "label": "AggregationRestrictions", + "description": [], + "signature": [ + "{ [x: string]: { agg?: string | undefined; interval?: number | undefined; fixed_interval?: string | undefined; calendar_interval?: string | undefined; delay?: string | undefined; time_zone?: string | undefined; }; }" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.CSV_FORMULA_CHARS", + "type": "Array", + "tags": [], + "label": "CSV_FORMULA_CHARS", + "description": [], + "signature": [ + "string[]" + ], + "path": "src/plugins/data/common/exports/constants.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.CSV_MIME_TYPE", + "type": "string", + "tags": [], + "label": "CSV_MIME_TYPE", + "description": [], + "signature": [ + "\"text/plain;charset=utf-8\"" + ], + "path": "src/plugins/data/common/exports/export_csv.tsx", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.DATA_VIEW_SAVED_OBJECT_TYPE", + "type": "string", + "tags": [], + "label": "DATA_VIEW_SAVED_OBJECT_TYPE", + "description": [ + "\nData view saved object type." + ], + "signature": [ + "\"index-pattern\"" + ], + "path": "src/plugins/data_views/common/constants.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.DataViewFieldMap", + "type": "Type", + "tags": [], + "label": "DataViewFieldMap", + "description": [], + "signature": [ + "{ [x: string]: ", { - "parentPluginId": "data", - "id": "def-common.KbnFieldTypeOptions.name", - "type": "string", - "tags": [], - "label": "name", - "description": [], - "path": "node_modules/@types/kbn__field-types/index.d.ts", - "deprecated": false + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" }, - { - "parentPluginId": "data", - "id": "def-common.KbnFieldTypeOptions.esTypes", - "type": "Array", - "tags": [], - "label": "esTypes", - "description": [], - "signature": [ - "ES_FIELD_TYPES", - "[]" - ], - "path": "node_modules/@types/kbn__field-types/index.d.ts", - "deprecated": false - } + "; }" ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", - "id": "def-common.RuntimeField", - "type": "Interface", - "tags": [ - "see" - ], - "label": "RuntimeField", + "id": "def-common.DataViewsContract", + "type": "Type", + "tags": [], + "label": "DataViewsContract", "description": [ - "\nThis is the RuntimeField interface enhanced with Data view field\nconfiguration: field format definition, customLabel or popularity.\n" + "\nData views service interface" ], "signature": [ + "{ create: (spec: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewSpec", + "text": "DataViewSpec" + }, + ", skipFetchFields?: boolean) => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + ">; delete: (indexPatternId: string) => Promise<{}>; find: (search: string, size?: number) => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + "[]>; get: (id: string) => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + ">; getCanSave: () => Promise; getIds: (refresh?: boolean) => Promise; getTitles: (refresh?: boolean) => Promise; getIdsWithTitle: (refresh?: boolean) => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewListItem", + "text": "DataViewListItem" + }, + "[]>; clearCache: (id?: string | undefined) => void; getCache: () => Promise<", + "SavedObject", + "<", + "DataViewSavedObjectAttrs", + ">[] | null | undefined>; getDefault: () => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + " | null>; getDefaultId: () => Promise; setDefault: (id: string | null, force?: boolean) => Promise; hasUserDataView: () => Promise; getFieldsForWildcard: (options: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.GetFieldsOptions", + "text": "GetFieldsOptions" + }, + ") => Promise<", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.RuntimeField", - "text": "RuntimeField" - }, - " extends ", - "RuntimeFieldBase", - ",", - "FieldConfiguration" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.RuntimeField.fields", - "type": "Object", - "tags": [], - "label": "fields", - "description": [], - "signature": [ - "Record | undefined" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.SavedObject", - "type": "Interface", - "tags": [], - "label": "SavedObject", - "description": [], - "signature": [ - "SavedObject", - "" - ], - "path": "src/core/types/saved_objects.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.SavedObject.id", - "type": "string", - "tags": [], - "label": "id", - "description": [ - "The ID of this Saved Object, guaranteed to be unique for all objects of the same `type`" - ], - "path": "src/core/types/saved_objects.ts", - "deprecated": false + "section": "def-common.FieldSpec", + "text": "FieldSpec" }, + "[]>; getFieldsForIndexPattern: (indexPattern: ", { - "parentPluginId": "data", - "id": "def-common.SavedObject.type", - "type": "string", - "tags": [], - "label": "type", - "description": [ - " The type of Saved Object. Each plugin can define it's own custom Saved Object types." - ], - "path": "src/core/types/saved_objects.ts", - "deprecated": false + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" }, + " | ", { - "parentPluginId": "data", - "id": "def-common.SavedObject.version", - "type": "string", - "tags": [], - "label": "version", - "description": [ - "An opaque version number which changes on each successful write operation. Can be used for implementing optimistic concurrency control." - ], - "signature": [ - "string | undefined" - ], - "path": "src/core/types/saved_objects.ts", - "deprecated": false + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewSpec", + "text": "DataViewSpec" }, + ", options?: ", { - "parentPluginId": "data", - "id": "def-common.SavedObject.updated_at", - "type": "string", - "tags": [], - "label": "updated_at", - "description": [ - "Timestamp of the last time this document had been updated." - ], - "signature": [ - "string | undefined" - ], - "path": "src/core/types/saved_objects.ts", - "deprecated": false + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.GetFieldsOptions", + "text": "GetFieldsOptions" }, + " | undefined) => Promise<", { - "parentPluginId": "data", - "id": "def-common.SavedObject.error", - "type": "Object", - "tags": [], - "label": "error", - "description": [], - "signature": [ - "SavedObjectError", - " | undefined" - ], - "path": "src/core/types/saved_objects.ts", - "deprecated": false + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" }, + "[]>; refreshFields: (indexPattern: ", { - "parentPluginId": "data", - "id": "def-common.SavedObject.attributes", - "type": "Uncategorized", - "tags": [], - "label": "attributes", - "description": [ - "{@inheritdoc SavedObjectAttributes}" - ], - "signature": [ - "T" - ], - "path": "src/core/types/saved_objects.ts", - "deprecated": false + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" }, + ") => Promise; fieldArrayToMap: (fields: ", { - "parentPluginId": "data", - "id": "def-common.SavedObject.references", - "type": "Array", - "tags": [], - "label": "references", - "description": [ - "{@inheritdoc SavedObjectReference}" - ], - "signature": [ - "SavedObjectReference", - "[]" - ], - "path": "src/core/types/saved_objects.ts", - "deprecated": false + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" }, + "[], fieldAttrs?: ", { - "parentPluginId": "data", - "id": "def-common.SavedObject.migrationVersion", - "type": "Object", - "tags": [], - "label": "migrationVersion", - "description": [ - "{@inheritdoc SavedObjectsMigrationVersion}" - ], - "signature": [ - "SavedObjectsMigrationVersion", - " | undefined" - ], - "path": "src/core/types/saved_objects.ts", - "deprecated": false + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldAttrs", + "text": "FieldAttrs" }, + " | undefined) => ", { - "parentPluginId": "data", - "id": "def-common.SavedObject.coreMigrationVersion", - "type": "string", - "tags": [], - "label": "coreMigrationVersion", - "description": [ - "A semver value that is used when upgrading objects between Kibana versions." - ], - "signature": [ - "string | undefined" - ], - "path": "src/core/types/saved_objects.ts", - "deprecated": false + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewFieldMap", + "text": "DataViewFieldMap" }, + "; savedObjectToSpec: (savedObject: ", + "SavedObject", + "<", { - "parentPluginId": "data", - "id": "def-common.SavedObject.namespaces", - "type": "Array", - "tags": [], - "label": "namespaces", - "description": [ - "\nSpace(s) that this saved object exists in. This attribute is not used for \"global\" saved object types which are registered with\n`namespaceType: 'agnostic'`." - ], - "signature": [ - "string[] | undefined" - ], - "path": "src/core/types/saved_objects.ts", - "deprecated": false + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewAttributes", + "text": "DataViewAttributes" }, + ">) => ", { - "parentPluginId": "data", - "id": "def-common.SavedObject.originId", - "type": "string", - "tags": [], - "label": "originId", - "description": [ - "\nThe ID of the saved object this originated from. This is set if this object's `id` was regenerated; that can happen during migration\nfrom a legacy single-namespace type, or during import. It is only set during migration or create operations. This is used during import\nto ensure that ID regeneration is deterministic, so saved objects will be overwritten if they are imported multiple times into a given\nspace." - ], - "signature": [ - "string | undefined" - ], - "path": "src/core/types/saved_objects.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.SavedObjectsClientCommon", - "type": "Interface", - "tags": [], - "label": "SavedObjectsClientCommon", - "description": [], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "children": [ + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewSpec", + "text": "DataViewSpec" + }, + "; createAndSave: (spec: ", { - "parentPluginId": "data", - "id": "def-common.SavedObjectsClientCommon.find", - "type": "Function", - "tags": [], - "label": "find", - "description": [], - "signature": [ - "(options: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.SavedObjectsClientCommonFindArgs", - "text": "SavedObjectsClientCommonFindArgs" - }, - ") => Promise<", - "SavedObject", - "[]>" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.SavedObjectsClientCommon.find.$1", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.SavedObjectsClientCommonFindArgs", - "text": "SavedObjectsClientCommonFindArgs" - } - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewSpec", + "text": "DataViewSpec" }, + ", override?: boolean, skipFetchFields?: boolean) => Promise<", { - "parentPluginId": "data", - "id": "def-common.SavedObjectsClientCommon.get", - "type": "Function", - "tags": [], - "label": "get", - "description": [], - "signature": [ - "(type: string, id: string) => Promise<", - "SavedObject", - ">" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.SavedObjectsClientCommon.get.$1", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "data", - "id": "def-common.SavedObjectsClientCommon.get.$2", - "type": "string", - "tags": [], - "label": "id", - "description": [], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" }, + ">; createSavedObject: (dataView: ", { - "parentPluginId": "data", - "id": "def-common.SavedObjectsClientCommon.update", - "type": "Function", - "tags": [], - "label": "update", - "description": [], - "signature": [ - "(type: string, id: string, attributes: Record, options: Record) => Promise<", - "SavedObject", - ">" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.SavedObjectsClientCommon.update.$1", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "data", - "id": "def-common.SavedObjectsClientCommon.update.$2", - "type": "string", - "tags": [], - "label": "id", - "description": [], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "data", - "id": "def-common.SavedObjectsClientCommon.update.$3", - "type": "Object", - "tags": [], - "label": "attributes", - "description": [], - "signature": [ - "Record" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "data", - "id": "def-common.SavedObjectsClientCommon.update.$4", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - "Record" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" }, + ", override?: boolean) => Promise<", { - "parentPluginId": "data", - "id": "def-common.SavedObjectsClientCommon.create", - "type": "Function", - "tags": [], - "label": "create", - "description": [], - "signature": [ - "(type: string, attributes: Record, options: Record) => Promise<", - "SavedObject", - ">" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.SavedObjectsClientCommon.create.$1", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "data", - "id": "def-common.SavedObjectsClientCommon.create.$2", - "type": "Object", - "tags": [], - "label": "attributes", - "description": [], - "signature": [ - "Record" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "data", - "id": "def-common.SavedObjectsClientCommon.create.$3", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - "Record" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" }, + ">; updateSavedObject: (indexPattern: ", { - "parentPluginId": "data", - "id": "def-common.SavedObjectsClientCommon.delete", - "type": "Function", - "tags": [], - "label": "delete", - "description": [], - "signature": [ - "(type: string, id: string) => Promise<{}>" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.SavedObjectsClientCommon.delete.$1", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "data", - "id": "def-common.SavedObjectsClientCommon.delete.$2", - "type": "string", - "tags": [], - "label": "id", - "description": [], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - } + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + ", saveAttempts?: number, ignoreErrors?: boolean) => Promise; getDefaultDataView: () => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + " | null>; }" ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", - "id": "def-common.SavedObjectsClientCommonFindArgs", - "type": "Interface", + "id": "def-common.DEFAULT_QUERY_LANGUAGE", + "type": "string", + "tags": [], + "label": "DEFAULT_QUERY_LANGUAGE", + "description": [], + "signature": [ + "\"kuery\"" + ], + "path": "src/plugins/data/common/constants.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.EsQueryConfig", + "type": "Type", + "tags": [ + "deprecated" + ], + "label": "EsQueryConfig", + "description": [], + "signature": [ + "KueryQueryOptions", + " & { allowLeadingWildcards: boolean; queryStringOptions: ", + "SerializableRecord", + "; ignoreFilterIfFieldNotInIndex: boolean; }" + ], + "path": "src/plugins/data/common/es_query/index.ts", + "deprecated": true, + "removeBy": "8.1", + "references": [], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.ExistsFilter", + "type": "Type", + "tags": [ + "deprecated" + ], + "label": "ExistsFilter", + "description": [], + "signature": [ + "Filter", + " & { meta: ", + "FilterMeta", + "; query: { exists?: { field: string; } | undefined; }; }" + ], + "path": "src/plugins/data/common/es_query/index.ts", + "deprecated": true, + "removeBy": "8.1", + "references": [], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.FieldSpecConflictDescriptions", + "type": "Type", "tags": [], - "label": "SavedObjectsClientCommonFindArgs", + "label": "FieldSpecConflictDescriptions", "description": [], + "signature": [ + "{ [x: string]: string[]; }" + ], "path": "src/plugins/data_views/common/types.ts", "deprecated": false, - "children": [ + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.Filter", + "type": "Type", + "tags": [ + "deprecated" + ], + "label": "Filter", + "description": [], + "signature": [ + "{ $state?: { store: ", + "FilterStateStore", + "; } | undefined; meta: ", + "FilterMeta", + "; query?: Record | undefined; }" + ], + "path": "src/plugins/data/common/es_query/index.ts", + "deprecated": true, + "removeBy": "8.1", + "references": [ { - "parentPluginId": "data", - "id": "def-common.SavedObjectsClientCommonFindArgs.type", - "type": "CompoundType", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "string | string[]" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false + "plugin": "discover", + "path": "src/plugins/discover/public/application/view_alert/view_alert_route.tsx" }, { - "parentPluginId": "data", - "id": "def-common.SavedObjectsClientCommonFindArgs.fields", - "type": "Array", - "tags": [], - "label": "fields", - "description": [], - "signature": [ - "string[] | undefined" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false + "plugin": "discover", + "path": "src/plugins/discover/public/application/view_alert/view_alert_route.tsx" }, { - "parentPluginId": "data", - "id": "def-common.SavedObjectsClientCommonFindArgs.perPage", - "type": "number", - "tags": [], - "label": "perPage", - "description": [], - "signature": [ - "number | undefined" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/application/lib/filter_utils.ts" }, { - "parentPluginId": "data", - "id": "def-common.SavedObjectsClientCommonFindArgs.search", - "type": "string", - "tags": [], - "label": "search", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/application/lib/filter_utils.ts" }, { - "parentPluginId": "data", - "id": "def-common.SavedObjectsClientCommonFindArgs.searchFields", - "type": "Array", - "tags": [], - "label": "searchFields", - "description": [], - "signature": [ - "string[] | undefined" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/application/lib/filter_utils.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/application/lib/filter_utils.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/application/lib/filter_utils.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/application/state/dashboard_state_slice.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/application/state/dashboard_state_slice.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/application/state/dashboard_state_slice.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/application/lib/sync_dashboard_filter_state.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/application/lib/sync_dashboard_filter_state.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/application/lib/sync_dashboard_filter_state.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx" + }, + { + "plugin": "lens", + "path": "x-pack/plugins/lens/public/trigger_actions/open_in_discover_drilldown.tsx" + }, + { + "plugin": "lens", + "path": "x-pack/plugins/lens/public/trigger_actions/open_in_discover_drilldown.tsx" + }, + { + "plugin": "urlDrilldown", + "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/variables/context_variables.ts" + }, + { + "plugin": "urlDrilldown", + "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/variables/context_variables.ts" + }, + { + "plugin": "urlDrilldown", + "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/url_drilldown.tsx" + }, + { + "plugin": "urlDrilldown", + "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/url_drilldown.tsx" + }, + { + "plugin": "urlDrilldown", + "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/test/data.ts" + }, + { + "plugin": "urlDrilldown", + "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/test/data.ts" } ], "initialIsOpen": false }, - { - "parentPluginId": "data", - "id": "def-common.SourceFilter", - "type": "Interface", - "tags": [], - "label": "SourceFilter", - "description": [], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.SourceFilter.value", - "type": "string", - "tags": [], - "label": "value", - "description": [], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false - } + { + "parentPluginId": "data", + "id": "def-common.FilterMeta", + "type": "Type", + "tags": [ + "deprecated" + ], + "label": "FilterMeta", + "description": [], + "signature": [ + "{ alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; }" ], + "path": "src/plugins/data/common/es_query/index.ts", + "deprecated": true, + "removeBy": "8.1", + "references": [], "initialIsOpen": false }, { "parentPluginId": "data", - "id": "def-common.TypeMeta", - "type": "Interface", + "id": "def-common.GetConfigFn", + "type": "Type", "tags": [], - "label": "TypeMeta", - "description": [], - "path": "src/plugins/data_views/common/types.ts", + "label": "GetConfigFn", + "description": [ + "\nIf a service is being shared on both the client and the server, and\nthe client code requires synchronous access to uiSettings, both client\nand server should wrap the core uiSettings services in a function\nmatching this signature.\n\nThis matches the signature of the public `core.uiSettings.get`, and\nshould only be used in scenarios where async access to uiSettings is\nnot possible." + ], + "signature": [ + "(key: string, defaultOverride?: T | undefined) => T" + ], + "path": "src/plugins/data/common/types.ts", "deprecated": false, + "returnComment": [], "children": [ { "parentPluginId": "data", - "id": "def-common.TypeMeta.aggs", - "type": "Object", + "id": "def-common.GetConfigFn.$1", + "type": "string", "tags": [], - "label": "aggs", + "label": "key", "description": [], - "signature": [ - "Record | undefined" - ], - "path": "src/plugins/data_views/common/types.ts", + "path": "src/plugins/data/common/types.ts", "deprecated": false }, { "parentPluginId": "data", - "id": "def-common.TypeMeta.params", - "type": "Object", + "id": "def-common.GetConfigFn.$2", + "type": "Uncategorized", "tags": [], - "label": "params", + "label": "defaultOverride", "description": [], "signature": [ - "{ rollup_index: string; } | undefined" + "T | undefined" ], - "path": "src/plugins/data_views/common/types.ts", + "path": "src/plugins/data/common/types.ts", "deprecated": false } ], @@ -30253,673 +30692,676 @@ }, { "parentPluginId": "data", - "id": "def-common.UiSettingsCommon", - "type": "Interface", + "id": "def-common.IndexPatternLoadExpressionFunctionDefinition", + "type": "Type", "tags": [], - "label": "UiSettingsCommon", + "label": "IndexPatternLoadExpressionFunctionDefinition", "description": [], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "children": [ + "signature": [ { - "parentPluginId": "data", - "id": "def-common.UiSettingsCommon.get", - "type": "Function", - "tags": [], - "label": "get", - "description": [], - "signature": [ - "(key: string) => Promise" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.UiSettingsCommon.get.$1", - "type": "string", - "tags": [], - "label": "key", - "description": [], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" }, + "<\"indexPatternLoad\", null, Arguments, Output, ", { - "parentPluginId": "data", - "id": "def-common.UiSettingsCommon.getAll", - "type": "Function", - "tags": [], - "label": "getAll", - "description": [], - "signature": [ - "() => Promise>" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "children": [], - "returnComment": [] + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" }, + "<", { - "parentPluginId": "data", - "id": "def-common.UiSettingsCommon.set", - "type": "Function", - "tags": [], - "label": "set", - "description": [], - "signature": [ - "(key: string, value: any) => Promise" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.UiSettingsCommon.set.$1", - "type": "string", - "tags": [], - "label": "key", - "description": [], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "data", - "id": "def-common.UiSettingsCommon.set.$2", - "type": "Any", - "tags": [], - "label": "value", - "description": [], - "signature": [ - "any" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" }, - { - "parentPluginId": "data", - "id": "def-common.UiSettingsCommon.remove", - "type": "Function", - "tags": [], - "label": "remove", - "description": [], - "signature": [ - "(key: string) => Promise" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.UiSettingsCommon.remove.$1", - "type": "string", - "tags": [], - "label": "key", - "description": [], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - } + ", ", + "SerializableRecord", + ">>" ], + "path": "src/plugins/data_views/common/expressions/load_index_pattern.ts", + "deprecated": false, "initialIsOpen": false - } - ], - "enums": [ + }, { "parentPluginId": "data", - "id": "def-common.DataViewType", - "type": "Enum", + "id": "def-common.KIBANA_USER_QUERY_LANGUAGE_KEY", + "type": "string", "tags": [], - "label": "DataViewType", + "label": "KIBANA_USER_QUERY_LANGUAGE_KEY", "description": [], - "path": "src/plugins/data_views/common/types.ts", + "signature": [ + "\"kibana.userQueryLanguage\"" + ], + "path": "src/plugins/data/common/constants.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", - "id": "def-common.ES_FIELD_TYPES", - "type": "Enum", - "tags": [], - "label": "ES_FIELD_TYPES", + "id": "def-common.KueryNode", + "type": "Type", + "tags": [ + "deprecated" + ], + "label": "KueryNode", "description": [], - "path": "node_modules/@types/kbn__field-types/index.d.ts", - "deprecated": false, + "signature": [ + "KueryNode" + ], + "path": "src/plugins/data/common/es_query/index.ts", + "deprecated": true, + "removeBy": "8.1", + "references": [], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.MatchAllFilter", + "type": "Type", + "tags": [ + "deprecated" + ], + "label": "MatchAllFilter", + "description": [], + "signature": [ + "Filter", + " & { meta: MatchAllFilterMeta; query: { match_all: ", + "QueryDslMatchAllQuery", + "; }; }" + ], + "path": "src/plugins/data/common/es_query/index.ts", + "deprecated": true, + "removeBy": "8.1", + "references": [], "initialIsOpen": false }, { "parentPluginId": "data", - "id": "def-common.FilterStateStore", - "type": "Enum", + "id": "def-common.META_FIELDS", + "type": "string", "tags": [], - "label": "FilterStateStore", + "label": "META_FIELDS", "description": [ - "\r\n Filter,\r\nAn enum to denote whether a filter is specific to an application's context or whether it should be applied globally." + "\nUiSettings key for metaFields list." ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", + "signature": [ + "\"metaFields\"" + ], + "path": "src/plugins/data_views/common/constants.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", - "id": "def-common.KBN_FIELD_TYPES", - "type": "Enum", - "tags": [], - "label": "KBN_FIELD_TYPES", - "description": [], - "path": "node_modules/@types/kbn__field-types/index.d.ts", - "deprecated": false, - "initialIsOpen": false - } - ], - "misc": [ - { - "parentPluginId": "data", - "id": "def-common.AggregationRestrictions", + "id": "def-common.PhraseFilter", "type": "Type", - "tags": [], - "label": "AggregationRestrictions", + "tags": [ + "deprecated" + ], + "label": "PhraseFilter", "description": [], "signature": [ - "{ [x: string]: { agg?: string | undefined; interval?: number | undefined; fixed_interval?: string | undefined; calendar_interval?: string | undefined; delay?: string | undefined; time_zone?: string | undefined; }; }" + "Filter", + " & { meta: PhraseFilterMeta; query: { match_phrase?: Partial> | undefined; match?: Partial> | undefined; }; }" ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, + "path": "src/plugins/data/common/es_query/index.ts", + "deprecated": true, + "removeBy": "8.1", + "references": [], "initialIsOpen": false }, { "parentPluginId": "data", - "id": "def-common.CSV_FORMULA_CHARS", - "type": "Array", + "id": "def-common.Query", + "type": "Type", "tags": [], - "label": "CSV_FORMULA_CHARS", + "label": "Query", "description": [], "signature": [ - "string[]" + "{ query: string | { [key: string]: any; }; language: string; }" ], - "path": "src/plugins/data/common/exports/constants.ts", + "path": "node_modules/@types/kbn__es-query/index.d.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", - "id": "def-common.CSV_MIME_TYPE", - "type": "string", - "tags": [], - "label": "CSV_MIME_TYPE", + "id": "def-common.RangeFilter", + "type": "Type", + "tags": [ + "deprecated" + ], + "label": "RangeFilter", "description": [], "signature": [ - "\"text/plain;charset=utf-8\"" + "Filter", + " & { meta: ", + "RangeFilterMeta", + "; query: { range: { [key: string]: ", + "RangeFilterParams", + "; }; }; }" ], - "path": "src/plugins/data/common/exports/export_csv.tsx", - "deprecated": false, + "path": "src/plugins/data/common/es_query/index.ts", + "deprecated": true, + "removeBy": "8.1", + "references": [], "initialIsOpen": false }, { "parentPluginId": "data", - "id": "def-common.DATA_VIEW_SAVED_OBJECT_TYPE", - "type": "string", - "tags": [], - "label": "DATA_VIEW_SAVED_OBJECT_TYPE", + "id": "def-common.RangeFilterParams", + "type": "Type", + "tags": [ + "deprecated" + ], + "label": "RangeFilterParams", "description": [], "signature": [ - "\"index-pattern\"" + "RangeFilterParams" ], - "path": "src/plugins/data_views/common/constants.ts", - "deprecated": false, + "path": "src/plugins/data/common/es_query/index.ts", + "deprecated": true, + "removeBy": "8.1", + "references": [], "initialIsOpen": false }, { "parentPluginId": "data", - "id": "def-common.DataViewFieldMap", + "id": "def-common.TimeRange", "type": "Type", - "tags": [], - "label": "DataViewFieldMap", - "description": [], + "tags": [ + "deprecated", + "deprecated" + ], + "label": "TimeRange", + "description": [ + "\n" + ], "signature": [ - "{ [x: string]: ", + "{ from: string; to: string; mode?: \"absolute\" | \"relative\" | undefined; }" + ], + "path": "src/plugins/data/common/es_query/index.ts", + "deprecated": true, + "removeBy": "8.1", + "references": [ { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" + "plugin": "infra", + "path": "x-pack/plugins/infra/public/pages/logs/log_entry_rate/use_log_entry_rate_results_url_state.tsx" + }, + { + "plugin": "discover", + "path": "src/plugins/discover/public/locator.ts" + }, + { + "plugin": "discover", + "path": "src/plugins/discover/public/locator.ts" + }, + { + "plugin": "discover", + "path": "src/plugins/discover/public/embeddable/types.ts" + }, + { + "plugin": "discover", + "path": "src/plugins/discover/public/embeddable/types.ts" + }, + { + "plugin": "discover", + "path": "src/plugins/discover/public/embeddable/saved_search_embeddable.tsx" + }, + { + "plugin": "discover", + "path": "src/plugins/discover/public/embeddable/saved_search_embeddable.tsx" + }, + { + "plugin": "discover", + "path": "src/plugins/discover/public/embeddable/search_embeddable_factory.ts" + }, + { + "plugin": "discover", + "path": "src/plugins/discover/public/embeddable/search_embeddable_factory.ts" + }, + { + "plugin": "discover", + "path": "src/plugins/discover/public/application/main/components/layout/types.ts" + }, + { + "plugin": "discover", + "path": "src/plugins/discover/public/application/main/components/layout/types.ts" + }, + { + "plugin": "discover", + "path": "src/plugins/discover/public/application/main/components/top_nav/discover_topnav.tsx" + }, + { + "plugin": "discover", + "path": "src/plugins/discover/public/application/main/components/top_nav/discover_topnav.tsx" + }, + { + "plugin": "visualizations", + "path": "src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx" + }, + { + "plugin": "visualizations", + "path": "src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx" + }, + { + "plugin": "visualizations", + "path": "src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx" + }, + { + "plugin": "visualizations", + "path": "src/plugins/visualizations/public/visualize_app/types.ts" + }, + { + "plugin": "visualizations", + "path": "src/plugins/visualizations/public/visualize_app/types.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/application/lib/filter_utils.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/application/lib/filter_utils.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/application/state/dashboard_state_slice.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/application/state/dashboard_state_slice.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/application/lib/convert_dashboard_state.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/application/lib/convert_dashboard_state.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/types.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/types.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/types.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/application/top_nav/show_share_modal.tsx" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/application/top_nav/show_share_modal.tsx" + }, + { + "plugin": "controls", + "path": "src/plugins/controls/public/services/kibana/options_list.ts" + }, + { + "plugin": "controls", + "path": "src/plugins/controls/public/services/kibana/options_list.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/locator.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/locator.ts" + }, + { + "plugin": "uiActionsEnhanced", + "path": "x-pack/plugins/ui_actions_enhanced/public/customize_time_range_modal.tsx" + }, + { + "plugin": "uiActionsEnhanced", + "path": "x-pack/plugins/ui_actions_enhanced/public/customize_time_range_modal.tsx" + }, + { + "plugin": "uiActionsEnhanced", + "path": "x-pack/plugins/ui_actions_enhanced/public/custom_time_range_action.tsx" + }, + { + "plugin": "uiActionsEnhanced", + "path": "x-pack/plugins/ui_actions_enhanced/public/custom_time_range_action.tsx" + }, + { + "plugin": "uiActionsEnhanced", + "path": "x-pack/plugins/ui_actions_enhanced/public/custom_time_range_badge.tsx" + }, + { + "plugin": "uiActionsEnhanced", + "path": "x-pack/plugins/ui_actions_enhanced/public/custom_time_range_badge.tsx" + }, + { + "plugin": "lens", + "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx" + }, + { + "plugin": "lens", + "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx" + }, + { + "plugin": "lens", + "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx" + }, + { + "plugin": "lens", + "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx" + }, + { + "plugin": "lens", + "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx" + }, + { + "plugin": "lens", + "path": "x-pack/plugins/lens/public/trigger_actions/open_in_discover_helpers.ts" + }, + { + "plugin": "lens", + "path": "x-pack/plugins/lens/public/trigger_actions/open_in_discover_helpers.ts" + }, + { + "plugin": "lens", + "path": "x-pack/plugins/lens/public/trigger_actions/open_in_discover_drilldown.tsx" }, - "; }" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewsContract", - "type": "Type", - "tags": [], - "label": "DataViewsContract", - "description": [], - "signature": [ - "{ create: (spec: ", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" + "plugin": "lens", + "path": "x-pack/plugins/lens/public/trigger_actions/open_in_discover_drilldown.tsx" }, - ", skipFetchFields?: boolean) => Promise<", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx" }, - ">; delete: (indexPatternId: string) => Promise<{}>; find: (search: string, size?: number) => Promise<", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx" }, - "[]>; get: (id: string) => Promise<", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/reducers/map/types.ts" }, - ">; getCanSave: () => Promise; ensureDefaultDataView: ", - "EnsureDefaultDataView", - "; getIds: (refresh?: boolean) => Promise; getTitles: (refresh?: boolean) => Promise; getIdsWithTitle: (refresh?: boolean) => Promise<", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewListItem", - "text": "DataViewListItem" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/reducers/map/types.ts" }, - "[]>; clearCache: (id?: string | undefined) => void; getCache: () => Promise<", - "SavedObject", - "<", - "IndexPatternSavedObjectAttrs", - ">[] | null | undefined>; getDefault: () => Promise<", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/selectors/map_selectors.ts" }, - " | null>; getDefaultId: () => Promise; setDefault: (id: string | null, force?: boolean) => Promise; hasUserDataView: () => Promise; getFieldsForWildcard: (options: ", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.GetFieldsOptions", - "text": "GetFieldsOptions" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/selectors/map_selectors.ts" }, - ") => Promise<", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/actions/map_actions.ts" }, - "[]>; getFieldsForIndexPattern: (indexPattern: ", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/actions/map_actions.ts" }, - " | ", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/routes/map_page/saved_map/types.ts" }, - ", options?: ", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.GetFieldsOptions", - "text": "GetFieldsOptions" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/routes/map_page/saved_map/types.ts" }, - " | undefined) => Promise<", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/routes/map_page/url_state/global_sync.ts" }, - "[]>; refreshFields: (indexPattern: ", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/routes/map_page/url_state/global_sync.ts" }, - ") => Promise; fieldArrayToMap: (fields: ", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/routes/map_page/map_app/index.ts" }, - "[], fieldAttrs?: ", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldAttrs", - "text": "FieldAttrs" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/routes/map_page/map_app/index.ts" }, - " | undefined) => ", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewFieldMap", - "text": "DataViewFieldMap" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx" }, - "; savedObjectToSpec: (savedObject: ", - "SavedObject", - "<", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewAttributes", - "text": "DataViewAttributes" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx" }, - ">) => ", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/locators.ts" }, - "; createAndSave: (spec: ", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/locators.ts" }, - ", override?: boolean, skipFetchFields?: boolean) => Promise<", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/locators.ts" }, - ">; createSavedObject: (indexPattern: ", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/locators.ts" }, - ", override?: boolean) => Promise<", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" + "plugin": "dataVisualizer", + "path": "x-pack/plugins/data_visualizer/public/application/common/components/results_links/results_links.tsx" }, - ">; updateSavedObject: (indexPattern: ", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" + "plugin": "dataVisualizer", + "path": "x-pack/plugins/data_visualizer/public/application/common/components/results_links/results_links.tsx" }, - ", saveAttempts?: number, ignoreErrors?: boolean) => Promise; getDefaultDataView: () => Promise<", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" + "plugin": "dataVisualizer", + "path": "x-pack/plugins/data_visualizer/public/application/common/components/date_picker_wrapper/date_picker_wrapper.tsx" + }, + { + "plugin": "dataVisualizer", + "path": "x-pack/plugins/data_visualizer/public/application/common/components/date_picker_wrapper/date_picker_wrapper.tsx" }, - " | null>; }" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.DEFAULT_QUERY_LANGUAGE", - "type": "string", - "tags": [], - "label": "DEFAULT_QUERY_LANGUAGE", - "description": [], - "signature": [ - "\"kuery\"" - ], - "path": "src/plugins/data/common/constants.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.EsQueryConfig", - "type": "Type", - "tags": [ - "deprecated" - ], - "label": "EsQueryConfig", - "description": [], - "signature": [ - "KueryQueryOptions", - " & { allowLeadingWildcards: boolean; queryStringOptions: ", - "SerializableRecord", - "; ignoreFilterIfFieldNotInIndex: boolean; }" - ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.ExistsFilter", - "type": "Type", - "tags": [ - "deprecated" - ], - "label": "ExistsFilter", - "description": [], - "signature": [ - "Filter", - " & { meta: ", - "FilterMeta", - "; query: { exists?: { field: string; } | undefined; }; }" - ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.FieldFormatMap", - "type": "Type", - "tags": [], - "label": "FieldFormatMap", - "description": [], - "signature": [ - "{ [x: string]: ", { - "pluginId": "fieldFormats", - "scope": "common", - "docId": "kibFieldFormatsPluginApi", - "section": "def-common.SerializedFieldFormat", - "text": "SerializedFieldFormat" + "plugin": "ml", + "path": "x-pack/plugins/ml/public/application/services/anomaly_timeline_service.ts" }, - "<", { - "pluginId": "fieldFormats", - "scope": "common", - "docId": "kibFieldFormatsPluginApi", - "section": "def-common.FieldFormatParams", - "text": "FieldFormatParams" + "plugin": "ml", + "path": "x-pack/plugins/ml/public/application/services/anomaly_timeline_service.ts" }, - ">; }" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.FieldSpecConflictDescriptions", - "type": "Type", - "tags": [], - "label": "FieldSpecConflictDescriptions", - "description": [], - "signature": [ - "{ [x: string]: string[]; }" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.Filter", - "type": "Type", - "tags": [ - "deprecated" - ], - "label": "Filter", - "description": [], - "signature": [ - "{ $state?: { store: ", - "FilterStateStore", - "; } | undefined; meta: ", - "FilterMeta", - "; query?: Record | undefined; }" - ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [ { - "plugin": "discover", - "path": "src/plugins/discover/public/application/view_alert/view_alert_route.tsx" + "plugin": "ml", + "path": "x-pack/plugins/ml/public/application/services/anomaly_timeline_service.ts" }, { - "plugin": "discover", - "path": "src/plugins/discover/public/application/view_alert/view_alert_route.tsx" + "plugin": "ml", + "path": "x-pack/plugins/ml/public/application/services/anomaly_explorer_charts_service.ts" }, { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/lib/filter_utils.ts" + "plugin": "ml", + "path": "x-pack/plugins/ml/public/application/services/anomaly_explorer_charts_service.ts" }, { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/lib/filter_utils.ts" + "plugin": "ml", + "path": "x-pack/plugins/ml/public/application/services/anomaly_explorer_charts_service.ts" }, { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/lib/filter_utils.ts" + "plugin": "ml", + "path": "x-pack/plugins/ml/public/application/components/navigation_menu/date_picker_wrapper/date_picker_wrapper.tsx" }, { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/lib/filter_utils.ts" + "plugin": "ml", + "path": "x-pack/plugins/ml/public/application/components/navigation_menu/date_picker_wrapper/date_picker_wrapper.tsx" }, { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/lib/filter_utils.ts" + "plugin": "infra", + "path": "x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx" }, { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts" + "plugin": "infra", + "path": "x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx" }, { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts" + "plugin": "infra", + "path": "x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx" }, { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/state/dashboard_state_slice.ts" + "plugin": "infra", + "path": "x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx" }, { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/state/dashboard_state_slice.ts" + "plugin": "infra", + "path": "x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx" }, { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/state/dashboard_state_slice.ts" + "plugin": "infra", + "path": "x-pack/plugins/infra/public/components/log_stream/log_stream_embeddable.tsx" }, { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/lib/sync_dashboard_filter_state.ts" + "plugin": "infra", + "path": "x-pack/plugins/infra/public/components/log_stream/log_stream_embeddable.tsx" }, { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/lib/sync_dashboard_filter_state.ts" + "plugin": "infra", + "path": "x-pack/plugins/infra/public/pages/logs/log_entry_rate/use_log_entry_rate_results_url_state.tsx" }, { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/lib/sync_dashboard_filter_state.ts" + "plugin": "infra", + "path": "x-pack/plugins/infra/public/pages/logs/log_entry_rate/use_log_entry_rate_results_url_state.tsx" }, { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx" + "plugin": "fleet", + "path": "x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/agent_logs.tsx" }, { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx" + "plugin": "fleet", + "path": "x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/agent_logs.tsx" }, { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/trigger_actions/open_in_discover_drilldown.tsx" + "plugin": "fleet", + "path": "x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/agent_logs.tsx" }, { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/trigger_actions/open_in_discover_drilldown.tsx" + "plugin": "canvas", + "path": "x-pack/plugins/canvas/types/embeddables.ts" + }, + { + "plugin": "canvas", + "path": "x-pack/plugins/canvas/types/embeddables.ts" + }, + { + "plugin": "dashboardEnhanced", + "path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/embeddable_to_dashboard_drilldown/embeddable_to_dashboard_drilldown.tsx" + }, + { + "plugin": "dashboardEnhanced", + "path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/embeddable_to_dashboard_drilldown/embeddable_to_dashboard_drilldown.tsx" + }, + { + "plugin": "discoverEnhanced", + "path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts" + }, + { + "plugin": "discoverEnhanced", + "path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts" + }, + { + "plugin": "monitoring", + "path": "x-pack/plugins/monitoring/public/url_state.ts" + }, + { + "plugin": "monitoring", + "path": "x-pack/plugins/monitoring/public/url_state.ts" + }, + { + "plugin": "monitoring", + "path": "x-pack/plugins/monitoring/public/application/contexts/global_state_context.tsx" + }, + { + "plugin": "monitoring", + "path": "x-pack/plugins/monitoring/public/application/contexts/global_state_context.tsx" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/public/common/components/query_bar/index.tsx" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/public/common/components/query_bar/index.tsx" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/public/common/components/query_bar/index.tsx" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/public/common/components/search_bar/index.tsx" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/public/common/components/search_bar/index.tsx" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/public/common/components/search_bar/index.tsx" + }, + { + "plugin": "uiActionsEnhanced", + "path": "x-pack/plugins/ui_actions_enhanced/public/can_inherit_time_range.ts" + }, + { + "plugin": "uiActionsEnhanced", + "path": "x-pack/plugins/ui_actions_enhanced/public/can_inherit_time_range.ts" + }, + { + "plugin": "uiActionsEnhanced", + "path": "x-pack/plugins/ui_actions_enhanced/public/test_helpers/time_range_embeddable.ts" + }, + { + "plugin": "uiActionsEnhanced", + "path": "x-pack/plugins/ui_actions_enhanced/public/test_helpers/time_range_embeddable.ts" + }, + { + "plugin": "uiActionsEnhanced", + "path": "x-pack/plugins/ui_actions_enhanced/public/test_helpers/time_range_container.ts" + }, + { + "plugin": "uiActionsEnhanced", + "path": "x-pack/plugins/ui_actions_enhanced/public/test_helpers/time_range_container.ts" + }, + { + "plugin": "uiActionsEnhanced", + "path": "x-pack/plugins/ui_actions_enhanced/public/test_helpers/time_range_container.ts" }, { "plugin": "urlDrilldown", @@ -30937,6 +31379,14 @@ "plugin": "urlDrilldown", "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/url_drilldown.tsx" }, + { + "plugin": "uiActionsEnhanced", + "path": "x-pack/plugins/ui_actions_enhanced/public/test_helpers/time_range_embeddable_factory.ts" + }, + { + "plugin": "uiActionsEnhanced", + "path": "x-pack/plugins/ui_actions_enhanced/public/test_helpers/time_range_embeddable_factory.ts" + }, { "plugin": "urlDrilldown", "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/test/data.ts" @@ -30944,669 +31394,318 @@ { "plugin": "urlDrilldown", "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/test/data.ts" - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.FilterMeta", - "type": "Type", - "tags": [ - "deprecated" - ], - "label": "FilterMeta", - "description": [], - "signature": [ - "{ alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; }" - ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.GetConfigFn", - "type": "Type", - "tags": [], - "label": "GetConfigFn", - "description": [ - "\nIf a service is being shared on both the client and the server, and\nthe client code requires synchronous access to uiSettings, both client\nand server should wrap the core uiSettings services in a function\nmatching this signature.\n\nThis matches the signature of the public `core.uiSettings.get`, and\nshould only be used in scenarios where async access to uiSettings is\nnot possible." - ], - "signature": [ - "(key: string, defaultOverride?: T | undefined) => T" - ], - "path": "src/plugins/data/common/types.ts", - "deprecated": false, - "returnComment": [], - "children": [ + }, { - "parentPluginId": "data", - "id": "def-common.GetConfigFn.$1", - "type": "string", - "tags": [], - "label": "key", - "description": [], - "path": "src/plugins/data/common/types.ts", - "deprecated": false + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/components/agg.tsx" }, { - "parentPluginId": "data", - "id": "def-common.GetConfigFn.$2", - "type": "Uncategorized", - "tags": [], - "label": "defaultOverride", - "description": [], - "signature": [ - "T | undefined" - ], - "path": "src/plugins/data/common/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.IndexPatternAttributes", - "type": "Type", - "tags": [ - "deprecated" - ], - "label": "IndexPatternAttributes", - "description": [], - "signature": [ + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/components/agg.tsx" + }, + { + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/components/agg_group.tsx" + }, + { + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/components/agg_group.tsx" + }, + { + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/components/sidebar/data_tab.tsx" + }, + { + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/components/sidebar/data_tab.tsx" + }, + { + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/components/sidebar/sidebar.tsx" + }, + { + "plugin": "visDefaultEditor", + "path": "src/plugins/vis_default_editor/public/components/sidebar/sidebar.tsx" + }, + { + "plugin": "visTypeTimelion", + "path": "src/plugins/vis_types/timelion/public/timelion_vis_fn.ts" + }, + { + "plugin": "visTypeTimelion", + "path": "src/plugins/vis_types/timelion/public/timelion_vis_fn.ts" + }, + { + "plugin": "visTypeTimelion", + "path": "src/plugins/vis_types/timelion/public/helpers/timelion_request_handler.ts" + }, + { + "plugin": "visTypeTimelion", + "path": "src/plugins/vis_types/timelion/public/helpers/timelion_request_handler.ts" + }, + { + "plugin": "visTypeTimeseries", + "path": "src/plugins/vis_types/timeseries/public/application/components/vis_editor.tsx" + }, + { + "plugin": "visTypeTimeseries", + "path": "src/plugins/vis_types/timeseries/public/application/components/vis_editor.tsx" + }, + { + "plugin": "visTypeVega", + "path": "src/plugins/vis_types/vega/public/vega_fn.ts" + }, + { + "plugin": "visTypeVega", + "path": "src/plugins/vis_types/vega/public/vega_fn.ts" + }, + { + "plugin": "visTypeVega", + "path": "src/plugins/vis_types/vega/public/vega_request_handler.ts" + }, + { + "plugin": "visTypeVega", + "path": "src/plugins/vis_types/vega/public/vega_request_handler.ts" + }, + { + "plugin": "infra", + "path": "x-pack/plugins/infra/public/pages/logs/log_entry_rate/use_log_entry_rate_results_url_state.tsx" + }, + { + "plugin": "visualizations", + "path": "src/plugins/visualizations/common/locator.ts" + }, + { + "plugin": "visualizations", + "path": "src/plugins/visualizations/common/locator.ts" + }, + { + "plugin": "controls", + "path": "src/plugins/controls/common/types.ts" + }, + { + "plugin": "controls", + "path": "src/plugins/controls/common/types.ts" + }, + { + "plugin": "controls", + "path": "src/plugins/controls/common/control_types/options_list/types.ts" + }, + { + "plugin": "controls", + "path": "src/plugins/controls/common/control_types/options_list/types.ts" + }, { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewAttributes", - "text": "DataViewAttributes" - } - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": true, - "references": [ + "plugin": "cases", + "path": "x-pack/plugins/cases/common/utils/markdown_plugins/lens/serializer.ts" + }, { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/index.ts" + "plugin": "cases", + "path": "x-pack/plugins/cases/common/utils/markdown_plugins/lens/serializer.ts" }, { - "plugin": "canvas", - "path": "x-pack/plugins/canvas/public/lib/es_service.ts" + "plugin": "cases", + "path": "x-pack/plugins/cases/common/utils/markdown_plugins/utils.ts" }, { - "plugin": "canvas", - "path": "x-pack/plugins/canvas/public/lib/es_service.ts" + "plugin": "cases", + "path": "x-pack/plugins/cases/common/utils/markdown_plugins/utils.ts" }, { - "plugin": "canvas", - "path": "x-pack/plugins/canvas/public/lib/es_service.ts" - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.IndexPatternLoadExpressionFunctionDefinition", - "type": "Type", - "tags": [], - "label": "IndexPatternLoadExpressionFunctionDefinition", - "description": [], - "signature": [ + "plugin": "maps", + "path": "x-pack/plugins/maps/common/descriptor_types/data_request_descriptor_types.ts" + }, { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" + "plugin": "maps", + "path": "x-pack/plugins/maps/common/descriptor_types/data_request_descriptor_types.ts" }, - "<\"indexPatternLoad\", null, Arguments, Output, ", { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutionContext", - "text": "ExecutionContext" + "plugin": "maps", + "path": "x-pack/plugins/maps/common/descriptor_types/data_request_descriptor_types.ts" }, - "<", { - "pluginId": "inspector", - "scope": "common", - "docId": "kibInspectorPluginApi", - "section": "def-common.Adapters", - "text": "Adapters" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/sources/es_source/es_source.ts" }, - ", ", - "SerializableRecord", - ">>" - ], - "path": "src/plugins/data_views/common/expressions/load_index_pattern.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.IndexPatternsContract", - "type": "Type", - "tags": [ - "deprecated" - ], - "label": "IndexPatternsContract", - "description": [], - "signature": [ - "{ create: (spec: ", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/sources/es_source/es_source.ts" }, - ", skipFetchFields?: boolean) => Promise<", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/sources/es_source/es_source.ts" }, - ">; delete: (indexPatternId: string) => Promise<{}>; find: (search: string, size?: number) => Promise<", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx" }, - "[]>; get: (id: string) => Promise<", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx" }, - ">; getCanSave: () => Promise; ensureDefaultDataView: ", - "EnsureDefaultDataView", - "; getIds: (refresh?: boolean) => Promise; getTitles: (refresh?: boolean) => Promise; getIdsWithTitle: (refresh?: boolean) => Promise<", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewListItem", - "text": "DataViewListItem" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/legacy_visualizations/region_map/region_map_fn.ts" }, - "[]>; clearCache: (id?: string | undefined) => void; getCache: () => Promise<", - "SavedObject", - "<", - "IndexPatternSavedObjectAttrs", - ">[] | null | undefined>; getDefault: () => Promise<", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/legacy_visualizations/region_map/region_map_fn.ts" }, - " | null>; getDefaultId: () => Promise; setDefault: (id: string | null, force?: boolean) => Promise; hasUserDataView: () => Promise; getFieldsForWildcard: (options: ", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.GetFieldsOptions", - "text": "GetFieldsOptions" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/embeddable/types.ts" }, - ") => Promise<", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/embeddable/types.ts" }, - "[]>; getFieldsForIndexPattern: (indexPattern: ", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/connected_components/timeslider/timeslider.tsx" }, - " | ", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/connected_components/timeslider/timeslider.tsx" }, - ", options?: ", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.GetFieldsOptions", - "text": "GetFieldsOptions" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/routes/map_page/map_app/map_app.tsx" }, - " | undefined) => Promise<", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/routes/map_page/map_app/map_app.tsx" }, - "[]>; refreshFields: (indexPattern: ", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/routes/map_page/map_app/map_app.tsx" }, - ") => Promise; fieldArrayToMap: (fields: ", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/routes/map_page/map_app/map_app.tsx" }, - "[], fieldAttrs?: ", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldAttrs", - "text": "FieldAttrs" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/embeddable/map_component.tsx" }, - " | undefined) => ", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewFieldMap", - "text": "DataViewFieldMap" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/embeddable/map_component.tsx" }, - "; savedObjectToSpec: (savedObject: ", - "SavedObject", - "<", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewAttributes", - "text": "DataViewAttributes" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/legacy_visualizations/region_map/region_map_visualization.tsx" }, - ">) => ", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/legacy_visualizations/region_map/region_map_visualization.tsx" }, - "; createAndSave: (spec: ", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/legacy_visualizations/tile_map/tile_map_fn.ts" }, - ", override?: boolean, skipFetchFields?: boolean) => Promise<", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/legacy_visualizations/tile_map/tile_map_fn.ts" }, - ">; createSavedObject: (indexPattern: ", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/legacy_visualizations/tile_map/tile_map_visualization.tsx" }, - ", override?: boolean) => Promise<", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" + "plugin": "maps", + "path": "x-pack/plugins/maps/public/legacy_visualizations/tile_map/tile_map_visualization.tsx" }, - ">; updateSavedObject: (indexPattern: ", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" + "plugin": "dataVisualizer", + "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/search_panel/search_panel.tsx" }, - ", saveAttempts?: number, ignoreErrors?: boolean) => Promise; getDefaultDataView: () => Promise<", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" + "plugin": "dataVisualizer", + "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/search_panel/search_panel.tsx" + }, + { + "plugin": "dataVisualizer", + "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/locator/locator.ts" + }, + { + "plugin": "dataVisualizer", + "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/locator/locator.ts" + }, + { + "plugin": "ml", + "path": "x-pack/plugins/ml/common/util/date_utils.ts" + }, + { + "plugin": "ml", + "path": "x-pack/plugins/ml/common/util/date_utils.ts" + }, + { + "plugin": "ml", + "path": "x-pack/plugins/ml/common/util/date_utils.ts" + }, + { + "plugin": "ml", + "path": "x-pack/plugins/ml/public/embeddables/types.ts" + }, + { + "plugin": "ml", + "path": "x-pack/plugins/ml/public/embeddables/types.ts" + }, + { + "plugin": "ml", + "path": "x-pack/plugins/ml/public/embeddables/types.ts" + }, + { + "plugin": "canvas", + "path": "x-pack/plugins/canvas/common/lib/build_embeddable_filters.ts" }, - " | null>; }" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": true, - "references": [ { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/index.ts" + "plugin": "canvas", + "path": "x-pack/plugins/canvas/common/lib/build_embeddable_filters.ts" }, { - "plugin": "dataViews", - "path": "src/plugins/data_views/public/index.ts" + "plugin": "canvas", + "path": "x-pack/plugins/canvas/common/lib/build_embeddable_filters.ts" }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/lazy_load_bundle/index.ts" + "plugin": "canvas", + "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/external/saved_lens.ts" }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/lazy_load_bundle/index.ts" - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.KIBANA_USER_QUERY_LANGUAGE_KEY", - "type": "string", - "tags": [], - "label": "KIBANA_USER_QUERY_LANGUAGE_KEY", - "description": [], - "signature": [ - "\"kibana.userQueryLanguage\"" - ], - "path": "src/plugins/data/common/constants.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.KueryNode", - "type": "Type", - "tags": [ - "deprecated" - ], - "label": "KueryNode", - "description": [], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.MatchAllFilter", - "type": "Type", - "tags": [ - "deprecated" - ], - "label": "MatchAllFilter", - "description": [], - "signature": [ - "Filter", - " & { meta: MatchAllFilterMeta; query: { match_all: ", - "QueryDslMatchAllQuery", - "; }; }" - ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.META_FIELDS", - "type": "string", - "tags": [], - "label": "META_FIELDS", - "description": [], - "signature": [ - "\"metaFields\"" - ], - "path": "src/plugins/data_views/common/constants.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.OnError", - "type": "Type", - "tags": [], - "label": "OnError", - "description": [], - "signature": [ - "(error: Error, toastInputFields: ", + "plugin": "canvas", + "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/external/saved_lens.ts" + }, { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ErrorToastOptions", - "text": "ErrorToastOptions" + "plugin": "canvas", + "path": "x-pack/plugins/canvas/public/functions/timelion.ts" }, - ", key: string) => void" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "returnComment": [], - "children": [ { - "parentPluginId": "data", - "id": "def-common.OnError.$1", - "type": "Object", - "tags": [], - "label": "error", - "description": [], - "signature": [ - "Error" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false + "plugin": "canvas", + "path": "x-pack/plugins/canvas/public/functions/timelion.ts" }, { - "parentPluginId": "data", - "id": "def-common.OnError.$2", - "type": "Object", - "tags": [], - "label": "toastInputFields", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ErrorToastOptions", - "text": "ErrorToastOptions" - } - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false + "plugin": "lens", + "path": "x-pack/plugins/lens/common/expressions/time_scale/time_scale.test.ts" }, { - "parentPluginId": "data", - "id": "def-common.OnError.$3", - "type": "string", - "tags": [], - "label": "key", - "description": [], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.OnNotification", - "type": "Type", - "tags": [], - "label": "OnNotification", - "description": [], - "signature": [ - "(toastInputFields: ", + "plugin": "lens", + "path": "x-pack/plugins/lens/common/expressions/time_scale/time_scale.test.ts" + }, { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ToastInputFields", - "text": "ToastInputFields" + "plugin": "visTypeVega", + "path": "src/plugins/vis_types/vega/public/data_model/time_cache.ts" }, - ", key: string) => void" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "returnComment": [], - "children": [ { - "parentPluginId": "data", - "id": "def-common.OnNotification.$1", - "type": "CompoundType", - "tags": [], - "label": "toastInputFields", - "description": [], - "signature": [ - "Pick<", - "Toast", - ", \"children\" | \"color\" | \"className\" | \"onChange\" | \"onKeyDown\" | \"onClick\" | \"security\" | \"defaultValue\" | \"hidden\" | \"defaultChecked\" | \"suppressContentEditableWarning\" | \"suppressHydrationWarning\" | \"accessKey\" | \"contentEditable\" | \"contextMenu\" | \"dir\" | \"draggable\" | \"lang\" | \"placeholder\" | \"slot\" | \"spellCheck\" | \"style\" | \"tabIndex\" | \"translate\" | \"radioGroup\" | \"role\" | \"about\" | \"datatype\" | \"inlist\" | \"prefix\" | \"property\" | \"resource\" | \"typeof\" | \"vocab\" | \"autoCapitalize\" | \"autoCorrect\" | \"autoSave\" | \"itemProp\" | \"itemScope\" | \"itemType\" | \"itemID\" | \"itemRef\" | \"results\" | \"unselectable\" | \"inputMode\" | \"is\" | \"aria-activedescendant\" | \"aria-atomic\" | \"aria-autocomplete\" | \"aria-busy\" | \"aria-checked\" | \"aria-colcount\" | \"aria-colindex\" | \"aria-colspan\" | \"aria-controls\" | \"aria-current\" | \"aria-describedby\" | \"aria-details\" | \"aria-disabled\" | \"aria-dropeffect\" | \"aria-errormessage\" | \"aria-expanded\" | \"aria-flowto\" | \"aria-grabbed\" | \"aria-haspopup\" | \"aria-hidden\" | \"aria-invalid\" | \"aria-keyshortcuts\" | \"aria-label\" | \"aria-labelledby\" | \"aria-level\" | \"aria-live\" | \"aria-modal\" | \"aria-multiline\" | \"aria-multiselectable\" | \"aria-orientation\" | \"aria-owns\" | \"aria-placeholder\" | \"aria-posinset\" | \"aria-pressed\" | \"aria-readonly\" | \"aria-relevant\" | \"aria-required\" | \"aria-roledescription\" | \"aria-rowcount\" | \"aria-rowindex\" | \"aria-rowspan\" | \"aria-selected\" | \"aria-setsize\" | \"aria-sort\" | \"aria-valuemax\" | \"aria-valuemin\" | \"aria-valuenow\" | \"aria-valuetext\" | \"dangerouslySetInnerHTML\" | \"onCopy\" | \"onCopyCapture\" | \"onCut\" | \"onCutCapture\" | \"onPaste\" | \"onPasteCapture\" | \"onCompositionEnd\" | \"onCompositionEndCapture\" | \"onCompositionStart\" | \"onCompositionStartCapture\" | \"onCompositionUpdate\" | \"onCompositionUpdateCapture\" | \"onFocus\" | \"onFocusCapture\" | \"onBlur\" | \"onBlurCapture\" | \"onChangeCapture\" | \"onBeforeInput\" | \"onBeforeInputCapture\" | \"onInput\" | \"onInputCapture\" | \"onReset\" | \"onResetCapture\" | \"onSubmit\" | \"onSubmitCapture\" | \"onInvalid\" | \"onInvalidCapture\" | \"onLoad\" | \"onLoadCapture\" | \"onError\" | \"onErrorCapture\" | \"onKeyDownCapture\" | \"onKeyPress\" | \"onKeyPressCapture\" | \"onKeyUp\" | \"onKeyUpCapture\" | \"onAbort\" | \"onAbortCapture\" | \"onCanPlay\" | \"onCanPlayCapture\" | \"onCanPlayThrough\" | \"onCanPlayThroughCapture\" | \"onDurationChange\" | \"onDurationChangeCapture\" | \"onEmptied\" | \"onEmptiedCapture\" | \"onEncrypted\" | \"onEncryptedCapture\" | \"onEnded\" | \"onEndedCapture\" | \"onLoadedData\" | \"onLoadedDataCapture\" | \"onLoadedMetadata\" | \"onLoadedMetadataCapture\" | \"onLoadStart\" | \"onLoadStartCapture\" | \"onPause\" | \"onPauseCapture\" | \"onPlay\" | \"onPlayCapture\" | \"onPlaying\" | \"onPlayingCapture\" | \"onProgress\" | \"onProgressCapture\" | \"onRateChange\" | \"onRateChangeCapture\" | \"onSeeked\" | \"onSeekedCapture\" | \"onSeeking\" | \"onSeekingCapture\" | \"onStalled\" | \"onStalledCapture\" | \"onSuspend\" | \"onSuspendCapture\" | \"onTimeUpdate\" | \"onTimeUpdateCapture\" | \"onVolumeChange\" | \"onVolumeChangeCapture\" | \"onWaiting\" | \"onWaitingCapture\" | \"onAuxClick\" | \"onAuxClickCapture\" | \"onClickCapture\" | \"onContextMenu\" | \"onContextMenuCapture\" | \"onDoubleClick\" | \"onDoubleClickCapture\" | \"onDrag\" | \"onDragCapture\" | \"onDragEnd\" | \"onDragEndCapture\" | \"onDragEnter\" | \"onDragEnterCapture\" | \"onDragExit\" | \"onDragExitCapture\" | \"onDragLeave\" | \"onDragLeaveCapture\" | \"onDragOver\" | \"onDragOverCapture\" | \"onDragStart\" | \"onDragStartCapture\" | \"onDrop\" | \"onDropCapture\" | \"onMouseDown\" | \"onMouseDownCapture\" | \"onMouseEnter\" | \"onMouseLeave\" | \"onMouseMove\" | \"onMouseMoveCapture\" | \"onMouseOut\" | \"onMouseOutCapture\" | \"onMouseOver\" | \"onMouseOverCapture\" | \"onMouseUp\" | \"onMouseUpCapture\" | \"onSelect\" | \"onSelectCapture\" | \"onTouchCancel\" | \"onTouchCancelCapture\" | \"onTouchEnd\" | \"onTouchEndCapture\" | \"onTouchMove\" | \"onTouchMoveCapture\" | \"onTouchStart\" | \"onTouchStartCapture\" | \"onPointerDown\" | \"onPointerDownCapture\" | \"onPointerMove\" | \"onPointerMoveCapture\" | \"onPointerUp\" | \"onPointerUpCapture\" | \"onPointerCancel\" | \"onPointerCancelCapture\" | \"onPointerEnter\" | \"onPointerEnterCapture\" | \"onPointerLeave\" | \"onPointerLeaveCapture\" | \"onPointerOver\" | \"onPointerOverCapture\" | \"onPointerOut\" | \"onPointerOutCapture\" | \"onGotPointerCapture\" | \"onGotPointerCaptureCapture\" | \"onLostPointerCapture\" | \"onLostPointerCaptureCapture\" | \"onScroll\" | \"onScrollCapture\" | \"onWheel\" | \"onWheelCapture\" | \"onAnimationStart\" | \"onAnimationStartCapture\" | \"onAnimationEnd\" | \"onAnimationEndCapture\" | \"onAnimationIteration\" | \"onAnimationIterationCapture\" | \"onTransitionEnd\" | \"onTransitionEndCapture\" | \"toastLifeTimeMs\" | \"iconType\" | \"onClose\" | \"data-test-subj\"> & { title?: string | ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.MountPoint", - "text": "MountPoint" - }, - " | undefined; text?: string | ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.MountPoint", - "text": "MountPoint" - }, - " | undefined; }" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false + "plugin": "visTypeVega", + "path": "src/plugins/vis_types/vega/public/data_model/time_cache.ts" }, { - "parentPluginId": "data", - "id": "def-common.OnNotification.$2", - "type": "string", - "tags": [], - "label": "key", - "description": [], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false + "plugin": "visTypeVega", + "path": "src/plugins/vis_types/vega/public/data_model/time_cache.ts" } ], "initialIsOpen": false }, - { - "parentPluginId": "data", - "id": "def-common.PhraseFilter", - "type": "Type", - "tags": [ - "deprecated" - ], - "label": "PhraseFilter", - "description": [], - "signature": [ - "Filter", - " & { meta: PhraseFilterMeta; query: { match_phrase?: Partial> | undefined; match?: Partial> | undefined; }; }" - ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.Query", - "type": "Type", - "tags": [], - "label": "Query", - "description": [], - "signature": [ - "{ query: string | { [key: string]: any; }; language: string; }" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.RangeFilter", - "type": "Type", - "tags": [ - "deprecated" - ], - "label": "RangeFilter", - "description": [], - "signature": [ - "Filter", - " & { meta: ", - "RangeFilterMeta", - "; query: { range: { [key: string]: ", - "RangeFilterParams", - "; }; }; }" - ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.RangeFilterParams", - "type": "Type", - "tags": [ - "deprecated" - ], - "label": "RangeFilterParams", - "description": [], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.RuntimeType", - "type": "Type", - "tags": [], - "label": "RuntimeType", - "description": [], - "signature": [ - "\"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"long\" | \"double\" | \"composite\"" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "initialIsOpen": false - }, { "parentPluginId": "data", "id": "def-common.ValueSuggestionsMethod", @@ -31789,7 +31888,9 @@ "type": "Object", "tags": [], "label": "RUNTIME_FIELD_TYPES", - "description": [], + "description": [ + "\nAll runtime field types." + ], "signature": [ "readonly [\"keyword\", \"long\", \"double\", \"date\", \"ip\", \"boolean\", \"geo_point\", \"composite\"]" ], diff --git a/api_docs/data.mdx b/api_docs/data.mdx index 414fd654aa3c2f..c93a3c18dcb25b 100644 --- a/api_docs/data.mdx +++ b/api_docs/data.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/data title: "data" image: https://source.unsplash.com/400x175/?github summary: API docs for the data plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 3489 | 38 | 2874 | 20 | +| 3402 | 35 | 2521 | 20 | ## Client diff --git a/api_docs/data_query.devdocs.json b/api_docs/data_query.devdocs.json index 85cb255d272c4f..69777ea5e80107 100644 --- a/api_docs/data_query.devdocs.json +++ b/api_docs/data_query.devdocs.json @@ -919,13 +919,7 @@ "description": [], "signature": [ "(time: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, + "TimeRange", ") => void" ], "path": "src/plugins/data/public/query/timefilter/time_history.ts", @@ -939,13 +933,7 @@ "label": "time", "description": [], "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - } + "TimeRange" ], "path": "src/plugins/data/public/query/timefilter/time_history.ts", "deprecated": false, @@ -963,13 +951,7 @@ "description": [], "signature": [ "() => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, + "TimeRange", "[]" ], "path": "src/plugins/data/public/query/timefilter/time_history.ts", @@ -988,13 +970,7 @@ "() => ", "Observable", "<", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, + "TimeRange", "[]>" ], "path": "src/plugins/data/public/query/timefilter/time_history.ts", @@ -1280,64 +1256,6 @@ "returnComment": [], "initialIsOpen": false }, - { - "parentPluginId": "data", - "id": "def-public.extractTimeRange", - "type": "Function", - "tags": [], - "label": "extractTimeRange", - "description": [], - "signature": [ - "(filters: ", - "Filter", - "[], timeFieldName: string | undefined) => { restOfFilters: ", - "Filter", - "[]; timeRange?: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, - " | undefined; }" - ], - "path": "src/plugins/data/public/query/timefilter/lib/extract_time_filter.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-public.extractTimeRange.$1", - "type": "Array", - "tags": [], - "label": "filters", - "description": [], - "signature": [ - "Filter", - "[]" - ], - "path": "src/plugins/data/public/query/timefilter/lib/extract_time_filter.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "data", - "id": "def-public.extractTimeRange.$2", - "type": "string", - "tags": [], - "label": "timeFieldName", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/data/public/query/timefilter/lib/extract_time_filter.ts", - "deprecated": false, - "isRequired": false - } - ], - "returnComment": [], - "initialIsOpen": false - }, { "parentPluginId": "data", "id": "def-public.generateFilters", @@ -1357,13 +1275,7 @@ "text": "FilterManager" }, ", field: string | ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" - }, + "DataViewFieldBase", ", values: any, operation: string, index: string) => ", "Filter", "[]" @@ -1404,13 +1316,7 @@ ], "signature": [ "string | ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" - } + "DataViewFieldBase" ], "path": "src/plugins/data/public/query/filter_manager/lib/generate_filters.ts", "deprecated": false, @@ -2490,17 +2396,11 @@ "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" + "section": "def-common.DataView", + "text": "DataView" }, ", timeRange?: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, + "TimeRange", " | undefined) => { bool: ", "BoolQuery", "; }" @@ -2520,8 +2420,8 @@ "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" + "section": "def-common.DataView", + "text": "DataView" } ], "path": "src/plugins/data/public/query/query_service.ts", @@ -2536,13 +2436,7 @@ "label": "timeRange", "description": [], "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, + "TimeRange", " | undefined" ], "path": "src/plugins/data/public/query/query_service.ts", @@ -2956,21 +2850,9 @@ ">; getFetch$: () => ", "Observable", "; getTime: () => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, + "TimeRange", "; getAbsoluteTime: () => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, + "TimeRange", "; setTime: (time: ", "InputTimeRange", ") => void; getRefreshInterval: () => ", @@ -2994,17 +2876,11 @@ "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.IIndexPattern", - "text": "IIndexPattern" + "section": "def-common.DataView", + "text": "DataView" }, ", timeRange?: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, + "TimeRange", " | undefined) => ", "RangeFilter", " | ", @@ -3014,17 +2890,11 @@ "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.IIndexPattern", - "text": "IIndexPattern" + "section": "def-common.DataView", + "text": "DataView" }, ", timeRange?: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, + "TimeRange", " | undefined) => ", "RangeFilter", " | ", @@ -3038,13 +2908,7 @@ "text": "TimeRangeBounds" }, "; calculateBounds: (timeRange: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, + "TimeRange", ") => ", { "pluginId": "data", @@ -3062,13 +2926,7 @@ "text": "TimeRangeBounds" }, " | undefined; enableTimeRangeSelector: () => void; disableTimeRangeSelector: () => void; enableAutoRefreshSelector: () => void; disableAutoRefreshSelector: () => void; getTimeDefaults: () => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, + "TimeRange", "; getRefreshIntervalDefaults: () => ", { "pluginId": "data", @@ -3091,31 +2949,13 @@ "description": [], "signature": [ "{ get: () => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, + "TimeRange", "[]; add: (time: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, + "TimeRange", ") => void; get$: () => ", "Observable", "<", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, + "TimeRange", "[]>; }" ], "path": "src/plugins/data/public/query/timefilter/timefilter_service.ts", @@ -3208,13 +3048,7 @@ "label": "SavedQueryTimeFilter", "description": [], "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, + "TimeRange", " & { refreshInterval: ", { "pluginId": "data", @@ -3256,21 +3090,9 @@ ">; getFetch$: () => ", "Observable", "; getTime: () => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, + "TimeRange", "; getAbsoluteTime: () => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, + "TimeRange", "; setTime: (time: ", "InputTimeRange", ") => void; getRefreshInterval: () => ", @@ -3294,17 +3116,11 @@ "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.IIndexPattern", - "text": "IIndexPattern" + "section": "def-common.DataView", + "text": "DataView" }, ", timeRange?: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, + "TimeRange", " | undefined) => ", "RangeFilter", " | ", @@ -3314,17 +3130,11 @@ "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.IIndexPattern", - "text": "IIndexPattern" + "section": "def-common.DataView", + "text": "DataView" }, ", timeRange?: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, + "TimeRange", " | undefined) => ", "RangeFilter", " | ", @@ -3338,13 +3148,7 @@ "text": "TimeRangeBounds" }, "; calculateBounds: (timeRange: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, + "TimeRange", ") => ", { "pluginId": "data", @@ -3362,13 +3166,7 @@ "text": "TimeRangeBounds" }, " | undefined; enableTimeRangeSelector: () => void; disableTimeRangeSelector: () => void; enableAutoRefreshSelector: () => void; disableAutoRefreshSelector: () => void; getTimeDefaults: () => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, + "TimeRange", "; getRefreshIntervalDefaults: () => ", { "pluginId": "data", @@ -3392,31 +3190,13 @@ "description": [], "signature": [ "{ get: () => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, + "TimeRange", "[]; add: (time: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, + "TimeRange", ") => void; get$: () => ", "Observable", "<", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, + "TimeRange", "[]>; }" ], "path": "src/plugins/data/public/query/timefilter/time_history.ts", @@ -3446,13 +3226,7 @@ "description": [], "signature": [ "(timeRange: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, + "TimeRange", ", options: CalculateBoundsOptions) => ", { "pluginId": "data", @@ -3473,13 +3247,7 @@ "label": "timeRange", "description": [], "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - } + "TimeRange" ], "path": "src/plugins/data/common/query/timefilter/get_time.ts", "deprecated": false, @@ -3512,21 +3280,9 @@ "description": [], "signature": [ "(timeRange: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, + "TimeRange", ", { forceNow }: { forceNow?: Date | undefined; }) => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - } + "TimeRange" ], "path": "src/plugins/data/common/query/timefilter/get_time.ts", "deprecated": false, @@ -3539,13 +3295,7 @@ "label": "timeRange", "description": [], "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - } + "TimeRange" ], "path": "src/plugins/data/common/query/timefilter/get_time.ts", "deprecated": false, @@ -3593,17 +3343,11 @@ "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.IIndexPattern", - "text": "IIndexPattern" + "section": "def-common.DataView", + "text": "DataView" }, " | undefined, timeRange: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, + "TimeRange", ", options: { forceNow?: Date | undefined; fieldName?: string | undefined; } | undefined) => ", "RangeFilter", " | ", @@ -3625,8 +3369,8 @@ "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.IIndexPattern", - "text": "IIndexPattern" + "section": "def-common.DataView", + "text": "DataView" }, " | undefined" ], @@ -3642,13 +3386,7 @@ "label": "timeRange", "description": [], "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - } + "TimeRange" ], "path": "src/plugins/data/common/query/timefilter/get_time.ts", "deprecated": false, @@ -3709,17 +3447,11 @@ "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.IIndexPattern", - "text": "IIndexPattern" + "section": "def-common.DataView", + "text": "DataView" }, " | undefined, timeRange: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, + "TimeRange", ", options: { forceNow?: Date | undefined; fieldName?: string | undefined; } | undefined) => ", "RangeFilter", " | ", @@ -3741,8 +3473,8 @@ "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.IIndexPattern", - "text": "IIndexPattern" + "section": "def-common.DataView", + "text": "DataView" }, " | undefined" ], @@ -3758,13 +3490,7 @@ "label": "timeRange", "description": [], "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - } + "TimeRange" ], "path": "src/plugins/data/common/query/timefilter/get_time.ts", "deprecated": false, @@ -4180,20 +3906,6 @@ "path": "src/plugins/data/common/query/types.ts", "deprecated": false, "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.TimeRange", - "type": "Type", - "tags": [], - "label": "TimeRange", - "description": [], - "signature": [ - "{ from: string; to: string; mode?: \"absolute\" | \"relative\" | undefined; }" - ], - "path": "src/plugins/data/common/query/timefilter/types.ts", - "deprecated": false, - "initialIsOpen": false } ], "objects": [] diff --git a/api_docs/data_query.mdx b/api_docs/data_query.mdx index c69c181b91554b..6cc9a192b7136d 100644 --- a/api_docs/data_query.mdx +++ b/api_docs/data_query.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/data-query title: "data.query" image: https://source.unsplash.com/400x175/?github summary: API docs for the data.query plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.query'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 3489 | 38 | 2874 | 20 | +| 3402 | 35 | 2521 | 20 | ## Client diff --git a/api_docs/data_search.devdocs.json b/api_docs/data_search.devdocs.json index e0f75570603042..c67be44554bf3c 100644 --- a/api_docs/data_search.devdocs.json +++ b/api_docs/data_search.devdocs.json @@ -444,8 +444,8 @@ "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" + "section": "def-common.DataView", + "text": "DataView" }, ", configStates?: ", { @@ -4757,8 +4757,8 @@ "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" + "section": "def-common.DataView", + "text": "DataView" } ], "path": "src/plugins/data/common/search/aggs/agg_config.ts", @@ -4775,13 +4775,7 @@ "description": [], "signature": [ "() => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, + "TimeRange", " | undefined" ], "path": "src/plugins/data/common/search/aggs/agg_config.ts", @@ -4964,25 +4958,6 @@ "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "deprecated": false, "children": [ - { - "parentPluginId": "data", - "id": "def-common.AggConfigs.indexPattern", - "type": "Object", - "tags": [], - "label": "indexPattern", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" - } - ], - "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "deprecated": false - }, { "parentPluginId": "data", "id": "def-common.AggConfigs.timeRange", @@ -4991,13 +4966,7 @@ "label": "timeRange", "description": [], "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, + "TimeRange", " | undefined" ], "path": "src/plugins/data/common/search/aggs/agg_configs.ts", @@ -5029,19 +4998,6 @@ "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "deprecated": false }, - { - "parentPluginId": "data", - "id": "def-common.AggConfigs.hierarchical", - "type": "CompoundType", - "tags": [], - "label": "hierarchical", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "src/plugins/data/common/search/aggs/agg_configs.ts", - "deprecated": false - }, { "parentPluginId": "data", "id": "def-common.AggConfigs.aggs", @@ -5062,6 +5018,42 @@ "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "deprecated": false }, + { + "parentPluginId": "data", + "id": "def-common.AggConfigs.partialRows", + "type": "CompoundType", + "tags": [], + "label": "partialRows", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.AggConfigs.hierarchical", + "type": "CompoundType", + "tags": [], + "label": "hierarchical", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.AggConfigs.timeZone", + "type": "string", + "tags": [], + "label": "timeZone", + "description": [], + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "deprecated": false + }, { "parentPluginId": "data", "id": "def-common.AggConfigs.Unnamed", @@ -5087,8 +5079,8 @@ "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" + "section": "def-common.DataView", + "text": "DataView" } ], "path": "src/plugins/data/common/search/aggs/agg_configs.ts", @@ -5135,6 +5127,26 @@ "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "deprecated": false, "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-common.AggConfigs.Unnamed.$4", + "type": "Function", + "tags": [], + "label": "getConfig", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.GetConfigFn", + "text": "GetConfigFn" + } + ], + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "deprecated": false, + "isRequired": true } ], "returnComment": [] @@ -5208,13 +5220,7 @@ "description": [], "signature": [ "(timeRange: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, + "TimeRange", ") => void" ], "path": "src/plugins/data/common/search/aggs/agg_configs.ts", @@ -5228,13 +5234,7 @@ "label": "timeRange", "description": [], "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - } + "TimeRange" ], "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "deprecated": false, @@ -6029,6 +6029,32 @@ } ], "returnComment": [] + }, + { + "parentPluginId": "data", + "id": "def-common.AggConfigs.toExpressionAst", + "type": "Function", + "tags": [], + "label": "toExpressionAst", + "description": [ + "\nGenerates an expression abstract syntax tree using the `esaggs` expression function." + ], + "signature": [ + "() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } + ], + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "deprecated": false, + "children": [], + "returnComment": [ + "The expression AST." + ] } ], "initialIsOpen": false @@ -6224,7 +6250,7 @@ "label": "start", "description": [], "signature": [ - "({ getConfig }: ", + "({ getConfig, aggExecutionContext }: ", { "pluginId": "data", "scope": "common", @@ -6249,7 +6275,7 @@ "id": "def-common.AggsCommonService.start.$1", "type": "Object", "tags": [], - "label": "{ getConfig }", + "label": "{ getConfig, aggExecutionContext }", "description": [], "signature": [ { @@ -6937,7 +6963,15 @@ }, "; serialize: () => { searchSourceJSON: string; references: ", "SavedObjectReference", - "[]; }; }" + "[]; }; toExpressionAst: ({ asDatatable }?: ExpressionAstOptions) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + "; }" ], "path": "src/plugins/data/common/search/aggs/agg_type.ts", "deprecated": false @@ -9853,11 +9887,11 @@ }, { "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/server/alert_types/es_query/alert_type.test.ts" + "path": "x-pack/plugins/stack_alerts/server/alert_types/es_query/rule_type.test.ts" }, { "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/server/alert_types/es_query/alert_type.test.ts" + "path": "x-pack/plugins/stack_alerts/server/alert_types/es_query/rule_type.test.ts" }, { "plugin": "securitySolution", @@ -10067,6 +10101,47 @@ "deprecated": false, "children": [], "returnComment": [] + }, + { + "parentPluginId": "data", + "id": "def-common.SearchSource.toExpressionAst", + "type": "Function", + "tags": [], + "label": "toExpressionAst", + "description": [ + "\nGenerates an expression abstract syntax tree using the fields set in the current search source and its ancestors.\nThe produced expression from the returned AST will return the `datatable` structure.\nIf the `asDatatable` option is truthy or omitted, the generator will use the `esdsl` function to perform the search.\nWhen the `aggs` field is present, it will use the `esaggs` function instead." + ], + "signature": [ + "({ asDatatable }?: ExpressionAstOptions) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } + ], + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.SearchSource.toExpressionAst.$1", + "type": "Object", + "tags": [], + "label": "{ asDatatable = true }", + "description": [], + "signature": [ + "ExpressionAstOptions" + ], + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [ + "The expression AST." + ] } ], "initialIsOpen": false @@ -10933,6 +11008,22 @@ "returnComment": [], "initialIsOpen": false }, + { + "parentPluginId": "data", + "id": "def-common.aggSinglePercentileRank", + "type": "Function", + "tags": [], + "label": "aggSinglePercentileRank", + "description": [], + "signature": [ + "() => FunctionDefinition" + ], + "path": "src/plugins/data/common/search/aggs/metrics/single_percentile_rank_fn.ts", + "deprecated": false, + "children": [], + "returnComment": [], + "initialIsOpen": false + }, { "parentPluginId": "data", "id": "def-common.aggStdDeviation", @@ -11683,8 +11774,8 @@ "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" + "section": "def-common.DataView", + "text": "DataView" }, " | undefined, params: TabifyDocsOptions | undefined) => Record" ], @@ -11721,8 +11812,8 @@ "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" + "section": "def-common.DataView", + "text": "DataView" }, " | undefined" ], @@ -12222,13 +12313,13 @@ "label": "getDateHistogramBucketAgg", "description": [], "signature": [ - "({ calculateBounds, isDefaultTimezone, getConfig, }: ", + "({ calculateBounds, aggExecutionContext, getConfig, }: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.DateHistogramBucketAggDependencies", - "text": "DateHistogramBucketAggDependencies" + "section": "def-common.AggTypesDependencies", + "text": "AggTypesDependencies" }, ") => ", { @@ -12256,15 +12347,15 @@ "id": "def-common.getDateHistogramBucketAgg.$1", "type": "Object", "tags": [], - "label": "{\n calculateBounds,\n isDefaultTimezone,\n getConfig,\n}", + "label": "{\n calculateBounds,\n aggExecutionContext,\n getConfig,\n}", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.DateHistogramBucketAggDependencies", - "text": "DateHistogramBucketAggDependencies" + "section": "def-common.AggTypesDependencies", + "text": "AggTypesDependencies" } ], "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", @@ -12352,13 +12443,13 @@ "label": "getDateRangeBucketAgg", "description": [], "signature": [ - "({ isDefaultTimezone, getConfig, }: ", + "({ aggExecutionContext, getConfig }: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.DateRangeBucketAggDependencies", - "text": "DateRangeBucketAggDependencies" + "section": "def-common.AggTypesDependencies", + "text": "AggTypesDependencies" }, ") => ", { @@ -12386,15 +12477,15 @@ "id": "def-common.getDateRangeBucketAgg.$1", "type": "Object", "tags": [], - "label": "{\n isDefaultTimezone,\n getConfig,\n}", + "label": "{ aggExecutionContext, getConfig }", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.DateRangeBucketAggDependencies", - "text": "DateRangeBucketAggDependencies" + "section": "def-common.AggTypesDependencies", + "text": "AggTypesDependencies" } ], "path": "src/plugins/data/common/search/aggs/buckets/date_range.ts", @@ -13889,6 +13980,32 @@ "returnComment": [], "initialIsOpen": false }, + { + "parentPluginId": "data", + "id": "def-common.getSinglePercentileRankMetricAgg", + "type": "Function", + "tags": [], + "label": "getSinglePercentileRankMetricAgg", + "description": [], + "signature": [ + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.MetricAggType", + "text": "MetricAggType" + }, + "<", + "IResponseAggConfig", + ">" + ], + "path": "src/plugins/data/common/search/aggs/metrics/single_percentile_rank.ts", + "deprecated": false, + "children": [], + "returnComment": [], + "initialIsOpen": false + }, { "parentPluginId": "data", "id": "def-common.getStdDeviationMetricAgg", @@ -14033,6 +14150,51 @@ "returnComment": [], "initialIsOpen": false }, + { + "parentPluginId": "data", + "id": "def-common.getUserTimeZone", + "type": "Function", + "tags": [], + "label": "getUserTimeZone", + "description": [], + "signature": [ + "(getConfig: (key: string) => T, shouldDetectTimezone?: boolean) => string" + ], + "path": "src/plugins/data/common/search/utils.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.getUserTimeZone.$1", + "type": "Function", + "tags": [], + "label": "getConfig", + "description": [], + "signature": [ + "(key: string) => T" + ], + "path": "src/plugins/data/common/search/utils.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-common.getUserTimeZone.$2", + "type": "boolean", + "tags": [], + "label": "shouldDetectTimezone", + "description": [], + "signature": [ + "boolean" + ], + "path": "src/plugins/data/common/search/utils.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, { "parentPluginId": "data", "id": "def-common.handleRequest", @@ -14041,7 +14203,7 @@ "label": "handleRequest", "description": [], "signature": [ - "({ abortSignal, aggs, filters, indexPattern, inspectorAdapters, partialRows, query, searchSessionId, searchSourceService, timeFields, timeRange, getNow, executionContext, }: RequestHandlerParams) => ", + "({ abortSignal, aggs, filters, indexPattern, inspectorAdapters, query, searchSessionId, searchSourceService, timeFields, timeRange, getNow, executionContext, }: RequestHandlerParams) => ", "Observable", "<", { @@ -14061,7 +14223,7 @@ "id": "def-common.handleRequest.$1", "type": "Object", "tags": [], - "label": "{\n abortSignal,\n aggs,\n filters,\n indexPattern,\n inspectorAdapters,\n partialRows,\n query,\n searchSessionId,\n searchSourceService,\n timeFields,\n timeRange,\n getNow,\n executionContext,\n}", + "label": "{\n abortSignal,\n aggs,\n filters,\n indexPattern,\n inspectorAdapters,\n query,\n searchSessionId,\n searchSourceService,\n timeFields,\n timeRange,\n getNow,\n executionContext,\n}", "description": [], "signature": [ "RequestHandlerParams" @@ -14082,23 +14244,23 @@ "label": "inferTimeZone", "description": [], "signature": [ - "(params: ", + "(params: { field?: string | ", { - "pluginId": "data", + "pluginId": "dataViews", "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggParamsDateHistogram", - "text": "AggParamsDateHistogram" + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewField", + "text": "DataViewField" }, - ", indexPattern: ", + " | undefined; time_zone?: string | undefined; }, dataView: ", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" + "section": "def-common.DataView", + "text": "DataView" }, - ", isDefaultTimezone: () => boolean, getConfig: (key: string) => T) => string" + ", aggName: \"date_histogram\" | \"date_range\", getConfig: (key: string) => T, { shouldDetectTimeZone }: { shouldDetectTimeZone?: boolean | undefined; } | undefined) => string" ], "path": "src/plugins/data/common/search/aggs/utils/infer_time_zone.ts", "deprecated": false, @@ -14110,33 +14272,59 @@ "tags": [], "label": "params", "description": [], - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggParamsDateHistogram", - "text": "AggParamsDateHistogram" - } - ], "path": "src/plugins/data/common/search/aggs/utils/infer_time_zone.ts", "deprecated": false, - "isRequired": true + "children": [ + { + "parentPluginId": "data", + "id": "def-common.inferTimeZone.$1.field", + "type": "CompoundType", + "tags": [], + "label": "field", + "description": [], + "signature": [ + "string | ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewField", + "text": "DataViewField" + }, + " | undefined" + ], + "path": "src/plugins/data/common/search/aggs/utils/infer_time_zone.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.inferTimeZone.$1.time_zone", + "type": "string", + "tags": [], + "label": "time_zone", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data/common/search/aggs/utils/infer_time_zone.ts", + "deprecated": false + } + ] }, { "parentPluginId": "data", "id": "def-common.inferTimeZone.$2", "type": "Object", "tags": [], - "label": "indexPattern", + "label": "dataView", "description": [], "signature": [ { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" + "section": "def-common.DataView", + "text": "DataView" } ], "path": "src/plugins/data/common/search/aggs/utils/infer_time_zone.ts", @@ -14146,12 +14334,12 @@ { "parentPluginId": "data", "id": "def-common.inferTimeZone.$3", - "type": "Function", + "type": "CompoundType", "tags": [], - "label": "isDefaultTimezone", + "label": "aggName", "description": [], "signature": [ - "() => boolean" + "\"date_histogram\" | \"date_range\"" ], "path": "src/plugins/data/common/search/aggs/utils/infer_time_zone.ts", "deprecated": false, @@ -14170,6 +14358,20 @@ "path": "src/plugins/data/common/search/aggs/utils/infer_time_zone.ts", "deprecated": false, "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-common.inferTimeZone.$5", + "type": "Object", + "tags": [], + "label": "{ shouldDetectTimeZone }", + "description": [], + "signature": [ + "{ shouldDetectTimeZone?: boolean | undefined; } | undefined" + ], + "path": "src/plugins/data/common/search/aggs/utils/infer_time_zone.ts", + "deprecated": false, + "isRequired": false } ], "returnComment": [], @@ -15384,8 +15586,8 @@ "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" + "section": "def-common.DataView", + "text": "DataView" }, " | undefined, params?: TabifyDocsOptions) => ", { @@ -15428,8 +15630,8 @@ "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" + "section": "def-common.DataView", + "text": "DataView" }, " | undefined" ], @@ -15584,13 +15786,7 @@ "description": [], "signature": [ "(range: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, + "TimeRange", ") => { from: Date; to: Date; } | undefined" ], "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/to_absolute_dates.ts", @@ -15604,13 +15800,7 @@ "label": "range", "description": [], "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - } + "TimeRange" ], "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/to_absolute_dates.ts", "deprecated": false, @@ -15663,6 +15853,32 @@ ], "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.AggConfigsOptions.aggExecutionContext", + "type": "Object", + "tags": [], + "label": "aggExecutionContext", + "description": [], + "signature": [ + "{ shouldDetectTimeZone?: boolean | undefined; } | undefined" + ], + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.AggConfigsOptions.partialRows", + "type": "CompoundType", + "tags": [], + "label": "partialRows", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "deprecated": false } ], "initialIsOpen": false @@ -17008,6 +17224,52 @@ "path": "src/plugins/data/common/search/aggs/types.ts", "deprecated": false }, + { + "parentPluginId": "data", + "id": "def-common.AggFunctionsMapping.aggSinglePercentileRank", + "type": "Object", + "tags": [], + "label": "aggSinglePercentileRank", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"aggSinglePercentileRank\", any, AggArgs, ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggExpressionType", + "text": "AggExpressionType" + }, + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableRecord", + ">>" + ], + "path": "src/plugins/data/common/search/aggs/types.ts", + "deprecated": false + }, { "parentPluginId": "data", "id": "def-common.AggFunctionsMapping.aggMin", @@ -17985,13 +18247,7 @@ "description": [], "signature": [ "string | ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" - }, + "DataViewFieldBase", " | undefined" ], "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", @@ -18005,13 +18261,7 @@ "label": "timeRange", "description": [], "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, + "TimeRange", " | undefined" ], "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", @@ -20000,6 +20250,56 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "data", + "id": "def-common.AggParamsSinglePercentileRank", + "type": "Interface", + "tags": [], + "label": "AggParamsSinglePercentileRank", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggParamsSinglePercentileRank", + "text": "AggParamsSinglePercentileRank" + }, + " extends ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.BaseAggParams", + "text": "BaseAggParams" + } + ], + "path": "src/plugins/data/common/search/aggs/metrics/single_percentile_rank.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.AggParamsSinglePercentileRank.field", + "type": "string", + "tags": [], + "label": "field", + "description": [], + "path": "src/plugins/data/common/search/aggs/metrics/single_percentile_rank.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.AggParamsSinglePercentileRank.value", + "type": "number", + "tags": [], + "label": "value", + "description": [], + "path": "src/plugins/data/common/search/aggs/metrics/single_percentile_rank.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, { "parentPluginId": "data", "id": "def-common.AggParamsStdDeviation", @@ -20320,7 +20620,7 @@ "label": "aggregate", "description": [], "signature": [ - "\"concat\" | \"sum\" | \"max\" | \"min\" | \"average\"" + "\"concat\" | \"min\" | \"max\" | \"sum\" | \"average\"" ], "path": "src/plugins/data/common/search/aggs/metrics/top_hit.ts", "deprecated": false @@ -20637,8 +20937,8 @@ "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" + "section": "def-common.DataView", + "text": "DataView" }, ", configStates?: ", { @@ -20672,8 +20972,8 @@ "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" + "section": "def-common.DataView", + "text": "DataView" } ], "path": "src/plugins/data/common/search/aggs/types.ts", @@ -20782,8 +21082,8 @@ "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" + "section": "def-common.DataView", + "text": "DataView" }, ">" ], @@ -20809,18 +21109,16 @@ }, { "parentPluginId": "data", - "id": "def-common.AggsCommonStartDependencies.isDefaultTimezone", - "type": "Function", + "id": "def-common.AggsCommonStartDependencies.aggExecutionContext", + "type": "Object", "tags": [], - "label": "isDefaultTimezone", + "label": "aggExecutionContext", "description": [], "signature": [ - "() => boolean" + "{ shouldDetectTimeZone?: boolean | undefined; } | undefined" ], "path": "src/plugins/data/common/search/aggs/aggs_service.ts", - "deprecated": false, - "children": [], - "returnComment": [] + "deprecated": false } ], "initialIsOpen": false @@ -21384,13 +21682,7 @@ "description": [], "signature": [ "(timeRange: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, + "TimeRange", ") => ", { "pluginId": "data", @@ -21474,18 +21766,16 @@ }, { "parentPluginId": "data", - "id": "def-common.AggTypesDependencies.isDefaultTimezone", - "type": "Function", + "id": "def-common.AggTypesDependencies.aggExecutionContext", + "type": "Object", "tags": [], - "label": "isDefaultTimezone", + "label": "aggExecutionContext", "description": [], "signature": [ - "() => boolean" + "{ shouldDetectTimeZone?: boolean | undefined; } | undefined" ], "path": "src/plugins/data/common/search/aggs/agg_types.ts", - "deprecated": false, - "children": [], - "returnComment": [] + "deprecated": false } ], "initialIsOpen": false @@ -21902,108 +22192,6 @@ ], "initialIsOpen": false }, - { - "parentPluginId": "data", - "id": "def-common.DateHistogramBucketAggDependencies", - "type": "Interface", - "tags": [], - "label": "DateHistogramBucketAggDependencies", - "description": [], - "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.DateHistogramBucketAggDependencies.calculateBounds", - "type": "Function", - "tags": [], - "label": "calculateBounds", - "description": [], - "signature": [ - "(timeRange: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, - ") => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRangeBounds", - "text": "TimeRangeBounds" - } - ], - "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-common.DateHistogramBucketAggDependencies.calculateBounds.$1", - "type": "Object", - "tags": [], - "label": "timeRange", - "description": [], - "signature": [ - "{ from: string; to: string; mode?: \"absolute\" | \"relative\" | undefined; }" - ], - "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "data", - "id": "def-common.DateHistogramBucketAggDependencies.isDefaultTimezone", - "type": "Function", - "tags": [], - "label": "isDefaultTimezone", - "description": [], - "signature": [ - "() => boolean" - ], - "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-common.DateHistogramBucketAggDependencies.getConfig", - "type": "Function", - "tags": [], - "label": "getConfig", - "description": [], - "signature": [ - "(key: string) => T" - ], - "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.DateHistogramBucketAggDependencies.getConfig.$1", - "type": "string", - "tags": [], - "label": "key", - "description": [], - "signature": [ - "string" - ], - "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - } - ], - "initialIsOpen": false - }, { "parentPluginId": "data", "id": "def-common.DateRange", @@ -22043,64 +22231,6 @@ ], "initialIsOpen": false }, - { - "parentPluginId": "data", - "id": "def-common.DateRangeBucketAggDependencies", - "type": "Interface", - "tags": [], - "label": "DateRangeBucketAggDependencies", - "description": [], - "path": "src/plugins/data/common/search/aggs/buckets/date_range.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.DateRangeBucketAggDependencies.isDefaultTimezone", - "type": "Function", - "tags": [], - "label": "isDefaultTimezone", - "description": [], - "signature": [ - "() => boolean" - ], - "path": "src/plugins/data/common/search/aggs/buckets/date_range.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-common.DateRangeBucketAggDependencies.getConfig", - "type": "Function", - "tags": [], - "label": "getConfig", - "description": [], - "signature": [ - "(key: string) => T" - ], - "path": "src/plugins/data/common/search/aggs/buckets/date_range.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.DateRangeBucketAggDependencies.getConfig.$1", - "type": "string", - "tags": [], - "label": "key", - "description": [], - "signature": [ - "string" - ], - "path": "src/plugins/data/common/search/aggs/buckets/date_range.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - } - ], - "initialIsOpen": false - }, { "parentPluginId": "data", "id": "def-common.EqlRawResponse", @@ -23704,8 +23834,8 @@ "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" + "section": "def-common.DataView", + "text": "DataView" }, " | undefined" ], @@ -24989,6 +25119,59 @@ "path": "src/plugins/data/common/search/search_source/search_source.ts", "deprecated": false, "children": [ + { + "parentPluginId": "data", + "id": "def-common.SearchSourceDependencies.aggs", + "type": "Object", + "tags": [], + "label": "aggs", + "description": [], + "signature": [ + "{ calculateAutoTimeExpression: (range: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + }, + ") => string | undefined; createAggConfigs: (indexPattern: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + ", configStates?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.CreateAggConfigParams", + "text": "CreateAggConfigParams" + }, + "[] | undefined) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfigs", + "text": "AggConfigs" + }, + "; types: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggTypesRegistryStart", + "text": "AggTypesRegistryStart" + }, + "; }" + ], + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "deprecated": false + }, { "parentPluginId": "data", "id": "def-common.SearchSourceDependencies.search", @@ -25347,8 +25530,8 @@ "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" + "section": "def-common.DataView", + "text": "DataView" }, " | undefined" ], @@ -25524,7 +25707,7 @@ "label": "mode", "description": [], "signature": [ - "\"sum\" | \"avg\" | \"max\" | \"min\" | \"median\" | undefined" + "\"min\" | \"max\" | \"sum\" | \"avg\" | \"median\" | undefined" ], "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false @@ -25623,6 +25806,51 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "data", + "id": "def-common.SqlSearchStrategyResponse", + "type": "Interface", + "tags": [], + "label": "SqlSearchStrategyResponse", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SqlSearchStrategyResponse", + "text": "SqlSearchStrategyResponse" + }, + " extends ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IKibanaSearchResponse", + "text": "IKibanaSearchResponse" + }, + "<", + "SqlQueryResponse", + ">" + ], + "path": "src/plugins/data/common/search/strategies/sql_search/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.SqlSearchStrategyResponse.took", + "type": "number", + "tags": [], + "label": "took", + "description": [ + "\nA metric showing how long did the search take." + ], + "path": "src/plugins/data/common/search/strategies/sql_search/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, { "parentPluginId": "data", "id": "def-common.TotalValue", @@ -26288,6 +26516,20 @@ "deprecated": false, "initialIsOpen": false }, + { + "parentPluginId": "data", + "id": "def-common.aggSinglePercentileRankFnName", + "type": "string", + "tags": [], + "label": "aggSinglePercentileRankFnName", + "description": [], + "signature": [ + "\"aggSinglePercentileRank\"" + ], + "path": "src/plugins/data/common/search/aggs/metrics/single_percentile_rank_fn.ts", + "deprecated": false, + "initialIsOpen": false + }, { "parentPluginId": "data", "id": "def-common.AggsStart", @@ -26311,8 +26553,8 @@ "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" + "section": "def-common.DataView", + "text": "DataView" }, ", configStates?: ", { @@ -27714,7 +27956,7 @@ "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, - "<\"rangeFilter\", null, Arguments, ", + "<\"phraseFilter\", null, Arguments, ", { "pluginId": "data", "scope": "common", @@ -28900,7 +29142,15 @@ }, "; serialize: () => { searchSourceJSON: string; references: ", "SavedObjectReference", - "[]; }; }" + "[]; }; toExpressionAst: ({ asDatatable }?: ExpressionAstOptions) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + "; }" ], "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false, @@ -28954,8 +29204,8 @@ "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.IndexPatternField", - "text": "IndexPatternField" + "section": "def-common.DataViewField", + "text": "DataViewField" } ], "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", @@ -29301,11 +29551,11 @@ "label": "SqlRequestParams", "description": [], "signature": [ - "Omit<", + "(Omit<", "SqlQueryRequest", ", \"keep_alive\" | \"keep_on_completion\"> | Omit<", "SqlGetAsyncRequest", - ", \"id\" | \"keep_alive\" | \"keep_on_completion\">" + ", \"id\" | \"keep_alive\" | \"keep_on_completion\">) & { keep_cursor?: boolean | undefined; }" ], "path": "src/plugins/data/common/search/strategies/sql_search/types.ts", "deprecated": false, @@ -29340,29 +29590,6 @@ "deprecated": false, "initialIsOpen": false }, - { - "parentPluginId": "data", - "id": "def-common.SqlSearchStrategyResponse", - "type": "Type", - "tags": [], - "label": "SqlSearchStrategyResponse", - "description": [], - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.IKibanaSearchResponse", - "text": "IKibanaSearchResponse" - }, - "<", - "SqlQueryResponse", - ">" - ], - "path": "src/plugins/data/common/search/strategies/sql_search/types.ts", - "deprecated": false, - "initialIsOpen": false - }, { "parentPluginId": "data", "id": "def-common.termsAggFilter", @@ -33309,7 +33536,7 @@ "label": "name", "description": [], "signature": [ - "\"rangeFilter\"" + "\"phraseFilter\"" ], "path": "src/plugins/data/common/search/expressions/phrase_filter.ts", "deprecated": false diff --git a/api_docs/data_search.mdx b/api_docs/data_search.mdx index fb7595b89a21a3..9cf2ddc56ab93b 100644 --- a/api_docs/data_search.mdx +++ b/api_docs/data_search.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/data-search title: "data.search" image: https://source.unsplash.com/400x175/?github summary: API docs for the data.search plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.search'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 3489 | 38 | 2874 | 20 | +| 3402 | 35 | 2521 | 20 | ## Client diff --git a/api_docs/data_view_editor.mdx b/api_docs/data_view_editor.mdx index 79d79f21cd9417..d52ac5faa258d0 100644 --- a/api_docs/data_view_editor.mdx +++ b/api_docs/data_view_editor.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/dataViewEditor title: "dataViewEditor" image: https://source.unsplash.com/400x175/?github summary: API docs for the dataViewEditor plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewEditor'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/data_view_field_editor.mdx b/api_docs/data_view_field_editor.mdx index c0535e6e74ef03..d34afec9bd4ca5 100644 --- a/api_docs/data_view_field_editor.mdx +++ b/api_docs/data_view_field_editor.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/dataViewFieldEditor title: "dataViewFieldEditor" image: https://source.unsplash.com/400x175/?github summary: API docs for the dataViewFieldEditor plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewFieldEditor'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/data_view_management.mdx b/api_docs/data_view_management.mdx index 024d28f66182bd..3eb5a6448e4416 100644 --- a/api_docs/data_view_management.mdx +++ b/api_docs/data_view_management.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/dataViewManagement title: "dataViewManagement" image: https://source.unsplash.com/400x175/?github summary: API docs for the dataViewManagement plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewManagement'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/data_views.devdocs.json b/api_docs/data_views.devdocs.json index aa7880b787b46c..2c219f03fec119 100644 --- a/api_docs/data_views.devdocs.json +++ b/api_docs/data_views.devdocs.json @@ -8,7 +8,9 @@ "type": "Class", "tags": [], "label": "DataView", - "description": [], + "description": [ + "\nData view class. Central kibana abstraction around multiple indices." + ], "signature": [ { "pluginId": "dataViews", @@ -18,13 +20,7 @@ "text": "DataView" }, " implements ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IIndexPattern", - "text": "IIndexPattern" - } + "DataViewBase" ], "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": false, @@ -35,7 +31,9 @@ "type": "string", "tags": [], "label": "id", - "description": [], + "description": [ + "\nSaved object id" + ], "signature": [ "string | undefined" ], @@ -48,7 +46,9 @@ "type": "string", "tags": [], "label": "title", - "description": [], + "description": [ + "\nTitle of data view" + ], "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": false }, @@ -58,7 +58,9 @@ "type": "Object", "tags": [], "label": "fieldFormatMap", - "description": [], + "description": [ + "\nMap of field formats by field name" + ], "signature": [ "{ [x: string]: any; }" ], @@ -72,7 +74,7 @@ "tags": [], "label": "typeMeta", "description": [ - "\nOnly used by rollup indices, used by rollup specific endpoint to load field list" + "\nOnly used by rollup indices, used by rollup specific endpoint to load field list." ], "signature": [ { @@ -93,7 +95,9 @@ "type": "CompoundType", "tags": [], "label": "fields", - "description": [], + "description": [ + "\nField list, in extended array format" + ], "signature": [ { "pluginId": "dataViews", @@ -121,7 +125,9 @@ "type": "string", "tags": [], "label": "timeFieldName", - "description": [], + "description": [ + "\nTimestamp field name" + ], "signature": [ "string | undefined" ], @@ -135,7 +141,7 @@ "tags": [], "label": "type", "description": [ - "\nType is used to identify rollup index patterns" + "\nType is used to identify rollup index patterns." ], "signature": [ "string | undefined" @@ -203,7 +209,9 @@ "type": "Array", "tags": [], "label": "metaFields", - "description": [], + "description": [ + "\nList of meta fields by name" + ], "signature": [ "string[]" ], @@ -231,7 +239,9 @@ "type": "Array", "tags": [], "label": "sourceFilters", - "description": [], + "description": [ + "\nArray of filters - hides fields in discover" + ], "signature": [ { "pluginId": "dataViews", @@ -251,7 +261,9 @@ "type": "Array", "tags": [], "label": "namespaces", - "description": [], + "description": [ + "\nArray of namespace ids" + ], "signature": [ "string[]" ], @@ -265,7 +277,7 @@ "tags": [], "label": "allowNoIndex", "description": [ - "\nprevents errors when index pattern exists before indices" + "\nPrevents errors when index pattern exists before indices" ], "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": false @@ -276,7 +288,9 @@ "type": "Function", "tags": [], "label": "Constructor", - "description": [], + "description": [ + "\nconstructor" + ], "signature": [ "any" ], @@ -288,8 +302,10 @@ "id": "def-public.DataView.Unnamed.$1", "type": "Object", "tags": [], - "label": "{ spec = {}, fieldFormats, shortDotsEnable = false, metaFields = [] }", - "description": [], + "label": "config", + "description": [ + "- config data and dependencies" + ], "signature": [ "DataViewDeps" ], @@ -324,7 +340,7 @@ "tags": [], "label": "resetOriginalSavedObjectBody", "description": [ - "\nReset last saved saved object fields. used after saving" + "\nReset last saved saved object fields. Used after saving." ], "signature": [ "() => void" @@ -340,7 +356,9 @@ "type": "Function", "tags": [], "label": "getFieldAttrs", - "description": [], + "description": [ + "\nReturns field attributes map" + ], "signature": [ "() => { [x: string]: ", { @@ -363,7 +381,9 @@ "type": "Function", "tags": [], "label": "getComputedFields", - "description": [], + "description": [ + "\nReturns scripted fields" + ], "signature": [ "() => { storedFields: string[]; scriptFields: Record ", @@ -426,7 +446,7 @@ ], "label": "removeScriptedField", "description": [ - "\nRemove scripted field from field list" + "\nRemoves scripted field from field list." ], "signature": [ "(fieldName: string) => void" @@ -450,7 +470,9 @@ "type": "string", "tags": [], "label": "fieldName", - "description": [], + "description": [ + "name of scripted field to remove" + ], "signature": [ "string" ], @@ -569,7 +591,9 @@ "type": "Function", "tags": [], "label": "isTimeBased", - "description": [], + "description": [ + "\nDoes the data view have a timestamp field?" + ], "signature": [ "() => this is ", { @@ -591,7 +615,9 @@ "type": "Function", "tags": [], "label": "isTimeNanosBased", - "description": [], + "description": [ + "\nDoes the data view have a timestamp field and is it a date nanos field?" + ], "signature": [ "() => this is ", { @@ -613,7 +639,9 @@ "type": "Function", "tags": [], "label": "getTimeField", - "description": [], + "description": [ + "\nGet timestamp field as DataViewField or return undefined" + ], "signature": [ "() => ", { @@ -636,7 +664,9 @@ "type": "Function", "tags": [], "label": "getFieldByName", - "description": [], + "description": [ + "\nGet field by name." + ], "signature": [ "(name: string) => ", { @@ -657,7 +687,9 @@ "type": "string", "tags": [], "label": "name", - "description": [], + "description": [ + "field name" + ], "signature": [ "string" ], @@ -674,7 +706,9 @@ "type": "Function", "tags": [], "label": "getAggregationRestrictions", - "description": [], + "description": [ + "\nGet aggregation restrictions. Rollup fields can only perform a subset of aggregations." + ], "signature": [ "() => Record ", { "pluginId": "fieldFormats", @@ -767,14 +793,16 @@ "type": "CompoundType", "tags": [], "label": "field", - "description": [], + "description": [ + "field to get formatter for" + ], "signature": [ { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" + "section": "def-common.DataViewField", + "text": "DataViewField" }, " | ", { @@ -783,14 +811,6 @@ "docId": "kibDataViewsPluginApi", "section": "def-common.FieldSpec", "text": "FieldSpec" - }, - " | ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" } ], "path": "src/plugins/data_views/common/data_views/data_view.ts", @@ -893,7 +913,9 @@ "type": "string", "tags": [], "label": "name", - "description": [], + "description": [ + "field name" + ], "signature": [ "string" ], @@ -933,7 +955,9 @@ "type": "string", "tags": [], "label": "name", - "description": [], + "description": [ + "Runtime field name" + ], "signature": [ "string" ], @@ -950,7 +974,9 @@ "type": "Function", "tags": [], "label": "getAllRuntimeFields", - "description": [], + "description": [ + "\nGet all runtime field definitions." + ], "signature": [ "() => Record Record ", @@ -1112,7 +1148,7 @@ "tags": [], "label": "getFormatterForFieldNoDefault", "description": [ - "\nGet formatter for a given field name. Return undefined if none exists" + "\nGet formatter for a given field name. Return undefined if none exists." ], "signature": [ "(fieldname: string) => ", @@ -1134,7 +1170,9 @@ "type": "string", "tags": [], "label": "fieldname", - "description": [], + "description": [ + "name of field to get formatter for" + ], "signature": [ "string" ], @@ -1151,7 +1189,9 @@ "type": "Function", "tags": [], "label": "setFieldAttrs", - "description": [], + "description": [ + "\nSet field attribute" + ], "signature": [ " void" ], @@ -1245,7 +1293,9 @@ "type": "string", "tags": [], "label": "fieldName", - "description": [], + "description": [ + "name of field to set custom label on" + ], "signature": [ "string" ], @@ -1259,7 +1309,9 @@ "type": "CompoundType", "tags": [], "label": "customLabel", - "description": [], + "description": [ + "custom label value. If undefined, custom label is removed" + ], "signature": [ "string | null | undefined" ], @@ -1276,7 +1328,9 @@ "type": "Function", "tags": [], "label": "setFieldCount", - "description": [], + "description": [ + "\nSet field count" + ], "signature": [ "(fieldName: string, count: number | null | undefined) => void" ], @@ -1289,7 +1343,9 @@ "type": "string", "tags": [], "label": "fieldName", - "description": [], + "description": [ + "name of field to set count on" + ], "signature": [ "string" ], @@ -1303,7 +1359,9 @@ "type": "CompoundType", "tags": [], "label": "count", - "description": [], + "description": [ + "count value. If undefined, count is removed" + ], "signature": [ "number | null | undefined" ], @@ -1320,7 +1378,9 @@ "type": "Function", "tags": [], "label": "setFieldFormat", - "description": [], + "description": [ + "\nSet field formatter" + ], "signature": [ "(fieldName: string, format: ", { @@ -1349,7 +1409,9 @@ "type": "string", "tags": [], "label": "fieldName", - "description": [], + "description": [ + "name of field to set format on" + ], "signature": [ "string" ], @@ -1363,7 +1425,9 @@ "type": "Object", "tags": [], "label": "format", - "description": [], + "description": [ + "field format in serialized form" + ], "signature": [ { "pluginId": "fieldFormats", @@ -1395,7 +1459,9 @@ "type": "Function", "tags": [], "label": "deleteFieldFormat", - "description": [], + "description": [ + "\nRemove field format from the field format map." + ], "signature": [ "(fieldName: string) => void" ], @@ -1408,7 +1474,9 @@ "type": "string", "tags": [], "label": "fieldName", - "description": [], + "description": [ + "field name associated with the format for removal" + ], "signature": [ "string" ], @@ -1428,7 +1496,9 @@ "type": "Class", "tags": [], "label": "DataViewField", - "description": [], + "description": [ + "\nData view field class" + ], "signature": [ { "pluginId": "dataViews", @@ -1438,13 +1508,7 @@ "text": "DataViewField" }, " implements ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" - } + "DataViewFieldBase" ], "path": "src/plugins/data_views/common/fields/data_view_field.ts", "deprecated": false, @@ -1472,9 +1536,13 @@ "parentPluginId": "dataViews", "id": "def-public.DataViewField.Unnamed", "type": "Function", - "tags": [], + "tags": [ + "constructor" + ], "label": "Constructor", - "description": [], + "description": [ + "\nDataView constructor" + ], "signature": [ "any" ], @@ -1487,7 +1555,9 @@ "type": "Object", "tags": [], "label": "spec", - "description": [], + "description": [ + "Configuration for the field" + ], "signature": [ { "pluginId": "dataViews", @@ -1511,7 +1581,7 @@ "tags": [], "label": "count", "description": [ - "\nCount is used for field popularity" + "\nCount is used for field popularity in discover." ], "path": "src/plugins/data_views/common/fields/data_view_field.ts", "deprecated": false @@ -1522,7 +1592,9 @@ "type": "number", "tags": [], "label": "count", - "description": [], + "description": [ + "\nSet count, which is used for field popularity in discover." + ], "path": "src/plugins/data_views/common/fields/data_view_field.ts", "deprecated": false }, @@ -1532,7 +1604,9 @@ "type": "Object", "tags": [], "label": "runtimeField", - "description": [], + "description": [ + "\nReturns runtime field definition or undefined if field is not runtime field." + ], "signature": [ { "pluginId": "dataViews", @@ -1552,7 +1626,9 @@ "type": "Object", "tags": [], "label": "runtimeField", - "description": [], + "description": [ + "\nSets runtime field definition or unsets if undefined is provided." + ], "signature": [ { "pluginId": "dataViews", @@ -1587,7 +1663,9 @@ "type": "string", "tags": [], "label": "script", - "description": [], + "description": [ + "\nSets scripted field painless code" + ], "signature": [ "string | undefined" ], @@ -1615,7 +1693,9 @@ "type": "string", "tags": [], "label": "lang", - "description": [], + "description": [ + "\nSets scripted field langauge." + ], "signature": [ "string | undefined" ], @@ -1628,7 +1708,9 @@ "type": "string", "tags": [], "label": "customLabel", - "description": [], + "description": [ + "\nReturns custom label if set, otherwise undefined." + ], "signature": [ "string | undefined" ], @@ -1641,7 +1723,9 @@ "type": "string", "tags": [], "label": "customLabel", - "description": [], + "description": [ + "\nSets custom label for field, or unsets if passed undefined." + ], "signature": [ "string | undefined" ], @@ -1655,7 +1739,7 @@ "tags": [], "label": "conflictDescriptions", "description": [ - "\nDescription of field type conflicts across different indices in the same index pattern" + "\nDescription of field type conflicts across different indices in the same index pattern." ], "signature": [ "Record | undefined" @@ -1669,7 +1753,9 @@ "type": "Object", "tags": [], "label": "conflictDescriptions", - "description": [], + "description": [ + "\nSets conflict descriptions for field." + ], "signature": [ "Record | undefined" ], @@ -1682,7 +1768,9 @@ "type": "string", "tags": [], "label": "name", - "description": [], + "description": [ + "\nGet field name" + ], "path": "src/plugins/data_views/common/fields/data_view_field.ts", "deprecated": false }, @@ -1692,7 +1780,9 @@ "type": "string", "tags": [], "label": "displayName", - "description": [], + "description": [ + "\nGets display name, calcualted based on name, custom label and shortDotsEnable." + ], "path": "src/plugins/data_views/common/fields/data_view_field.ts", "deprecated": false }, @@ -1702,7 +1792,9 @@ "type": "string", "tags": [], "label": "type", - "description": [], + "description": [ + "\nGets field type" + ], "path": "src/plugins/data_views/common/fields/data_view_field.ts", "deprecated": false }, @@ -1712,7 +1804,9 @@ "type": "Array", "tags": [], "label": "esTypes", - "description": [], + "description": [ + "\nGets ES types as string array" + ], "signature": [ "string[] | undefined" ], @@ -1725,7 +1819,9 @@ "type": "boolean", "tags": [], "label": "scripted", - "description": [], + "description": [ + "\nReturns true if scripted field" + ], "path": "src/plugins/data_views/common/fields/data_view_field.ts", "deprecated": false }, @@ -1735,7 +1831,9 @@ "type": "boolean", "tags": [], "label": "searchable", - "description": [], + "description": [ + "\nReturns true if field is searchable" + ], "path": "src/plugins/data_views/common/fields/data_view_field.ts", "deprecated": false }, @@ -1745,7 +1843,9 @@ "type": "boolean", "tags": [], "label": "aggregatable", - "description": [], + "description": [ + "\nReturns true if field is aggregatable" + ], "path": "src/plugins/data_views/common/fields/data_view_field.ts", "deprecated": false }, @@ -1755,7 +1855,9 @@ "type": "boolean", "tags": [], "label": "readFromDocValues", - "description": [], + "description": [ + "\nReturns true if field is available via doc values" + ], "path": "src/plugins/data_views/common/fields/data_view_field.ts", "deprecated": false }, @@ -1765,7 +1867,9 @@ "type": "CompoundType", "tags": [], "label": "subType", - "description": [], + "description": [ + "\nReturns field subtype, multi, nested, or undefined if neither" + ], "signature": [ "IFieldSubType", " | undefined" @@ -1794,7 +1898,9 @@ "type": "boolean", "tags": [], "label": "isRuntimeField", - "description": [], + "description": [ + "\nReturns true if runtime field defined on data view" + ], "path": "src/plugins/data_views/common/fields/data_view_field.ts", "deprecated": false }, @@ -1804,7 +1910,9 @@ "type": "boolean", "tags": [], "label": "sortable", - "description": [], + "description": [ + "\nReturns true if field is sortable" + ], "path": "src/plugins/data_views/common/fields/data_view_field.ts", "deprecated": false }, @@ -1814,7 +1922,9 @@ "type": "boolean", "tags": [], "label": "filterable", - "description": [], + "description": [ + "\nReturns true if field is filterable" + ], "path": "src/plugins/data_views/common/fields/data_view_field.ts", "deprecated": false }, @@ -1824,7 +1934,9 @@ "type": "boolean", "tags": [], "label": "visualizable", - "description": [], + "description": [ + "\nReturns true if field is visualizable" + ], "path": "src/plugins/data_views/common/fields/data_view_field.ts", "deprecated": false }, @@ -1834,7 +1946,9 @@ "type": "Function", "tags": [], "label": "isSubtypeNested", - "description": [], + "description": [ + "\nReturns true if field is subtype nested" + ], "signature": [ "() => boolean" ], @@ -1849,7 +1963,9 @@ "type": "Function", "tags": [], "label": "isSubtypeMulti", - "description": [], + "description": [ + "\nReturns true if field is subtype multi" + ], "signature": [ "() => boolean" ], @@ -1864,7 +1980,9 @@ "type": "Function", "tags": [], "label": "getSubtypeNested", - "description": [], + "description": [ + "\nReturns subtype nested data if exists" + ], "signature": [ "() => ", "IFieldSubTypeNested", @@ -1881,7 +1999,9 @@ "type": "Function", "tags": [], "label": "getSubtypeMulti", - "description": [], + "description": [ + "\nReturns subtype multi data if exists" + ], "signature": [ "() => ", "IFieldSubTypeMulti", @@ -1898,8 +2018,10 @@ "type": "Function", "tags": [], "label": "deleteCount", - "description": [], - "signature": [ + "description": [ + "\nDeletes count value. Popularity as used by discover" + ], + "signature": [ "() => void" ], "path": "src/plugins/data_views/common/fields/data_view_field.ts", @@ -1913,7 +2035,9 @@ "type": "Function", "tags": [], "label": "toJSON", - "description": [], + "description": [ + "\nJSON version of field" + ], "signature": [ "() => { count: number; script: string | undefined; lang: string | undefined; conflictDescriptions: Record | undefined; name: string; type: string; esTypes: string[] | undefined; scripted: boolean; searchable: boolean; aggregatable: boolean; readFromDocValues: boolean; subType: ", "IFieldSubType", @@ -1930,41 +2054,19 @@ "type": "Function", "tags": [], "label": "toSpec", - "description": [], + "description": [ + "\nGet field in serialized form - fieldspec." + ], "signature": [ - "({ getFormatterForField, }?: { getFormatterForField?: ((field: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" - }, - " | ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - " | ", + "(config?: ", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" + "section": "def-common.ToSpecConfig", + "text": "ToSpecConfig" }, ") => ", - { - "pluginId": "fieldFormats", - "scope": "common", - "docId": "kibFieldFormatsPluginApi", - "section": "def-common.FieldFormat", - "text": "FieldFormat" - }, - ") | undefined; }) => ", { "pluginId": "dataViews", "scope": "common", @@ -1981,60 +2083,27 @@ "id": "def-public.DataViewField.toSpec.$1", "type": "Object", "tags": [], - "label": "{\n getFormatterForField,\n }", - "description": [], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false, - "children": [ + "label": "config", + "description": [ + "provide a method to get a field formatter" + ], + "signature": [ { - "parentPluginId": "dataViews", - "id": "def-public.DataViewField.toSpec.$1.getFormatterForField", - "type": "Function", - "tags": [], - "label": "getFormatterForField", - "description": [], - "signature": [ - "((field: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" - }, - " | ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - " | ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" - }, - ") => ", - { - "pluginId": "fieldFormats", - "scope": "common", - "docId": "kibFieldFormatsPluginApi", - "section": "def-common.FieldFormat", - "text": "FieldFormat" - }, - ") | undefined" - ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.ToSpecConfig", + "text": "ToSpecConfig" } - ] + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false, + "isRequired": true } ], - "returnComment": [] + "returnComment": [ + "field in serialized form - field spec" + ] }, { "parentPluginId": "dataViews", @@ -2042,7 +2111,9 @@ "type": "Function", "tags": [], "label": "isRuntimeCompositeSubField", - "description": [], + "description": [ + "\nReturns true if composite runtime field" + ], "signature": [ "() => boolean" ], @@ -2060,7 +2131,9 @@ "type": "Class", "tags": [], "label": "DataViewsApiClient", - "description": [], + "description": [ + "\nData Views API Client - client implementation" + ], "signature": [ { "pluginId": "dataViews", @@ -2087,7 +2160,9 @@ "type": "Function", "tags": [], "label": "Constructor", - "description": [], + "description": [ + "\nconstructor" + ], "signature": [ "any" ], @@ -2100,7 +2175,9 @@ "type": "Object", "tags": [], "label": "http", - "description": [], + "description": [ + "http dependency" + ], "signature": [ { "pluginId": "core", @@ -2117,59 +2194,17 @@ ], "returnComment": [] }, - { - "parentPluginId": "dataViews", - "id": "def-public.DataViewsApiClient.getFieldsForTimePattern", - "type": "Function", - "tags": [], - "label": "getFieldsForTimePattern", - "description": [], - "signature": [ - "(options: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.GetFieldsOptionsTimePattern", - "text": "GetFieldsOptionsTimePattern" - }, - ") => Promise" - ], - "path": "src/plugins/data_views/public/data_views/data_views_api_client.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-public.DataViewsApiClient.getFieldsForTimePattern.$1", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.GetFieldsOptionsTimePattern", - "text": "GetFieldsOptionsTimePattern" - } - ], - "path": "src/plugins/data_views/public/data_views/data_views_api_client.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, { "parentPluginId": "dataViews", "id": "def-public.DataViewsApiClient.getFieldsForWildcard", "type": "Function", "tags": [], "label": "getFieldsForWildcard", - "description": [], + "description": [ + "\nGet field list for a given index pattern" + ], "signature": [ - "({ pattern, metaFields, type, rollupIndex, allowNoIndex, filter, }: ", + "(options: ", { "pluginId": "dataViews", "scope": "common", @@ -2187,8 +2222,10 @@ "id": "def-public.DataViewsApiClient.getFieldsForWildcard.$1", "type": "Object", "tags": [], - "label": "{\n pattern,\n metaFields,\n type,\n rollupIndex,\n allowNoIndex,\n filter,\n }", - "description": [], + "label": "options", + "description": [ + "options for fields request" + ], "signature": [ { "pluginId": "dataViews", @@ -2211,7 +2248,9 @@ "type": "Function", "tags": [], "label": "hasUserIndexPattern", - "description": [], + "description": [ + "\nDoes a user created data view exist?" + ], "signature": [ "() => Promise" ], @@ -2229,7 +2268,9 @@ "type": "Class", "tags": [], "label": "DataViewSavedObjectConflictError", - "description": [], + "description": [ + "\nError thrown when saved object has been changed when attempting to save." + ], "signature": [ { "pluginId": "dataViews", @@ -2249,7 +2290,9 @@ "type": "Function", "tags": [], "label": "Constructor", - "description": [], + "description": [ + "\nconstructor" + ], "signature": [ "any" ], @@ -2262,7 +2305,9 @@ "type": "string", "tags": [], "label": "savedObjectId", - "description": [], + "description": [ + "saved object id with conflict" + ], "signature": [ "string" ], @@ -2308,11 +2353,29 @@ "text": "DataViewsPublicPluginSetup" }, ", ", - "DataViewsServicePublic", + { + "pluginId": "dataViews", + "scope": "public", + "docId": "kibDataViewsPluginApi", + "section": "def-public.DataViewsServicePublic", + "text": "DataViewsServicePublic" + }, ", ", - "DataViewsPublicSetupDependencies", + { + "pluginId": "dataViews", + "scope": "public", + "docId": "kibDataViewsPluginApi", + "section": "def-public.DataViewsPublicSetupDependencies", + "text": "DataViewsPublicSetupDependencies" + }, ", ", - "DataViewsPublicStartDependencies", + { + "pluginId": "dataViews", + "scope": "public", + "docId": "kibDataViewsPluginApi", + "section": "def-public.DataViewsPublicStartDependencies", + "text": "DataViewsPublicStartDependencies" + }, ">" ], "path": "src/plugins/data_views/public/plugin.ts", @@ -2335,11 +2398,29 @@ "text": "CoreSetup" }, "<", - "DataViewsPublicStartDependencies", + { + "pluginId": "dataViews", + "scope": "public", + "docId": "kibDataViewsPluginApi", + "section": "def-public.DataViewsPublicStartDependencies", + "text": "DataViewsPublicStartDependencies" + }, ", ", - "DataViewsServicePublic", + { + "pluginId": "dataViews", + "scope": "public", + "docId": "kibDataViewsPluginApi", + "section": "def-public.DataViewsServicePublic", + "text": "DataViewsServicePublic" + }, ">, { expressions }: ", - "DataViewsPublicSetupDependencies", + { + "pluginId": "dataViews", + "scope": "public", + "docId": "kibDataViewsPluginApi", + "section": "def-public.DataViewsPublicSetupDependencies", + "text": "DataViewsPublicSetupDependencies" + }, ") => ", { "pluginId": "dataViews", @@ -2368,9 +2449,21 @@ "text": "CoreSetup" }, "<", - "DataViewsPublicStartDependencies", + { + "pluginId": "dataViews", + "scope": "public", + "docId": "kibDataViewsPluginApi", + "section": "def-public.DataViewsPublicStartDependencies", + "text": "DataViewsPublicStartDependencies" + }, ", ", - "DataViewsServicePublic", + { + "pluginId": "dataViews", + "scope": "public", + "docId": "kibDataViewsPluginApi", + "section": "def-public.DataViewsServicePublic", + "text": "DataViewsServicePublic" + }, ">" ], "path": "src/plugins/data_views/public/plugin.ts", @@ -2385,7 +2478,13 @@ "label": "{ expressions }", "description": [], "signature": [ - "DataViewsPublicSetupDependencies" + { + "pluginId": "dataViews", + "scope": "public", + "docId": "kibDataViewsPluginApi", + "section": "def-public.DataViewsPublicSetupDependencies", + "text": "DataViewsPublicSetupDependencies" + } ], "path": "src/plugins/data_views/public/plugin.ts", "deprecated": false, @@ -2411,9 +2510,21 @@ "text": "CoreStart" }, ", { fieldFormats }: ", - "DataViewsPublicStartDependencies", + { + "pluginId": "dataViews", + "scope": "public", + "docId": "kibDataViewsPluginApi", + "section": "def-public.DataViewsPublicStartDependencies", + "text": "DataViewsPublicStartDependencies" + }, ") => ", - "DataViewsServicePublic" + { + "pluginId": "dataViews", + "scope": "public", + "docId": "kibDataViewsPluginApi", + "section": "def-public.DataViewsServicePublic", + "text": "DataViewsServicePublic" + } ], "path": "src/plugins/data_views/public/plugin.ts", "deprecated": false, @@ -2446,7 +2557,13 @@ "label": "{ fieldFormats }", "description": [], "signature": [ - "DataViewsPublicStartDependencies" + { + "pluginId": "dataViews", + "scope": "public", + "docId": "kibDataViewsPluginApi", + "section": "def-public.DataViewsPublicStartDependencies", + "text": "DataViewsPublicStartDependencies" + } ], "path": "src/plugins/data_views/public/plugin.ts", "deprecated": false, @@ -2479,7 +2596,9 @@ "type": "Class", "tags": [], "label": "DataViewsService", - "description": [], + "description": [ + "\nData views service, providing CRUD operations for data views." + ], "path": "src/plugins/data_views/common/data_views/data_views.ts", "deprecated": false, "children": [ @@ -2489,7 +2608,9 @@ "type": "Function", "tags": [], "label": "getCanSave", - "description": [], + "description": [ + "\nCan the user save data views?" + ], "signature": [ "() => Promise" ], @@ -2498,31 +2619,15 @@ "returnComment": [], "children": [] }, - { - "parentPluginId": "dataViews", - "id": "def-public.DataViewsService.ensureDefaultDataView", - "type": "Function", - "tags": [ - "deprecated" - ], - "label": "ensureDefaultDataView", - "description": [], - "signature": [ - "() => Promise | undefined" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": true, - "references": [], - "returnComment": [], - "children": [] - }, { "parentPluginId": "dataViews", "id": "def-public.DataViewsService.Unnamed", "type": "Function", "tags": [], "label": "Constructor", - "description": [], + "description": [ + "\nDataViewsService constructor" + ], "signature": [ "any" ], @@ -2534,10 +2639,18 @@ "id": "def-public.DataViewsService.Unnamed.$1", "type": "Object", "tags": [], - "label": "{\n uiSettings,\n savedObjectsClient,\n apiClient,\n fieldFormats,\n onNotification,\n onError,\n onRedirectNoIndexPattern = () => {},\n getCanSave = () => Promise.resolve(false),\n }", - "description": [], + "label": "deps", + "description": [ + "Service dependencies" + ], "signature": [ - "DataViewsServiceDeps" + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewsServiceDeps", + "text": "DataViewsServiceDeps" + } ], "path": "src/plugins/data_views/common/data_views/data_views.ts", "deprecated": false, @@ -2553,7 +2666,7 @@ "tags": [], "label": "getIds", "description": [ - "\nGet list of index pattern ids" + "\nGets list of index pattern ids." ], "signature": [ "(refresh?: boolean) => Promise" @@ -2587,7 +2700,7 @@ "tags": [], "label": "getTitles", "description": [ - "\nGet list of index pattern titles" + "\nGets list of index pattern titles." ], "signature": [ "(refresh?: boolean) => Promise" @@ -2621,7 +2734,7 @@ "tags": [], "label": "find", "description": [ - "\nFind and load index patterns by title" + "\nFind and load index patterns by title." ], "signature": [ "(search: string, size?: number) => Promise<", @@ -2643,7 +2756,9 @@ "type": "string", "tags": [], "label": "search", - "description": [], + "description": [ + "Search string" + ], "signature": [ "string" ], @@ -2657,7 +2772,9 @@ "type": "number", "tags": [], "label": "size", - "description": [], + "description": [ + "Number of data views to return" + ], "signature": [ "number" ], @@ -2667,7 +2784,7 @@ } ], "returnComment": [ - "IndexPattern[]" + "DataView[]" ] }, { @@ -2677,7 +2794,7 @@ "tags": [], "label": "getIdsWithTitle", "description": [ - "\nGet list of index pattern ids with titles" + "\nGets list of index pattern ids with titles." ], "signature": [ "(refresh?: boolean) => Promise<", @@ -2719,7 +2836,7 @@ "tags": [], "label": "clearCache", "description": [ - "\nClear index pattern list cache" + "\nClear index pattern list cache." ], "signature": [ "(id?: string | undefined) => void" @@ -2752,12 +2869,14 @@ "type": "Function", "tags": [], "label": "getCache", - "description": [], + "description": [ + "\nGet cache, contains data view saved objects." + ], "signature": [ "() => Promise<", "SavedObject", "<", - "IndexPatternSavedObjectAttrs", + "DataViewSavedObjectAttrs", ">[] | null | undefined>" ], "path": "src/plugins/data_views/common/data_views/data_views.ts", @@ -2828,7 +2947,9 @@ "type": "CompoundType", "tags": [], "label": "id", - "description": [], + "description": [ + "data view id" + ], "signature": [ "string | null" ], @@ -2842,7 +2963,9 @@ "type": "boolean", "tags": [], "label": "force", - "description": [], + "description": [ + "set default data view even if there's an existing default" + ], "signature": [ "boolean" ], @@ -2860,7 +2983,7 @@ "tags": [], "label": "hasUserDataView", "description": [ - "\nChecks if current user has a user created index pattern ignoring fleet's server default index patterns" + "\nChecks if current user has a user created index pattern ignoring fleet's server default index patterns." ], "signature": [ "() => Promise" @@ -2877,7 +3000,7 @@ "tags": [], "label": "getFieldsForWildcard", "description": [ - "\nGet field list by providing { pattern }" + "\nGet field list by providing { pattern }." ], "signature": [ "(options: ", @@ -2907,7 +3030,9 @@ "type": "Object", "tags": [], "label": "options", - "description": [], + "description": [ + "options for getting field list" + ], "signature": [ { "pluginId": "dataViews", @@ -2933,7 +3058,7 @@ "tags": [], "label": "getFieldsForIndexPattern", "description": [ - "\nGet field list by providing an index patttern (or spec)" + "\nGet field list by providing an index patttern (or spec)." ], "signature": [ "(indexPattern: ", @@ -3007,7 +3132,9 @@ "type": "Object", "tags": [], "label": "options", - "description": [], + "description": [ + "options for getting field list" + ], "signature": [ { "pluginId": "dataViews", @@ -3034,7 +3161,7 @@ "tags": [], "label": "refreshFields", "description": [ - "\nRefresh field list for a given index pattern" + "\nRefresh field list for a given index pattern." ], "signature": [ "(indexPattern: ", @@ -3080,7 +3207,7 @@ "tags": [], "label": "fieldArrayToMap", "description": [ - "\nConverts field array to map" + "\nConverts field array to map." ], "signature": [ "(fields: ", @@ -3169,7 +3296,7 @@ "tags": [], "label": "savedObjectToSpec", "description": [ - "\nConverts index pattern saved object to index pattern spec" + "\nConverts data view saved object to data view spec." ], "signature": [ "(savedObject: ", @@ -3229,7 +3356,7 @@ "tags": [], "label": "get", "description": [ - "\nGet an index pattern by id. Cache optimized" + "\nGet an index pattern by id, cache optimized." ], "signature": [ "(id: string) => Promise<", @@ -3269,7 +3396,7 @@ "tags": [], "label": "create", "description": [ - "\nCreate a new index pattern instance" + "\nCreate a new data view instance." ], "signature": [ "(spec: ", @@ -3299,7 +3426,9 @@ "type": "Object", "tags": [], "label": "spec", - "description": [], + "description": [ + "data view spec" + ], "signature": [ { "pluginId": "dataViews", @@ -3319,7 +3448,9 @@ "type": "boolean", "tags": [], "label": "skipFetchFields", - "description": [], + "description": [ + "if true, will not fetch fields" + ], "signature": [ "boolean" ], @@ -3329,7 +3460,7 @@ } ], "returnComment": [ - "IndexPattern" + "DataView" ] }, { @@ -3339,7 +3470,7 @@ "tags": [], "label": "createAndSave", "description": [ - "\nCreate a new index pattern and save it right away" + "\nCreate a new data view and save it right away." ], "signature": [ "(spec: ", @@ -3369,7 +3500,9 @@ "type": "Object", "tags": [], "label": "spec", - "description": [], + "description": [ + "data view spec" + ], "signature": [ { "pluginId": "dataViews", @@ -3425,10 +3558,10 @@ "tags": [], "label": "createSavedObject", "description": [ - "\nSave a new index pattern" + "\nSave a new data view." ], "signature": [ - "(indexPattern: ", + "(dataView: ", { "pluginId": "dataViews", "scope": "common", @@ -3454,8 +3587,10 @@ "id": "def-public.DataViewsService.createSavedObject.$1", "type": "Object", "tags": [], - "label": "indexPattern", - "description": [], + "label": "dataView", + "description": [ + "data view instance" + ], "signature": [ { "pluginId": "dataViews", @@ -3495,7 +3630,7 @@ "tags": [], "label": "updateSavedObject", "description": [ - "\nSave existing index pattern. Will attempt to merge differences if there are conflicts" + "\nSave existing dat aview. Will attempt to merge differences if there are conflicts." ], "signature": [ "(indexPattern: ", @@ -3569,7 +3704,7 @@ "tags": [], "label": "delete", "description": [ - "\nDeletes an index pattern from .kibana index" + "\nDeletes an index pattern from .kibana index." ], "signature": [ "(indexPatternId: string) => Promise<{}>" @@ -3603,7 +3738,7 @@ "tags": [], "label": "getDefaultDataView", "description": [ - "\nReturns the default data view as an object.\nIf no default is found, or it is missing\nanother data view is selected as default and returned.\nIf no possible data view found to become a default returns null\n" + "\nReturns the default data view as an object.\nIf no default is found, or it is missing\nanother data view is selected as default and returned.\nIf no possible data view found to become a default returns null.\n" ], "signature": [ "() => Promise<", @@ -3628,1332 +3763,1938 @@ }, { "parentPluginId": "dataViews", - "id": "def-public.IndexPattern", + "id": "def-public.DataViewsServicePublic", "type": "Class", - "tags": [ - "deprecated" + "tags": [], + "label": "DataViewsServicePublic", + "description": [ + "\nData Views public service" ], - "label": "IndexPattern", - "description": [], "signature": [ { "pluginId": "dataViews", - "scope": "common", + "scope": "public", "docId": "kibDataViewsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" + "section": "def-public.DataViewsServicePublic", + "text": "DataViewsServicePublic" }, " extends ", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" + "section": "def-common.DataViewsService", + "text": "DataViewsService" } ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": true, - "references": [ - { - "plugin": "data", - "path": "src/plugins/data/common/index.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/types.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/types.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/types.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/types.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/tabify/tabify_docs.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/tabify/tabify_docs.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/tabify/tabify_docs.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/expressions/esaggs/request_handler.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/expressions/esaggs/request_handler.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/expressions/phrase_filter.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/expressions/phrase_filter.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/expressions/phrase_filter.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/expressions/exists_filter.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/expressions/exists_filter.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/expressions/range_filter.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/expressions/range_filter.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/types.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/types.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/utils/infer_time_zone.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/utils/infer_time_zone.ts" - }, + "path": "src/plugins/data_views/public/data_views_service_public.ts", + "deprecated": false, + "children": [ { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/agg_configs.ts" + "parentPluginId": "dataViews", + "id": "def-public.DataViewsServicePublic.getCanSaveSync", + "type": "Function", + "tags": [], + "label": "getCanSaveSync", + "description": [], + "signature": [ + "() => boolean" + ], + "path": "src/plugins/data_views/public/data_views_service_public.ts", + "deprecated": false, + "returnComment": [], + "children": [] }, { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/agg_configs.ts" + "parentPluginId": "dataViews", + "id": "def-public.DataViewsServicePublic.hasData", + "type": "Object", + "tags": [], + "label": "hasData", + "description": [], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.HasDataService", + "text": "HasDataService" + } + ], + "path": "src/plugins/data_views/public/data_views_service_public.ts", + "deprecated": false }, { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/agg_configs.ts" - }, + "parentPluginId": "dataViews", + "id": "def-public.DataViewsServicePublic.Unnamed", + "type": "Function", + "tags": [], + "label": "Constructor", + "description": [ + "\nConstructor" + ], + "signature": [ + "any" + ], + "path": "src/plugins/data_views/public/data_views_service_public.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-public.DataViewsServicePublic.Unnamed.$1", + "type": "Object", + "tags": [], + "label": "deps", + "description": [ + "Service dependencies" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "public", + "docId": "kibDataViewsPluginApi", + "section": "def-public.DataViewsServicePublicDeps", + "text": "DataViewsServicePublicDeps" + } + ], + "path": "src/plugins/data_views/public/data_views_service_public.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "dataViews", + "id": "def-public.SavedObjectsClientPublicToCommon", + "type": "Class", + "tags": [], + "label": "SavedObjectsClientPublicToCommon", + "description": [], + "signature": [ { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/aggs_service.ts" + "pluginId": "dataViews", + "scope": "public", + "docId": "kibDataViewsPluginApi", + "section": "def-public.SavedObjectsClientPublicToCommon", + "text": "SavedObjectsClientPublicToCommon" }, + " implements ", { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/aggs_service.ts" - }, + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.SavedObjectsClientCommon", + "text": "SavedObjectsClientCommon" + } + ], + "path": "src/plugins/data_views/public/saved_objects_client_wrapper.ts", + "deprecated": false, + "children": [ { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/aggs_service.ts" + "parentPluginId": "dataViews", + "id": "def-public.SavedObjectsClientPublicToCommon.Unnamed", + "type": "Function", + "tags": [], + "label": "Constructor", + "description": [], + "signature": [ + "any" + ], + "path": "src/plugins/data_views/public/saved_objects_client_wrapper.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-public.SavedObjectsClientPublicToCommon.Unnamed.$1", + "type": "Object", + "tags": [], + "label": "savedObjectClient", + "description": [], + "signature": [ + "SOClient" + ], + "path": "src/plugins/data_views/public/saved_objects_client_wrapper.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { - "plugin": "data", - "path": "src/plugins/data/server/index.ts" + "parentPluginId": "dataViews", + "id": "def-public.SavedObjectsClientPublicToCommon.find", + "type": "Function", + "tags": [], + "label": "find", + "description": [], + "signature": [ + "(options: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.SavedObjectsClientCommonFindArgs", + "text": "SavedObjectsClientCommonFindArgs" + }, + ") => Promise<", + "SavedObject", + "[]>" + ], + "path": "src/plugins/data_views/public/saved_objects_client_wrapper.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-public.SavedObjectsClientPublicToCommon.find.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.SavedObjectsClientCommonFindArgs", + "text": "SavedObjectsClientCommonFindArgs" + } + ], + "path": "src/plugins/data_views/public/saved_objects_client_wrapper.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { - "plugin": "discover", - "path": "src/plugins/discover/public/application/view_alert/view_alert_route.tsx" + "parentPluginId": "dataViews", + "id": "def-public.SavedObjectsClientPublicToCommon.get", + "type": "Function", + "tags": [], + "label": "get", + "description": [], + "signature": [ + "(type: string, id: string) => Promise<", + "SavedObject", + ">" + ], + "path": "src/plugins/data_views/public/saved_objects_client_wrapper.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-public.SavedObjectsClientPublicToCommon.get.$1", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/public/saved_objects_client_wrapper.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "dataViews", + "id": "def-public.SavedObjectsClientPublicToCommon.get.$2", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/public/saved_objects_client_wrapper.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { - "plugin": "discover", - "path": "src/plugins/discover/public/application/view_alert/view_alert_route.tsx" - }, - { - "plugin": "ux", - "path": "x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_filters.tsx" - }, - { - "plugin": "ux", - "path": "x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_filters.tsx" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/agg_config.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/agg_config.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/agg_config.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/agg_config.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/agg_configs.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/agg_configs.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.test.ts" + "parentPluginId": "dataViews", + "id": "def-public.SavedObjectsClientPublicToCommon.update", + "type": "Function", + "tags": [], + "label": "update", + "description": [], + "signature": [ + "(type: string, id: string, attributes: Record, options: Record) => Promise<", + "SavedObject", + ">" + ], + "path": "src/plugins/data_views/public/saved_objects_client_wrapper.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-public.SavedObjectsClientPublicToCommon.update.$1", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/public/saved_objects_client_wrapper.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "dataViews", + "id": "def-public.SavedObjectsClientPublicToCommon.update.$2", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/public/saved_objects_client_wrapper.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "dataViews", + "id": "def-public.SavedObjectsClientPublicToCommon.update.$3", + "type": "Object", + "tags": [], + "label": "attributes", + "description": [], + "signature": [ + "Record" + ], + "path": "src/plugins/data_views/public/saved_objects_client_wrapper.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "dataViews", + "id": "def-public.SavedObjectsClientPublicToCommon.update.$4", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "Record" + ], + "path": "src/plugins/data_views/public/saved_objects_client_wrapper.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.test.ts" + "parentPluginId": "dataViews", + "id": "def-public.SavedObjectsClientPublicToCommon.create", + "type": "Function", + "tags": [], + "label": "create", + "description": [], + "signature": [ + "(type: string, attributes: Record, options: Record) => Promise<", + "SavedObject", + ">" + ], + "path": "src/plugins/data_views/public/saved_objects_client_wrapper.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-public.SavedObjectsClientPublicToCommon.create.$1", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/public/saved_objects_client_wrapper.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "dataViews", + "id": "def-public.SavedObjectsClientPublicToCommon.create.$2", + "type": "Object", + "tags": [], + "label": "attributes", + "description": [], + "signature": [ + "Record" + ], + "path": "src/plugins/data_views/public/saved_objects_client_wrapper.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "dataViews", + "id": "def-public.SavedObjectsClientPublicToCommon.create.$3", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "Record" + ], + "path": "src/plugins/data_views/public/saved_objects_client_wrapper.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.test.ts" - }, + "parentPluginId": "dataViews", + "id": "def-public.SavedObjectsClientPublicToCommon.delete", + "type": "Function", + "tags": [], + "label": "delete", + "description": [], + "signature": [ + "(type: string, id: string) => Promise<{}>" + ], + "path": "src/plugins/data_views/public/saved_objects_client_wrapper.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-public.SavedObjectsClientPublicToCommon.delete.$1", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/public/saved_objects_client_wrapper.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "dataViews", + "id": "def-public.SavedObjectsClientPublicToCommon.delete.$2", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/public/saved_objects_client_wrapper.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "dataViews", + "id": "def-public.UiSettingsPublicToCommon", + "type": "Class", + "tags": [], + "label": "UiSettingsPublicToCommon", + "description": [], + "signature": [ { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.test.ts" + "pluginId": "dataViews", + "scope": "public", + "docId": "kibDataViewsPluginApi", + "section": "def-public.UiSettingsPublicToCommon", + "text": "UiSettingsPublicToCommon" }, + " implements ", { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.test.ts" - }, + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.UiSettingsCommon", + "text": "UiSettingsCommon" + } + ], + "path": "src/plugins/data_views/public/ui_settings_wrapper.ts", + "deprecated": false, + "children": [ { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.test.ts" + "parentPluginId": "dataViews", + "id": "def-public.UiSettingsPublicToCommon.Unnamed", + "type": "Function", + "tags": [], + "label": "Constructor", + "description": [], + "signature": [ + "any" + ], + "path": "src/plugins/data_views/public/ui_settings_wrapper.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-public.UiSettingsPublicToCommon.Unnamed.$1", + "type": "Object", + "tags": [], + "label": "uiSettings", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.IUiSettingsClient", + "text": "IUiSettingsClient" + } + ], + "path": "src/plugins/data_views/public/ui_settings_wrapper.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.test.ts" + "parentPluginId": "dataViews", + "id": "def-public.UiSettingsPublicToCommon.get", + "type": "Function", + "tags": [], + "label": "get", + "description": [], + "signature": [ + "(key: string) => Promise" + ], + "path": "src/plugins/data_views/public/ui_settings_wrapper.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-public.UiSettingsPublicToCommon.get.$1", + "type": "string", + "tags": [], + "label": "key", + "description": [], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/public/ui_settings_wrapper.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.test.ts" + "parentPluginId": "dataViews", + "id": "def-public.UiSettingsPublicToCommon.getAll", + "type": "Function", + "tags": [], + "label": "getAll", + "description": [], + "signature": [ + "() => Promise>>" + ], + "path": "src/plugins/data_views/public/ui_settings_wrapper.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.test.ts" + "parentPluginId": "dataViews", + "id": "def-public.UiSettingsPublicToCommon.set", + "type": "Function", + "tags": [], + "label": "set", + "description": [], + "signature": [ + "(key: string, value: any) => Promise" + ], + "path": "src/plugins/data_views/public/ui_settings_wrapper.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-public.UiSettingsPublicToCommon.set.$1", + "type": "string", + "tags": [], + "label": "key", + "description": [], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/public/ui_settings_wrapper.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "dataViews", + "id": "def-public.UiSettingsPublicToCommon.set.$2", + "type": "Any", + "tags": [], + "label": "value", + "description": [], + "signature": [ + "any" + ], + "path": "src/plugins/data_views/public/ui_settings_wrapper.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.test.ts" - }, + "parentPluginId": "dataViews", + "id": "def-public.UiSettingsPublicToCommon.remove", + "type": "Function", + "tags": [], + "label": "remove", + "description": [], + "signature": [ + "(key: string) => Promise" + ], + "path": "src/plugins/data_views/public/ui_settings_wrapper.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-public.UiSettingsPublicToCommon.remove.$1", + "type": "string", + "tags": [], + "label": "key", + "description": [], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/public/ui_settings_wrapper.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + } + ], + "functions": [ + { + "parentPluginId": "dataViews", + "id": "def-public.getFieldSubtypeMulti", + "type": "Function", + "tags": [], + "label": "getFieldSubtypeMulti", + "description": [], + "signature": [ + "(field: HasSubtype) => ", + "IFieldSubTypeMulti", + " | undefined" + ], + "path": "src/plugins/data_views/common/fields/utils.ts", + "deprecated": false, + "returnComment": [], + "children": [ { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.test.ts" - }, + "parentPluginId": "dataViews", + "id": "def-public.getFieldSubtypeMulti.$1", + "type": "Object", + "tags": [], + "label": "field", + "description": [], + "signature": [ + "{ subType?: ", + "IFieldSubType", + " | undefined; }" + ], + "path": "src/plugins/data_views/common/fields/utils.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "dataViews", + "id": "def-public.getFieldSubtypeNested", + "type": "Function", + "tags": [], + "label": "getFieldSubtypeNested", + "description": [], + "signature": [ + "(field: HasSubtype) => ", + "IFieldSubTypeNested", + " | undefined" + ], + "path": "src/plugins/data_views/common/fields/utils.ts", + "deprecated": false, + "returnComment": [], + "children": [ { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.test.ts" - }, + "parentPluginId": "dataViews", + "id": "def-public.getFieldSubtypeNested.$1", + "type": "Object", + "tags": [], + "label": "field", + "description": [], + "signature": [ + "{ subType?: ", + "IFieldSubType", + " | undefined; }" + ], + "path": "src/plugins/data_views/common/fields/utils.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "dataViews", + "id": "def-public.validateDataView", + "type": "Function", + "tags": [], + "label": "validateDataView", + "description": [ + "\nValidate index pattern strings" + ], + "signature": [ + "(indexPattern: string) => { ILLEGAL_CHARACTERS?: string[] | undefined; CONTAINS_SPACES?: boolean | undefined; }" + ], + "path": "src/plugins/data_views/common/lib/validate_data_view.ts", + "deprecated": false, + "children": [ { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.test.ts" - }, + "parentPluginId": "dataViews", + "id": "def-public.validateDataView.$1", + "type": "string", + "tags": [], + "label": "indexPattern", + "description": [ + "string to validate" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/lib/validate_data_view.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [ + "errors object" + ], + "initialIsOpen": false + } + ], + "interfaces": [ + { + "parentPluginId": "dataViews", + "id": "def-public.DataViewAttributes", + "type": "Interface", + "tags": [], + "label": "DataViewAttributes", + "description": [ + "\nInterface for the data view saved object" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "children": [ { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.test.ts" + "parentPluginId": "dataViews", + "id": "def-public.DataViewAttributes.fields", + "type": "string", + "tags": [], + "label": "fields", + "description": [ + "\nFields as a serialized array of field specs" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.test.ts" + "parentPluginId": "dataViews", + "id": "def-public.DataViewAttributes.title", + "type": "string", + "tags": [], + "label": "title", + "description": [ + "\nData view title" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.test.ts" + "parentPluginId": "dataViews", + "id": "def-public.DataViewAttributes.type", + "type": "string", + "tags": [], + "label": "type", + "description": [ + "\nData view type, default or rollup" + ], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.test.ts" + "parentPluginId": "dataViews", + "id": "def-public.DataViewAttributes.typeMeta", + "type": "string", + "tags": [], + "label": "typeMeta", + "description": [ + "\nType metadata information, serialized. Only used by rollup data views." + ], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.test.ts" + "parentPluginId": "dataViews", + "id": "def-public.DataViewAttributes.timeFieldName", + "type": "string", + "tags": [], + "label": "timeFieldName", + "description": [ + "\nTime field name" + ], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.test.ts" + "parentPluginId": "dataViews", + "id": "def-public.DataViewAttributes.sourceFilters", + "type": "string", + "tags": [], + "label": "sourceFilters", + "description": [ + "\nSerialized array of filters. Used by discover to hide fields." + ], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.test.ts" + "parentPluginId": "dataViews", + "id": "def-public.DataViewAttributes.fieldFormatMap", + "type": "string", + "tags": [], + "label": "fieldFormatMap", + "description": [ + "\nSerialized map of field formats by field name" + ], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.test.ts" + "parentPluginId": "dataViews", + "id": "def-public.DataViewAttributes.fieldAttrs", + "type": "string", + "tags": [], + "label": "fieldAttrs", + "description": [ + "\nSerialized map of field attributes, currently field count and name" + ], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.test.ts" + "parentPluginId": "dataViews", + "id": "def-public.DataViewAttributes.runtimeFieldMap", + "type": "string", + "tags": [], + "label": "runtimeFieldMap", + "description": [ + "\nSerialized map of runtime field definitions, by field name" + ], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.test.ts" - }, + "parentPluginId": "dataViews", + "id": "def-public.DataViewAttributes.allowNoIndex", + "type": "CompoundType", + "tags": [], + "label": "allowNoIndex", + "description": [ + "\nPrevents errors when index pattern exists before indices" + ], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "dataViews", + "id": "def-public.DataViewListItem", + "type": "Interface", + "tags": [], + "label": "DataViewListItem", + "description": [ + "\nResult from data view search - summary data." + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.test.ts" + "parentPluginId": "dataViews", + "id": "def-public.DataViewListItem.id", + "type": "string", + "tags": [], + "label": "id", + "description": [ + "\nSaved object id" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false }, { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.test.ts" + "parentPluginId": "dataViews", + "id": "def-public.DataViewListItem.namespaces", + "type": "Array", + "tags": [], + "label": "namespaces", + "description": [ + "\nNamespace ids" + ], + "signature": [ + "string[] | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false }, { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.test.ts" + "parentPluginId": "dataViews", + "id": "def-public.DataViewListItem.title", + "type": "string", + "tags": [], + "label": "title", + "description": [ + "\nData view title" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false }, { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.test.ts" + "parentPluginId": "dataViews", + "id": "def-public.DataViewListItem.type", + "type": "string", + "tags": [], + "label": "type", + "description": [ + "\nData view type" + ], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false }, { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.test.ts" - }, + "parentPluginId": "dataViews", + "id": "def-public.DataViewListItem.typeMeta", + "type": "Object", + "tags": [], + "label": "typeMeta", + "description": [ + "\nData view type meta" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.TypeMeta", + "text": "TypeMeta" + }, + " | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "dataViews", + "id": "def-public.DataViewSpec", + "type": "Interface", + "tags": [], + "label": "DataViewSpec", + "description": [ + "\nStatic data view format\nSerialized data object, representing data view attributes and state" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "children": [ { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.test.ts" + "parentPluginId": "dataViews", + "id": "def-public.DataViewSpec.id", + "type": "string", + "tags": [], + "label": "id", + "description": [ + "\nSaved object id" + ], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.test.ts" + "parentPluginId": "dataViews", + "id": "def-public.DataViewSpec.version", + "type": "string", + "tags": [], + "label": "version", + "description": [ + "\nSaved object version string" + ], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.test.ts" + "parentPluginId": "dataViews", + "id": "def-public.DataViewSpec.title", + "type": "string", + "tags": [], + "label": "title", + "description": [ + "\nData view title" + ], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.test.ts" + "parentPluginId": "dataViews", + "id": "def-public.DataViewSpec.timeFieldName", + "type": "string", + "tags": [], + "label": "timeFieldName", + "description": [ + "\nName of timestamp field" + ], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, { - "plugin": "data", - "path": "src/plugins/data/common/search/tabify/tabify.test.ts" + "parentPluginId": "dataViews", + "id": "def-public.DataViewSpec.sourceFilters", + "type": "Array", + "tags": [], + "label": "sourceFilters", + "description": [ + "\nList of filters which discover uses to hide fields" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.SourceFilter", + "text": "SourceFilter" + }, + "[] | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, { - "plugin": "data", - "path": "src/plugins/data/common/search/tabify/tabify.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/tabify/tabify_docs.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/tabify/tabify_docs.test.ts" + "parentPluginId": "dataViews", + "id": "def-public.DataViewSpec.fields", + "type": "Object", + "tags": [], + "label": "fields", + "description": [ + "\nMap of fields by name" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewFieldMap", + "text": "DataViewFieldMap" + }, + " | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/buckets/_terms_other_bucket_helper.test.ts" + "parentPluginId": "dataViews", + "id": "def-public.DataViewSpec.typeMeta", + "type": "Object", + "tags": [], + "label": "typeMeta", + "description": [ + "\nMetadata about data view, only used by rollup data views" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.TypeMeta", + "text": "TypeMeta" + }, + " | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/buckets/_terms_other_bucket_helper.test.ts" + "parentPluginId": "dataViews", + "id": "def-public.DataViewSpec.type", + "type": "string", + "tags": [], + "label": "type", + "description": [ + "\nDefault or rollup" + ], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/buckets/multi_terms.test.ts" + "parentPluginId": "dataViews", + "id": "def-public.DataViewSpec.fieldFormats", + "type": "Object", + "tags": [], + "label": "fieldFormats", + "description": [ + "\nMap of serialized field formats by field name" + ], + "signature": [ + "Record> | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/buckets/multi_terms.test.ts" + "parentPluginId": "dataViews", + "id": "def-public.DataViewSpec.runtimeFieldMap", + "type": "Object", + "tags": [], + "label": "runtimeFieldMap", + "description": [ + "\nMap of runtime fields by field name" + ], + "signature": [ + "Record | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/buckets/multi_terms.test.ts" + "parentPluginId": "dataViews", + "id": "def-public.DataViewSpec.fieldAttrs", + "type": "Object", + "tags": [], + "label": "fieldAttrs", + "description": [ + "\nMap of field attributes by field name, currently customName and count" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldAttrs", + "text": "FieldAttrs" + }, + " | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/buckets/rare_terms.test.ts" + "parentPluginId": "dataViews", + "id": "def-public.DataViewSpec.allowNoIndex", + "type": "CompoundType", + "tags": [], + "label": "allowNoIndex", + "description": [ + "\nDetermines whether failure to load field list should be reported as error" + ], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/buckets/rare_terms.test.ts" - }, + "parentPluginId": "dataViews", + "id": "def-public.DataViewSpec.namespaces", + "type": "Array", + "tags": [], + "label": "namespaces", + "description": [ + "\nArray of namespace ids" + ], + "signature": [ + "string[] | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "dataViews", + "id": "def-public.DataViewsPublicSetupDependencies", + "type": "Interface", + "tags": [], + "label": "DataViewsPublicSetupDependencies", + "description": [ + "\nData views public setup dependencies" + ], + "path": "src/plugins/data_views/public/types.ts", + "deprecated": false, + "children": [ { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/buckets/terms.test.ts" + "parentPluginId": "dataViews", + "id": "def-public.DataViewsPublicSetupDependencies.expressions", + "type": "Object", + "tags": [], + "label": "expressions", + "description": [ + "\nExpressions" + ], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionsServiceSetup", + "text": "ExpressionsServiceSetup" + } + ], + "path": "src/plugins/data_views/public/types.ts", + "deprecated": false }, { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/buckets/terms.test.ts" - }, + "parentPluginId": "dataViews", + "id": "def-public.DataViewsPublicSetupDependencies.fieldFormats", + "type": "Object", + "tags": [], + "label": "fieldFormats", + "description": [ + "\nField formats" + ], + "signature": [ + "{ register: (fieldFormats: ", + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.FieldFormatInstanceType", + "text": "FieldFormatInstanceType" + }, + "[]) => void; has: (id: string) => boolean; }" + ], + "path": "src/plugins/data_views/public/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "dataViews", + "id": "def-public.DataViewsPublicStartDependencies", + "type": "Interface", + "tags": [], + "label": "DataViewsPublicStartDependencies", + "description": [ + "\nData views public start dependencies" + ], + "path": "src/plugins/data_views/public/types.ts", + "deprecated": false, + "children": [ { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/buckets/terms.test.ts" - }, + "parentPluginId": "dataViews", + "id": "def-public.DataViewsPublicStartDependencies.fieldFormats", + "type": "CompoundType", + "tags": [], + "label": "fieldFormats", + "description": [ + "\nField formats" + ], + "signature": [ + "Omit<", + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.FieldFormatsRegistry", + "text": "FieldFormatsRegistry" + }, + ", \"init\" | \"register\"> & { deserialize: ", + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.FormatFactory", + "text": "FormatFactory" + }, + "; }" + ], + "path": "src/plugins/data_views/public/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "dataViews", + "id": "def-public.DataViewsServicePublicDeps", + "type": "Interface", + "tags": [], + "label": "DataViewsServicePublicDeps", + "description": [ + "\nData Views public service dependencies" + ], + "signature": [ { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/utils/infer_time_zone.test.ts" + "pluginId": "dataViews", + "scope": "public", + "docId": "kibDataViewsPluginApi", + "section": "def-public.DataViewsServicePublicDeps", + "text": "DataViewsServicePublicDeps" }, + " extends ", { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/utils/infer_time_zone.test.ts" - }, + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewsServiceDeps", + "text": "DataViewsServiceDeps" + } + ], + "path": "src/plugins/data_views/public/data_views_service_public.ts", + "deprecated": false, + "children": [ { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/utils/infer_time_zone.test.ts" + "parentPluginId": "dataViews", + "id": "def-public.DataViewsServicePublicDeps.getCanSaveSync", + "type": "Function", + "tags": [], + "label": "getCanSaveSync", + "description": [ + "\nGet can user save data view - sync version" + ], + "signature": [ + "() => boolean" + ], + "path": "src/plugins/data_views/public/data_views_service_public.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/utils/infer_time_zone.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/utils/infer_time_zone.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/utils/infer_time_zone.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/expressions/esaggs/request_handler.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/expressions/esaggs/request_handler.test.ts" - }, - { - "plugin": "ux", - "path": "x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_wildcards.tsx" - }, - { - "plugin": "ux", - "path": "x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_wildcards.tsx" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/index.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/search/errors/painless_error.tsx" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/search/errors/painless_error.tsx" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/search/errors/painless_error.tsx" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/query/query_service.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/query/query_service.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/query/query_service.ts" - }, - { - "plugin": "savedObjects", - "path": "src/plugins/saved_objects/public/types.ts" - }, - { - "plugin": "savedObjects", - "path": "src/plugins/saved_objects/public/types.ts" - }, - { - "plugin": "savedObjects", - "path": "src/plugins/saved_objects/public/types.ts" - }, - { - "plugin": "savedObjects", - "path": "src/plugins/saved_objects/public/saved_object/helpers/apply_es_resp.ts" - }, - { - "plugin": "savedObjects", - "path": "src/plugins/saved_objects/public/saved_object/helpers/apply_es_resp.ts" - }, - { - "plugin": "dataViewEditor", - "path": "src/plugins/data_view_editor/public/shared_imports.ts" - }, - { - "plugin": "dataViewEditor", - "path": "src/plugins/data_view_editor/public/open_editor.tsx" - }, - { - "plugin": "dataViewEditor", - "path": "src/plugins/data_view_editor/public/open_editor.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/fields/agg/percentile_agg_field.test.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/fields/agg/percentile_agg_field.test.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/agg_filters/agg_type_filters.ts" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/agg_filters/agg_type_filters.ts" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/agg_filters/agg_type_filters.ts" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/utils/editor_config.ts" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/utils/editor_config.ts" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.ts" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.ts" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_select.tsx" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_select.tsx" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_params.tsx" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_params.tsx" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.test.ts" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.test.ts" + "parentPluginId": "dataViews", + "id": "def-public.DataViewsServicePublicDeps.hasData", + "type": "Object", + "tags": [], + "label": "hasData", + "description": [ + "\nHas data service" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.HasDataService", + "text": "HasDataService" + } + ], + "path": "src/plugins/data_views/public/data_views_service_public.ts", + "deprecated": false } ], - "children": [], "initialIsOpen": false }, { "parentPluginId": "dataViews", - "id": "def-public.IndexPatternField", - "type": "Class", - "tags": [ - "deprecated" + "id": "def-public.FieldSpec", + "type": "Interface", + "tags": [], + "label": "FieldSpec", + "description": [ + "\nSerialized version of DataViewField" ], - "label": "IndexPatternField", - "description": [], "signature": [ { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.IndexPatternField", - "text": "IndexPatternField" + "section": "def-common.FieldSpec", + "text": "FieldSpec" }, " extends ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" - } + "DataViewFieldBase" ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": true, - "references": [ - { - "plugin": "data", - "path": "src/plugins/data/public/index.ts" - }, - { - "plugin": "dataViewEditor", - "path": "src/plugins/data_view_editor/public/shared_imports.ts" - }, - { - "plugin": "dataViewEditor", - "path": "src/plugins/data_view_editor/public/lib/extract_time_fields.ts" - }, - { - "plugin": "dataViewEditor", - "path": "src/plugins/data_view_editor/public/lib/extract_time_fields.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" - }, + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "children": [ { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" + "parentPluginId": "dataViews", + "id": "def-public.FieldSpec.count", + "type": "number", + "tags": [], + "label": "count", + "description": [ + "\nPopularity count is used by discover" + ], + "signature": [ + "number | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" + "parentPluginId": "dataViews", + "id": "def-public.FieldSpec.conflictDescriptions", + "type": "Object", + "tags": [], + "label": "conflictDescriptions", + "description": [ + "\nDescription of field type conflicts across indices" + ], + "signature": [ + "Record | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" + "parentPluginId": "dataViews", + "id": "def-public.FieldSpec.format", + "type": "Object", + "tags": [], + "label": "format", + "description": [ + "\nField formatting in serialized format" + ], + "signature": [ + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.SerializedFieldFormat", + "text": "SerializedFieldFormat" + }, + "<", + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.FieldFormatParams", + "text": "FieldFormatParams" + }, + "> | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" + "parentPluginId": "dataViews", + "id": "def-public.FieldSpec.esTypes", + "type": "Array", + "tags": [], + "label": "esTypes", + "description": [ + "\nElasticsearch field types used by backing indices" + ], + "signature": [ + "string[] | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" + "parentPluginId": "dataViews", + "id": "def-public.FieldSpec.searchable", + "type": "boolean", + "tags": [], + "label": "searchable", + "description": [ + "\nTrue if field is searchable" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" + "parentPluginId": "dataViews", + "id": "def-public.FieldSpec.aggregatable", + "type": "boolean", + "tags": [], + "label": "aggregatable", + "description": [ + "\nTrue if field is aggregatable" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" + "parentPluginId": "dataViews", + "id": "def-public.FieldSpec.readFromDocValues", + "type": "CompoundType", + "tags": [], + "label": "readFromDocValues", + "description": [ + "\nTrue if can be read from doc values" + ], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" + "parentPluginId": "dataViews", + "id": "def-public.FieldSpec.indexed", + "type": "CompoundType", + "tags": [], + "label": "indexed", + "description": [ + "\nTrue if field is indexed" + ], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" + "parentPluginId": "dataViews", + "id": "def-public.FieldSpec.customLabel", + "type": "string", + "tags": [], + "label": "customLabel", + "description": [ + "\nCustom label for field, used for display in kibana" + ], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/metrics_editor/metric_editor.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/metrics_editor/metric_editor.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/metrics_editor/metric_editor.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/fields/es_doc_field.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/fields/es_doc_field.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/metrics_editor/metrics_editor.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/metrics_editor/metrics_editor.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_geo_grid_source/update_source_editor.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_geo_grid_source/update_source_editor.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/top_hits/top_hits_form.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/top_hits/top_hits_form.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/top_hits/top_hits_form.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/top_hits/update_source_editor.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/top_hits/update_source_editor.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/top_hits/update_source_editor.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/geo_field_select.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/geo_field_select.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/connected_components/edit_layer_panel/join_editor/resources/join_expression.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/connected_components/edit_layer_panel/join_editor/resources/join_expression.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/connected_components/edit_layer_panel/join_editor/resources/metrics_expression.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/connected_components/edit_layer_panel/join_editor/resources/metrics_expression.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/index_pattern_util.test.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/index_pattern_util.test.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/index_pattern_util.test.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/index_pattern_util.test.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/index_pattern_util.test.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/index_pattern_util.test.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/agg_filters/agg_type_field_filters.ts" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/agg_filters/agg_type_field_filters.ts" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/agg_filters/agg_type_field_filters.ts" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_param_props.ts" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_param_props.ts" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/controls/field.tsx" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/controls/field.tsx" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/controls/field.tsx" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/controls/field.tsx" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/controls/top_field.tsx" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/controls/top_field.tsx" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/controls/top_sort_field.tsx" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/controls/top_sort_field.tsx" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.ts" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.ts" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.ts" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.ts" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.ts" - }, - { - "plugin": "dataViewEditor", - "path": "src/plugins/data_view_editor/public/lib/extract_time_fields.test.ts" - }, - { - "plugin": "dataViewEditor", - "path": "src/plugins/data_view_editor/public/lib/extract_time_fields.test.ts" - }, - { - "plugin": "dataViewEditor", - "path": "src/plugins/data_view_editor/public/lib/extract_time_fields.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/index.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/server/index.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/agg_config.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/agg_config.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/buckets/_terms_other_bucket_helper.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/buckets/_terms_other_bucket_helper.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/buckets/multi_terms.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/buckets/multi_terms.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/buckets/multi_terms.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/buckets/rare_terms.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/buckets/rare_terms.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/buckets/terms.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/buckets/terms.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/buckets/terms.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/utils/infer_time_zone.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/utils/infer_time_zone.test.ts" + "parentPluginId": "dataViews", + "id": "def-public.FieldSpec.runtimeField", + "type": "Object", + "tags": [], + "label": "runtimeField", + "description": [ + "\nRuntime field definition" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.RuntimeFieldSpec", + "text": "RuntimeFieldSpec" + }, + " | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/param_types/field.ts" + "parentPluginId": "dataViews", + "id": "def-public.FieldSpec.shortDotsEnable", + "type": "CompoundType", + "tags": [], + "label": "shortDotsEnable", + "description": [ + "\nWhether short dots are enabled, based on uiSettings." + ], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/param_types/field.ts" - }, + "parentPluginId": "dataViews", + "id": "def-public.FieldSpec.isMapped", + "type": "CompoundType", + "tags": [], + "label": "isMapped", + "description": [ + "\nIs this field in the mapping? False if a scripted or runtime field defined on the data view." + ], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "dataViews", + "id": "def-public.HasDataViewsResponse", + "type": "Interface", + "tags": [], + "label": "HasDataViewsResponse", + "description": [], + "path": "src/plugins/data_views/public/types.ts", + "deprecated": false, + "children": [ { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/param_types/field.ts" + "parentPluginId": "dataViews", + "id": "def-public.HasDataViewsResponse.hasDataView", + "type": "boolean", + "tags": [], + "label": "hasDataView", + "description": [], + "path": "src/plugins/data_views/public/types.ts", + "deprecated": false }, { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/param_types/field.ts" + "parentPluginId": "dataViews", + "id": "def-public.HasDataViewsResponse.hasUserDataView", + "type": "boolean", + "tags": [], + "label": "hasUserDataView", + "description": [], + "path": "src/plugins/data_views/public/types.ts", + "deprecated": false } ], - "children": [], "initialIsOpen": false }, { "parentPluginId": "dataViews", - "id": "def-public.IndexPatternsService", - "type": "Class", - "tags": [ - "deprecated" + "id": "def-public.IIndexPatternFieldList", + "type": "Interface", + "tags": [], + "label": "IIndexPatternFieldList", + "description": [ + "\nInterface for data view field list which _extends_ the array class." ], - "label": "IndexPatternsService", - "description": [], "signature": [ { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.IndexPatternsService", - "text": "IndexPatternsService" + "section": "def-common.IIndexPatternFieldList", + "text": "IIndexPatternFieldList" }, " extends ", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewsService", - "text": "DataViewsService" - } - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": true, - "references": [ - { - "plugin": "data", - "path": "src/plugins/data/common/index.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/server/index.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/server/index.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/server/index.ts" + "section": "def-common.DataViewField", + "text": "DataViewField" }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/server/data_indexing/create_doc_source.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/server/data_indexing/create_doc_source.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/index.ts" - } - ], - "children": [], - "initialIsOpen": false - }, - { - "parentPluginId": "dataViews", - "id": "def-public.SavedObjectsClientPublicToCommon", - "type": "Class", - "tags": [], - "label": "SavedObjectsClientPublicToCommon", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "public", - "docId": "kibDataViewsPluginApi", - "section": "def-public.SavedObjectsClientPublicToCommon", - "text": "SavedObjectsClientPublicToCommon" - }, - " implements ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.SavedObjectsClientCommon", - "text": "SavedObjectsClientCommon" - } - ], - "path": "src/plugins/data_views/public/saved_objects_client_wrapper.ts", - "deprecated": false, - "children": [ + "[]" + ], + "path": "src/plugins/data_views/common/fields/field_list.ts", + "deprecated": false, + "children": [ { "parentPluginId": "dataViews", - "id": "def-public.SavedObjectsClientPublicToCommon.Unnamed", + "id": "def-public.IIndexPatternFieldList.add", "type": "Function", "tags": [], - "label": "Constructor", - "description": [], + "label": "add", + "description": [ + "\nAdd field to field list." + ], "signature": [ - "any" + "(field: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + ") => ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewField", + "text": "DataViewField" + } ], - "path": "src/plugins/data_views/public/saved_objects_client_wrapper.ts", + "path": "src/plugins/data_views/common/fields/field_list.ts", "deprecated": false, "children": [ { "parentPluginId": "dataViews", - "id": "def-public.SavedObjectsClientPublicToCommon.Unnamed.$1", + "id": "def-public.IIndexPatternFieldList.add.$1", "type": "Object", "tags": [], - "label": "savedObjectClient", - "description": [], + "label": "field", + "description": [ + "field spec to add field to list" + ], "signature": [ - "SOClient" + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + } ], - "path": "src/plugins/data_views/public/saved_objects_client_wrapper.ts", + "path": "src/plugins/data_views/common/fields/field_list.ts", "deprecated": false, "isRequired": true } ], - "returnComment": [] + "returnComment": [ + "data view field instance which was added to list" + ] }, { "parentPluginId": "dataViews", - "id": "def-public.SavedObjectsClientPublicToCommon.find", + "id": "def-public.IIndexPatternFieldList.getAll", "type": "Function", "tags": [], - "label": "find", - "description": [], + "label": "getAll", + "description": [ + "\nReturns fields as plain array of data view field instances." + ], "signature": [ - "(options: ", + "() => ", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.SavedObjectsClientCommonFindArgs", - "text": "SavedObjectsClientCommonFindArgs" + "section": "def-common.DataViewField", + "text": "DataViewField" }, - ") => Promise<", - "SavedObject", - "[]>" + "[]" ], - "path": "src/plugins/data_views/public/saved_objects_client_wrapper.ts", + "path": "src/plugins/data_views/common/fields/field_list.ts", "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-public.SavedObjectsClientPublicToCommon.find.$1", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.SavedObjectsClientCommonFindArgs", - "text": "SavedObjectsClientCommonFindArgs" - } - ], - "path": "src/plugins/data_views/public/saved_objects_client_wrapper.ts", - "deprecated": false, - "isRequired": true - } - ], + "children": [], "returnComment": [] }, { "parentPluginId": "dataViews", - "id": "def-public.SavedObjectsClientPublicToCommon.get", + "id": "def-public.IIndexPatternFieldList.getByName", "type": "Function", "tags": [], - "label": "get", - "description": [], + "label": "getByName", + "description": [ + "\nGet field by name. Optimized, uses map to find field." + ], "signature": [ - "(type: string, id: string) => Promise<", - "SavedObject", - ">" + "(name: string) => ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewField", + "text": "DataViewField" + }, + " | undefined" ], - "path": "src/plugins/data_views/public/saved_objects_client_wrapper.ts", + "path": "src/plugins/data_views/common/fields/field_list.ts", "deprecated": false, "children": [ { "parentPluginId": "dataViews", - "id": "def-public.SavedObjectsClientPublicToCommon.get.$1", + "id": "def-public.IIndexPatternFieldList.getByName.$1", "type": "string", "tags": [], - "label": "type", - "description": [], - "signature": [ - "string" + "label": "name", + "description": [ + "name of field to find" ], - "path": "src/plugins/data_views/public/saved_objects_client_wrapper.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "dataViews", - "id": "def-public.SavedObjectsClientPublicToCommon.get.$2", - "type": "string", - "tags": [], - "label": "id", - "description": [], "signature": [ "string" ], - "path": "src/plugins/data_views/public/saved_objects_client_wrapper.ts", + "path": "src/plugins/data_views/common/fields/field_list.ts", "deprecated": false, "isRequired": true } ], - "returnComment": [] + "returnComment": [ + "data view field instance if found, undefined otherwise" + ] }, { "parentPluginId": "dataViews", - "id": "def-public.SavedObjectsClientPublicToCommon.update", + "id": "def-public.IIndexPatternFieldList.getByType", "type": "Function", "tags": [], - "label": "update", - "description": [], + "label": "getByType", + "description": [ + "\nGet fields by field type. Optimized, uses map to find fields." + ], "signature": [ - "(type: string, id: string, attributes: Record, options: Record) => Promise<", - "SavedObject", - ">" + "(type: string) => ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewField", + "text": "DataViewField" + }, + "[]" ], - "path": "src/plugins/data_views/public/saved_objects_client_wrapper.ts", + "path": "src/plugins/data_views/common/fields/field_list.ts", "deprecated": false, "children": [ { "parentPluginId": "dataViews", - "id": "def-public.SavedObjectsClientPublicToCommon.update.$1", + "id": "def-public.IIndexPatternFieldList.getByType.$1", "type": "string", "tags": [], "label": "type", - "description": [], - "signature": [ - "string" + "description": [ + "type of field to find" ], - "path": "src/plugins/data_views/public/saved_objects_client_wrapper.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "dataViews", - "id": "def-public.SavedObjectsClientPublicToCommon.update.$2", - "type": "string", - "tags": [], - "label": "id", - "description": [], "signature": [ "string" ], - "path": "src/plugins/data_views/public/saved_objects_client_wrapper.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "dataViews", - "id": "def-public.SavedObjectsClientPublicToCommon.update.$3", - "type": "Object", - "tags": [], - "label": "attributes", - "description": [], - "signature": [ - "Record" - ], - "path": "src/plugins/data_views/public/saved_objects_client_wrapper.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "dataViews", - "id": "def-public.SavedObjectsClientPublicToCommon.update.$4", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - "Record" - ], - "path": "src/plugins/data_views/public/saved_objects_client_wrapper.ts", + "path": "src/plugins/data_views/common/fields/field_list.ts", "deprecated": false, "isRequired": true } ], - "returnComment": [] + "returnComment": [ + "array of data view field instances if found, empty array otherwise" + ] }, { "parentPluginId": "dataViews", - "id": "def-public.SavedObjectsClientPublicToCommon.create", + "id": "def-public.IIndexPatternFieldList.remove", "type": "Function", "tags": [], - "label": "create", - "description": [], - "signature": [ - "(type: string, attributes: Record, options: Record) => Promise<", - "SavedObject", - ">" + "label": "remove", + "description": [ + "\nRemove field from field list" ], - "path": "src/plugins/data_views/public/saved_objects_client_wrapper.ts", - "deprecated": false, - "children": [ + "signature": [ + "(field: ", { - "parentPluginId": "dataViews", - "id": "def-public.SavedObjectsClientPublicToCommon.create.$1", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/public/saved_objects_client_wrapper.ts", - "deprecated": false, - "isRequired": true + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewField", + "text": "DataViewField" }, + " | ", { - "parentPluginId": "dataViews", - "id": "def-public.SavedObjectsClientPublicToCommon.create.$2", - "type": "Object", - "tags": [], - "label": "attributes", - "description": [], - "signature": [ - "Record" - ], - "path": "src/plugins/data_views/public/saved_objects_client_wrapper.ts", - "deprecated": false, - "isRequired": true + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" }, + ") => void" + ], + "path": "src/plugins/data_views/common/fields/field_list.ts", + "deprecated": false, + "children": [ { "parentPluginId": "dataViews", - "id": "def-public.SavedObjectsClientPublicToCommon.create.$3", - "type": "Object", + "id": "def-public.IIndexPatternFieldList.remove.$1", + "type": "CompoundType", "tags": [], - "label": "options", - "description": [], + "label": "field", + "description": [ + "field for removal" + ], "signature": [ - "Record" + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewField", + "text": "DataViewField" + }, + " | ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + } ], - "path": "src/plugins/data_views/public/saved_objects_client_wrapper.ts", + "path": "src/plugins/data_views/common/fields/field_list.ts", "deprecated": false, "isRequired": true } @@ -4962,108 +5703,112 @@ }, { "parentPluginId": "dataViews", - "id": "def-public.SavedObjectsClientPublicToCommon.delete", + "id": "def-public.IIndexPatternFieldList.removeAll", "type": "Function", "tags": [], - "label": "delete", - "description": [], + "label": "removeAll", + "description": [ + "\nRemove all fields from field list." + ], "signature": [ - "(type: string, id: string) => Promise<{}>" + "() => void" ], - "path": "src/plugins/data_views/public/saved_objects_client_wrapper.ts", + "path": "src/plugins/data_views/common/fields/field_list.ts", "deprecated": false, - "children": [ + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "dataViews", + "id": "def-public.IIndexPatternFieldList.replaceAll", + "type": "Function", + "tags": [], + "label": "replaceAll", + "description": [ + "\nReplace all fields in field list with new fields." + ], + "signature": [ + "(specs: ", { - "parentPluginId": "dataViews", - "id": "def-public.SavedObjectsClientPublicToCommon.delete.$1", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/public/saved_objects_client_wrapper.ts", - "deprecated": false, - "isRequired": true + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" }, + "[]) => void" + ], + "path": "src/plugins/data_views/common/fields/field_list.ts", + "deprecated": false, + "children": [ { "parentPluginId": "dataViews", - "id": "def-public.SavedObjectsClientPublicToCommon.delete.$2", - "type": "string", + "id": "def-public.IIndexPatternFieldList.replaceAll.$1", + "type": "Array", "tags": [], - "label": "id", - "description": [], + "label": "specs", + "description": [ + "array of field specs to add to list" + ], "signature": [ - "string" + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + "[]" ], - "path": "src/plugins/data_views/public/saved_objects_client_wrapper.ts", + "path": "src/plugins/data_views/common/fields/field_list.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "dataViews", - "id": "def-public.UiSettingsPublicToCommon", - "type": "Class", - "tags": [], - "label": "UiSettingsPublicToCommon", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "public", - "docId": "kibDataViewsPluginApi", - "section": "def-public.UiSettingsPublicToCommon", - "text": "UiSettingsPublicToCommon" }, - " implements ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.UiSettingsCommon", - "text": "UiSettingsCommon" - } - ], - "path": "src/plugins/data_views/public/ui_settings_wrapper.ts", - "deprecated": false, - "children": [ { "parentPluginId": "dataViews", - "id": "def-public.UiSettingsPublicToCommon.Unnamed", + "id": "def-public.IIndexPatternFieldList.update", "type": "Function", "tags": [], - "label": "Constructor", - "description": [], + "label": "update", + "description": [ + "\nUpdate a field in the list" + ], "signature": [ - "any" + "(field: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + ") => void" ], - "path": "src/plugins/data_views/public/ui_settings_wrapper.ts", + "path": "src/plugins/data_views/common/fields/field_list.ts", "deprecated": false, "children": [ { "parentPluginId": "dataViews", - "id": "def-public.UiSettingsPublicToCommon.Unnamed.$1", + "id": "def-public.IIndexPatternFieldList.update.$1", "type": "Object", "tags": [], - "label": "uiSettings", - "description": [], + "label": "field", + "description": [ + "field spec to update" + ], "signature": [ { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.IUiSettingsClient", - "text": "IUiSettingsClient" + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" } ], - "path": "src/plugins/data_views/public/ui_settings_wrapper.ts", + "path": "src/plugins/data_views/common/fields/field_list.ts", "deprecated": false, "isRequired": true } @@ -5072,91 +5817,183 @@ }, { "parentPluginId": "dataViews", - "id": "def-public.UiSettingsPublicToCommon.get", + "id": "def-public.IIndexPatternFieldList.toSpec", "type": "Function", - "tags": [], - "label": "get", - "description": [], + "tags": [ + "return" + ], + "label": "toSpec", + "description": [ + "\nField list as field spec map by name" + ], "signature": [ - "(key: string) => Promise" + "(options?: ToSpecOptions | undefined) => ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewFieldMap", + "text": "DataViewFieldMap" + } ], - "path": "src/plugins/data_views/public/ui_settings_wrapper.ts", + "path": "src/plugins/data_views/common/fields/field_list.ts", "deprecated": false, "children": [ { "parentPluginId": "dataViews", - "id": "def-public.UiSettingsPublicToCommon.get.$1", - "type": "string", + "id": "def-public.IIndexPatternFieldList.toSpec.$1", + "type": "Object", "tags": [], - "label": "key", - "description": [], + "label": "options", + "description": [ + "optionally provide a function to get field formatter for fields" + ], "signature": [ - "string" + "ToSpecOptions | undefined" ], - "path": "src/plugins/data_views/public/ui_settings_wrapper.ts", + "path": "src/plugins/data_views/common/fields/field_list.ts", "deprecated": false, - "isRequired": true + "isRequired": false } ], - "returnComment": [] - }, + "returnComment": [ + "map of field specs by name" + ] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "dataViews", + "id": "def-public.IndicesViaSearchResponse", + "type": "Interface", + "tags": [], + "label": "IndicesViaSearchResponse", + "description": [], + "path": "src/plugins/data_views/public/types.ts", + "deprecated": false, + "children": [ { "parentPluginId": "dataViews", - "id": "def-public.UiSettingsPublicToCommon.getAll", - "type": "Function", + "id": "def-public.IndicesViaSearchResponse.total", + "type": "number", "tags": [], - "label": "getAll", + "label": "total", "description": [], + "path": "src/plugins/data_views/public/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "dataViews", + "id": "def-public.SavedObjectsClientCommon", + "type": "Interface", + "tags": [], + "label": "SavedObjectsClientCommon", + "description": [ + "\nCommon interface for the saved objects client" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-public.SavedObjectsClientCommon.find", + "type": "Function", + "tags": [], + "label": "find", + "description": [ + "\nSearch for saved objects" + ], "signature": [ - "() => Promise>>" + "(options: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.SavedObjectsClientCommonFindArgs", + "text": "SavedObjectsClientCommonFindArgs" + }, + ") => Promise<", + "SavedObject", + "[]>" ], - "path": "src/plugins/data_views/public/ui_settings_wrapper.ts", + "path": "src/plugins/data_views/common/types.ts", "deprecated": false, - "children": [], + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-public.SavedObjectsClientCommon.find.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [ + "- options for search" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.SavedObjectsClientCommonFindArgs", + "text": "SavedObjectsClientCommonFindArgs" + } + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "isRequired": true + } + ], "returnComment": [] }, { "parentPluginId": "dataViews", - "id": "def-public.UiSettingsPublicToCommon.set", + "id": "def-public.SavedObjectsClientCommon.get", "type": "Function", "tags": [], - "label": "set", - "description": [], + "label": "get", + "description": [ + "\nGet a single saved object by id" + ], "signature": [ - "(key: string, value: any) => Promise" + "(type: string, id: string) => Promise<", + "SavedObject", + ">" ], - "path": "src/plugins/data_views/public/ui_settings_wrapper.ts", + "path": "src/plugins/data_views/common/types.ts", "deprecated": false, "children": [ { "parentPluginId": "dataViews", - "id": "def-public.UiSettingsPublicToCommon.set.$1", + "id": "def-public.SavedObjectsClientCommon.get.$1", "type": "string", "tags": [], - "label": "key", - "description": [], + "label": "type", + "description": [ + "- type of saved object" + ], "signature": [ "string" ], - "path": "src/plugins/data_views/public/ui_settings_wrapper.ts", + "path": "src/plugins/data_views/common/types.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "dataViews", - "id": "def-public.UiSettingsPublicToCommon.set.$2", - "type": "Any", + "id": "def-public.SavedObjectsClientCommon.get.$2", + "type": "string", "tags": [], - "label": "value", - "description": [], + "label": "id", + "description": [ + "- id of saved object" + ], "signature": [ - "any" + "string" ], - "path": "src/plugins/data_views/public/ui_settings_wrapper.ts", + "path": "src/plugins/data_views/common/types.ts", "deprecated": false, "isRequired": true } @@ -5165,461 +6002,506 @@ }, { "parentPluginId": "dataViews", - "id": "def-public.UiSettingsPublicToCommon.remove", + "id": "def-public.SavedObjectsClientCommon.update", "type": "Function", "tags": [], - "label": "remove", - "description": [], + "label": "update", + "description": [ + "\nUpdate a saved object by id" + ], "signature": [ - "(key: string) => Promise" + "(type: string, id: string, attributes: Record, options: Record) => Promise<", + "SavedObject", + ">" ], - "path": "src/plugins/data_views/public/ui_settings_wrapper.ts", + "path": "src/plugins/data_views/common/types.ts", "deprecated": false, "children": [ { "parentPluginId": "dataViews", - "id": "def-public.UiSettingsPublicToCommon.remove.$1", + "id": "def-public.SavedObjectsClientCommon.update.$1", "type": "string", "tags": [], - "label": "key", - "description": [], + "label": "type", + "description": [ + "- type of saved object" + ], "signature": [ "string" ], - "path": "src/plugins/data_views/public/ui_settings_wrapper.ts", + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "dataViews", + "id": "def-public.SavedObjectsClientCommon.update.$2", + "type": "string", + "tags": [], + "label": "id", + "description": [ + "- id of saved object" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "dataViews", + "id": "def-public.SavedObjectsClientCommon.update.$3", + "type": "Object", + "tags": [], + "label": "attributes", + "description": [ + "- attributes to update" + ], + "signature": [ + "Record" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "dataViews", + "id": "def-public.SavedObjectsClientCommon.update.$4", + "type": "Object", + "tags": [], + "label": "options", + "description": [ + "- client options" + ], + "signature": [ + "Record" + ], + "path": "src/plugins/data_views/common/types.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] - } - ], - "initialIsOpen": false - } - ], - "functions": [ - { - "parentPluginId": "dataViews", - "id": "def-public.getFieldSubtypeMulti", - "type": "Function", - "tags": [], - "label": "getFieldSubtypeMulti", - "description": [], - "signature": [ - "(field: HasSubtype) => ", - "IFieldSubTypeMulti", - " | undefined" - ], - "path": "src/plugins/data_views/common/fields/utils.ts", - "deprecated": false, - "returnComment": [], - "children": [ + }, { "parentPluginId": "dataViews", - "id": "def-public.getFieldSubtypeMulti.$1", - "type": "Object", + "id": "def-public.SavedObjectsClientCommon.create", + "type": "Function", "tags": [], - "label": "field", - "description": [], - "signature": [ - "{ subType?: ", - "IFieldSubType", - " | undefined; }" + "label": "create", + "description": [ + "\nCreate a saved object" ], - "path": "src/plugins/data_views/common/fields/utils.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "dataViews", - "id": "def-public.getFieldSubtypeNested", - "type": "Function", - "tags": [], - "label": "getFieldSubtypeNested", - "description": [], - "signature": [ - "(field: HasSubtype) => ", - "IFieldSubTypeNested", - " | undefined" - ], - "path": "src/plugins/data_views/common/fields/utils.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-public.getFieldSubtypeNested.$1", - "type": "Object", - "tags": [], - "label": "field", - "description": [], "signature": [ - "{ subType?: ", - "IFieldSubType", - " | undefined; }" + "(type: string, attributes: Record, options: Record) => Promise<", + "SavedObject", + ">" ], - "path": "src/plugins/data_views/common/fields/utils.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "dataViews", - "id": "def-public.onRedirectNoIndexPattern", - "type": "Function", - "tags": [], - "label": "onRedirectNoIndexPattern", - "description": [], - "signature": [ - "(capabilities: Readonly<{ [x: string]: Readonly<{ [x: string]: boolean | Readonly<{ [x: string]: boolean; }>; }>; navLinks: Readonly<{ [x: string]: boolean; }>; management: Readonly<{ [x: string]: Readonly<{ [x: string]: boolean; }>; }>; catalogue: Readonly<{ [x: string]: boolean; }>; }>, navigateToApp: (appId: string, options?: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreApplicationPluginApi", - "section": "def-public.NavigateToAppOptions", - "text": "NavigateToAppOptions" - }, - " | undefined) => Promise, overlays: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.OverlayStart", - "text": "OverlayStart" - }, - ", theme: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ThemeServiceStart", - "text": "ThemeServiceStart" - }, - ") => () => Promise" - ], - "path": "src/plugins/data_views/public/data_views/redirect_no_index_pattern.tsx", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-public.onRedirectNoIndexPattern.$1", - "type": "Object", - "tags": [], - "label": "capabilities", - "description": [], - "signature": [ - "Readonly<{ [x: string]: Readonly<{ [x: string]: boolean | Readonly<{ [x: string]: boolean; }>; }>; navLinks: Readonly<{ [x: string]: boolean; }>; management: Readonly<{ [x: string]: Readonly<{ [x: string]: boolean; }>; }>; catalogue: Readonly<{ [x: string]: boolean; }>; }>" - ], - "path": "src/plugins/data_views/public/data_views/redirect_no_index_pattern.tsx", + "path": "src/plugins/data_views/common/types.ts", "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "dataViews", - "id": "def-public.onRedirectNoIndexPattern.$2", - "type": "Function", - "tags": [], - "label": "navigateToApp", - "description": [], - "signature": [ - "(appId: string, options?: ", + "children": [ { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreApplicationPluginApi", - "section": "def-public.NavigateToAppOptions", - "text": "NavigateToAppOptions" + "parentPluginId": "dataViews", + "id": "def-public.SavedObjectsClientCommon.create.$1", + "type": "string", + "tags": [], + "label": "type", + "description": [ + "- type of saved object" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "isRequired": true }, - " | undefined) => Promise" - ], - "path": "src/plugins/data_views/public/data_views/redirect_no_index_pattern.tsx", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "dataViews", - "id": "def-public.onRedirectNoIndexPattern.$3", - "type": "Object", - "tags": [], - "label": "overlays", - "description": [], - "signature": [ { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.OverlayStart", - "text": "OverlayStart" + "parentPluginId": "dataViews", + "id": "def-public.SavedObjectsClientCommon.create.$2", + "type": "Object", + "tags": [], + "label": "attributes", + "description": [ + "- attributes to set" + ], + "signature": [ + "Record" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "dataViews", + "id": "def-public.SavedObjectsClientCommon.create.$3", + "type": "Object", + "tags": [], + "label": "options", + "description": [ + "- client options" + ], + "signature": [ + "Record" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "isRequired": true } ], - "path": "src/plugins/data_views/public/data_views/redirect_no_index_pattern.tsx", - "deprecated": false, - "isRequired": true + "returnComment": [] }, { "parentPluginId": "dataViews", - "id": "def-public.onRedirectNoIndexPattern.$4", - "type": "Object", + "id": "def-public.SavedObjectsClientCommon.delete", + "type": "Function", "tags": [], - "label": "theme", - "description": [], + "label": "delete", + "description": [ + "\nDelete a saved object by id" + ], "signature": [ + "(type: string, id: string) => Promise<{}>" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "children": [ { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ThemeServiceStart", - "text": "ThemeServiceStart" + "parentPluginId": "dataViews", + "id": "def-public.SavedObjectsClientCommon.delete.$1", + "type": "string", + "tags": [], + "label": "type", + "description": [ + "- type of saved object" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "dataViews", + "id": "def-public.SavedObjectsClientCommon.delete.$2", + "type": "string", + "tags": [], + "label": "id", + "description": [ + "- id of saved object" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "isRequired": true } ], - "path": "src/plugins/data_views/public/data_views/redirect_no_index_pattern.tsx", - "deprecated": false, - "isRequired": true + "returnComment": [] } ], - "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "dataViews", - "id": "def-public.validateDataView", - "type": "Function", - "tags": [], - "label": "validateDataView", - "description": [], - "signature": [ - "(indexPattern: string) => { ILLEGAL_CHARACTERS?: string[] | undefined; CONTAINS_SPACES?: boolean | undefined; }" - ], - "path": "src/plugins/data_views/common/lib/validate_data_view.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-public.validateDataView.$1", - "type": "string", - "tags": [], - "label": "indexPattern", - "description": [], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/lib/validate_data_view.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - } - ], - "interfaces": [ - { - "parentPluginId": "dataViews", - "id": "def-public.DataViewAttributes", + "id": "def-public.TypeMeta", "type": "Interface", "tags": [], - "label": "DataViewAttributes", + "label": "TypeMeta", "description": [ - "\nInterface for an index pattern saved object" + "\nInterface for metadata about rollup indices" ], "path": "src/plugins/data_views/common/types.ts", "deprecated": false, "children": [ { "parentPluginId": "dataViews", - "id": "def-public.DataViewAttributes.fields", - "type": "string", - "tags": [], - "label": "fields", - "description": [], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-public.DataViewAttributes.title", - "type": "string", - "tags": [], - "label": "title", - "description": [], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-public.DataViewAttributes.type", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-public.DataViewAttributes.typeMeta", - "type": "string", + "id": "def-public.TypeMeta.aggs", + "type": "Object", "tags": [], - "label": "typeMeta", - "description": [], - "signature": [ - "string | undefined" + "label": "aggs", + "description": [ + "\nAggregation restrictions for rollup fields" ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-public.DataViewAttributes.timeFieldName", - "type": "string", - "tags": [], - "label": "timeFieldName", - "description": [], "signature": [ - "string | undefined" + "Record | undefined" ], "path": "src/plugins/data_views/common/types.ts", "deprecated": false }, { "parentPluginId": "dataViews", - "id": "def-public.DataViewAttributes.sourceFilters", - "type": "string", + "id": "def-public.TypeMeta.params", + "type": "Object", "tags": [], - "label": "sourceFilters", - "description": [], - "signature": [ - "string | undefined" + "label": "params", + "description": [ + "\nParams for retrieving rollup field data" ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-public.DataViewAttributes.fieldFormatMap", - "type": "string", - "tags": [], - "label": "fieldFormatMap", - "description": [], "signature": [ - "string | undefined" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-public.DataViewAttributes.fieldAttrs", - "type": "string", - "tags": [], - "label": "fieldAttrs", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-public.DataViewAttributes.runtimeFieldMap", - "type": "string", - "tags": [], - "label": "runtimeFieldMap", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-public.DataViewAttributes.allowNoIndex", - "type": "CompoundType", - "tags": [], - "label": "allowNoIndex", - "description": [ - "\nprevents errors when index pattern exists before indices" - ], - "signature": [ - "boolean | undefined" + "{ rollup_index: string; } | undefined" ], "path": "src/plugins/data_views/common/types.ts", "deprecated": false } ], "initialIsOpen": false + } + ], + "enums": [ + { + "parentPluginId": "dataViews", + "id": "def-public.DataViewType", + "type": "Enum", + "tags": [], + "label": "DataViewType", + "description": [ + "\nData View type. Default or rollup" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "initialIsOpen": false + } + ], + "misc": [ + { + "parentPluginId": "dataViews", + "id": "def-public.CONTAINS_SPACES_KEY", + "type": "string", + "tags": [], + "label": "CONTAINS_SPACES_KEY", + "description": [ + "\nError code for when an index pattern contains spaces" + ], + "signature": [ + "\"CONTAINS_SPACES\"" + ], + "path": "src/plugins/data_views/common/lib/types.ts", + "deprecated": false, + "initialIsOpen": false }, { "parentPluginId": "dataViews", - "id": "def-public.DataViewListItem", - "type": "Interface", + "id": "def-public.DATA_VIEW_SAVED_OBJECT_TYPE", + "type": "string", "tags": [], - "label": "DataViewListItem", - "description": [], - "path": "src/plugins/data_views/common/data_views/data_views.ts", + "label": "DATA_VIEW_SAVED_OBJECT_TYPE", + "description": [ + "\nData view saved object type." + ], + "signature": [ + "\"index-pattern\"" + ], + "path": "src/plugins/data_views/common/constants.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "dataViews", + "id": "def-public.ILLEGAL_CHARACTERS", + "type": "Array", + "tags": [], + "label": "ILLEGAL_CHARACTERS", + "description": [ + "\nAll characters disallowed in index patterns." + ], + "signature": [ + "string[]" + ], + "path": "src/plugins/data_views/common/lib/types.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "dataViews", + "id": "def-public.ILLEGAL_CHARACTERS_KEY", + "type": "string", + "tags": [], + "label": "ILLEGAL_CHARACTERS_KEY", + "description": [ + "\nError code for when an index pattern contains illegal characters" + ], + "signature": [ + "\"ILLEGAL_CHARACTERS\"" + ], + "path": "src/plugins/data_views/common/lib/types.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "dataViews", + "id": "def-public.ILLEGAL_CHARACTERS_VISIBLE", + "type": "Array", + "tags": [], + "label": "ILLEGAL_CHARACTERS_VISIBLE", + "description": [ + "\nCharacters disallowed in index patterns that are visible." + ], + "signature": [ + "string[]" + ], + "path": "src/plugins/data_views/common/lib/types.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "dataViews", + "id": "def-public.META_FIELDS", + "type": "string", + "tags": [], + "label": "META_FIELDS", + "description": [ + "\nUiSettings key for metaFields list." + ], + "signature": [ + "\"metaFields\"" + ], + "path": "src/plugins/data_views/common/constants.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "dataViews", + "id": "def-public.RuntimeType", + "type": "Type", + "tags": [], + "label": "RuntimeType", + "description": [ + "\nRuntime field - type of value returned" + ], + "signature": [ + "\"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"long\" | \"double\" | \"composite\"" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "initialIsOpen": false + } + ], + "objects": [], + "setup": { + "parentPluginId": "dataViews", + "id": "def-public.DataViewsPublicPluginSetup", + "type": "Interface", + "tags": [], + "label": "DataViewsPublicPluginSetup", + "description": [ + "\nData plugin public Setup contract" + ], + "path": "src/plugins/data_views/public/types.ts", + "deprecated": false, + "children": [], + "lifecycle": "setup", + "initialIsOpen": true + }, + "start": { + "parentPluginId": "dataViews", + "id": "def-public.DataViewsContract", + "type": "Type", + "tags": [], + "label": "DataViewsContract", + "description": [], + "signature": [ + { + "pluginId": "dataViews", + "scope": "public", + "docId": "kibDataViewsPluginApi", + "section": "def-public.DataViewsServicePublic", + "text": "DataViewsServicePublic" + } + ], + "path": "src/plugins/data_views/public/types.ts", + "deprecated": false, + "lifecycle": "start", + "initialIsOpen": true + } + }, + "server": { + "classes": [ + { + "parentPluginId": "dataViews", + "id": "def-server.DataView", + "type": "Class", + "tags": [], + "label": "DataView", + "description": [ + "\nData view class. Central kibana abstraction around multiple indices." + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + " implements ", + "DataViewBase" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": false, "children": [ { "parentPluginId": "dataViews", - "id": "def-public.DataViewListItem.id", + "id": "def-server.DataView.id", "type": "string", "tags": [], "label": "id", - "description": [], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-public.DataViewListItem.namespaces", - "type": "Array", - "tags": [], - "label": "namespaces", - "description": [], + "description": [ + "\nSaved object id" + ], "signature": [ - "string[] | undefined" + "string | undefined" ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", + "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": false }, { "parentPluginId": "dataViews", - "id": "def-public.DataViewListItem.title", + "id": "def-server.DataView.title", "type": "string", "tags": [], "label": "title", - "description": [], - "path": "src/plugins/data_views/common/data_views/data_views.ts", + "description": [ + "\nTitle of data view" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": false }, { "parentPluginId": "dataViews", - "id": "def-public.DataViewListItem.type", - "type": "string", + "id": "def-server.DataView.fieldFormatMap", + "type": "Object", "tags": [], - "label": "type", - "description": [], + "label": "fieldFormatMap", + "description": [ + "\nMap of field formats by field name" + ], "signature": [ - "string | undefined" + "{ [x: string]: any; }" ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", + "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": false }, { "parentPluginId": "dataViews", - "id": "def-public.DataViewListItem.typeMeta", + "id": "def-server.DataView.typeMeta", "type": "Object", "tags": [], "label": "typeMeta", - "description": [], + "description": [ + "\nOnly used by rollup indices, used by rollup specific endpoint to load field list." + ], "signature": [ { "pluginId": "dataViews", @@ -5630,569 +6512,562 @@ }, " | undefined" ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", + "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "dataViews", - "id": "def-public.DataViewSpec", - "type": "Interface", - "tags": [], - "label": "DataViewSpec", - "description": [ - "\nStatic index pattern format\nSerialized data object, representing index pattern attributes and state" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "dataViews", - "id": "def-public.DataViewSpec.id", - "type": "string", + "id": "def-server.DataView.fields", + "type": "CompoundType", "tags": [], - "label": "id", + "label": "fields", "description": [ - "\nsaved object id" + "\nField list, in extended array format" ], "signature": [ - "string | undefined" + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.IIndexPatternFieldList", + "text": "IIndexPatternFieldList" + }, + " & { toSpec: () => ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewFieldMap", + "text": "DataViewFieldMap" + }, + "; }" ], - "path": "src/plugins/data_views/common/types.ts", + "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": false }, { "parentPluginId": "dataViews", - "id": "def-public.DataViewSpec.version", + "id": "def-server.DataView.timeFieldName", "type": "string", "tags": [], - "label": "version", + "label": "timeFieldName", "description": [ - "\nsaved object version string" + "\nTimestamp field name" ], "signature": [ "string | undefined" ], - "path": "src/plugins/data_views/common/types.ts", + "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": false }, { "parentPluginId": "dataViews", - "id": "def-public.DataViewSpec.title", + "id": "def-server.DataView.type", "type": "string", "tags": [], - "label": "title", - "description": [], + "label": "type", + "description": [ + "\nType is used to identify rollup index patterns." + ], "signature": [ "string | undefined" ], - "path": "src/plugins/data_views/common/types.ts", + "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": false }, { "parentPluginId": "dataViews", - "id": "def-public.DataViewSpec.timeFieldName", - "type": "string", - "tags": [], - "label": "timeFieldName", + "id": "def-server.DataView.flattenHit", + "type": "Function", + "tags": [ + "deprecated" + ], + "label": "flattenHit", "description": [], "signature": [ - "string | undefined" + "(hit: Record, deep?: boolean | undefined) => Record" ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": true, + "references": [ + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx" + } + ], + "returnComment": [], + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-server.DataView.flattenHit.$1", + "type": "Object", + "tags": [], + "label": "hit", + "description": [], + "signature": [ + "{ [x: string]: any; }" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false + }, + { + "parentPluginId": "dataViews", + "id": "def-server.DataView.flattenHit.$2", + "type": "CompoundType", + "tags": [], + "label": "deep", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false + } + ] }, { "parentPluginId": "dataViews", - "id": "def-public.DataViewSpec.sourceFilters", + "id": "def-server.DataView.metaFields", "type": "Array", "tags": [], - "label": "sourceFilters", - "description": [], + "label": "metaFields", + "description": [ + "\nList of meta fields by name" + ], "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.SourceFilter", - "text": "SourceFilter" - }, - "[] | undefined" + "string[]" ], - "path": "src/plugins/data_views/common/types.ts", + "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": false }, { "parentPluginId": "dataViews", - "id": "def-public.DataViewSpec.fields", - "type": "Object", + "id": "def-server.DataView.version", + "type": "string", "tags": [], - "label": "fields", - "description": [], + "label": "version", + "description": [ + "\nSavedObject version" + ], "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewFieldMap", - "text": "DataViewFieldMap" - }, - " | undefined" + "string | undefined" ], - "path": "src/plugins/data_views/common/types.ts", + "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": false }, { "parentPluginId": "dataViews", - "id": "def-public.DataViewSpec.typeMeta", - "type": "Object", + "id": "def-server.DataView.sourceFilters", + "type": "Array", "tags": [], - "label": "typeMeta", - "description": [], + "label": "sourceFilters", + "description": [ + "\nArray of filters - hides fields in discover" + ], "signature": [ { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.TypeMeta", - "text": "TypeMeta" + "section": "def-common.SourceFilter", + "text": "SourceFilter" }, - " | undefined" + "[] | undefined" ], - "path": "src/plugins/data_views/common/types.ts", + "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": false }, { "parentPluginId": "dataViews", - "id": "def-public.DataViewSpec.type", - "type": "string", + "id": "def-server.DataView.namespaces", + "type": "Array", "tags": [], - "label": "type", - "description": [], + "label": "namespaces", + "description": [ + "\nArray of namespace ids" + ], "signature": [ - "string | undefined" + "string[]" ], - "path": "src/plugins/data_views/common/types.ts", + "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": false }, { "parentPluginId": "dataViews", - "id": "def-public.DataViewSpec.fieldFormats", - "type": "Object", + "id": "def-server.DataView.allowNoIndex", + "type": "boolean", "tags": [], - "label": "fieldFormats", - "description": [], - "signature": [ - "Record> | undefined" + "label": "allowNoIndex", + "description": [ + "\nPrevents errors when index pattern exists before indices" ], - "path": "src/plugins/data_views/common/types.ts", + "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": false }, { "parentPluginId": "dataViews", - "id": "def-public.DataViewSpec.runtimeFieldMap", - "type": "Object", + "id": "def-server.DataView.Unnamed", + "type": "Function", "tags": [], - "label": "runtimeFieldMap", - "description": [], + "label": "Constructor", + "description": [ + "\nconstructor" + ], "signature": [ - "Record | undefined" + "parentPluginId": "dataViews", + "id": "def-server.DataView.Unnamed.$1", + "type": "Object", + "tags": [], + "label": "config", + "description": [ + "- config data and dependencies" + ], + "signature": [ + "DataViewDeps" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + } ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false + "returnComment": [] }, { "parentPluginId": "dataViews", - "id": "def-public.DataViewSpec.fieldAttrs", - "type": "Object", + "id": "def-server.DataView.getOriginalSavedObjectBody", + "type": "Function", "tags": [], - "label": "fieldAttrs", - "description": [], + "label": "getOriginalSavedObjectBody", + "description": [ + "\nGet last saved saved object fields" + ], "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldAttrs", - "text": "FieldAttrs" - }, - " | undefined" + "() => { fieldAttrs?: string | undefined; title?: string | undefined; timeFieldName?: string | undefined; fields?: string | undefined; sourceFilters?: string | undefined; fieldFormatMap?: string | undefined; typeMeta?: string | undefined; type?: string | undefined; }" ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "dataViews", - "id": "def-public.DataViewSpec.allowNoIndex", - "type": "CompoundType", + "id": "def-server.DataView.resetOriginalSavedObjectBody", + "type": "Function", "tags": [], - "label": "allowNoIndex", - "description": [], - "signature": [ - "boolean | undefined" + "label": "resetOriginalSavedObjectBody", + "description": [ + "\nReset last saved saved object fields. Used after saving." ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-public.DataViewSpec.namespaces", - "type": "Array", - "tags": [], - "label": "namespaces", - "description": [], "signature": [ - "string[] | undefined" + "() => void" ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "dataViews", - "id": "def-public.FieldSpec", - "type": "Interface", - "tags": [], - "label": "FieldSpec", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, - " extends ", - "DataViewFieldBase" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "children": [ { "parentPluginId": "dataViews", - "id": "def-public.FieldSpec.count", - "type": "number", + "id": "def-server.DataView.getFieldAttrs", + "type": "Function", "tags": [], - "label": "count", + "label": "getFieldAttrs", "description": [ - "\nPopularity count is used by discover" + "\nReturns field attributes map" ], "signature": [ - "number | undefined" + "() => { [x: string]: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldAttrSet", + "text": "FieldAttrSet" + }, + "; }" ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "dataViews", - "id": "def-public.FieldSpec.conflictDescriptions", - "type": "Object", + "id": "def-server.DataView.getComputedFields", + "type": "Function", "tags": [], - "label": "conflictDescriptions", - "description": [], + "label": "getComputedFields", + "description": [ + "\nReturns scripted fields" + ], "signature": [ - "Record | undefined" + "() => { storedFields: string[]; scriptFields: Record; docvalueFields: { field: string; format: string; }[]; runtimeFields: ", + "MappingRuntimeFields", + "; }" ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "dataViews", - "id": "def-public.FieldSpec.format", - "type": "Object", + "id": "def-server.DataView.toSpec", + "type": "Function", "tags": [], - "label": "format", - "description": [], + "label": "toSpec", + "description": [ + "\nCreates static representation of the data view." + ], "signature": [ + "() => ", { - "pluginId": "fieldFormats", - "scope": "common", - "docId": "kibFieldFormatsPluginApi", - "section": "def-common.SerializedFieldFormat", - "text": "SerializedFieldFormat" - }, - "<", - { - "pluginId": "fieldFormats", + "pluginId": "dataViews", "scope": "common", - "docId": "kibFieldFormatsPluginApi", - "section": "def-common.FieldFormatParams", - "text": "FieldFormatParams" - }, - "> | undefined" + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewSpec", + "text": "DataViewSpec" + } ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "dataViews", - "id": "def-public.FieldSpec.esTypes", - "type": "Array", + "id": "def-server.DataView.getSourceFiltering", + "type": "Function", "tags": [], - "label": "esTypes", - "description": [], - "signature": [ - "string[] | undefined" + "label": "getSourceFiltering", + "description": [ + "\nGet the source filtering configuration for that index." ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-public.FieldSpec.searchable", - "type": "boolean", - "tags": [], - "label": "searchable", - "description": [], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-public.FieldSpec.aggregatable", - "type": "boolean", - "tags": [], - "label": "aggregatable", - "description": [], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-public.FieldSpec.readFromDocValues", - "type": "CompoundType", - "tags": [], - "label": "readFromDocValues", - "description": [], "signature": [ - "boolean | undefined" + "() => { excludes: string[]; }" ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "dataViews", - "id": "def-public.FieldSpec.indexed", - "type": "CompoundType", - "tags": [], - "label": "indexed", - "description": [], - "signature": [ - "boolean | undefined" + "id": "def-server.DataView.removeScriptedField", + "type": "Function", + "tags": [ + "deprecated" + ], + "label": "removeScriptedField", + "description": [ + "\nRemoves scripted field from field list." ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-public.FieldSpec.customLabel", - "type": "string", - "tags": [], - "label": "customLabel", - "description": [], "signature": [ - "string | undefined" + "(fieldName: string) => void" ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": true, + "references": [ + { + "plugin": "dataViewManagement", + "path": "src/plugins/data_view_management/public/components/edit_index_pattern/scripted_fields_table/scripted_fields_table.tsx" + }, + { + "plugin": "dataViewManagement", + "path": "src/plugins/data_view_management/public/components/field_editor/field_editor.tsx" + } + ], + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-server.DataView.removeScriptedField.$1", + "type": "string", + "tags": [], + "label": "fieldName", + "description": [ + "name of scripted field to remove" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "dataViews", - "id": "def-public.FieldSpec.runtimeField", - "type": "Object", - "tags": [], - "label": "runtimeField", - "description": [], + "id": "def-server.DataView.getNonScriptedFields", + "type": "Function", + "tags": [ + "deprecated" + ], + "label": "getNonScriptedFields", + "description": [ + "\n" + ], "signature": [ + "() => ", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.RuntimeFieldSpec", - "text": "RuntimeFieldSpec" + "section": "def-common.DataViewField", + "text": "DataViewField" }, - " | undefined" + "[]" ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-public.FieldSpec.shortDotsEnable", - "type": "CompoundType", - "tags": [], - "label": "shortDotsEnable", - "description": [], - "signature": [ - "boolean | undefined" + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": true, + "references": [ + { + "plugin": "visTypeTimeseries", + "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/abstract_search_strategy.ts" + }, + { + "plugin": "graph", + "path": "x-pack/plugins/graph/public/services/persistence/deserialize.ts" + }, + { + "plugin": "graph", + "path": "x-pack/plugins/graph/public/state_management/datasource.test.ts" + }, + { + "plugin": "graph", + "path": "x-pack/plugins/graph/public/services/persistence/deserialize.test.ts" + }, + { + "plugin": "graph", + "path": "x-pack/plugins/graph/public/services/persistence/deserialize.test.ts" + }, + { + "plugin": "dataViewManagement", + "path": "src/plugins/data_view_management/public/components/edit_index_pattern/source_filters_table/components/table/table.tsx" + }, + { + "plugin": "dataViewManagement", + "path": "src/plugins/data_view_management/public/components/edit_index_pattern/edit_index_pattern.tsx" + }, + { + "plugin": "dataViewManagement", + "path": "src/plugins/data_view_management/public/components/edit_index_pattern/edit_index_pattern.tsx" + }, + { + "plugin": "dataViewManagement", + "path": "src/plugins/data_view_management/public/components/edit_index_pattern/edit_index_pattern.tsx" + }, + { + "plugin": "visTypeTimeseries", + "path": "src/plugins/vis_types/timeseries/public/application/lib/fetch_fields.ts" + } ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false + "children": [], + "returnComment": [] }, { "parentPluginId": "dataViews", - "id": "def-public.FieldSpec.isMapped", - "type": "CompoundType", - "tags": [], - "label": "isMapped", - "description": [], + "id": "def-server.DataView.getScriptedFields", + "type": "Function", + "tags": [ + "deprecated" + ], + "label": "getScriptedFields", + "description": [ + "\n" + ], "signature": [ - "boolean | undefined" + "() => ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewField", + "text": "DataViewField" + }, + "[]" ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "dataViews", - "id": "def-public.HasDataViewsResponse", - "type": "Interface", - "tags": [], - "label": "HasDataViewsResponse", - "description": [], - "path": "src/plugins/data_views/public/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-public.HasDataViewsResponse.hasDataView", - "type": "boolean", - "tags": [], - "label": "hasDataView", - "description": [], - "path": "src/plugins/data_views/public/types.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-public.HasDataViewsResponse.hasUserDataView", - "type": "boolean", - "tags": [], - "label": "hasUserDataView", - "description": [], - "path": "src/plugins/data_views/public/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "dataViews", - "id": "def-public.IIndexPatternFieldList", - "type": "Interface", - "tags": [], - "label": "IIndexPatternFieldList", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IIndexPatternFieldList", - "text": "IIndexPatternFieldList" - }, - " extends ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": true, + "references": [ + { + "plugin": "dataViewManagement", + "path": "src/plugins/data_view_management/public/components/edit_index_pattern/scripted_fields_table/scripted_fields_table.tsx" + } + ], + "children": [], + "returnComment": [] }, - "[]" - ], - "path": "src/plugins/data_views/common/fields/field_list.ts", - "deprecated": false, - "children": [ { "parentPluginId": "dataViews", - "id": "def-public.IIndexPatternFieldList.add", + "id": "def-server.DataView.isTimeBased", "type": "Function", "tags": [], - "label": "add", - "description": [], + "label": "isTimeBased", + "description": [ + "\nDoes the data view have a timestamp field?" + ], "signature": [ - "(field: ", + "() => this is ", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - ") => ", + "section": "def-common.TimeBasedDataView", + "text": "TimeBasedDataView" + } + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "dataViews", + "id": "def-server.DataView.isTimeNanosBased", + "type": "Function", + "tags": [], + "label": "isTimeNanosBased", + "description": [ + "\nDoes the data view have a timestamp field and is it a date nanos field?" + ], + "signature": [ + "() => this is ", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" + "section": "def-common.TimeBasedDataView", + "text": "TimeBasedDataView" } ], - "path": "src/plugins/data_views/common/fields/field_list.ts", + "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-public.IIndexPatternFieldList.add.$1", - "type": "Object", - "tags": [], - "label": "field", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - } - ], - "path": "src/plugins/data_views/common/fields/field_list.ts", - "deprecated": false, - "isRequired": true - } - ], + "children": [], "returnComment": [] }, { "parentPluginId": "dataViews", - "id": "def-public.IIndexPatternFieldList.getAll", + "id": "def-server.DataView.getTimeField", "type": "Function", "tags": [], - "label": "getAll", - "description": [], + "label": "getTimeField", + "description": [ + "\nGet timestamp field as DataViewField or return undefined" + ], "signature": [ "() => ", { @@ -6202,20 +7077,22 @@ "section": "def-common.DataViewField", "text": "DataViewField" }, - "[]" + " | undefined" ], - "path": "src/plugins/data_views/common/fields/field_list.ts", + "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "dataViews", - "id": "def-public.IIndexPatternFieldList.getByName", + "id": "def-server.DataView.getFieldByName", "type": "Function", "tags": [], - "label": "getByName", - "description": [], + "label": "getFieldByName", + "description": [ + "\nGet field by name." + ], "signature": [ "(name: string) => ", { @@ -6227,20 +7104,22 @@ }, " | undefined" ], - "path": "src/plugins/data_views/common/fields/field_list.ts", + "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": false, "children": [ { "parentPluginId": "dataViews", - "id": "def-public.IIndexPatternFieldList.getByName.$1", + "id": "def-server.DataView.getFieldByName.$1", "type": "string", "tags": [], "label": "name", - "description": [], + "description": [ + "field name" + ], "signature": [ "string" ], - "path": "src/plugins/data_views/common/fields/field_list.ts", + "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": false, "isRequired": true } @@ -6249,80 +7128,118 @@ }, { "parentPluginId": "dataViews", - "id": "def-public.IIndexPatternFieldList.getByType", + "id": "def-server.DataView.getAggregationRestrictions", "type": "Function", "tags": [], - "label": "getByType", - "description": [], + "label": "getAggregationRestrictions", + "description": [ + "\nGet aggregation restrictions. Rollup fields can only perform a subset of aggregations." + ], "signature": [ - "(type: string) => ", + "() => Record | undefined" ], - "path": "src/plugins/data_views/common/fields/field_list.ts", + "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-public.IIndexPatternFieldList.getByType.$1", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/fields/field_list.ts", - "deprecated": false, - "isRequired": true + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "dataViews", + "id": "def-server.DataView.getAsSavedObjectBody", + "type": "Function", + "tags": [], + "label": "getAsSavedObjectBody", + "description": [ + "\nReturns index pattern as saved object body for saving" + ], + "signature": [ + "() => ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewAttributes", + "text": "DataViewAttributes" } ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [], "returnComment": [] }, { "parentPluginId": "dataViews", - "id": "def-public.IIndexPatternFieldList.remove", + "id": "def-server.DataView.getFormatterForField", "type": "Function", "tags": [], - "label": "remove", - "description": [], + "label": "getFormatterForField", + "description": [ + "\nProvide a field, get its formatter" + ], "signature": [ "(field: ", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" + "section": "def-common.DataViewField", + "text": "DataViewField" }, - ") => void" + " | ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + ") => ", + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.FieldFormat", + "text": "FieldFormat" + } ], - "path": "src/plugins/data_views/common/fields/field_list.ts", + "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": false, "children": [ { "parentPluginId": "dataViews", - "id": "def-public.IIndexPatternFieldList.remove.$1", - "type": "Object", + "id": "def-server.DataView.getFormatterForField.$1", + "type": "CompoundType", "tags": [], "label": "field", - "description": [], + "description": [ + "field to get formatter for" + ], "signature": [ { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" + "section": "def-common.DataViewField", + "text": "DataViewField" + }, + " | ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" } ], - "path": "src/plugins/data_views/common/fields/field_list.ts", + "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": false, "isRequired": true } @@ -6331,58 +7248,70 @@ }, { "parentPluginId": "dataViews", - "id": "def-public.IIndexPatternFieldList.removeAll", + "id": "def-server.DataView.addRuntimeField", "type": "Function", "tags": [], - "label": "removeAll", - "description": [], - "signature": [ - "() => void" + "label": "addRuntimeField", + "description": [ + "\nAdd a runtime field - Appended to existing mapped field or a new field is\ncreated as appropriate." ], - "path": "src/plugins/data_views/common/fields/field_list.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "dataViews", - "id": "def-public.IIndexPatternFieldList.replaceAll", - "type": "Function", - "tags": [], - "label": "replaceAll", - "description": [], "signature": [ - "(specs: ", + "(name: string, runtimeField: ", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" + "section": "def-common.RuntimeField", + "text": "RuntimeField" }, - "[]) => void" + ") => ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewField", + "text": "DataViewField" + }, + "[]" ], - "path": "src/plugins/data_views/common/fields/field_list.ts", + "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": false, "children": [ { "parentPluginId": "dataViews", - "id": "def-public.IIndexPatternFieldList.replaceAll.$1", - "type": "Array", + "id": "def-server.DataView.addRuntimeField.$1", + "type": "string", "tags": [], - "label": "specs", - "description": [], + "label": "name", + "description": [ + "Field name" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "dataViews", + "id": "def-server.DataView.addRuntimeField.$2", + "type": "Object", + "tags": [], + "label": "runtimeField", + "description": [ + "Runtime field definition" + ], "signature": [ { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - "[]" + "section": "def-common.RuntimeField", + "text": "RuntimeField" + } ], - "path": "src/plugins/data_views/common/fields/field_list.ts", + "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": false, "isRequired": true } @@ -6391,42 +7320,32 @@ }, { "parentPluginId": "dataViews", - "id": "def-public.IIndexPatternFieldList.update", + "id": "def-server.DataView.hasRuntimeField", "type": "Function", "tags": [], - "label": "update", - "description": [], + "label": "hasRuntimeField", + "description": [ + "\nChecks if runtime field exists" + ], "signature": [ - "(field: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - ") => void" + "(name: string) => boolean" ], - "path": "src/plugins/data_views/common/fields/field_list.ts", + "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": false, "children": [ { "parentPluginId": "dataViews", - "id": "def-public.IIndexPatternFieldList.update.$1", - "type": "Object", + "id": "def-server.DataView.hasRuntimeField.$1", + "type": "string", "tags": [], - "label": "field", - "description": [], + "label": "name", + "description": [ + "field name" + ], "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - } + "string" ], - "path": "src/plugins/data_views/common/fields/field_list.ts", + "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": false, "isRequired": true } @@ -6435,29 +7354,84 @@ }, { "parentPluginId": "dataViews", - "id": "def-public.IIndexPatternFieldList.toSpec", + "id": "def-server.DataView.getRuntimeField", "type": "Function", "tags": [], - "label": "toSpec", - "description": [], + "label": "getRuntimeField", + "description": [ + "\nReturns runtime field if exists" + ], "signature": [ - "(options?: { getFormatterForField?: ((field: ", + "(name: string) => ", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" + "section": "def-common.RuntimeField", + "text": "RuntimeField" }, - " | ", + " | null" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-server.DataView.getRuntimeField.$1", + "type": "string", + "tags": [], + "label": "name", + "description": [ + "Runtime field name" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "dataViews", + "id": "def-server.DataView.getAllRuntimeFields", + "type": "Function", + "tags": [], + "label": "getAllRuntimeFields", + "description": [ + "\nGet all runtime field definitions." + ], + "signature": [ + "() => Record" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [], + "returnComment": [ + "map of runtime field definitions by field name" + ] + }, + { + "parentPluginId": "dataViews", + "id": "def-server.DataView.getFieldsByRuntimeFieldName", + "type": "Function", + "tags": [], + "label": "getFieldsByRuntimeFieldName", + "description": [ + "\nReturns data view fields backed by runtime fields." + ], + "signature": [ + "(name: string) => Record ", - { - "pluginId": "fieldFormats", - "scope": "common", - "docId": "kibFieldFormatsPluginApi", - "section": "def-common.FieldFormat", - "text": "FieldFormat" - }, - ") | undefined; } | undefined) => ", + "> | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-server.DataView.getFieldsByRuntimeFieldName.$1", + "type": "string", + "tags": [], + "label": "name", + "description": [ + "runtime field name" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [ + "map of DataViewFields (that are runtime fields) by field name" + ] + }, + { + "parentPluginId": "dataViews", + "id": "def-server.DataView.replaceAllRuntimeFields", + "type": "Function", + "tags": [], + "label": "replaceAllRuntimeFields", + "description": [ + "\nReplaces all existing runtime fields with new fields." + ], + "signature": [ + "(newFields: Record) => void" ], - "path": "src/plugins/data_views/common/fields/field_list.ts", + "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": false, "children": [ { "parentPluginId": "dataViews", - "id": "def-public.IIndexPatternFieldList.toSpec.$1", + "id": "def-server.DataView.replaceAllRuntimeFields.$1", "type": "Object", "tags": [], - "label": "options", - "description": [], - "path": "src/plugins/data_views/common/fields/field_list.ts", - "deprecated": false, - "children": [ + "label": "newFields", + "description": [ + "Map of runtime field definitions by field name" + ], + "signature": [ + "Record ", - { - "pluginId": "fieldFormats", - "scope": "common", - "docId": "kibFieldFormatsPluginApi", - "section": "def-common.FieldFormat", - "text": "FieldFormat" - }, - ") | undefined" - ], - "path": "src/plugins/data_views/common/fields/field_list.ts", - "deprecated": false - } - ] + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.RuntimeField", + "text": "RuntimeField" + }, + ">" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true } ], "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "dataViews", - "id": "def-public.IndicesResponse", - "type": "Interface", - "tags": [], - "label": "IndicesResponse", - "description": [], - "path": "src/plugins/data_views/public/types.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "dataViews", - "id": "def-public.IndicesResponse.indices", - "type": "Array", + "id": "def-server.DataView.removeRuntimeField", + "type": "Function", "tags": [], - "label": "indices", - "description": [], + "label": "removeRuntimeField", + "description": [ + "\nRemove a runtime field - removed from mapped field or removed unmapped\nfield as appropriate. Doesn't clear associated field attributes." + ], "signature": [ - "IndicesResponseItemIndex", - "[] | undefined" + "(name: string) => void" ], - "path": "src/plugins/data_views/public/types.ts", - "deprecated": false + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-server.DataView.removeRuntimeField.$1", + "type": "string", + "tags": [], + "label": "name", + "description": [ + "- Field name to remove" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "dataViews", - "id": "def-public.IndicesResponse.aliases", - "type": "Array", + "id": "def-server.DataView.getRuntimeMappings", + "type": "Function", "tags": [], - "label": "aliases", - "description": [], + "label": "getRuntimeMappings", + "description": [ + "\nReturn the \"runtime_mappings\" section of the ES search query." + ], "signature": [ - "IndicesResponseItemAlias", - "[] | undefined" + "() => ", + "MappingRuntimeFields" ], - "path": "src/plugins/data_views/public/types.ts", - "deprecated": false + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "dataViews", - "id": "def-public.IndicesResponse.data_streams", - "type": "Array", + "id": "def-server.DataView.getFormatterForFieldNoDefault", + "type": "Function", "tags": [], - "label": "data_streams", - "description": [], + "label": "getFormatterForFieldNoDefault", + "description": [ + "\nGet formatter for a given field name. Return undefined if none exists." + ], "signature": [ - "IndicesResponseItemDataStream", - "[] | undefined" + "(fieldname: string) => ", + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.FieldFormat", + "text": "FieldFormat" + }, + " | undefined" ], - "path": "src/plugins/data_views/public/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "dataViews", - "id": "def-public.IndicesResponseModified", - "type": "Interface", - "tags": [], - "label": "IndicesResponseModified", - "description": [], - "path": "src/plugins/data_views/public/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-public.IndicesResponseModified.name", - "type": "string", - "tags": [], - "label": "name", - "description": [], - "path": "src/plugins/data_views/public/types.ts", - "deprecated": false + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-server.DataView.getFormatterForFieldNoDefault.$1", + "type": "string", + "tags": [], + "label": "fieldname", + "description": [ + "name of field to get formatter for" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "dataViews", - "id": "def-public.IndicesResponseModified.item", - "type": "Object", + "id": "def-server.DataView.setFieldAttrs", + "type": "Function", "tags": [], - "label": "item", - "description": [], - "signature": [ - "{ name: string; backing_indices?: string[] | undefined; timestamp_field?: string | undefined; indices?: string[] | undefined; aliases?: string[] | undefined; attributes?: ", - "IndicesResponseItemIndexAttrs", - "[] | undefined; data_stream?: string | undefined; }" + "label": "setFieldAttrs", + "description": [ + "\nSet field attribute" ], - "path": "src/plugins/data_views/public/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "dataViews", - "id": "def-public.IndicesViaSearchResponse", - "type": "Interface", - "tags": [], - "label": "IndicesViaSearchResponse", - "description": [], - "path": "src/plugins/data_views/public/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-public.IndicesViaSearchResponse.total", - "type": "number", - "tags": [], - "label": "total", - "description": [], - "path": "src/plugins/data_views/public/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "dataViews", - "id": "def-public.TypeMeta", - "type": "Interface", - "tags": [], - "label": "TypeMeta", - "description": [], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-public.TypeMeta.aggs", - "type": "Object", - "tags": [], - "label": "aggs", - "description": [], "signature": [ - "Record | undefined" + ">(fieldName: string, attrName: K, value: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldAttrSet", + "text": "FieldAttrSet" + }, + "[K]) => void" ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-public.TypeMeta.params", - "type": "Object", + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-server.DataView.setFieldAttrs.$1", + "type": "string", + "tags": [], + "label": "fieldName", + "description": [ + "name of field to set attribute on" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "dataViews", + "id": "def-server.DataView.setFieldAttrs.$2", + "type": "Uncategorized", + "tags": [], + "label": "attrName", + "description": [ + "name of attribute to set" + ], + "signature": [ + "K" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "dataViews", + "id": "def-server.DataView.setFieldAttrs.$3", + "type": "Uncategorized", + "tags": [], + "label": "value", + "description": [ + "value of attribute" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldAttrSet", + "text": "FieldAttrSet" + }, + "[K]" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "dataViews", + "id": "def-server.DataView.setFieldCustomLabel", + "type": "Function", "tags": [], - "label": "params", - "description": [], + "label": "setFieldCustomLabel", + "description": [ + "\nSet field custom label" + ], "signature": [ - "{ rollup_index: string; } | undefined" + "(fieldName: string, customLabel: string | null | undefined) => void" ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-server.DataView.setFieldCustomLabel.$1", + "type": "string", + "tags": [], + "label": "fieldName", + "description": [ + "name of field to set custom label on" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "dataViews", + "id": "def-server.DataView.setFieldCustomLabel.$2", + "type": "CompoundType", + "tags": [], + "label": "customLabel", + "description": [ + "custom label value. If undefined, custom label is removed" + ], + "signature": [ + "string | null | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "dataViews", + "id": "def-server.DataView.setFieldCount", + "type": "Function", + "tags": [], + "label": "setFieldCount", + "description": [ + "\nSet field count" + ], + "signature": [ + "(fieldName: string, count: number | null | undefined) => void" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-server.DataView.setFieldCount.$1", + "type": "string", + "tags": [], + "label": "fieldName", + "description": [ + "name of field to set count on" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "dataViews", + "id": "def-server.DataView.setFieldCount.$2", + "type": "CompoundType", + "tags": [], + "label": "count", + "description": [ + "count value. If undefined, count is removed" + ], + "signature": [ + "number | null | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "dataViews", + "id": "def-server.DataView.setFieldFormat", + "type": "Function", + "tags": [], + "label": "setFieldFormat", + "description": [ + "\nSet field formatter" + ], + "signature": [ + "(fieldName: string, format: ", + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.SerializedFieldFormat", + "text": "SerializedFieldFormat" + }, + "<", + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.FieldFormatParams", + "text": "FieldFormatParams" + }, + ">) => void" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-server.DataView.setFieldFormat.$1", + "type": "string", + "tags": [], + "label": "fieldName", + "description": [ + "name of field to set format on" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "dataViews", + "id": "def-server.DataView.setFieldFormat.$2", + "type": "Object", + "tags": [], + "label": "format", + "description": [ + "field format in serialized form" + ], + "signature": [ + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.SerializedFieldFormat", + "text": "SerializedFieldFormat" + }, + "<", + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.FieldFormatParams", + "text": "FieldFormatParams" + }, + ">" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "dataViews", + "id": "def-server.DataView.deleteFieldFormat", + "type": "Function", + "tags": [], + "label": "deleteFieldFormat", + "description": [ + "\nRemove field format from the field format map." + ], + "signature": [ + "(fieldName: string) => void" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-server.DataView.deleteFieldFormat.$1", + "type": "string", + "tags": [], + "label": "fieldName", + "description": [ + "field name associated with the format for removal" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] } ], "initialIsOpen": false - } - ], - "enums": [ + }, { "parentPluginId": "dataViews", - "id": "def-public.DataViewType", - "type": "Enum", - "tags": [], - "label": "DataViewType", - "description": [], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "initialIsOpen": false - } - ], - "misc": [ - { - "parentPluginId": "dataViews", - "id": "def-public.CONTAINS_SPACES_KEY", - "type": "string", - "tags": [], - "label": "CONTAINS_SPACES_KEY", - "description": [], - "signature": [ - "\"CONTAINS_SPACES\"" - ], - "path": "src/plugins/data_views/common/lib/types.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "dataViews", - "id": "def-public.DATA_VIEW_SAVED_OBJECT_TYPE", - "type": "string", - "tags": [], - "label": "DATA_VIEW_SAVED_OBJECT_TYPE", - "description": [], - "signature": [ - "\"index-pattern\"" - ], - "path": "src/plugins/data_views/common/constants.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "dataViews", - "id": "def-public.ILLEGAL_CHARACTERS", - "type": "Array", - "tags": [], - "label": "ILLEGAL_CHARACTERS", - "description": [], - "signature": [ - "string[]" - ], - "path": "src/plugins/data_views/common/lib/types.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "dataViews", - "id": "def-public.ILLEGAL_CHARACTERS_KEY", - "type": "string", - "tags": [], - "label": "ILLEGAL_CHARACTERS_KEY", - "description": [], - "signature": [ - "\"ILLEGAL_CHARACTERS\"" - ], - "path": "src/plugins/data_views/common/lib/types.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "dataViews", - "id": "def-public.ILLEGAL_CHARACTERS_VISIBLE", - "type": "Array", + "id": "def-server.DataViewsServerPlugin", + "type": "Class", "tags": [], - "label": "ILLEGAL_CHARACTERS_VISIBLE", - "description": [], - "signature": [ - "string[]" - ], - "path": "src/plugins/data_views/common/lib/types.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "dataViews", - "id": "def-public.IndexPatternsContract", - "type": "Type", - "tags": [ - "deprecated" - ], - "label": "IndexPatternsContract", + "label": "DataViewsServerPlugin", "description": [], "signature": [ - "{ create: (spec: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" - }, - ", skipFetchFields?: boolean) => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - ">; delete: (indexPatternId: string) => Promise<{}>; find: (search: string, size?: number) => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - "[]>; get: (id: string) => Promise<", { "pluginId": "dataViews", - "scope": "common", + "scope": "server", "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" + "section": "def-server.DataViewsServerPlugin", + "text": "DataViewsServerPlugin" }, - ">; getCanSave: () => Promise; ensureDefaultDataView: ", - "EnsureDefaultDataView", - "; getIds: (refresh?: boolean) => Promise; getTitles: (refresh?: boolean) => Promise; getIdsWithTitle: (refresh?: boolean) => Promise<", + " implements ", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewListItem", - "text": "DataViewListItem" + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.Plugin", + "text": "Plugin" }, - "[]>; clearCache: (id?: string | undefined) => void; getCache: () => Promise<", - "SavedObject", "<", - "IndexPatternSavedObjectAttrs", - ">[] | null | undefined>; getDefault: () => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - " | null>; getDefaultId: () => Promise; setDefault: (id: string | null, force?: boolean) => Promise; hasUserDataView: () => Promise; getFieldsForWildcard: (options: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.GetFieldsOptions", - "text": "GetFieldsOptions" - }, - ") => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - "[]>; getFieldsForIndexPattern: (indexPattern: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - " | ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" - }, - ", options?: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.GetFieldsOptions", - "text": "GetFieldsOptions" - }, - " | undefined) => Promise<", { "pluginId": "dataViews", - "scope": "common", + "scope": "server", "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" + "section": "def-server.DataViewsServerPluginSetup", + "text": "DataViewsServerPluginSetup" }, - "[]>; refreshFields: (indexPattern: ", + ", ", { "pluginId": "dataViews", - "scope": "common", + "scope": "server", "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" + "section": "def-server.DataViewsServerPluginStart", + "text": "DataViewsServerPluginStart" }, - ") => Promise; fieldArrayToMap: (fields: ", + ", ", { "pluginId": "dataViews", - "scope": "common", + "scope": "server", "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" + "section": "def-server.DataViewsServerPluginSetupDependencies", + "text": "DataViewsServerPluginSetupDependencies" }, - "[], fieldAttrs?: ", + ", ", { "pluginId": "dataViews", - "scope": "common", + "scope": "server", "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldAttrs", - "text": "FieldAttrs" + "section": "def-server.DataViewsServerPluginStartDependencies", + "text": "DataViewsServerPluginStartDependencies" }, - " | undefined) => ", + ">" + ], + "path": "src/plugins/data_views/server/plugin.ts", + "deprecated": false, + "children": [ { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewFieldMap", - "text": "DataViewFieldMap" + "parentPluginId": "dataViews", + "id": "def-server.DataViewsServerPlugin.Unnamed", + "type": "Function", + "tags": [], + "label": "Constructor", + "description": [], + "signature": [ + "any" + ], + "path": "src/plugins/data_views/server/plugin.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-server.DataViewsServerPlugin.Unnamed.$1", + "type": "Object", + "tags": [], + "label": "initializerContext", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.PluginInitializerContext", + "text": "PluginInitializerContext" + }, + "" + ], + "path": "src/plugins/data_views/server/plugin.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, - "; savedObjectToSpec: (savedObject: ", - "SavedObject", - "<", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewAttributes", - "text": "DataViewAttributes" + "parentPluginId": "dataViews", + "id": "def-server.DataViewsServerPlugin.setup", + "type": "Function", + "tags": [], + "label": "setup", + "description": [], + "signature": [ + "(core: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreSetup", + "text": "CoreSetup" + }, + "<", + { + "pluginId": "dataViews", + "scope": "server", + "docId": "kibDataViewsPluginApi", + "section": "def-server.DataViewsServerPluginStartDependencies", + "text": "DataViewsServerPluginStartDependencies" + }, + ", ", + { + "pluginId": "dataViews", + "scope": "server", + "docId": "kibDataViewsPluginApi", + "section": "def-server.DataViewsServerPluginStart", + "text": "DataViewsServerPluginStart" + }, + ">, { expressions, usageCollection }: ", + { + "pluginId": "dataViews", + "scope": "server", + "docId": "kibDataViewsPluginApi", + "section": "def-server.DataViewsServerPluginSetupDependencies", + "text": "DataViewsServerPluginSetupDependencies" + }, + ") => {}" + ], + "path": "src/plugins/data_views/server/plugin.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-server.DataViewsServerPlugin.setup.$1", + "type": "Object", + "tags": [], + "label": "core", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreSetup", + "text": "CoreSetup" + }, + "<", + { + "pluginId": "dataViews", + "scope": "server", + "docId": "kibDataViewsPluginApi", + "section": "def-server.DataViewsServerPluginStartDependencies", + "text": "DataViewsServerPluginStartDependencies" + }, + ", ", + { + "pluginId": "dataViews", + "scope": "server", + "docId": "kibDataViewsPluginApi", + "section": "def-server.DataViewsServerPluginStart", + "text": "DataViewsServerPluginStart" + }, + ">" + ], + "path": "src/plugins/data_views/server/plugin.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "dataViews", + "id": "def-server.DataViewsServerPlugin.setup.$2", + "type": "Object", + "tags": [], + "label": "{ expressions, usageCollection }", + "description": [], + "signature": [ + { + "pluginId": "dataViews", + "scope": "server", + "docId": "kibDataViewsPluginApi", + "section": "def-server.DataViewsServerPluginSetupDependencies", + "text": "DataViewsServerPluginSetupDependencies" + } + ], + "path": "src/plugins/data_views/server/plugin.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, - ">) => ", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" + "parentPluginId": "dataViews", + "id": "def-server.DataViewsServerPlugin.start", + "type": "Function", + "tags": [], + "label": "start", + "description": [], + "signature": [ + "({ uiSettings, capabilities }: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreStart", + "text": "CoreStart" + }, + ", { fieldFormats }: ", + { + "pluginId": "dataViews", + "scope": "server", + "docId": "kibDataViewsPluginApi", + "section": "def-server.DataViewsServerPluginStartDependencies", + "text": "DataViewsServerPluginStartDependencies" + }, + ") => { dataViewsServiceFactory: (savedObjectsClient: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClientContract", + "text": "SavedObjectsClientContract" + }, + ", elasticsearchClient: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ElasticsearchClient", + "text": "ElasticsearchClient" + }, + ", request?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + " | undefined, byPassCapabilities?: boolean | undefined) => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewsService", + "text": "DataViewsService" + }, + ">; }" + ], + "path": "src/plugins/data_views/server/plugin.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-server.DataViewsServerPlugin.start.$1", + "type": "Object", + "tags": [], + "label": "{ uiSettings, capabilities }", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreStart", + "text": "CoreStart" + } + ], + "path": "src/plugins/data_views/server/plugin.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "dataViews", + "id": "def-server.DataViewsServerPlugin.start.$2", + "type": "Object", + "tags": [], + "label": "{ fieldFormats }", + "description": [], + "signature": [ + { + "pluginId": "dataViews", + "scope": "server", + "docId": "kibDataViewsPluginApi", + "section": "def-server.DataViewsServerPluginStartDependencies", + "text": "DataViewsServerPluginStartDependencies" + } + ], + "path": "src/plugins/data_views/server/plugin.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, - "; createAndSave: (spec: ", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" - }, - ", override?: boolean, skipFetchFields?: boolean) => Promise<", + "parentPluginId": "dataViews", + "id": "def-server.DataViewsServerPlugin.stop", + "type": "Function", + "tags": [], + "label": "stop", + "description": [], + "signature": [ + "() => void" + ], + "path": "src/plugins/data_views/server/plugin.ts", + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "dataViews", + "id": "def-server.DataViewsService", + "type": "Class", + "tags": [], + "label": "DataViewsService", + "description": [ + "\nData views service, providing CRUD operations for data views." + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" + "parentPluginId": "dataViews", + "id": "def-server.DataViewsService.getCanSave", + "type": "Function", + "tags": [], + "label": "getCanSave", + "description": [ + "\nCan the user save data views?" + ], + "signature": [ + "() => Promise" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "returnComment": [], + "children": [] }, - ">; createSavedObject: (indexPattern: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - ", override?: boolean) => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - ">; updateSavedObject: (indexPattern: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - ", saveAttempts?: number, ignoreErrors?: boolean) => Promise; getDefaultDataView: () => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - " | null>; }" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": true, - "references": [ - { - "plugin": "data", - "path": "src/plugins/data/common/index.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/create_search_source.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/create_search_source.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source_service.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source_service.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/expressions/esaggs/esaggs_fn.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/expressions/esaggs/esaggs_fn.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/search/types.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/search/types.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/create_search_source.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/create_search_source.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/create_search_source.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source_service.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source_service.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/search/expressions/esaggs.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/search/expressions/esaggs.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/server/search/expressions/esaggs.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/server/search/expressions/esaggs.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/services.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/services.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/index.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/search/aggs/aggs_service.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/search/aggs/aggs_service.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/search/search_service.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/search/search_service.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/lazy_load_bundle/index.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/lazy_load_bundle/index.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/actions/filters/create_filters_from_range_select.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/actions/filters/create_filters_from_range_select.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/actions/filters/create_filters_from_value_click.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/actions/filters/create_filters_from_value_click.test.ts" - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "dataViews", - "id": "def-public.META_FIELDS", - "type": "string", - "tags": [], - "label": "META_FIELDS", - "description": [], - "signature": [ - "\"metaFields\"" - ], - "path": "src/plugins/data_views/common/constants.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "dataViews", - "id": "def-public.RuntimeType", - "type": "Type", - "tags": [], - "label": "RuntimeType", - "description": [], - "signature": [ - "\"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"long\" | \"double\" | \"composite\"" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "initialIsOpen": false - } - ], - "objects": [], - "setup": { - "parentPluginId": "dataViews", - "id": "def-public.DataViewsPublicPluginSetup", - "type": "Interface", - "tags": [], - "label": "DataViewsPublicPluginSetup", - "description": [ - "\nData plugin public Setup contract" - ], - "path": "src/plugins/data_views/public/types.ts", - "deprecated": false, - "children": [], - "lifecycle": "setup", - "initialIsOpen": true - }, - "start": { - "parentPluginId": "dataViews", - "id": "def-public.DataViewsContract", - "type": "Type", - "tags": [], - "label": "DataViewsContract", - "description": [], - "signature": [ - "DataViewsServicePublic" - ], - "path": "src/plugins/data_views/public/types.ts", - "deprecated": false, - "lifecycle": "start", - "initialIsOpen": true - } - }, - "server": { - "classes": [ - { - "parentPluginId": "dataViews", - "id": "def-server.DataViewsServerPlugin", - "type": "Class", - "tags": [], - "label": "DataViewsServerPlugin", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "server", - "docId": "kibDataViewsPluginApi", - "section": "def-server.DataViewsServerPlugin", - "text": "DataViewsServerPlugin" - }, - " implements ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.Plugin", - "text": "Plugin" - }, - "<", - { - "pluginId": "dataViews", - "scope": "server", - "docId": "kibDataViewsPluginApi", - "section": "def-server.DataViewsServerPluginSetup", - "text": "DataViewsServerPluginSetup" - }, - ", ", - { - "pluginId": "dataViews", - "scope": "server", - "docId": "kibDataViewsPluginApi", - "section": "def-server.DataViewsServerPluginStart", - "text": "DataViewsServerPluginStart" - }, - ", ", - "DataViewsServerPluginSetupDependencies", - ", ", - "DataViewsServerPluginStartDependencies", - ">" - ], - "path": "src/plugins/data_views/server/plugin.ts", - "deprecated": false, - "children": [ { "parentPluginId": "dataViews", - "id": "def-server.DataViewsServerPlugin.Unnamed", + "id": "def-server.DataViewsService.Unnamed", "type": "Function", "tags": [], "label": "Constructor", - "description": [], + "description": [ + "\nDataViewsService constructor" + ], "signature": [ "any" ], - "path": "src/plugins/data_views/server/plugin.ts", + "path": "src/plugins/data_views/common/data_views/data_views.ts", "deprecated": false, "children": [ { "parentPluginId": "dataViews", - "id": "def-server.DataViewsServerPlugin.Unnamed.$1", + "id": "def-server.DataViewsService.Unnamed.$1", "type": "Object", "tags": [], - "label": "initializerContext", - "description": [], + "label": "deps", + "description": [ + "Service dependencies" + ], "signature": [ { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.PluginInitializerContext", - "text": "PluginInitializerContext" - }, - "" + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewsServiceDeps", + "text": "DataViewsServiceDeps" + } ], - "path": "src/plugins/data_views/server/plugin.ts", + "path": "src/plugins/data_views/common/data_views/data_views.ts", "deprecated": false, "isRequired": true } @@ -7288,79 +8311,66 @@ }, { "parentPluginId": "dataViews", - "id": "def-server.DataViewsServerPlugin.setup", + "id": "def-server.DataViewsService.getIds", "type": "Function", "tags": [], - "label": "setup", - "description": [], + "label": "getIds", + "description": [ + "\nGets list of index pattern ids." + ], "signature": [ - "(core: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.CoreSetup", - "text": "CoreSetup" - }, - "<", - "DataViewsServerPluginStartDependencies", - ", ", - { - "pluginId": "dataViews", - "scope": "server", - "docId": "kibDataViewsPluginApi", - "section": "def-server.DataViewsServerPluginStart", - "text": "DataViewsServerPluginStart" - }, - ">, { expressions, usageCollection }: ", - "DataViewsServerPluginSetupDependencies", - ") => {}" - ], - "path": "src/plugins/data_views/server/plugin.ts", - "deprecated": false, - "children": [ + "(refresh?: boolean) => Promise" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ { "parentPluginId": "dataViews", - "id": "def-server.DataViewsServerPlugin.setup.$1", - "type": "Object", + "id": "def-server.DataViewsService.getIds.$1", + "type": "boolean", "tags": [], - "label": "core", - "description": [], + "label": "refresh", + "description": [ + "Force refresh of index pattern list" + ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.CoreSetup", - "text": "CoreSetup" - }, - "<", - "DataViewsServerPluginStartDependencies", - ", ", - { - "pluginId": "dataViews", - "scope": "server", - "docId": "kibDataViewsPluginApi", - "section": "def-server.DataViewsServerPluginStart", - "text": "DataViewsServerPluginStart" - }, - ">" + "boolean" ], - "path": "src/plugins/data_views/server/plugin.ts", + "path": "src/plugins/data_views/common/data_views/data_views.ts", "deprecated": false, "isRequired": true - }, + } + ], + "returnComment": [] + }, + { + "parentPluginId": "dataViews", + "id": "def-server.DataViewsService.getTitles", + "type": "Function", + "tags": [], + "label": "getTitles", + "description": [ + "\nGets list of index pattern titles." + ], + "signature": [ + "(refresh?: boolean) => Promise" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ { "parentPluginId": "dataViews", - "id": "def-server.DataViewsServerPlugin.setup.$2", - "type": "Object", + "id": "def-server.DataViewsService.getTitles.$1", + "type": "boolean", "tags": [], - "label": "{ expressions, usageCollection }", - "description": [], + "label": "refresh", + "description": [ + "Force refresh of index pattern list" + ], "signature": [ - "DataViewsServerPluginSetupDependencies" + "boolean" ], - "path": "src/plugins/data_views/server/plugin.ts", + "path": "src/plugins/data_views/common/data_views/data_views.ts", "deprecated": false, "isRequired": true } @@ -7369,200 +8379,100 @@ }, { "parentPluginId": "dataViews", - "id": "def-server.DataViewsServerPlugin.start", + "id": "def-server.DataViewsService.find", "type": "Function", "tags": [], - "label": "start", - "description": [], + "label": "find", + "description": [ + "\nFind and load index patterns by title." + ], "signature": [ - "({ uiSettings, capabilities }: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.CoreStart", - "text": "CoreStart" - }, - ", { fieldFormats }: ", - "DataViewsServerPluginStartDependencies", - ") => { indexPatternsServiceFactory: (savedObjectsClient: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClientContract", - "text": "SavedObjectsClientContract" - }, - ", elasticsearchClient: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ElasticsearchClient", - "text": "ElasticsearchClient" - }, - ", request?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - " | undefined, byPassCapabilities?: boolean | undefined) => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewsService", - "text": "DataViewsService" - }, - ">; dataViewsServiceFactory: (savedObjectsClient: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClientContract", - "text": "SavedObjectsClientContract" - }, - ", elasticsearchClient: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ElasticsearchClient", - "text": "ElasticsearchClient" - }, - ", request?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - " | undefined, byPassCapabilities?: boolean | undefined) => Promise<", + "(search: string, size?: number) => Promise<", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewsService", - "text": "DataViewsService" + "section": "def-common.DataView", + "text": "DataView" }, - ">; }" + "[]>" ], - "path": "src/plugins/data_views/server/plugin.ts", + "path": "src/plugins/data_views/common/data_views/data_views.ts", "deprecated": false, "children": [ { "parentPluginId": "dataViews", - "id": "def-server.DataViewsServerPlugin.start.$1", - "type": "Object", + "id": "def-server.DataViewsService.find.$1", + "type": "string", "tags": [], - "label": "{ uiSettings, capabilities }", - "description": [], + "label": "search", + "description": [ + "Search string" + ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.CoreStart", - "text": "CoreStart" - } + "string" ], - "path": "src/plugins/data_views/server/plugin.ts", + "path": "src/plugins/data_views/common/data_views/data_views.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "dataViews", - "id": "def-server.DataViewsServerPlugin.start.$2", - "type": "Object", + "id": "def-server.DataViewsService.find.$2", + "type": "number", "tags": [], - "label": "{ fieldFormats }", - "description": [], + "label": "size", + "description": [ + "Number of data views to return" + ], "signature": [ - "DataViewsServerPluginStartDependencies" + "number" ], - "path": "src/plugins/data_views/server/plugin.ts", + "path": "src/plugins/data_views/common/data_views/data_views.ts", "deprecated": false, "isRequired": true } ], - "returnComment": [] + "returnComment": [ + "DataView[]" + ] }, { "parentPluginId": "dataViews", - "id": "def-server.DataViewsServerPlugin.stop", + "id": "def-server.DataViewsService.getIdsWithTitle", "type": "Function", "tags": [], - "label": "stop", - "description": [], - "signature": [ - "() => void" + "label": "getIdsWithTitle", + "description": [ + "\nGets list of index pattern ids with titles." ], - "path": "src/plugins/data_views/server/plugin.ts", - "deprecated": false, - "children": [], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "dataViews", - "id": "def-server.IndexPatternsFetcher", - "type": "Class", - "tags": [], - "label": "IndexPatternsFetcher", - "description": [], - "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-server.IndexPatternsFetcher.Unnamed", - "type": "Function", - "tags": [], - "label": "Constructor", - "description": [], "signature": [ - "any" + "(refresh?: boolean) => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewListItem", + "text": "DataViewListItem" + }, + "[]>" ], - "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", + "path": "src/plugins/data_views/common/data_views/data_views.ts", "deprecated": false, "children": [ { "parentPluginId": "dataViews", - "id": "def-server.IndexPatternsFetcher.Unnamed.$1", - "type": "Object", - "tags": [], - "label": "elasticsearchClient", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ElasticsearchClient", - "text": "ElasticsearchClient" - } - ], - "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "dataViews", - "id": "def-server.IndexPatternsFetcher.Unnamed.$2", + "id": "def-server.DataViewsService.getIdsWithTitle.$1", "type": "boolean", "tags": [], - "label": "allowNoIndices", - "description": [], + "label": "refresh", + "description": [ + "Force refresh of index pattern list" + ], "signature": [ "boolean" ], - "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", + "path": "src/plugins/data_views/common/data_views/data_views.ts", "deprecated": false, "isRequired": true } @@ -7571,564 +8481,475 @@ }, { "parentPluginId": "dataViews", - "id": "def-server.IndexPatternsFetcher.getFieldsForWildcard", + "id": "def-server.DataViewsService.clearCache", "type": "Function", - "tags": [ - "property", - "property", - "return" - ], - "label": "getFieldsForWildcard", + "tags": [], + "label": "clearCache", "description": [ - "\n Get a list of field objects for an index pattern that may contain wildcards\n" + "\nClear index pattern list cache." ], "signature": [ - "(options: { pattern: string | string[]; metaFields?: string[] | undefined; fieldCapsOptions?: { allow_no_indices: boolean; } | undefined; type?: string | undefined; rollupIndex?: string | undefined; filter?: ", - "QueryDslQueryContainer", - " | undefined; }) => Promise<", - { - "pluginId": "dataViews", - "scope": "server", - "docId": "kibDataViewsPluginApi", - "section": "def-server.FieldDescriptor", - "text": "FieldDescriptor" - }, - "[]>" + "(id?: string | undefined) => void" ], - "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", + "path": "src/plugins/data_views/common/data_views/data_views.ts", "deprecated": false, "children": [ { "parentPluginId": "dataViews", - "id": "def-server.IndexPatternsFetcher.getFieldsForWildcard.$1", - "type": "Object", + "id": "def-server.DataViewsService.clearCache.$1", + "type": "string", "tags": [], - "label": "options", - "description": [], - "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", + "label": "id", + "description": [ + "optionally clear a single id" + ], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-server.IndexPatternsFetcher.getFieldsForWildcard.$1.pattern", - "type": "CompoundType", - "tags": [], - "label": "pattern", - "description": [], - "signature": [ - "string | string[]" - ], - "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-server.IndexPatternsFetcher.getFieldsForWildcard.$1.metaFields", - "type": "Array", - "tags": [], - "label": "metaFields", - "description": [], - "signature": [ - "string[] | undefined" - ], - "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-server.IndexPatternsFetcher.getFieldsForWildcard.$1.fieldCapsOptions", - "type": "Object", - "tags": [], - "label": "fieldCapsOptions", - "description": [], - "signature": [ - "{ allow_no_indices: boolean; } | undefined" - ], - "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-server.IndexPatternsFetcher.getFieldsForWildcard.$1.type", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-server.IndexPatternsFetcher.getFieldsForWildcard.$1.rollupIndex", - "type": "string", - "tags": [], - "label": "rollupIndex", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-server.IndexPatternsFetcher.getFieldsForWildcard.$1.filter", - "type": "Object", - "tags": [], - "label": "filter", - "description": [], - "signature": [ - "QueryDslQueryContainer", - " | undefined" - ], - "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", - "deprecated": false - } - ] + "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "dataViews", - "id": "def-server.IndexPatternsFetcher.getFieldsForTimePattern", + "id": "def-server.DataViewsService.getCache", "type": "Function", - "tags": [ - "property", - "property", - "property", - "return" + "tags": [], + "label": "getCache", + "description": [ + "\nGet cache, contains data view saved objects." + ], + "signature": [ + "() => Promise<", + "SavedObject", + "<", + "DataViewSavedObjectAttrs", + ">[] | null | undefined>" ], - "label": "getFieldsForTimePattern", + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "dataViews", + "id": "def-server.DataViewsService.getDefault", + "type": "Function", + "tags": [], + "label": "getDefault", "description": [ - "\n Get a list of field objects for a time pattern\n" + "\nGet default index pattern" ], "signature": [ - "(options: { pattern: string; metaFields: string[]; lookBack: number; interval: string; }) => Promise<", + "() => Promise<", { "pluginId": "dataViews", - "scope": "server", + "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-server.FieldDescriptor", - "text": "FieldDescriptor" + "section": "def-common.DataView", + "text": "DataView" }, - "[]>" + " | null>" ], - "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", + "path": "src/plugins/data_views/common/data_views/data_views.ts", "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-server.IndexPatternsFetcher.getFieldsForTimePattern.$1", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-server.IndexPatternsFetcher.getFieldsForTimePattern.$1.pattern", - "type": "string", - "tags": [], - "label": "pattern", - "description": [], - "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-server.IndexPatternsFetcher.getFieldsForTimePattern.$1.metaFields", - "type": "Array", - "tags": [], - "label": "metaFields", - "description": [], - "signature": [ - "string[]" - ], - "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-server.IndexPatternsFetcher.getFieldsForTimePattern.$1.lookBack", - "type": "number", - "tags": [], - "label": "lookBack", - "description": [], - "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-server.IndexPatternsFetcher.getFieldsForTimePattern.$1.interval", - "type": "string", - "tags": [], - "label": "interval", - "description": [], - "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", - "deprecated": false - } - ] - } - ], + "children": [], "returnComment": [] }, { "parentPluginId": "dataViews", - "id": "def-server.IndexPatternsFetcher.validatePatternListActive", + "id": "def-server.DataViewsService.getDefaultId", "type": "Function", - "tags": [ - "return" + "tags": [], + "label": "getDefaultId", + "description": [ + "\nGet default index pattern id" ], - "label": "validatePatternListActive", + "signature": [ + "() => Promise" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "dataViews", + "id": "def-server.DataViewsService.setDefault", + "type": "Function", + "tags": [], + "label": "setDefault", "description": [ - "\n Returns an index pattern list of only those index pattern strings in the given list that return indices\n" + "\nOptionally set default index pattern, unless force = true" ], "signature": [ - "(patternList: string[]) => Promise" + "(id: string | null, force?: boolean) => Promise" ], - "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", + "path": "src/plugins/data_views/common/data_views/data_views.ts", "deprecated": false, "children": [ { "parentPluginId": "dataViews", - "id": "def-server.IndexPatternsFetcher.validatePatternListActive.$1", - "type": "Array", + "id": "def-server.DataViewsService.setDefault.$1", + "type": "CompoundType", "tags": [], - "label": "patternList", + "label": "id", "description": [ - "string[]" + "data view id" ], "signature": [ - "string[]" + "string | null" ], - "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": false + }, + { + "parentPluginId": "dataViews", + "id": "def-server.DataViewsService.setDefault.$2", + "type": "boolean", + "tags": [], + "label": "force", + "description": [ + "set default data view even if there's an existing default" + ], + "signature": [ + "boolean" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] - } - ], - "initialIsOpen": false - } - ], - "functions": [ - { - "parentPluginId": "dataViews", - "id": "def-server.dataViewsServiceFactory", - "type": "Function", - "tags": [], - "label": "dataViewsServiceFactory", - "description": [], - "signature": [ - "({ logger, uiSettings, fieldFormats, capabilities, }: { logger: ", - "Logger", - "; uiSettings: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.UiSettingsServiceStart", - "text": "UiSettingsServiceStart" - }, - "; fieldFormats: ", - { - "pluginId": "fieldFormats", - "scope": "server", - "docId": "kibFieldFormatsPluginApi", - "section": "def-server.FieldFormatsStart", - "text": "FieldFormatsStart" - }, - "; capabilities: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.CapabilitiesStart", - "text": "CapabilitiesStart" - }, - "; }) => (savedObjectsClient: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClientContract", - "text": "SavedObjectsClientContract" - }, - ", elasticsearchClient: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ElasticsearchClient", - "text": "ElasticsearchClient" - }, - ", request?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" }, - " | undefined, byPassCapabilities?: boolean | undefined) => Promise<", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewsService", - "text": "DataViewsService" + "parentPluginId": "dataViews", + "id": "def-server.DataViewsService.hasUserDataView", + "type": "Function", + "tags": [], + "label": "hasUserDataView", + "description": [ + "\nChecks if current user has a user created index pattern ignoring fleet's server default index patterns." + ], + "signature": [ + "() => Promise" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, - ">" - ], - "path": "src/plugins/data_views/server/data_views_service_factory.ts", - "deprecated": false, - "children": [ { "parentPluginId": "dataViews", - "id": "def-server.dataViewsServiceFactory.$1", - "type": "Object", + "id": "def-server.DataViewsService.getFieldsForWildcard", + "type": "Function", "tags": [], - "label": "{\n logger,\n uiSettings,\n fieldFormats,\n capabilities,\n}", - "description": [], - "path": "src/plugins/data_views/server/data_views_service_factory.ts", + "label": "getFieldsForWildcard", + "description": [ + "\nGet field list by providing { pattern }." + ], + "signature": [ + "(options: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.GetFieldsOptions", + "text": "GetFieldsOptions" + }, + ") => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + "[]>" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", "deprecated": false, "children": [ { "parentPluginId": "dataViews", - "id": "def-server.dataViewsServiceFactory.$1.logger", + "id": "def-server.DataViewsService.getFieldsForWildcard.$1", "type": "Object", "tags": [], - "label": "logger", - "description": [], + "label": "options", + "description": [ + "options for getting field list" + ], "signature": [ - "Logger" + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.GetFieldsOptions", + "text": "GetFieldsOptions" + } ], - "path": "src/plugins/data_views/server/data_views_service_factory.ts", - "deprecated": false + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [ + "FieldSpec[]" + ] + }, + { + "parentPluginId": "dataViews", + "id": "def-server.DataViewsService.getFieldsForIndexPattern", + "type": "Function", + "tags": [], + "label": "getFieldsForIndexPattern", + "description": [ + "\nGet field list by providing an index patttern (or spec)." + ], + "signature": [ + "(indexPattern: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + " | ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewSpec", + "text": "DataViewSpec" + }, + ", options?: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.GetFieldsOptions", + "text": "GetFieldsOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" }, + "[]>" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ { "parentPluginId": "dataViews", - "id": "def-server.dataViewsServiceFactory.$1.uiSettings", - "type": "Object", + "id": "def-server.DataViewsService.getFieldsForIndexPattern.$1", + "type": "CompoundType", "tags": [], - "label": "uiSettings", + "label": "indexPattern", "description": [], "signature": [ { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.UiSettingsServiceStart", - "text": "UiSettingsServiceStart" + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + " | ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewSpec", + "text": "DataViewSpec" } ], - "path": "src/plugins/data_views/server/data_views_service_factory.ts", - "deprecated": false + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true }, { "parentPluginId": "dataViews", - "id": "def-server.dataViewsServiceFactory.$1.fieldFormats", + "id": "def-server.DataViewsService.getFieldsForIndexPattern.$2", "type": "Object", "tags": [], - "label": "fieldFormats", - "description": [], + "label": "options", + "description": [ + "options for getting field list" + ], "signature": [ { - "pluginId": "fieldFormats", - "scope": "server", - "docId": "kibFieldFormatsPluginApi", - "section": "def-server.FieldFormatsStart", - "text": "FieldFormatsStart" - } + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.GetFieldsOptions", + "text": "GetFieldsOptions" + }, + " | undefined" ], - "path": "src/plugins/data_views/server/data_views_service_factory.ts", - "deprecated": false + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [ + "FieldSpec[]" + ] + }, + { + "parentPluginId": "dataViews", + "id": "def-server.DataViewsService.refreshFields", + "type": "Function", + "tags": [], + "label": "refreshFields", + "description": [ + "\nRefresh field list for a given index pattern." + ], + "signature": [ + "(indexPattern: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" }, + ") => Promise" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ { "parentPluginId": "dataViews", - "id": "def-server.dataViewsServiceFactory.$1.capabilities", + "id": "def-server.DataViewsService.refreshFields.$1", "type": "Object", "tags": [], - "label": "capabilities", + "label": "indexPattern", "description": [], "signature": [ { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.CapabilitiesStart", - "text": "CapabilitiesStart" + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" } ], - "path": "src/plugins/data_views/server/data_views_service_factory.ts", - "deprecated": false + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true } - ] - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "dataViews", - "id": "def-server.findIndexPatternById", - "type": "Function", - "tags": [], - "label": "findIndexPatternById", - "description": [], - "signature": [ - "(savedObjectsClient: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClientContract", - "text": "SavedObjectsClientContract" - }, - ", index: string) => Promise<", - "SavedObject", - "<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewAttributes", - "text": "DataViewAttributes" + ], + "returnComment": [] }, - "> | undefined>" - ], - "path": "src/plugins/data_views/server/utils.ts", - "deprecated": false, - "children": [ { "parentPluginId": "dataViews", - "id": "def-server.findIndexPatternById.$1", - "type": "Object", + "id": "def-server.DataViewsService.fieldArrayToMap", + "type": "Function", "tags": [], - "label": "savedObjectsClient", - "description": [], + "label": "fieldArrayToMap", + "description": [ + "\nConverts field array to map." + ], "signature": [ + "(fields: ", { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClientContract", - "text": "SavedObjectsClientContract" + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + "[], fieldAttrs?: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldAttrs", + "text": "FieldAttrs" + }, + " | undefined) => ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewFieldMap", + "text": "DataViewFieldMap" } ], - "path": "src/plugins/data_views/server/utils.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "dataViews", - "id": "def-server.findIndexPatternById.$2", - "type": "string", - "tags": [], - "label": "index", - "description": [], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/server/utils.ts", + "path": "src/plugins/data_views/common/data_views/data_views.ts", "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "dataViews", - "id": "def-server.getCapabilitiesForRollupIndices", - "type": "Function", - "tags": [], - "label": "getCapabilitiesForRollupIndices", - "description": [], - "signature": [ - "(indices: Record) => { [key: string]: any; }" - ], - "path": "src/plugins/data_views/server/fetcher/lib/map_capabilities.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-server.getCapabilitiesForRollupIndices.$1", - "type": "Object", - "tags": [], - "label": "indices", - "description": [], - "signature": [ - "Record" + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-server.DataViewsService.fieldArrayToMap.$1", + "type": "Array", + "tags": [], + "label": "fields", + "description": [ + ": FieldSpec[]" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + "[]" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "dataViews", + "id": "def-server.DataViewsService.fieldArrayToMap.$2", + "type": "Object", + "tags": [], + "label": "fieldAttrs", + "description": [ + ": FieldAttrs" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldAttrs", + "text": "FieldAttrs" + }, + " | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": false + } ], - "path": "src/plugins/data_views/server/fetcher/lib/map_capabilities.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "dataViews", - "id": "def-server.getFieldByName", - "type": "Function", - "tags": [], - "label": "getFieldByName", - "description": [], - "signature": [ - "(fieldName: string, indexPattern: ", - "SavedObject", - "<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewAttributes", - "text": "DataViewAttributes" - }, - ">) => ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" + "returnComment": [ + "Record" + ] }, - " | undefined" - ], - "path": "src/plugins/data_views/server/utils.ts", - "deprecated": false, - "children": [ { "parentPluginId": "dataViews", - "id": "def-server.getFieldByName.$1", - "type": "string", + "id": "def-server.DataViewsService.savedObjectToSpec", + "type": "Function", "tags": [], - "label": "fieldName", - "description": [], - "signature": [ - "string" + "label": "savedObjectToSpec", + "description": [ + "\nConverts data view saved object to data view spec." ], - "path": "src/plugins/data_views/server/utils.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "dataViews", - "id": "def-server.getFieldByName.$2", - "type": "Object", - "tags": [], - "label": "indexPattern", - "description": [], "signature": [ + "(savedObject: ", "SavedObject", "<", { @@ -8138,8919 +8959,7205 @@ "section": "def-common.DataViewAttributes", "text": "DataViewAttributes" }, - ">" + ">) => ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewSpec", + "text": "DataViewSpec" + } ], - "path": "src/plugins/data_views/server/utils.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "dataViews", - "id": "def-server.mergeCapabilitiesWithFields", - "type": "Function", - "tags": [], - "label": "mergeCapabilitiesWithFields", - "description": [], - "signature": [ - "(rollupIndexCapabilities: { [key: string]: any; }, fieldsFromFieldCapsApi: Record, previousFields?: ", - { - "pluginId": "dataViews", - "scope": "server", - "docId": "kibDataViewsPluginApi", - "section": "def-server.FieldDescriptor", - "text": "FieldDescriptor" - }, - "[]) => ", - { - "pluginId": "dataViews", - "scope": "server", - "docId": "kibDataViewsPluginApi", - "section": "def-server.FieldDescriptor", - "text": "FieldDescriptor" - }, - "[]" - ], - "path": "src/plugins/data_views/server/fetcher/lib/merge_capabilities_with_fields.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-server.mergeCapabilitiesWithFields.$1", - "type": "Object", - "tags": [], - "label": "rollupIndexCapabilities", - "description": [], - "path": "src/plugins/data_views/server/fetcher/lib/merge_capabilities_with_fields.ts", + "path": "src/plugins/data_views/common/data_views/data_views.ts", "deprecated": false, "children": [ { "parentPluginId": "dataViews", - "id": "def-server.mergeCapabilitiesWithFields.$1.Unnamed", - "type": "IndexSignature", + "id": "def-server.DataViewsService.savedObjectToSpec.$1", + "type": "Object", "tags": [], - "label": "[key: string]: any", + "label": "savedObject", "description": [], "signature": [ - "[key: string]: any" + "SavedObject", + "<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewAttributes", + "text": "DataViewAttributes" + }, + ">" ], - "path": "src/plugins/data_views/server/fetcher/lib/merge_capabilities_with_fields.ts", - "deprecated": false + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true } + ], + "returnComment": [ + "DataViewSpec" ] }, { "parentPluginId": "dataViews", - "id": "def-server.mergeCapabilitiesWithFields.$2", - "type": "Object", + "id": "def-server.DataViewsService.get", + "type": "Function", "tags": [], - "label": "fieldsFromFieldCapsApi", - "description": [], + "label": "get", + "description": [ + "\nGet an index pattern by id, cache optimized." + ], "signature": [ - "Record Promise<", { "pluginId": "dataViews", - "scope": "server", + "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-server.FieldDescriptor", - "text": "FieldDescriptor" + "section": "def-common.DataView", + "text": "DataView" }, ">" ], - "path": "src/plugins/data_views/server/fetcher/lib/merge_capabilities_with_fields.ts", + "path": "src/plugins/data_views/common/data_views/data_views.ts", "deprecated": false, - "isRequired": true + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-server.DataViewsService.get.$1", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "dataViews", - "id": "def-server.mergeCapabilitiesWithFields.$3", - "type": "Array", + "id": "def-server.DataViewsService.create", + "type": "Function", "tags": [], - "label": "previousFields", - "description": [], + "label": "create", + "description": [ + "\nCreate a new data view instance." + ], "signature": [ + "(spec: ", { "pluginId": "dataViews", - "scope": "server", + "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-server.FieldDescriptor", - "text": "FieldDescriptor" + "section": "def-common.DataViewSpec", + "text": "DataViewSpec" }, - "[]" + ", skipFetchFields?: boolean) => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + ">" ], - "path": "src/plugins/data_views/server/fetcher/lib/merge_capabilities_with_fields.ts", + "path": "src/plugins/data_views/common/data_views/data_views.ts", "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "dataViews", - "id": "def-server.shouldReadFieldFromDocValues", - "type": "Function", - "tags": [], - "label": "shouldReadFieldFromDocValues", - "description": [], - "signature": [ - "(aggregatable: boolean, esType: string) => boolean" - ], - "path": "src/plugins/data_views/server/fetcher/lib/field_capabilities/should_read_field_from_doc_values.ts", - "deprecated": false, - "children": [ + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-server.DataViewsService.create.$1", + "type": "Object", + "tags": [], + "label": "spec", + "description": [ + "data view spec" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewSpec", + "text": "DataViewSpec" + } + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "dataViews", + "id": "def-server.DataViewsService.create.$2", + "type": "boolean", + "tags": [], + "label": "skipFetchFields", + "description": [ + "if true, will not fetch fields" + ], + "signature": [ + "boolean" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [ + "DataView" + ] + }, { "parentPluginId": "dataViews", - "id": "def-server.shouldReadFieldFromDocValues.$1", - "type": "boolean", + "id": "def-server.DataViewsService.createAndSave", + "type": "Function", "tags": [], - "label": "aggregatable", - "description": [], + "label": "createAndSave", + "description": [ + "\nCreate a new data view and save it right away." + ], "signature": [ - "boolean" + "(spec: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewSpec", + "text": "DataViewSpec" + }, + ", override?: boolean, skipFetchFields?: boolean) => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + ">" ], - "path": "src/plugins/data_views/server/fetcher/lib/field_capabilities/should_read_field_from_doc_values.ts", + "path": "src/plugins/data_views/common/data_views/data_views.ts", "deprecated": false, - "isRequired": true + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-server.DataViewsService.createAndSave.$1", + "type": "Object", + "tags": [], + "label": "spec", + "description": [ + "data view spec" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewSpec", + "text": "DataViewSpec" + } + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "dataViews", + "id": "def-server.DataViewsService.createAndSave.$2", + "type": "boolean", + "tags": [], + "label": "override", + "description": [ + "Overwrite if existing index pattern exists." + ], + "signature": [ + "boolean" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "dataViews", + "id": "def-server.DataViewsService.createAndSave.$3", + "type": "boolean", + "tags": [], + "label": "skipFetchFields", + "description": [ + "Whether to skip field refresh step." + ], + "signature": [ + "boolean" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "dataViews", - "id": "def-server.shouldReadFieldFromDocValues.$2", - "type": "string", + "id": "def-server.DataViewsService.createSavedObject", + "type": "Function", "tags": [], - "label": "esType", - "description": [], + "label": "createSavedObject", + "description": [ + "\nSave a new data view." + ], "signature": [ - "string" + "(dataView: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + ", override?: boolean) => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + ">" ], - "path": "src/plugins/data_views/server/fetcher/lib/field_capabilities/should_read_field_from_doc_values.ts", + "path": "src/plugins/data_views/common/data_views/data_views.ts", "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - } - ], - "interfaces": [ - { - "parentPluginId": "dataViews", - "id": "def-server.FieldDescriptor", - "type": "Interface", - "tags": [], - "label": "FieldDescriptor", - "description": [], - "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-server.FieldDescriptor.aggregatable", - "type": "boolean", - "tags": [], - "label": "aggregatable", - "description": [], - "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-server.FieldDescriptor.name", - "type": "string", - "tags": [], - "label": "name", - "description": [], - "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-server.FieldDescriptor.readFromDocValues", - "type": "boolean", - "tags": [], - "label": "readFromDocValues", - "description": [], - "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-server.FieldDescriptor.searchable", - "type": "boolean", - "tags": [], - "label": "searchable", - "description": [], - "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-server.FieldDescriptor.type", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", - "deprecated": false + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-server.DataViewsService.createSavedObject.$1", + "type": "Object", + "tags": [], + "label": "dataView", + "description": [ + "data view instance" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + } + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "dataViews", + "id": "def-server.DataViewsService.createSavedObject.$2", + "type": "boolean", + "tags": [], + "label": "override", + "description": [ + "Overwrite if existing index pattern exists" + ], + "signature": [ + "boolean" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "dataViews", - "id": "def-server.FieldDescriptor.esTypes", - "type": "Array", + "id": "def-server.DataViewsService.updateSavedObject", + "type": "Function", "tags": [], - "label": "esTypes", - "description": [], + "label": "updateSavedObject", + "description": [ + "\nSave existing dat aview. Will attempt to merge differences if there are conflicts." + ], "signature": [ - "string[]" + "(indexPattern: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + ", saveAttempts?: number, ignoreErrors?: boolean) => Promise" ], - "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", - "deprecated": false + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-server.DataViewsService.updateSavedObject.$1", + "type": "Object", + "tags": [], + "label": "indexPattern", + "description": [], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + } + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "dataViews", + "id": "def-server.DataViewsService.updateSavedObject.$2", + "type": "number", + "tags": [], + "label": "saveAttempts", + "description": [], + "signature": [ + "number" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "dataViews", + "id": "def-server.DataViewsService.updateSavedObject.$3", + "type": "boolean", + "tags": [], + "label": "ignoreErrors", + "description": [], + "signature": [ + "boolean" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "dataViews", - "id": "def-server.FieldDescriptor.subType", - "type": "Object", + "id": "def-server.DataViewsService.delete", + "type": "Function", "tags": [], - "label": "subType", - "description": [], + "label": "delete", + "description": [ + "\nDeletes an index pattern from .kibana index." + ], "signature": [ - "FieldSubType | undefined" + "(indexPatternId: string) => Promise<{}>" ], - "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", - "deprecated": false + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-server.DataViewsService.delete.$1", + "type": "string", + "tags": [], + "label": "indexPatternId", + "description": [ + ": Id of kibana Index Pattern to delete" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "dataViews", - "id": "def-server.FieldDescriptor.metadata_field", - "type": "CompoundType", + "id": "def-server.DataViewsService.getDefaultDataView", + "type": "Function", "tags": [], - "label": "metadata_field", - "description": [], + "label": "getDefaultDataView", + "description": [ + "\nReturns the default data view as an object.\nIf no default is found, or it is missing\nanother data view is selected as default and returned.\nIf no possible data view found to become a default returns null.\n" + ], "signature": [ - "boolean | undefined" + "() => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + " | null>" ], - "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", - "deprecated": false + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [], + "returnComment": [ + "default data view" + ] } ], "initialIsOpen": false - } - ], - "enums": [], - "misc": [ - { - "parentPluginId": "dataViews", - "id": "def-server.DATA_VIEW_PATH", - "type": "string", - "tags": [], - "label": "DATA_VIEW_PATH", - "description": [], - "path": "src/plugins/data_views/server/constants.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "dataViews", - "id": "def-server.DATA_VIEW_PATH_LEGACY", - "type": "string", - "tags": [], - "label": "DATA_VIEW_PATH_LEGACY", - "description": [], - "path": "src/plugins/data_views/server/constants.ts", - "deprecated": false, - "initialIsOpen": false }, { "parentPluginId": "dataViews", - "id": "def-server.RUNTIME_FIELD_PATH", - "type": "string", + "id": "def-server.IndexPatternsFetcher", + "type": "Class", "tags": [], - "label": "RUNTIME_FIELD_PATH", + "label": "IndexPatternsFetcher", "description": [], - "path": "src/plugins/data_views/server/constants.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "dataViews", - "id": "def-server.RUNTIME_FIELD_PATH_LEGACY", - "type": "string", - "tags": [], - "label": "RUNTIME_FIELD_PATH_LEGACY", - "description": [], - "path": "src/plugins/data_views/server/constants.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "dataViews", - "id": "def-server.SCRIPTED_FIELD_PATH", - "type": "string", - "tags": [], - "label": "SCRIPTED_FIELD_PATH", - "description": [], - "path": "src/plugins/data_views/server/constants.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "dataViews", - "id": "def-server.SCRIPTED_FIELD_PATH_LEGACY", - "type": "string", - "tags": [], - "label": "SCRIPTED_FIELD_PATH_LEGACY", - "description": [], - "path": "src/plugins/data_views/server/constants.ts", + "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-server.IndexPatternsFetcher.Unnamed", + "type": "Function", + "tags": [], + "label": "Constructor", + "description": [], + "signature": [ + "any" + ], + "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-server.IndexPatternsFetcher.Unnamed.$1", + "type": "Object", + "tags": [], + "label": "elasticsearchClient", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ElasticsearchClient", + "text": "ElasticsearchClient" + } + ], + "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "dataViews", + "id": "def-server.IndexPatternsFetcher.Unnamed.$2", + "type": "boolean", + "tags": [], + "label": "allowNoIndices", + "description": [], + "signature": [ + "boolean" + ], + "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "dataViews", + "id": "def-server.IndexPatternsFetcher.getFieldsForWildcard", + "type": "Function", + "tags": [ + "property", + "property", + "return" + ], + "label": "getFieldsForWildcard", + "description": [ + "\n Get a list of field objects for an index pattern that may contain wildcards\n" + ], + "signature": [ + "(options: { pattern: string | string[]; metaFields?: string[] | undefined; fieldCapsOptions?: { allow_no_indices: boolean; } | undefined; type?: string | undefined; rollupIndex?: string | undefined; filter?: ", + "QueryDslQueryContainer", + " | undefined; }) => Promise<", + { + "pluginId": "dataViews", + "scope": "server", + "docId": "kibDataViewsPluginApi", + "section": "def-server.FieldDescriptor", + "text": "FieldDescriptor" + }, + "[]>" + ], + "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-server.IndexPatternsFetcher.getFieldsForWildcard.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-server.IndexPatternsFetcher.getFieldsForWildcard.$1.pattern", + "type": "CompoundType", + "tags": [], + "label": "pattern", + "description": [], + "signature": [ + "string | string[]" + ], + "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", + "deprecated": false + }, + { + "parentPluginId": "dataViews", + "id": "def-server.IndexPatternsFetcher.getFieldsForWildcard.$1.metaFields", + "type": "Array", + "tags": [], + "label": "metaFields", + "description": [], + "signature": [ + "string[] | undefined" + ], + "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", + "deprecated": false + }, + { + "parentPluginId": "dataViews", + "id": "def-server.IndexPatternsFetcher.getFieldsForWildcard.$1.fieldCapsOptions", + "type": "Object", + "tags": [], + "label": "fieldCapsOptions", + "description": [], + "signature": [ + "{ allow_no_indices: boolean; } | undefined" + ], + "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", + "deprecated": false + }, + { + "parentPluginId": "dataViews", + "id": "def-server.IndexPatternsFetcher.getFieldsForWildcard.$1.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", + "deprecated": false + }, + { + "parentPluginId": "dataViews", + "id": "def-server.IndexPatternsFetcher.getFieldsForWildcard.$1.rollupIndex", + "type": "string", + "tags": [], + "label": "rollupIndex", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", + "deprecated": false + }, + { + "parentPluginId": "dataViews", + "id": "def-server.IndexPatternsFetcher.getFieldsForWildcard.$1.filter", + "type": "Object", + "tags": [], + "label": "filter", + "description": [], + "signature": [ + "QueryDslQueryContainer", + " | undefined" + ], + "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", + "deprecated": false + } + ] + } + ], + "returnComment": [] + }, + { + "parentPluginId": "dataViews", + "id": "def-server.IndexPatternsFetcher.validatePatternListActive", + "type": "Function", + "tags": [ + "return" + ], + "label": "validatePatternListActive", + "description": [ + "\n Returns an index pattern list of only those index pattern strings in the given list that return indices\n" + ], + "signature": [ + "(patternList: string[]) => Promise" + ], + "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-server.IndexPatternsFetcher.validatePatternListActive.$1", + "type": "Array", + "tags": [], + "label": "patternList", + "description": [ + "string[]" + ], + "signature": [ + "string[]" + ], + "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], "initialIsOpen": false - }, + } + ], + "functions": [ { "parentPluginId": "dataViews", - "id": "def-server.SERVICE_KEY", - "type": "string", + "id": "def-server.dataViewsServiceFactory", + "type": "Function", "tags": [], - "label": "SERVICE_KEY", - "description": [], - "signature": [ - "\"data_view\"" + "label": "dataViewsServiceFactory", + "description": [ + "\nCreates a new DataViewsService instance." ], - "path": "src/plugins/data_views/server/constants.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "dataViews", - "id": "def-server.SERVICE_KEY_LEGACY", - "type": "string", - "tags": [], - "label": "SERVICE_KEY_LEGACY", - "description": [], "signature": [ - "\"index_pattern\"" + "(deps: DataViewsServiceFactoryDeps) => (savedObjectsClient: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClientContract", + "text": "SavedObjectsClientContract" + }, + ", elasticsearchClient: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ElasticsearchClient", + "text": "ElasticsearchClient" + }, + ", request?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + " | undefined, byPassCapabilities?: boolean | undefined) => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewsService", + "text": "DataViewsService" + }, + ">" ], - "path": "src/plugins/data_views/server/constants.ts", + "path": "src/plugins/data_views/server/data_views_service_factory.ts", "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-server.dataViewsServiceFactory.$1", + "type": "Object", + "tags": [], + "label": "deps", + "description": [ + "- Dependencies required by the DataViewsService" + ], + "signature": [ + "DataViewsServiceFactoryDeps" + ], + "path": "src/plugins/data_views/server/data_views_service_factory.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "dataViews", - "id": "def-server.SERVICE_KEY_TYPE", - "type": "Type", - "tags": [], - "label": "SERVICE_KEY_TYPE", + "id": "def-server.findIndexPatternById", + "type": "Function", + "tags": [ + "deprecated" + ], + "label": "findIndexPatternById", "description": [], "signature": [ - "\"index_pattern\" | \"data_view\"" + "(savedObjectsClient: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClientContract", + "text": "SavedObjectsClientContract" + }, + ", index: string) => Promise<", + "SavedObject", + "<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewAttributes", + "text": "DataViewAttributes" + }, + "> | undefined>" ], - "path": "src/plugins/data_views/server/constants.ts", - "deprecated": false, + "path": "src/plugins/data_views/server/utils.ts", + "deprecated": true, + "references": [ + { + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/server/autocomplete/terms_enum.ts" + }, + { + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/server/autocomplete/terms_enum.ts" + }, + { + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/server/autocomplete/terms_agg.ts" + }, + { + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/server/autocomplete/terms_agg.ts" + } + ], + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-server.findIndexPatternById.$1", + "type": "Object", + "tags": [], + "label": "savedObjectsClient", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClientContract", + "text": "SavedObjectsClientContract" + } + ], + "path": "src/plugins/data_views/server/utils.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "dataViews", + "id": "def-server.findIndexPatternById.$2", + "type": "string", + "tags": [], + "label": "index", + "description": [], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/server/utils.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "dataViews", - "id": "def-server.SERVICE_PATH", - "type": "string", + "id": "def-server.getCapabilitiesForRollupIndices", + "type": "Function", "tags": [], - "label": "SERVICE_PATH", - "description": [], + "label": "getCapabilitiesForRollupIndices", + "description": [ + "\nGet rollup job capabilities" + ], "signature": [ - "\"/api/data_views\"" + "(indices: Record) => { [key: string]: any; }" ], - "path": "src/plugins/data_views/server/constants.ts", + "path": "src/plugins/data_views/server/fetcher/lib/map_capabilities.ts", "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-server.getCapabilitiesForRollupIndices.$1", + "type": "Object", + "tags": [], + "label": "indices", + "description": [ + "rollup job index capabilites" + ], + "signature": [ + "Record" + ], + "path": "src/plugins/data_views/server/fetcher/lib/map_capabilities.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "dataViews", - "id": "def-server.SERVICE_PATH_LEGACY", - "type": "string", - "tags": [], - "label": "SERVICE_PATH_LEGACY", + "id": "def-server.getFieldByName", + "type": "Function", + "tags": [ + "deprecated" + ], + "label": "getFieldByName", "description": [], "signature": [ - "\"/api/index_patterns\"" + "(fieldName: string, indexPattern: ", + "SavedObject", + "<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewAttributes", + "text": "DataViewAttributes" + }, + ">) => ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + " | undefined" ], - "path": "src/plugins/data_views/server/constants.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "dataViews", - "id": "def-server.SPECIFIC_DATA_VIEW_PATH", - "type": "string", - "tags": [], - "label": "SPECIFIC_DATA_VIEW_PATH", - "description": [], - "path": "src/plugins/data_views/server/constants.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "dataViews", - "id": "def-server.SPECIFIC_DATA_VIEW_PATH_LEGACY", - "type": "string", - "tags": [], - "label": "SPECIFIC_DATA_VIEW_PATH_LEGACY", - "description": [], - "path": "src/plugins/data_views/server/constants.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "dataViews", - "id": "def-server.SPECIFIC_RUNTIME_FIELD_PATH", - "type": "string", - "tags": [], - "label": "SPECIFIC_RUNTIME_FIELD_PATH", - "description": [], - "path": "src/plugins/data_views/server/constants.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "dataViews", - "id": "def-server.SPECIFIC_RUNTIME_FIELD_PATH_LEGACY", - "type": "string", - "tags": [], - "label": "SPECIFIC_RUNTIME_FIELD_PATH_LEGACY", - "description": [], - "path": "src/plugins/data_views/server/constants.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "dataViews", - "id": "def-server.SPECIFIC_SCRIPTED_FIELD_PATH", - "type": "string", + "path": "src/plugins/data_views/server/utils.ts", + "deprecated": true, + "references": [ + { + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/server/autocomplete/terms_enum.ts" + }, + { + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/server/autocomplete/terms_enum.ts" + }, + { + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/server/autocomplete/terms_agg.ts" + }, + { + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/server/autocomplete/terms_agg.ts" + } + ], + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-server.getFieldByName.$1", + "type": "string", + "tags": [], + "label": "fieldName", + "description": [], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/server/utils.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "dataViews", + "id": "def-server.getFieldByName.$2", + "type": "Object", + "tags": [], + "label": "indexPattern", + "description": [], + "signature": [ + "SavedObject", + "<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewAttributes", + "text": "DataViewAttributes" + }, + ">" + ], + "path": "src/plugins/data_views/server/utils.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [ + { + "parentPluginId": "dataViews", + "id": "def-server.DataViewsServerPluginSetupDependencies", + "type": "Interface", "tags": [], - "label": "SPECIFIC_SCRIPTED_FIELD_PATH", - "description": [], - "path": "src/plugins/data_views/server/constants.ts", + "label": "DataViewsServerPluginSetupDependencies", + "description": [ + "\nData Views server setup dependencies" + ], + "path": "src/plugins/data_views/server/types.ts", "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-server.DataViewsServerPluginSetupDependencies.fieldFormats", + "type": "Object", + "tags": [], + "label": "fieldFormats", + "description": [ + "\nFile formats" + ], + "signature": [ + { + "pluginId": "fieldFormats", + "scope": "server", + "docId": "kibFieldFormatsPluginApi", + "section": "def-server.FieldFormatsSetup", + "text": "FieldFormatsSetup" + } + ], + "path": "src/plugins/data_views/server/types.ts", + "deprecated": false + }, + { + "parentPluginId": "dataViews", + "id": "def-server.DataViewsServerPluginSetupDependencies.expressions", + "type": "Object", + "tags": [], + "label": "expressions", + "description": [ + "\nExpressions" + ], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionsServiceSetup", + "text": "ExpressionsServiceSetup" + } + ], + "path": "src/plugins/data_views/server/types.ts", + "deprecated": false + }, + { + "parentPluginId": "dataViews", + "id": "def-server.DataViewsServerPluginSetupDependencies.usageCollection", + "type": "Object", + "tags": [], + "label": "usageCollection", + "description": [ + "\nUsage collection" + ], + "signature": [ + { + "pluginId": "usageCollection", + "scope": "server", + "docId": "kibUsageCollectionPluginApi", + "section": "def-server.UsageCollectionSetup", + "text": "UsageCollectionSetup" + }, + " | undefined" + ], + "path": "src/plugins/data_views/server/types.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { "parentPluginId": "dataViews", - "id": "def-server.SPECIFIC_SCRIPTED_FIELD_PATH_LEGACY", - "type": "string", + "id": "def-server.DataViewsServerPluginStartDependencies", + "type": "Interface", "tags": [], - "label": "SPECIFIC_SCRIPTED_FIELD_PATH_LEGACY", + "label": "DataViewsServerPluginStartDependencies", + "description": [ + "\nData Views server start dependencies" + ], + "path": "src/plugins/data_views/server/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-server.DataViewsServerPluginStartDependencies.fieldFormats", + "type": "Object", + "tags": [], + "label": "fieldFormats", + "description": [ + "\nField formats" + ], + "signature": [ + { + "pluginId": "fieldFormats", + "scope": "server", + "docId": "kibFieldFormatsPluginApi", + "section": "def-server.FieldFormatsStart", + "text": "FieldFormatsStart" + } + ], + "path": "src/plugins/data_views/server/types.ts", + "deprecated": false + }, + { + "parentPluginId": "dataViews", + "id": "def-server.DataViewsServerPluginStartDependencies.logger", + "type": "Object", + "tags": [], + "label": "logger", + "description": [ + "\nLogger" + ], + "signature": [ + "Logger" + ], + "path": "src/plugins/data_views/server/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "dataViews", + "id": "def-server.FieldDescriptor", + "type": "Interface", + "tags": [], + "label": "FieldDescriptor", "description": [], - "path": "src/plugins/data_views/server/constants.ts", + "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-server.FieldDescriptor.aggregatable", + "type": "boolean", + "tags": [], + "label": "aggregatable", + "description": [], + "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", + "deprecated": false + }, + { + "parentPluginId": "dataViews", + "id": "def-server.FieldDescriptor.name", + "type": "string", + "tags": [], + "label": "name", + "description": [], + "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", + "deprecated": false + }, + { + "parentPluginId": "dataViews", + "id": "def-server.FieldDescriptor.readFromDocValues", + "type": "boolean", + "tags": [], + "label": "readFromDocValues", + "description": [], + "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", + "deprecated": false + }, + { + "parentPluginId": "dataViews", + "id": "def-server.FieldDescriptor.searchable", + "type": "boolean", + "tags": [], + "label": "searchable", + "description": [], + "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", + "deprecated": false + }, + { + "parentPluginId": "dataViews", + "id": "def-server.FieldDescriptor.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", + "deprecated": false + }, + { + "parentPluginId": "dataViews", + "id": "def-server.FieldDescriptor.esTypes", + "type": "Array", + "tags": [], + "label": "esTypes", + "description": [], + "signature": [ + "string[]" + ], + "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", + "deprecated": false + }, + { + "parentPluginId": "dataViews", + "id": "def-server.FieldDescriptor.subType", + "type": "Object", + "tags": [], + "label": "subType", + "description": [], + "signature": [ + "FieldSubType | undefined" + ], + "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", + "deprecated": false + }, + { + "parentPluginId": "dataViews", + "id": "def-server.FieldDescriptor.metadata_field", + "type": "CompoundType", + "tags": [], + "label": "metadata_field", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", + "deprecated": false + } + ], "initialIsOpen": false - } - ], - "objects": [], - "start": { - "parentPluginId": "dataViews", - "id": "def-server.DataViewsServerPluginStart", - "type": "Interface", - "tags": [], - "label": "DataViewsServerPluginStart", - "description": [], - "path": "src/plugins/data_views/server/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-server.DataViewsServerPluginStart.dataViewsServiceFactory", - "type": "Function", - "tags": [], - "label": "dataViewsServiceFactory", - "description": [], - "signature": [ - "(savedObjectsClient: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClientContract", - "text": "SavedObjectsClientContract" - }, - ", elasticsearchClient: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ElasticsearchClient", - "text": "ElasticsearchClient" - }, - ", request?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - " | undefined, byPassCapabilities?: boolean | undefined) => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewsService", - "text": "DataViewsService" - }, - ">" - ], - "path": "src/plugins/data_views/server/types.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-server.DataViewsServerPluginStart.dataViewsServiceFactory.$1", - "type": "Object", - "tags": [], - "label": "savedObjectsClient", - "description": [], - "signature": [ - "{ create: (type: string, attributes: T, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreateOptions", - "text": "SavedObjectsCreateOptions" - }, - " | undefined) => Promise<", - "SavedObject", - ">; bulkCreate: (objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkCreateObject", - "text": "SavedObjectsBulkCreateObject" - }, - "[], options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreateOptions", - "text": "SavedObjectsCreateOptions" - }, - " | undefined) => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkResponse", - "text": "SavedObjectsBulkResponse" - }, - ">; checkConflicts: (objects?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCheckConflictsObject", - "text": "SavedObjectsCheckConflictsObject" - }, - "[], options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCheckConflictsResponse", - "text": "SavedObjectsCheckConflictsResponse" - }, - ">; delete: (type: string, id: string, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsDeleteOptions", - "text": "SavedObjectsDeleteOptions" - }, - ") => Promise<{}>; find: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsFindOptions", - "text": "SavedObjectsFindOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsFindResponse", - "text": "SavedObjectsFindResponse" - }, - ">; bulkGet: (objects?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkGetObject", - "text": "SavedObjectsBulkGetObject" - }, - "[], options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkResponse", - "text": "SavedObjectsBulkResponse" - }, - ">; bulkResolve: (objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkResolveObject", - "text": "SavedObjectsBulkResolveObject" - }, - "[], options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - " | undefined) => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkResolveResponse", - "text": "SavedObjectsBulkResolveResponse" - }, - ">; get: (type: string, id: string, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - ") => Promise<", - "SavedObject", - ">; resolve: (type: string, id: string, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsResolveResponse", - "text": "SavedObjectsResolveResponse" - }, - ">; update: (type: string, id: string, attributes: Partial, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateOptions", - "text": "SavedObjectsUpdateOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateResponse", - "text": "SavedObjectsUpdateResponse" - }, - ">; collectMultiNamespaceReferences: (objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesObject", - "text": "SavedObjectsCollectMultiNamespaceReferencesObject" - }, - "[], options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesOptions", - "text": "SavedObjectsCollectMultiNamespaceReferencesOptions" - }, - " | undefined) => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesResponse", - "text": "SavedObjectsCollectMultiNamespaceReferencesResponse" - }, - ">; updateObjectsSpaces: (objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateObjectsSpacesObject", - "text": "SavedObjectsUpdateObjectsSpacesObject" - }, - "[], spacesToAdd: string[], spacesToRemove: string[], options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateObjectsSpacesOptions", - "text": "SavedObjectsUpdateObjectsSpacesOptions" - }, - " | undefined) => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateObjectsSpacesResponse", - "text": "SavedObjectsUpdateObjectsSpacesResponse" - }, - ">; bulkUpdate: (objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateObject", - "text": "SavedObjectsBulkUpdateObject" - }, - "[], options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateOptions", - "text": "SavedObjectsBulkUpdateOptions" - }, - " | undefined) => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateResponse", - "text": "SavedObjectsBulkUpdateResponse" - }, - ">; removeReferencesTo: (type: string, id: string, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsRemoveReferencesToOptions", - "text": "SavedObjectsRemoveReferencesToOptions" - }, - " | undefined) => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsRemoveReferencesToResponse", - "text": "SavedObjectsRemoveReferencesToResponse" - }, - ">; openPointInTimeForType: (type: string | string[], options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsOpenPointInTimeOptions", - "text": "SavedObjectsOpenPointInTimeOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsOpenPointInTimeResponse", - "text": "SavedObjectsOpenPointInTimeResponse" - }, - ">; closePointInTime: (id: string, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - " | undefined) => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClosePointInTimeResponse", - "text": "SavedObjectsClosePointInTimeResponse" - }, - ">; createPointInTimeFinder: (findOptions: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreatePointInTimeFinderOptions", - "text": "SavedObjectsCreatePointInTimeFinderOptions" - }, - ", dependencies?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreatePointInTimeFinderDependencies", - "text": "SavedObjectsCreatePointInTimeFinderDependencies" - }, - " | undefined) => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.ISavedObjectsPointInTimeFinder", - "text": "ISavedObjectsPointInTimeFinder" - }, - "; errors: typeof ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsErrorHelpers", - "text": "SavedObjectsErrorHelpers" - }, - "; }" - ], - "path": "src/plugins/data_views/server/types.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-server.DataViewsServerPluginStart.dataViewsServiceFactory.$2", - "type": "Object", - "tags": [], - "label": "elasticsearchClient", - "description": [], - "signature": [ - "{ eql: ", - "default", - "; search: { >(this: That, params?: ", - "SearchRequest", - " | ", - "SearchRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "SearchResponse", - ">; >(this: That, params?: ", - "SearchRequest", - " | ", - "SearchRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "SearchResponse", - ", unknown>>; >(this: That, params?: ", - "SearchRequest", - " | ", - "SearchRequest", - " | undefined, options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "SearchResponse", - ">; }; create: { (this: That, params: ", - "CreateRequest", - " | ", - "CreateRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "WriteResponseBase", - ">; (this: That, params: ", - "CreateRequest", - " | ", - "CreateRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "WriteResponseBase", - ", unknown>>; (this: That, params: ", - "CreateRequest", - " | ", - "CreateRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "WriteResponseBase", - ">; }; monitoring: ", - "default", - "; security: ", - "default", - "; name: string | symbol; index: { (this: That, params: ", - "IndexRequest", - " | ", - "IndexRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "WriteResponseBase", - ">; (this: That, params: ", - "IndexRequest", - " | ", - "IndexRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "WriteResponseBase", - ", unknown>>; (this: That, params: ", - "IndexRequest", - " | ", - "IndexRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "WriteResponseBase", - ">; }; delete: { (this: That, params: ", - "DeleteRequest", - " | ", - "DeleteRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "WriteResponseBase", - ">; (this: That, params: ", - "DeleteRequest", - " | ", - "DeleteRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "WriteResponseBase", - ", unknown>>; (this: That, params: ", - "DeleteRequest", - " | ", - "DeleteRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "WriteResponseBase", - ">; }; get: { (this: That, params: ", - "GetRequest", - " | ", - "GetRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "GetResponse", - ">; (this: That, params: ", - "GetRequest", - " | ", - "GetRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "GetResponse", - ", unknown>>; (this: That, params: ", - "GetRequest", - " | ", - "GetRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "GetResponse", - ">; }; update: { (this: That, params: ", - "UpdateRequest", - " | ", - "UpdateRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "UpdateResponse", - ">; (this: That, params: ", - "UpdateRequest", - " | ", - "UpdateRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "UpdateResponse", - ", unknown>>; (this: That, params: ", - "UpdateRequest", - " | ", - "UpdateRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "UpdateResponse", - ">; }; closePointInTime: { (this: That, params: ", - "ClosePointInTimeRequest", - " | ", - "ClosePointInTimeRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "ClosePointInTimeResponse", - ">; (this: That, params: ", - "ClosePointInTimeRequest", - " | ", - "ClosePointInTimeRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "ClosePointInTimeResponse", - ", unknown>>; (this: That, params: ", - "ClosePointInTimeRequest", - " | ", - "ClosePointInTimeRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "ClosePointInTimeResponse", - ">; }; helpers: ", - "default", - "; [kInternal]: symbol | null; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", - "default", - "; child: (opts: ", - "ClientOptions", - ") => ", - "default", - "; Internal: ", - "default", - "; asyncSearch: ", - "default", - "; autoscaling: ", - "default", - "; bulk: { (this: That, params: ", - "BulkRequest", - " | ", - "BulkRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "BulkResponse", - ">; (this: That, params: ", - "BulkRequest", - " | ", - "BulkRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "BulkResponse", - ", unknown>>; (this: That, params: ", - "BulkRequest", - " | ", - "BulkRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "BulkResponse", - ">; }; cat: ", - "default", - "; ccr: ", - "default", - "; clearScroll: { (this: That, params?: ", - "ClearScrollRequest", - " | ", - "ClearScrollRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "ClearScrollResponse", - ">; (this: That, params?: ", - "ClearScrollRequest", - " | ", - "ClearScrollRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "ClearScrollResponse", - ", unknown>>; (this: That, params?: ", - "ClearScrollRequest", - " | ", - "ClearScrollRequest", - " | undefined, options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "ClearScrollResponse", - ">; }; cluster: ", - "default", - "; count: { (this: That, params?: ", - "CountRequest", - " | ", - "CountRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "CountResponse", - ">; (this: That, params?: ", - "CountRequest", - " | ", - "CountRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "CountResponse", - ", unknown>>; (this: That, params?: ", - "CountRequest", - " | ", - "CountRequest", - " | undefined, options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "CountResponse", - ">; }; danglingIndices: ", - "default", - "; deleteByQuery: { (this: That, params: ", - "DeleteByQueryRequest", - " | ", - "DeleteByQueryRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "DeleteByQueryResponse", - ">; (this: That, params: ", - "DeleteByQueryRequest", - " | ", - "DeleteByQueryRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "DeleteByQueryResponse", - ", unknown>>; (this: That, params: ", - "DeleteByQueryRequest", - " | ", - "DeleteByQueryRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "DeleteByQueryResponse", - ">; }; deleteByQueryRethrottle: { (this: That, params: ", - "DeleteByQueryRethrottleRequest", - " | ", - "DeleteByQueryRethrottleRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "TasksTaskListResponseBase", - ">; (this: That, params: ", - "DeleteByQueryRethrottleRequest", - " | ", - "DeleteByQueryRethrottleRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "TasksTaskListResponseBase", - ", unknown>>; (this: That, params: ", - "DeleteByQueryRethrottleRequest", - " | ", - "DeleteByQueryRethrottleRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "TasksTaskListResponseBase", - ">; }; deleteScript: { (this: That, params: ", - "DeleteScriptRequest", - " | ", - "DeleteScriptRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "AcknowledgedResponseBase", - ">; (this: That, params: ", - "DeleteScriptRequest", - " | ", - "DeleteScriptRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "AcknowledgedResponseBase", - ", unknown>>; (this: That, params: ", - "DeleteScriptRequest", - " | ", - "DeleteScriptRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "AcknowledgedResponseBase", - ">; }; enrich: ", - "default", - "; exists: { (this: That, params: ", - "ExistsRequest", - " | ", - "ExistsRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise; (this: That, params: ", - "ExistsRequest", - " | ", - "ExistsRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - ">; (this: That, params: ", - "ExistsRequest", - " | ", - "ExistsRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise; }; existsSource: { (this: That, params: ", - "ExistsSourceRequest", - " | ", - "ExistsSourceRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise; (this: That, params: ", - "ExistsSourceRequest", - " | ", - "ExistsSourceRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - ">; (this: That, params: ", - "ExistsSourceRequest", - " | ", - "ExistsSourceRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise; }; explain: { (this: That, params: ", - "ExplainRequest", - " | ", - "ExplainRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "ExplainResponse", - ">; (this: That, params: ", - "ExplainRequest", - " | ", - "ExplainRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "ExplainResponse", - ", unknown>>; (this: That, params: ", - "ExplainRequest", - " | ", - "ExplainRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "ExplainResponse", - ">; }; features: ", - "default", - "; fieldCaps: { (this: That, params: ", - "FieldCapsRequest", - " | ", - "FieldCapsRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "FieldCapsResponse", - ">; (this: That, params: ", - "FieldCapsRequest", - " | ", - "FieldCapsRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "FieldCapsResponse", - ", unknown>>; (this: That, params: ", - "FieldCapsRequest", - " | ", - "FieldCapsRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "FieldCapsResponse", - ">; }; fleet: ", - "default", - "; getScript: { (this: That, params: ", - "GetScriptRequest", - " | ", - "GetScriptRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "GetScriptResponse", - ">; (this: That, params: ", - "GetScriptRequest", - " | ", - "GetScriptRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "GetScriptResponse", - ", unknown>>; (this: That, params: ", - "GetScriptRequest", - " | ", - "GetScriptRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "GetScriptResponse", - ">; }; getScriptContext: { (this: That, params?: ", - "GetScriptContextRequest", - " | ", - "GetScriptContextRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "GetScriptContextResponse", - ">; (this: That, params?: ", - "GetScriptContextRequest", - " | ", - "GetScriptContextRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "GetScriptContextResponse", - ", unknown>>; (this: That, params?: ", - "GetScriptContextRequest", - " | ", - "GetScriptContextRequest", - " | undefined, options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "GetScriptContextResponse", - ">; }; getScriptLanguages: { (this: That, params?: ", - "GetScriptLanguagesRequest", - " | ", - "GetScriptLanguagesRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "GetScriptLanguagesResponse", - ">; (this: That, params?: ", - "GetScriptLanguagesRequest", - " | ", - "GetScriptLanguagesRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "GetScriptLanguagesResponse", - ", unknown>>; (this: That, params?: ", - "GetScriptLanguagesRequest", - " | ", - "GetScriptLanguagesRequest", - " | undefined, options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "GetScriptLanguagesResponse", - ">; }; getSource: { (this: That, params: ", - "GetSourceRequest", - " | ", - "GetSourceRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise; (this: That, params: ", - "GetSourceRequest", - " | ", - "GetSourceRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - ">; (this: That, params: ", - "GetSourceRequest", - " | ", - "GetSourceRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise; }; graph: ", - "default", - "; ilm: ", - "default", - "; indices: ", - "default", - "; info: { (this: That, params?: ", - "InfoRequest", - " | ", - "InfoRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "InfoResponse", - ">; (this: That, params?: ", - "InfoRequest", - " | ", - "InfoRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "InfoResponse", - ", unknown>>; (this: That, params?: ", - "InfoRequest", - " | ", - "InfoRequest", - " | undefined, options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "InfoResponse", - ">; }; ingest: ", - "default", - "; knnSearch: { (this: That, params: ", - "KnnSearchRequest", - " | ", - "KnnSearchRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "KnnSearchResponse", - ">; (this: That, params: ", - "KnnSearchRequest", - " | ", - "KnnSearchRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "KnnSearchResponse", - ", unknown>>; (this: That, params: ", - "KnnSearchRequest", - " | ", - "KnnSearchRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "KnnSearchResponse", - ">; }; license: ", - "default", - "; logstash: ", - "default", - "; mget: { (this: That, params?: ", - "MgetRequest", - " | ", - "MgetRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "MgetResponse", - ">; (this: That, params?: ", - "MgetRequest", - " | ", - "MgetRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "MgetResponse", - ", unknown>>; (this: That, params?: ", - "MgetRequest", - " | ", - "MgetRequest", - " | undefined, options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "MgetResponse", - ">; }; migration: ", - "default", - "; ml: ", - "default", - "; msearch: { >(this: That, params: ", - "MsearchRequest", - " | ", - "MsearchRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "MsearchResponse", - ">; >(this: That, params: ", - "MsearchRequest", - " | ", - "MsearchRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "MsearchResponse", - ", unknown>>; >(this: That, params: ", - "MsearchRequest", - " | ", - "MsearchRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "MsearchResponse", - ">; }; msearchTemplate: { >(this: That, params: ", - "MsearchTemplateRequest", - " | ", - "MsearchTemplateRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "MsearchTemplateResponse", - ">; >(this: That, params: ", - "MsearchTemplateRequest", - " | ", - "MsearchTemplateRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "MsearchTemplateResponse", - ", unknown>>; >(this: That, params: ", - "MsearchTemplateRequest", - " | ", - "MsearchTemplateRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "MsearchTemplateResponse", - ">; }; mtermvectors: { (this: That, params?: ", - "MtermvectorsRequest", - " | ", - "MtermvectorsRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "MtermvectorsResponse", - ">; (this: That, params?: ", - "MtermvectorsRequest", - " | ", - "MtermvectorsRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "MtermvectorsResponse", - ", unknown>>; (this: That, params?: ", - "MtermvectorsRequest", - " | ", - "MtermvectorsRequest", - " | undefined, options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "MtermvectorsResponse", - ">; }; nodes: ", - "default", - "; openPointInTime: { (this: That, params: ", - "OpenPointInTimeRequest", - " | ", - "OpenPointInTimeRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "OpenPointInTimeResponse", - ">; (this: That, params: ", - "OpenPointInTimeRequest", - " | ", - "OpenPointInTimeRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "OpenPointInTimeResponse", - ", unknown>>; (this: That, params: ", - "OpenPointInTimeRequest", - " | ", - "OpenPointInTimeRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "OpenPointInTimeResponse", - ">; }; ping: { (this: That, params?: ", - "PingRequest", - " | ", - "PingRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise; (this: That, params?: ", - "PingRequest", - " | ", - "PingRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - ">; (this: That, params?: ", - "PingRequest", - " | ", - "PingRequest", - " | undefined, options?: ", - "TransportRequestOptions", - " | undefined): Promise; }; putScript: { (this: That, params: ", - "PutScriptRequest", - " | ", - "PutScriptRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "AcknowledgedResponseBase", - ">; (this: That, params: ", - "PutScriptRequest", - " | ", - "PutScriptRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "AcknowledgedResponseBase", - ", unknown>>; (this: That, params: ", - "PutScriptRequest", - " | ", - "PutScriptRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "AcknowledgedResponseBase", - ">; }; rankEval: { (this: That, params: ", - "RankEvalRequest", - " | ", - "RankEvalRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "RankEvalResponse", - ">; (this: That, params: ", - "RankEvalRequest", - " | ", - "RankEvalRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "RankEvalResponse", - ", unknown>>; (this: That, params: ", - "RankEvalRequest", - " | ", - "RankEvalRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "RankEvalResponse", - ">; }; reindex: { (this: That, params: ", - "ReindexRequest", - " | ", - "ReindexRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "ReindexResponse", - ">; (this: That, params: ", - "ReindexRequest", - " | ", - "ReindexRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "ReindexResponse", - ", unknown>>; (this: That, params: ", - "ReindexRequest", - " | ", - "ReindexRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "ReindexResponse", - ">; }; reindexRethrottle: { (this: That, params: ", - "ReindexRethrottleRequest", - " | ", - "ReindexRethrottleRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "ReindexRethrottleResponse", - ">; (this: That, params: ", - "ReindexRethrottleRequest", - " | ", - "ReindexRethrottleRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "ReindexRethrottleResponse", - ", unknown>>; (this: That, params: ", - "ReindexRethrottleRequest", - " | ", - "ReindexRethrottleRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "ReindexRethrottleResponse", - ">; }; renderSearchTemplate: { (this: That, params?: ", - "RenderSearchTemplateRequest", - " | ", - "RenderSearchTemplateRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "RenderSearchTemplateResponse", - ">; (this: That, params?: ", - "RenderSearchTemplateRequest", - " | ", - "RenderSearchTemplateRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "RenderSearchTemplateResponse", - ", unknown>>; (this: That, params?: ", - "RenderSearchTemplateRequest", - " | ", - "RenderSearchTemplateRequest", - " | undefined, options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "RenderSearchTemplateResponse", - ">; }; rollup: ", - "default", - "; scriptsPainlessExecute: { (this: That, params?: ", - "ScriptsPainlessExecuteRequest", - " | ", - "ScriptsPainlessExecuteRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "ScriptsPainlessExecuteResponse", - ">; (this: That, params?: ", - "ScriptsPainlessExecuteRequest", - " | ", - "ScriptsPainlessExecuteRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "ScriptsPainlessExecuteResponse", - ", unknown>>; (this: That, params?: ", - "ScriptsPainlessExecuteRequest", - " | ", - "ScriptsPainlessExecuteRequest", - " | undefined, options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "ScriptsPainlessExecuteResponse", - ">; }; scroll: { >(this: That, params: ", - "ScrollRequest", - " | ", - "ScrollRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "ScrollResponse", - ">; >(this: That, params: ", - "ScrollRequest", - " | ", - "ScrollRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "ScrollResponse", - ", unknown>>; >(this: That, params: ", - "ScrollRequest", - " | ", - "ScrollRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "ScrollResponse", - ">; }; searchMvt: { (this: That, params: ", - "SearchMvtRequest", - " | ", - "SearchMvtRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise; (this: That, params: ", - "SearchMvtRequest", - " | ", - "SearchMvtRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - ">; (this: That, params: ", - "SearchMvtRequest", - " | ", - "SearchMvtRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise; }; searchShards: { (this: That, params?: ", - "SearchShardsRequest", - " | ", - "SearchShardsRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "SearchShardsResponse", - ">; (this: That, params?: ", - "SearchShardsRequest", - " | ", - "SearchShardsRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "SearchShardsResponse", - ", unknown>>; (this: That, params?: ", - "SearchShardsRequest", - " | ", - "SearchShardsRequest", - " | undefined, options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "SearchShardsResponse", - ">; }; searchTemplate: { (this: That, params?: ", - "SearchTemplateRequest", - " | ", - "SearchTemplateRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "SearchTemplateResponse", - ">; (this: That, params?: ", - "SearchTemplateRequest", - " | ", - "SearchTemplateRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "SearchTemplateResponse", - ", unknown>>; (this: That, params?: ", - "SearchTemplateRequest", - " | ", - "SearchTemplateRequest", - " | undefined, options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "SearchTemplateResponse", - ">; }; searchableSnapshots: ", - "default", - "; shutdown: ", - "default", - "; slm: ", - "default", - "; snapshot: ", - "default", - "; sql: ", - "default", - "; ssl: ", - "default", - "; tasks: ", - "default", - "; termsEnum: { (this: That, params: ", - "TermsEnumRequest", - " | ", - "TermsEnumRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "TermsEnumResponse", - ">; (this: That, params: ", - "TermsEnumRequest", - " | ", - "TermsEnumRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "TermsEnumResponse", - ", unknown>>; (this: That, params: ", - "TermsEnumRequest", - " | ", - "TermsEnumRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "TermsEnumResponse", - ">; }; termvectors: { (this: That, params: ", - "TermvectorsRequest", - " | ", - "TermvectorsRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "TermvectorsResponse", - ">; (this: That, params: ", - "TermvectorsRequest", - " | ", - "TermvectorsRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "TermvectorsResponse", - ", unknown>>; (this: That, params: ", - "TermvectorsRequest", - " | ", - "TermvectorsRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "TermvectorsResponse", - ">; }; textStructure: ", - "default", - "; transform: ", - "default", - "; updateByQuery: { (this: That, params: ", - "UpdateByQueryRequest", - " | ", - "UpdateByQueryRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "UpdateByQueryResponse", - ">; (this: That, params: ", - "UpdateByQueryRequest", - " | ", - "UpdateByQueryRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "UpdateByQueryResponse", - ", unknown>>; (this: That, params: ", - "UpdateByQueryRequest", - " | ", - "UpdateByQueryRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "UpdateByQueryResponse", - ">; }; updateByQueryRethrottle: { (this: That, params: ", - "UpdateByQueryRethrottleRequest", - " | ", - "UpdateByQueryRethrottleRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "UpdateByQueryRethrottleResponse", - ">; (this: That, params: ", - "UpdateByQueryRethrottleRequest", - " | ", - "UpdateByQueryRethrottleRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "UpdateByQueryRethrottleResponse", - ", unknown>>; (this: That, params: ", - "UpdateByQueryRethrottleRequest", - " | ", - "UpdateByQueryRethrottleRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "UpdateByQueryRethrottleResponse", - ">; }; watcher: ", - "default", - "; xpack: ", - "default", - "; }" - ], - "path": "src/plugins/data_views/server/types.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-server.DataViewsServerPluginStart.dataViewsServiceFactory.$3", - "type": "Object", - "tags": [], - "label": "request", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - " | undefined" - ], - "path": "src/plugins/data_views/server/types.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-server.DataViewsServerPluginStart.dataViewsServiceFactory.$4", - "type": "CompoundType", - "tags": [], - "label": "byPassCapabilities", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "src/plugins/data_views/server/types.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "dataViews", - "id": "def-server.DataViewsServerPluginStart.indexPatternsServiceFactory", - "type": "Function", - "tags": [ - "deprecated" - ], - "label": "indexPatternsServiceFactory", - "description": [], - "signature": [ - "(savedObjectsClient: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClientContract", - "text": "SavedObjectsClientContract" - }, - ", elasticsearchClient: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ElasticsearchClient", - "text": "ElasticsearchClient" - }, - ", request?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - " | undefined, byPassCapabilities?: boolean | undefined) => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewsService", - "text": "DataViewsService" - }, - ">" - ], - "path": "src/plugins/data_views/server/types.ts", - "deprecated": true, - "references": [ - { - "plugin": "data", - "path": "src/plugins/data/server/search/aggs/aggs_service.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/server/search/expressions/esaggs.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/server/search/search_service.ts" - }, - { - "plugin": "infra", - "path": "x-pack/plugins/infra/server/lib/adapters/framework/kibana_framework_adapter.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/server/kibana_server_services.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/server/data_indexing/indexing_routes.ts" - } - ], - "returnComment": [], - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-server.DataViewsServerPluginStart.indexPatternsServiceFactory.$1", - "type": "Object", - "tags": [], - "label": "savedObjectsClient", - "description": [], - "signature": [ - "{ create: (type: string, attributes: T, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreateOptions", - "text": "SavedObjectsCreateOptions" - }, - " | undefined) => Promise<", - "SavedObject", - ">; bulkCreate: (objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkCreateObject", - "text": "SavedObjectsBulkCreateObject" - }, - "[], options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreateOptions", - "text": "SavedObjectsCreateOptions" - }, - " | undefined) => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkResponse", - "text": "SavedObjectsBulkResponse" - }, - ">; checkConflicts: (objects?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCheckConflictsObject", - "text": "SavedObjectsCheckConflictsObject" - }, - "[], options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCheckConflictsResponse", - "text": "SavedObjectsCheckConflictsResponse" - }, - ">; delete: (type: string, id: string, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsDeleteOptions", - "text": "SavedObjectsDeleteOptions" - }, - ") => Promise<{}>; find: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsFindOptions", - "text": "SavedObjectsFindOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsFindResponse", - "text": "SavedObjectsFindResponse" - }, - ">; bulkGet: (objects?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkGetObject", - "text": "SavedObjectsBulkGetObject" - }, - "[], options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkResponse", - "text": "SavedObjectsBulkResponse" - }, - ">; bulkResolve: (objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkResolveObject", - "text": "SavedObjectsBulkResolveObject" - }, - "[], options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - " | undefined) => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkResolveResponse", - "text": "SavedObjectsBulkResolveResponse" - }, - ">; get: (type: string, id: string, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - ") => Promise<", - "SavedObject", - ">; resolve: (type: string, id: string, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsResolveResponse", - "text": "SavedObjectsResolveResponse" - }, - ">; update: (type: string, id: string, attributes: Partial, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateOptions", - "text": "SavedObjectsUpdateOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateResponse", - "text": "SavedObjectsUpdateResponse" - }, - ">; collectMultiNamespaceReferences: (objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesObject", - "text": "SavedObjectsCollectMultiNamespaceReferencesObject" - }, - "[], options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesOptions", - "text": "SavedObjectsCollectMultiNamespaceReferencesOptions" - }, - " | undefined) => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesResponse", - "text": "SavedObjectsCollectMultiNamespaceReferencesResponse" - }, - ">; updateObjectsSpaces: (objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateObjectsSpacesObject", - "text": "SavedObjectsUpdateObjectsSpacesObject" - }, - "[], spacesToAdd: string[], spacesToRemove: string[], options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateObjectsSpacesOptions", - "text": "SavedObjectsUpdateObjectsSpacesOptions" - }, - " | undefined) => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateObjectsSpacesResponse", - "text": "SavedObjectsUpdateObjectsSpacesResponse" - }, - ">; bulkUpdate: (objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateObject", - "text": "SavedObjectsBulkUpdateObject" - }, - "[], options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateOptions", - "text": "SavedObjectsBulkUpdateOptions" - }, - " | undefined) => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateResponse", - "text": "SavedObjectsBulkUpdateResponse" - }, - ">; removeReferencesTo: (type: string, id: string, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsRemoveReferencesToOptions", - "text": "SavedObjectsRemoveReferencesToOptions" - }, - " | undefined) => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsRemoveReferencesToResponse", - "text": "SavedObjectsRemoveReferencesToResponse" - }, - ">; openPointInTimeForType: (type: string | string[], options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsOpenPointInTimeOptions", - "text": "SavedObjectsOpenPointInTimeOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsOpenPointInTimeResponse", - "text": "SavedObjectsOpenPointInTimeResponse" - }, - ">; closePointInTime: (id: string, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - " | undefined) => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClosePointInTimeResponse", - "text": "SavedObjectsClosePointInTimeResponse" - }, - ">; createPointInTimeFinder: (findOptions: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreatePointInTimeFinderOptions", - "text": "SavedObjectsCreatePointInTimeFinderOptions" - }, - ", dependencies?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreatePointInTimeFinderDependencies", - "text": "SavedObjectsCreatePointInTimeFinderDependencies" - }, - " | undefined) => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.ISavedObjectsPointInTimeFinder", - "text": "ISavedObjectsPointInTimeFinder" - }, - "; errors: typeof ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsErrorHelpers", - "text": "SavedObjectsErrorHelpers" - }, - "; }" - ], - "path": "src/plugins/data_views/server/types.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-server.DataViewsServerPluginStart.indexPatternsServiceFactory.$2", - "type": "Object", - "tags": [], - "label": "elasticsearchClient", - "description": [], - "signature": [ - "{ eql: ", - "default", - "; search: { >(this: That, params?: ", - "SearchRequest", - " | ", - "SearchRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "SearchResponse", - ">; >(this: That, params?: ", - "SearchRequest", - " | ", - "SearchRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "SearchResponse", - ", unknown>>; >(this: That, params?: ", - "SearchRequest", - " | ", - "SearchRequest", - " | undefined, options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "SearchResponse", - ">; }; create: { (this: That, params: ", - "CreateRequest", - " | ", - "CreateRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "WriteResponseBase", - ">; (this: That, params: ", - "CreateRequest", - " | ", - "CreateRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "WriteResponseBase", - ", unknown>>; (this: That, params: ", - "CreateRequest", - " | ", - "CreateRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "WriteResponseBase", - ">; }; monitoring: ", - "default", - "; security: ", - "default", - "; name: string | symbol; index: { (this: That, params: ", - "IndexRequest", - " | ", - "IndexRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "WriteResponseBase", - ">; (this: That, params: ", - "IndexRequest", - " | ", - "IndexRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "WriteResponseBase", - ", unknown>>; (this: That, params: ", - "IndexRequest", - " | ", - "IndexRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "WriteResponseBase", - ">; }; delete: { (this: That, params: ", - "DeleteRequest", - " | ", - "DeleteRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "WriteResponseBase", - ">; (this: That, params: ", - "DeleteRequest", - " | ", - "DeleteRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "WriteResponseBase", - ", unknown>>; (this: That, params: ", - "DeleteRequest", - " | ", - "DeleteRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "WriteResponseBase", - ">; }; get: { (this: That, params: ", - "GetRequest", - " | ", - "GetRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "GetResponse", - ">; (this: That, params: ", - "GetRequest", - " | ", - "GetRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "GetResponse", - ", unknown>>; (this: That, params: ", - "GetRequest", - " | ", - "GetRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "GetResponse", - ">; }; update: { (this: That, params: ", - "UpdateRequest", - " | ", - "UpdateRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "UpdateResponse", - ">; (this: That, params: ", - "UpdateRequest", - " | ", - "UpdateRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "UpdateResponse", - ", unknown>>; (this: That, params: ", - "UpdateRequest", - " | ", - "UpdateRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "UpdateResponse", - ">; }; closePointInTime: { (this: That, params: ", - "ClosePointInTimeRequest", - " | ", - "ClosePointInTimeRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "ClosePointInTimeResponse", - ">; (this: That, params: ", - "ClosePointInTimeRequest", - " | ", - "ClosePointInTimeRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "ClosePointInTimeResponse", - ", unknown>>; (this: That, params: ", - "ClosePointInTimeRequest", - " | ", - "ClosePointInTimeRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "ClosePointInTimeResponse", - ">; }; helpers: ", - "default", - "; [kInternal]: symbol | null; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", - "default", - "; child: (opts: ", - "ClientOptions", - ") => ", - "default", - "; Internal: ", - "default", - "; asyncSearch: ", - "default", - "; autoscaling: ", - "default", - "; bulk: { (this: That, params: ", - "BulkRequest", - " | ", - "BulkRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "BulkResponse", - ">; (this: That, params: ", - "BulkRequest", - " | ", - "BulkRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "BulkResponse", - ", unknown>>; (this: That, params: ", - "BulkRequest", - " | ", - "BulkRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "BulkResponse", - ">; }; cat: ", - "default", - "; ccr: ", - "default", - "; clearScroll: { (this: That, params?: ", - "ClearScrollRequest", - " | ", - "ClearScrollRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "ClearScrollResponse", - ">; (this: That, params?: ", - "ClearScrollRequest", - " | ", - "ClearScrollRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "ClearScrollResponse", - ", unknown>>; (this: That, params?: ", - "ClearScrollRequest", - " | ", - "ClearScrollRequest", - " | undefined, options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "ClearScrollResponse", - ">; }; cluster: ", - "default", - "; count: { (this: That, params?: ", - "CountRequest", - " | ", - "CountRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "CountResponse", - ">; (this: That, params?: ", - "CountRequest", - " | ", - "CountRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "CountResponse", - ", unknown>>; (this: That, params?: ", - "CountRequest", - " | ", - "CountRequest", - " | undefined, options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "CountResponse", - ">; }; danglingIndices: ", - "default", - "; deleteByQuery: { (this: That, params: ", - "DeleteByQueryRequest", - " | ", - "DeleteByQueryRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "DeleteByQueryResponse", - ">; (this: That, params: ", - "DeleteByQueryRequest", - " | ", - "DeleteByQueryRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "DeleteByQueryResponse", - ", unknown>>; (this: That, params: ", - "DeleteByQueryRequest", - " | ", - "DeleteByQueryRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "DeleteByQueryResponse", - ">; }; deleteByQueryRethrottle: { (this: That, params: ", - "DeleteByQueryRethrottleRequest", - " | ", - "DeleteByQueryRethrottleRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "TasksTaskListResponseBase", - ">; (this: That, params: ", - "DeleteByQueryRethrottleRequest", - " | ", - "DeleteByQueryRethrottleRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "TasksTaskListResponseBase", - ", unknown>>; (this: That, params: ", - "DeleteByQueryRethrottleRequest", - " | ", - "DeleteByQueryRethrottleRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "TasksTaskListResponseBase", - ">; }; deleteScript: { (this: That, params: ", - "DeleteScriptRequest", - " | ", - "DeleteScriptRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "AcknowledgedResponseBase", - ">; (this: That, params: ", - "DeleteScriptRequest", - " | ", - "DeleteScriptRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "AcknowledgedResponseBase", - ", unknown>>; (this: That, params: ", - "DeleteScriptRequest", - " | ", - "DeleteScriptRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "AcknowledgedResponseBase", - ">; }; enrich: ", - "default", - "; exists: { (this: That, params: ", - "ExistsRequest", - " | ", - "ExistsRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise; (this: That, params: ", - "ExistsRequest", - " | ", - "ExistsRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - ">; (this: That, params: ", - "ExistsRequest", - " | ", - "ExistsRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise; }; existsSource: { (this: That, params: ", - "ExistsSourceRequest", - " | ", - "ExistsSourceRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise; (this: That, params: ", - "ExistsSourceRequest", - " | ", - "ExistsSourceRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - ">; (this: That, params: ", - "ExistsSourceRequest", - " | ", - "ExistsSourceRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise; }; explain: { (this: That, params: ", - "ExplainRequest", - " | ", - "ExplainRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "ExplainResponse", - ">; (this: That, params: ", - "ExplainRequest", - " | ", - "ExplainRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "ExplainResponse", - ", unknown>>; (this: That, params: ", - "ExplainRequest", - " | ", - "ExplainRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "ExplainResponse", - ">; }; features: ", - "default", - "; fieldCaps: { (this: That, params: ", - "FieldCapsRequest", - " | ", - "FieldCapsRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "FieldCapsResponse", - ">; (this: That, params: ", - "FieldCapsRequest", - " | ", - "FieldCapsRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "FieldCapsResponse", - ", unknown>>; (this: That, params: ", - "FieldCapsRequest", - " | ", - "FieldCapsRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "FieldCapsResponse", - ">; }; fleet: ", - "default", - "; getScript: { (this: That, params: ", - "GetScriptRequest", - " | ", - "GetScriptRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "GetScriptResponse", - ">; (this: That, params: ", - "GetScriptRequest", - " | ", - "GetScriptRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "GetScriptResponse", - ", unknown>>; (this: That, params: ", - "GetScriptRequest", - " | ", - "GetScriptRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "GetScriptResponse", - ">; }; getScriptContext: { (this: That, params?: ", - "GetScriptContextRequest", - " | ", - "GetScriptContextRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "GetScriptContextResponse", - ">; (this: That, params?: ", - "GetScriptContextRequest", - " | ", - "GetScriptContextRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "GetScriptContextResponse", - ", unknown>>; (this: That, params?: ", - "GetScriptContextRequest", - " | ", - "GetScriptContextRequest", - " | undefined, options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "GetScriptContextResponse", - ">; }; getScriptLanguages: { (this: That, params?: ", - "GetScriptLanguagesRequest", - " | ", - "GetScriptLanguagesRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "GetScriptLanguagesResponse", - ">; (this: That, params?: ", - "GetScriptLanguagesRequest", - " | ", - "GetScriptLanguagesRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "GetScriptLanguagesResponse", - ", unknown>>; (this: That, params?: ", - "GetScriptLanguagesRequest", - " | ", - "GetScriptLanguagesRequest", - " | undefined, options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "GetScriptLanguagesResponse", - ">; }; getSource: { (this: That, params: ", - "GetSourceRequest", - " | ", - "GetSourceRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise; (this: That, params: ", - "GetSourceRequest", - " | ", - "GetSourceRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - ">; (this: That, params: ", - "GetSourceRequest", - " | ", - "GetSourceRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise; }; graph: ", - "default", - "; ilm: ", - "default", - "; indices: ", - "default", - "; info: { (this: That, params?: ", - "InfoRequest", - " | ", - "InfoRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "InfoResponse", - ">; (this: That, params?: ", - "InfoRequest", - " | ", - "InfoRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "InfoResponse", - ", unknown>>; (this: That, params?: ", - "InfoRequest", - " | ", - "InfoRequest", - " | undefined, options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "InfoResponse", - ">; }; ingest: ", - "default", - "; knnSearch: { (this: That, params: ", - "KnnSearchRequest", - " | ", - "KnnSearchRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "KnnSearchResponse", - ">; (this: That, params: ", - "KnnSearchRequest", - " | ", - "KnnSearchRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "KnnSearchResponse", - ", unknown>>; (this: That, params: ", - "KnnSearchRequest", - " | ", - "KnnSearchRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "KnnSearchResponse", - ">; }; license: ", - "default", - "; logstash: ", - "default", - "; mget: { (this: That, params?: ", - "MgetRequest", - " | ", - "MgetRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "MgetResponse", - ">; (this: That, params?: ", - "MgetRequest", - " | ", - "MgetRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "MgetResponse", - ", unknown>>; (this: That, params?: ", - "MgetRequest", - " | ", - "MgetRequest", - " | undefined, options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "MgetResponse", - ">; }; migration: ", - "default", - "; ml: ", - "default", - "; msearch: { >(this: That, params: ", - "MsearchRequest", - " | ", - "MsearchRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "MsearchResponse", - ">; >(this: That, params: ", - "MsearchRequest", - " | ", - "MsearchRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "MsearchResponse", - ", unknown>>; >(this: That, params: ", - "MsearchRequest", - " | ", - "MsearchRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "MsearchResponse", - ">; }; msearchTemplate: { >(this: That, params: ", - "MsearchTemplateRequest", - " | ", - "MsearchTemplateRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "MsearchTemplateResponse", - ">; >(this: That, params: ", - "MsearchTemplateRequest", - " | ", - "MsearchTemplateRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "MsearchTemplateResponse", - ", unknown>>; >(this: That, params: ", - "MsearchTemplateRequest", - " | ", - "MsearchTemplateRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "MsearchTemplateResponse", - ">; }; mtermvectors: { (this: That, params?: ", - "MtermvectorsRequest", - " | ", - "MtermvectorsRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "MtermvectorsResponse", - ">; (this: That, params?: ", - "MtermvectorsRequest", - " | ", - "MtermvectorsRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "MtermvectorsResponse", - ", unknown>>; (this: That, params?: ", - "MtermvectorsRequest", - " | ", - "MtermvectorsRequest", - " | undefined, options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "MtermvectorsResponse", - ">; }; nodes: ", - "default", - "; openPointInTime: { (this: That, params: ", - "OpenPointInTimeRequest", - " | ", - "OpenPointInTimeRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "OpenPointInTimeResponse", - ">; (this: That, params: ", - "OpenPointInTimeRequest", - " | ", - "OpenPointInTimeRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "OpenPointInTimeResponse", - ", unknown>>; (this: That, params: ", - "OpenPointInTimeRequest", - " | ", - "OpenPointInTimeRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "OpenPointInTimeResponse", - ">; }; ping: { (this: That, params?: ", - "PingRequest", - " | ", - "PingRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise; (this: That, params?: ", - "PingRequest", - " | ", - "PingRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - ">; (this: That, params?: ", - "PingRequest", - " | ", - "PingRequest", - " | undefined, options?: ", - "TransportRequestOptions", - " | undefined): Promise; }; putScript: { (this: That, params: ", - "PutScriptRequest", - " | ", - "PutScriptRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "AcknowledgedResponseBase", - ">; (this: That, params: ", - "PutScriptRequest", - " | ", - "PutScriptRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "AcknowledgedResponseBase", - ", unknown>>; (this: That, params: ", - "PutScriptRequest", - " | ", - "PutScriptRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "AcknowledgedResponseBase", - ">; }; rankEval: { (this: That, params: ", - "RankEvalRequest", - " | ", - "RankEvalRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "RankEvalResponse", - ">; (this: That, params: ", - "RankEvalRequest", - " | ", - "RankEvalRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "RankEvalResponse", - ", unknown>>; (this: That, params: ", - "RankEvalRequest", - " | ", - "RankEvalRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "RankEvalResponse", - ">; }; reindex: { (this: That, params: ", - "ReindexRequest", - " | ", - "ReindexRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "ReindexResponse", - ">; (this: That, params: ", - "ReindexRequest", - " | ", - "ReindexRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "ReindexResponse", - ", unknown>>; (this: That, params: ", - "ReindexRequest", - " | ", - "ReindexRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "ReindexResponse", - ">; }; reindexRethrottle: { (this: That, params: ", - "ReindexRethrottleRequest", - " | ", - "ReindexRethrottleRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "ReindexRethrottleResponse", - ">; (this: That, params: ", - "ReindexRethrottleRequest", - " | ", - "ReindexRethrottleRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "ReindexRethrottleResponse", - ", unknown>>; (this: That, params: ", - "ReindexRethrottleRequest", - " | ", - "ReindexRethrottleRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "ReindexRethrottleResponse", - ">; }; renderSearchTemplate: { (this: That, params?: ", - "RenderSearchTemplateRequest", - " | ", - "RenderSearchTemplateRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "RenderSearchTemplateResponse", - ">; (this: That, params?: ", - "RenderSearchTemplateRequest", - " | ", - "RenderSearchTemplateRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "RenderSearchTemplateResponse", - ", unknown>>; (this: That, params?: ", - "RenderSearchTemplateRequest", - " | ", - "RenderSearchTemplateRequest", - " | undefined, options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "RenderSearchTemplateResponse", - ">; }; rollup: ", - "default", - "; scriptsPainlessExecute: { (this: That, params?: ", - "ScriptsPainlessExecuteRequest", - " | ", - "ScriptsPainlessExecuteRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "ScriptsPainlessExecuteResponse", - ">; (this: That, params?: ", - "ScriptsPainlessExecuteRequest", - " | ", - "ScriptsPainlessExecuteRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "ScriptsPainlessExecuteResponse", - ", unknown>>; (this: That, params?: ", - "ScriptsPainlessExecuteRequest", - " | ", - "ScriptsPainlessExecuteRequest", - " | undefined, options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "ScriptsPainlessExecuteResponse", - ">; }; scroll: { >(this: That, params: ", - "ScrollRequest", - " | ", - "ScrollRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "ScrollResponse", - ">; >(this: That, params: ", - "ScrollRequest", - " | ", - "ScrollRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "ScrollResponse", - ", unknown>>; >(this: That, params: ", - "ScrollRequest", - " | ", - "ScrollRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "ScrollResponse", - ">; }; searchMvt: { (this: That, params: ", - "SearchMvtRequest", - " | ", - "SearchMvtRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise; (this: That, params: ", - "SearchMvtRequest", - " | ", - "SearchMvtRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - ">; (this: That, params: ", - "SearchMvtRequest", - " | ", - "SearchMvtRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise; }; searchShards: { (this: That, params?: ", - "SearchShardsRequest", - " | ", - "SearchShardsRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "SearchShardsResponse", - ">; (this: That, params?: ", - "SearchShardsRequest", - " | ", - "SearchShardsRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "SearchShardsResponse", - ", unknown>>; (this: That, params?: ", - "SearchShardsRequest", - " | ", - "SearchShardsRequest", - " | undefined, options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "SearchShardsResponse", - ">; }; searchTemplate: { (this: That, params?: ", - "SearchTemplateRequest", - " | ", - "SearchTemplateRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "SearchTemplateResponse", - ">; (this: That, params?: ", - "SearchTemplateRequest", - " | ", - "SearchTemplateRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "SearchTemplateResponse", - ", unknown>>; (this: That, params?: ", - "SearchTemplateRequest", - " | ", - "SearchTemplateRequest", - " | undefined, options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "SearchTemplateResponse", - ">; }; searchableSnapshots: ", - "default", - "; shutdown: ", - "default", - "; slm: ", - "default", - "; snapshot: ", - "default", - "; sql: ", - "default", - "; ssl: ", - "default", - "; tasks: ", - "default", - "; termsEnum: { (this: That, params: ", - "TermsEnumRequest", - " | ", - "TermsEnumRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "TermsEnumResponse", - ">; (this: That, params: ", - "TermsEnumRequest", - " | ", - "TermsEnumRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "TermsEnumResponse", - ", unknown>>; (this: That, params: ", - "TermsEnumRequest", - " | ", - "TermsEnumRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "TermsEnumResponse", - ">; }; termvectors: { (this: That, params: ", - "TermvectorsRequest", - " | ", - "TermvectorsRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "TermvectorsResponse", - ">; (this: That, params: ", - "TermvectorsRequest", - " | ", - "TermvectorsRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "TermvectorsResponse", - ", unknown>>; (this: That, params: ", - "TermvectorsRequest", - " | ", - "TermvectorsRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "TermvectorsResponse", - ">; }; textStructure: ", - "default", - "; transform: ", - "default", - "; updateByQuery: { (this: That, params: ", - "UpdateByQueryRequest", - " | ", - "UpdateByQueryRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "UpdateByQueryResponse", - ">; (this: That, params: ", - "UpdateByQueryRequest", - " | ", - "UpdateByQueryRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "UpdateByQueryResponse", - ", unknown>>; (this: That, params: ", - "UpdateByQueryRequest", - " | ", - "UpdateByQueryRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "UpdateByQueryResponse", - ">; }; updateByQueryRethrottle: { (this: That, params: ", - "UpdateByQueryRethrottleRequest", - " | ", - "UpdateByQueryRethrottleRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "UpdateByQueryRethrottleResponse", - ">; (this: That, params: ", - "UpdateByQueryRethrottleRequest", - " | ", - "UpdateByQueryRethrottleRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "UpdateByQueryRethrottleResponse", - ", unknown>>; (this: That, params: ", - "UpdateByQueryRethrottleRequest", - " | ", - "UpdateByQueryRethrottleRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "UpdateByQueryRethrottleResponse", - ">; }; watcher: ", - "default", - "; xpack: ", - "default", - "; }" - ], - "path": "src/plugins/data_views/server/types.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-server.DataViewsServerPluginStart.indexPatternsServiceFactory.$3", - "type": "Object", - "tags": [], - "label": "request", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - " | undefined" - ], - "path": "src/plugins/data_views/server/types.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-server.DataViewsServerPluginStart.indexPatternsServiceFactory.$4", - "type": "CompoundType", - "tags": [], - "label": "byPassCapabilities", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "src/plugins/data_views/server/types.ts", - "deprecated": false - } - ] - } - ], - "lifecycle": "start", - "initialIsOpen": true - }, - "setup": { - "parentPluginId": "dataViews", - "id": "def-server.DataViewsServerPluginSetup", - "type": "Interface", - "tags": [], - "label": "DataViewsServerPluginSetup", - "description": [], - "path": "src/plugins/data_views/server/types.ts", - "deprecated": false, - "children": [], - "lifecycle": "setup", - "initialIsOpen": true - } - }, - "common": { - "classes": [ - { - "parentPluginId": "dataViews", - "id": "def-common.DataView", - "type": "Class", - "tags": [], - "label": "DataView", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - " implements ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IIndexPattern", - "text": "IIndexPattern" - } - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.DataView.id", - "type": "string", - "tags": [], - "label": "id", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataView.title", - "type": "string", - "tags": [], - "label": "title", - "description": [], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataView.fieldFormatMap", - "type": "Object", - "tags": [], - "label": "fieldFormatMap", - "description": [], - "signature": [ - "{ [x: string]: any; }" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataView.typeMeta", - "type": "Object", - "tags": [], - "label": "typeMeta", - "description": [ - "\nOnly used by rollup indices, used by rollup specific endpoint to load field list" - ], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.TypeMeta", - "text": "TypeMeta" - }, - " | undefined" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataView.fields", - "type": "CompoundType", - "tags": [], - "label": "fields", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IIndexPatternFieldList", - "text": "IIndexPatternFieldList" - }, - " & { toSpec: () => ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewFieldMap", - "text": "DataViewFieldMap" - }, - "; }" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataView.timeFieldName", - "type": "string", - "tags": [], - "label": "timeFieldName", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataView.type", - "type": "string", - "tags": [], - "label": "type", - "description": [ - "\nType is used to identify rollup index patterns" - ], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataView.flattenHit", - "type": "Function", - "tags": [ - "deprecated" - ], - "label": "flattenHit", - "description": [], - "signature": [ - "(hit: Record, deep?: boolean | undefined) => Record" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": true, - "references": [ - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx" - } - ], - "returnComment": [], - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.DataView.flattenHit.$1", - "type": "Object", - "tags": [], - "label": "hit", - "description": [], - "signature": [ - "{ [x: string]: any; }" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataView.flattenHit.$2", - "type": "CompoundType", - "tags": [], - "label": "deep", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataView.metaFields", - "type": "Array", - "tags": [], - "label": "metaFields", - "description": [], - "signature": [ - "string[]" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataView.version", - "type": "string", - "tags": [], - "label": "version", - "description": [ - "\nSavedObject version" - ], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataView.sourceFilters", - "type": "Array", - "tags": [], - "label": "sourceFilters", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.SourceFilter", - "text": "SourceFilter" - }, - "[] | undefined" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataView.namespaces", - "type": "Array", - "tags": [], - "label": "namespaces", - "description": [], - "signature": [ - "string[]" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataView.allowNoIndex", - "type": "boolean", - "tags": [], - "label": "allowNoIndex", - "description": [ - "\nprevents errors when index pattern exists before indices" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataView.Unnamed", - "type": "Function", - "tags": [], - "label": "Constructor", - "description": [], - "signature": [ - "any" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.DataView.Unnamed.$1", - "type": "Object", - "tags": [], - "label": "{ spec = {}, fieldFormats, shortDotsEnable = false, metaFields = [] }", - "description": [], - "signature": [ - "DataViewDeps" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataView.getOriginalSavedObjectBody", - "type": "Function", - "tags": [], - "label": "getOriginalSavedObjectBody", - "description": [ - "\nGet last saved saved object fields" - ], - "signature": [ - "() => { fieldAttrs?: string | undefined; title?: string | undefined; timeFieldName?: string | undefined; fields?: string | undefined; sourceFilters?: string | undefined; fieldFormatMap?: string | undefined; typeMeta?: string | undefined; type?: string | undefined; }" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataView.resetOriginalSavedObjectBody", - "type": "Function", - "tags": [], - "label": "resetOriginalSavedObjectBody", - "description": [ - "\nReset last saved saved object fields. used after saving" - ], - "signature": [ - "() => void" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataView.getFieldAttrs", - "type": "Function", - "tags": [], - "label": "getFieldAttrs", - "description": [], - "signature": [ - "() => { [x: string]: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldAttrSet", - "text": "FieldAttrSet" - }, - "; }" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataView.getComputedFields", - "type": "Function", - "tags": [], - "label": "getComputedFields", - "description": [], - "signature": [ - "() => { storedFields: string[]; scriptFields: Record; docvalueFields: { field: string; format: string; }[]; runtimeFields: ", - "MappingRuntimeFields", - "; }" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataView.toSpec", - "type": "Function", - "tags": [], - "label": "toSpec", - "description": [ - "\nCreate static representation of index pattern" - ], - "signature": [ - "() => ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" - } - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataView.getSourceFiltering", - "type": "Function", - "tags": [], - "label": "getSourceFiltering", - "description": [ - "\nGet the source filtering configuration for that index." - ], - "signature": [ - "() => { excludes: string[]; }" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataView.removeScriptedField", - "type": "Function", - "tags": [ - "deprecated" - ], - "label": "removeScriptedField", - "description": [ - "\nRemove scripted field from field list" - ], - "signature": [ - "(fieldName: string) => void" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": true, - "references": [ - { - "plugin": "dataViewManagement", - "path": "src/plugins/data_view_management/public/components/edit_index_pattern/scripted_fields_table/scripted_fields_table.tsx" - }, - { - "plugin": "dataViewManagement", - "path": "src/plugins/data_view_management/public/components/field_editor/field_editor.tsx" - } - ], - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.DataView.removeScriptedField.$1", - "type": "string", - "tags": [], - "label": "fieldName", - "description": [], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataView.getNonScriptedFields", - "type": "Function", - "tags": [ - "deprecated" - ], - "label": "getNonScriptedFields", - "description": [ - "\n" - ], - "signature": [ - "() => ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" - }, - "[]" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": true, - "references": [ - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/abstract_search_strategy.ts" - }, - { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/services/persistence/deserialize.ts" - }, - { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/state_management/datasource.test.ts" - }, - { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/services/persistence/deserialize.test.ts" - }, - { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/services/persistence/deserialize.test.ts" - }, - { - "plugin": "dataViewManagement", - "path": "src/plugins/data_view_management/public/components/edit_index_pattern/source_filters_table/components/table/table.tsx" - }, - { - "plugin": "dataViewManagement", - "path": "src/plugins/data_view_management/public/components/edit_index_pattern/edit_index_pattern.tsx" - }, - { - "plugin": "dataViewManagement", - "path": "src/plugins/data_view_management/public/components/edit_index_pattern/edit_index_pattern.tsx" - }, - { - "plugin": "dataViewManagement", - "path": "src/plugins/data_view_management/public/components/edit_index_pattern/edit_index_pattern.tsx" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/lib/fetch_fields.ts" - } - ], - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataView.getScriptedFields", - "type": "Function", - "tags": [ - "deprecated" - ], - "label": "getScriptedFields", - "description": [ - "\n" - ], - "signature": [ - "() => ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" - }, - "[]" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": true, - "references": [ - { - "plugin": "dataViewManagement", - "path": "src/plugins/data_view_management/public/components/edit_index_pattern/scripted_fields_table/scripted_fields_table.tsx" - } - ], - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataView.isTimeBased", - "type": "Function", - "tags": [], - "label": "isTimeBased", - "description": [], - "signature": [ - "() => this is ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.TimeBasedDataView", - "text": "TimeBasedDataView" - } - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataView.isTimeNanosBased", - "type": "Function", - "tags": [], - "label": "isTimeNanosBased", - "description": [], - "signature": [ - "() => this is ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.TimeBasedDataView", - "text": "TimeBasedDataView" - } - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataView.getTimeField", - "type": "Function", - "tags": [], - "label": "getTimeField", - "description": [], - "signature": [ - "() => ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" - }, - " | undefined" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataView.getFieldByName", - "type": "Function", - "tags": [], - "label": "getFieldByName", - "description": [], - "signature": [ - "(name: string) => ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" - }, - " | undefined" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.DataView.getFieldByName.$1", - "type": "string", - "tags": [], - "label": "name", - "description": [], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataView.getAggregationRestrictions", - "type": "Function", - "tags": [], - "label": "getAggregationRestrictions", - "description": [], - "signature": [ - "() => Record | undefined" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataView.getAsSavedObjectBody", - "type": "Function", - "tags": [], - "label": "getAsSavedObjectBody", - "description": [ - "\nReturns index pattern as saved object body for saving" - ], - "signature": [ - "() => ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewAttributes", - "text": "DataViewAttributes" - } - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataView.getFormatterForField", - "type": "Function", - "tags": [], - "label": "getFormatterForField", - "description": [ - "\nProvide a field, get its formatter" - ], - "signature": [ - "(field: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" - }, - " | ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - " | ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" - }, - ") => ", - { - "pluginId": "fieldFormats", - "scope": "common", - "docId": "kibFieldFormatsPluginApi", - "section": "def-common.FieldFormat", - "text": "FieldFormat" - } - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.DataView.getFormatterForField.$1", - "type": "CompoundType", - "tags": [], - "label": "field", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" - }, - " | ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - " | ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" - } - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataView.addRuntimeField", - "type": "Function", - "tags": [], - "label": "addRuntimeField", - "description": [ - "\nAdd a runtime field - Appended to existing mapped field or a new field is\ncreated as appropriate." - ], - "signature": [ - "(name: string, runtimeField: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.RuntimeField", - "text": "RuntimeField" - }, - ") => ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" - }, - "[]" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.DataView.addRuntimeField.$1", - "type": "string", - "tags": [], - "label": "name", - "description": [ - "Field name" - ], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataView.addRuntimeField.$2", - "type": "Object", - "tags": [], - "label": "runtimeField", - "description": [ - "Runtime field definition" - ], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.RuntimeField", - "text": "RuntimeField" - } - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataView.hasRuntimeField", - "type": "Function", - "tags": [], - "label": "hasRuntimeField", - "description": [ - "\nChecks if runtime field exists" - ], - "signature": [ - "(name: string) => boolean" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.DataView.hasRuntimeField.$1", - "type": "string", - "tags": [], - "label": "name", - "description": [], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataView.getRuntimeField", - "type": "Function", - "tags": [], - "label": "getRuntimeField", - "description": [ - "\nReturns runtime field if exists" - ], - "signature": [ - "(name: string) => ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.RuntimeField", - "text": "RuntimeField" - }, - " | null" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.DataView.getRuntimeField.$1", - "type": "string", - "tags": [], - "label": "name", - "description": [], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataView.getAllRuntimeFields", - "type": "Function", - "tags": [], - "label": "getAllRuntimeFields", - "description": [], - "signature": [ - "() => Record" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataView.getFieldsByRuntimeFieldName", - "type": "Function", - "tags": [], - "label": "getFieldsByRuntimeFieldName", - "description": [], - "signature": [ - "(name: string) => Record | undefined" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.DataView.getFieldsByRuntimeFieldName.$1", - "type": "string", - "tags": [], - "label": "name", - "description": [], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataView.replaceAllRuntimeFields", - "type": "Function", - "tags": [], - "label": "replaceAllRuntimeFields", - "description": [ - "\nReplaces all existing runtime fields with new fields" - ], - "signature": [ - "(newFields: Record) => void" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.DataView.replaceAllRuntimeFields.$1", - "type": "Object", - "tags": [], - "label": "newFields", - "description": [], - "signature": [ - "Record" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataView.removeRuntimeField", - "type": "Function", - "tags": [], - "label": "removeRuntimeField", - "description": [ - "\nRemove a runtime field - removed from mapped field or removed unmapped\nfield as appropriate. Doesn't clear associated field attributes." - ], - "signature": [ - "(name: string) => void" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.DataView.removeRuntimeField.$1", - "type": "string", - "tags": [], - "label": "name", - "description": [ - "- Field name to remove" - ], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataView.getRuntimeMappings", - "type": "Function", - "tags": [], - "label": "getRuntimeMappings", - "description": [ - "\nReturn the \"runtime_mappings\" section of the ES search query" - ], - "signature": [ - "() => ", - "MappingRuntimeFields" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataView.getFormatterForFieldNoDefault", - "type": "Function", - "tags": [], - "label": "getFormatterForFieldNoDefault", - "description": [ - "\nGet formatter for a given field name. Return undefined if none exists" - ], - "signature": [ - "(fieldname: string) => ", - { - "pluginId": "fieldFormats", - "scope": "common", - "docId": "kibFieldFormatsPluginApi", - "section": "def-common.FieldFormat", - "text": "FieldFormat" - }, - " | undefined" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.DataView.getFormatterForFieldNoDefault.$1", - "type": "string", - "tags": [], - "label": "fieldname", - "description": [], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataView.setFieldAttrs", - "type": "Function", - "tags": [], - "label": "setFieldAttrs", - "description": [], - "signature": [ - "(fieldName: string, attrName: K, value: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldAttrSet", - "text": "FieldAttrSet" - }, - "[K]) => void" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.DataView.setFieldAttrs.$1", - "type": "string", - "tags": [], - "label": "fieldName", - "description": [], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataView.setFieldAttrs.$2", - "type": "Uncategorized", - "tags": [], - "label": "attrName", - "description": [], - "signature": [ - "K" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataView.setFieldAttrs.$3", - "type": "Uncategorized", - "tags": [], - "label": "value", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldAttrSet", - "text": "FieldAttrSet" - }, - "[K]" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataView.setFieldCustomLabel", - "type": "Function", - "tags": [], - "label": "setFieldCustomLabel", - "description": [], - "signature": [ - "(fieldName: string, customLabel: string | null | undefined) => void" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.DataView.setFieldCustomLabel.$1", - "type": "string", - "tags": [], - "label": "fieldName", - "description": [], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataView.setFieldCustomLabel.$2", - "type": "CompoundType", - "tags": [], - "label": "customLabel", - "description": [], - "signature": [ - "string | null | undefined" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": false - } - ], - "returnComment": [] - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataView.setFieldCount", - "type": "Function", - "tags": [], - "label": "setFieldCount", - "description": [], - "signature": [ - "(fieldName: string, count: number | null | undefined) => void" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.DataView.setFieldCount.$1", - "type": "string", - "tags": [], - "label": "fieldName", - "description": [], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataView.setFieldCount.$2", - "type": "CompoundType", - "tags": [], - "label": "count", - "description": [], - "signature": [ - "number | null | undefined" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": false - } - ], - "returnComment": [] - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataView.setFieldFormat", - "type": "Function", - "tags": [], - "label": "setFieldFormat", - "description": [], - "signature": [ - "(fieldName: string, format: ", - { - "pluginId": "fieldFormats", - "scope": "common", - "docId": "kibFieldFormatsPluginApi", - "section": "def-common.SerializedFieldFormat", - "text": "SerializedFieldFormat" - }, - "<", - { - "pluginId": "fieldFormats", - "scope": "common", - "docId": "kibFieldFormatsPluginApi", - "section": "def-common.FieldFormatParams", - "text": "FieldFormatParams" - }, - ">) => void" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.DataView.setFieldFormat.$1", - "type": "string", - "tags": [], - "label": "fieldName", - "description": [], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataView.setFieldFormat.$2", - "type": "Object", - "tags": [], - "label": "format", - "description": [], - "signature": [ - { - "pluginId": "fieldFormats", - "scope": "common", - "docId": "kibFieldFormatsPluginApi", - "section": "def-common.SerializedFieldFormat", - "text": "SerializedFieldFormat" - }, - "<", - { - "pluginId": "fieldFormats", - "scope": "common", - "docId": "kibFieldFormatsPluginApi", - "section": "def-common.FieldFormatParams", - "text": "FieldFormatParams" - }, - ">" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataView.deleteFieldFormat", - "type": "Function", - "tags": [], - "label": "deleteFieldFormat", - "description": [], - "signature": [ - "(fieldName: string) => void" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.DataView.deleteFieldFormat.$1", - "type": "string", - "tags": [], - "label": "fieldName", - "description": [], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewField", - "type": "Class", - "tags": [], - "label": "DataViewField", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" - }, - " implements ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" - } - ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewField.spec", - "type": "Object", - "tags": [], - "label": "spec", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - } - ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewField.Unnamed", - "type": "Function", - "tags": [], - "label": "Constructor", - "description": [], - "signature": [ - "any" - ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewField.Unnamed.$1", - "type": "Object", - "tags": [], - "label": "spec", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - } - ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewField.count", - "type": "number", - "tags": [], - "label": "count", - "description": [ - "\nCount is used for field popularity" - ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewField.count", - "type": "number", - "tags": [], - "label": "count", - "description": [], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewField.runtimeField", - "type": "Object", - "tags": [], - "label": "runtimeField", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.RuntimeFieldSpec", - "text": "RuntimeFieldSpec" - }, - " | undefined" - ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewField.runtimeField", - "type": "Object", - "tags": [], - "label": "runtimeField", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.RuntimeFieldSpec", - "text": "RuntimeFieldSpec" - }, - " | undefined" - ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewField.script", - "type": "string", - "tags": [], - "label": "script", - "description": [ - "\nScript field code" - ], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewField.script", - "type": "string", - "tags": [], - "label": "script", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewField.lang", - "type": "string", - "tags": [], - "label": "lang", - "description": [ - "\nScript field language" - ], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewField.lang", - "type": "string", - "tags": [], - "label": "lang", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewField.customLabel", - "type": "string", - "tags": [], - "label": "customLabel", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewField.customLabel", - "type": "string", - "tags": [], - "label": "customLabel", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewField.conflictDescriptions", - "type": "Object", - "tags": [], - "label": "conflictDescriptions", - "description": [ - "\nDescription of field type conflicts across different indices in the same index pattern" - ], - "signature": [ - "Record | undefined" - ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewField.conflictDescriptions", - "type": "Object", - "tags": [], - "label": "conflictDescriptions", - "description": [], - "signature": [ - "Record | undefined" - ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewField.name", - "type": "string", - "tags": [], - "label": "name", - "description": [], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewField.displayName", - "type": "string", - "tags": [], - "label": "displayName", - "description": [], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewField.type", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewField.esTypes", - "type": "Array", - "tags": [], - "label": "esTypes", - "description": [], - "signature": [ - "string[] | undefined" - ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewField.scripted", - "type": "boolean", - "tags": [], - "label": "scripted", - "description": [], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewField.searchable", - "type": "boolean", - "tags": [], - "label": "searchable", - "description": [], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewField.aggregatable", - "type": "boolean", - "tags": [], - "label": "aggregatable", - "description": [], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewField.readFromDocValues", - "type": "boolean", - "tags": [], - "label": "readFromDocValues", - "description": [], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewField.subType", - "type": "CompoundType", - "tags": [], - "label": "subType", - "description": [], - "signature": [ - "IFieldSubType", - " | undefined" - ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewField.isMapped", - "type": "CompoundType", - "tags": [], - "label": "isMapped", - "description": [ - "\nIs the field part of the index mapping?" - ], - "signature": [ - "boolean | undefined" - ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewField.isRuntimeField", - "type": "boolean", - "tags": [], - "label": "isRuntimeField", - "description": [], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewField.sortable", - "type": "boolean", - "tags": [], - "label": "sortable", - "description": [], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewField.filterable", - "type": "boolean", - "tags": [], - "label": "filterable", - "description": [], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewField.visualizable", - "type": "boolean", - "tags": [], - "label": "visualizable", - "description": [], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewField.isSubtypeNested", - "type": "Function", - "tags": [], - "label": "isSubtypeNested", - "description": [], - "signature": [ - "() => boolean" - ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewField.isSubtypeMulti", - "type": "Function", - "tags": [], - "label": "isSubtypeMulti", - "description": [], - "signature": [ - "() => boolean" - ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewField.getSubtypeNested", - "type": "Function", - "tags": [], - "label": "getSubtypeNested", - "description": [], - "signature": [ - "() => ", - "IFieldSubTypeNested", - " | undefined" - ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewField.getSubtypeMulti", - "type": "Function", - "tags": [], - "label": "getSubtypeMulti", - "description": [], - "signature": [ - "() => ", - "IFieldSubTypeMulti", - " | undefined" - ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewField.deleteCount", - "type": "Function", - "tags": [], - "label": "deleteCount", - "description": [], - "signature": [ - "() => void" - ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewField.toJSON", - "type": "Function", - "tags": [], - "label": "toJSON", - "description": [], - "signature": [ - "() => { count: number; script: string | undefined; lang: string | undefined; conflictDescriptions: Record | undefined; name: string; type: string; esTypes: string[] | undefined; scripted: boolean; searchable: boolean; aggregatable: boolean; readFromDocValues: boolean; subType: ", - "IFieldSubType", - " | undefined; customLabel: string | undefined; }" - ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewField.toSpec", - "type": "Function", - "tags": [], - "label": "toSpec", - "description": [], - "signature": [ - "({ getFormatterForField, }?: { getFormatterForField?: ((field: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" - }, - " | ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - " | ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" - }, - ") => ", - { - "pluginId": "fieldFormats", - "scope": "common", - "docId": "kibFieldFormatsPluginApi", - "section": "def-common.FieldFormat", - "text": "FieldFormat" - }, - ") | undefined; }) => ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - } - ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewField.toSpec.$1", - "type": "Object", - "tags": [], - "label": "{\n getFormatterForField,\n }", - "description": [], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewField.toSpec.$1.getFormatterForField", - "type": "Function", - "tags": [], - "label": "getFormatterForField", - "description": [], - "signature": [ - "((field: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" - }, - " | ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - " | ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" - }, - ") => ", - { - "pluginId": "fieldFormats", - "scope": "common", - "docId": "kibFieldFormatsPluginApi", - "section": "def-common.FieldFormat", - "text": "FieldFormat" - }, - ") | undefined" - ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false - } - ] - } - ], - "returnComment": [] - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewField.isRuntimeCompositeSubField", - "type": "Function", - "tags": [], - "label": "isRuntimeCompositeSubField", - "description": [], - "signature": [ - "() => boolean" - ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false, - "children": [], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewInsufficientAccessError", - "type": "Class", - "tags": [], - "label": "DataViewInsufficientAccessError", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewInsufficientAccessError", - "text": "DataViewInsufficientAccessError" - }, - " extends Error" - ], - "path": "src/plugins/data_views/common/errors/insufficient_access.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewInsufficientAccessError.Unnamed", - "type": "Function", - "tags": [], - "label": "Constructor", - "description": [], - "signature": [ - "any" - ], - "path": "src/plugins/data_views/common/errors/insufficient_access.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewInsufficientAccessError.Unnamed.$1", - "type": "string", - "tags": [], - "label": "savedObjectId", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/data_views/common/errors/insufficient_access.ts", - "deprecated": false, - "isRequired": false - } - ], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewSavedObjectConflictError", - "type": "Class", - "tags": [], - "label": "DataViewSavedObjectConflictError", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSavedObjectConflictError", - "text": "DataViewSavedObjectConflictError" - }, - " extends Error" - ], - "path": "src/plugins/data_views/common/errors/data_view_saved_object_conflict.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewSavedObjectConflictError.Unnamed", - "type": "Function", - "tags": [], - "label": "Constructor", - "description": [], - "signature": [ - "any" - ], - "path": "src/plugins/data_views/common/errors/data_view_saved_object_conflict.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewSavedObjectConflictError.Unnamed.$1", - "type": "string", - "tags": [], - "label": "savedObjectId", - "description": [], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/errors/data_view_saved_object_conflict.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewsService", - "type": "Class", - "tags": [], - "label": "DataViewsService", - "description": [], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewsService.getCanSave", - "type": "Function", - "tags": [], - "label": "getCanSave", - "description": [], - "signature": [ - "() => Promise" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "returnComment": [], - "children": [] - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewsService.ensureDefaultDataView", - "type": "Function", - "tags": [ - "deprecated" - ], - "label": "ensureDefaultDataView", - "description": [], - "signature": [ - "() => Promise | undefined" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": true, - "references": [], - "returnComment": [], - "children": [] - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewsService.Unnamed", - "type": "Function", - "tags": [], - "label": "Constructor", - "description": [], - "signature": [ - "any" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewsService.Unnamed.$1", - "type": "Object", - "tags": [], - "label": "{\n uiSettings,\n savedObjectsClient,\n apiClient,\n fieldFormats,\n onNotification,\n onError,\n onRedirectNoIndexPattern = () => {},\n getCanSave = () => Promise.resolve(false),\n }", - "description": [], - "signature": [ - "DataViewsServiceDeps" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewsService.getIds", - "type": "Function", - "tags": [], - "label": "getIds", - "description": [ - "\nGet list of index pattern ids" - ], - "signature": [ - "(refresh?: boolean) => Promise" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewsService.getIds.$1", - "type": "boolean", - "tags": [], - "label": "refresh", - "description": [ - "Force refresh of index pattern list" - ], - "signature": [ - "boolean" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewsService.getTitles", - "type": "Function", - "tags": [], - "label": "getTitles", - "description": [ - "\nGet list of index pattern titles" - ], - "signature": [ - "(refresh?: boolean) => Promise" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewsService.getTitles.$1", - "type": "boolean", - "tags": [], - "label": "refresh", - "description": [ - "Force refresh of index pattern list" - ], - "signature": [ - "boolean" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewsService.find", - "type": "Function", - "tags": [], - "label": "find", - "description": [ - "\nFind and load index patterns by title" - ], - "signature": [ - "(search: string, size?: number) => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - "[]>" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewsService.find.$1", - "type": "string", - "tags": [], - "label": "search", - "description": [], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewsService.find.$2", - "type": "number", - "tags": [], - "label": "size", - "description": [], - "signature": [ - "number" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [ - "IndexPattern[]" - ] - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewsService.getIdsWithTitle", - "type": "Function", - "tags": [], - "label": "getIdsWithTitle", - "description": [ - "\nGet list of index pattern ids with titles" - ], - "signature": [ - "(refresh?: boolean) => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewListItem", - "text": "DataViewListItem" - }, - "[]>" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewsService.getIdsWithTitle.$1", - "type": "boolean", - "tags": [], - "label": "refresh", - "description": [ - "Force refresh of index pattern list" - ], - "signature": [ - "boolean" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewsService.clearCache", - "type": "Function", - "tags": [], - "label": "clearCache", - "description": [ - "\nClear index pattern list cache" - ], - "signature": [ - "(id?: string | undefined) => void" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewsService.clearCache.$1", - "type": "string", - "tags": [], - "label": "id", - "description": [ - "optionally clear a single id" - ], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": false - } - ], - "returnComment": [] - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewsService.getCache", - "type": "Function", - "tags": [], - "label": "getCache", - "description": [], - "signature": [ - "() => Promise<", - "SavedObject", - "<", - "IndexPatternSavedObjectAttrs", - ">[] | null | undefined>" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewsService.getDefault", - "type": "Function", - "tags": [], - "label": "getDefault", - "description": [ - "\nGet default index pattern" - ], - "signature": [ - "() => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - " | null>" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewsService.getDefaultId", - "type": "Function", - "tags": [], - "label": "getDefaultId", - "description": [ - "\nGet default index pattern id" - ], - "signature": [ - "() => Promise" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewsService.setDefault", - "type": "Function", - "tags": [], - "label": "setDefault", - "description": [ - "\nOptionally set default index pattern, unless force = true" - ], - "signature": [ - "(id: string | null, force?: boolean) => Promise" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewsService.setDefault.$1", - "type": "CompoundType", - "tags": [], - "label": "id", - "description": [], - "signature": [ - "string | null" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewsService.setDefault.$2", - "type": "boolean", - "tags": [], - "label": "force", - "description": [], - "signature": [ - "boolean" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewsService.hasUserDataView", - "type": "Function", - "tags": [], - "label": "hasUserDataView", - "description": [ - "\nChecks if current user has a user created index pattern ignoring fleet's server default index patterns" - ], - "signature": [ - "() => Promise" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewsService.getFieldsForWildcard", - "type": "Function", - "tags": [], - "label": "getFieldsForWildcard", - "description": [ - "\nGet field list by providing { pattern }" - ], - "signature": [ - "(options: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.GetFieldsOptions", - "text": "GetFieldsOptions" - }, - ") => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - "[]>" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewsService.getFieldsForWildcard.$1", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.GetFieldsOptions", - "text": "GetFieldsOptions" - } - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [ - "FieldSpec[]" - ] - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewsService.getFieldsForIndexPattern", - "type": "Function", - "tags": [], - "label": "getFieldsForIndexPattern", - "description": [ - "\nGet field list by providing an index patttern (or spec)" - ], - "signature": [ - "(indexPattern: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - " | ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" - }, - ", options?: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.GetFieldsOptions", - "text": "GetFieldsOptions" - }, - " | undefined) => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - "[]>" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewsService.getFieldsForIndexPattern.$1", - "type": "CompoundType", - "tags": [], - "label": "indexPattern", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - " | ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" - } - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewsService.getFieldsForIndexPattern.$2", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.GetFieldsOptions", - "text": "GetFieldsOptions" - }, - " | undefined" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": false - } - ], - "returnComment": [ - "FieldSpec[]" - ] - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewsService.refreshFields", - "type": "Function", - "tags": [], - "label": "refreshFields", - "description": [ - "\nRefresh field list for a given index pattern" - ], - "signature": [ - "(indexPattern: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - ") => Promise" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewsService.refreshFields.$1", - "type": "Object", - "tags": [], - "label": "indexPattern", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - } - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewsService.fieldArrayToMap", - "type": "Function", - "tags": [], - "label": "fieldArrayToMap", - "description": [ - "\nConverts field array to map" - ], - "signature": [ - "(fields: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - "[], fieldAttrs?: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldAttrs", - "text": "FieldAttrs" - }, - " | undefined) => ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewFieldMap", - "text": "DataViewFieldMap" - } - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewsService.fieldArrayToMap.$1", - "type": "Array", - "tags": [], - "label": "fields", - "description": [ - ": FieldSpec[]" - ], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - "[]" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewsService.fieldArrayToMap.$2", - "type": "Object", - "tags": [], - "label": "fieldAttrs", - "description": [ - ": FieldAttrs" - ], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldAttrs", - "text": "FieldAttrs" - }, - " | undefined" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": false - } - ], - "returnComment": [ - "Record" - ] - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewsService.savedObjectToSpec", - "type": "Function", - "tags": [], - "label": "savedObjectToSpec", - "description": [ - "\nConverts index pattern saved object to index pattern spec" - ], - "signature": [ - "(savedObject: ", - "SavedObject", - "<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewAttributes", - "text": "DataViewAttributes" - }, - ">) => ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" - } - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewsService.savedObjectToSpec.$1", - "type": "Object", - "tags": [], - "label": "savedObject", - "description": [], - "signature": [ - "SavedObject", - "<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewAttributes", - "text": "DataViewAttributes" - }, - ">" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [ - "DataViewSpec" - ] - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewsService.get", - "type": "Function", - "tags": [], - "label": "get", - "description": [ - "\nGet an index pattern by id. Cache optimized" - ], - "signature": [ - "(id: string) => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - ">" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewsService.get.$1", - "type": "string", - "tags": [], - "label": "id", - "description": [], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewsService.create", - "type": "Function", - "tags": [], - "label": "create", - "description": [ - "\nCreate a new index pattern instance" - ], - "signature": [ - "(spec: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" - }, - ", skipFetchFields?: boolean) => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - ">" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewsService.create.$1", - "type": "Object", - "tags": [], - "label": "spec", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" - } - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewsService.create.$2", - "type": "boolean", - "tags": [], - "label": "skipFetchFields", - "description": [], - "signature": [ - "boolean" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [ - "IndexPattern" - ] - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewsService.createAndSave", - "type": "Function", - "tags": [], - "label": "createAndSave", - "description": [ - "\nCreate a new index pattern and save it right away" - ], - "signature": [ - "(spec: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" - }, - ", override?: boolean, skipFetchFields?: boolean) => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - ">" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewsService.createAndSave.$1", - "type": "Object", - "tags": [], - "label": "spec", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" - } - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewsService.createAndSave.$2", - "type": "boolean", - "tags": [], - "label": "override", - "description": [ - "Overwrite if existing index pattern exists." - ], - "signature": [ - "boolean" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewsService.createAndSave.$3", - "type": "boolean", - "tags": [], - "label": "skipFetchFields", - "description": [ - "Whether to skip field refresh step." - ], - "signature": [ - "boolean" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewsService.createSavedObject", - "type": "Function", - "tags": [], - "label": "createSavedObject", - "description": [ - "\nSave a new index pattern" - ], - "signature": [ - "(indexPattern: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - ", override?: boolean) => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - ">" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewsService.createSavedObject.$1", - "type": "Object", - "tags": [], - "label": "indexPattern", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - } - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewsService.createSavedObject.$2", - "type": "boolean", - "tags": [], - "label": "override", - "description": [ - "Overwrite if existing index pattern exists" - ], - "signature": [ - "boolean" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewsService.updateSavedObject", - "type": "Function", - "tags": [], - "label": "updateSavedObject", - "description": [ - "\nSave existing index pattern. Will attempt to merge differences if there are conflicts" - ], - "signature": [ - "(indexPattern: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - ", saveAttempts?: number, ignoreErrors?: boolean) => Promise" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewsService.updateSavedObject.$1", - "type": "Object", - "tags": [], - "label": "indexPattern", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - } - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewsService.updateSavedObject.$2", - "type": "number", - "tags": [], - "label": "saveAttempts", - "description": [], - "signature": [ - "number" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewsService.updateSavedObject.$3", - "type": "boolean", - "tags": [], - "label": "ignoreErrors", - "description": [], - "signature": [ - "boolean" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewsService.delete", - "type": "Function", - "tags": [], - "label": "delete", - "description": [ - "\nDeletes an index pattern from .kibana index" - ], - "signature": [ - "(indexPatternId: string) => Promise<{}>" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewsService.delete.$1", - "type": "string", - "tags": [], - "label": "indexPatternId", - "description": [ - ": Id of kibana Index Pattern to delete" - ], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewsService.getDefaultDataView", - "type": "Function", - "tags": [], - "label": "getDefaultDataView", - "description": [ - "\nReturns the default data view as an object.\nIf no default is found, or it is missing\nanother data view is selected as default and returned.\nIf no possible data view found to become a default returns null\n" - ], - "signature": [ - "() => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - " | null>" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [], - "returnComment": [ - "default data view" - ] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DuplicateDataViewError", - "type": "Class", - "tags": [], - "label": "DuplicateDataViewError", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DuplicateDataViewError", - "text": "DuplicateDataViewError" - }, - " extends Error" - ], - "path": "src/plugins/data_views/common/errors/duplicate_index_pattern.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.DuplicateDataViewError.Unnamed", - "type": "Function", - "tags": [], - "label": "Constructor", - "description": [], - "signature": [ - "any" - ], - "path": "src/plugins/data_views/common/errors/duplicate_index_pattern.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.DuplicateDataViewError.Unnamed.$1", - "type": "string", - "tags": [], - "label": "message", - "description": [], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/errors/duplicate_index_pattern.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.IndexPattern", - "type": "Class", - "tags": [ - "deprecated" - ], - "label": "IndexPattern", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" - }, - " extends ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - } - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": true, - "references": [ - { - "plugin": "data", - "path": "src/plugins/data/common/index.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/types.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/types.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/types.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/types.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/tabify/tabify_docs.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/tabify/tabify_docs.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/tabify/tabify_docs.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/expressions/esaggs/request_handler.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/expressions/esaggs/request_handler.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/expressions/phrase_filter.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/expressions/phrase_filter.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/expressions/phrase_filter.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/expressions/exists_filter.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/expressions/exists_filter.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/expressions/range_filter.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/expressions/range_filter.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/types.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/types.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/utils/infer_time_zone.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/utils/infer_time_zone.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/agg_configs.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/agg_configs.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/agg_configs.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/aggs_service.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/aggs_service.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/aggs_service.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/server/index.ts" - }, - { - "plugin": "discover", - "path": "src/plugins/discover/public/application/view_alert/view_alert_route.tsx" - }, - { - "plugin": "discover", - "path": "src/plugins/discover/public/application/view_alert/view_alert_route.tsx" - }, - { - "plugin": "ux", - "path": "x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_filters.tsx" - }, - { - "plugin": "ux", - "path": "x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_filters.tsx" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/agg_config.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/agg_config.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/agg_config.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/agg_config.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/agg_configs.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/agg_configs.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/tabify/tabify.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/tabify/tabify.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/tabify/tabify_docs.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/tabify/tabify_docs.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/buckets/_terms_other_bucket_helper.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/buckets/_terms_other_bucket_helper.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/buckets/multi_terms.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/buckets/multi_terms.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/buckets/multi_terms.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/buckets/rare_terms.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/buckets/rare_terms.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/buckets/terms.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/buckets/terms.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/buckets/terms.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/utils/infer_time_zone.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/utils/infer_time_zone.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/utils/infer_time_zone.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/utils/infer_time_zone.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/utils/infer_time_zone.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/utils/infer_time_zone.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/expressions/esaggs/request_handler.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/expressions/esaggs/request_handler.test.ts" - }, - { - "plugin": "ux", - "path": "x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_wildcards.tsx" - }, - { - "plugin": "ux", - "path": "x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_wildcards.tsx" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/index.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/search/errors/painless_error.tsx" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/search/errors/painless_error.tsx" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/search/errors/painless_error.tsx" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/query/query_service.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/query/query_service.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/query/query_service.ts" - }, - { - "plugin": "savedObjects", - "path": "src/plugins/saved_objects/public/types.ts" - }, - { - "plugin": "savedObjects", - "path": "src/plugins/saved_objects/public/types.ts" - }, - { - "plugin": "savedObjects", - "path": "src/plugins/saved_objects/public/types.ts" - }, - { - "plugin": "savedObjects", - "path": "src/plugins/saved_objects/public/saved_object/helpers/apply_es_resp.ts" - }, - { - "plugin": "savedObjects", - "path": "src/plugins/saved_objects/public/saved_object/helpers/apply_es_resp.ts" - }, - { - "plugin": "dataViewEditor", - "path": "src/plugins/data_view_editor/public/shared_imports.ts" - }, - { - "plugin": "dataViewEditor", - "path": "src/plugins/data_view_editor/public/open_editor.tsx" - }, - { - "plugin": "dataViewEditor", - "path": "src/plugins/data_view_editor/public/open_editor.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts" - }, + }, + { + "parentPluginId": "dataViews", + "id": "def-server.FieldSpec", + "type": "Interface", + "tags": [], + "label": "FieldSpec", + "description": [ + "\nSerialized version of DataViewField" + ], + "signature": [ { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/fields/agg/percentile_agg_field.test.ts" + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" }, + " extends ", + "DataViewFieldBase" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "children": [ { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/fields/agg/percentile_agg_field.test.ts" + "parentPluginId": "dataViews", + "id": "def-server.FieldSpec.count", + "type": "number", + "tags": [], + "label": "count", + "description": [ + "\nPopularity count is used by discover" + ], + "signature": [ + "number | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts" + "parentPluginId": "dataViews", + "id": "def-server.FieldSpec.conflictDescriptions", + "type": "Object", + "tags": [], + "label": "conflictDescriptions", + "description": [ + "\nDescription of field type conflicts across indices" + ], + "signature": [ + "Record | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts" + "parentPluginId": "dataViews", + "id": "def-server.FieldSpec.format", + "type": "Object", + "tags": [], + "label": "format", + "description": [ + "\nField formatting in serialized format" + ], + "signature": [ + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.SerializedFieldFormat", + "text": "SerializedFieldFormat" + }, + "<", + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.FieldFormatParams", + "text": "FieldFormatParams" + }, + "> | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts" + "parentPluginId": "dataViews", + "id": "def-server.FieldSpec.esTypes", + "type": "Array", + "tags": [], + "label": "esTypes", + "description": [ + "\nElasticsearch field types used by backing indices" + ], + "signature": [ + "string[] | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/agg_filters/agg_type_filters.ts" + "parentPluginId": "dataViews", + "id": "def-server.FieldSpec.searchable", + "type": "boolean", + "tags": [], + "label": "searchable", + "description": [ + "\nTrue if field is searchable" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/agg_filters/agg_type_filters.ts" + "parentPluginId": "dataViews", + "id": "def-server.FieldSpec.aggregatable", + "type": "boolean", + "tags": [], + "label": "aggregatable", + "description": [ + "\nTrue if field is aggregatable" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/agg_filters/agg_type_filters.ts" + "parentPluginId": "dataViews", + "id": "def-server.FieldSpec.readFromDocValues", + "type": "CompoundType", + "tags": [], + "label": "readFromDocValues", + "description": [ + "\nTrue if can be read from doc values" + ], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/utils/editor_config.ts" + "parentPluginId": "dataViews", + "id": "def-server.FieldSpec.indexed", + "type": "CompoundType", + "tags": [], + "label": "indexed", + "description": [ + "\nTrue if field is indexed" + ], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/utils/editor_config.ts" + "parentPluginId": "dataViews", + "id": "def-server.FieldSpec.customLabel", + "type": "string", + "tags": [], + "label": "customLabel", + "description": [ + "\nCustom label for field, used for display in kibana" + ], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.ts" + "parentPluginId": "dataViews", + "id": "def-server.FieldSpec.runtimeField", + "type": "Object", + "tags": [], + "label": "runtimeField", + "description": [ + "\nRuntime field definition" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.RuntimeFieldSpec", + "text": "RuntimeFieldSpec" + }, + " | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.ts" + "parentPluginId": "dataViews", + "id": "def-server.FieldSpec.shortDotsEnable", + "type": "CompoundType", + "tags": [], + "label": "shortDotsEnable", + "description": [ + "\nWhether short dots are enabled, based on uiSettings." + ], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_select.tsx" - }, + "parentPluginId": "dataViews", + "id": "def-server.FieldSpec.isMapped", + "type": "CompoundType", + "tags": [], + "label": "isMapped", + "description": [ + "\nIs this field in the mapping? False if a scripted or runtime field defined on the data view." + ], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "dataViews", + "id": "def-server.SavedObjectsClientCommon", + "type": "Interface", + "tags": [], + "label": "SavedObjectsClientCommon", + "description": [ + "\nCommon interface for the saved objects client" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "children": [ { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_select.tsx" + "parentPluginId": "dataViews", + "id": "def-server.SavedObjectsClientCommon.find", + "type": "Function", + "tags": [], + "label": "find", + "description": [ + "\nSearch for saved objects" + ], + "signature": [ + "(options: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.SavedObjectsClientCommonFindArgs", + "text": "SavedObjectsClientCommonFindArgs" + }, + ") => Promise<", + "SavedObject", + "[]>" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-server.SavedObjectsClientCommon.find.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [ + "- options for search" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.SavedObjectsClientCommonFindArgs", + "text": "SavedObjectsClientCommonFindArgs" + } + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_params.tsx" + "parentPluginId": "dataViews", + "id": "def-server.SavedObjectsClientCommon.get", + "type": "Function", + "tags": [], + "label": "get", + "description": [ + "\nGet a single saved object by id" + ], + "signature": [ + "(type: string, id: string) => Promise<", + "SavedObject", + ">" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-server.SavedObjectsClientCommon.get.$1", + "type": "string", + "tags": [], + "label": "type", + "description": [ + "- type of saved object" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "dataViews", + "id": "def-server.SavedObjectsClientCommon.get.$2", + "type": "string", + "tags": [], + "label": "id", + "description": [ + "- id of saved object" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_params.tsx" + "parentPluginId": "dataViews", + "id": "def-server.SavedObjectsClientCommon.update", + "type": "Function", + "tags": [], + "label": "update", + "description": [ + "\nUpdate a saved object by id" + ], + "signature": [ + "(type: string, id: string, attributes: Record, options: Record) => Promise<", + "SavedObject", + ">" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-server.SavedObjectsClientCommon.update.$1", + "type": "string", + "tags": [], + "label": "type", + "description": [ + "- type of saved object" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "dataViews", + "id": "def-server.SavedObjectsClientCommon.update.$2", + "type": "string", + "tags": [], + "label": "id", + "description": [ + "- id of saved object" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "dataViews", + "id": "def-server.SavedObjectsClientCommon.update.$3", + "type": "Object", + "tags": [], + "label": "attributes", + "description": [ + "- attributes to update" + ], + "signature": [ + "Record" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "dataViews", + "id": "def-server.SavedObjectsClientCommon.update.$4", + "type": "Object", + "tags": [], + "label": "options", + "description": [ + "- client options" + ], + "signature": [ + "Record" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.test.ts" + "parentPluginId": "dataViews", + "id": "def-server.SavedObjectsClientCommon.create", + "type": "Function", + "tags": [], + "label": "create", + "description": [ + "\nCreate a saved object" + ], + "signature": [ + "(type: string, attributes: Record, options: Record) => Promise<", + "SavedObject", + ">" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-server.SavedObjectsClientCommon.create.$1", + "type": "string", + "tags": [], + "label": "type", + "description": [ + "- type of saved object" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "dataViews", + "id": "def-server.SavedObjectsClientCommon.create.$2", + "type": "Object", + "tags": [], + "label": "attributes", + "description": [ + "- attributes to set" + ], + "signature": [ + "Record" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "dataViews", + "id": "def-server.SavedObjectsClientCommon.create.$3", + "type": "Object", + "tags": [], + "label": "options", + "description": [ + "- client options" + ], + "signature": [ + "Record" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.test.ts" + "parentPluginId": "dataViews", + "id": "def-server.SavedObjectsClientCommon.delete", + "type": "Function", + "tags": [], + "label": "delete", + "description": [ + "\nDelete a saved object by id" + ], + "signature": [ + "(type: string, id: string) => Promise<{}>" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-server.SavedObjectsClientCommon.delete.$1", + "type": "string", + "tags": [], + "label": "type", + "description": [ + "- type of saved object" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "dataViews", + "id": "def-server.SavedObjectsClientCommon.delete.$2", + "type": "string", + "tags": [], + "label": "id", + "description": [ + "- id of saved object" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] } ], - "children": [], + "initialIsOpen": false + } + ], + "enums": [], + "misc": [ + { + "parentPluginId": "dataViews", + "id": "def-server.DATA_VIEW_PATH", + "type": "string", + "tags": [], + "label": "DATA_VIEW_PATH", + "description": [ + "\nPath for data view creation" + ], + "path": "src/plugins/data_views/server/constants.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "dataViews", + "id": "def-server.DATA_VIEW_PATH_LEGACY", + "type": "string", + "tags": [], + "label": "DATA_VIEW_PATH_LEGACY", + "description": [ + "\nLegacy path for data view creation" + ], + "path": "src/plugins/data_views/server/constants.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "dataViews", + "id": "def-server.RUNTIME_FIELD_PATH", + "type": "string", + "tags": [], + "label": "RUNTIME_FIELD_PATH", + "description": [ + "\nPath to create runtime field" + ], + "path": "src/plugins/data_views/server/constants.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "dataViews", + "id": "def-server.RUNTIME_FIELD_PATH_LEGACY", + "type": "string", + "tags": [], + "label": "RUNTIME_FIELD_PATH_LEGACY", + "description": [ + "\nLegacy path to create runtime field" + ], + "path": "src/plugins/data_views/server/constants.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "dataViews", + "id": "def-server.SCRIPTED_FIELD_PATH", + "type": "string", + "tags": [], + "label": "SCRIPTED_FIELD_PATH", + "description": [ + "\nPath to create scripted field" + ], + "path": "src/plugins/data_views/server/constants.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "dataViews", + "id": "def-server.SCRIPTED_FIELD_PATH_LEGACY", + "type": "string", + "tags": [], + "label": "SCRIPTED_FIELD_PATH_LEGACY", + "description": [ + "\nLegacy path to create scripted field" + ], + "path": "src/plugins/data_views/server/constants.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "dataViews", + "id": "def-server.SERVICE_KEY", + "type": "string", + "tags": [], + "label": "SERVICE_KEY", + "description": [ + "\nname of service in path form" + ], + "signature": [ + "\"data_view\"" + ], + "path": "src/plugins/data_views/server/constants.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "dataViews", + "id": "def-server.SERVICE_KEY_LEGACY", + "type": "string", + "tags": [], + "label": "SERVICE_KEY_LEGACY", + "description": [ + "\nLegacy name of service in path form" + ], + "signature": [ + "\"index_pattern\"" + ], + "path": "src/plugins/data_views/server/constants.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "dataViews", + "id": "def-server.SERVICE_KEY_TYPE", + "type": "Type", + "tags": [], + "label": "SERVICE_KEY_TYPE", + "description": [ + "\nService keys as type" + ], + "signature": [ + "\"index_pattern\" | \"data_view\"" + ], + "path": "src/plugins/data_views/server/constants.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "dataViews", + "id": "def-server.SERVICE_PATH", + "type": "string", + "tags": [], + "label": "SERVICE_PATH", + "description": [ + "\nService path for data views REST API" + ], + "signature": [ + "\"/api/data_views\"" + ], + "path": "src/plugins/data_views/server/constants.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "dataViews", + "id": "def-server.SERVICE_PATH_LEGACY", + "type": "string", + "tags": [], + "label": "SERVICE_PATH_LEGACY", + "description": [ + "\nLegacy service path for data views REST API" + ], + "signature": [ + "\"/api/index_patterns\"" + ], + "path": "src/plugins/data_views/server/constants.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "dataViews", + "id": "def-server.SPECIFIC_DATA_VIEW_PATH", + "type": "string", + "tags": [], + "label": "SPECIFIC_DATA_VIEW_PATH", + "description": [ + "\nPath for single data view" + ], + "path": "src/plugins/data_views/server/constants.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "dataViews", + "id": "def-server.SPECIFIC_DATA_VIEW_PATH_LEGACY", + "type": "string", + "tags": [], + "label": "SPECIFIC_DATA_VIEW_PATH_LEGACY", + "description": [ + "\nLegacy path for single data view" + ], + "path": "src/plugins/data_views/server/constants.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "dataViews", + "id": "def-server.SPECIFIC_RUNTIME_FIELD_PATH", + "type": "string", + "tags": [], + "label": "SPECIFIC_RUNTIME_FIELD_PATH", + "description": [ + "\nPath for runtime field" + ], + "path": "src/plugins/data_views/server/constants.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "dataViews", + "id": "def-server.SPECIFIC_RUNTIME_FIELD_PATH_LEGACY", + "type": "string", + "tags": [], + "label": "SPECIFIC_RUNTIME_FIELD_PATH_LEGACY", + "description": [ + "\nLegacy path for runtime field" + ], + "path": "src/plugins/data_views/server/constants.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "dataViews", + "id": "def-server.SPECIFIC_SCRIPTED_FIELD_PATH", + "type": "string", + "tags": [], + "label": "SPECIFIC_SCRIPTED_FIELD_PATH", + "description": [ + "\nPath for scripted field" + ], + "path": "src/plugins/data_views/server/constants.ts", + "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "dataViews", - "id": "def-common.IndexPatternField", + "id": "def-server.SPECIFIC_SCRIPTED_FIELD_PATH_LEGACY", + "type": "string", + "tags": [], + "label": "SPECIFIC_SCRIPTED_FIELD_PATH_LEGACY", + "description": [ + "\nLegacy path for scripted field" + ], + "path": "src/plugins/data_views/server/constants.ts", + "deprecated": false, + "initialIsOpen": false + } + ], + "objects": [], + "start": { + "parentPluginId": "dataViews", + "id": "def-server.DataViewsServerPluginStart", + "type": "Interface", + "tags": [], + "label": "DataViewsServerPluginStart", + "description": [ + "\nDataViews server plugin start api" + ], + "path": "src/plugins/data_views/server/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-server.DataViewsServerPluginStart.dataViewsServiceFactory", + "type": "Function", + "tags": [], + "label": "dataViewsServiceFactory", + "description": [ + "\nReturns a DataViews service instance" + ], + "signature": [ + "(savedObjectsClient: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClientContract", + "text": "SavedObjectsClientContract" + }, + ", elasticsearchClient: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ElasticsearchClient", + "text": "ElasticsearchClient" + }, + ", request?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + " | undefined, byPassCapabilities?: boolean | undefined) => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewsService", + "text": "DataViewsService" + }, + ">" + ], + "path": "src/plugins/data_views/server/types.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-server.DataViewsServerPluginStart.dataViewsServiceFactory.$1", + "type": "Object", + "tags": [], + "label": "savedObjectsClient", + "description": [], + "signature": [ + "{ create: (type: string, attributes: T, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCreateOptions", + "text": "SavedObjectsCreateOptions" + }, + " | undefined) => Promise<", + "SavedObject", + ">; bulkCreate: (objects: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkCreateObject", + "text": "SavedObjectsBulkCreateObject" + }, + "[], options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCreateOptions", + "text": "SavedObjectsCreateOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkResponse", + "text": "SavedObjectsBulkResponse" + }, + ">; checkConflicts: (objects?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCheckConflictsObject", + "text": "SavedObjectsCheckConflictsObject" + }, + "[], options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCheckConflictsResponse", + "text": "SavedObjectsCheckConflictsResponse" + }, + ">; delete: (type: string, id: string, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsDeleteOptions", + "text": "SavedObjectsDeleteOptions" + }, + ") => Promise<{}>; find: (options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsFindOptions", + "text": "SavedObjectsFindOptions" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsFindResponse", + "text": "SavedObjectsFindResponse" + }, + ">; bulkGet: (objects?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkGetObject", + "text": "SavedObjectsBulkGetObject" + }, + "[], options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkResponse", + "text": "SavedObjectsBulkResponse" + }, + ">; bulkResolve: (objects: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkResolveObject", + "text": "SavedObjectsBulkResolveObject" + }, + "[], options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkResolveResponse", + "text": "SavedObjectsBulkResolveResponse" + }, + ">; get: (type: string, id: string, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + ") => Promise<", + "SavedObject", + ">; resolve: (type: string, id: string, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsResolveResponse", + "text": "SavedObjectsResolveResponse" + }, + ">; update: (type: string, id: string, attributes: Partial, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsUpdateOptions", + "text": "SavedObjectsUpdateOptions" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsUpdateResponse", + "text": "SavedObjectsUpdateResponse" + }, + ">; collectMultiNamespaceReferences: (objects: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesObject", + "text": "SavedObjectsCollectMultiNamespaceReferencesObject" + }, + "[], options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesOptions", + "text": "SavedObjectsCollectMultiNamespaceReferencesOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesResponse", + "text": "SavedObjectsCollectMultiNamespaceReferencesResponse" + }, + ">; updateObjectsSpaces: (objects: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsUpdateObjectsSpacesObject", + "text": "SavedObjectsUpdateObjectsSpacesObject" + }, + "[], spacesToAdd: string[], spacesToRemove: string[], options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsUpdateObjectsSpacesOptions", + "text": "SavedObjectsUpdateObjectsSpacesOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsUpdateObjectsSpacesResponse", + "text": "SavedObjectsUpdateObjectsSpacesResponse" + }, + ">; bulkUpdate: (objects: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkUpdateObject", + "text": "SavedObjectsBulkUpdateObject" + }, + "[], options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkUpdateOptions", + "text": "SavedObjectsBulkUpdateOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkUpdateResponse", + "text": "SavedObjectsBulkUpdateResponse" + }, + ">; removeReferencesTo: (type: string, id: string, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsRemoveReferencesToOptions", + "text": "SavedObjectsRemoveReferencesToOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsRemoveReferencesToResponse", + "text": "SavedObjectsRemoveReferencesToResponse" + }, + ">; openPointInTimeForType: (type: string | string[], options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsOpenPointInTimeOptions", + "text": "SavedObjectsOpenPointInTimeOptions" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsOpenPointInTimeResponse", + "text": "SavedObjectsOpenPointInTimeResponse" + }, + ">; closePointInTime: (id: string, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClosePointInTimeResponse", + "text": "SavedObjectsClosePointInTimeResponse" + }, + ">; createPointInTimeFinder: (findOptions: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCreatePointInTimeFinderOptions", + "text": "SavedObjectsCreatePointInTimeFinderOptions" + }, + ", dependencies?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCreatePointInTimeFinderDependencies", + "text": "SavedObjectsCreatePointInTimeFinderDependencies" + }, + " | undefined) => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.ISavedObjectsPointInTimeFinder", + "text": "ISavedObjectsPointInTimeFinder" + }, + "; errors: typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsErrorHelpers", + "text": "SavedObjectsErrorHelpers" + }, + "; }" + ], + "path": "src/plugins/data_views/server/types.ts", + "deprecated": false + }, + { + "parentPluginId": "dataViews", + "id": "def-server.DataViewsServerPluginStart.dataViewsServiceFactory.$2", + "type": "Object", + "tags": [], + "label": "elasticsearchClient", + "description": [], + "signature": [ + "{ eql: ", + "default", + "; search: { >(this: That, params?: ", + "SearchRequest", + " | ", + "SearchRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "SearchResponse", + ">; >(this: That, params?: ", + "SearchRequest", + " | ", + "SearchRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "SearchResponse", + ", unknown>>; >(this: That, params?: ", + "SearchRequest", + " | ", + "SearchRequest", + " | undefined, options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "SearchResponse", + ">; }; create: { (this: That, params: ", + "CreateRequest", + " | ", + "CreateRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "WriteResponseBase", + ">; (this: That, params: ", + "CreateRequest", + " | ", + "CreateRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "WriteResponseBase", + ", unknown>>; (this: That, params: ", + "CreateRequest", + " | ", + "CreateRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "WriteResponseBase", + ">; }; monitoring: ", + "default", + "; security: ", + "default", + "; name: string | symbol; index: { (this: That, params: ", + "IndexRequest", + " | ", + "IndexRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "WriteResponseBase", + ">; (this: That, params: ", + "IndexRequest", + " | ", + "IndexRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "WriteResponseBase", + ", unknown>>; (this: That, params: ", + "IndexRequest", + " | ", + "IndexRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "WriteResponseBase", + ">; }; delete: { (this: That, params: ", + "DeleteRequest", + " | ", + "DeleteRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "WriteResponseBase", + ">; (this: That, params: ", + "DeleteRequest", + " | ", + "DeleteRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "WriteResponseBase", + ", unknown>>; (this: That, params: ", + "DeleteRequest", + " | ", + "DeleteRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "WriteResponseBase", + ">; }; get: { (this: That, params: ", + "GetRequest", + " | ", + "GetRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "GetResponse", + ">; (this: That, params: ", + "GetRequest", + " | ", + "GetRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "GetResponse", + ", unknown>>; (this: That, params: ", + "GetRequest", + " | ", + "GetRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "GetResponse", + ">; }; update: { (this: That, params: ", + "UpdateRequest", + " | ", + "UpdateRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "UpdateResponse", + ">; (this: That, params: ", + "UpdateRequest", + " | ", + "UpdateRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "UpdateResponse", + ", unknown>>; (this: That, params: ", + "UpdateRequest", + " | ", + "UpdateRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "UpdateResponse", + ">; }; closePointInTime: { (this: That, params: ", + "ClosePointInTimeRequest", + " | ", + "ClosePointInTimeRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "ClosePointInTimeResponse", + ">; (this: That, params: ", + "ClosePointInTimeRequest", + " | ", + "ClosePointInTimeRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "ClosePointInTimeResponse", + ", unknown>>; (this: That, params: ", + "ClosePointInTimeRequest", + " | ", + "ClosePointInTimeRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "ClosePointInTimeResponse", + ">; }; helpers: ", + "default", + "; [kInternal]: symbol | null; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", + "default", + "; child: (opts: ", + "ClientOptions", + ") => ", + "default", + "; Internal: ", + "default", + "; asyncSearch: ", + "default", + "; autoscaling: ", + "default", + "; bulk: { (this: That, params: ", + "BulkRequest", + " | ", + "BulkRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "BulkResponse", + ">; (this: That, params: ", + "BulkRequest", + " | ", + "BulkRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "BulkResponse", + ", unknown>>; (this: That, params: ", + "BulkRequest", + " | ", + "BulkRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "BulkResponse", + ">; }; cat: ", + "default", + "; ccr: ", + "default", + "; clearScroll: { (this: That, params?: ", + "ClearScrollRequest", + " | ", + "ClearScrollRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "ClearScrollResponse", + ">; (this: That, params?: ", + "ClearScrollRequest", + " | ", + "ClearScrollRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "ClearScrollResponse", + ", unknown>>; (this: That, params?: ", + "ClearScrollRequest", + " | ", + "ClearScrollRequest", + " | undefined, options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "ClearScrollResponse", + ">; }; cluster: ", + "default", + "; count: { (this: That, params?: ", + "CountRequest", + " | ", + "CountRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "CountResponse", + ">; (this: That, params?: ", + "CountRequest", + " | ", + "CountRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "CountResponse", + ", unknown>>; (this: That, params?: ", + "CountRequest", + " | ", + "CountRequest", + " | undefined, options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "CountResponse", + ">; }; danglingIndices: ", + "default", + "; deleteByQuery: { (this: That, params: ", + "DeleteByQueryRequest", + " | ", + "DeleteByQueryRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "DeleteByQueryResponse", + ">; (this: That, params: ", + "DeleteByQueryRequest", + " | ", + "DeleteByQueryRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "DeleteByQueryResponse", + ", unknown>>; (this: That, params: ", + "DeleteByQueryRequest", + " | ", + "DeleteByQueryRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "DeleteByQueryResponse", + ">; }; deleteByQueryRethrottle: { (this: That, params: ", + "DeleteByQueryRethrottleRequest", + " | ", + "DeleteByQueryRethrottleRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "TasksTaskListResponseBase", + ">; (this: That, params: ", + "DeleteByQueryRethrottleRequest", + " | ", + "DeleteByQueryRethrottleRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "TasksTaskListResponseBase", + ", unknown>>; (this: That, params: ", + "DeleteByQueryRethrottleRequest", + " | ", + "DeleteByQueryRethrottleRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "TasksTaskListResponseBase", + ">; }; deleteScript: { (this: That, params: ", + "DeleteScriptRequest", + " | ", + "DeleteScriptRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "AcknowledgedResponseBase", + ">; (this: That, params: ", + "DeleteScriptRequest", + " | ", + "DeleteScriptRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "AcknowledgedResponseBase", + ", unknown>>; (this: That, params: ", + "DeleteScriptRequest", + " | ", + "DeleteScriptRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "AcknowledgedResponseBase", + ">; }; enrich: ", + "default", + "; exists: { (this: That, params: ", + "ExistsRequest", + " | ", + "ExistsRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise; (this: That, params: ", + "ExistsRequest", + " | ", + "ExistsRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + ">; (this: That, params: ", + "ExistsRequest", + " | ", + "ExistsRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise; }; existsSource: { (this: That, params: ", + "ExistsSourceRequest", + " | ", + "ExistsSourceRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise; (this: That, params: ", + "ExistsSourceRequest", + " | ", + "ExistsSourceRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + ">; (this: That, params: ", + "ExistsSourceRequest", + " | ", + "ExistsSourceRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise; }; explain: { (this: That, params: ", + "ExplainRequest", + " | ", + "ExplainRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "ExplainResponse", + ">; (this: That, params: ", + "ExplainRequest", + " | ", + "ExplainRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "ExplainResponse", + ", unknown>>; (this: That, params: ", + "ExplainRequest", + " | ", + "ExplainRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "ExplainResponse", + ">; }; features: ", + "default", + "; fieldCaps: { (this: That, params: ", + "FieldCapsRequest", + " | ", + "FieldCapsRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "FieldCapsResponse", + ">; (this: That, params: ", + "FieldCapsRequest", + " | ", + "FieldCapsRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "FieldCapsResponse", + ", unknown>>; (this: That, params: ", + "FieldCapsRequest", + " | ", + "FieldCapsRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "FieldCapsResponse", + ">; }; fleet: ", + "default", + "; getScript: { (this: That, params: ", + "GetScriptRequest", + " | ", + "GetScriptRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "GetScriptResponse", + ">; (this: That, params: ", + "GetScriptRequest", + " | ", + "GetScriptRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "GetScriptResponse", + ", unknown>>; (this: That, params: ", + "GetScriptRequest", + " | ", + "GetScriptRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "GetScriptResponse", + ">; }; getScriptContext: { (this: That, params?: ", + "GetScriptContextRequest", + " | ", + "GetScriptContextRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "GetScriptContextResponse", + ">; (this: That, params?: ", + "GetScriptContextRequest", + " | ", + "GetScriptContextRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "GetScriptContextResponse", + ", unknown>>; (this: That, params?: ", + "GetScriptContextRequest", + " | ", + "GetScriptContextRequest", + " | undefined, options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "GetScriptContextResponse", + ">; }; getScriptLanguages: { (this: That, params?: ", + "GetScriptLanguagesRequest", + " | ", + "GetScriptLanguagesRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "GetScriptLanguagesResponse", + ">; (this: That, params?: ", + "GetScriptLanguagesRequest", + " | ", + "GetScriptLanguagesRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "GetScriptLanguagesResponse", + ", unknown>>; (this: That, params?: ", + "GetScriptLanguagesRequest", + " | ", + "GetScriptLanguagesRequest", + " | undefined, options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "GetScriptLanguagesResponse", + ">; }; getSource: { (this: That, params: ", + "GetSourceRequest", + " | ", + "GetSourceRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise; (this: That, params: ", + "GetSourceRequest", + " | ", + "GetSourceRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + ">; (this: That, params: ", + "GetSourceRequest", + " | ", + "GetSourceRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise; }; graph: ", + "default", + "; ilm: ", + "default", + "; indices: ", + "default", + "; info: { (this: That, params?: ", + "InfoRequest", + " | ", + "InfoRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "InfoResponse", + ">; (this: That, params?: ", + "InfoRequest", + " | ", + "InfoRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "InfoResponse", + ", unknown>>; (this: That, params?: ", + "InfoRequest", + " | ", + "InfoRequest", + " | undefined, options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "InfoResponse", + ">; }; ingest: ", + "default", + "; knnSearch: { (this: That, params: ", + "KnnSearchRequest", + " | ", + "KnnSearchRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "KnnSearchResponse", + ">; (this: That, params: ", + "KnnSearchRequest", + " | ", + "KnnSearchRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "KnnSearchResponse", + ", unknown>>; (this: That, params: ", + "KnnSearchRequest", + " | ", + "KnnSearchRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "KnnSearchResponse", + ">; }; license: ", + "default", + "; logstash: ", + "default", + "; mget: { (this: That, params?: ", + "MgetRequest", + " | ", + "MgetRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "MgetResponse", + ">; (this: That, params?: ", + "MgetRequest", + " | ", + "MgetRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "MgetResponse", + ", unknown>>; (this: That, params?: ", + "MgetRequest", + " | ", + "MgetRequest", + " | undefined, options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "MgetResponse", + ">; }; migration: ", + "default", + "; ml: ", + "default", + "; msearch: { >(this: That, params: ", + "MsearchRequest", + " | ", + "MsearchRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "MsearchResponse", + ">; >(this: That, params: ", + "MsearchRequest", + " | ", + "MsearchRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "MsearchResponse", + ", unknown>>; >(this: That, params: ", + "MsearchRequest", + " | ", + "MsearchRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "MsearchResponse", + ">; }; msearchTemplate: { >(this: That, params: ", + "MsearchTemplateRequest", + " | ", + "MsearchTemplateRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "MsearchTemplateResponse", + ">; >(this: That, params: ", + "MsearchTemplateRequest", + " | ", + "MsearchTemplateRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "MsearchTemplateResponse", + ", unknown>>; >(this: That, params: ", + "MsearchTemplateRequest", + " | ", + "MsearchTemplateRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "MsearchTemplateResponse", + ">; }; mtermvectors: { (this: That, params?: ", + "MtermvectorsRequest", + " | ", + "MtermvectorsRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "MtermvectorsResponse", + ">; (this: That, params?: ", + "MtermvectorsRequest", + " | ", + "MtermvectorsRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "MtermvectorsResponse", + ", unknown>>; (this: That, params?: ", + "MtermvectorsRequest", + " | ", + "MtermvectorsRequest", + " | undefined, options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "MtermvectorsResponse", + ">; }; nodes: ", + "default", + "; openPointInTime: { (this: That, params: ", + "OpenPointInTimeRequest", + " | ", + "OpenPointInTimeRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "OpenPointInTimeResponse", + ">; (this: That, params: ", + "OpenPointInTimeRequest", + " | ", + "OpenPointInTimeRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "OpenPointInTimeResponse", + ", unknown>>; (this: That, params: ", + "OpenPointInTimeRequest", + " | ", + "OpenPointInTimeRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "OpenPointInTimeResponse", + ">; }; ping: { (this: That, params?: ", + "PingRequest", + " | ", + "PingRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise; (this: That, params?: ", + "PingRequest", + " | ", + "PingRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + ">; (this: That, params?: ", + "PingRequest", + " | ", + "PingRequest", + " | undefined, options?: ", + "TransportRequestOptions", + " | undefined): Promise; }; putScript: { (this: That, params: ", + "PutScriptRequest", + " | ", + "PutScriptRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "AcknowledgedResponseBase", + ">; (this: That, params: ", + "PutScriptRequest", + " | ", + "PutScriptRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "AcknowledgedResponseBase", + ", unknown>>; (this: That, params: ", + "PutScriptRequest", + " | ", + "PutScriptRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "AcknowledgedResponseBase", + ">; }; rankEval: { (this: That, params: ", + "RankEvalRequest", + " | ", + "RankEvalRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "RankEvalResponse", + ">; (this: That, params: ", + "RankEvalRequest", + " | ", + "RankEvalRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "RankEvalResponse", + ", unknown>>; (this: That, params: ", + "RankEvalRequest", + " | ", + "RankEvalRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "RankEvalResponse", + ">; }; reindex: { (this: That, params: ", + "ReindexRequest", + " | ", + "ReindexRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "ReindexResponse", + ">; (this: That, params: ", + "ReindexRequest", + " | ", + "ReindexRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "ReindexResponse", + ", unknown>>; (this: That, params: ", + "ReindexRequest", + " | ", + "ReindexRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "ReindexResponse", + ">; }; reindexRethrottle: { (this: That, params: ", + "ReindexRethrottleRequest", + " | ", + "ReindexRethrottleRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "ReindexRethrottleResponse", + ">; (this: That, params: ", + "ReindexRethrottleRequest", + " | ", + "ReindexRethrottleRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "ReindexRethrottleResponse", + ", unknown>>; (this: That, params: ", + "ReindexRethrottleRequest", + " | ", + "ReindexRethrottleRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "ReindexRethrottleResponse", + ">; }; renderSearchTemplate: { (this: That, params?: ", + "RenderSearchTemplateRequest", + " | ", + "RenderSearchTemplateRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "RenderSearchTemplateResponse", + ">; (this: That, params?: ", + "RenderSearchTemplateRequest", + " | ", + "RenderSearchTemplateRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "RenderSearchTemplateResponse", + ", unknown>>; (this: That, params?: ", + "RenderSearchTemplateRequest", + " | ", + "RenderSearchTemplateRequest", + " | undefined, options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "RenderSearchTemplateResponse", + ">; }; rollup: ", + "default", + "; scriptsPainlessExecute: { (this: That, params?: ", + "ScriptsPainlessExecuteRequest", + " | ", + "ScriptsPainlessExecuteRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "ScriptsPainlessExecuteResponse", + ">; (this: That, params?: ", + "ScriptsPainlessExecuteRequest", + " | ", + "ScriptsPainlessExecuteRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "ScriptsPainlessExecuteResponse", + ", unknown>>; (this: That, params?: ", + "ScriptsPainlessExecuteRequest", + " | ", + "ScriptsPainlessExecuteRequest", + " | undefined, options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "ScriptsPainlessExecuteResponse", + ">; }; scroll: { >(this: That, params: ", + "ScrollRequest", + " | ", + "ScrollRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "ScrollResponse", + ">; >(this: That, params: ", + "ScrollRequest", + " | ", + "ScrollRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "ScrollResponse", + ", unknown>>; >(this: That, params: ", + "ScrollRequest", + " | ", + "ScrollRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "ScrollResponse", + ">; }; searchMvt: { (this: That, params: ", + "SearchMvtRequest", + " | ", + "SearchMvtRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise; (this: That, params: ", + "SearchMvtRequest", + " | ", + "SearchMvtRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + ">; (this: That, params: ", + "SearchMvtRequest", + " | ", + "SearchMvtRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise; }; searchShards: { (this: That, params?: ", + "SearchShardsRequest", + " | ", + "SearchShardsRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "SearchShardsResponse", + ">; (this: That, params?: ", + "SearchShardsRequest", + " | ", + "SearchShardsRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "SearchShardsResponse", + ", unknown>>; (this: That, params?: ", + "SearchShardsRequest", + " | ", + "SearchShardsRequest", + " | undefined, options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "SearchShardsResponse", + ">; }; searchTemplate: { (this: That, params?: ", + "SearchTemplateRequest", + " | ", + "SearchTemplateRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "SearchTemplateResponse", + ">; (this: That, params?: ", + "SearchTemplateRequest", + " | ", + "SearchTemplateRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "SearchTemplateResponse", + ", unknown>>; (this: That, params?: ", + "SearchTemplateRequest", + " | ", + "SearchTemplateRequest", + " | undefined, options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "SearchTemplateResponse", + ">; }; searchableSnapshots: ", + "default", + "; shutdown: ", + "default", + "; slm: ", + "default", + "; snapshot: ", + "default", + "; sql: ", + "default", + "; ssl: ", + "default", + "; tasks: ", + "default", + "; termsEnum: { (this: That, params: ", + "TermsEnumRequest", + " | ", + "TermsEnumRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "TermsEnumResponse", + ">; (this: That, params: ", + "TermsEnumRequest", + " | ", + "TermsEnumRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "TermsEnumResponse", + ", unknown>>; (this: That, params: ", + "TermsEnumRequest", + " | ", + "TermsEnumRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "TermsEnumResponse", + ">; }; termvectors: { (this: That, params: ", + "TermvectorsRequest", + " | ", + "TermvectorsRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "TermvectorsResponse", + ">; (this: That, params: ", + "TermvectorsRequest", + " | ", + "TermvectorsRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "TermvectorsResponse", + ", unknown>>; (this: That, params: ", + "TermvectorsRequest", + " | ", + "TermvectorsRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "TermvectorsResponse", + ">; }; textStructure: ", + "default", + "; transform: ", + "default", + "; updateByQuery: { (this: That, params: ", + "UpdateByQueryRequest", + " | ", + "UpdateByQueryRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "UpdateByQueryResponse", + ">; (this: That, params: ", + "UpdateByQueryRequest", + " | ", + "UpdateByQueryRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "UpdateByQueryResponse", + ", unknown>>; (this: That, params: ", + "UpdateByQueryRequest", + " | ", + "UpdateByQueryRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "UpdateByQueryResponse", + ">; }; updateByQueryRethrottle: { (this: That, params: ", + "UpdateByQueryRethrottleRequest", + " | ", + "UpdateByQueryRethrottleRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "UpdateByQueryRethrottleResponse", + ">; (this: That, params: ", + "UpdateByQueryRethrottleRequest", + " | ", + "UpdateByQueryRethrottleRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "UpdateByQueryRethrottleResponse", + ", unknown>>; (this: That, params: ", + "UpdateByQueryRethrottleRequest", + " | ", + "UpdateByQueryRethrottleRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "UpdateByQueryRethrottleResponse", + ">; }; watcher: ", + "default", + "; xpack: ", + "default", + "; }" + ], + "path": "src/plugins/data_views/server/types.ts", + "deprecated": false + }, + { + "parentPluginId": "dataViews", + "id": "def-server.DataViewsServerPluginStart.dataViewsServiceFactory.$3", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + " | undefined" + ], + "path": "src/plugins/data_views/server/types.ts", + "deprecated": false + }, + { + "parentPluginId": "dataViews", + "id": "def-server.DataViewsServerPluginStart.dataViewsServiceFactory.$4", + "type": "CompoundType", + "tags": [], + "label": "byPassCapabilities", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/data_views/server/types.ts", + "deprecated": false + } + ] + } + ], + "lifecycle": "start", + "initialIsOpen": true + }, + "setup": { + "parentPluginId": "dataViews", + "id": "def-server.DataViewsServerPluginSetup", + "type": "Interface", + "tags": [], + "label": "DataViewsServerPluginSetup", + "description": [ + "\nDataViews server plugin setup api" + ], + "path": "src/plugins/data_views/server/types.ts", + "deprecated": false, + "children": [], + "lifecycle": "setup", + "initialIsOpen": true + } + }, + "common": { + "classes": [ + { + "parentPluginId": "dataViews", + "id": "def-common.DataView", "type": "Class", - "tags": [ - "deprecated" + "tags": [], + "label": "DataView", + "description": [ + "\nData view class. Central kibana abstraction around multiple indices." ], - "label": "IndexPatternField", - "description": [], "signature": [ { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.IndexPatternField", - "text": "IndexPatternField" + "section": "def-common.DataView", + "text": "DataView" }, - " extends ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" - } + " implements ", + "DataViewBase" ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": true, - "references": [ - { - "plugin": "data", - "path": "src/plugins/data/public/index.ts" - }, - { - "plugin": "dataViewEditor", - "path": "src/plugins/data_view_editor/public/shared_imports.ts" - }, - { - "plugin": "dataViewEditor", - "path": "src/plugins/data_view_editor/public/lib/extract_time_fields.ts" - }, - { - "plugin": "dataViewEditor", - "path": "src/plugins/data_view_editor/public/lib/extract_time_fields.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/single_field_select.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/metrics_editor/metric_editor.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/metrics_editor/metric_editor.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/metrics_editor/metric_editor.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/fields/es_doc_field.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/fields/es_doc_field.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/metrics_editor/metrics_editor.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/metrics_editor/metrics_editor.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_geo_grid_source/update_source_editor.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_geo_grid_source/update_source_editor.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/top_hits/top_hits_form.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/top_hits/top_hits_form.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/top_hits/top_hits_form.tsx" - }, + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [ { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/top_hits/update_source_editor.tsx" + "parentPluginId": "dataViews", + "id": "def-common.DataView.id", + "type": "string", + "tags": [], + "label": "id", + "description": [ + "\nSaved object id" + ], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/top_hits/update_source_editor.tsx" + "parentPluginId": "dataViews", + "id": "def-common.DataView.title", + "type": "string", + "tags": [], + "label": "title", + "description": [ + "\nTitle of data view" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/top_hits/update_source_editor.tsx" + "parentPluginId": "dataViews", + "id": "def-common.DataView.fieldFormatMap", + "type": "Object", + "tags": [], + "label": "fieldFormatMap", + "description": [ + "\nMap of field formats by field name" + ], + "signature": [ + "{ [x: string]: any; }" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/geo_field_select.tsx" + "parentPluginId": "dataViews", + "id": "def-common.DataView.typeMeta", + "type": "Object", + "tags": [], + "label": "typeMeta", + "description": [ + "\nOnly used by rollup indices, used by rollup specific endpoint to load field list." + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.TypeMeta", + "text": "TypeMeta" + }, + " | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/components/geo_field_select.tsx" + "parentPluginId": "dataViews", + "id": "def-common.DataView.fields", + "type": "CompoundType", + "tags": [], + "label": "fields", + "description": [ + "\nField list, in extended array format" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.IIndexPatternFieldList", + "text": "IIndexPatternFieldList" + }, + " & { toSpec: () => ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewFieldMap", + "text": "DataViewFieldMap" + }, + "; }" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/connected_components/edit_layer_panel/join_editor/resources/join_expression.tsx" + "parentPluginId": "dataViews", + "id": "def-common.DataView.timeFieldName", + "type": "string", + "tags": [], + "label": "timeFieldName", + "description": [ + "\nTimestamp field name" + ], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/connected_components/edit_layer_panel/join_editor/resources/join_expression.tsx" + "parentPluginId": "dataViews", + "id": "def-common.DataView.type", + "type": "string", + "tags": [], + "label": "type", + "description": [ + "\nType is used to identify rollup index patterns." + ], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/connected_components/edit_layer_panel/join_editor/resources/metrics_expression.tsx" + "parentPluginId": "dataViews", + "id": "def-common.DataView.flattenHit", + "type": "Function", + "tags": [ + "deprecated" + ], + "label": "flattenHit", + "description": [], + "signature": [ + "(hit: Record, deep?: boolean | undefined) => Record" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": true, + "references": [ + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx" + } + ], + "returnComment": [], + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.DataView.flattenHit.$1", + "type": "Object", + "tags": [], + "label": "hit", + "description": [], + "signature": [ + "{ [x: string]: any; }" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false + }, + { + "parentPluginId": "dataViews", + "id": "def-common.DataView.flattenHit.$2", + "type": "CompoundType", + "tags": [], + "label": "deep", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false + } + ] }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/connected_components/edit_layer_panel/join_editor/resources/metrics_expression.tsx" + "parentPluginId": "dataViews", + "id": "def-common.DataView.metaFields", + "type": "Array", + "tags": [], + "label": "metaFields", + "description": [ + "\nList of meta fields by name" + ], + "signature": [ + "string[]" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/index_pattern_util.test.ts" + "parentPluginId": "dataViews", + "id": "def-common.DataView.version", + "type": "string", + "tags": [], + "label": "version", + "description": [ + "\nSavedObject version" + ], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/index_pattern_util.test.ts" + "parentPluginId": "dataViews", + "id": "def-common.DataView.sourceFilters", + "type": "Array", + "tags": [], + "label": "sourceFilters", + "description": [ + "\nArray of filters - hides fields in discover" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.SourceFilter", + "text": "SourceFilter" + }, + "[] | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/index_pattern_util.test.ts" + "parentPluginId": "dataViews", + "id": "def-common.DataView.namespaces", + "type": "Array", + "tags": [], + "label": "namespaces", + "description": [ + "\nArray of namespace ids" + ], + "signature": [ + "string[]" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/index_pattern_util.test.ts" + "parentPluginId": "dataViews", + "id": "def-common.DataView.allowNoIndex", + "type": "boolean", + "tags": [], + "label": "allowNoIndex", + "description": [ + "\nPrevents errors when index pattern exists before indices" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/index_pattern_util.test.ts" + "parentPluginId": "dataViews", + "id": "def-common.DataView.Unnamed", + "type": "Function", + "tags": [], + "label": "Constructor", + "description": [ + "\nconstructor" + ], + "signature": [ + "any" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.DataView.Unnamed.$1", + "type": "Object", + "tags": [], + "label": "config", + "description": [ + "- config data and dependencies" + ], + "signature": [ + "DataViewDeps" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/index_pattern_util.test.ts" + "parentPluginId": "dataViews", + "id": "def-common.DataView.getOriginalSavedObjectBody", + "type": "Function", + "tags": [], + "label": "getOriginalSavedObjectBody", + "description": [ + "\nGet last saved saved object fields" + ], + "signature": [ + "() => { fieldAttrs?: string | undefined; title?: string | undefined; timeFieldName?: string | undefined; fields?: string | undefined; sourceFilters?: string | undefined; fieldFormatMap?: string | undefined; typeMeta?: string | undefined; type?: string | undefined; }" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts" + "parentPluginId": "dataViews", + "id": "def-common.DataView.resetOriginalSavedObjectBody", + "type": "Function", + "tags": [], + "label": "resetOriginalSavedObjectBody", + "description": [ + "\nReset last saved saved object fields. Used after saving." + ], + "signature": [ + "() => void" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts" + "parentPluginId": "dataViews", + "id": "def-common.DataView.getFieldAttrs", + "type": "Function", + "tags": [], + "label": "getFieldAttrs", + "description": [ + "\nReturns field attributes map" + ], + "signature": [ + "() => { [x: string]: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldAttrSet", + "text": "FieldAttrSet" + }, + "; }" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts" + "parentPluginId": "dataViews", + "id": "def-common.DataView.getComputedFields", + "type": "Function", + "tags": [], + "label": "getComputedFields", + "description": [ + "\nReturns scripted fields" + ], + "signature": [ + "() => { storedFields: string[]; scriptFields: Record; docvalueFields: { field: string; format: string; }[]; runtimeFields: ", + "MappingRuntimeFields", + "; }" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts" + "parentPluginId": "dataViews", + "id": "def-common.DataView.toSpec", + "type": "Function", + "tags": [], + "label": "toSpec", + "description": [ + "\nCreates static representation of the data view." + ], + "signature": [ + "() => ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewSpec", + "text": "DataViewSpec" + } + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts" + "parentPluginId": "dataViews", + "id": "def-common.DataView.getSourceFiltering", + "type": "Function", + "tags": [], + "label": "getSourceFiltering", + "description": [ + "\nGet the source filtering configuration for that index." + ], + "signature": [ + "() => { excludes: string[]; }" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts" + "parentPluginId": "dataViews", + "id": "def-common.DataView.removeScriptedField", + "type": "Function", + "tags": [ + "deprecated" + ], + "label": "removeScriptedField", + "description": [ + "\nRemoves scripted field from field list." + ], + "signature": [ + "(fieldName: string) => void" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": true, + "references": [ + { + "plugin": "dataViewManagement", + "path": "src/plugins/data_view_management/public/components/edit_index_pattern/scripted_fields_table/scripted_fields_table.tsx" + }, + { + "plugin": "dataViewManagement", + "path": "src/plugins/data_view_management/public/components/field_editor/field_editor.tsx" + } + ], + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.DataView.removeScriptedField.$1", + "type": "string", + "tags": [], + "label": "fieldName", + "description": [ + "name of scripted field to remove" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts" + "parentPluginId": "dataViews", + "id": "def-common.DataView.getNonScriptedFields", + "type": "Function", + "tags": [ + "deprecated" + ], + "label": "getNonScriptedFields", + "description": [ + "\n" + ], + "signature": [ + "() => ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewField", + "text": "DataViewField" + }, + "[]" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": true, + "references": [ + { + "plugin": "visTypeTimeseries", + "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/abstract_search_strategy.ts" + }, + { + "plugin": "graph", + "path": "x-pack/plugins/graph/public/services/persistence/deserialize.ts" + }, + { + "plugin": "graph", + "path": "x-pack/plugins/graph/public/state_management/datasource.test.ts" + }, + { + "plugin": "graph", + "path": "x-pack/plugins/graph/public/services/persistence/deserialize.test.ts" + }, + { + "plugin": "graph", + "path": "x-pack/plugins/graph/public/services/persistence/deserialize.test.ts" + }, + { + "plugin": "dataViewManagement", + "path": "src/plugins/data_view_management/public/components/edit_index_pattern/source_filters_table/components/table/table.tsx" + }, + { + "plugin": "dataViewManagement", + "path": "src/plugins/data_view_management/public/components/edit_index_pattern/edit_index_pattern.tsx" + }, + { + "plugin": "dataViewManagement", + "path": "src/plugins/data_view_management/public/components/edit_index_pattern/edit_index_pattern.tsx" + }, + { + "plugin": "dataViewManagement", + "path": "src/plugins/data_view_management/public/components/edit_index_pattern/edit_index_pattern.tsx" + }, + { + "plugin": "visTypeTimeseries", + "path": "src/plugins/vis_types/timeseries/public/application/lib/fetch_fields.ts" + } + ], + "children": [], + "returnComment": [] }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/agg_filters/agg_type_field_filters.ts" + "parentPluginId": "dataViews", + "id": "def-common.DataView.getScriptedFields", + "type": "Function", + "tags": [ + "deprecated" + ], + "label": "getScriptedFields", + "description": [ + "\n" + ], + "signature": [ + "() => ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewField", + "text": "DataViewField" + }, + "[]" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": true, + "references": [ + { + "plugin": "dataViewManagement", + "path": "src/plugins/data_view_management/public/components/edit_index_pattern/scripted_fields_table/scripted_fields_table.tsx" + } + ], + "children": [], + "returnComment": [] }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/agg_filters/agg_type_field_filters.ts" + "parentPluginId": "dataViews", + "id": "def-common.DataView.isTimeBased", + "type": "Function", + "tags": [], + "label": "isTimeBased", + "description": [ + "\nDoes the data view have a timestamp field?" + ], + "signature": [ + "() => this is ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.TimeBasedDataView", + "text": "TimeBasedDataView" + } + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/agg_filters/agg_type_field_filters.ts" + "parentPluginId": "dataViews", + "id": "def-common.DataView.isTimeNanosBased", + "type": "Function", + "tags": [], + "label": "isTimeNanosBased", + "description": [ + "\nDoes the data view have a timestamp field and is it a date nanos field?" + ], + "signature": [ + "() => this is ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.TimeBasedDataView", + "text": "TimeBasedDataView" + } + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_param_props.ts" + "parentPluginId": "dataViews", + "id": "def-common.DataView.getTimeField", + "type": "Function", + "tags": [], + "label": "getTimeField", + "description": [ + "\nGet timestamp field as DataViewField or return undefined" + ], + "signature": [ + "() => ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewField", + "text": "DataViewField" + }, + " | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_param_props.ts" + "parentPluginId": "dataViews", + "id": "def-common.DataView.getFieldByName", + "type": "Function", + "tags": [], + "label": "getFieldByName", + "description": [ + "\nGet field by name." + ], + "signature": [ + "(name: string) => ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewField", + "text": "DataViewField" + }, + " | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.DataView.getFieldByName.$1", + "type": "string", + "tags": [], + "label": "name", + "description": [ + "field name" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/controls/field.tsx" + "parentPluginId": "dataViews", + "id": "def-common.DataView.getAggregationRestrictions", + "type": "Function", + "tags": [], + "label": "getAggregationRestrictions", + "description": [ + "\nGet aggregation restrictions. Rollup fields can only perform a subset of aggregations." + ], + "signature": [ + "() => Record | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/controls/field.tsx" + "parentPluginId": "dataViews", + "id": "def-common.DataView.getAsSavedObjectBody", + "type": "Function", + "tags": [], + "label": "getAsSavedObjectBody", + "description": [ + "\nReturns index pattern as saved object body for saving" + ], + "signature": [ + "() => ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewAttributes", + "text": "DataViewAttributes" + } + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/controls/field.tsx" + "parentPluginId": "dataViews", + "id": "def-common.DataView.getFormatterForField", + "type": "Function", + "tags": [], + "label": "getFormatterForField", + "description": [ + "\nProvide a field, get its formatter" + ], + "signature": [ + "(field: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewField", + "text": "DataViewField" + }, + " | ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + ") => ", + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.FieldFormat", + "text": "FieldFormat" + } + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.DataView.getFormatterForField.$1", + "type": "CompoundType", + "tags": [], + "label": "field", + "description": [ + "field to get formatter for" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewField", + "text": "DataViewField" + }, + " | ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + } + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/controls/field.tsx" + "parentPluginId": "dataViews", + "id": "def-common.DataView.addRuntimeField", + "type": "Function", + "tags": [], + "label": "addRuntimeField", + "description": [ + "\nAdd a runtime field - Appended to existing mapped field or a new field is\ncreated as appropriate." + ], + "signature": [ + "(name: string, runtimeField: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.RuntimeField", + "text": "RuntimeField" + }, + ") => ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewField", + "text": "DataViewField" + }, + "[]" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.DataView.addRuntimeField.$1", + "type": "string", + "tags": [], + "label": "name", + "description": [ + "Field name" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "dataViews", + "id": "def-common.DataView.addRuntimeField.$2", + "type": "Object", + "tags": [], + "label": "runtimeField", + "description": [ + "Runtime field definition" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.RuntimeField", + "text": "RuntimeField" + } + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/controls/top_field.tsx" + "parentPluginId": "dataViews", + "id": "def-common.DataView.hasRuntimeField", + "type": "Function", + "tags": [], + "label": "hasRuntimeField", + "description": [ + "\nChecks if runtime field exists" + ], + "signature": [ + "(name: string) => boolean" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.DataView.hasRuntimeField.$1", + "type": "string", + "tags": [], + "label": "name", + "description": [ + "field name" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/controls/top_field.tsx" + "parentPluginId": "dataViews", + "id": "def-common.DataView.getRuntimeField", + "type": "Function", + "tags": [], + "label": "getRuntimeField", + "description": [ + "\nReturns runtime field if exists" + ], + "signature": [ + "(name: string) => ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.RuntimeField", + "text": "RuntimeField" + }, + " | null" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.DataView.getRuntimeField.$1", + "type": "string", + "tags": [], + "label": "name", + "description": [ + "Runtime field name" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/controls/top_sort_field.tsx" + "parentPluginId": "dataViews", + "id": "def-common.DataView.getAllRuntimeFields", + "type": "Function", + "tags": [], + "label": "getAllRuntimeFields", + "description": [ + "\nGet all runtime field definitions." + ], + "signature": [ + "() => Record" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [], + "returnComment": [ + "map of runtime field definitions by field name" + ] }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/controls/top_sort_field.tsx" + "parentPluginId": "dataViews", + "id": "def-common.DataView.getFieldsByRuntimeFieldName", + "type": "Function", + "tags": [], + "label": "getFieldsByRuntimeFieldName", + "description": [ + "\nReturns data view fields backed by runtime fields." + ], + "signature": [ + "(name: string) => Record | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.DataView.getFieldsByRuntimeFieldName.$1", + "type": "string", + "tags": [], + "label": "name", + "description": [ + "runtime field name" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [ + "map of DataViewFields (that are runtime fields) by field name" + ] }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.ts" + "parentPluginId": "dataViews", + "id": "def-common.DataView.replaceAllRuntimeFields", + "type": "Function", + "tags": [], + "label": "replaceAllRuntimeFields", + "description": [ + "\nReplaces all existing runtime fields with new fields." + ], + "signature": [ + "(newFields: Record) => void" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.DataView.replaceAllRuntimeFields.$1", + "type": "Object", + "tags": [], + "label": "newFields", + "description": [ + "Map of runtime field definitions by field name" + ], + "signature": [ + "Record" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.ts" + "parentPluginId": "dataViews", + "id": "def-common.DataView.removeRuntimeField", + "type": "Function", + "tags": [], + "label": "removeRuntimeField", + "description": [ + "\nRemove a runtime field - removed from mapped field or removed unmapped\nfield as appropriate. Doesn't clear associated field attributes." + ], + "signature": [ + "(name: string) => void" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.DataView.removeRuntimeField.$1", + "type": "string", + "tags": [], + "label": "name", + "description": [ + "- Field name to remove" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.ts" + "parentPluginId": "dataViews", + "id": "def-common.DataView.getRuntimeMappings", + "type": "Function", + "tags": [], + "label": "getRuntimeMappings", + "description": [ + "\nReturn the \"runtime_mappings\" section of the ES search query." + ], + "signature": [ + "() => ", + "MappingRuntimeFields" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.ts" + "parentPluginId": "dataViews", + "id": "def-common.DataView.getFormatterForFieldNoDefault", + "type": "Function", + "tags": [], + "label": "getFormatterForFieldNoDefault", + "description": [ + "\nGet formatter for a given field name. Return undefined if none exists." + ], + "signature": [ + "(fieldname: string) => ", + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.FieldFormat", + "text": "FieldFormat" + }, + " | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.DataView.getFormatterForFieldNoDefault.$1", + "type": "string", + "tags": [], + "label": "fieldname", + "description": [ + "name of field to get formatter for" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_params_helper.ts" + "parentPluginId": "dataViews", + "id": "def-common.DataView.setFieldAttrs", + "type": "Function", + "tags": [], + "label": "setFieldAttrs", + "description": [ + "\nSet field attribute" + ], + "signature": [ + "(fieldName: string, attrName: K, value: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldAttrSet", + "text": "FieldAttrSet" + }, + "[K]) => void" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.DataView.setFieldAttrs.$1", + "type": "string", + "tags": [], + "label": "fieldName", + "description": [ + "name of field to set attribute on" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "dataViews", + "id": "def-common.DataView.setFieldAttrs.$2", + "type": "Uncategorized", + "tags": [], + "label": "attrName", + "description": [ + "name of attribute to set" + ], + "signature": [ + "K" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "dataViews", + "id": "def-common.DataView.setFieldAttrs.$3", + "type": "Uncategorized", + "tags": [], + "label": "value", + "description": [ + "value of attribute" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldAttrSet", + "text": "FieldAttrSet" + }, + "[K]" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { - "plugin": "dataViewEditor", - "path": "src/plugins/data_view_editor/public/lib/extract_time_fields.test.ts" + "parentPluginId": "dataViews", + "id": "def-common.DataView.setFieldCustomLabel", + "type": "Function", + "tags": [], + "label": "setFieldCustomLabel", + "description": [ + "\nSet field custom label" + ], + "signature": [ + "(fieldName: string, customLabel: string | null | undefined) => void" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.DataView.setFieldCustomLabel.$1", + "type": "string", + "tags": [], + "label": "fieldName", + "description": [ + "name of field to set custom label on" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "dataViews", + "id": "def-common.DataView.setFieldCustomLabel.$2", + "type": "CompoundType", + "tags": [], + "label": "customLabel", + "description": [ + "custom label value. If undefined, custom label is removed" + ], + "signature": [ + "string | null | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] }, { - "plugin": "dataViewEditor", - "path": "src/plugins/data_view_editor/public/lib/extract_time_fields.test.ts" + "parentPluginId": "dataViews", + "id": "def-common.DataView.setFieldCount", + "type": "Function", + "tags": [], + "label": "setFieldCount", + "description": [ + "\nSet field count" + ], + "signature": [ + "(fieldName: string, count: number | null | undefined) => void" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.DataView.setFieldCount.$1", + "type": "string", + "tags": [], + "label": "fieldName", + "description": [ + "name of field to set count on" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "dataViews", + "id": "def-common.DataView.setFieldCount.$2", + "type": "CompoundType", + "tags": [], + "label": "count", + "description": [ + "count value. If undefined, count is removed" + ], + "signature": [ + "number | null | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] }, { - "plugin": "dataViewEditor", - "path": "src/plugins/data_view_editor/public/lib/extract_time_fields.test.ts" + "parentPluginId": "dataViews", + "id": "def-common.DataView.setFieldFormat", + "type": "Function", + "tags": [], + "label": "setFieldFormat", + "description": [ + "\nSet field formatter" + ], + "signature": [ + "(fieldName: string, format: ", + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.SerializedFieldFormat", + "text": "SerializedFieldFormat" + }, + "<", + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.FieldFormatParams", + "text": "FieldFormatParams" + }, + ">) => void" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.DataView.setFieldFormat.$1", + "type": "string", + "tags": [], + "label": "fieldName", + "description": [ + "name of field to set format on" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "dataViews", + "id": "def-common.DataView.setFieldFormat.$2", + "type": "Object", + "tags": [], + "label": "format", + "description": [ + "field format in serialized form" + ], + "signature": [ + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.SerializedFieldFormat", + "text": "SerializedFieldFormat" + }, + "<", + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.FieldFormatParams", + "text": "FieldFormatParams" + }, + ">" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { - "plugin": "data", - "path": "src/plugins/data/common/index.ts" - }, + "parentPluginId": "dataViews", + "id": "def-common.DataView.deleteFieldFormat", + "type": "Function", + "tags": [], + "label": "deleteFieldFormat", + "description": [ + "\nRemove field format from the field format map." + ], + "signature": [ + "(fieldName: string) => void" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.DataView.deleteFieldFormat.$1", + "type": "string", + "tags": [], + "label": "fieldName", + "description": [ + "field name associated with the format for removal" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewField", + "type": "Class", + "tags": [], + "label": "DataViewField", + "description": [ + "\nData view field class" + ], + "signature": [ { - "plugin": "data", - "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts" + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewField", + "text": "DataViewField" }, + " implements ", + "DataViewFieldBase" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false, + "children": [ { - "plugin": "data", - "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts" + "parentPluginId": "dataViews", + "id": "def-common.DataViewField.spec", + "type": "Object", + "tags": [], + "label": "spec", + "description": [], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + } + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false }, { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.ts" + "parentPluginId": "dataViews", + "id": "def-common.DataViewField.Unnamed", + "type": "Function", + "tags": [ + "constructor" + ], + "label": "Constructor", + "description": [ + "\nDataView constructor" + ], + "signature": [ + "any" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewField.Unnamed.$1", + "type": "Object", + "tags": [], + "label": "spec", + "description": [ + "Configuration for the field" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + } + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.ts" + "parentPluginId": "dataViews", + "id": "def-common.DataViewField.count", + "type": "number", + "tags": [], + "label": "count", + "description": [ + "\nCount is used for field popularity in discover." + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false }, { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.ts" + "parentPluginId": "dataViews", + "id": "def-common.DataViewField.count", + "type": "number", + "tags": [], + "label": "count", + "description": [ + "\nSet count, which is used for field popularity in discover." + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false }, { - "plugin": "data", - "path": "src/plugins/data/server/index.ts" + "parentPluginId": "dataViews", + "id": "def-common.DataViewField.runtimeField", + "type": "Object", + "tags": [], + "label": "runtimeField", + "description": [ + "\nReturns runtime field definition or undefined if field is not runtime field." + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.RuntimeFieldSpec", + "text": "RuntimeFieldSpec" + }, + " | undefined" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false }, { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/agg_config.test.ts" + "parentPluginId": "dataViews", + "id": "def-common.DataViewField.runtimeField", + "type": "Object", + "tags": [], + "label": "runtimeField", + "description": [ + "\nSets runtime field definition or unsets if undefined is provided." + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.RuntimeFieldSpec", + "text": "RuntimeFieldSpec" + }, + " | undefined" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false }, { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/agg_config.test.ts" + "parentPluginId": "dataViews", + "id": "def-common.DataViewField.script", + "type": "string", + "tags": [], + "label": "script", + "description": [ + "\nScript field code" + ], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false }, { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/buckets/_terms_other_bucket_helper.test.ts" + "parentPluginId": "dataViews", + "id": "def-common.DataViewField.script", + "type": "string", + "tags": [], + "label": "script", + "description": [ + "\nSets scripted field painless code" + ], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false }, { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/buckets/_terms_other_bucket_helper.test.ts" + "parentPluginId": "dataViews", + "id": "def-common.DataViewField.lang", + "type": "string", + "tags": [], + "label": "lang", + "description": [ + "\nScript field language" + ], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false }, { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/buckets/multi_terms.test.ts" + "parentPluginId": "dataViews", + "id": "def-common.DataViewField.lang", + "type": "string", + "tags": [], + "label": "lang", + "description": [ + "\nSets scripted field langauge." + ], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false }, { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/buckets/multi_terms.test.ts" + "parentPluginId": "dataViews", + "id": "def-common.DataViewField.customLabel", + "type": "string", + "tags": [], + "label": "customLabel", + "description": [ + "\nReturns custom label if set, otherwise undefined." + ], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false }, { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/buckets/multi_terms.test.ts" + "parentPluginId": "dataViews", + "id": "def-common.DataViewField.customLabel", + "type": "string", + "tags": [], + "label": "customLabel", + "description": [ + "\nSets custom label for field, or unsets if passed undefined." + ], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false }, { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/buckets/rare_terms.test.ts" + "parentPluginId": "dataViews", + "id": "def-common.DataViewField.conflictDescriptions", + "type": "Object", + "tags": [], + "label": "conflictDescriptions", + "description": [ + "\nDescription of field type conflicts across different indices in the same index pattern." + ], + "signature": [ + "Record | undefined" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false }, { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/buckets/rare_terms.test.ts" + "parentPluginId": "dataViews", + "id": "def-common.DataViewField.conflictDescriptions", + "type": "Object", + "tags": [], + "label": "conflictDescriptions", + "description": [ + "\nSets conflict descriptions for field." + ], + "signature": [ + "Record | undefined" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false }, { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/buckets/terms.test.ts" + "parentPluginId": "dataViews", + "id": "def-common.DataViewField.name", + "type": "string", + "tags": [], + "label": "name", + "description": [ + "\nGet field name" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false }, { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/buckets/terms.test.ts" + "parentPluginId": "dataViews", + "id": "def-common.DataViewField.displayName", + "type": "string", + "tags": [], + "label": "displayName", + "description": [ + "\nGets display name, calcualted based on name, custom label and shortDotsEnable." + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false }, { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/buckets/terms.test.ts" + "parentPluginId": "dataViews", + "id": "def-common.DataViewField.type", + "type": "string", + "tags": [], + "label": "type", + "description": [ + "\nGets field type" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false }, { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/utils/infer_time_zone.test.ts" + "parentPluginId": "dataViews", + "id": "def-common.DataViewField.esTypes", + "type": "Array", + "tags": [], + "label": "esTypes", + "description": [ + "\nGets ES types as string array" + ], + "signature": [ + "string[] | undefined" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false }, { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/utils/infer_time_zone.test.ts" + "parentPluginId": "dataViews", + "id": "def-common.DataViewField.scripted", + "type": "boolean", + "tags": [], + "label": "scripted", + "description": [ + "\nReturns true if scripted field" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false }, { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/param_types/field.ts" + "parentPluginId": "dataViews", + "id": "def-common.DataViewField.searchable", + "type": "boolean", + "tags": [], + "label": "searchable", + "description": [ + "\nReturns true if field is searchable" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false }, { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/param_types/field.ts" + "parentPluginId": "dataViews", + "id": "def-common.DataViewField.aggregatable", + "type": "boolean", + "tags": [], + "label": "aggregatable", + "description": [ + "\nReturns true if field is aggregatable" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false }, { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/param_types/field.ts" + "parentPluginId": "dataViews", + "id": "def-common.DataViewField.readFromDocValues", + "type": "boolean", + "tags": [], + "label": "readFromDocValues", + "description": [ + "\nReturns true if field is available via doc values" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false }, { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/param_types/field.ts" - } - ], - "children": [], - "initialIsOpen": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.IndexPatternsService", - "type": "Class", - "tags": [ - "deprecated" - ], - "label": "IndexPatternsService", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IndexPatternsService", - "text": "IndexPatternsService" + "parentPluginId": "dataViews", + "id": "def-common.DataViewField.subType", + "type": "CompoundType", + "tags": [], + "label": "subType", + "description": [ + "\nReturns field subtype, multi, nested, or undefined if neither" + ], + "signature": [ + "IFieldSubType", + " | undefined" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false }, - " extends ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewsService", - "text": "DataViewsService" - } - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": true, - "references": [ { - "plugin": "data", - "path": "src/plugins/data/common/index.ts" + "parentPluginId": "dataViews", + "id": "def-common.DataViewField.isMapped", + "type": "CompoundType", + "tags": [], + "label": "isMapped", + "description": [ + "\nIs the field part of the index mapping?" + ], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false }, { - "plugin": "data", - "path": "src/plugins/data/server/index.ts" + "parentPluginId": "dataViews", + "id": "def-common.DataViewField.isRuntimeField", + "type": "boolean", + "tags": [], + "label": "isRuntimeField", + "description": [ + "\nReturns true if runtime field defined on data view" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false }, { - "plugin": "data", - "path": "src/plugins/data/server/index.ts" + "parentPluginId": "dataViews", + "id": "def-common.DataViewField.sortable", + "type": "boolean", + "tags": [], + "label": "sortable", + "description": [ + "\nReturns true if field is sortable" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false }, { - "plugin": "data", - "path": "src/plugins/data/server/index.ts" + "parentPluginId": "dataViews", + "id": "def-common.DataViewField.filterable", + "type": "boolean", + "tags": [], + "label": "filterable", + "description": [ + "\nReturns true if field is filterable" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/server/data_indexing/create_doc_source.ts" + "parentPluginId": "dataViews", + "id": "def-common.DataViewField.visualizable", + "type": "boolean", + "tags": [], + "label": "visualizable", + "description": [ + "\nReturns true if field is visualizable" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/server/data_indexing/create_doc_source.ts" + "parentPluginId": "dataViews", + "id": "def-common.DataViewField.isSubtypeNested", + "type": "Function", + "tags": [], + "label": "isSubtypeNested", + "description": [ + "\nReturns true if field is subtype nested" + ], + "signature": [ + "() => boolean" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { - "plugin": "data", - "path": "src/plugins/data/public/index.ts" - } - ], - "children": [], - "initialIsOpen": false - } - ], - "functions": [ - { - "parentPluginId": "dataViews", - "id": "def-common.fieldList", - "type": "Function", - "tags": [], - "label": "fieldList", - "description": [], - "signature": [ - "(specs?: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" + "parentPluginId": "dataViews", + "id": "def-common.DataViewField.isSubtypeMulti", + "type": "Function", + "tags": [], + "label": "isSubtypeMulti", + "description": [ + "\nReturns true if field is subtype multi" + ], + "signature": [ + "() => boolean" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, - "[], shortDotsEnable?: boolean) => ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IIndexPatternFieldList", - "text": "IIndexPatternFieldList" - } - ], - "path": "src/plugins/data_views/common/fields/field_list.ts", - "deprecated": false, - "children": [ { "parentPluginId": "dataViews", - "id": "def-common.fieldList.$1", - "type": "Array", + "id": "def-common.DataViewField.getSubtypeNested", + "type": "Function", "tags": [], - "label": "specs", - "description": [], + "label": "getSubtypeNested", + "description": [ + "\nReturns subtype nested data if exists" + ], "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - "[]" + "() => ", + "IFieldSubTypeNested", + " | undefined" ], - "path": "src/plugins/data_views/common/fields/field_list.ts", + "path": "src/plugins/data_views/common/fields/data_view_field.ts", "deprecated": false, - "isRequired": true + "children": [], + "returnComment": [] }, { "parentPluginId": "dataViews", - "id": "def-common.fieldList.$2", - "type": "boolean", + "id": "def-common.DataViewField.getSubtypeMulti", + "type": "Function", "tags": [], - "label": "shortDotsEnable", - "description": [], + "label": "getSubtypeMulti", + "description": [ + "\nReturns subtype multi data if exists" + ], "signature": [ - "boolean" + "() => ", + "IFieldSubTypeMulti", + " | undefined" ], - "path": "src/plugins/data_views/common/fields/field_list.ts", + "path": "src/plugins/data_views/common/fields/data_view_field.ts", "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.getFieldSubtypeMulti", - "type": "Function", - "tags": [], - "label": "getFieldSubtypeMulti", - "description": [], - "signature": [ - "(field: HasSubtype) => ", - "IFieldSubTypeMulti", - " | undefined" - ], - "path": "src/plugins/data_views/common/fields/utils.ts", - "deprecated": false, - "returnComment": [], - "children": [ + "children": [], + "returnComment": [] + }, { "parentPluginId": "dataViews", - "id": "def-common.getFieldSubtypeMulti.$1", - "type": "Object", + "id": "def-common.DataViewField.deleteCount", + "type": "Function", "tags": [], - "label": "field", - "description": [], + "label": "deleteCount", + "description": [ + "\nDeletes count value. Popularity as used by discover" + ], "signature": [ - "{ subType?: ", - "IFieldSubType", - " | undefined; }" + "() => void" ], - "path": "src/plugins/data_views/common/fields/utils.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.getFieldSubtypeNested", - "type": "Function", - "tags": [], - "label": "getFieldSubtypeNested", - "description": [], - "signature": [ - "(field: HasSubtype) => ", - "IFieldSubTypeNested", - " | undefined" - ], - "path": "src/plugins/data_views/common/fields/utils.ts", - "deprecated": false, - "returnComment": [], - "children": [ + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, { "parentPluginId": "dataViews", - "id": "def-common.getFieldSubtypeNested.$1", - "type": "Object", + "id": "def-common.DataViewField.toJSON", + "type": "Function", "tags": [], - "label": "field", - "description": [], + "label": "toJSON", + "description": [ + "\nJSON version of field" + ], "signature": [ - "{ subType?: ", + "() => { count: number; script: string | undefined; lang: string | undefined; conflictDescriptions: Record | undefined; name: string; type: string; esTypes: string[] | undefined; scripted: boolean; searchable: boolean; aggregatable: boolean; readFromDocValues: boolean; subType: ", "IFieldSubType", - " | undefined; }" + " | undefined; customLabel: string | undefined; }" ], - "path": "src/plugins/data_views/common/fields/utils.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.getIndexPatternLoadMeta", - "type": "Function", - "tags": [], - "label": "getIndexPatternLoadMeta", - "description": [], - "signature": [ - "() => Omit<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IndexPatternLoadExpressionFunctionDefinition", - "text": "IndexPatternLoadExpressionFunctionDefinition" - }, - ", \"fn\">" - ], - "path": "src/plugins/data_views/common/expressions/load_index_pattern.ts", - "deprecated": false, - "children": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.isFilterable", - "type": "Function", - "tags": [], - "label": "isFilterable", - "description": [], - "signature": [ - "(field: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, - ") => boolean" - ], - "path": "src/plugins/data_views/common/fields/utils.ts", - "deprecated": false, - "children": [ { "parentPluginId": "dataViews", - "id": "def-common.isFilterable.$1", - "type": "Object", + "id": "def-common.DataViewField.toSpec", + "type": "Function", "tags": [], - "label": "field", - "description": [], + "label": "toSpec", + "description": [ + "\nGet field in serialized form - fieldspec." + ], "signature": [ + "(config?: ", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" + "section": "def-common.ToSpecConfig", + "text": "ToSpecConfig" + }, + ") => ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" } ], - "path": "src/plugins/data_views/common/fields/utils.ts", + "path": "src/plugins/data_views/common/fields/data_view_field.ts", "deprecated": false, - "isRequired": true + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewField.toSpec.$1", + "type": "Object", + "tags": [], + "label": "config", + "description": [ + "provide a method to get a field formatter" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.ToSpecConfig", + "text": "ToSpecConfig" + } + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [ + "field in serialized form - field spec" + ] + }, + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewField.isRuntimeCompositeSubField", + "type": "Function", + "tags": [], + "label": "isRuntimeCompositeSubField", + "description": [ + "\nReturns true if composite runtime field" + ], + "signature": [ + "() => boolean" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false, + "children": [], + "returnComment": [] } ], - "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "dataViews", - "id": "def-common.isMultiField", - "type": "Function", - "tags": [], - "label": "isMultiField", - "description": [], + "id": "def-common.DataViewInsufficientAccessError", + "type": "Class", + "tags": [ + "constructor" + ], + "label": "DataViewInsufficientAccessError", + "description": [ + "\nError thrown when action attempted without sufficient access." + ], "signature": [ - "(field: HasSubtype) => boolean" + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewInsufficientAccessError", + "text": "DataViewInsufficientAccessError" + }, + " extends Error" ], - "path": "src/plugins/data_views/common/fields/utils.ts", + "path": "src/plugins/data_views/common/errors/insufficient_access.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "dataViews", - "id": "def-common.isMultiField.$1", - "type": "Object", + "id": "def-common.DataViewInsufficientAccessError.Unnamed", + "type": "Function", "tags": [], - "label": "field", - "description": [], + "label": "Constructor", + "description": [ + "\nconstructor" + ], "signature": [ - "{ subType?: ", - "IFieldSubType", - " | undefined; }" + "any" + ], + "path": "src/plugins/data_views/common/errors/insufficient_access.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewInsufficientAccessError.Unnamed.$1", + "type": "string", + "tags": [], + "label": "savedObjectId", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/common/errors/insufficient_access.ts", + "deprecated": false, + "isRequired": false + } ], - "path": "src/plugins/data_views/common/fields/utils.ts", - "deprecated": false + "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "dataViews", - "id": "def-common.isNestedField", - "type": "Function", + "id": "def-common.DataViewSavedObjectConflictError", + "type": "Class", "tags": [], - "label": "isNestedField", - "description": [], + "label": "DataViewSavedObjectConflictError", + "description": [ + "\nError thrown when saved object has been changed when attempting to save." + ], "signature": [ - "(field: HasSubtype) => boolean" + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewSavedObjectConflictError", + "text": "DataViewSavedObjectConflictError" + }, + " extends Error" ], - "path": "src/plugins/data_views/common/fields/utils.ts", + "path": "src/plugins/data_views/common/errors/data_view_saved_object_conflict.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "dataViews", - "id": "def-common.isNestedField.$1", - "type": "Object", + "id": "def-common.DataViewSavedObjectConflictError.Unnamed", + "type": "Function", "tags": [], - "label": "field", - "description": [], + "label": "Constructor", + "description": [ + "\nconstructor" + ], "signature": [ - "{ subType?: ", - "IFieldSubType", - " | undefined; }" + "any" ], - "path": "src/plugins/data_views/common/fields/utils.ts", - "deprecated": false + "path": "src/plugins/data_views/common/errors/data_view_saved_object_conflict.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewSavedObjectConflictError.Unnamed.$1", + "type": "string", + "tags": [], + "label": "savedObjectId", + "description": [ + "saved object id with conflict" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/errors/data_view_saved_object_conflict.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] } ], "initialIsOpen": false - } - ], - "interfaces": [ + }, { "parentPluginId": "dataViews", - "id": "def-common.DataViewAttributes", - "type": "Interface", + "id": "def-common.DataViewsService", + "type": "Class", "tags": [], - "label": "DataViewAttributes", + "label": "DataViewsService", "description": [ - "\nInterface for an index pattern saved object" + "\nData views service, providing CRUD operations for data views." ], - "path": "src/plugins/data_views/common/types.ts", + "path": "src/plugins/data_views/common/data_views/data_views.ts", "deprecated": false, "children": [ { "parentPluginId": "dataViews", - "id": "def-common.DataViewAttributes.fields", - "type": "string", + "id": "def-common.DataViewsService.getCanSave", + "type": "Function", + "tags": [], + "label": "getCanSave", + "description": [ + "\nCan the user save data views?" + ], + "signature": [ + "() => Promise" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "returnComment": [], + "children": [] + }, + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsService.Unnamed", + "type": "Function", + "tags": [], + "label": "Constructor", + "description": [ + "\nDataViewsService constructor" + ], + "signature": [ + "any" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsService.Unnamed.$1", + "type": "Object", + "tags": [], + "label": "deps", + "description": [ + "Service dependencies" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewsServiceDeps", + "text": "DataViewsServiceDeps" + } + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsService.getIds", + "type": "Function", + "tags": [], + "label": "getIds", + "description": [ + "\nGets list of index pattern ids." + ], + "signature": [ + "(refresh?: boolean) => Promise" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsService.getIds.$1", + "type": "boolean", + "tags": [], + "label": "refresh", + "description": [ + "Force refresh of index pattern list" + ], + "signature": [ + "boolean" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsService.getTitles", + "type": "Function", + "tags": [], + "label": "getTitles", + "description": [ + "\nGets list of index pattern titles." + ], + "signature": [ + "(refresh?: boolean) => Promise" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsService.getTitles.$1", + "type": "boolean", + "tags": [], + "label": "refresh", + "description": [ + "Force refresh of index pattern list" + ], + "signature": [ + "boolean" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsService.find", + "type": "Function", + "tags": [], + "label": "find", + "description": [ + "\nFind and load index patterns by title." + ], + "signature": [ + "(search: string, size?: number) => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + "[]>" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsService.find.$1", + "type": "string", + "tags": [], + "label": "search", + "description": [ + "Search string" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsService.find.$2", + "type": "number", + "tags": [], + "label": "size", + "description": [ + "Number of data views to return" + ], + "signature": [ + "number" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [ + "DataView[]" + ] + }, + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsService.getIdsWithTitle", + "type": "Function", "tags": [], - "label": "fields", - "description": [], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false + "label": "getIdsWithTitle", + "description": [ + "\nGets list of index pattern ids with titles." + ], + "signature": [ + "(refresh?: boolean) => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewListItem", + "text": "DataViewListItem" + }, + "[]>" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsService.getIdsWithTitle.$1", + "type": "boolean", + "tags": [], + "label": "refresh", + "description": [ + "Force refresh of index pattern list" + ], + "signature": [ + "boolean" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "dataViews", - "id": "def-common.DataViewAttributes.title", - "type": "string", + "id": "def-common.DataViewsService.clearCache", + "type": "Function", "tags": [], - "label": "title", - "description": [], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false + "label": "clearCache", + "description": [ + "\nClear index pattern list cache." + ], + "signature": [ + "(id?: string | undefined) => void" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsService.clearCache.$1", + "type": "string", + "tags": [], + "label": "id", + "description": [ + "optionally clear a single id" + ], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] }, { "parentPluginId": "dataViews", - "id": "def-common.DataViewAttributes.type", - "type": "string", + "id": "def-common.DataViewsService.getCache", + "type": "Function", "tags": [], - "label": "type", - "description": [], + "label": "getCache", + "description": [ + "\nGet cache, contains data view saved objects." + ], "signature": [ - "string | undefined" + "() => Promise<", + "SavedObject", + "<", + "DataViewSavedObjectAttrs", + ">[] | null | undefined>" ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "dataViews", - "id": "def-common.DataViewAttributes.typeMeta", - "type": "string", + "id": "def-common.DataViewsService.getDefault", + "type": "Function", "tags": [], - "label": "typeMeta", - "description": [], + "label": "getDefault", + "description": [ + "\nGet default index pattern" + ], "signature": [ - "string | undefined" + "() => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + " | null>" ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "dataViews", - "id": "def-common.DataViewAttributes.timeFieldName", - "type": "string", + "id": "def-common.DataViewsService.getDefaultId", + "type": "Function", "tags": [], - "label": "timeFieldName", - "description": [], + "label": "getDefaultId", + "description": [ + "\nGet default index pattern id" + ], "signature": [ - "string | undefined" + "() => Promise" ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "dataViews", - "id": "def-common.DataViewAttributes.sourceFilters", - "type": "string", + "id": "def-common.DataViewsService.setDefault", + "type": "Function", "tags": [], - "label": "sourceFilters", - "description": [], + "label": "setDefault", + "description": [ + "\nOptionally set default index pattern, unless force = true" + ], "signature": [ - "string | undefined" + "(id: string | null, force?: boolean) => Promise" ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsService.setDefault.$1", + "type": "CompoundType", + "tags": [], + "label": "id", + "description": [ + "data view id" + ], + "signature": [ + "string | null" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": false + }, + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsService.setDefault.$2", + "type": "boolean", + "tags": [], + "label": "force", + "description": [ + "set default data view even if there's an existing default" + ], + "signature": [ + "boolean" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "dataViews", - "id": "def-common.DataViewAttributes.fieldFormatMap", - "type": "string", + "id": "def-common.DataViewsService.hasUserDataView", + "type": "Function", "tags": [], - "label": "fieldFormatMap", - "description": [], + "label": "hasUserDataView", + "description": [ + "\nChecks if current user has a user created index pattern ignoring fleet's server default index patterns." + ], "signature": [ - "string | undefined" + "() => Promise" ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "dataViews", - "id": "def-common.DataViewAttributes.fieldAttrs", - "type": "string", + "id": "def-common.DataViewsService.getFieldsForWildcard", + "type": "Function", "tags": [], - "label": "fieldAttrs", - "description": [], + "label": "getFieldsForWildcard", + "description": [ + "\nGet field list by providing { pattern }." + ], "signature": [ - "string | undefined" + "(options: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.GetFieldsOptions", + "text": "GetFieldsOptions" + }, + ") => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + "[]>" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsService.getFieldsForWildcard.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [ + "options for getting field list" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.GetFieldsOptions", + "text": "GetFieldsOptions" + } + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false + "returnComment": [ + "FieldSpec[]" + ] }, { "parentPluginId": "dataViews", - "id": "def-common.DataViewAttributes.runtimeFieldMap", - "type": "string", + "id": "def-common.DataViewsService.getFieldsForIndexPattern", + "type": "Function", "tags": [], - "label": "runtimeFieldMap", - "description": [], + "label": "getFieldsForIndexPattern", + "description": [ + "\nGet field list by providing an index patttern (or spec)." + ], "signature": [ - "string | undefined" + "(indexPattern: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + " | ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewSpec", + "text": "DataViewSpec" + }, + ", options?: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.GetFieldsOptions", + "text": "GetFieldsOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + "[]>" ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsService.getFieldsForIndexPattern.$1", + "type": "CompoundType", + "tags": [], + "label": "indexPattern", + "description": [], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + " | ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewSpec", + "text": "DataViewSpec" + } + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsService.getFieldsForIndexPattern.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [ + "options for getting field list" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.GetFieldsOptions", + "text": "GetFieldsOptions" + }, + " | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [ + "FieldSpec[]" + ] }, { "parentPluginId": "dataViews", - "id": "def-common.DataViewAttributes.allowNoIndex", - "type": "CompoundType", + "id": "def-common.DataViewsService.refreshFields", + "type": "Function", "tags": [], - "label": "allowNoIndex", + "label": "refreshFields", "description": [ - "\nprevents errors when index pattern exists before indices" + "\nRefresh field list for a given index pattern." ], "signature": [ - "boolean | undefined" + "(indexPattern: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + ") => Promise" ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewListItem", - "type": "Interface", - "tags": [], - "label": "DataViewListItem", - "description": [], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewListItem.id", - "type": "string", - "tags": [], - "label": "id", - "description": [], "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsService.refreshFields.$1", + "type": "Object", + "tags": [], + "label": "indexPattern", + "description": [], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + } + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "dataViews", - "id": "def-common.DataViewListItem.namespaces", - "type": "Array", + "id": "def-common.DataViewsService.fieldArrayToMap", + "type": "Function", "tags": [], - "label": "namespaces", - "description": [], + "label": "fieldArrayToMap", + "description": [ + "\nConverts field array to map." + ], "signature": [ - "string[] | undefined" + "(fields: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + "[], fieldAttrs?: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldAttrs", + "text": "FieldAttrs" + }, + " | undefined) => ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewFieldMap", + "text": "DataViewFieldMap" + } ], "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsService.fieldArrayToMap.$1", + "type": "Array", + "tags": [], + "label": "fields", + "description": [ + ": FieldSpec[]" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + "[]" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsService.fieldArrayToMap.$2", + "type": "Object", + "tags": [], + "label": "fieldAttrs", + "description": [ + ": FieldAttrs" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldAttrs", + "text": "FieldAttrs" + }, + " | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [ + "Record" + ] }, { "parentPluginId": "dataViews", - "id": "def-common.DataViewListItem.title", - "type": "string", + "id": "def-common.DataViewsService.savedObjectToSpec", + "type": "Function", "tags": [], - "label": "title", - "description": [], + "label": "savedObjectToSpec", + "description": [ + "\nConverts data view saved object to data view spec." + ], + "signature": [ + "(savedObject: ", + "SavedObject", + "<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewAttributes", + "text": "DataViewAttributes" + }, + ">) => ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewSpec", + "text": "DataViewSpec" + } + ], "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsService.savedObjectToSpec.$1", + "type": "Object", + "tags": [], + "label": "savedObject", + "description": [], + "signature": [ + "SavedObject", + "<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewAttributes", + "text": "DataViewAttributes" + }, + ">" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [ + "DataViewSpec" + ] }, { "parentPluginId": "dataViews", - "id": "def-common.DataViewListItem.type", - "type": "string", + "id": "def-common.DataViewsService.get", + "type": "Function", "tags": [], - "label": "type", - "description": [], + "label": "get", + "description": [ + "\nGet an index pattern by id, cache optimized." + ], "signature": [ - "string | undefined" + "(id: string) => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + ">" ], "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsService.get.$1", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "dataViews", - "id": "def-common.DataViewListItem.typeMeta", - "type": "Object", + "id": "def-common.DataViewsService.create", + "type": "Function", "tags": [], - "label": "typeMeta", - "description": [], + "label": "create", + "description": [ + "\nCreate a new data view instance." + ], "signature": [ + "(spec: ", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.TypeMeta", - "text": "TypeMeta" + "section": "def-common.DataViewSpec", + "text": "DataViewSpec" }, - " | undefined" + ", skipFetchFields?: boolean) => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + ">" ], "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewSpec", - "type": "Interface", - "tags": [], - "label": "DataViewSpec", - "description": [ - "\nStatic index pattern format\nSerialized data object, representing index pattern attributes and state" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "children": [ + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsService.create.$1", + "type": "Object", + "tags": [], + "label": "spec", + "description": [ + "data view spec" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewSpec", + "text": "DataViewSpec" + } + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsService.create.$2", + "type": "boolean", + "tags": [], + "label": "skipFetchFields", + "description": [ + "if true, will not fetch fields" + ], + "signature": [ + "boolean" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [ + "DataView" + ] + }, { "parentPluginId": "dataViews", - "id": "def-common.DataViewSpec.id", - "type": "string", + "id": "def-common.DataViewsService.createAndSave", + "type": "Function", "tags": [], - "label": "id", + "label": "createAndSave", "description": [ - "\nsaved object id" + "\nCreate a new data view and save it right away." ], "signature": [ - "string | undefined" + "(spec: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewSpec", + "text": "DataViewSpec" + }, + ", override?: boolean, skipFetchFields?: boolean) => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + ">" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsService.createAndSave.$1", + "type": "Object", + "tags": [], + "label": "spec", + "description": [ + "data view spec" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewSpec", + "text": "DataViewSpec" + } + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsService.createAndSave.$2", + "type": "boolean", + "tags": [], + "label": "override", + "description": [ + "Overwrite if existing index pattern exists." + ], + "signature": [ + "boolean" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsService.createAndSave.$3", + "type": "boolean", + "tags": [], + "label": "skipFetchFields", + "description": [ + "Whether to skip field refresh step." + ], + "signature": [ + "boolean" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false + "returnComment": [] }, { "parentPluginId": "dataViews", - "id": "def-common.DataViewSpec.version", - "type": "string", + "id": "def-common.DataViewsService.createSavedObject", + "type": "Function", "tags": [], - "label": "version", + "label": "createSavedObject", "description": [ - "\nsaved object version string" - ], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewSpec.title", - "type": "string", - "tags": [], - "label": "title", - "description": [], - "signature": [ - "string | undefined" + "\nSave a new data view." ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewSpec.timeFieldName", - "type": "string", - "tags": [], - "label": "timeFieldName", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewSpec.sourceFilters", - "type": "Array", - "tags": [], - "label": "sourceFilters", - "description": [], "signature": [ + "(dataView: ", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.SourceFilter", - "text": "SourceFilter" + "section": "def-common.DataView", + "text": "DataView" }, - "[] | undefined" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewSpec.fields", - "type": "Object", - "tags": [], - "label": "fields", - "description": [], - "signature": [ + ", override?: boolean) => Promise<", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewFieldMap", - "text": "DataViewFieldMap" + "section": "def-common.DataView", + "text": "DataView" }, - " | undefined" + ">" ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsService.createSavedObject.$1", + "type": "Object", + "tags": [], + "label": "dataView", + "description": [ + "data view instance" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + } + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsService.createSavedObject.$2", + "type": "boolean", + "tags": [], + "label": "override", + "description": [ + "Overwrite if existing index pattern exists" + ], + "signature": [ + "boolean" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "dataViews", - "id": "def-common.DataViewSpec.typeMeta", - "type": "Object", + "id": "def-common.DataViewsService.updateSavedObject", + "type": "Function", "tags": [], - "label": "typeMeta", - "description": [], + "label": "updateSavedObject", + "description": [ + "\nSave existing dat aview. Will attempt to merge differences if there are conflicts." + ], "signature": [ + "(indexPattern: ", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.TypeMeta", - "text": "TypeMeta" + "section": "def-common.DataView", + "text": "DataView" }, - " | undefined" + ", saveAttempts?: number, ignoreErrors?: boolean) => Promise" ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsService.updateSavedObject.$1", + "type": "Object", + "tags": [], + "label": "indexPattern", + "description": [], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + } + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsService.updateSavedObject.$2", + "type": "number", + "tags": [], + "label": "saveAttempts", + "description": [], + "signature": [ + "number" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsService.updateSavedObject.$3", + "type": "boolean", + "tags": [], + "label": "ignoreErrors", + "description": [], + "signature": [ + "boolean" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "dataViews", - "id": "def-common.DataViewSpec.type", - "type": "string", + "id": "def-common.DataViewsService.delete", + "type": "Function", "tags": [], - "label": "type", - "description": [], + "label": "delete", + "description": [ + "\nDeletes an index pattern from .kibana index." + ], "signature": [ - "string | undefined" + "(indexPatternId: string) => Promise<{}>" ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsService.delete.$1", + "type": "string", + "tags": [], + "label": "indexPatternId", + "description": [ + ": Id of kibana Index Pattern to delete" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "dataViews", - "id": "def-common.DataViewSpec.fieldFormats", - "type": "Object", + "id": "def-common.DataViewsService.getDefaultDataView", + "type": "Function", "tags": [], - "label": "fieldFormats", - "description": [], + "label": "getDefaultDataView", + "description": [ + "\nReturns the default data view as an object.\nIf no default is found, or it is missing\nanother data view is selected as default and returned.\nIf no possible data view found to become a default returns null.\n" + ], "signature": [ - "Record Promise<", { - "pluginId": "fieldFormats", + "pluginId": "dataViews", "scope": "common", - "docId": "kibFieldFormatsPluginApi", - "section": "def-common.FieldFormatParams", - "text": "FieldFormatParams" + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" }, - ">> | undefined" + " | null>" ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [], + "returnComment": [ + "default data view" + ] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "dataViews", + "id": "def-common.DuplicateDataViewError", + "type": "Class", + "tags": [], + "label": "DuplicateDataViewError", + "description": [ + "\nError thrown when attempting to create duplicate index pattern based on title." + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DuplicateDataViewError", + "text": "DuplicateDataViewError" }, + " extends Error" + ], + "path": "src/plugins/data_views/common/errors/duplicate_index_pattern.ts", + "deprecated": false, + "children": [ { "parentPluginId": "dataViews", - "id": "def-common.DataViewSpec.runtimeFieldMap", - "type": "Object", + "id": "def-common.DuplicateDataViewError.Unnamed", + "type": "Function", "tags": [], - "label": "runtimeFieldMap", - "description": [], + "label": "Constructor", + "description": [ + "\nconstructor" + ], "signature": [ - "Record | undefined" + "parentPluginId": "dataViews", + "id": "def-common.DuplicateDataViewError.Unnamed.$1", + "type": "string", + "tags": [], + "label": "message", + "description": [ + "- Error message" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/errors/duplicate_index_pattern.ts", + "deprecated": false, + "isRequired": true + } ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false + "returnComment": [] + } + ], + "initialIsOpen": false + } + ], + "functions": [ + { + "parentPluginId": "dataViews", + "id": "def-common.fieldList", + "type": "Function", + "tags": [], + "label": "fieldList", + "description": [], + "signature": [ + "(specs?: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" }, + "[], shortDotsEnable?: boolean) => ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.IIndexPatternFieldList", + "text": "IIndexPatternFieldList" + } + ], + "path": "src/plugins/data_views/common/fields/field_list.ts", + "deprecated": false, + "children": [ { "parentPluginId": "dataViews", - "id": "def-common.DataViewSpec.fieldAttrs", - "type": "Object", + "id": "def-common.fieldList.$1", + "type": "Array", "tags": [], - "label": "fieldAttrs", + "label": "specs", "description": [], "signature": [ { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldAttrs", - "text": "FieldAttrs" + "section": "def-common.FieldSpec", + "text": "FieldSpec" }, - " | undefined" + "[]" ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false + "path": "src/plugins/data_views/common/fields/field_list.ts", + "deprecated": false, + "isRequired": true }, { "parentPluginId": "dataViews", - "id": "def-common.DataViewSpec.allowNoIndex", - "type": "CompoundType", + "id": "def-common.fieldList.$2", + "type": "boolean", "tags": [], - "label": "allowNoIndex", + "label": "shortDotsEnable", "description": [], "signature": [ - "boolean | undefined" + "boolean" ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false - }, + "path": "src/plugins/data_views/common/fields/field_list.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "dataViews", + "id": "def-common.getFieldSubtypeMulti", + "type": "Function", + "tags": [], + "label": "getFieldSubtypeMulti", + "description": [], + "signature": [ + "(field: HasSubtype) => ", + "IFieldSubTypeMulti", + " | undefined" + ], + "path": "src/plugins/data_views/common/fields/utils.ts", + "deprecated": false, + "returnComment": [], + "children": [ { "parentPluginId": "dataViews", - "id": "def-common.DataViewSpec.namespaces", - "type": "Array", + "id": "def-common.getFieldSubtypeMulti.$1", + "type": "Object", "tags": [], - "label": "namespaces", + "label": "field", "description": [], "signature": [ - "string[] | undefined" + "{ subType?: ", + "IFieldSubType", + " | undefined; }" ], - "path": "src/plugins/data_views/common/types.ts", + "path": "src/plugins/data_views/common/fields/utils.ts", "deprecated": false } ], @@ -17058,1115 +16165,678 @@ }, { "parentPluginId": "dataViews", - "id": "def-common.DataViewsServicePublicMethods", - "type": "Interface", + "id": "def-common.getFieldSubtypeNested", + "type": "Function", "tags": [], - "label": "DataViewsServicePublicMethods", + "label": "getFieldSubtypeNested", "description": [], - "path": "src/plugins/data_views/common/data_views/data_views.ts", + "signature": [ + "(field: HasSubtype) => ", + "IFieldSubTypeNested", + " | undefined" + ], + "path": "src/plugins/data_views/common/fields/utils.ts", "deprecated": false, + "returnComment": [], "children": [ { "parentPluginId": "dataViews", - "id": "def-common.DataViewsServicePublicMethods.clearCache", - "type": "Function", + "id": "def-common.getFieldSubtypeNested.$1", + "type": "Object", "tags": [], - "label": "clearCache", + "label": "field", "description": [], "signature": [ - "(id?: string | undefined) => void" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewsServicePublicMethods.clearCache.$1", - "type": "string", - "tags": [], - "label": "id", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": false - } + "{ subType?: ", + "IFieldSubType", + " | undefined; }" ], - "returnComment": [] + "path": "src/plugins/data_views/common/fields/utils.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "dataViews", + "id": "def-common.getIndexPatternLoadMeta", + "type": "Function", + "tags": [], + "label": "getIndexPatternLoadMeta", + "description": [], + "signature": [ + "() => Omit<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.IndexPatternLoadExpressionFunctionDefinition", + "text": "IndexPatternLoadExpressionFunctionDefinition" + }, + ", \"fn\">" + ], + "path": "src/plugins/data_views/common/expressions/load_index_pattern.ts", + "deprecated": false, + "children": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "dataViews", + "id": "def-common.isFilterable", + "type": "Function", + "tags": [], + "label": "isFilterable", + "description": [], + "signature": [ + "(field: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewField", + "text": "DataViewField" }, + ") => boolean" + ], + "path": "src/plugins/data_views/common/fields/utils.ts", + "deprecated": false, + "children": [ { "parentPluginId": "dataViews", - "id": "def-common.DataViewsServicePublicMethods.create", - "type": "Function", + "id": "def-common.isFilterable.$1", + "type": "Object", "tags": [], - "label": "create", + "label": "field", "description": [], "signature": [ - "(spec: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" - }, - ", skipFetchFields?: boolean | undefined) => Promise<", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - ">" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewsServicePublicMethods.create.$1", - "type": "Object", - "tags": [], - "label": "spec", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" - } - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewsServicePublicMethods.create.$2", - "type": "CompoundType", - "tags": [], - "label": "skipFetchFields", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": false + "section": "def-common.DataViewField", + "text": "DataViewField" } ], - "returnComment": [] - }, + "path": "src/plugins/data_views/common/fields/utils.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "dataViews", + "id": "def-common.isMultiField", + "type": "Function", + "tags": [], + "label": "isMultiField", + "description": [], + "signature": [ + "(field: HasSubtype) => boolean" + ], + "path": "src/plugins/data_views/common/fields/utils.ts", + "deprecated": false, + "returnComment": [], + "children": [ { "parentPluginId": "dataViews", - "id": "def-common.DataViewsServicePublicMethods.createAndSave", - "type": "Function", + "id": "def-common.isMultiField.$1", + "type": "Object", "tags": [], - "label": "createAndSave", + "label": "field", "description": [], "signature": [ - "(spec: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" - }, - ", override?: boolean | undefined, skipFetchFields?: boolean | undefined) => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - ">" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewsServicePublicMethods.createAndSave.$1", - "type": "Object", - "tags": [], - "label": "spec", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" - } - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewsServicePublicMethods.createAndSave.$2", - "type": "CompoundType", - "tags": [], - "label": "override", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewsServicePublicMethods.createAndSave.$3", - "type": "CompoundType", - "tags": [], - "label": "skipFetchFields", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": false - } + "{ subType?: ", + "IFieldSubType", + " | undefined; }" ], - "returnComment": [] - }, + "path": "src/plugins/data_views/common/fields/utils.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "dataViews", + "id": "def-common.isNestedField", + "type": "Function", + "tags": [], + "label": "isNestedField", + "description": [], + "signature": [ + "(field: HasSubtype) => boolean" + ], + "path": "src/plugins/data_views/common/fields/utils.ts", + "deprecated": false, + "returnComment": [], + "children": [ { "parentPluginId": "dataViews", - "id": "def-common.DataViewsServicePublicMethods.createSavedObject", - "type": "Function", + "id": "def-common.isNestedField.$1", + "type": "Object", "tags": [], - "label": "createSavedObject", + "label": "field", "description": [], "signature": [ - "(indexPattern: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - ", override?: boolean | undefined) => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - ">" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewsServicePublicMethods.createSavedObject.$1", - "type": "Object", - "tags": [], - "label": "indexPattern", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - } - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewsServicePublicMethods.createSavedObject.$2", - "type": "CompoundType", - "tags": [], - "label": "override", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": false - } + "{ subType?: ", + "IFieldSubType", + " | undefined; }" ], - "returnComment": [] - }, + "path": "src/plugins/data_views/common/fields/utils.ts", + "deprecated": false + } + ], + "initialIsOpen": false + } + ], + "interfaces": [ + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewAttributes", + "type": "Interface", + "tags": [], + "label": "DataViewAttributes", + "description": [ + "\nInterface for the data view saved object" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "children": [ { "parentPluginId": "dataViews", - "id": "def-common.DataViewsServicePublicMethods.delete", - "type": "Function", + "id": "def-common.DataViewAttributes.fields", + "type": "string", "tags": [], - "label": "delete", - "description": [], - "signature": [ - "(indexPatternId: string) => Promise<{}>" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewsServicePublicMethods.delete.$1", - "type": "string", - "tags": [], - "label": "indexPatternId", - "description": [], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true - } + "label": "fields", + "description": [ + "\nFields as a serialized array of field specs" ], - "returnComment": [] + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, { "parentPluginId": "dataViews", - "id": "def-common.DataViewsServicePublicMethods.ensureDefaultDataView", - "type": "Function", + "id": "def-common.DataViewAttributes.title", + "type": "string", "tags": [], - "label": "ensureDefaultDataView", - "description": [], - "signature": [ - "() => Promise | undefined" + "label": "title", + "description": [ + "\nData view title" ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "returnComment": [], - "children": [] + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, { "parentPluginId": "dataViews", - "id": "def-common.DataViewsServicePublicMethods.fieldArrayToMap", - "type": "Function", + "id": "def-common.DataViewAttributes.type", + "type": "string", "tags": [], - "label": "fieldArrayToMap", - "description": [], - "signature": [ - "(fields: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - "[], fieldAttrs?: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldAttrs", - "text": "FieldAttrs" - }, - " | undefined) => ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewFieldMap", - "text": "DataViewFieldMap" - } + "label": "type", + "description": [ + "\nData view type, default or rollup" ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewsServicePublicMethods.fieldArrayToMap.$1", - "type": "Array", - "tags": [], - "label": "fields", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - "[]" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewsServicePublicMethods.fieldArrayToMap.$2", - "type": "Object", - "tags": [], - "label": "fieldAttrs", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldAttrs", - "text": "FieldAttrs" - }, - " | undefined" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": false - } + "signature": [ + "string | undefined" ], - "returnComment": [] + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, { "parentPluginId": "dataViews", - "id": "def-common.DataViewsServicePublicMethods.find", - "type": "Function", + "id": "def-common.DataViewAttributes.typeMeta", + "type": "string", "tags": [], - "label": "find", - "description": [], - "signature": [ - "(search: string, size?: number | undefined) => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - "[]>" + "label": "typeMeta", + "description": [ + "\nType metadata information, serialized. Only used by rollup data views." ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewsServicePublicMethods.find.$1", - "type": "string", - "tags": [], - "label": "search", - "description": [], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewsServicePublicMethods.find.$2", - "type": "number", - "tags": [], - "label": "size", - "description": [], - "signature": [ - "number | undefined" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": false - } + "signature": [ + "string | undefined" ], - "returnComment": [] + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, { "parentPluginId": "dataViews", - "id": "def-common.DataViewsServicePublicMethods.get", - "type": "Function", + "id": "def-common.DataViewAttributes.timeFieldName", + "type": "string", "tags": [], - "label": "get", - "description": [], - "signature": [ - "(id: string) => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - ">" + "label": "timeFieldName", + "description": [ + "\nTime field name" ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewsServicePublicMethods.get.$1", - "type": "string", - "tags": [], - "label": "id", - "description": [], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true - } + "signature": [ + "string | undefined" ], - "returnComment": [] + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, { "parentPluginId": "dataViews", - "id": "def-common.DataViewsServicePublicMethods.getCache", - "type": "Function", + "id": "def-common.DataViewAttributes.sourceFilters", + "type": "string", "tags": [], - "label": "getCache", - "description": [], + "label": "sourceFilters", + "description": [ + "\nSerialized array of filters. Used by discover to hide fields." + ], "signature": [ - "() => Promise<", - "SavedObject", - "<", - "IndexPatternSavedObjectAttrs", - ">[] | null | undefined>" + "string | undefined" ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [], - "returnComment": [] + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, { "parentPluginId": "dataViews", - "id": "def-common.DataViewsServicePublicMethods.getCanSave", - "type": "Function", + "id": "def-common.DataViewAttributes.fieldFormatMap", + "type": "string", "tags": [], - "label": "getCanSave", - "description": [], + "label": "fieldFormatMap", + "description": [ + "\nSerialized map of field formats by field name" + ], "signature": [ - "() => Promise" + "string | undefined" ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [], - "returnComment": [] + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, { "parentPluginId": "dataViews", - "id": "def-common.DataViewsServicePublicMethods.getDefault", - "type": "Function", + "id": "def-common.DataViewAttributes.fieldAttrs", + "type": "string", "tags": [], - "label": "getDefault", - "description": [], + "label": "fieldAttrs", + "description": [ + "\nSerialized map of field attributes, currently field count and name" + ], "signature": [ - "() => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - " | null>" + "string | undefined" ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [], - "returnComment": [] + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, { "parentPluginId": "dataViews", - "id": "def-common.DataViewsServicePublicMethods.getDefaultId", - "type": "Function", + "id": "def-common.DataViewAttributes.runtimeFieldMap", + "type": "string", "tags": [], - "label": "getDefaultId", - "description": [], + "label": "runtimeFieldMap", + "description": [ + "\nSerialized map of runtime field definitions, by field name" + ], "signature": [ - "() => Promise" + "string | undefined" ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [], - "returnComment": [] + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, { "parentPluginId": "dataViews", - "id": "def-common.DataViewsServicePublicMethods.getDefaultDataView", - "type": "Function", + "id": "def-common.DataViewAttributes.allowNoIndex", + "type": "CompoundType", "tags": [], - "label": "getDefaultDataView", - "description": [], + "label": "allowNoIndex", + "description": [ + "\nPrevents errors when index pattern exists before indices" + ], "signature": [ - "() => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - " | null>" + "boolean | undefined" ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewListItem", + "type": "Interface", + "tags": [], + "label": "DataViewListItem", + "description": [ + "\nResult from data view search - summary data." + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ { "parentPluginId": "dataViews", - "id": "def-common.DataViewsServicePublicMethods.getFieldsForIndexPattern", - "type": "Function", + "id": "def-common.DataViewListItem.id", + "type": "string", "tags": [], - "label": "getFieldsForIndexPattern", - "description": [], - "signature": [ - "(indexPattern: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - " | ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" - }, - ", options?: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.GetFieldsOptions", - "text": "GetFieldsOptions" - }, - " | undefined) => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - "[]>" + "label": "id", + "description": [ + "\nSaved object id" ], "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewsServicePublicMethods.getFieldsForIndexPattern.$1", - "type": "CompoundType", - "tags": [], - "label": "indexPattern", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - " | ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" - } - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewsServicePublicMethods.getFieldsForIndexPattern.$2", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.GetFieldsOptions", - "text": "GetFieldsOptions" - }, - " | undefined" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": false - } - ], - "returnComment": [] + "deprecated": false }, { "parentPluginId": "dataViews", - "id": "def-common.DataViewsServicePublicMethods.getFieldsForWildcard", - "type": "Function", + "id": "def-common.DataViewListItem.namespaces", + "type": "Array", "tags": [], - "label": "getFieldsForWildcard", - "description": [], + "label": "namespaces", + "description": [ + "\nNamespace ids" + ], "signature": [ - "(options: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.GetFieldsOptions", - "text": "GetFieldsOptions" - }, - ") => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - "[]>" + "string[] | undefined" ], "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewsServicePublicMethods.getFieldsForWildcard.$1", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.GetFieldsOptions", - "text": "GetFieldsOptions" - } - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true - } + "deprecated": false + }, + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewListItem.title", + "type": "string", + "tags": [], + "label": "title", + "description": [ + "\nData view title" ], - "returnComment": [] + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false }, { "parentPluginId": "dataViews", - "id": "def-common.DataViewsServicePublicMethods.getIds", - "type": "Function", + "id": "def-common.DataViewListItem.type", + "type": "string", "tags": [], - "label": "getIds", - "description": [], + "label": "type", + "description": [ + "\nData view type" + ], "signature": [ - "(refresh?: boolean | undefined) => Promise" + "string | undefined" ], "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewsServicePublicMethods.getIds.$1", - "type": "CompoundType", - "tags": [], - "label": "refresh", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": false - } - ], - "returnComment": [] + "deprecated": false }, { "parentPluginId": "dataViews", - "id": "def-common.DataViewsServicePublicMethods.getIdsWithTitle", - "type": "Function", + "id": "def-common.DataViewListItem.typeMeta", + "type": "Object", "tags": [], - "label": "getIdsWithTitle", - "description": [], + "label": "typeMeta", + "description": [ + "\nData view type meta" + ], "signature": [ - "(refresh?: boolean | undefined) => Promise<", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewListItem", - "text": "DataViewListItem" + "section": "def-common.TypeMeta", + "text": "TypeMeta" }, - "[]>" + " | undefined" ], "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewsServicePublicMethods.getIdsWithTitle.$1", - "type": "CompoundType", - "tags": [], - "label": "refresh", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": false - } + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewSpec", + "type": "Interface", + "tags": [], + "label": "DataViewSpec", + "description": [ + "\nStatic data view format\nSerialized data object, representing data view attributes and state" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewSpec.id", + "type": "string", + "tags": [], + "label": "id", + "description": [ + "\nSaved object id" ], - "returnComment": [] + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, { "parentPluginId": "dataViews", - "id": "def-common.DataViewsServicePublicMethods.getTitles", - "type": "Function", + "id": "def-common.DataViewSpec.version", + "type": "string", "tags": [], - "label": "getTitles", - "description": [], + "label": "version", + "description": [ + "\nSaved object version string" + ], "signature": [ - "(refresh?: boolean | undefined) => Promise" + "string | undefined" ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewsServicePublicMethods.getTitles.$1", - "type": "CompoundType", - "tags": [], - "label": "refresh", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": false - } + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false + }, + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewSpec.title", + "type": "string", + "tags": [], + "label": "title", + "description": [ + "\nData view title" ], - "returnComment": [] + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, { "parentPluginId": "dataViews", - "id": "def-common.DataViewsServicePublicMethods.hasUserDataView", - "type": "Function", + "id": "def-common.DataViewSpec.timeFieldName", + "type": "string", "tags": [], - "label": "hasUserDataView", - "description": [], + "label": "timeFieldName", + "description": [ + "\nName of timestamp field" + ], "signature": [ - "() => Promise" + "string | undefined" ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [], - "returnComment": [] + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, { "parentPluginId": "dataViews", - "id": "def-common.DataViewsServicePublicMethods.refreshFields", - "type": "Function", + "id": "def-common.DataViewSpec.sourceFilters", + "type": "Array", "tags": [], - "label": "refreshFields", - "description": [], + "label": "sourceFilters", + "description": [ + "\nList of filters which discover uses to hide fields" + ], "signature": [ - "(indexPattern: ", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" + "section": "def-common.SourceFilter", + "text": "SourceFilter" }, - ") => Promise" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewsServicePublicMethods.refreshFields.$1", - "type": "Object", - "tags": [], - "label": "indexPattern", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - } - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true - } + "[] | undefined" ], - "returnComment": [] + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, { "parentPluginId": "dataViews", - "id": "def-common.DataViewsServicePublicMethods.savedObjectToSpec", - "type": "Function", + "id": "def-common.DataViewSpec.fields", + "type": "Object", "tags": [], - "label": "savedObjectToSpec", - "description": [], + "label": "fields", + "description": [ + "\nMap of fields by name" + ], "signature": [ - "(savedObject: ", - "SavedObject", - "<", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewAttributes", - "text": "DataViewAttributes" + "section": "def-common.DataViewFieldMap", + "text": "DataViewFieldMap" }, - ">) => ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" - } + " | undefined" ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewsServicePublicMethods.savedObjectToSpec.$1", - "type": "Object", - "tags": [], - "label": "savedObject", - "description": [], - "signature": [ - "SavedObject", - "<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewAttributes", - "text": "DataViewAttributes" - }, - ">" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true - } + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false + }, + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewSpec.typeMeta", + "type": "Object", + "tags": [], + "label": "typeMeta", + "description": [ + "\nMetadata about data view, only used by rollup data views" ], - "returnComment": [] + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.TypeMeta", + "text": "TypeMeta" + }, + " | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, { "parentPluginId": "dataViews", - "id": "def-common.DataViewsServicePublicMethods.setDefault", - "type": "Function", + "id": "def-common.DataViewSpec.type", + "type": "string", "tags": [], - "label": "setDefault", - "description": [], + "label": "type", + "description": [ + "\nDefault or rollup" + ], "signature": [ - "(id: string | null, force?: boolean | undefined) => Promise" + "string | undefined" ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [ + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false + }, + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewSpec.fieldFormats", + "type": "Object", + "tags": [], + "label": "fieldFormats", + "description": [ + "\nMap of serialized field formats by field name" + ], + "signature": [ + "Record> | undefined" ], - "returnComment": [] + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, { "parentPluginId": "dataViews", - "id": "def-common.DataViewsServicePublicMethods.updateSavedObject", - "type": "Function", + "id": "def-common.DataViewSpec.runtimeFieldMap", + "type": "Object", "tags": [], - "label": "updateSavedObject", - "description": [], + "label": "runtimeFieldMap", + "description": [ + "\nMap of runtime fields by field name" + ], "signature": [ - "(indexPattern: ", + "Record Promise" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewsServicePublicMethods.updateSavedObject.$1", - "type": "Object", - "tags": [], - "label": "indexPattern", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - } - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewsServicePublicMethods.updateSavedObject.$2", - "type": "number", - "tags": [], - "label": "saveAttempts", - "description": [], - "signature": [ - "number | undefined" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": false + "section": "def-common.RuntimeFieldSpec", + "text": "RuntimeFieldSpec" }, - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewsServicePublicMethods.updateSavedObject.$3", - "type": "CompoundType", - "tags": [], - "label": "ignoreErrors", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": false - } + "> | undefined" ], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.FieldAttrs", - "type": "Interface", - "tags": [ - "intenal" - ], - "label": "FieldAttrs", - "description": [], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "children": [ + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false + }, { "parentPluginId": "dataViews", - "id": "def-common.FieldAttrs.Unnamed", - "type": "IndexSignature", + "id": "def-common.DataViewSpec.fieldAttrs", + "type": "Object", "tags": [], - "label": "[key: string]: FieldAttrSet", - "description": [], + "label": "fieldAttrs", + "description": [ + "\nMap of field attributes by field name, currently customName and count" + ], "signature": [ - "[key: string]: ", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldAttrSet", - "text": "FieldAttrSet" - } + "section": "def-common.FieldAttrs", + "text": "FieldAttrs" + }, + " | undefined" ], "path": "src/plugins/data_views/common/types.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.FieldAttrSet", - "type": "Interface", - "tags": [], - "label": "FieldAttrSet", - "description": [], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "dataViews", - "id": "def-common.FieldAttrSet.customLabel", - "type": "string", + "id": "def-common.DataViewSpec.allowNoIndex", + "type": "CompoundType", "tags": [], - "label": "customLabel", - "description": [], + "label": "allowNoIndex", + "description": [ + "\nDetermines whether failure to load field list should be reported as error" + ], "signature": [ - "string | undefined" + "boolean | undefined" ], "path": "src/plugins/data_views/common/types.ts", "deprecated": false }, { "parentPluginId": "dataViews", - "id": "def-common.FieldAttrSet.count", - "type": "number", + "id": "def-common.DataViewSpec.namespaces", + "type": "Array", "tags": [], - "label": "count", - "description": [], + "label": "namespaces", + "description": [ + "\nArray of namespace ids" + ], "signature": [ - "number | undefined" + "string[] | undefined" ], "path": "src/plugins/data_views/common/types.ts", "deprecated": false @@ -18176,69 +16846,150 @@ }, { "parentPluginId": "dataViews", - "id": "def-common.FieldSpec", + "id": "def-common.DataViewsServiceDeps", "type": "Interface", "tags": [], - "label": "FieldSpec", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - " extends ", - "DataViewFieldBase" + "label": "DataViewsServiceDeps", + "description": [ + "\nData views API service dependencies" ], - "path": "src/plugins/data_views/common/types.ts", + "path": "src/plugins/data_views/common/data_views/data_views.ts", "deprecated": false, "children": [ { "parentPluginId": "dataViews", - "id": "def-common.FieldSpec.count", - "type": "number", + "id": "def-common.DataViewsServiceDeps.uiSettings", + "type": "Object", + "tags": [], + "label": "uiSettings", + "description": [ + "\nUiSettings service instance wrapped in a common interface" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.UiSettingsCommon", + "text": "UiSettingsCommon" + } + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false + }, + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsServiceDeps.savedObjectsClient", + "type": "Object", "tags": [], - "label": "count", + "label": "savedObjectsClient", "description": [ - "\nPopularity count is used by discover" + "\nSaved objects client interface wrapped in a common interface" ], "signature": [ - "number | undefined" + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.SavedObjectsClientCommon", + "text": "SavedObjectsClientCommon" + } ], - "path": "src/plugins/data_views/common/types.ts", + "path": "src/plugins/data_views/common/data_views/data_views.ts", "deprecated": false }, { "parentPluginId": "dataViews", - "id": "def-common.FieldSpec.conflictDescriptions", + "id": "def-common.DataViewsServiceDeps.apiClient", "type": "Object", "tags": [], - "label": "conflictDescriptions", - "description": [], + "label": "apiClient", + "description": [ + "\nWrapper around http call functionality so it can be used on client or server" + ], "signature": [ - "Record | undefined" + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.IDataViewsApiClient", + "text": "IDataViewsApiClient" + } ], - "path": "src/plugins/data_views/common/types.ts", + "path": "src/plugins/data_views/common/data_views/data_views.ts", "deprecated": false }, { "parentPluginId": "dataViews", - "id": "def-common.FieldSpec.format", + "id": "def-common.DataViewsServiceDeps.fieldFormats", "type": "Object", "tags": [], - "label": "format", - "description": [], + "label": "fieldFormats", + "description": [ + "\nField formats service" + ], "signature": [ + "{ deserialize: ", { "pluginId": "fieldFormats", "scope": "common", "docId": "kibFieldFormatsPluginApi", - "section": "def-common.SerializedFieldFormat", - "text": "SerializedFieldFormat" + "section": "def-common.FormatFactory", + "text": "FormatFactory" }, - "<", + "; getDefaultConfig: (fieldType: ", + "KBN_FIELD_TYPES", + ", esTypes?: ", + "ES_FIELD_TYPES", + "[] | undefined) => ", + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.FieldFormatConfig", + "text": "FieldFormatConfig" + }, + "; getType: (formatId: string) => ", + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.FieldFormatInstanceType", + "text": "FieldFormatInstanceType" + }, + " | undefined; getTypeWithoutMetaParams: (formatId: string) => ", + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.FieldFormatInstanceType", + "text": "FieldFormatInstanceType" + }, + " | undefined; getDefaultType: (fieldType: ", + "KBN_FIELD_TYPES", + ", esTypes?: ", + "ES_FIELD_TYPES", + "[] | undefined) => ", + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.FieldFormatInstanceType", + "text": "FieldFormatInstanceType" + }, + " | undefined; getTypeNameByEsTypes: (esTypes: ", + "ES_FIELD_TYPES", + "[] | undefined) => ", + "ES_FIELD_TYPES", + " | undefined; getDefaultTypeName: (fieldType: ", + "KBN_FIELD_TYPES", + ", esTypes?: ", + "ES_FIELD_TYPES", + "[] | undefined) => ", + "ES_FIELD_TYPES", + " | ", + "KBN_FIELD_TYPES", + "; getInstance: (formatId: string, params?: ", { "pluginId": "fieldFormats", "scope": "common", @@ -18246,636 +16997,939 @@ "section": "def-common.FieldFormatParams", "text": "FieldFormatParams" }, - "> | undefined" + ") => ", + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.FieldFormat", + "text": "FieldFormat" + }, + "; getDefaultInstancePlain: (fieldType: ", + "KBN_FIELD_TYPES", + ", esTypes?: ", + "ES_FIELD_TYPES", + "[] | undefined, params?: ", + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.FieldFormatParams", + "text": "FieldFormatParams" + }, + ") => ", + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.FieldFormat", + "text": "FieldFormat" + }, + "; getDefaultInstanceCacheResolver: (fieldType: ", + "KBN_FIELD_TYPES", + ", esTypes?: ", + "ES_FIELD_TYPES", + "[] | undefined) => string; getByFieldType: (fieldType: ", + "KBN_FIELD_TYPES", + ") => ", + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.FieldFormatInstanceType", + "text": "FieldFormatInstanceType" + }, + "[]; getDefaultInstance: (fieldType: ", + "KBN_FIELD_TYPES", + ", esTypes?: ", + "ES_FIELD_TYPES", + "[] | undefined, params?: ", + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.FieldFormatParams", + "text": "FieldFormatParams" + }, + ") => ", + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.FieldFormat", + "text": "FieldFormat" + }, + "; parseDefaultTypeMap: (value: Record) => void; has: (id: string) => boolean; }" ], - "path": "src/plugins/data_views/common/types.ts", + "path": "src/plugins/data_views/common/data_views/data_views.ts", "deprecated": false }, { "parentPluginId": "dataViews", - "id": "def-common.FieldSpec.esTypes", - "type": "Array", + "id": "def-common.DataViewsServiceDeps.onNotification", + "type": "Function", "tags": [], - "label": "esTypes", - "description": [], - "signature": [ - "string[] | undefined" + "label": "onNotification", + "description": [ + "\nHander for service notifications" ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.FieldSpec.searchable", - "type": "boolean", - "tags": [], - "label": "searchable", - "description": [], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.FieldSpec.aggregatable", - "type": "boolean", - "tags": [], - "label": "aggregatable", - "description": [], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.FieldSpec.readFromDocValues", - "type": "CompoundType", - "tags": [], - "label": "readFromDocValues", - "description": [], "signature": [ - "boolean | undefined" + "(toastInputFields: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInputFields", + "text": "ToastInputFields" + }, + ", key: string) => void" ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsServiceDeps.onNotification.$1", + "type": "CompoundType", + "tags": [], + "label": "toastInputFields", + "description": [], + "signature": [ + "Pick<", + "Toast", + ", \"children\" | \"color\" | \"className\" | \"onChange\" | \"onKeyDown\" | \"onClick\" | \"security\" | \"defaultValue\" | \"hidden\" | \"lang\" | \"onError\" | \"defaultChecked\" | \"suppressContentEditableWarning\" | \"suppressHydrationWarning\" | \"accessKey\" | \"contentEditable\" | \"contextMenu\" | \"dir\" | \"draggable\" | \"placeholder\" | \"slot\" | \"spellCheck\" | \"style\" | \"tabIndex\" | \"translate\" | \"radioGroup\" | \"role\" | \"about\" | \"datatype\" | \"inlist\" | \"prefix\" | \"property\" | \"resource\" | \"typeof\" | \"vocab\" | \"autoCapitalize\" | \"autoCorrect\" | \"autoSave\" | \"itemProp\" | \"itemScope\" | \"itemType\" | \"itemID\" | \"itemRef\" | \"results\" | \"unselectable\" | \"inputMode\" | \"is\" | \"aria-activedescendant\" | \"aria-atomic\" | \"aria-autocomplete\" | \"aria-busy\" | \"aria-checked\" | \"aria-colcount\" | \"aria-colindex\" | \"aria-colspan\" | \"aria-controls\" | \"aria-current\" | \"aria-describedby\" | \"aria-details\" | \"aria-disabled\" | \"aria-dropeffect\" | \"aria-errormessage\" | \"aria-expanded\" | \"aria-flowto\" | \"aria-grabbed\" | \"aria-haspopup\" | \"aria-hidden\" | \"aria-invalid\" | \"aria-keyshortcuts\" | \"aria-label\" | \"aria-labelledby\" | \"aria-level\" | \"aria-live\" | \"aria-modal\" | \"aria-multiline\" | \"aria-multiselectable\" | \"aria-orientation\" | \"aria-owns\" | \"aria-placeholder\" | \"aria-posinset\" | \"aria-pressed\" | \"aria-readonly\" | \"aria-relevant\" | \"aria-required\" | \"aria-roledescription\" | \"aria-rowcount\" | \"aria-rowindex\" | \"aria-rowspan\" | \"aria-selected\" | \"aria-setsize\" | \"aria-sort\" | \"aria-valuemax\" | \"aria-valuemin\" | \"aria-valuenow\" | \"aria-valuetext\" | \"dangerouslySetInnerHTML\" | \"onCopy\" | \"onCopyCapture\" | \"onCut\" | \"onCutCapture\" | \"onPaste\" | \"onPasteCapture\" | \"onCompositionEnd\" | \"onCompositionEndCapture\" | \"onCompositionStart\" | \"onCompositionStartCapture\" | \"onCompositionUpdate\" | \"onCompositionUpdateCapture\" | \"onFocus\" | \"onFocusCapture\" | \"onBlur\" | \"onBlurCapture\" | \"onChangeCapture\" | \"onBeforeInput\" | \"onBeforeInputCapture\" | \"onInput\" | \"onInputCapture\" | \"onReset\" | \"onResetCapture\" | \"onSubmit\" | \"onSubmitCapture\" | \"onInvalid\" | \"onInvalidCapture\" | \"onLoad\" | \"onLoadCapture\" | \"onErrorCapture\" | \"onKeyDownCapture\" | \"onKeyPress\" | \"onKeyPressCapture\" | \"onKeyUp\" | \"onKeyUpCapture\" | \"onAbort\" | \"onAbortCapture\" | \"onCanPlay\" | \"onCanPlayCapture\" | \"onCanPlayThrough\" | \"onCanPlayThroughCapture\" | \"onDurationChange\" | \"onDurationChangeCapture\" | \"onEmptied\" | \"onEmptiedCapture\" | \"onEncrypted\" | \"onEncryptedCapture\" | \"onEnded\" | \"onEndedCapture\" | \"onLoadedData\" | \"onLoadedDataCapture\" | \"onLoadedMetadata\" | \"onLoadedMetadataCapture\" | \"onLoadStart\" | \"onLoadStartCapture\" | \"onPause\" | \"onPauseCapture\" | \"onPlay\" | \"onPlayCapture\" | \"onPlaying\" | \"onPlayingCapture\" | \"onProgress\" | \"onProgressCapture\" | \"onRateChange\" | \"onRateChangeCapture\" | \"onSeeked\" | \"onSeekedCapture\" | \"onSeeking\" | \"onSeekingCapture\" | \"onStalled\" | \"onStalledCapture\" | \"onSuspend\" | \"onSuspendCapture\" | \"onTimeUpdate\" | \"onTimeUpdateCapture\" | \"onVolumeChange\" | \"onVolumeChangeCapture\" | \"onWaiting\" | \"onWaitingCapture\" | \"onAuxClick\" | \"onAuxClickCapture\" | \"onClickCapture\" | \"onContextMenu\" | \"onContextMenuCapture\" | \"onDoubleClick\" | \"onDoubleClickCapture\" | \"onDrag\" | \"onDragCapture\" | \"onDragEnd\" | \"onDragEndCapture\" | \"onDragEnter\" | \"onDragEnterCapture\" | \"onDragExit\" | \"onDragExitCapture\" | \"onDragLeave\" | \"onDragLeaveCapture\" | \"onDragOver\" | \"onDragOverCapture\" | \"onDragStart\" | \"onDragStartCapture\" | \"onDrop\" | \"onDropCapture\" | \"onMouseDown\" | \"onMouseDownCapture\" | \"onMouseEnter\" | \"onMouseLeave\" | \"onMouseMove\" | \"onMouseMoveCapture\" | \"onMouseOut\" | \"onMouseOutCapture\" | \"onMouseOver\" | \"onMouseOverCapture\" | \"onMouseUp\" | \"onMouseUpCapture\" | \"onSelect\" | \"onSelectCapture\" | \"onTouchCancel\" | \"onTouchCancelCapture\" | \"onTouchEnd\" | \"onTouchEndCapture\" | \"onTouchMove\" | \"onTouchMoveCapture\" | \"onTouchStart\" | \"onTouchStartCapture\" | \"onPointerDown\" | \"onPointerDownCapture\" | \"onPointerMove\" | \"onPointerMoveCapture\" | \"onPointerUp\" | \"onPointerUpCapture\" | \"onPointerCancel\" | \"onPointerCancelCapture\" | \"onPointerEnter\" | \"onPointerEnterCapture\" | \"onPointerLeave\" | \"onPointerLeaveCapture\" | \"onPointerOver\" | \"onPointerOverCapture\" | \"onPointerOut\" | \"onPointerOutCapture\" | \"onGotPointerCapture\" | \"onGotPointerCaptureCapture\" | \"onLostPointerCapture\" | \"onLostPointerCaptureCapture\" | \"onScroll\" | \"onScrollCapture\" | \"onWheel\" | \"onWheelCapture\" | \"onAnimationStart\" | \"onAnimationStartCapture\" | \"onAnimationEnd\" | \"onAnimationEndCapture\" | \"onAnimationIteration\" | \"onAnimationIterationCapture\" | \"onTransitionEnd\" | \"onTransitionEndCapture\" | \"toastLifeTimeMs\" | \"iconType\" | \"onClose\" | \"data-test-subj\"> & { title?: string | ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.MountPoint", + "text": "MountPoint" + }, + " | undefined; text?: string | ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.MountPoint", + "text": "MountPoint" + }, + " | undefined; }" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false + }, + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsServiceDeps.onNotification.$2", + "type": "string", + "tags": [], + "label": "key", + "description": [], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false + } + ] }, { "parentPluginId": "dataViews", - "id": "def-common.FieldSpec.indexed", - "type": "CompoundType", + "id": "def-common.DataViewsServiceDeps.onError", + "type": "Function", "tags": [], - "label": "indexed", - "description": [], - "signature": [ - "boolean | undefined" + "label": "onError", + "description": [ + "\nHandler for service errors" ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.FieldSpec.customLabel", - "type": "string", - "tags": [], - "label": "customLabel", - "description": [], "signature": [ - "string | undefined" + "(error: Error, toastInputFields: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ErrorToastOptions", + "text": "ErrorToastOptions" + }, + ", key: string) => void" ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.FieldSpec.runtimeField", - "type": "Object", - "tags": [], - "label": "runtimeField", - "description": [], - "signature": [ + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "returnComment": [], + "children": [ { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.RuntimeFieldSpec", - "text": "RuntimeFieldSpec" + "parentPluginId": "dataViews", + "id": "def-common.DataViewsServiceDeps.onError.$1", + "type": "Object", + "tags": [], + "label": "error", + "description": [], + "signature": [ + "Error" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false + }, + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsServiceDeps.onError.$2", + "type": "Object", + "tags": [], + "label": "toastInputFields", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ErrorToastOptions", + "text": "ErrorToastOptions" + } + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, - " | undefined" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsServiceDeps.onError.$3", + "type": "string", + "tags": [], + "label": "key", + "description": [], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false + } + ] }, { "parentPluginId": "dataViews", - "id": "def-common.FieldSpec.shortDotsEnable", - "type": "CompoundType", + "id": "def-common.DataViewsServiceDeps.onRedirectNoIndexPattern", + "type": "Function", "tags": [], - "label": "shortDotsEnable", - "description": [], + "label": "onRedirectNoIndexPattern", + "description": [ + "\nRedirects when there's no data view. only used on client" + ], "signature": [ - "boolean | undefined" + "(() => void) | undefined" ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "dataViews", - "id": "def-common.FieldSpec.isMapped", - "type": "CompoundType", + "id": "def-common.DataViewsServiceDeps.getCanSave", + "type": "Function", "tags": [], - "label": "isMapped", - "description": [], + "label": "getCanSave", + "description": [ + "\nDetermines whether the user can save data views" + ], "signature": [ - "boolean | undefined" + "() => Promise" ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [], + "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "dataViews", - "id": "def-common.FieldSpecExportFmt", + "id": "def-common.DataViewsServicePublicMethods", "type": "Interface", "tags": [], - "label": "FieldSpecExportFmt", - "description": [], - "path": "src/plugins/data_views/common/types.ts", + "label": "DataViewsServicePublicMethods", + "description": [ + "\nData views API service methods" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", "deprecated": false, "children": [ { "parentPluginId": "dataViews", - "id": "def-common.FieldSpecExportFmt.count", - "type": "number", + "id": "def-common.DataViewsServicePublicMethods.clearCache", + "type": "Function", "tags": [], - "label": "count", - "description": [], - "signature": [ - "number | undefined" + "label": "clearCache", + "description": [ + "\nClear the cache of data views." ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.FieldSpecExportFmt.script", - "type": "string", - "tags": [], - "label": "script", - "description": [], "signature": [ - "string | undefined" + "(id?: string | undefined) => void" ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.FieldSpecExportFmt.lang", - "type": "string", - "tags": [], - "label": "lang", - "description": [], - "signature": [ - "string | undefined" + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsServicePublicMethods.clearCache.$1", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": false + } ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false + "returnComment": [] }, { "parentPluginId": "dataViews", - "id": "def-common.FieldSpecExportFmt.conflictDescriptions", - "type": "Object", + "id": "def-common.DataViewsServicePublicMethods.create", + "type": "Function", "tags": [], - "label": "conflictDescriptions", - "description": [], + "label": "create", + "description": [ + "\nCreate data view based on the provided spec." + ], "signature": [ + "(spec: ", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpecConflictDescriptions", - "text": "FieldSpecConflictDescriptions" + "section": "def-common.DataViewSpec", + "text": "DataViewSpec" }, - " | undefined" + ", skipFetchFields?: boolean | undefined) => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + ">" ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.FieldSpecExportFmt.name", - "type": "string", - "tags": [], - "label": "name", - "description": [], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsServicePublicMethods.create.$1", + "type": "Object", + "tags": [], + "label": "spec", + "description": [ + "- Data view spec." + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewSpec", + "text": "DataViewSpec" + } + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsServicePublicMethods.create.$2", + "type": "CompoundType", + "tags": [], + "label": "skipFetchFields", + "description": [ + "- If true, do not fetch fields." + ], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] }, { "parentPluginId": "dataViews", - "id": "def-common.FieldSpecExportFmt.type", - "type": "Enum", + "id": "def-common.DataViewsServicePublicMethods.createAndSave", + "type": "Function", "tags": [], - "label": "type", - "description": [], + "label": "createAndSave", + "description": [ + "\nCreate and save data view based on provided spec." + ], "signature": [ - "KBN_FIELD_TYPES" + "(spec: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewSpec", + "text": "DataViewSpec" + }, + ", override?: boolean | undefined, skipFetchFields?: boolean | undefined) => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + ">" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsServicePublicMethods.createAndSave.$1", + "type": "Object", + "tags": [], + "label": "spec", + "description": [ + "- Data view spec." + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewSpec", + "text": "DataViewSpec" + } + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsServicePublicMethods.createAndSave.$2", + "type": "CompoundType", + "tags": [], + "label": "override", + "description": [ + "- If true, save over existing data view" + ], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": false + }, + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsServicePublicMethods.createAndSave.$3", + "type": "CompoundType", + "tags": [], + "label": "skipFetchFields", + "description": [ + "- If true, do not fetch fields." + ], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": false + } ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false + "returnComment": [] }, { "parentPluginId": "dataViews", - "id": "def-common.FieldSpecExportFmt.esTypes", - "type": "Array", + "id": "def-common.DataViewsServicePublicMethods.createSavedObject", + "type": "Function", "tags": [], - "label": "esTypes", - "description": [], - "signature": [ - "string[] | undefined" + "label": "createSavedObject", + "description": [ + "\nSave data view" ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.FieldSpecExportFmt.scripted", - "type": "boolean", - "tags": [], - "label": "scripted", - "description": [], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.FieldSpecExportFmt.searchable", - "type": "boolean", - "tags": [], - "label": "searchable", - "description": [], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.FieldSpecExportFmt.aggregatable", - "type": "boolean", - "tags": [], - "label": "aggregatable", - "description": [], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.FieldSpecExportFmt.readFromDocValues", - "type": "CompoundType", - "tags": [], - "label": "readFromDocValues", - "description": [], "signature": [ - "boolean | undefined" + "(indexPattern: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + ", override?: boolean | undefined) => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + ">" ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsServicePublicMethods.createSavedObject.$1", + "type": "Object", + "tags": [], + "label": "indexPattern", + "description": [], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + } + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsServicePublicMethods.createSavedObject.$2", + "type": "CompoundType", + "tags": [], + "label": "override", + "description": [ + "- If true, save over existing data view" + ], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] }, { "parentPluginId": "dataViews", - "id": "def-common.FieldSpecExportFmt.subType", - "type": "CompoundType", + "id": "def-common.DataViewsServicePublicMethods.delete", + "type": "Function", "tags": [], - "label": "subType", - "description": [], + "label": "delete", + "description": [ + "\nDelete data view" + ], "signature": [ - "IFieldSubType", - " | undefined" + "(indexPatternId: string) => Promise<{}>" ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsServicePublicMethods.delete.$1", + "type": "string", + "tags": [], + "label": "indexPatternId", + "description": [ + "- Id of the data view to delete." + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "dataViews", - "id": "def-common.FieldSpecExportFmt.format", - "type": "Object", - "tags": [], - "label": "format", - "description": [], + "id": "def-common.DataViewsServicePublicMethods.fieldArrayToMap", + "type": "Function", + "tags": [ + "params" + ], + "label": "fieldArrayToMap", + "description": [ + "\nTakes field array and field attributes and returns field map by name." + ], "signature": [ + "(fields: ", { - "pluginId": "fieldFormats", + "pluginId": "dataViews", "scope": "common", - "docId": "kibFieldFormatsPluginApi", - "section": "def-common.SerializedFieldFormat", - "text": "SerializedFieldFormat" + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" }, - "<", + "[], fieldAttrs?: ", { - "pluginId": "fieldFormats", + "pluginId": "dataViews", "scope": "common", - "docId": "kibFieldFormatsPluginApi", - "section": "def-common.FieldFormatParams", - "text": "FieldFormatParams" + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldAttrs", + "text": "FieldAttrs" }, - "> | undefined" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.FieldSpecExportFmt.indexed", - "type": "CompoundType", - "tags": [], - "label": "indexed", - "description": [], - "signature": [ - "boolean | undefined" + " | undefined) => ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewFieldMap", + "text": "DataViewFieldMap" + } ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.GetFieldsOptions", - "type": "Interface", - "tags": [], - "label": "GetFieldsOptions", - "description": [], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.GetFieldsOptions.pattern", - "type": "string", - "tags": [], - "label": "pattern", - "description": [], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.GetFieldsOptions.type", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "string | undefined" + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsServicePublicMethods.fieldArrayToMap.$1", + "type": "Array", + "tags": [], + "label": "fields", + "description": [ + "- Array of fieldspecs" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + "[]" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsServicePublicMethods.fieldArrayToMap.$2", + "type": "Object", + "tags": [], + "label": "fieldAttrs", + "description": [], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldAttrs", + "text": "FieldAttrs" + }, + " | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": false + } ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false + "returnComment": [ + "Field map by name" + ] }, { "parentPluginId": "dataViews", - "id": "def-common.GetFieldsOptions.lookBack", - "type": "CompoundType", + "id": "def-common.DataViewsServicePublicMethods.find", + "type": "Function", "tags": [], - "label": "lookBack", - "description": [], - "signature": [ - "boolean | undefined" + "label": "find", + "description": [ + "\nSearch for data views based on title" ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.GetFieldsOptions.metaFields", - "type": "Array", - "tags": [], - "label": "metaFields", - "description": [], "signature": [ - "string[] | undefined" + "(search: string, size?: number | undefined) => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + "[]>" ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.GetFieldsOptions.rollupIndex", - "type": "string", - "tags": [], - "label": "rollupIndex", - "description": [], - "signature": [ - "string | undefined" + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsServicePublicMethods.find.$1", + "type": "string", + "tags": [], + "label": "search", + "description": [ + "- Search string" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsServicePublicMethods.find.$2", + "type": "number", + "tags": [], + "label": "size", + "description": [ + "- Number of results to return" + ], + "signature": [ + "number | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": false + } ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false + "returnComment": [] }, { "parentPluginId": "dataViews", - "id": "def-common.GetFieldsOptions.allowNoIndex", - "type": "CompoundType", + "id": "def-common.DataViewsServicePublicMethods.get", + "type": "Function", "tags": [], - "label": "allowNoIndex", - "description": [], + "label": "get", + "description": [ + "\nGet data view by id." + ], "signature": [ - "boolean | undefined" + "(id: string) => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + ">" ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsServicePublicMethods.get.$1", + "type": "string", + "tags": [], + "label": "id", + "description": [ + "- Id of the data view to get." + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "dataViews", - "id": "def-common.GetFieldsOptions.filter", - "type": "Object", + "id": "def-common.DataViewsServicePublicMethods.getCache", + "type": "Function", "tags": [], - "label": "filter", - "description": [], + "label": "getCache", + "description": [ + "\nGet populated data view saved object cache." + ], "signature": [ - "QueryDslQueryContainer", - " | undefined" + "() => Promise<", + "SavedObject", + "<", + "DataViewSavedObjectAttrs", + ">[] | null | undefined>" ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.GetFieldsOptionsTimePattern", - "type": "Interface", - "tags": [], - "label": "GetFieldsOptionsTimePattern", - "description": [], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.GetFieldsOptionsTimePattern.pattern", - "type": "string", - "tags": [], - "label": "pattern", - "description": [], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "dataViews", - "id": "def-common.GetFieldsOptionsTimePattern.metaFields", - "type": "Array", + "id": "def-common.DataViewsServicePublicMethods.getCanSave", + "type": "Function", "tags": [], - "label": "metaFields", - "description": [], + "label": "getCanSave", + "description": [ + "\nIf user can save data view, return true." + ], "signature": [ - "string[]" + "() => Promise" ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.GetFieldsOptionsTimePattern.lookBack", - "type": "number", - "tags": [], - "label": "lookBack", - "description": [], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "dataViews", - "id": "def-common.GetFieldsOptionsTimePattern.interval", - "type": "string", - "tags": [], - "label": "interval", - "description": [], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.HasDataService", - "type": "Interface", - "tags": [], - "label": "HasDataService", - "description": [], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.HasDataService.hasESData", + "id": "def-common.DataViewsServicePublicMethods.getDefault", "type": "Function", "tags": [], - "label": "hasESData", - "description": [], + "label": "getDefault", + "description": [ + "\nGet default data view as data view instance." + ], "signature": [ - "() => Promise" + "() => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + " | null>" ], - "path": "src/plugins/data_views/common/types.ts", + "path": "src/plugins/data_views/common/data_views/data_views.ts", "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "dataViews", - "id": "def-common.HasDataService.hasUserDataView", + "id": "def-common.DataViewsServicePublicMethods.getDefaultId", "type": "Function", "tags": [], - "label": "hasUserDataView", - "description": [], + "label": "getDefaultId", + "description": [ + "\nGet default data view id." + ], "signature": [ - "() => Promise" + "() => Promise" ], - "path": "src/plugins/data_views/common/types.ts", + "path": "src/plugins/data_views/common/data_views/data_views.ts", "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "dataViews", - "id": "def-common.HasDataService.hasDataView", + "id": "def-common.DataViewsServicePublicMethods.getDefaultDataView", "type": "Function", "tags": [], - "label": "hasDataView", - "description": [], + "label": "getDefaultDataView", + "description": [ + "\nGet default data view, if it doesn't exist, choose and save new default data view and return it." + ], "signature": [ - "() => Promise" + "() => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + " | null>" ], - "path": "src/plugins/data_views/common/types.ts", + "path": "src/plugins/data_views/common/data_views/data_views.ts", "deprecated": false, "children": [], "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.IDataViewsApiClient", - "type": "Interface", - "tags": [], - "label": "IDataViewsApiClient", - "description": [], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "dataViews", - "id": "def-common.IDataViewsApiClient.getFieldsForTimePattern", + "id": "def-common.DataViewsServicePublicMethods.getFieldsForIndexPattern", "type": "Function", "tags": [], - "label": "getFieldsForTimePattern", - "description": [], + "label": "getFieldsForIndexPattern", + "description": [ + "\nGet fields for data view" + ], "signature": [ - "(options: ", + "(indexPattern: ", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.GetFieldsOptionsTimePattern", - "text": "GetFieldsOptionsTimePattern" + "section": "def-common.DataView", + "text": "DataView" }, - ") => Promise" + " | ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewSpec", + "text": "DataViewSpec" + }, + ", options?: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.GetFieldsOptions", + "text": "GetFieldsOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + "[]>" ], - "path": "src/plugins/data_views/common/types.ts", + "path": "src/plugins/data_views/common/data_views/data_views.ts", "deprecated": false, "children": [ { "parentPluginId": "dataViews", - "id": "def-common.IDataViewsApiClient.getFieldsForTimePattern.$1", - "type": "Object", + "id": "def-common.DataViewsServicePublicMethods.getFieldsForIndexPattern.$1", + "type": "CompoundType", "tags": [], - "label": "options", + "label": "indexPattern", "description": [], "signature": [ { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.GetFieldsOptionsTimePattern", - "text": "GetFieldsOptionsTimePattern" + "section": "def-common.DataView", + "text": "DataView" + }, + " | ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewSpec", + "text": "DataViewSpec" } ], - "path": "src/plugins/data_views/common/types.ts", + "path": "src/plugins/data_views/common/data_views/data_views.ts", "deprecated": false, "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "dataViews", - "id": "def-common.IDataViewsApiClient.getFieldsForWildcard", - "type": "Function", - "tags": [], - "label": "getFieldsForWildcard", - "description": [], - "signature": [ - "(options: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.GetFieldsOptions", - "text": "GetFieldsOptions" }, - ") => Promise" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "children": [ { "parentPluginId": "dataViews", - "id": "def-common.IDataViewsApiClient.getFieldsForWildcard.$1", + "id": "def-common.DataViewsServicePublicMethods.getFieldsForIndexPattern.$2", "type": "Object", "tags": [], "label": "options", - "description": [], + "description": [ + "- Options for getting fields" + ], "signature": [ { "pluginId": "dataViews", @@ -18883,411 +17937,435 @@ "docId": "kibDataViewsPluginApi", "section": "def-common.GetFieldsOptions", "text": "GetFieldsOptions" - } + }, + " | undefined" ], - "path": "src/plugins/data_views/common/types.ts", + "path": "src/plugins/data_views/common/data_views/data_views.ts", "deprecated": false, - "isRequired": true + "isRequired": false } ], - "returnComment": [] + "returnComment": [ + "FieldSpec array" + ] }, { "parentPluginId": "dataViews", - "id": "def-common.IDataViewsApiClient.hasUserIndexPattern", + "id": "def-common.DataViewsServicePublicMethods.getFieldsForWildcard", "type": "Function", "tags": [], - "label": "hasUserIndexPattern", - "description": [], + "label": "getFieldsForWildcard", + "description": [ + "\nGet fields for index pattern string" + ], "signature": [ - "() => Promise" + "(options: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.GetFieldsOptions", + "text": "GetFieldsOptions" + }, + ") => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + "[]>" ], - "path": "src/plugins/data_views/common/types.ts", + "path": "src/plugins/data_views/common/data_views/data_views.ts", "deprecated": false, - "children": [], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.IFieldType", - "type": "Interface", - "tags": [ - "deprecated" - ], - "label": "IFieldType", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" - }, - " extends ", - "DataViewFieldBase" - ], - "path": "src/plugins/data_views/common/fields/types.ts", - "deprecated": true, - "removeBy": "8.2", - "references": [ - { - "plugin": "data", - "path": "src/plugins/data/common/index.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/query/filter_manager/lib/generate_filters.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/query/filter_manager/lib/generate_filters.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/query/filter_manager/lib/generate_filters.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/query/filter_manager/lib/generate_filters.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/index.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/actions/filters/create_filters_from_range_select.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/actions/filters/create_filters_from_range_select.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.tsx" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/query/timefilter/lib/extract_time_filter.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/query/timefilter/lib/extract_time_filter.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/query/timefilter/lib/extract_time_filter.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/query/timefilter/lib/extract_time_filter.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/query/filter_manager/lib/mappers/map_exists.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/query/filter_manager/lib/mappers/map_exists.test.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts" - } - ], - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.IFieldType.count", - "type": "number", - "tags": [], - "label": "count", - "description": [], - "signature": [ - "number | undefined" + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsServicePublicMethods.getFieldsForWildcard.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [ + "- options for getting fields" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.GetFieldsOptions", + "text": "GetFieldsOptions" + } + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } ], - "path": "src/plugins/data_views/common/fields/types.ts", - "deprecated": false + "returnComment": [] }, { "parentPluginId": "dataViews", - "id": "def-common.IFieldType.esTypes", - "type": "Array", + "id": "def-common.DataViewsServicePublicMethods.getIds", + "type": "Function", "tags": [], - "label": "esTypes", - "description": [], - "signature": [ - "string[] | undefined" + "label": "getIds", + "description": [ + "\nGet list of data view ids." ], - "path": "src/plugins/data_views/common/fields/types.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.IFieldType.aggregatable", - "type": "CompoundType", - "tags": [], - "label": "aggregatable", - "description": [], "signature": [ - "boolean | undefined" + "(refresh?: boolean | undefined) => Promise" ], - "path": "src/plugins/data_views/common/fields/types.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.IFieldType.filterable", - "type": "CompoundType", - "tags": [], - "label": "filterable", - "description": [], - "signature": [ - "boolean | undefined" + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsServicePublicMethods.getIds.$1", + "type": "CompoundType", + "tags": [], + "label": "refresh", + "description": [ + "- clear cache and fetch from server" + ], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": false + } ], - "path": "src/plugins/data_views/common/fields/types.ts", - "deprecated": false + "returnComment": [] }, { "parentPluginId": "dataViews", - "id": "def-common.IFieldType.searchable", - "type": "CompoundType", + "id": "def-common.DataViewsServicePublicMethods.getIdsWithTitle", + "type": "Function", "tags": [], - "label": "searchable", - "description": [], - "signature": [ - "boolean | undefined" + "label": "getIdsWithTitle", + "description": [ + "\nGet list of data view ids and title (and more) for each data view." ], - "path": "src/plugins/data_views/common/fields/types.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.IFieldType.sortable", - "type": "CompoundType", - "tags": [], - "label": "sortable", - "description": [], "signature": [ - "boolean | undefined" + "(refresh?: boolean | undefined) => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewListItem", + "text": "DataViewListItem" + }, + "[]>" ], - "path": "src/plugins/data_views/common/fields/types.ts", - "deprecated": false + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsServicePublicMethods.getIdsWithTitle.$1", + "type": "CompoundType", + "tags": [], + "label": "refresh", + "description": [ + "- clear cache and fetch from server" + ], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] }, { "parentPluginId": "dataViews", - "id": "def-common.IFieldType.visualizable", - "type": "CompoundType", + "id": "def-common.DataViewsServicePublicMethods.getTitles", + "type": "Function", "tags": [], - "label": "visualizable", - "description": [], + "label": "getTitles", + "description": [ + "\nGet list of data view ids and title (and more) for each data view." + ], "signature": [ - "boolean | undefined" + "(refresh?: boolean | undefined) => Promise" ], - "path": "src/plugins/data_views/common/fields/types.ts", - "deprecated": false + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsServicePublicMethods.getTitles.$1", + "type": "CompoundType", + "tags": [], + "label": "refresh", + "description": [ + "- clear cache and fetch from server" + ], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] }, { "parentPluginId": "dataViews", - "id": "def-common.IFieldType.readFromDocValues", - "type": "CompoundType", + "id": "def-common.DataViewsServicePublicMethods.hasUserDataView", + "type": "Function", "tags": [], - "label": "readFromDocValues", - "description": [], + "label": "hasUserDataView", + "description": [ + "\nReturns true if user has access to view a data view." + ], "signature": [ - "boolean | undefined" + "() => Promise" ], - "path": "src/plugins/data_views/common/fields/types.ts", - "deprecated": false + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "dataViews", - "id": "def-common.IFieldType.displayName", - "type": "string", - "tags": [], - "label": "displayName", - "description": [], + "id": "def-common.DataViewsServicePublicMethods.refreshFields", + "type": "Function", + "tags": [ + "params" + ], + "label": "refreshFields", + "description": [ + "\nRefresh fields for data view instance" + ], "signature": [ - "string | undefined" + "(indexPattern: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + ") => Promise" ], - "path": "src/plugins/data_views/common/fields/types.ts", - "deprecated": false + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsServicePublicMethods.refreshFields.$1", + "type": "Object", + "tags": [], + "label": "indexPattern", + "description": [], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + } + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "dataViews", - "id": "def-common.IFieldType.customLabel", - "type": "string", - "tags": [], - "label": "customLabel", - "description": [], + "id": "def-common.DataViewsServicePublicMethods.savedObjectToSpec", + "type": "Function", + "tags": [ + "params" + ], + "label": "savedObjectToSpec", + "description": [ + "\nConverts data view saved object to spec" + ], "signature": [ - "string | undefined" + "(savedObject: ", + "SavedObject", + "<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewAttributes", + "text": "DataViewAttributes" + }, + ">) => ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewSpec", + "text": "DataViewSpec" + } + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsServicePublicMethods.savedObjectToSpec.$1", + "type": "Object", + "tags": [], + "label": "savedObject", + "description": [], + "signature": [ + "SavedObject", + "<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewAttributes", + "text": "DataViewAttributes" + }, + ">" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } ], - "path": "src/plugins/data_views/common/fields/types.ts", - "deprecated": false + "returnComment": [] }, { "parentPluginId": "dataViews", - "id": "def-common.IFieldType.format", - "type": "Any", + "id": "def-common.DataViewsServicePublicMethods.setDefault", + "type": "Function", "tags": [], - "label": "format", - "description": [], + "label": "setDefault", + "description": [ + "\nSet default data view." + ], "signature": [ - "any" + "(id: string | null, force?: boolean | undefined) => Promise" ], - "path": "src/plugins/data_views/common/fields/types.ts", - "deprecated": false + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsServicePublicMethods.setDefault.$1", + "type": "CompoundType", + "tags": [], + "label": "id", + "description": [ + "- Id of the data view to set as default." + ], + "signature": [ + "string | null" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": false + }, + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsServicePublicMethods.setDefault.$2", + "type": "CompoundType", + "tags": [], + "label": "force", + "description": [ + "- Overwrite if true" + ], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] }, { "parentPluginId": "dataViews", - "id": "def-common.IFieldType.toSpec", + "id": "def-common.DataViewsServicePublicMethods.updateSavedObject", "type": "Function", - "tags": [], - "label": "toSpec", - "description": [], + "tags": [ + "oaram" + ], + "label": "updateSavedObject", + "description": [ + "\nSave saved object" + ], "signature": [ - "((options?: { getFormatterForField?: ((field: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" - }, - " | ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - " | ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" - }, - ") => ", - { - "pluginId": "fieldFormats", - "scope": "common", - "docId": "kibFieldFormatsPluginApi", - "section": "def-common.FieldFormat", - "text": "FieldFormat" - }, - ") | undefined; } | undefined) => ", + "(indexPattern: ", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" + "section": "def-common.DataView", + "text": "DataView" }, - ") | undefined" + ", saveAttempts?: number | undefined, ignoreErrors?: boolean | undefined) => Promise" ], - "path": "src/plugins/data_views/common/fields/types.ts", + "path": "src/plugins/data_views/common/data_views/data_views.ts", "deprecated": false, "children": [ { "parentPluginId": "dataViews", - "id": "def-common.IFieldType.toSpec.$1", + "id": "def-common.DataViewsServicePublicMethods.updateSavedObject.$1", "type": "Object", "tags": [], - "label": "options", - "description": [], - "path": "src/plugins/data_views/common/fields/types.ts", - "deprecated": false, - "children": [ + "label": "indexPattern", + "description": [ + "- data view instance" + ], + "signature": [ { - "parentPluginId": "dataViews", - "id": "def-common.IFieldType.toSpec.$1.getFormatterForField", - "type": "Function", - "tags": [], - "label": "getFormatterForField", - "description": [], - "signature": [ - "((field: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" - }, - " | ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - " | ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" - }, - ") => ", - { - "pluginId": "fieldFormats", - "scope": "common", - "docId": "kibFieldFormatsPluginApi", - "section": "def-common.FieldFormat", - "text": "FieldFormat" - }, - ") | undefined" - ], - "path": "src/plugins/data_views/common/fields/types.ts", - "deprecated": false + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" } - ] + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsServicePublicMethods.updateSavedObject.$2", + "type": "number", + "tags": [], + "label": "saveAttempts", + "description": [ + "- number of times to try saving" + ], + "signature": [ + "number | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": false + }, + { + "parentPluginId": "dataViews", + "id": "def-common.DataViewsServicePublicMethods.updateSavedObject.$3", + "type": "CompoundType", + "tags": [], + "label": "ignoreErrors", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": false } ], "returnComment": [] @@ -19297,227 +18375,134 @@ }, { "parentPluginId": "dataViews", - "id": "def-common.IIndexPattern", + "id": "def-common.FieldAttrs", "type": "Interface", - "tags": [ - "deprecated" - ], - "label": "IIndexPattern", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IIndexPattern", - "text": "IIndexPattern" - }, - " extends ", - "DataViewBase" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": true, - "references": [ - { - "plugin": "data", - "path": "src/plugins/data/common/index.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/query/timefilter/get_time.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/query/timefilter/get_time.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/query/timefilter/get_time.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/query/timefilter/get_time.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/query/filter_manager/lib/generate_filters.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/query/filter_manager/lib/generate_filters.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/query/filter_manager/lib/generate_filters.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/query/timefilter/timefilter.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/query/timefilter/timefilter.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/query/timefilter/timefilter.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/normalize_sort_request.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/normalize_sort_request.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/normalize_sort_request.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/index.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/query/timefilter/get_time.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/query/timefilter/get_time.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/query/timefilter/get_time.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/query/timefilter/get_time.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/query/timefilter/get_time.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/create_search_source.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/create_search_source.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/create_search_source.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/normalize_sort_request.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/normalize_sort_request.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/query/timefilter/lib/extract_time_filter.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/query/timefilter/lib/extract_time_filter.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/query/timefilter/lib/extract_time_filter.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/query/filter_manager/lib/mappers/map_exists.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/query/filter_manager/lib/mappers/map_exists.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/query/filter_manager/lib/mappers/map_exists.test.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts" - }, + "tags": [], + "label": "FieldAttrs", + "description": [ + "\nSet of field attributes" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "children": [ { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts" + "parentPluginId": "dataViews", + "id": "def-common.FieldAttrs.Unnamed", + "type": "IndexSignature", + "tags": [], + "label": "[key: string]: FieldAttrSet", + "description": [], + "signature": [ + "[key: string]: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldAttrSet", + "text": "FieldAttrSet" + } + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false } ], + "initialIsOpen": false + }, + { + "parentPluginId": "dataViews", + "id": "def-common.FieldAttrSet", + "type": "Interface", + "tags": [], + "label": "FieldAttrSet", + "description": [ + "\nField attributes that are stored on the data view" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, "children": [ { "parentPluginId": "dataViews", - "id": "def-common.IIndexPattern.title", + "id": "def-common.FieldAttrSet.customLabel", "type": "string", "tags": [], - "label": "title", - "description": [], + "label": "customLabel", + "description": [ + "\nCustom field label" + ], + "signature": [ + "string | undefined" + ], "path": "src/plugins/data_views/common/types.ts", "deprecated": false }, { "parentPluginId": "dataViews", - "id": "def-common.IIndexPattern.fields", - "type": "Array", + "id": "def-common.FieldAttrSet.count", + "type": "number", "tags": [], - "label": "fields", - "description": [], + "label": "count", + "description": [ + "\nPopularity count - used for discover" + ], + "signature": [ + "number | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "dataViews", + "id": "def-common.FieldConfiguration", + "type": "Interface", + "tags": [], + "label": "FieldConfiguration", + "description": [ + "\nField attributes that are user configurable" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.FieldConfiguration.format", + "type": "CompoundType", + "tags": [], + "label": "format", + "description": [ + "\nField format in serialized form" + ], "signature": [ { - "pluginId": "dataViews", + "pluginId": "fieldFormats", "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.SerializedFieldFormat", + "text": "SerializedFieldFormat" }, - "[]" + "<", + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.FieldFormatParams", + "text": "FieldFormatParams" + }, + "> | null | undefined" ], "path": "src/plugins/data_views/common/types.ts", "deprecated": false }, { "parentPluginId": "dataViews", - "id": "def-common.IIndexPattern.type", + "id": "def-common.FieldConfiguration.customLabel", "type": "string", "tags": [], - "label": "type", + "label": "customLabel", "description": [ - "\nType is used for identifying rollup indices, otherwise left undefined" + "\nCustom label" ], "signature": [ "string | undefined" @@ -19527,937 +18512,948 @@ }, { "parentPluginId": "dataViews", - "id": "def-common.IIndexPattern.timeFieldName", - "type": "string", + "id": "def-common.FieldConfiguration.popularity", + "type": "number", "tags": [], - "label": "timeFieldName", - "description": [], + "label": "popularity", + "description": [ + "\nPopularity - used for discover" + ], "signature": [ - "string | undefined" + "number | undefined" ], "path": "src/plugins/data_views/common/types.ts", "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "dataViews", + "id": "def-common.FieldSpec", + "type": "Interface", + "tags": [], + "label": "FieldSpec", + "description": [ + "\nSerialized version of DataViewField" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" }, + " extends ", + "DataViewFieldBase" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "children": [ { "parentPluginId": "dataViews", - "id": "def-common.IIndexPattern.getTimeField", - "type": "Function", + "id": "def-common.FieldSpec.count", + "type": "number", "tags": [], - "label": "getTimeField", - "description": [], + "label": "count", + "description": [ + "\nPopularity count is used by discover" + ], "signature": [ - "(() => ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" - }, - " | undefined) | undefined" + "number | undefined" ], "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "children": [], - "returnComment": [] + "deprecated": false }, { "parentPluginId": "dataViews", - "id": "def-common.IIndexPattern.fieldFormatMap", + "id": "def-common.FieldSpec.conflictDescriptions", "type": "Object", "tags": [], - "label": "fieldFormatMap", - "description": [], + "label": "conflictDescriptions", + "description": [ + "\nDescription of field type conflicts across indices" + ], "signature": [ - "Record | undefined> | undefined" + "Record | undefined" ], "path": "src/plugins/data_views/common/types.ts", "deprecated": false }, { "parentPluginId": "dataViews", - "id": "def-common.IIndexPattern.getFormatterForField", - "type": "Function", + "id": "def-common.FieldSpec.format", + "type": "Object", "tags": [], - "label": "getFormatterForField", + "label": "format", "description": [ - "\nLook up a formatter for a given field" + "\nField formatting in serialized format" ], "signature": [ - "((field: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" - }, - " | ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - " | ", { - "pluginId": "dataViews", + "pluginId": "fieldFormats", "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.SerializedFieldFormat", + "text": "SerializedFieldFormat" }, - ") => ", + "<", { "pluginId": "fieldFormats", "scope": "common", "docId": "kibFieldFormatsPluginApi", - "section": "def-common.FieldFormat", - "text": "FieldFormat" + "section": "def-common.FieldFormatParams", + "text": "FieldFormatParams" }, - ") | undefined" + "> | undefined" ], "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.IIndexPattern.getFormatterForField.$1", - "type": "CompoundType", - "tags": [], - "label": "field", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" - }, - " | ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - " | ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" - } - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "isRequired": true - } + "deprecated": false + }, + { + "parentPluginId": "dataViews", + "id": "def-common.FieldSpec.esTypes", + "type": "Array", + "tags": [], + "label": "esTypes", + "description": [ + "\nElasticsearch field types used by backing indices" ], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.IIndexPatternFieldList", - "type": "Interface", - "tags": [], - "label": "IIndexPatternFieldList", - "description": [], - "signature": [ + "signature": [ + "string[] | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false + }, { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IIndexPatternFieldList", - "text": "IIndexPatternFieldList" + "parentPluginId": "dataViews", + "id": "def-common.FieldSpec.searchable", + "type": "boolean", + "tags": [], + "label": "searchable", + "description": [ + "\nTrue if field is searchable" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, - " extends ", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" + "parentPluginId": "dataViews", + "id": "def-common.FieldSpec.aggregatable", + "type": "boolean", + "tags": [], + "label": "aggregatable", + "description": [ + "\nTrue if field is aggregatable" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, - "[]" - ], - "path": "src/plugins/data_views/common/fields/field_list.ts", - "deprecated": false, - "children": [ { "parentPluginId": "dataViews", - "id": "def-common.IIndexPatternFieldList.add", - "type": "Function", + "id": "def-common.FieldSpec.readFromDocValues", + "type": "CompoundType", "tags": [], - "label": "add", - "description": [], + "label": "readFromDocValues", + "description": [ + "\nTrue if can be read from doc values" + ], "signature": [ - "(field: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - ") => ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" - } + "boolean | undefined" ], - "path": "src/plugins/data_views/common/fields/field_list.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.IIndexPatternFieldList.add.$1", - "type": "Object", - "tags": [], - "label": "field", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - } - ], - "path": "src/plugins/data_views/common/fields/field_list.ts", - "deprecated": false, - "isRequired": true - } + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false + }, + { + "parentPluginId": "dataViews", + "id": "def-common.FieldSpec.indexed", + "type": "CompoundType", + "tags": [], + "label": "indexed", + "description": [ + "\nTrue if field is indexed" ], - "returnComment": [] + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, { "parentPluginId": "dataViews", - "id": "def-common.IIndexPatternFieldList.getAll", - "type": "Function", + "id": "def-common.FieldSpec.customLabel", + "type": "string", "tags": [], - "label": "getAll", - "description": [], + "label": "customLabel", + "description": [ + "\nCustom label for field, used for display in kibana" + ], "signature": [ - "() => ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" - }, - "[]" + "string | undefined" ], - "path": "src/plugins/data_views/common/fields/field_list.ts", - "deprecated": false, - "children": [], - "returnComment": [] + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, { "parentPluginId": "dataViews", - "id": "def-common.IIndexPatternFieldList.getByName", - "type": "Function", + "id": "def-common.FieldSpec.runtimeField", + "type": "Object", "tags": [], - "label": "getByName", - "description": [], + "label": "runtimeField", + "description": [ + "\nRuntime field definition" + ], "signature": [ - "(name: string) => ", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" + "section": "def-common.RuntimeFieldSpec", + "text": "RuntimeFieldSpec" }, " | undefined" ], - "path": "src/plugins/data_views/common/fields/field_list.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.IIndexPatternFieldList.getByName.$1", - "type": "string", - "tags": [], - "label": "name", - "description": [], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/fields/field_list.ts", - "deprecated": false, - "isRequired": true - } + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false + }, + { + "parentPluginId": "dataViews", + "id": "def-common.FieldSpec.shortDotsEnable", + "type": "CompoundType", + "tags": [], + "label": "shortDotsEnable", + "description": [ + "\nWhether short dots are enabled, based on uiSettings." ], - "returnComment": [] + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, { "parentPluginId": "dataViews", - "id": "def-common.IIndexPatternFieldList.getByType", - "type": "Function", + "id": "def-common.FieldSpec.isMapped", + "type": "CompoundType", "tags": [], - "label": "getByType", - "description": [], + "label": "isMapped", + "description": [ + "\nIs this field in the mapping? False if a scripted or runtime field defined on the data view." + ], "signature": [ - "(type: string) => ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" - }, - "[]" + "boolean | undefined" ], - "path": "src/plugins/data_views/common/fields/field_list.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.IIndexPatternFieldList.getByType.$1", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/fields/field_list.ts", - "deprecated": false, - "isRequired": true - } + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "dataViews", + "id": "def-common.GetFieldsOptions", + "type": "Interface", + "tags": [], + "label": "GetFieldsOptions", + "description": [], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.GetFieldsOptions.pattern", + "type": "string", + "tags": [], + "label": "pattern", + "description": [], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false + }, + { + "parentPluginId": "dataViews", + "id": "def-common.GetFieldsOptions.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "string | undefined" ], - "returnComment": [] + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, { "parentPluginId": "dataViews", - "id": "def-common.IIndexPatternFieldList.remove", - "type": "Function", + "id": "def-common.GetFieldsOptions.lookBack", + "type": "CompoundType", "tags": [], - "label": "remove", + "label": "lookBack", "description": [], "signature": [ - "(field: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" - }, - ") => void" - ], - "path": "src/plugins/data_views/common/fields/field_list.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.IIndexPatternFieldList.remove.$1", - "type": "Object", - "tags": [], - "label": "field", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" - } - ], - "path": "src/plugins/data_views/common/fields/field_list.ts", - "deprecated": false, - "isRequired": true - } + "boolean | undefined" ], - "returnComment": [] + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, { "parentPluginId": "dataViews", - "id": "def-common.IIndexPatternFieldList.removeAll", - "type": "Function", + "id": "def-common.GetFieldsOptions.metaFields", + "type": "Array", "tags": [], - "label": "removeAll", + "label": "metaFields", "description": [], "signature": [ - "() => void" + "string[] | undefined" ], - "path": "src/plugins/data_views/common/fields/field_list.ts", - "deprecated": false, - "children": [], - "returnComment": [] + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, { "parentPluginId": "dataViews", - "id": "def-common.IIndexPatternFieldList.replaceAll", - "type": "Function", + "id": "def-common.GetFieldsOptions.rollupIndex", + "type": "string", "tags": [], - "label": "replaceAll", + "label": "rollupIndex", "description": [], "signature": [ - "(specs: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - "[]) => void" - ], - "path": "src/plugins/data_views/common/fields/field_list.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.IIndexPatternFieldList.replaceAll.$1", - "type": "Array", - "tags": [], - "label": "specs", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - "[]" - ], - "path": "src/plugins/data_views/common/fields/field_list.ts", - "deprecated": false, - "isRequired": true - } + "string | undefined" ], - "returnComment": [] + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, { "parentPluginId": "dataViews", - "id": "def-common.IIndexPatternFieldList.update", - "type": "Function", + "id": "def-common.GetFieldsOptions.allowNoIndex", + "type": "CompoundType", "tags": [], - "label": "update", + "label": "allowNoIndex", "description": [], "signature": [ - "(field: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - ") => void" - ], - "path": "src/plugins/data_views/common/fields/field_list.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.IIndexPatternFieldList.update.$1", - "type": "Object", - "tags": [], - "label": "field", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - } - ], - "path": "src/plugins/data_views/common/fields/field_list.ts", - "deprecated": false, - "isRequired": true - } + "boolean | undefined" ], - "returnComment": [] + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, { "parentPluginId": "dataViews", - "id": "def-common.IIndexPatternFieldList.toSpec", - "type": "Function", + "id": "def-common.GetFieldsOptions.filter", + "type": "Object", "tags": [], - "label": "toSpec", + "label": "filter", "description": [], "signature": [ - "(options?: { getFormatterForField?: ((field: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" - }, - " | ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - " | ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" - }, - ") => ", - { - "pluginId": "fieldFormats", - "scope": "common", - "docId": "kibFieldFormatsPluginApi", - "section": "def-common.FieldFormat", - "text": "FieldFormat" - }, - ") | undefined; } | undefined) => ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewFieldMap", - "text": "DataViewFieldMap" - } - ], - "path": "src/plugins/data_views/common/fields/field_list.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.IIndexPatternFieldList.toSpec.$1", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "path": "src/plugins/data_views/common/fields/field_list.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.IIndexPatternFieldList.toSpec.$1.getFormatterForField", - "type": "Function", - "tags": [], - "label": "getFormatterForField", - "description": [], - "signature": [ - "((field: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" - }, - " | ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - " | ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" - }, - ") => ", - { - "pluginId": "fieldFormats", - "scope": "common", - "docId": "kibFieldFormatsPluginApi", - "section": "def-common.FieldFormat", - "text": "FieldFormat" - }, - ") | undefined" - ], - "path": "src/plugins/data_views/common/fields/field_list.ts", - "deprecated": false - } - ] - } + "QueryDslQueryContainer", + " | undefined" ], - "returnComment": [] + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "dataViews", - "id": "def-common.IndexPatternExpressionType", + "id": "def-common.HasDataService", "type": "Interface", "tags": [], - "label": "IndexPatternExpressionType", + "label": "HasDataService", "description": [], - "path": "src/plugins/data_views/common/expressions/load_index_pattern.ts", + "path": "src/plugins/data_views/common/types.ts", "deprecated": false, "children": [ { "parentPluginId": "dataViews", - "id": "def-common.IndexPatternExpressionType.type", - "type": "string", + "id": "def-common.HasDataService.hasESData", + "type": "Function", "tags": [], - "label": "type", + "label": "hasESData", "description": [], "signature": [ - "\"index_pattern\"" + "() => Promise" ], - "path": "src/plugins/data_views/common/expressions/load_index_pattern.ts", - "deprecated": false + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "dataViews", - "id": "def-common.IndexPatternExpressionType.value", - "type": "Object", + "id": "def-common.HasDataService.hasUserDataView", + "type": "Function", "tags": [], - "label": "value", + "label": "hasUserDataView", "description": [], "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" - } + "() => Promise" ], - "path": "src/plugins/data_views/common/expressions/load_index_pattern.ts", - "deprecated": false + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "dataViews", + "id": "def-common.HasDataService.hasDataView", + "type": "Function", + "tags": [], + "label": "hasDataView", + "description": [], + "signature": [ + "() => Promise" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "children": [], + "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "dataViews", - "id": "def-common.RuntimeField", + "id": "def-common.IDataViewsApiClient", "type": "Interface", - "tags": [ - "see" - ], - "label": "RuntimeField", - "description": [ - "\nThis is the RuntimeField interface enhanced with Data view field\nconfiguration: field format definition, customLabel or popularity.\n" - ], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.RuntimeField", - "text": "RuntimeField" - }, - " extends ", - "RuntimeFieldBase", - ",", - "FieldConfiguration" - ], + "tags": [], + "label": "IDataViewsApiClient", + "description": [], "path": "src/plugins/data_views/common/types.ts", "deprecated": false, "children": [ { "parentPluginId": "dataViews", - "id": "def-common.RuntimeField.fields", - "type": "Object", + "id": "def-common.IDataViewsApiClient.getFieldsForWildcard", + "type": "Function", "tags": [], - "label": "fields", + "label": "getFieldsForWildcard", "description": [], "signature": [ - "Record | undefined" + ") => Promise" ], "path": "src/plugins/data_views/common/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.RuntimeFieldSpec", - "type": "Interface", - "tags": [], - "label": "RuntimeFieldSpec", - "description": [ - "\nThe RuntimeField that will be sent in the ES Query \"runtime_mappings\" object" - ], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.RuntimeFieldSpec", - "text": "RuntimeFieldSpec" + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.IDataViewsApiClient.getFieldsForWildcard.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.GetFieldsOptions", + "text": "GetFieldsOptions" + } + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, - " extends ", - "RuntimeFieldBase" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "children": [ { "parentPluginId": "dataViews", - "id": "def-common.RuntimeFieldSpec.fields", - "type": "Object", + "id": "def-common.IDataViewsApiClient.hasUserIndexPattern", + "type": "Function", "tags": [], - "label": "fields", + "label": "hasUserIndexPattern", "description": [], "signature": [ - "Record | undefined" + "() => Promise" ], "path": "src/plugins/data_views/common/types.ts", - "deprecated": false + "deprecated": false, + "children": [], + "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "dataViews", - "id": "def-common.RuntimeFieldSubField", + "id": "def-common.IIndexPatternFieldList", "type": "Interface", "tags": [], - "label": "RuntimeFieldSubField", - "description": [], + "label": "IIndexPatternFieldList", + "description": [ + "\nInterface for data view field list which _extends_ the array class." + ], "signature": [ { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.RuntimeFieldSubField", - "text": "RuntimeFieldSubField" + "section": "def-common.IIndexPatternFieldList", + "text": "IIndexPatternFieldList" }, " extends ", - "FieldConfiguration" + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewField", + "text": "DataViewField" + }, + "[]" ], - "path": "src/plugins/data_views/common/types.ts", + "path": "src/plugins/data_views/common/fields/field_list.ts", "deprecated": false, "children": [ { "parentPluginId": "dataViews", - "id": "def-common.RuntimeFieldSubField.type", - "type": "CompoundType", + "id": "def-common.IIndexPatternFieldList.add", + "type": "Function", "tags": [], - "label": "type", - "description": [], + "label": "add", + "description": [ + "\nAdd field to field list." + ], "signature": [ - "\"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"long\" | \"double\"" + "(field: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + ") => ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewField", + "text": "DataViewField" + } ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.SavedObject", - "type": "Interface", - "tags": [], - "label": "SavedObject", - "description": [], - "signature": [ - "SavedObject", - "" - ], - "path": "src/core/types/saved_objects.ts", - "deprecated": false, - "children": [ + "path": "src/plugins/data_views/common/fields/field_list.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.IIndexPatternFieldList.add.$1", + "type": "Object", + "tags": [], + "label": "field", + "description": [ + "field spec to add field to list" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + } + ], + "path": "src/plugins/data_views/common/fields/field_list.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [ + "data view field instance which was added to list" + ] + }, { "parentPluginId": "dataViews", - "id": "def-common.SavedObject.id", - "type": "string", + "id": "def-common.IIndexPatternFieldList.getAll", + "type": "Function", "tags": [], - "label": "id", + "label": "getAll", "description": [ - "The ID of this Saved Object, guaranteed to be unique for all objects of the same `type`" + "\nReturns fields as plain array of data view field instances." ], - "path": "src/core/types/saved_objects.ts", - "deprecated": false + "signature": [ + "() => ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewField", + "text": "DataViewField" + }, + "[]" + ], + "path": "src/plugins/data_views/common/fields/field_list.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "dataViews", - "id": "def-common.SavedObject.type", - "type": "string", + "id": "def-common.IIndexPatternFieldList.getByName", + "type": "Function", "tags": [], - "label": "type", + "label": "getByName", "description": [ - " The type of Saved Object. Each plugin can define it's own custom Saved Object types." + "\nGet field by name. Optimized, uses map to find field." + ], + "signature": [ + "(name: string) => ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewField", + "text": "DataViewField" + }, + " | undefined" + ], + "path": "src/plugins/data_views/common/fields/field_list.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.IIndexPatternFieldList.getByName.$1", + "type": "string", + "tags": [], + "label": "name", + "description": [ + "name of field to find" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/fields/field_list.ts", + "deprecated": false, + "isRequired": true + } ], - "path": "src/core/types/saved_objects.ts", - "deprecated": false + "returnComment": [ + "data view field instance if found, undefined otherwise" + ] }, { "parentPluginId": "dataViews", - "id": "def-common.SavedObject.version", - "type": "string", + "id": "def-common.IIndexPatternFieldList.getByType", + "type": "Function", "tags": [], - "label": "version", + "label": "getByType", "description": [ - "An opaque version number which changes on each successful write operation. Can be used for implementing optimistic concurrency control." + "\nGet fields by field type. Optimized, uses map to find fields." ], "signature": [ - "string | undefined" + "(type: string) => ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewField", + "text": "DataViewField" + }, + "[]" ], - "path": "src/core/types/saved_objects.ts", - "deprecated": false + "path": "src/plugins/data_views/common/fields/field_list.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.IIndexPatternFieldList.getByType.$1", + "type": "string", + "tags": [], + "label": "type", + "description": [ + "type of field to find" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/fields/field_list.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [ + "array of data view field instances if found, empty array otherwise" + ] }, { "parentPluginId": "dataViews", - "id": "def-common.SavedObject.updated_at", - "type": "string", + "id": "def-common.IIndexPatternFieldList.remove", + "type": "Function", "tags": [], - "label": "updated_at", + "label": "remove", "description": [ - "Timestamp of the last time this document had been updated." + "\nRemove field from field list" ], "signature": [ - "string | undefined" + "(field: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewField", + "text": "DataViewField" + }, + " | ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + ") => void" ], - "path": "src/core/types/saved_objects.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.SavedObject.error", - "type": "Object", - "tags": [], - "label": "error", - "description": [], - "signature": [ - "SavedObjectError", - " | undefined" + "path": "src/plugins/data_views/common/fields/field_list.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.IIndexPatternFieldList.remove.$1", + "type": "CompoundType", + "tags": [], + "label": "field", + "description": [ + "field for removal" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewField", + "text": "DataViewField" + }, + " | ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + } + ], + "path": "src/plugins/data_views/common/fields/field_list.ts", + "deprecated": false, + "isRequired": true + } ], - "path": "src/core/types/saved_objects.ts", - "deprecated": false + "returnComment": [] }, { "parentPluginId": "dataViews", - "id": "def-common.SavedObject.attributes", - "type": "Uncategorized", + "id": "def-common.IIndexPatternFieldList.removeAll", + "type": "Function", "tags": [], - "label": "attributes", + "label": "removeAll", "description": [ - "{@inheritdoc SavedObjectAttributes}" + "\nRemove all fields from field list." ], "signature": [ - "T" + "() => void" ], - "path": "src/core/types/saved_objects.ts", - "deprecated": false + "path": "src/plugins/data_views/common/fields/field_list.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "dataViews", - "id": "def-common.SavedObject.references", - "type": "Array", + "id": "def-common.IIndexPatternFieldList.replaceAll", + "type": "Function", "tags": [], - "label": "references", + "label": "replaceAll", "description": [ - "{@inheritdoc SavedObjectReference}" + "\nReplace all fields in field list with new fields." ], "signature": [ - "SavedObjectReference", - "[]" + "(specs: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + "[]) => void" ], - "path": "src/core/types/saved_objects.ts", - "deprecated": false + "path": "src/plugins/data_views/common/fields/field_list.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.IIndexPatternFieldList.replaceAll.$1", + "type": "Array", + "tags": [], + "label": "specs", + "description": [ + "array of field specs to add to list" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + "[]" + ], + "path": "src/plugins/data_views/common/fields/field_list.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "dataViews", - "id": "def-common.SavedObject.migrationVersion", - "type": "Object", + "id": "def-common.IIndexPatternFieldList.update", + "type": "Function", "tags": [], - "label": "migrationVersion", + "label": "update", "description": [ - "{@inheritdoc SavedObjectsMigrationVersion}" + "\nUpdate a field in the list" ], "signature": [ - "SavedObjectsMigrationVersion", - " | undefined" + "(field: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + ") => void" ], - "path": "src/core/types/saved_objects.ts", - "deprecated": false + "path": "src/plugins/data_views/common/fields/field_list.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.IIndexPatternFieldList.update.$1", + "type": "Object", + "tags": [], + "label": "field", + "description": [ + "field spec to update" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + } + ], + "path": "src/plugins/data_views/common/fields/field_list.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "dataViews", - "id": "def-common.SavedObject.coreMigrationVersion", - "type": "string", - "tags": [], - "label": "coreMigrationVersion", + "id": "def-common.IIndexPatternFieldList.toSpec", + "type": "Function", + "tags": [ + "return" + ], + "label": "toSpec", "description": [ - "A semver value that is used when upgrading objects between Kibana versions." + "\nField list as field spec map by name" ], "signature": [ - "string | undefined" + "(options?: ToSpecOptions | undefined) => ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewFieldMap", + "text": "DataViewFieldMap" + } + ], + "path": "src/plugins/data_views/common/fields/field_list.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.IIndexPatternFieldList.toSpec.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [ + "optionally provide a function to get field formatter for fields" + ], + "signature": [ + "ToSpecOptions | undefined" + ], + "path": "src/plugins/data_views/common/fields/field_list.ts", + "deprecated": false, + "isRequired": false + } ], - "path": "src/core/types/saved_objects.ts", - "deprecated": false - }, + "returnComment": [ + "map of field specs by name" + ] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "dataViews", + "id": "def-common.IndexPatternExpressionType", + "type": "Interface", + "tags": [], + "label": "IndexPatternExpressionType", + "description": [ + "\nIndex pattern expression interface" + ], + "path": "src/plugins/data_views/common/expressions/load_index_pattern.ts", + "deprecated": false, + "children": [ { "parentPluginId": "dataViews", - "id": "def-common.SavedObject.namespaces", - "type": "Array", + "id": "def-common.IndexPatternExpressionType.type", + "type": "string", "tags": [], - "label": "namespaces", + "label": "type", "description": [ - "\nSpace(s) that this saved object exists in. This attribute is not used for \"global\" saved object types which are registered with\n`namespaceType: 'agnostic'`." + "\nExpression type" ], "signature": [ - "string[] | undefined" + "\"index_pattern\"" ], - "path": "src/core/types/saved_objects.ts", + "path": "src/plugins/data_views/common/expressions/load_index_pattern.ts", "deprecated": false }, { "parentPluginId": "dataViews", - "id": "def-common.SavedObject.originId", - "type": "string", + "id": "def-common.IndexPatternExpressionType.value", + "type": "Object", "tags": [], - "label": "originId", + "label": "value", "description": [ - "\nThe ID of the saved object this originated from. This is set if this object's `id` was regenerated; that can happen during migration\nfrom a legacy single-namespace type, or during import. It is only set during migration or create operations. This is used during import\nto ensure that ID regeneration is deterministic, so saved objects will be overwritten if they are imported multiple times into a given\nspace." + "\nValue - DataViewSpec" ], "signature": [ - "string | undefined" + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewSpec", + "text": "DataViewSpec" + } ], - "path": "src/core/types/saved_objects.ts", + "path": "src/plugins/data_views/common/expressions/load_index_pattern.ts", "deprecated": false } ], @@ -20465,383 +19461,384 @@ }, { "parentPluginId": "dataViews", - "id": "def-common.SavedObjectsClientCommon", + "id": "def-common.RuntimeField", "type": "Interface", "tags": [], - "label": "SavedObjectsClientCommon", - "description": [], + "label": "RuntimeField", + "description": [ + "\nThis is the RuntimeField interface enhanced with Data view field\nconfiguration: field format definition, customLabel or popularity." + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.RuntimeField", + "text": "RuntimeField" + }, + " extends ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.RuntimeFieldBase", + "text": "RuntimeFieldBase" + }, + ",", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldConfiguration", + "text": "FieldConfiguration" + } + ], "path": "src/plugins/data_views/common/types.ts", "deprecated": false, "children": [ { "parentPluginId": "dataViews", - "id": "def-common.SavedObjectsClientCommon.find", - "type": "Function", + "id": "def-common.RuntimeField.fields", + "type": "Object", "tags": [], - "label": "find", - "description": [], + "label": "fields", + "description": [ + "\nSubfields of composite field" + ], "signature": [ - "(options: ", + "Record Promise<", - "SavedObject", - "[]>" + "> | undefined" ], "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.SavedObjectsClientCommon.find.$1", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.SavedObjectsClientCommonFindArgs", - "text": "SavedObjectsClientCommonFindArgs" - } - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "dataViews", + "id": "def-common.RuntimeFieldBase", + "type": "Interface", + "tags": [], + "label": "RuntimeFieldBase", + "description": [ + "\nRuntime field definition" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "children": [ { "parentPluginId": "dataViews", - "id": "def-common.SavedObjectsClientCommon.get", - "type": "Function", + "id": "def-common.RuntimeFieldBase.type", + "type": "CompoundType", "tags": [], - "label": "get", - "description": [], + "label": "type", + "description": [ + "\nType of runtime field" + ], "signature": [ - "(type: string, id: string) => Promise<", - "SavedObject", - ">" + "\"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"long\" | \"double\" | \"composite\"" ], "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.SavedObjectsClientCommon.get.$1", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "dataViews", - "id": "def-common.SavedObjectsClientCommon.get.$2", - "type": "string", - "tags": [], - "label": "id", - "description": [], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] + "deprecated": false }, { "parentPluginId": "dataViews", - "id": "def-common.SavedObjectsClientCommon.update", - "type": "Function", - "tags": [], - "label": "update", - "description": [], - "signature": [ - "(type: string, id: string, attributes: Record, options: Record) => Promise<", - "SavedObject", - ">" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.SavedObjectsClientCommon.update.$1", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "dataViews", - "id": "def-common.SavedObjectsClientCommon.update.$2", - "type": "string", - "tags": [], - "label": "id", - "description": [], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "dataViews", - "id": "def-common.SavedObjectsClientCommon.update.$3", - "type": "Object", - "tags": [], - "label": "attributes", - "description": [], - "signature": [ - "Record" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "dataViews", - "id": "def-common.SavedObjectsClientCommon.update.$4", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - "Record" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "isRequired": true - } + "id": "def-common.RuntimeFieldBase.script", + "type": "Object", + "tags": [], + "label": "script", + "description": [ + "\nRuntime field script" ], - "returnComment": [] + "signature": [ + "{ source: string; } | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "dataViews", + "id": "def-common.RuntimeFieldSpec", + "type": "Interface", + "tags": [], + "label": "RuntimeFieldSpec", + "description": [ + "\nThe RuntimeField that will be sent in the ES Query \"runtime_mappings\" object" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.RuntimeFieldSpec", + "text": "RuntimeFieldSpec" }, + " extends ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.RuntimeFieldBase", + "text": "RuntimeFieldBase" + } + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "children": [ { "parentPluginId": "dataViews", - "id": "def-common.SavedObjectsClientCommon.create", - "type": "Function", + "id": "def-common.RuntimeFieldSpec.fields", + "type": "Object", "tags": [], - "label": "create", + "label": "fields", "description": [], "signature": [ - "(type: string, attributes: Record, options: Record) => Promise<", - "SavedObject", - ">" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.SavedObjectsClientCommon.create.$1", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "isRequired": true - }, + "Record" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "isRequired": true + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.RuntimeTypeExceptComposite", + "text": "RuntimeTypeExceptComposite" }, - { - "parentPluginId": "dataViews", - "id": "def-common.SavedObjectsClientCommon.create.$3", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - "Record" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "isRequired": true - } + "; }> | undefined" ], - "returnComment": [] + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "dataViews", + "id": "def-common.RuntimeFieldSubField", + "type": "Interface", + "tags": [], + "label": "RuntimeFieldSubField", + "description": [ + "\nRuntime field composite subfield" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.RuntimeFieldSubField", + "text": "RuntimeFieldSubField" }, + " extends ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldConfiguration", + "text": "FieldConfiguration" + } + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "children": [ { "parentPluginId": "dataViews", - "id": "def-common.SavedObjectsClientCommon.delete", - "type": "Function", + "id": "def-common.RuntimeFieldSubField.type", + "type": "CompoundType", "tags": [], - "label": "delete", - "description": [], + "label": "type", + "description": [ + "\nType of runtime field, can only be primitive type" + ], "signature": [ - "(type: string, id: string) => Promise<{}>" + "\"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"long\" | \"double\"" ], "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.SavedObjectsClientCommon.delete.$1", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "dataViews", - "id": "def-common.SavedObjectsClientCommon.delete.$2", - "type": "string", - "tags": [], - "label": "id", - "description": [], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] + "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "dataViews", - "id": "def-common.SavedObjectsClientCommonFindArgs", + "id": "def-common.SavedObject", "type": "Interface", "tags": [], - "label": "SavedObjectsClientCommonFindArgs", + "label": "SavedObject", "description": [], - "path": "src/plugins/data_views/common/types.ts", + "signature": [ + "SavedObject", + "" + ], + "path": "src/core/types/saved_objects.ts", "deprecated": false, "children": [ { "parentPluginId": "dataViews", - "id": "def-common.SavedObjectsClientCommonFindArgs.type", - "type": "CompoundType", + "id": "def-common.SavedObject.id", + "type": "string", + "tags": [], + "label": "id", + "description": [ + "The ID of this Saved Object, guaranteed to be unique for all objects of the same `type`" + ], + "path": "src/core/types/saved_objects.ts", + "deprecated": false + }, + { + "parentPluginId": "dataViews", + "id": "def-common.SavedObject.type", + "type": "string", "tags": [], "label": "type", + "description": [ + " The type of Saved Object. Each plugin can define it's own custom Saved Object types." + ], + "path": "src/core/types/saved_objects.ts", + "deprecated": false + }, + { + "parentPluginId": "dataViews", + "id": "def-common.SavedObject.version", + "type": "string", + "tags": [], + "label": "version", + "description": [ + "An opaque version number which changes on each successful write operation. Can be used for implementing optimistic concurrency control." + ], + "signature": [ + "string | undefined" + ], + "path": "src/core/types/saved_objects.ts", + "deprecated": false + }, + { + "parentPluginId": "dataViews", + "id": "def-common.SavedObject.updated_at", + "type": "string", + "tags": [], + "label": "updated_at", + "description": [ + "Timestamp of the last time this document had been updated." + ], + "signature": [ + "string | undefined" + ], + "path": "src/core/types/saved_objects.ts", + "deprecated": false + }, + { + "parentPluginId": "dataViews", + "id": "def-common.SavedObject.error", + "type": "Object", + "tags": [], + "label": "error", "description": [], "signature": [ - "string | string[]" + "SavedObjectError", + " | undefined" + ], + "path": "src/core/types/saved_objects.ts", + "deprecated": false + }, + { + "parentPluginId": "dataViews", + "id": "def-common.SavedObject.attributes", + "type": "Uncategorized", + "tags": [], + "label": "attributes", + "description": [ + "{@inheritdoc SavedObjectAttributes}" + ], + "signature": [ + "T" ], - "path": "src/plugins/data_views/common/types.ts", + "path": "src/core/types/saved_objects.ts", "deprecated": false }, { "parentPluginId": "dataViews", - "id": "def-common.SavedObjectsClientCommonFindArgs.fields", + "id": "def-common.SavedObject.references", "type": "Array", "tags": [], - "label": "fields", - "description": [], + "label": "references", + "description": [ + "{@inheritdoc SavedObjectReference}" + ], "signature": [ - "string[] | undefined" + "SavedObjectReference", + "[]" ], - "path": "src/plugins/data_views/common/types.ts", + "path": "src/core/types/saved_objects.ts", "deprecated": false }, { "parentPluginId": "dataViews", - "id": "def-common.SavedObjectsClientCommonFindArgs.perPage", - "type": "number", + "id": "def-common.SavedObject.migrationVersion", + "type": "Object", "tags": [], - "label": "perPage", - "description": [], + "label": "migrationVersion", + "description": [ + "{@inheritdoc SavedObjectsMigrationVersion}" + ], "signature": [ - "number | undefined" + "SavedObjectsMigrationVersion", + " | undefined" ], - "path": "src/plugins/data_views/common/types.ts", + "path": "src/core/types/saved_objects.ts", "deprecated": false }, { "parentPluginId": "dataViews", - "id": "def-common.SavedObjectsClientCommonFindArgs.search", + "id": "def-common.SavedObject.coreMigrationVersion", "type": "string", "tags": [], - "label": "search", - "description": [], + "label": "coreMigrationVersion", + "description": [ + "A semver value that is used when upgrading objects between Kibana versions." + ], "signature": [ "string | undefined" ], - "path": "src/plugins/data_views/common/types.ts", + "path": "src/core/types/saved_objects.ts", "deprecated": false }, { "parentPluginId": "dataViews", - "id": "def-common.SavedObjectsClientCommonFindArgs.searchFields", + "id": "def-common.SavedObject.namespaces", "type": "Array", "tags": [], - "label": "searchFields", - "description": [], + "label": "namespaces", + "description": [ + "\nSpace(s) that this saved object exists in. This attribute is not used for \"global\" saved object types which are registered with\n`namespaceType: 'agnostic'`." + ], "signature": [ "string[] | undefined" ], - "path": "src/plugins/data_views/common/types.ts", + "path": "src/core/types/saved_objects.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.SourceFilter", - "type": "Interface", - "tags": [], - "label": "SourceFilter", - "description": [], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "dataViews", - "id": "def-common.SourceFilter.value", + "id": "def-common.SavedObject.originId", "type": "string", "tags": [], - "label": "value", - "description": [], - "path": "src/plugins/data_views/common/types.ts", + "label": "originId", + "description": [ + "\nThe ID of the saved object this originated from. This is set if this object's `id` was regenerated; that can happen during migration\nfrom a legacy single-namespace type, or during import. It is only set during migration or create operations. This is used during import\nto ensure that ID regeneration is deterministic, so saved objects will be overwritten if they are imported multiple times into a given\nspace." + ], + "signature": [ + "string | undefined" + ], + "path": "src/core/types/saved_objects.ts", "deprecated": false } ], @@ -20849,190 +19846,228 @@ }, { "parentPluginId": "dataViews", - "id": "def-common.TimeBasedDataView", + "id": "def-common.SavedObjectsClientCommon", "type": "Interface", "tags": [], - "label": "TimeBasedDataView", + "label": "SavedObjectsClientCommon", "description": [ - "\nAn interface representing a data view that is time based." - ], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.TimeBasedDataView", - "text": "TimeBasedDataView" - }, - " extends ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - } + "\nCommon interface for the saved objects client" ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", + "path": "src/plugins/data_views/common/types.ts", "deprecated": false, "children": [ { "parentPluginId": "dataViews", - "id": "def-common.TimeBasedDataView.timeFieldName", - "type": "string", - "tags": [], - "label": "timeFieldName", - "description": [], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.TimeBasedDataView.getTimeField", + "id": "def-common.SavedObjectsClientCommon.find", "type": "Function", "tags": [], - "label": "getTimeField", - "description": [], - "signature": [ - "() => ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" - } + "label": "find", + "description": [ + "\nSearch for saved objects" ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.TypeMeta", - "type": "Interface", - "tags": [], - "label": "TypeMeta", - "description": [], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.TypeMeta.aggs", - "type": "Object", - "tags": [], - "label": "aggs", - "description": [], "signature": [ - "Record(options: ", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.AggregationRestrictions", - "text": "AggregationRestrictions" + "section": "def-common.SavedObjectsClientCommonFindArgs", + "text": "SavedObjectsClientCommonFindArgs" }, - "> | undefined" + ") => Promise<", + "SavedObject", + "[]>" ], "path": "src/plugins/data_views/common/types.ts", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.SavedObjectsClientCommon.find.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [ + "- options for search" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.SavedObjectsClientCommonFindArgs", + "text": "SavedObjectsClientCommonFindArgs" + } + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "dataViews", - "id": "def-common.TypeMeta.params", - "type": "Object", + "id": "def-common.SavedObjectsClientCommon.get", + "type": "Function", "tags": [], - "label": "params", - "description": [], + "label": "get", + "description": [ + "\nGet a single saved object by id" + ], "signature": [ - "{ rollup_index: string; } | undefined" + "(type: string, id: string) => Promise<", + "SavedObject", + ">" ], "path": "src/plugins/data_views/common/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.UiSettingsCommon", - "type": "Interface", - "tags": [], - "label": "UiSettingsCommon", - "description": [], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "children": [ + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.SavedObjectsClientCommon.get.$1", + "type": "string", + "tags": [], + "label": "type", + "description": [ + "- type of saved object" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "dataViews", + "id": "def-common.SavedObjectsClientCommon.get.$2", + "type": "string", + "tags": [], + "label": "id", + "description": [ + "- id of saved object" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, { "parentPluginId": "dataViews", - "id": "def-common.UiSettingsCommon.get", + "id": "def-common.SavedObjectsClientCommon.update", "type": "Function", "tags": [], - "label": "get", - "description": [], + "label": "update", + "description": [ + "\nUpdate a saved object by id" + ], "signature": [ - "(key: string) => Promise" + "(type: string, id: string, attributes: Record, options: Record) => Promise<", + "SavedObject", + ">" ], "path": "src/plugins/data_views/common/types.ts", "deprecated": false, "children": [ { "parentPluginId": "dataViews", - "id": "def-common.UiSettingsCommon.get.$1", + "id": "def-common.SavedObjectsClientCommon.update.$1", "type": "string", "tags": [], - "label": "key", - "description": [], + "label": "type", + "description": [ + "- type of saved object" + ], "signature": [ "string" ], "path": "src/plugins/data_views/common/types.ts", "deprecated": false, "isRequired": true + }, + { + "parentPluginId": "dataViews", + "id": "def-common.SavedObjectsClientCommon.update.$2", + "type": "string", + "tags": [], + "label": "id", + "description": [ + "- id of saved object" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "dataViews", + "id": "def-common.SavedObjectsClientCommon.update.$3", + "type": "Object", + "tags": [], + "label": "attributes", + "description": [ + "- attributes to update" + ], + "signature": [ + "Record" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "dataViews", + "id": "def-common.SavedObjectsClientCommon.update.$4", + "type": "Object", + "tags": [], + "label": "options", + "description": [ + "- client options" + ], + "signature": [ + "Record" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "dataViews", - "id": "def-common.UiSettingsCommon.getAll", + "id": "def-common.SavedObjectsClientCommon.create", "type": "Function", "tags": [], - "label": "getAll", - "description": [], - "signature": [ - "() => Promise>" + "label": "create", + "description": [ + "\nCreate a saved object" ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "dataViews", - "id": "def-common.UiSettingsCommon.set", - "type": "Function", - "tags": [], - "label": "set", - "description": [], "signature": [ - "(key: string, value: any) => Promise" + "(type: string, attributes: Record, options: Record) => Promise<", + "SavedObject", + ">" ], "path": "src/plugins/data_views/common/types.ts", "deprecated": false, "children": [ { "parentPluginId": "dataViews", - "id": "def-common.UiSettingsCommon.set.$1", + "id": "def-common.SavedObjectsClientCommon.create.$1", "type": "string", "tags": [], - "label": "key", - "description": [], + "label": "type", + "description": [ + "- type of saved object" + ], "signature": [ "string" ], @@ -21042,13 +20077,31 @@ }, { "parentPluginId": "dataViews", - "id": "def-common.UiSettingsCommon.set.$2", - "type": "Any", + "id": "def-common.SavedObjectsClientCommon.create.$2", + "type": "Object", "tags": [], - "label": "value", - "description": [], + "label": "attributes", + "description": [ + "- attributes to set" + ], "signature": [ - "any" + "Record" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "dataViews", + "id": "def-common.SavedObjectsClientCommon.create.$3", + "type": "Object", + "tags": [], + "label": "options", + "description": [ + "- client options" + ], + "signature": [ + "Record" ], "path": "src/plugins/data_views/common/types.ts", "deprecated": false, @@ -21059,24 +20112,44 @@ }, { "parentPluginId": "dataViews", - "id": "def-common.UiSettingsCommon.remove", + "id": "def-common.SavedObjectsClientCommon.delete", "type": "Function", "tags": [], - "label": "remove", - "description": [], + "label": "delete", + "description": [ + "\nDelete a saved object by id" + ], "signature": [ - "(key: string) => Promise" + "(type: string, id: string) => Promise<{}>" ], "path": "src/plugins/data_views/common/types.ts", "deprecated": false, "children": [ { "parentPluginId": "dataViews", - "id": "def-common.UiSettingsCommon.remove.$1", + "id": "def-common.SavedObjectsClientCommon.delete.$1", "type": "string", "tags": [], - "label": "key", - "description": [], + "label": "type", + "description": [ + "- type of saved object" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "dataViews", + "id": "def-common.SavedObjectsClientCommon.delete.$2", + "type": "string", + "tags": [], + "label": "id", + "description": [ + "- id of saved object" + ], "signature": [ "string" ], @@ -21089,325 +20162,471 @@ } ], "initialIsOpen": false - } - ], - "enums": [ - { - "parentPluginId": "dataViews", - "id": "def-common.DataViewType", - "type": "Enum", - "tags": [], - "label": "DataViewType", - "description": [], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "initialIsOpen": false - } - ], - "misc": [ + }, { "parentPluginId": "dataViews", - "id": "def-common.AggregationRestrictions", - "type": "Type", + "id": "def-common.SavedObjectsClientCommonFindArgs", + "type": "Interface", "tags": [], - "label": "AggregationRestrictions", - "description": [], - "signature": [ - "{ [x: string]: { agg?: string | undefined; interval?: number | undefined; fixed_interval?: string | undefined; calendar_interval?: string | undefined; delay?: string | undefined; time_zone?: string | undefined; }; }" + "label": "SavedObjectsClientCommonFindArgs", + "description": [ + "\nSaved objects common find args" ], "path": "src/plugins/data_views/common/types.ts", "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.DATA_VIEW_SAVED_OBJECT_TYPE", - "type": "string", - "tags": [], - "label": "DATA_VIEW_SAVED_OBJECT_TYPE", - "description": [], - "signature": [ - "\"index-pattern\"" + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.SavedObjectsClientCommonFindArgs.type", + "type": "CompoundType", + "tags": [], + "label": "type", + "description": [ + "\nSaved object type" + ], + "signature": [ + "string | string[]" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false + }, + { + "parentPluginId": "dataViews", + "id": "def-common.SavedObjectsClientCommonFindArgs.fields", + "type": "Array", + "tags": [], + "label": "fields", + "description": [ + "\nSaved object fields" + ], + "signature": [ + "string[] | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false + }, + { + "parentPluginId": "dataViews", + "id": "def-common.SavedObjectsClientCommonFindArgs.perPage", + "type": "number", + "tags": [], + "label": "perPage", + "description": [ + "\nResults per page" + ], + "signature": [ + "number | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false + }, + { + "parentPluginId": "dataViews", + "id": "def-common.SavedObjectsClientCommonFindArgs.search", + "type": "string", + "tags": [], + "label": "search", + "description": [ + "\nQuery string" + ], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false + }, + { + "parentPluginId": "dataViews", + "id": "def-common.SavedObjectsClientCommonFindArgs.searchFields", + "type": "Array", + "tags": [], + "label": "searchFields", + "description": [ + "\nFields to search" + ], + "signature": [ + "string[] | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false + } ], - "path": "src/plugins/data_views/common/constants.ts", - "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "dataViews", - "id": "def-common.DataViewFieldMap", - "type": "Type", + "id": "def-common.SourceFilter", + "type": "Interface", "tags": [], - "label": "DataViewFieldMap", + "label": "SourceFilter", "description": [], - "signature": [ - "{ [x: string]: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - "; }" - ], "path": "src/plugins/data_views/common/types.ts", "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.SourceFilter.value", + "type": "string", + "tags": [], + "label": "value", + "description": [], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { "parentPluginId": "dataViews", - "id": "def-common.DataViewsContract", - "type": "Type", + "id": "def-common.TimeBasedDataView", + "type": "Interface", "tags": [], - "label": "DataViewsContract", - "description": [], + "label": "TimeBasedDataView", + "description": [ + "\nAn interface representing a data view that is time based." + ], "signature": [ - "{ create: (spec: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" - }, - ", skipFetchFields?: boolean) => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - ">; delete: (indexPatternId: string) => Promise<{}>; find: (search: string, size?: number) => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - "[]>; get: (id: string) => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - ">; getCanSave: () => Promise; ensureDefaultDataView: ", - "EnsureDefaultDataView", - "; getIds: (refresh?: boolean) => Promise; getTitles: (refresh?: boolean) => Promise; getIdsWithTitle: (refresh?: boolean) => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewListItem", - "text": "DataViewListItem" - }, - "[]>; clearCache: (id?: string | undefined) => void; getCache: () => Promise<", - "SavedObject", - "<", - "IndexPatternSavedObjectAttrs", - ">[] | null | undefined>; getDefault: () => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - " | null>; getDefaultId: () => Promise; setDefault: (id: string | null, force?: boolean) => Promise; hasUserDataView: () => Promise; getFieldsForWildcard: (options: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.GetFieldsOptions", - "text": "GetFieldsOptions" - }, - ") => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - "[]>; getFieldsForIndexPattern: (indexPattern: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - " | ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" - }, - ", options?: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.GetFieldsOptions", - "text": "GetFieldsOptions" - }, - " | undefined) => Promise<", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" + "section": "def-common.TimeBasedDataView", + "text": "TimeBasedDataView" }, - "[]>; refreshFields: (indexPattern: ", + " extends ", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", "section": "def-common.DataView", "text": "DataView" - }, - ") => Promise; fieldArrayToMap: (fields: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - "[], fieldAttrs?: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldAttrs", - "text": "FieldAttrs" - }, - " | undefined) => ", + } + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [ { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewFieldMap", - "text": "DataViewFieldMap" + "parentPluginId": "dataViews", + "id": "def-common.TimeBasedDataView.timeFieldName", + "type": "string", + "tags": [], + "label": "timeFieldName", + "description": [ + "\nThe timestamp field name." + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false }, - "; savedObjectToSpec: (savedObject: ", - "SavedObject", - "<", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewAttributes", - "text": "DataViewAttributes" - }, - ">) => ", + "parentPluginId": "dataViews", + "id": "def-common.TimeBasedDataView.getTimeField", + "type": "Function", + "tags": [], + "label": "getTimeField", + "description": [ + "\nThe timestamp field." + ], + "signature": [ + "() => ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewField", + "text": "DataViewField" + } + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "dataViews", + "id": "def-common.ToSpecConfig", + "type": "Interface", + "tags": [], + "label": "ToSpecConfig", + "description": [ + "\nOptional format getter when serializing a field" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false, + "children": [ { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" - }, - "; createAndSave: (spec: ", + "parentPluginId": "dataViews", + "id": "def-common.ToSpecConfig.getFormatterForField", + "type": "Function", + "tags": [], + "label": "getFormatterForField", + "description": [ + "\nField format getter" + ], + "signature": [ + "((field: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewField", + "text": "DataViewField" + }, + " | ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + ") => ", + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.FieldFormat", + "text": "FieldFormat" + }, + ") | undefined" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "dataViews", + "id": "def-common.TypeMeta", + "type": "Interface", + "tags": [], + "label": "TypeMeta", + "description": [ + "\nInterface for metadata about rollup indices" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "children": [ { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" + "parentPluginId": "dataViews", + "id": "def-common.TypeMeta.aggs", + "type": "Object", + "tags": [], + "label": "aggs", + "description": [ + "\nAggregation restrictions for rollup fields" + ], + "signature": [ + "Record | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, - ", override?: boolean, skipFetchFields?: boolean) => Promise<", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - ">; createSavedObject: (indexPattern: ", + "parentPluginId": "dataViews", + "id": "def-common.TypeMeta.params", + "type": "Object", + "tags": [], + "label": "params", + "description": [ + "\nParams for retrieving rollup field data" + ], + "signature": [ + "{ rollup_index: string; } | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "dataViews", + "id": "def-common.UiSettingsCommon", + "type": "Interface", + "tags": [], + "label": "UiSettingsCommon", + "description": [ + "\nInterface for UiSettings common interface {@link UiSettingsClient}" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "children": [ { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" + "parentPluginId": "dataViews", + "id": "def-common.UiSettingsCommon.get", + "type": "Function", + "tags": [], + "label": "get", + "description": [ + "\nGet a setting value" + ], + "signature": [ + "(key: string) => Promise" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.UiSettingsCommon.get.$1", + "type": "string", + "tags": [], + "label": "key", + "description": [ + "name of value" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, - ", override?: boolean) => Promise<", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" + "parentPluginId": "dataViews", + "id": "def-common.UiSettingsCommon.getAll", + "type": "Function", + "tags": [], + "label": "getAll", + "description": [ + "\nGet all settings values" + ], + "signature": [ + "() => Promise>" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, - ">; updateSavedObject: (indexPattern: ", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" + "parentPluginId": "dataViews", + "id": "def-common.UiSettingsCommon.set", + "type": "Function", + "tags": [], + "label": "set", + "description": [ + "\nSet a setting value" + ], + "signature": [ + "(key: string, value: T) => Promise" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.UiSettingsCommon.set.$1", + "type": "string", + "tags": [], + "label": "key", + "description": [ + "name of value" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "dataViews", + "id": "def-common.UiSettingsCommon.set.$2", + "type": "Uncategorized", + "tags": [], + "label": "value", + "description": [ + "value to set" + ], + "signature": [ + "T" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, - ", saveAttempts?: number, ignoreErrors?: boolean) => Promise; getDefaultDataView: () => Promise<", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - " | null>; }" + "parentPluginId": "dataViews", + "id": "def-common.UiSettingsCommon.remove", + "type": "Function", + "tags": [], + "label": "remove", + "description": [ + "\nRemove a setting value" + ], + "signature": [ + "(key: string) => Promise" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.UiSettingsCommon.remove.$1", + "type": "string", + "tags": [], + "label": "key", + "description": [ + "name of value" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, "initialIsOpen": false - }, + } + ], + "enums": [ { "parentPluginId": "dataViews", - "id": "def-common.FieldFormatMap", - "type": "Type", + "id": "def-common.DataViewType", + "type": "Enum", "tags": [], - "label": "FieldFormatMap", - "description": [], - "signature": [ - "{ [x: string]: ", - { - "pluginId": "fieldFormats", - "scope": "common", - "docId": "kibFieldFormatsPluginApi", - "section": "def-common.SerializedFieldFormat", - "text": "SerializedFieldFormat" - }, - "<", - { - "pluginId": "fieldFormats", - "scope": "common", - "docId": "kibFieldFormatsPluginApi", - "section": "def-common.FieldFormatParams", - "text": "FieldFormatParams" - }, - ">; }" + "label": "DataViewType", + "description": [ + "\nData View type. Default or rollup" ], "path": "src/plugins/data_views/common/types.ts", "deprecated": false, "initialIsOpen": false - }, + } + ], + "misc": [ { "parentPluginId": "dataViews", - "id": "def-common.FieldSpecConflictDescriptions", + "id": "def-common.AggregationRestrictions", "type": "Type", "tags": [], - "label": "FieldSpecConflictDescriptions", + "label": "AggregationRestrictions", "description": [], "signature": [ - "{ [x: string]: string[]; }" + "{ [x: string]: { agg?: string | undefined; interval?: number | undefined; fixed_interval?: string | undefined; calendar_interval?: string | undefined; delay?: string | undefined; time_zone?: string | undefined; }; }" ], "path": "src/plugins/data_views/common/types.ts", "deprecated": false, @@ -21415,100 +20634,51 @@ }, { "parentPluginId": "dataViews", - "id": "def-common.IndexPatternAttributes", - "type": "Type", - "tags": [ - "deprecated" + "id": "def-common.DATA_VIEW_SAVED_OBJECT_TYPE", + "type": "string", + "tags": [], + "label": "DATA_VIEW_SAVED_OBJECT_TYPE", + "description": [ + "\nData view saved object type." ], - "label": "IndexPatternAttributes", - "description": [], "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewAttributes", - "text": "DataViewAttributes" - } - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": true, - "references": [ - { - "plugin": "data", - "path": "src/plugins/data/common/index.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/index.ts" - }, - { - "plugin": "canvas", - "path": "x-pack/plugins/canvas/public/lib/es_service.ts" - }, - { - "plugin": "canvas", - "path": "x-pack/plugins/canvas/public/lib/es_service.ts" - }, - { - "plugin": "canvas", - "path": "x-pack/plugins/canvas/public/lib/es_service.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/server/index.ts" - } + "\"index-pattern\"" ], + "path": "src/plugins/data_views/common/constants.ts", + "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "dataViews", - "id": "def-common.IndexPatternLoadExpressionFunctionDefinition", + "id": "def-common.DataViewFieldMap", "type": "Type", "tags": [], - "label": "IndexPatternLoadExpressionFunctionDefinition", + "label": "DataViewFieldMap", "description": [], "signature": [ + "{ [x: string]: ", { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"indexPatternLoad\", null, Arguments, Output, ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutionContext", - "text": "ExecutionContext" - }, - "<", - { - "pluginId": "inspector", + "pluginId": "dataViews", "scope": "common", - "docId": "kibInspectorPluginApi", - "section": "def-common.Adapters", - "text": "Adapters" + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" }, - ", ", - "SerializableRecord", - ">>" + "; }" ], - "path": "src/plugins/data_views/common/expressions/load_index_pattern.ts", + "path": "src/plugins/data_views/common/types.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "dataViews", - "id": "def-common.IndexPatternsContract", + "id": "def-common.DataViewsContract", "type": "Type", - "tags": [ - "deprecated" + "tags": [], + "label": "DataViewsContract", + "description": [ + "\nData views service interface" ], - "label": "IndexPatternsContract", - "description": [], "signature": [ "{ create: (spec: ", { @@ -21542,9 +20712,7 @@ "section": "def-common.DataView", "text": "DataView" }, - ">; getCanSave: () => Promise; ensureDefaultDataView: ", - "EnsureDefaultDataView", - "; getIds: (refresh?: boolean) => Promise; getTitles: (refresh?: boolean) => Promise; getIdsWithTitle: (refresh?: boolean) => Promise<", + ">; getCanSave: () => Promise; getIds: (refresh?: boolean) => Promise; getTitles: (refresh?: boolean) => Promise; getIdsWithTitle: (refresh?: boolean) => Promise<", { "pluginId": "dataViews", "scope": "common", @@ -21555,7 +20723,7 @@ "[]>; clearCache: (id?: string | undefined) => void; getCache: () => Promise<", "SavedObject", "<", - "IndexPatternSavedObjectAttrs", + "DataViewSavedObjectAttrs", ">[] | null | undefined>; getDefault: () => Promise<", { "pluginId": "dataViews", @@ -21678,7 +20846,7 @@ "section": "def-common.DataView", "text": "DataView" }, - ">; createSavedObject: (indexPattern: ", + ">; createSavedObject: (dataView: ", { "pluginId": "dataViews", "scope": "common", @@ -21713,133 +20881,90 @@ " | null>; }" ], "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": true, - "references": [ - { - "plugin": "data", - "path": "src/plugins/data/common/index.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/create_search_source.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/create_search_source.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source_service.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source_service.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/expressions/esaggs/esaggs_fn.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/expressions/esaggs/esaggs_fn.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/search/types.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/search/types.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/create_search_source.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/create_search_source.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/create_search_source.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source_service.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source_service.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/search/expressions/esaggs.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/search/expressions/esaggs.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/server/search/expressions/esaggs.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/server/search/expressions/esaggs.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/services.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/services.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/index.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/search/aggs/aggs_service.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/search/aggs/aggs_service.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/search/search_service.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/search/search_service.ts" - }, + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "dataViews", + "id": "def-common.FieldFormatMap", + "type": "Type", + "tags": [], + "label": "FieldFormatMap", + "description": [], + "signature": [ + "{ [x: string]: ", { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/lazy_load_bundle/index.ts" + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.SerializedFieldFormat", + "text": "SerializedFieldFormat" }, + "<", { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/lazy_load_bundle/index.ts" + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.FieldFormatParams", + "text": "FieldFormatParams" }, + ">; }" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "dataViews", + "id": "def-common.FieldSpecConflictDescriptions", + "type": "Type", + "tags": [], + "label": "FieldSpecConflictDescriptions", + "description": [], + "signature": [ + "{ [x: string]: string[]; }" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "dataViews", + "id": "def-common.IndexPatternLoadExpressionFunctionDefinition", + "type": "Type", + "tags": [], + "label": "IndexPatternLoadExpressionFunctionDefinition", + "description": [], + "signature": [ { - "plugin": "data", - "path": "src/plugins/data/public/actions/filters/create_filters_from_range_select.test.ts" + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" }, + "<\"indexPatternLoad\", null, Arguments, Output, ", { - "plugin": "data", - "path": "src/plugins/data/public/actions/filters/create_filters_from_range_select.test.ts" + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" }, + "<", { - "plugin": "data", - "path": "src/plugins/data/public/actions/filters/create_filters_from_value_click.test.ts" + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" }, - { - "plugin": "data", - "path": "src/plugins/data/public/actions/filters/create_filters_from_value_click.test.ts" - } + ", ", + "SerializableRecord", + ">>" ], + "path": "src/plugins/data_views/common/expressions/load_index_pattern.ts", + "deprecated": false, "initialIsOpen": false }, { @@ -21848,7 +20973,9 @@ "type": "string", "tags": [], "label": "META_FIELDS", - "description": [], + "description": [ + "\nUiSettings key for metaFields list." + ], "signature": [ "\"metaFields\"" ], @@ -21862,7 +20989,9 @@ "type": "Type", "tags": [], "label": "OnError", - "description": [], + "description": [ + "\nHandler for data view errors" + ], "signature": [ "(error: Error, toastInputFields: ", { @@ -21884,7 +21013,9 @@ "type": "Object", "tags": [], "label": "error", - "description": [], + "description": [ + "Error object" + ], "signature": [ "Error" ], @@ -21897,7 +21028,9 @@ "type": "Object", "tags": [], "label": "toastInputFields", - "description": [], + "description": [ + "Toast notif config" + ], "signature": [ { "pluginId": "core", @@ -21916,7 +21049,9 @@ "type": "string", "tags": [], "label": "key", - "description": [], + "description": [ + "Used to dedupe notifs" + ], "path": "src/plugins/data_views/common/types.ts", "deprecated": false } @@ -21929,7 +21064,9 @@ "type": "Type", "tags": [], "label": "OnNotification", - "description": [], + "description": [ + "\nHandler for data view notifications" + ], "signature": [ "(toastInputFields: ", { @@ -21951,11 +21088,13 @@ "type": "CompoundType", "tags": [], "label": "toastInputFields", - "description": [], + "description": [ + "Toast notif config" + ], "signature": [ "Pick<", "Toast", - ", \"children\" | \"color\" | \"className\" | \"onChange\" | \"onKeyDown\" | \"onClick\" | \"security\" | \"defaultValue\" | \"hidden\" | \"defaultChecked\" | \"suppressContentEditableWarning\" | \"suppressHydrationWarning\" | \"accessKey\" | \"contentEditable\" | \"contextMenu\" | \"dir\" | \"draggable\" | \"lang\" | \"placeholder\" | \"slot\" | \"spellCheck\" | \"style\" | \"tabIndex\" | \"translate\" | \"radioGroup\" | \"role\" | \"about\" | \"datatype\" | \"inlist\" | \"prefix\" | \"property\" | \"resource\" | \"typeof\" | \"vocab\" | \"autoCapitalize\" | \"autoCorrect\" | \"autoSave\" | \"itemProp\" | \"itemScope\" | \"itemType\" | \"itemID\" | \"itemRef\" | \"results\" | \"unselectable\" | \"inputMode\" | \"is\" | \"aria-activedescendant\" | \"aria-atomic\" | \"aria-autocomplete\" | \"aria-busy\" | \"aria-checked\" | \"aria-colcount\" | \"aria-colindex\" | \"aria-colspan\" | \"aria-controls\" | \"aria-current\" | \"aria-describedby\" | \"aria-details\" | \"aria-disabled\" | \"aria-dropeffect\" | \"aria-errormessage\" | \"aria-expanded\" | \"aria-flowto\" | \"aria-grabbed\" | \"aria-haspopup\" | \"aria-hidden\" | \"aria-invalid\" | \"aria-keyshortcuts\" | \"aria-label\" | \"aria-labelledby\" | \"aria-level\" | \"aria-live\" | \"aria-modal\" | \"aria-multiline\" | \"aria-multiselectable\" | \"aria-orientation\" | \"aria-owns\" | \"aria-placeholder\" | \"aria-posinset\" | \"aria-pressed\" | \"aria-readonly\" | \"aria-relevant\" | \"aria-required\" | \"aria-roledescription\" | \"aria-rowcount\" | \"aria-rowindex\" | \"aria-rowspan\" | \"aria-selected\" | \"aria-setsize\" | \"aria-sort\" | \"aria-valuemax\" | \"aria-valuemin\" | \"aria-valuenow\" | \"aria-valuetext\" | \"dangerouslySetInnerHTML\" | \"onCopy\" | \"onCopyCapture\" | \"onCut\" | \"onCutCapture\" | \"onPaste\" | \"onPasteCapture\" | \"onCompositionEnd\" | \"onCompositionEndCapture\" | \"onCompositionStart\" | \"onCompositionStartCapture\" | \"onCompositionUpdate\" | \"onCompositionUpdateCapture\" | \"onFocus\" | \"onFocusCapture\" | \"onBlur\" | \"onBlurCapture\" | \"onChangeCapture\" | \"onBeforeInput\" | \"onBeforeInputCapture\" | \"onInput\" | \"onInputCapture\" | \"onReset\" | \"onResetCapture\" | \"onSubmit\" | \"onSubmitCapture\" | \"onInvalid\" | \"onInvalidCapture\" | \"onLoad\" | \"onLoadCapture\" | \"onError\" | \"onErrorCapture\" | \"onKeyDownCapture\" | \"onKeyPress\" | \"onKeyPressCapture\" | \"onKeyUp\" | \"onKeyUpCapture\" | \"onAbort\" | \"onAbortCapture\" | \"onCanPlay\" | \"onCanPlayCapture\" | \"onCanPlayThrough\" | \"onCanPlayThroughCapture\" | \"onDurationChange\" | \"onDurationChangeCapture\" | \"onEmptied\" | \"onEmptiedCapture\" | \"onEncrypted\" | \"onEncryptedCapture\" | \"onEnded\" | \"onEndedCapture\" | \"onLoadedData\" | \"onLoadedDataCapture\" | \"onLoadedMetadata\" | \"onLoadedMetadataCapture\" | \"onLoadStart\" | \"onLoadStartCapture\" | \"onPause\" | \"onPauseCapture\" | \"onPlay\" | \"onPlayCapture\" | \"onPlaying\" | \"onPlayingCapture\" | \"onProgress\" | \"onProgressCapture\" | \"onRateChange\" | \"onRateChangeCapture\" | \"onSeeked\" | \"onSeekedCapture\" | \"onSeeking\" | \"onSeekingCapture\" | \"onStalled\" | \"onStalledCapture\" | \"onSuspend\" | \"onSuspendCapture\" | \"onTimeUpdate\" | \"onTimeUpdateCapture\" | \"onVolumeChange\" | \"onVolumeChangeCapture\" | \"onWaiting\" | \"onWaitingCapture\" | \"onAuxClick\" | \"onAuxClickCapture\" | \"onClickCapture\" | \"onContextMenu\" | \"onContextMenuCapture\" | \"onDoubleClick\" | \"onDoubleClickCapture\" | \"onDrag\" | \"onDragCapture\" | \"onDragEnd\" | \"onDragEndCapture\" | \"onDragEnter\" | \"onDragEnterCapture\" | \"onDragExit\" | \"onDragExitCapture\" | \"onDragLeave\" | \"onDragLeaveCapture\" | \"onDragOver\" | \"onDragOverCapture\" | \"onDragStart\" | \"onDragStartCapture\" | \"onDrop\" | \"onDropCapture\" | \"onMouseDown\" | \"onMouseDownCapture\" | \"onMouseEnter\" | \"onMouseLeave\" | \"onMouseMove\" | \"onMouseMoveCapture\" | \"onMouseOut\" | \"onMouseOutCapture\" | \"onMouseOver\" | \"onMouseOverCapture\" | \"onMouseUp\" | \"onMouseUpCapture\" | \"onSelect\" | \"onSelectCapture\" | \"onTouchCancel\" | \"onTouchCancelCapture\" | \"onTouchEnd\" | \"onTouchEndCapture\" | \"onTouchMove\" | \"onTouchMoveCapture\" | \"onTouchStart\" | \"onTouchStartCapture\" | \"onPointerDown\" | \"onPointerDownCapture\" | \"onPointerMove\" | \"onPointerMoveCapture\" | \"onPointerUp\" | \"onPointerUpCapture\" | \"onPointerCancel\" | \"onPointerCancelCapture\" | \"onPointerEnter\" | \"onPointerEnterCapture\" | \"onPointerLeave\" | \"onPointerLeaveCapture\" | \"onPointerOver\" | \"onPointerOverCapture\" | \"onPointerOut\" | \"onPointerOutCapture\" | \"onGotPointerCapture\" | \"onGotPointerCaptureCapture\" | \"onLostPointerCapture\" | \"onLostPointerCaptureCapture\" | \"onScroll\" | \"onScrollCapture\" | \"onWheel\" | \"onWheelCapture\" | \"onAnimationStart\" | \"onAnimationStartCapture\" | \"onAnimationEnd\" | \"onAnimationEndCapture\" | \"onAnimationIteration\" | \"onAnimationIterationCapture\" | \"onTransitionEnd\" | \"onTransitionEndCapture\" | \"toastLifeTimeMs\" | \"iconType\" | \"onClose\" | \"data-test-subj\"> & { title?: string | ", + ", \"children\" | \"color\" | \"className\" | \"onChange\" | \"onKeyDown\" | \"onClick\" | \"security\" | \"defaultValue\" | \"hidden\" | \"lang\" | \"onError\" | \"defaultChecked\" | \"suppressContentEditableWarning\" | \"suppressHydrationWarning\" | \"accessKey\" | \"contentEditable\" | \"contextMenu\" | \"dir\" | \"draggable\" | \"placeholder\" | \"slot\" | \"spellCheck\" | \"style\" | \"tabIndex\" | \"translate\" | \"radioGroup\" | \"role\" | \"about\" | \"datatype\" | \"inlist\" | \"prefix\" | \"property\" | \"resource\" | \"typeof\" | \"vocab\" | \"autoCapitalize\" | \"autoCorrect\" | \"autoSave\" | \"itemProp\" | \"itemScope\" | \"itemType\" | \"itemID\" | \"itemRef\" | \"results\" | \"unselectable\" | \"inputMode\" | \"is\" | \"aria-activedescendant\" | \"aria-atomic\" | \"aria-autocomplete\" | \"aria-busy\" | \"aria-checked\" | \"aria-colcount\" | \"aria-colindex\" | \"aria-colspan\" | \"aria-controls\" | \"aria-current\" | \"aria-describedby\" | \"aria-details\" | \"aria-disabled\" | \"aria-dropeffect\" | \"aria-errormessage\" | \"aria-expanded\" | \"aria-flowto\" | \"aria-grabbed\" | \"aria-haspopup\" | \"aria-hidden\" | \"aria-invalid\" | \"aria-keyshortcuts\" | \"aria-label\" | \"aria-labelledby\" | \"aria-level\" | \"aria-live\" | \"aria-modal\" | \"aria-multiline\" | \"aria-multiselectable\" | \"aria-orientation\" | \"aria-owns\" | \"aria-placeholder\" | \"aria-posinset\" | \"aria-pressed\" | \"aria-readonly\" | \"aria-relevant\" | \"aria-required\" | \"aria-roledescription\" | \"aria-rowcount\" | \"aria-rowindex\" | \"aria-rowspan\" | \"aria-selected\" | \"aria-setsize\" | \"aria-sort\" | \"aria-valuemax\" | \"aria-valuemin\" | \"aria-valuenow\" | \"aria-valuetext\" | \"dangerouslySetInnerHTML\" | \"onCopy\" | \"onCopyCapture\" | \"onCut\" | \"onCutCapture\" | \"onPaste\" | \"onPasteCapture\" | \"onCompositionEnd\" | \"onCompositionEndCapture\" | \"onCompositionStart\" | \"onCompositionStartCapture\" | \"onCompositionUpdate\" | \"onCompositionUpdateCapture\" | \"onFocus\" | \"onFocusCapture\" | \"onBlur\" | \"onBlurCapture\" | \"onChangeCapture\" | \"onBeforeInput\" | \"onBeforeInputCapture\" | \"onInput\" | \"onInputCapture\" | \"onReset\" | \"onResetCapture\" | \"onSubmit\" | \"onSubmitCapture\" | \"onInvalid\" | \"onInvalidCapture\" | \"onLoad\" | \"onLoadCapture\" | \"onErrorCapture\" | \"onKeyDownCapture\" | \"onKeyPress\" | \"onKeyPressCapture\" | \"onKeyUp\" | \"onKeyUpCapture\" | \"onAbort\" | \"onAbortCapture\" | \"onCanPlay\" | \"onCanPlayCapture\" | \"onCanPlayThrough\" | \"onCanPlayThroughCapture\" | \"onDurationChange\" | \"onDurationChangeCapture\" | \"onEmptied\" | \"onEmptiedCapture\" | \"onEncrypted\" | \"onEncryptedCapture\" | \"onEnded\" | \"onEndedCapture\" | \"onLoadedData\" | \"onLoadedDataCapture\" | \"onLoadedMetadata\" | \"onLoadedMetadataCapture\" | \"onLoadStart\" | \"onLoadStartCapture\" | \"onPause\" | \"onPauseCapture\" | \"onPlay\" | \"onPlayCapture\" | \"onPlaying\" | \"onPlayingCapture\" | \"onProgress\" | \"onProgressCapture\" | \"onRateChange\" | \"onRateChangeCapture\" | \"onSeeked\" | \"onSeekedCapture\" | \"onSeeking\" | \"onSeekingCapture\" | \"onStalled\" | \"onStalledCapture\" | \"onSuspend\" | \"onSuspendCapture\" | \"onTimeUpdate\" | \"onTimeUpdateCapture\" | \"onVolumeChange\" | \"onVolumeChangeCapture\" | \"onWaiting\" | \"onWaitingCapture\" | \"onAuxClick\" | \"onAuxClickCapture\" | \"onClickCapture\" | \"onContextMenu\" | \"onContextMenuCapture\" | \"onDoubleClick\" | \"onDoubleClickCapture\" | \"onDrag\" | \"onDragCapture\" | \"onDragEnd\" | \"onDragEndCapture\" | \"onDragEnter\" | \"onDragEnterCapture\" | \"onDragExit\" | \"onDragExitCapture\" | \"onDragLeave\" | \"onDragLeaveCapture\" | \"onDragOver\" | \"onDragOverCapture\" | \"onDragStart\" | \"onDragStartCapture\" | \"onDrop\" | \"onDropCapture\" | \"onMouseDown\" | \"onMouseDownCapture\" | \"onMouseEnter\" | \"onMouseLeave\" | \"onMouseMove\" | \"onMouseMoveCapture\" | \"onMouseOut\" | \"onMouseOutCapture\" | \"onMouseOver\" | \"onMouseOverCapture\" | \"onMouseUp\" | \"onMouseUpCapture\" | \"onSelect\" | \"onSelectCapture\" | \"onTouchCancel\" | \"onTouchCancelCapture\" | \"onTouchEnd\" | \"onTouchEndCapture\" | \"onTouchMove\" | \"onTouchMoveCapture\" | \"onTouchStart\" | \"onTouchStartCapture\" | \"onPointerDown\" | \"onPointerDownCapture\" | \"onPointerMove\" | \"onPointerMoveCapture\" | \"onPointerUp\" | \"onPointerUpCapture\" | \"onPointerCancel\" | \"onPointerCancelCapture\" | \"onPointerEnter\" | \"onPointerEnterCapture\" | \"onPointerLeave\" | \"onPointerLeaveCapture\" | \"onPointerOver\" | \"onPointerOverCapture\" | \"onPointerOut\" | \"onPointerOutCapture\" | \"onGotPointerCapture\" | \"onGotPointerCaptureCapture\" | \"onLostPointerCapture\" | \"onLostPointerCaptureCapture\" | \"onScroll\" | \"onScrollCapture\" | \"onWheel\" | \"onWheelCapture\" | \"onAnimationStart\" | \"onAnimationStartCapture\" | \"onAnimationEnd\" | \"onAnimationEndCapture\" | \"onAnimationIteration\" | \"onAnimationIterationCapture\" | \"onTransitionEnd\" | \"onTransitionEndCapture\" | \"toastLifeTimeMs\" | \"iconType\" | \"onClose\" | \"data-test-subj\"> & { title?: string | ", { "pluginId": "core", "scope": "public", @@ -21982,7 +21121,9 @@ "type": "string", "tags": [], "label": "key", - "description": [], + "description": [ + "Used to dedupe notifs" + ], "path": "src/plugins/data_views/common/types.ts", "deprecated": false } @@ -21995,13 +21136,31 @@ "type": "Type", "tags": [], "label": "RuntimeType", - "description": [], + "description": [ + "\nRuntime field - type of value returned" + ], "signature": [ "\"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"long\" | \"double\" | \"composite\"" ], "path": "src/plugins/data_views/common/types.ts", "deprecated": false, "initialIsOpen": false + }, + { + "parentPluginId": "dataViews", + "id": "def-common.RuntimeTypeExceptComposite", + "type": "Type", + "tags": [], + "label": "RuntimeTypeExceptComposite", + "description": [ + "\nPrimitive runtime field types" + ], + "signature": [ + "\"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"long\" | \"double\"" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "initialIsOpen": false } ], "objects": [ @@ -22086,7 +21245,9 @@ "type": "Object", "tags": [], "label": "RUNTIME_FIELD_TYPES", - "description": [], + "description": [ + "\nAll runtime field types." + ], "signature": [ "readonly [\"keyword\", \"long\", \"double\", \"date\", \"ip\", \"boolean\", \"geo_point\", \"composite\"]" ], diff --git a/api_docs/data_views.mdx b/api_docs/data_views.mdx index b1f53987893923..cfe8b58dbc190d 100644 --- a/api_docs/data_views.mdx +++ b/api_docs/data_views.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/dataViews title: "dataViews" image: https://source.unsplash.com/400x175/?github summary: API docs for the dataViews plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViews'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 866 | 3 | 714 | 15 | +| 987 | 1 | 187 | 1 | ## Client diff --git a/api_docs/data_visualizer.mdx b/api_docs/data_visualizer.mdx index 75c8e68cedce5e..a81971ba233367 100644 --- a/api_docs/data_visualizer.mdx +++ b/api_docs/data_visualizer.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/dataVisualizer title: "dataVisualizer" image: https://source.unsplash.com/400x175/?github summary: API docs for the dataVisualizer plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataVisualizer'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/deprecations_by_api.mdx b/api_docs/deprecations_by_api.mdx index 8864885c930910..386cdfa362ea16 100644 --- a/api_docs/deprecations_by_api.mdx +++ b/api_docs/deprecations_by_api.mdx @@ -3,7 +3,7 @@ id: kibDevDocsDeprecationsByApi slug: /kibana-dev-docs/api-meta/deprecated-api-list-by-api title: Deprecated API usage by API summary: A list of deprecated APIs, which plugins are still referencing them, and when they need to be removed by. -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. --- @@ -13,42 +13,24 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Deprecated API | Referencing plugin(s) | Remove By | | ---------------|-----------|-----------| -| | dataViews, maps, data | - | -| | dataViews, maps, data | - | -| | dataViews, discover, ux, savedObjects, dataViewEditor, maps, visDefaultEditor, data | - | -| | dataViews, dataViewEditor, maps, visDefaultEditor, data | - | -| | dataViews, unifiedSearch | - | -| | dataViews, canvas | - | -| | dataViews, unifiedSearch, data | - | -| | dataViews, canvas, data | - | -| | dataViews, maps, data | - | -| | dataViews, dataViewEditor, maps, visDefaultEditor, data | - | -| | dataViews, maps, data | - | -| | dataViews | - | -| | dataViews, discover, ux, savedObjects, dataViewEditor, maps, visDefaultEditor, data | - | -| | dataViews, maps | - | -| | dataViewManagement, dataViews | - | -| | visTypeTimeseries, graph, dataViewManagement, dataViews | - | -| | dataViews, dataViewManagement | - | -| | dataViews, canvas | - | -| | dataViews, dataViewEditor, maps, visDefaultEditor | - | -| | dataViews, discover, ux, savedObjects, dataViewEditor, maps, visDefaultEditor | - | -| | dataViews, maps | - | -| | dataViews, maps | - | -| | dataViewManagement, dataViews | - | -| | visTypeTimeseries, graph, dataViewManagement, dataViews | - | -| | dataViews, dataViewManagement | - | -| | discover, visualizations, dashboard, lens, maps, monitoring | - | -| | unifiedSearch, discover, maps, infra, graph, securitySolution, stackAlerts, inputControlVis, savedObjects | - | -| | maps | - | -| | data, infra, maps | - | | | alerting, discover, securitySolution | - | | | alerting, discover, securitySolution | - | +| | actions, alerting | - | +| | discover, visualizations, dashboard, lens, maps, monitoring | - | +| | unifiedSearch, discover, maps, infra, graph, securitySolution, stackAlerts, inputControlVis, savedObjects | - | | | data, discover, embeddable | - | | | advancedSettings, discover | - | | | advancedSettings, discover | - | +| | encryptedSavedObjects, actions, data, cloud, ml, logstash, securitySolution | - | +| | dashboard, lens, stackAlerts, visTypeTable, visTypeTimeseries, visTypeXy, visTypeVislib, expressionPartitionVis | - | | | management, observability, infra, apm, cloudSecurityPosture, enterpriseSearch, synthetics, ux, kibanaOverview | - | | | esUiShared, home, data, spaces, fleet, visualizations, lens, observability, ml, apm, cloudSecurityPosture, indexLifecycleManagement, synthetics, upgradeAssistant, ux, savedObjectsManagement, kibanaOverview | - | +| | dashboard | - | +| | dataViews, maps | - | +| | dataViews, maps | - | +| | maps | - | +| | management, spaces, observability, ml, canvas, cloudSecurityPosture, enterpriseSearch, osquery, kibanaOverview | - | +| | actions, ml, enterpriseSearch, savedObjectsTagging | - | | | canvas, visTypeXy | - | | | canvas | - | | | canvas | - | @@ -59,49 +41,50 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | canvas | - | | | canvas | - | | | canvas, visTypeXy | - | -| | management, spaces, observability, ml, canvas, cloudSecurityPosture, enterpriseSearch, osquery, kibanaOverview | - | -| | actions, alerting | - | -| | encryptedSavedObjects, actions, data, cloud, ml, logstash, securitySolution | - | -| | dashboard, lens, stackAlerts, visTypeTable, visTypeTimeseries, visTypeXy, visTypeVislib, expressionPartitionVis | - | -| | dashboard | - | -| | visTypeTimeseries, graph, dataViewManagement | - | +| | visTypeTimeseries, graph, dataViewManagement, dataViews | - | +| | visTypeTimeseries, graph, dataViewManagement, dataViews | - | | | visTypeTimeseries | - | +| | visTypeTimeseries, graph, dataViewManagement | - | +| | unifiedSearch | - | +| | unifiedSearch | - | +| | dataViewManagement, dataViews | - | +| | dataViews, dataViewManagement | - | +| | dataViewManagement, dataViews | - | +| | dataViews, dataViewManagement | - | | | dataViewManagement | - | | | dataViewManagement | - | -| | actions, ml, enterpriseSearch, savedObjectsTagging | - | | | spaces, savedObjectsManagement | - | | | spaces, savedObjectsManagement | - | | | visTypeGauge | - | | | visTypePie | - | | | visTypePie | - | | | console | - | +| | stackAlerts, alerting, securitySolution, inputControlVis | 8.1 | +| | stackAlerts, alerting, securitySolution, inputControlVis | 8.1 | +| | infra, discover, visualizations, dashboard, controls, uiActionsEnhanced, lens, maps, dataVisualizer, ml, fleet, canvas, dashboardEnhanced, discoverEnhanced, monitoring, securitySolution, urlDrilldown, visDefaultEditor, visTypeTimelion, visTypeTimeseries, visTypeVega, cases | 8.1 | | | discover, dashboard, lens, urlDrilldown | 8.1 | | | discover, dashboard, lens, urlDrilldown | 8.1 | +| | infra, discover, visualizations, dashboard, controls, uiActionsEnhanced, lens, maps, dataVisualizer, ml, fleet, canvas, dashboardEnhanced, discoverEnhanced, monitoring, securitySolution, urlDrilldown, visDefaultEditor, visTypeTimelion, visTypeTimeseries, visTypeVega, cases | 8.1 | +| | infra, discover, visualizations, dashboard, controls, uiActionsEnhanced, lens, maps, dataVisualizer, ml, fleet, canvas, dashboardEnhanced, discoverEnhanced, monitoring, securitySolution, urlDrilldown, visDefaultEditor, visTypeTimelion, visTypeTimeseries, visTypeVega, cases | 8.1 | | | discover, dashboard, lens, urlDrilldown | 8.1 | -| | unifiedSearch | 8.1 | -| | stackAlerts, alerting, securitySolution, inputControlVis | 8.1 | -| | stackAlerts, alerting, securitySolution, inputControlVis | 8.1 | | | apm | 8.1 | -| | dataViews, unifiedSearch | 8.2 | -| | dataViews, unifiedSearch, data | 8.2 | -| | visualizations, dashboard, lens, maps, ml, securitySolution, security | 8.8.0 | -| | dashboard, maps | 8.8.0 | -| | embeddable, discover, presentationUtil, dashboard, graph | 8.8.0 | | | spaces, security, alerting | 8.8.0 | | | spaces, security, actions, alerting, ml, remoteClusters, graph, indexLifecycleManagement, mapsEms, painlessLab, rollup, searchprofiler, snapshotRestore, transform, upgradeAssistant | 8.8.0 | +| | embeddable, discover, presentationUtil, dashboard, graph | 8.8.0 | | | apm, security, securitySolution | 8.8.0 | | | apm, security, securitySolution | 8.8.0 | +| | visualizations, dashboard, lens, maps, ml, securitySolution, security | 8.8.0 | | | securitySolution | 8.8.0 | | | savedObjectsTaggingOss, visualizations, dashboard, lens | 8.8.0 | | | dashboard | 8.8.0 | -| | monitoring | 8.8.0 | -| | monitoring, kibanaUsageCollection | 8.8.0 | -| | cloud, apm | 8.8.0 | +| | dashboard, maps | 8.8.0 | | | security, licenseManagement, ml, apm, crossClusterReplication, logstash, painlessLab, searchprofiler, watcher | 8.8.0 | -| | management, fleet, security, kibanaOverview | 8.8.0 | | | security, fleet | 8.8.0 | | | security, fleet | 8.8.0 | | | security, fleet | 8.8.0 | +| | management, fleet, security, kibanaOverview | 8.8.0 | +| | monitoring, kibanaUsageCollection | 8.8.0 | +| | cloud, apm | 8.8.0 | | | security | 8.8.0 | | | mapsEms | 8.8.0 | | | ml | 8.8.0 @@ -126,6 +109,7 @@ Safe to remove. | ---------------|------------| | | data | | | data | +| | data | | | data | | | data | | | data | @@ -186,8 +170,6 @@ Safe to remove. | | data | | | data | | | data | -| | dataViews | -| | dataViews | | | expressions | | | expressions | | | expressions | @@ -211,6 +193,7 @@ Safe to remove. | | reporting | | | taskManager | | | core | -| | core | | | core | -| | core | \ No newline at end of file +| | core | +| | @kbn/core-injected-metadata-browser | +| | @kbn/core-injected-metadata-browser | \ No newline at end of file diff --git a/api_docs/deprecations_by_plugin.mdx b/api_docs/deprecations_by_plugin.mdx index f105045929426e..bd8d977e927243 100644 --- a/api_docs/deprecations_by_plugin.mdx +++ b/api_docs/deprecations_by_plugin.mdx @@ -3,7 +3,7 @@ id: kibDevDocsDeprecationsByPlugin slug: /kibana-dev-docs/api-meta/deprecated-api-list-by-plugin title: Deprecated API usage by plugin summary: A list of deprecated APIs, which plugins are still referencing them, and when they need to be removed by. -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. --- @@ -61,23 +61,33 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| -| | [es_service.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/lib/es_service.ts#:~:text=IndexPatternAttributes), [es_service.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/lib/es_service.ts#:~:text=IndexPatternAttributes), [es_service.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/lib/es_service.ts#:~:text=IndexPatternAttributes) | - | -| | [es_service.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/lib/es_service.ts#:~:text=IndexPatternAttributes), [es_service.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/lib/es_service.ts#:~:text=IndexPatternAttributes), [es_service.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/lib/es_service.ts#:~:text=IndexPatternAttributes), [es_service.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/lib/es_service.ts#:~:text=IndexPatternAttributes), [es_service.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/lib/es_service.ts#:~:text=IndexPatternAttributes), [es_service.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/lib/es_service.ts#:~:text=IndexPatternAttributes) | - | -| | [es_service.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/lib/es_service.ts#:~:text=IndexPatternAttributes), [es_service.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/lib/es_service.ts#:~:text=IndexPatternAttributes), [es_service.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/lib/es_service.ts#:~:text=IndexPatternAttributes) | - | -| | [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/server/demodata/index.ts#:~:text=context), [embeddable.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/external/embeddable.ts#:~:text=context), [esdocs.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/browser/esdocs.ts#:~:text=context), [essql.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/browser/essql.ts#:~:text=context), [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/server/pointseries/index.ts#:~:text=context), [filters.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/common/functions/filters.ts#:~:text=context), [escount.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/browser/escount.ts#:~:text=context), [neq.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/common/neq.ts#:~:text=context) | - | +| | [embeddables.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/types/embeddables.ts#:~:text=TimeRange), [embeddables.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/types/embeddables.ts#:~:text=TimeRange), [build_embeddable_filters.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/common/lib/build_embeddable_filters.ts#:~:text=TimeRange), [build_embeddable_filters.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/common/lib/build_embeddable_filters.ts#:~:text=TimeRange), [build_embeddable_filters.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/common/lib/build_embeddable_filters.ts#:~:text=TimeRange), [saved_lens.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/external/saved_lens.ts#:~:text=TimeRange), [saved_lens.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/external/saved_lens.ts#:~:text=TimeRange), [timelion.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/functions/timelion.ts#:~:text=TimeRange), [timelion.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/functions/timelion.ts#:~:text=TimeRange) | 8.1 | +| | [embeddables.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/types/embeddables.ts#:~:text=TimeRange), [embeddables.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/types/embeddables.ts#:~:text=TimeRange), [build_embeddable_filters.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/common/lib/build_embeddable_filters.ts#:~:text=TimeRange), [build_embeddable_filters.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/common/lib/build_embeddable_filters.ts#:~:text=TimeRange), [build_embeddable_filters.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/common/lib/build_embeddable_filters.ts#:~:text=TimeRange), [saved_lens.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/external/saved_lens.ts#:~:text=TimeRange), [saved_lens.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/external/saved_lens.ts#:~:text=TimeRange), [timelion.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/functions/timelion.ts#:~:text=TimeRange), [timelion.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/functions/timelion.ts#:~:text=TimeRange) | 8.1 | +| | [embeddables.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/types/embeddables.ts#:~:text=TimeRange), [embeddables.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/types/embeddables.ts#:~:text=TimeRange), [build_embeddable_filters.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/common/lib/build_embeddable_filters.ts#:~:text=TimeRange), [build_embeddable_filters.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/common/lib/build_embeddable_filters.ts#:~:text=TimeRange), [build_embeddable_filters.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/common/lib/build_embeddable_filters.ts#:~:text=TimeRange), [saved_lens.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/external/saved_lens.ts#:~:text=TimeRange), [saved_lens.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/external/saved_lens.ts#:~:text=TimeRange), [timelion.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/functions/timelion.ts#:~:text=TimeRange), [timelion.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/functions/timelion.ts#:~:text=TimeRange) | 8.1 | +| | [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/server/demodata/index.ts#:~:text=context), [embeddable.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/external/embeddable.ts#:~:text=context), [esdocs.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/browser/esdocs.ts#:~:text=context), [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/server/pointseries/index.ts#:~:text=context), [filters.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/common/functions/filters.ts#:~:text=context), [escount.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/browser/escount.ts#:~:text=context), [neq.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/common/neq.ts#:~:text=context) | - | | | [setup_expressions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/setup_expressions.ts#:~:text=getFunction) | - | | | [application.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/application.tsx#:~:text=getFunctions), [functions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/server/routes/functions/functions.ts#:~:text=getFunctions), [functions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/server/routes/functions/functions.ts#:~:text=getFunctions), [functions.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/server/routes/functions/functions.test.ts#:~:text=getFunctions) | - | | | [setup_expressions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/setup_expressions.ts#:~:text=getTypes), [application.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/application.tsx#:~:text=getTypes), [functions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/server/routes/functions/functions.ts#:~:text=getTypes) | - | | | [state.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/types/state.ts#:~:text=Render), [state.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/types/state.ts#:~:text=Render), [markdown.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/browser/markdown.ts#:~:text=Render), [markdown.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/browser/markdown.ts#:~:text=Render), [timefilterControl.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/common/timefilterControl.ts#:~:text=Render), [timefilterControl.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/common/timefilterControl.ts#:~:text=Render), [pie.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/functions/pie.ts#:~:text=Render), [pie.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/functions/pie.ts#:~:text=Render), [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/functions/plot/index.ts#:~:text=Render), [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/functions/plot/index.ts#:~:text=Render)+ 2 more | - | -| | [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/server/demodata/index.ts#:~:text=context), [embeddable.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/external/embeddable.ts#:~:text=context), [esdocs.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/browser/esdocs.ts#:~:text=context), [essql.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/browser/essql.ts#:~:text=context), [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/server/pointseries/index.ts#:~:text=context), [filters.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/common/functions/filters.ts#:~:text=context), [escount.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/browser/escount.ts#:~:text=context), [neq.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/common/neq.ts#:~:text=context) | - | +| | [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/server/demodata/index.ts#:~:text=context), [embeddable.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/external/embeddable.ts#:~:text=context), [esdocs.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/browser/esdocs.ts#:~:text=context), [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/server/pointseries/index.ts#:~:text=context), [filters.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/common/functions/filters.ts#:~:text=context), [escount.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/browser/escount.ts#:~:text=context), [neq.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/common/neq.ts#:~:text=context) | - | | | [setup_expressions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/setup_expressions.ts#:~:text=getFunction) | - | | | [application.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/application.tsx#:~:text=getFunctions), [functions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/server/routes/functions/functions.ts#:~:text=getFunctions), [functions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/server/routes/functions/functions.ts#:~:text=getFunctions), [functions.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/server/routes/functions/functions.test.ts#:~:text=getFunctions) | - | | | [setup_expressions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/setup_expressions.ts#:~:text=getTypes), [application.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/application.tsx#:~:text=getTypes), [functions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/server/routes/functions/functions.ts#:~:text=getTypes) | - | -| | [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/server/demodata/index.ts#:~:text=context), [embeddable.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/external/embeddable.ts#:~:text=context), [esdocs.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/browser/esdocs.ts#:~:text=context), [essql.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/browser/essql.ts#:~:text=context), [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/server/pointseries/index.ts#:~:text=context), [filters.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/common/functions/filters.ts#:~:text=context), [escount.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/browser/escount.ts#:~:text=context), [neq.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/common/neq.ts#:~:text=context) | - | +| | [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/server/demodata/index.ts#:~:text=context), [embeddable.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/external/embeddable.ts#:~:text=context), [esdocs.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/browser/esdocs.ts#:~:text=context), [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/server/pointseries/index.ts#:~:text=context), [filters.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/common/functions/filters.ts#:~:text=context), [escount.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/browser/escount.ts#:~:text=context), [neq.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/common/neq.ts#:~:text=context) | - | | | [home.component.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/components/home/home.component.tsx#:~:text=KibanaPageTemplate), [home.component.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/components/home/home.component.tsx#:~:text=KibanaPageTemplate), [home.component.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/components/home/home.component.tsx#:~:text=KibanaPageTemplate) | - | +## cases + +| Deprecated API | Reference location(s) | Remove By | +| ---------------|-----------|-----------| +| | [serializer.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cases/common/utils/markdown_plugins/lens/serializer.ts#:~:text=TimeRange), [serializer.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cases/common/utils/markdown_plugins/lens/serializer.ts#:~:text=TimeRange), [utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cases/common/utils/markdown_plugins/utils.ts#:~:text=TimeRange), [utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cases/common/utils/markdown_plugins/utils.ts#:~:text=TimeRange) | 8.1 | +| | [serializer.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cases/common/utils/markdown_plugins/lens/serializer.ts#:~:text=TimeRange), [serializer.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cases/common/utils/markdown_plugins/lens/serializer.ts#:~:text=TimeRange), [utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cases/common/utils/markdown_plugins/utils.ts#:~:text=TimeRange), [utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cases/common/utils/markdown_plugins/utils.ts#:~:text=TimeRange) | 8.1 | +| | [serializer.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cases/common/utils/markdown_plugins/lens/serializer.ts#:~:text=TimeRange), [serializer.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cases/common/utils/markdown_plugins/lens/serializer.ts#:~:text=TimeRange), [utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cases/common/utils/markdown_plugins/utils.ts#:~:text=TimeRange), [utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cases/common/utils/markdown_plugins/utils.ts#:~:text=TimeRange) | 8.1 | + + + ## cloud | Deprecated API | Reference location(s) | Remove By | @@ -105,6 +115,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex +## controls + +| Deprecated API | Reference location(s) | Remove By | +| ---------------|-----------|-----------| +| | [options_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/controls/public/services/kibana/options_list.ts#:~:text=TimeRange), [options_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/controls/public/services/kibana/options_list.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/controls/common/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/controls/common/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/controls/common/control_types/options_list/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/controls/common/control_types/options_list/types.ts#:~:text=TimeRange) | 8.1 | +| | [options_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/controls/public/services/kibana/options_list.ts#:~:text=TimeRange), [options_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/controls/public/services/kibana/options_list.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/controls/common/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/controls/common/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/controls/common/control_types/options_list/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/controls/common/control_types/options_list/types.ts#:~:text=TimeRange) | 8.1 | +| | [options_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/controls/public/services/kibana/options_list.ts#:~:text=TimeRange), [options_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/controls/public/services/kibana/options_list.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/controls/common/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/controls/common/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/controls/common/control_types/options_list/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/controls/common/control_types/options_list/types.ts#:~:text=TimeRange) | 8.1 | + + + ## crossClusterReplication | Deprecated API | Reference location(s) | Remove By | @@ -117,10 +137,13 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| +| | [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=TimeRange), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=TimeRange), [dashboard_state_slice.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/state/dashboard_state_slice.ts#:~:text=TimeRange), [dashboard_state_slice.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/state/dashboard_state_slice.ts#:~:text=TimeRange), [convert_dashboard_state.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/convert_dashboard_state.ts#:~:text=TimeRange), [convert_dashboard_state.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/convert_dashboard_state.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/types.ts#:~:text=TimeRange), [dashboard_container.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#:~:text=TimeRange)+ 5 more | 8.1 | | | [sync_dashboard_filter_state.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/sync_dashboard_filter_state.ts#:~:text=syncQueryStateWithUrl), [sync_dashboard_filter_state.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/sync_dashboard_filter_state.ts#:~:text=syncQueryStateWithUrl), [dashboard_listing.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/listing/dashboard_listing.tsx#:~:text=syncQueryStateWithUrl), [dashboard_listing.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/listing/dashboard_listing.tsx#:~:text=syncQueryStateWithUrl) | - | | | [export_csv_action.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/actions/export_csv_action.tsx#:~:text=fieldFormats) | - | | | [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [saved_dashboard.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#:~:text=Filter), [saved_dashboard.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#:~:text=Filter), [dashboard_state_slice.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/state/dashboard_state_slice.ts#:~:text=Filter), [dashboard_state_slice.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/state/dashboard_state_slice.ts#:~:text=Filter), [dashboard_state_slice.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/state/dashboard_state_slice.ts#:~:text=Filter)+ 5 more | 8.1 | | | [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [saved_dashboard.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#:~:text=Filter), [saved_dashboard.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#:~:text=Filter), [dashboard_state_slice.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/state/dashboard_state_slice.ts#:~:text=Filter), [dashboard_state_slice.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/state/dashboard_state_slice.ts#:~:text=Filter), [dashboard_state_slice.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/state/dashboard_state_slice.ts#:~:text=Filter)+ 5 more | 8.1 | +| | [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=TimeRange), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=TimeRange), [dashboard_state_slice.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/state/dashboard_state_slice.ts#:~:text=TimeRange), [dashboard_state_slice.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/state/dashboard_state_slice.ts#:~:text=TimeRange), [convert_dashboard_state.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/convert_dashboard_state.ts#:~:text=TimeRange), [convert_dashboard_state.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/convert_dashboard_state.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/types.ts#:~:text=TimeRange), [dashboard_container.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#:~:text=TimeRange)+ 5 more | 8.1 | +| | [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=TimeRange), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=TimeRange), [dashboard_state_slice.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/state/dashboard_state_slice.ts#:~:text=TimeRange), [dashboard_state_slice.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/state/dashboard_state_slice.ts#:~:text=TimeRange), [convert_dashboard_state.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/convert_dashboard_state.ts#:~:text=TimeRange), [convert_dashboard_state.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/convert_dashboard_state.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/types.ts#:~:text=TimeRange), [dashboard_container.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#:~:text=TimeRange)+ 5 more | 8.1 | | | [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [saved_dashboard.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#:~:text=Filter), [saved_dashboard.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#:~:text=Filter), [dashboard_state_slice.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/state/dashboard_state_slice.ts#:~:text=Filter), [dashboard_state_slice.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/state/dashboard_state_slice.ts#:~:text=Filter), [dashboard_state_slice.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/state/dashboard_state_slice.ts#:~:text=Filter)+ 5 more | 8.1 | | | [kibana_react.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/services/kibana_react.ts#:~:text=ExitFullScreenButton), [plugin.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/plugin.tsx#:~:text=ExitFullScreenButton), [plugin.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/plugin.tsx#:~:text=ExitFullScreenButton), [plugin.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/plugin.tsx#:~:text=ExitFullScreenButton) | - | | | [saved_objects.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/services/saved_objects.ts#:~:text=SavedObjectSaveModal), [save_modal.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/top_nav/save_modal.tsx#:~:text=SavedObjectSaveModal), [save_modal.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/top_nav/save_modal.tsx#:~:text=SavedObjectSaveModal) | 8.8.0 | @@ -131,38 +154,23 @@ warning: This document is auto-generated and is meant to be viewed inside our ex -## data +## dashboardEnhanced | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| -| | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/index.ts#:~:text=IndexPatternField), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/index.ts#:~:text=IndexPatternField), [kibana_context_type.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/expressions/kibana_context_type.ts#:~:text=IndexPatternField), [kibana_context_type.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/expressions/kibana_context_type.ts#:~:text=IndexPatternField), [search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source.ts#:~:text=IndexPatternField), [search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source.ts#:~:text=IndexPatternField), [search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source.ts#:~:text=IndexPatternField), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/server/index.ts#:~:text=IndexPatternField), [agg_config.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/aggs/agg_config.test.ts#:~:text=IndexPatternField), [agg_config.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/aggs/agg_config.test.ts#:~:text=IndexPatternField)+ 16 more | - | -| | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/index.ts#:~:text=IndexPatternsContract), [create_search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/create_search_source.ts#:~:text=IndexPatternsContract), [create_search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/create_search_source.ts#:~:text=IndexPatternsContract), [search_source_service.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source_service.ts#:~:text=IndexPatternsContract), [search_source_service.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source_service.ts#:~:text=IndexPatternsContract), [esaggs_fn.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/expressions/esaggs/esaggs_fn.ts#:~:text=IndexPatternsContract), [esaggs_fn.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/expressions/esaggs/esaggs_fn.ts#:~:text=IndexPatternsContract), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/search/types.ts#:~:text=IndexPatternsContract), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/search/types.ts#:~:text=IndexPatternsContract), [create_search_source.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/create_search_source.test.ts#:~:text=IndexPatternsContract)+ 19 more | - | -| | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/index.ts#:~:text=IndexPatternsService), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/server/index.ts#:~:text=IndexPatternsService), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/server/index.ts#:~:text=IndexPatternsService), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/server/index.ts#:~:text=IndexPatternsService), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/index.ts#:~:text=IndexPatternsService) | - | -| | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/index.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/types.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/types.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/types.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/types.ts#:~:text=IndexPattern), [search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source.ts#:~:text=IndexPattern), [search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source.ts#:~:text=IndexPattern), [search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source.ts#:~:text=IndexPattern), [tabify_docs.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/tabify/tabify_docs.ts#:~:text=IndexPattern), [tabify_docs.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/tabify/tabify_docs.ts#:~:text=IndexPattern)+ 90 more | - | -| | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/index.ts#:~:text=IFieldType), [generate_filters.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/query/filter_manager/lib/generate_filters.ts#:~:text=IFieldType), [generate_filters.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/query/filter_manager/lib/generate_filters.ts#:~:text=IFieldType), [generate_filters.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/query/filter_manager/lib/generate_filters.ts#:~:text=IFieldType), [generate_filters.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/query/filter_manager/lib/generate_filters.ts#:~:text=IFieldType), [date_histogram.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/aggs/buckets/date_histogram.ts#:~:text=IFieldType), [date_histogram.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/aggs/buckets/date_histogram.ts#:~:text=IFieldType), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/index.ts#:~:text=IFieldType), [create_filters_from_range_select.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/actions/filters/create_filters_from_range_select.ts#:~:text=IFieldType), [create_filters_from_range_select.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/actions/filters/create_filters_from_range_select.ts#:~:text=IFieldType)+ 6 more | 8.2 | -| | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/index.ts#:~:text=IndexPatternField), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/index.ts#:~:text=IndexPatternField), [kibana_context_type.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/expressions/kibana_context_type.ts#:~:text=IndexPatternField), [kibana_context_type.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/expressions/kibana_context_type.ts#:~:text=IndexPatternField), [search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source.ts#:~:text=IndexPatternField), [search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source.ts#:~:text=IndexPatternField), [search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source.ts#:~:text=IndexPatternField), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/server/index.ts#:~:text=IndexPatternField), [agg_config.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/aggs/agg_config.test.ts#:~:text=IndexPatternField), [agg_config.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/aggs/agg_config.test.ts#:~:text=IndexPatternField)+ 16 more | - | -| | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/index.ts#:~:text=IIndexPattern), [get_time.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/query/timefilter/get_time.ts#:~:text=IIndexPattern), [get_time.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/query/timefilter/get_time.ts#:~:text=IIndexPattern), [get_time.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/query/timefilter/get_time.ts#:~:text=IIndexPattern), [get_time.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/query/timefilter/get_time.ts#:~:text=IIndexPattern), [generate_filters.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/query/filter_manager/lib/generate_filters.ts#:~:text=IIndexPattern), [generate_filters.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/query/filter_manager/lib/generate_filters.ts#:~:text=IIndexPattern), [generate_filters.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/query/filter_manager/lib/generate_filters.ts#:~:text=IIndexPattern), [timefilter.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/query/timefilter/timefilter.ts#:~:text=IIndexPattern), [timefilter.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/query/timefilter/timefilter.ts#:~:text=IIndexPattern)+ 23 more | - | -| | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/index.ts#:~:text=IndexPatternAttributes), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/index.ts#:~:text=IndexPatternAttributes), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/server/index.ts#:~:text=IndexPatternAttributes) | - | -| | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/index.ts#:~:text=IndexPatternsContract), [create_search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/create_search_source.ts#:~:text=IndexPatternsContract), [create_search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/create_search_source.ts#:~:text=IndexPatternsContract), [search_source_service.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source_service.ts#:~:text=IndexPatternsContract), [search_source_service.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source_service.ts#:~:text=IndexPatternsContract), [esaggs_fn.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/expressions/esaggs/esaggs_fn.ts#:~:text=IndexPatternsContract), [esaggs_fn.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/expressions/esaggs/esaggs_fn.ts#:~:text=IndexPatternsContract), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/search/types.ts#:~:text=IndexPatternsContract), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/search/types.ts#:~:text=IndexPatternsContract), [create_search_source.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/create_search_source.test.ts#:~:text=IndexPatternsContract)+ 19 more | - | -| | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/index.ts#:~:text=IndexPatternsService), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/server/index.ts#:~:text=IndexPatternsService), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/server/index.ts#:~:text=IndexPatternsService), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/server/index.ts#:~:text=IndexPatternsService), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/index.ts#:~:text=IndexPatternsService) | - | -| | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/index.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/types.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/types.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/types.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/types.ts#:~:text=IndexPattern), [search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source.ts#:~:text=IndexPattern), [search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source.ts#:~:text=IndexPattern), [search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source.ts#:~:text=IndexPattern), [tabify_docs.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/tabify/tabify_docs.ts#:~:text=IndexPattern), [tabify_docs.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/tabify/tabify_docs.ts#:~:text=IndexPattern)+ 90 more | - | -| | [aggs_service.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/server/search/aggs/aggs_service.ts#:~:text=indexPatternsServiceFactory), [esaggs.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/server/search/expressions/esaggs.ts#:~:text=indexPatternsServiceFactory), [search_service.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/server/search/search_service.ts#:~:text=indexPatternsServiceFactory) | - | -| | [connected_search_session_indicator.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/search/session/session_indicator/connected_search_session_indicator/connected_search_session_indicator.tsx#:~:text=RedirectAppLinks), [connected_search_session_indicator.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/search/session/session_indicator/connected_search_session_indicator/connected_search_session_indicator.tsx#:~:text=RedirectAppLinks), [connected_search_session_indicator.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/search/session/session_indicator/connected_search_session_indicator/connected_search_session_indicator.tsx#:~:text=RedirectAppLinks), [get_columns.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/search/session/sessions_mgmt/lib/get_columns.tsx#:~:text=RedirectAppLinks), [get_columns.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/search/session/sessions_mgmt/lib/get_columns.tsx#:~:text=RedirectAppLinks), [get_columns.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/search/session/sessions_mgmt/lib/get_columns.tsx#:~:text=RedirectAppLinks) | - | -| | [data_table.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/utils/table_inspector_view/components/data_table.tsx#:~:text=executeTriggerActions), [data_table.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/utils/table_inspector_view/components/data_table.tsx#:~:text=executeTriggerActions) | - | -| | [session_service.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/server/search/session/session_service.ts#:~:text=authc) | - | +| | [embeddable_to_dashboard_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/dashboard_enhanced/public/services/drilldowns/embeddable_to_dashboard_drilldown/embeddable_to_dashboard_drilldown.tsx#:~:text=TimeRange), [embeddable_to_dashboard_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/dashboard_enhanced/public/services/drilldowns/embeddable_to_dashboard_drilldown/embeddable_to_dashboard_drilldown.tsx#:~:text=TimeRange) | 8.1 | +| | [embeddable_to_dashboard_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/dashboard_enhanced/public/services/drilldowns/embeddable_to_dashboard_drilldown/embeddable_to_dashboard_drilldown.tsx#:~:text=TimeRange), [embeddable_to_dashboard_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/dashboard_enhanced/public/services/drilldowns/embeddable_to_dashboard_drilldown/embeddable_to_dashboard_drilldown.tsx#:~:text=TimeRange) | 8.1 | +| | [embeddable_to_dashboard_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/dashboard_enhanced/public/services/drilldowns/embeddable_to_dashboard_drilldown/embeddable_to_dashboard_drilldown.tsx#:~:text=TimeRange), [embeddable_to_dashboard_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/dashboard_enhanced/public/services/drilldowns/embeddable_to_dashboard_drilldown/embeddable_to_dashboard_drilldown.tsx#:~:text=TimeRange) | 8.1 | -## dataViewEditor +## data | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| -| | [shared_imports.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_editor/public/shared_imports.ts#:~:text=IndexPattern), [open_editor.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_editor/public/open_editor.tsx#:~:text=IndexPattern), [open_editor.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_editor/public/open_editor.tsx#:~:text=IndexPattern), [shared_imports.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_editor/public/shared_imports.ts#:~:text=IndexPattern), [open_editor.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_editor/public/open_editor.tsx#:~:text=IndexPattern), [open_editor.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_editor/public/open_editor.tsx#:~:text=IndexPattern) | - | -| | [shared_imports.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_editor/public/shared_imports.ts#:~:text=IndexPatternField), [extract_time_fields.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_editor/public/lib/extract_time_fields.ts#:~:text=IndexPatternField), [extract_time_fields.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_editor/public/lib/extract_time_fields.ts#:~:text=IndexPatternField), [extract_time_fields.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_editor/public/lib/extract_time_fields.test.ts#:~:text=IndexPatternField), [extract_time_fields.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_editor/public/lib/extract_time_fields.test.ts#:~:text=IndexPatternField), [extract_time_fields.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_editor/public/lib/extract_time_fields.test.ts#:~:text=IndexPatternField), [shared_imports.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_editor/public/shared_imports.ts#:~:text=IndexPatternField), [extract_time_fields.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_editor/public/lib/extract_time_fields.ts#:~:text=IndexPatternField), [extract_time_fields.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_editor/public/lib/extract_time_fields.ts#:~:text=IndexPatternField), [extract_time_fields.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_editor/public/lib/extract_time_fields.test.ts#:~:text=IndexPatternField)+ 2 more | - | -| | [shared_imports.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_editor/public/shared_imports.ts#:~:text=IndexPatternField), [extract_time_fields.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_editor/public/lib/extract_time_fields.ts#:~:text=IndexPatternField), [extract_time_fields.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_editor/public/lib/extract_time_fields.ts#:~:text=IndexPatternField), [extract_time_fields.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_editor/public/lib/extract_time_fields.test.ts#:~:text=IndexPatternField), [extract_time_fields.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_editor/public/lib/extract_time_fields.test.ts#:~:text=IndexPatternField), [extract_time_fields.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_editor/public/lib/extract_time_fields.test.ts#:~:text=IndexPatternField), [shared_imports.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_editor/public/shared_imports.ts#:~:text=IndexPatternField), [extract_time_fields.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_editor/public/lib/extract_time_fields.ts#:~:text=IndexPatternField), [extract_time_fields.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_editor/public/lib/extract_time_fields.ts#:~:text=IndexPatternField), [extract_time_fields.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_editor/public/lib/extract_time_fields.test.ts#:~:text=IndexPatternField)+ 2 more | - | -| | [shared_imports.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_editor/public/shared_imports.ts#:~:text=IndexPattern), [open_editor.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_editor/public/open_editor.tsx#:~:text=IndexPattern), [open_editor.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_editor/public/open_editor.tsx#:~:text=IndexPattern), [shared_imports.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_editor/public/shared_imports.ts#:~:text=IndexPattern), [open_editor.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_editor/public/open_editor.tsx#:~:text=IndexPattern), [open_editor.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_editor/public/open_editor.tsx#:~:text=IndexPattern) | - | -| | [shared_imports.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_editor/public/shared_imports.ts#:~:text=IndexPatternField), [extract_time_fields.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_editor/public/lib/extract_time_fields.ts#:~:text=IndexPatternField), [extract_time_fields.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_editor/public/lib/extract_time_fields.ts#:~:text=IndexPatternField), [extract_time_fields.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_editor/public/lib/extract_time_fields.test.ts#:~:text=IndexPatternField), [extract_time_fields.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_editor/public/lib/extract_time_fields.test.ts#:~:text=IndexPatternField), [extract_time_fields.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_editor/public/lib/extract_time_fields.test.ts#:~:text=IndexPatternField) | - | -| | [shared_imports.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_editor/public/shared_imports.ts#:~:text=IndexPattern), [open_editor.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_editor/public/open_editor.tsx#:~:text=IndexPattern), [open_editor.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_editor/public/open_editor.tsx#:~:text=IndexPattern) | - | +| | [connected_search_session_indicator.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/search/session/session_indicator/connected_search_session_indicator/connected_search_session_indicator.tsx#:~:text=RedirectAppLinks), [connected_search_session_indicator.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/search/session/session_indicator/connected_search_session_indicator/connected_search_session_indicator.tsx#:~:text=RedirectAppLinks), [connected_search_session_indicator.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/search/session/session_indicator/connected_search_session_indicator/connected_search_session_indicator.tsx#:~:text=RedirectAppLinks), [get_columns.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/search/session/sessions_mgmt/lib/get_columns.tsx#:~:text=RedirectAppLinks), [get_columns.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/search/session/sessions_mgmt/lib/get_columns.tsx#:~:text=RedirectAppLinks), [get_columns.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/search/session/sessions_mgmt/lib/get_columns.tsx#:~:text=RedirectAppLinks) | - | +| | [data_table.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/utils/table_inspector_view/components/data_table.tsx#:~:text=executeTriggerActions), [data_table.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/utils/table_inspector_view/components/data_table.tsx#:~:text=executeTriggerActions) | - | +| | [session_service.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/server/search/session/session_service.ts#:~:text=authc) | - | @@ -173,9 +181,9 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [scripted_fields_table.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_management/public/components/edit_index_pattern/scripted_fields_table/scripted_fields_table.tsx#:~:text=removeScriptedField), [field_editor.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_management/public/components/field_editor/field_editor.tsx#:~:text=removeScriptedField), [scripted_fields_table.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_management/public/components/edit_index_pattern/scripted_fields_table/scripted_fields_table.tsx#:~:text=removeScriptedField), [field_editor.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_management/public/components/field_editor/field_editor.tsx#:~:text=removeScriptedField) | - | | | [table.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_management/public/components/edit_index_pattern/source_filters_table/components/table/table.tsx#:~:text=getNonScriptedFields), [edit_index_pattern.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_management/public/components/edit_index_pattern/edit_index_pattern.tsx#:~:text=getNonScriptedFields), [edit_index_pattern.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_management/public/components/edit_index_pattern/edit_index_pattern.tsx#:~:text=getNonScriptedFields), [edit_index_pattern.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_management/public/components/edit_index_pattern/edit_index_pattern.tsx#:~:text=getNonScriptedFields), [table.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_management/public/components/edit_index_pattern/source_filters_table/components/table/table.tsx#:~:text=getNonScriptedFields), [edit_index_pattern.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_management/public/components/edit_index_pattern/edit_index_pattern.tsx#:~:text=getNonScriptedFields), [edit_index_pattern.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_management/public/components/edit_index_pattern/edit_index_pattern.tsx#:~:text=getNonScriptedFields), [edit_index_pattern.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_management/public/components/edit_index_pattern/edit_index_pattern.tsx#:~:text=getNonScriptedFields) | - | | | [scripted_fields_table.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_management/public/components/edit_index_pattern/scripted_fields_table/scripted_fields_table.tsx#:~:text=getScriptedFields), [scripted_fields_table.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_management/public/components/edit_index_pattern/scripted_fields_table/scripted_fields_table.tsx#:~:text=getScriptedFields) | - | -| | [scripted_fields_table.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_management/public/components/edit_index_pattern/scripted_fields_table/scripted_fields_table.tsx#:~:text=removeScriptedField), [field_editor.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_management/public/components/field_editor/field_editor.tsx#:~:text=removeScriptedField) | - | -| | [table.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_management/public/components/edit_index_pattern/source_filters_table/components/table/table.tsx#:~:text=getNonScriptedFields), [edit_index_pattern.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_management/public/components/edit_index_pattern/edit_index_pattern.tsx#:~:text=getNonScriptedFields), [edit_index_pattern.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_management/public/components/edit_index_pattern/edit_index_pattern.tsx#:~:text=getNonScriptedFields), [edit_index_pattern.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_management/public/components/edit_index_pattern/edit_index_pattern.tsx#:~:text=getNonScriptedFields) | - | -| | [scripted_fields_table.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_management/public/components/edit_index_pattern/scripted_fields_table/scripted_fields_table.tsx#:~:text=getScriptedFields) | - | +| | [scripted_fields_table.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_management/public/components/edit_index_pattern/scripted_fields_table/scripted_fields_table.tsx#:~:text=removeScriptedField), [field_editor.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_management/public/components/field_editor/field_editor.tsx#:~:text=removeScriptedField), [scripted_fields_table.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_management/public/components/edit_index_pattern/scripted_fields_table/scripted_fields_table.tsx#:~:text=removeScriptedField), [field_editor.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_management/public/components/field_editor/field_editor.tsx#:~:text=removeScriptedField) | - | +| | [table.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_management/public/components/edit_index_pattern/source_filters_table/components/table/table.tsx#:~:text=getNonScriptedFields), [edit_index_pattern.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_management/public/components/edit_index_pattern/edit_index_pattern.tsx#:~:text=getNonScriptedFields), [edit_index_pattern.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_management/public/components/edit_index_pattern/edit_index_pattern.tsx#:~:text=getNonScriptedFields), [edit_index_pattern.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_management/public/components/edit_index_pattern/edit_index_pattern.tsx#:~:text=getNonScriptedFields), [table.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_management/public/components/edit_index_pattern/source_filters_table/components/table/table.tsx#:~:text=getNonScriptedFields), [edit_index_pattern.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_management/public/components/edit_index_pattern/edit_index_pattern.tsx#:~:text=getNonScriptedFields), [edit_index_pattern.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_management/public/components/edit_index_pattern/edit_index_pattern.tsx#:~:text=getNonScriptedFields), [edit_index_pattern.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_management/public/components/edit_index_pattern/edit_index_pattern.tsx#:~:text=getNonScriptedFields) | - | +| | [scripted_fields_table.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_management/public/components/edit_index_pattern/scripted_fields_table/scripted_fields_table.tsx#:~:text=getScriptedFields), [scripted_fields_table.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_management/public/components/edit_index_pattern/scripted_fields_table/scripted_fields_table.tsx#:~:text=getScriptedFields) | - | | | [scripted_fields_table.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_management/public/components/edit_index_pattern/scripted_fields_table/scripted_fields_table.tsx#:~:text=removeScriptedField), [field_editor.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_management/public/components/field_editor/field_editor.tsx#:~:text=removeScriptedField) | - | | | [table.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_management/public/components/edit_index_pattern/source_filters_table/components/table/table.tsx#:~:text=getNonScriptedFields), [edit_index_pattern.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_management/public/components/edit_index_pattern/edit_index_pattern.tsx#:~:text=getNonScriptedFields), [edit_index_pattern.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_management/public/components/edit_index_pattern/edit_index_pattern.tsx#:~:text=getNonScriptedFields), [edit_index_pattern.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_management/public/components/edit_index_pattern/edit_index_pattern.tsx#:~:text=getNonScriptedFields) | - | | | [scripted_fields_table.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/data_view_management/public/components/edit_index_pattern/scripted_fields_table/scripted_fields_table.tsx#:~:text=getScriptedFields) | - | @@ -186,29 +194,10 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| -| | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/index.ts#:~:text=IndexPatternsService), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/public/index.ts#:~:text=IndexPatternsService) | - | -| | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/index.ts#:~:text=IndexPatternsContract), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/public/index.ts#:~:text=IndexPatternsContract) | - | -| | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/index.ts#:~:text=IndexPattern), [data_view_field.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.test.ts#:~:text=IndexPattern), [data_view_field.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.test.ts#:~:text=IndexPattern), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/public/index.ts#:~:text=IndexPattern), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=IndexPattern), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=IndexPattern), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=IndexPattern), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=IndexPattern) | - | -| | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/index.ts#:~:text=IndexPatternField), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/public/index.ts#:~:text=IndexPatternField), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=IndexPatternField), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=IndexPatternField), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=IndexPatternField), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=IndexPatternField), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=IndexPatternField), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=IndexPatternField), [data_view_field.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.test.ts#:~:text=IndexPatternField), [data_view_field.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.test.ts#:~:text=IndexPatternField)+ 2 more | - | -| | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/index.ts#:~:text=IIndexPattern), [data_view.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.ts#:~:text=IIndexPattern), [data_view.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.ts#:~:text=IIndexPattern) | - | -| | [utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/utils.ts#:~:text=IFieldType), [utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/utils.ts#:~:text=IFieldType), [data_view_field.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.ts#:~:text=IFieldType), [data_view_field.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/index.ts#:~:text=IFieldType), [data_view.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.ts#:~:text=IFieldType)+ 7 more | 8.2 | -| | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/index.ts#:~:text=IndexPatternAttributes) | - | -| | [utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/utils.ts#:~:text=IFieldType), [utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/utils.ts#:~:text=IFieldType), [data_view_field.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.ts#:~:text=IFieldType), [data_view_field.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/index.ts#:~:text=IFieldType), [data_view.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.ts#:~:text=IFieldType)+ 7 more | 8.2 | -| | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/index.ts#:~:text=IIndexPattern), [data_view.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.ts#:~:text=IIndexPattern), [data_view.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.ts#:~:text=IIndexPattern) | - | -| | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/index.ts#:~:text=IndexPatternAttributes) | - | -| | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/index.ts#:~:text=IndexPatternsContract), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/public/index.ts#:~:text=IndexPatternsContract) | - | -| | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/index.ts#:~:text=IndexPatternField), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/public/index.ts#:~:text=IndexPatternField), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=IndexPatternField), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=IndexPatternField), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=IndexPatternField), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=IndexPatternField), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=IndexPatternField), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=IndexPatternField), [data_view_field.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.test.ts#:~:text=IndexPatternField), [data_view_field.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.test.ts#:~:text=IndexPatternField)+ 2 more | - | -| | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/index.ts#:~:text=IndexPatternsService), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/public/index.ts#:~:text=IndexPatternsService) | - | -| | [data_views.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_views.ts#:~:text=ensureDefaultDataView) | - | -| | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/index.ts#:~:text=IndexPattern), [data_view_field.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.test.ts#:~:text=IndexPattern), [data_view_field.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.test.ts#:~:text=IndexPattern), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/public/index.ts#:~:text=IndexPattern), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=IndexPattern), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=IndexPattern), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=IndexPattern), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=IndexPattern) | - | | | [data_view.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.ts#:~:text=flattenHit) | - | | | [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=removeScriptedField) | - | | | [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=getNonScriptedFields) | - | | | [data_view.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.ts#:~:text=getScriptedFields), [data_view.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.ts#:~:text=getScriptedFields), [data_views.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_views.ts#:~:text=getScriptedFields), [register_index_pattern_usage_collection.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/server/register_index_pattern_usage_collection.ts#:~:text=getScriptedFields), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=getScriptedFields), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=getScriptedFields), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=getScriptedFields), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=getScriptedFields), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=getScriptedFields) | - | -| | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/index.ts#:~:text=IndexPatternAttributes) | - | -| | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/index.ts#:~:text=IndexPatternField), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/public/index.ts#:~:text=IndexPatternField), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=IndexPatternField), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=IndexPatternField), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=IndexPatternField), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=IndexPatternField), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=IndexPatternField), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=IndexPatternField), [data_view_field.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.test.ts#:~:text=IndexPatternField), [data_view_field.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.test.ts#:~:text=IndexPatternField)+ 2 more | - | -| | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/index.ts#:~:text=IndexPattern), [data_view_field.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.test.ts#:~:text=IndexPattern), [data_view_field.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.test.ts#:~:text=IndexPattern), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/public/index.ts#:~:text=IndexPattern), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=IndexPattern), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=IndexPattern), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=IndexPattern), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=IndexPattern) | - | -| | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/index.ts#:~:text=IndexPatternsService), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/public/index.ts#:~:text=IndexPatternsService), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/index.ts#:~:text=IndexPatternsService), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/public/index.ts#:~:text=IndexPatternsService) | - | | | [data_view.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.ts#:~:text=flattenHit) | - | | | [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=removeScriptedField) | - | | | [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=getNonScriptedFields) | - | @@ -216,19 +205,29 @@ warning: This document is auto-generated and is meant to be viewed inside our ex +## dataVisualizer + +| Deprecated API | Reference location(s) | Remove By | +| ---------------|-----------|-----------| +| | [results_links.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/common/components/results_links/results_links.tsx#:~:text=TimeRange), [results_links.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/common/components/results_links/results_links.tsx#:~:text=TimeRange), [date_picker_wrapper.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/common/components/date_picker_wrapper/date_picker_wrapper.tsx#:~:text=TimeRange), [date_picker_wrapper.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/common/components/date_picker_wrapper/date_picker_wrapper.tsx#:~:text=TimeRange), [search_panel.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/search_panel/search_panel.tsx#:~:text=TimeRange), [search_panel.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/search_panel/search_panel.tsx#:~:text=TimeRange), [locator.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/locator/locator.ts#:~:text=TimeRange), [locator.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/locator/locator.ts#:~:text=TimeRange) | 8.1 | +| | [results_links.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/common/components/results_links/results_links.tsx#:~:text=TimeRange), [results_links.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/common/components/results_links/results_links.tsx#:~:text=TimeRange), [date_picker_wrapper.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/common/components/date_picker_wrapper/date_picker_wrapper.tsx#:~:text=TimeRange), [date_picker_wrapper.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/common/components/date_picker_wrapper/date_picker_wrapper.tsx#:~:text=TimeRange), [search_panel.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/search_panel/search_panel.tsx#:~:text=TimeRange), [search_panel.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/search_panel/search_panel.tsx#:~:text=TimeRange), [locator.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/locator/locator.ts#:~:text=TimeRange), [locator.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/locator/locator.ts#:~:text=TimeRange) | 8.1 | +| | [results_links.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/common/components/results_links/results_links.tsx#:~:text=TimeRange), [results_links.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/common/components/results_links/results_links.tsx#:~:text=TimeRange), [date_picker_wrapper.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/common/components/date_picker_wrapper/date_picker_wrapper.tsx#:~:text=TimeRange), [date_picker_wrapper.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/common/components/date_picker_wrapper/date_picker_wrapper.tsx#:~:text=TimeRange), [search_panel.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/search_panel/search_panel.tsx#:~:text=TimeRange), [search_panel.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/search_panel/search_panel.tsx#:~:text=TimeRange), [locator.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/locator/locator.ts#:~:text=TimeRange), [locator.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/locator/locator.ts#:~:text=TimeRange) | 8.1 | + + + ## discover | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| -| | [view_alert_route.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/view_alert/view_alert_route.tsx#:~:text=IndexPattern), [view_alert_route.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/view_alert/view_alert_route.tsx#:~:text=IndexPattern), [view_alert_route.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/view_alert/view_alert_route.tsx#:~:text=IndexPattern), [view_alert_route.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/view_alert/view_alert_route.tsx#:~:text=IndexPattern) | - | | | [saved_search_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/saved_search_embeddable.tsx#:~:text=create), [saved_search_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/saved_search_embeddable.tsx#:~:text=create) | - | +| | [locator.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/locator.ts#:~:text=TimeRange), [locator.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/locator.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/types.ts#:~:text=TimeRange), [saved_search_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/saved_search_embeddable.tsx#:~:text=TimeRange), [saved_search_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/saved_search_embeddable.tsx#:~:text=TimeRange), [search_embeddable_factory.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/search_embeddable_factory.ts#:~:text=TimeRange), [search_embeddable_factory.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/search_embeddable_factory.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/components/layout/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/components/layout/types.ts#:~:text=TimeRange)+ 2 more | 8.1 | | | [discover_state.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/services/discover_state.ts#:~:text=syncQueryStateWithUrl), [discover_state.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/services/discover_state.ts#:~:text=syncQueryStateWithUrl) | - | | | [plugin.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/plugin.tsx#:~:text=indexPatterns) | - | | | [view_alert_route.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/view_alert/view_alert_route.tsx#:~:text=Filter), [view_alert_route.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/view_alert/view_alert_route.tsx#:~:text=Filter) | 8.1 | | | [view_alert_route.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/view_alert/view_alert_route.tsx#:~:text=Filter), [view_alert_route.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/view_alert/view_alert_route.tsx#:~:text=Filter) | 8.1 | -| | [view_alert_route.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/view_alert/view_alert_route.tsx#:~:text=IndexPattern), [view_alert_route.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/view_alert/view_alert_route.tsx#:~:text=IndexPattern), [view_alert_route.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/view_alert/view_alert_route.tsx#:~:text=IndexPattern), [view_alert_route.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/view_alert/view_alert_route.tsx#:~:text=IndexPattern) | - | +| | [locator.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/locator.ts#:~:text=TimeRange), [locator.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/locator.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/types.ts#:~:text=TimeRange), [saved_search_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/saved_search_embeddable.tsx#:~:text=TimeRange), [saved_search_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/saved_search_embeddable.tsx#:~:text=TimeRange), [search_embeddable_factory.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/search_embeddable_factory.ts#:~:text=TimeRange), [search_embeddable_factory.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/search_embeddable_factory.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/components/layout/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/components/layout/types.ts#:~:text=TimeRange)+ 2 more | 8.1 | | | [saved_search_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/saved_search_embeddable.tsx#:~:text=create), [saved_search_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/saved_search_embeddable.tsx#:~:text=create) | - | -| | [view_alert_route.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/view_alert/view_alert_route.tsx#:~:text=IndexPattern), [view_alert_route.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/view_alert/view_alert_route.tsx#:~:text=IndexPattern) | - | +| | [locator.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/locator.ts#:~:text=TimeRange), [locator.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/locator.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/types.ts#:~:text=TimeRange), [saved_search_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/saved_search_embeddable.tsx#:~:text=TimeRange), [saved_search_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/saved_search_embeddable.tsx#:~:text=TimeRange), [search_embeddable_factory.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/search_embeddable_factory.ts#:~:text=TimeRange), [search_embeddable_factory.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/search_embeddable_factory.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/components/layout/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/components/layout/types.ts#:~:text=TimeRange)+ 2 more | 8.1 | | | [view_alert_route.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/view_alert/view_alert_route.tsx#:~:text=Filter), [view_alert_route.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/view_alert/view_alert_route.tsx#:~:text=Filter) | 8.1 | | | [on_save_search.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/components/top_nav/on_save_search.tsx#:~:text=SavedObjectSaveModal), [on_save_search.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/components/top_nav/on_save_search.tsx#:~:text=SavedObjectSaveModal) | 8.8.0 | | | [saved_search_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/saved_search_embeddable.tsx#:~:text=executeTriggerActions), [search_embeddable_factory.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/search_embeddable_factory.ts#:~:text=executeTriggerActions), [plugin.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/plugin.tsx#:~:text=executeTriggerActions) | - | @@ -237,6 +236,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex +## discoverEnhanced + +| Deprecated API | Reference location(s) | Remove By | +| ---------------|-----------|-----------| +| | [explore_data_context_menu_action.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts#:~:text=TimeRange), [explore_data_context_menu_action.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts#:~:text=TimeRange) | 8.1 | +| | [explore_data_context_menu_action.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts#:~:text=TimeRange), [explore_data_context_menu_action.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts#:~:text=TimeRange) | 8.1 | +| | [explore_data_context_menu_action.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts#:~:text=TimeRange), [explore_data_context_menu_action.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts#:~:text=TimeRange) | 8.1 | + + + ## embeddable | Deprecated API | Reference location(s) | Remove By | @@ -284,6 +293,9 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| +| | [agent_logs.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/agent_logs.tsx#:~:text=TimeRange), [agent_logs.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/agent_logs.tsx#:~:text=TimeRange), [agent_logs.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/agent_logs.tsx#:~:text=TimeRange) | 8.1 | +| | [agent_logs.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/agent_logs.tsx#:~:text=TimeRange), [agent_logs.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/agent_logs.tsx#:~:text=TimeRange), [agent_logs.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/agent_logs.tsx#:~:text=TimeRange) | 8.1 | +| | [agent_logs.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/agent_logs.tsx#:~:text=TimeRange), [agent_logs.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/agent_logs.tsx#:~:text=TimeRange), [agent_logs.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/agent_logs.tsx#:~:text=TimeRange) | 8.1 | | | [tutorial_directory_header_link.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/public/components/home_integration/tutorial_directory_header_link.tsx#:~:text=RedirectAppLinks), [tutorial_directory_header_link.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/public/components/home_integration/tutorial_directory_header_link.tsx#:~:text=RedirectAppLinks), [tutorial_directory_header_link.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/public/components/home_integration/tutorial_directory_header_link.tsx#:~:text=RedirectAppLinks), [custom_assets_accordion.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/public/components/custom_assets_accordion.tsx#:~:text=RedirectAppLinks), [custom_assets_accordion.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/public/components/custom_assets_accordion.tsx#:~:text=RedirectAppLinks), [custom_assets_accordion.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/public/components/custom_assets_accordion.tsx#:~:text=RedirectAppLinks), [agent_logs.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/agent_logs.tsx#:~:text=RedirectAppLinks), [agent_logs.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/agent_logs.tsx#:~:text=RedirectAppLinks), [agent_logs.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/agent_logs.tsx#:~:text=RedirectAppLinks), [app.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/public/applications/integrations/app.tsx#:~:text=RedirectAppLinks)+ 5 more | - | | | [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/server/plugin.ts#:~:text=disabled) | 8.8.0 | | | [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/server/plugin.ts#:~:text=disabled) | 8.8.0 | @@ -298,7 +310,7 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | ---------------|-----------|-----------| | | [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/public/plugin.ts#:~:text=indexPatterns) | - | | | [deserialize.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/public/services/persistence/deserialize.ts#:~:text=getNonScriptedFields), [datasource.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/public/state_management/datasource.test.ts#:~:text=getNonScriptedFields), [deserialize.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/public/services/persistence/deserialize.test.ts#:~:text=getNonScriptedFields), [deserialize.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/public/services/persistence/deserialize.test.ts#:~:text=getNonScriptedFields), [deserialize.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/public/services/persistence/deserialize.ts#:~:text=getNonScriptedFields), [datasource.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/public/state_management/datasource.test.ts#:~:text=getNonScriptedFields), [deserialize.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/public/services/persistence/deserialize.test.ts#:~:text=getNonScriptedFields), [deserialize.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/public/services/persistence/deserialize.test.ts#:~:text=getNonScriptedFields) | - | -| | [deserialize.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/public/services/persistence/deserialize.ts#:~:text=getNonScriptedFields), [datasource.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/public/state_management/datasource.test.ts#:~:text=getNonScriptedFields), [deserialize.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/public/services/persistence/deserialize.test.ts#:~:text=getNonScriptedFields), [deserialize.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/public/services/persistence/deserialize.test.ts#:~:text=getNonScriptedFields) | - | +| | [deserialize.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/public/services/persistence/deserialize.ts#:~:text=getNonScriptedFields), [datasource.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/public/state_management/datasource.test.ts#:~:text=getNonScriptedFields), [deserialize.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/public/services/persistence/deserialize.test.ts#:~:text=getNonScriptedFields), [deserialize.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/public/services/persistence/deserialize.test.ts#:~:text=getNonScriptedFields), [deserialize.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/public/services/persistence/deserialize.ts#:~:text=getNonScriptedFields), [datasource.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/public/state_management/datasource.test.ts#:~:text=getNonScriptedFields), [deserialize.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/public/services/persistence/deserialize.test.ts#:~:text=getNonScriptedFields), [deserialize.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/public/services/persistence/deserialize.test.ts#:~:text=getNonScriptedFields) | - | | | [deserialize.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/public/services/persistence/deserialize.ts#:~:text=getNonScriptedFields), [datasource.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/public/state_management/datasource.test.ts#:~:text=getNonScriptedFields), [deserialize.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/public/services/persistence/deserialize.test.ts#:~:text=getNonScriptedFields), [deserialize.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/public/services/persistence/deserialize.test.ts#:~:text=getNonScriptedFields) | - | | | [save_modal.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/public/components/save_modal.tsx#:~:text=SavedObjectSaveModal), [save_modal.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/public/components/save_modal.tsx#:~:text=SavedObjectSaveModal) | 8.8.0 | | | [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/server/plugin.ts#:~:text=license%24) | 8.8.0 | @@ -326,8 +338,10 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| +| | [use_log_entry_rate_results_url_state.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/pages/logs/log_entry_rate/use_log_entry_rate_results_url_state.tsx#:~:text=TimeRange), [use_kibana_timefilter_time.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx#:~:text=TimeRange), [use_kibana_timefilter_time.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx#:~:text=TimeRange), [use_kibana_timefilter_time.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx#:~:text=TimeRange), [use_kibana_timefilter_time.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx#:~:text=TimeRange), [use_kibana_timefilter_time.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx#:~:text=TimeRange), [log_stream_embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/components/log_stream/log_stream_embeddable.tsx#:~:text=TimeRange), [log_stream_embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/components/log_stream/log_stream_embeddable.tsx#:~:text=TimeRange), [use_log_entry_rate_results_url_state.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/pages/logs/log_entry_rate/use_log_entry_rate_results_url_state.tsx#:~:text=TimeRange), [use_log_entry_rate_results_url_state.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/pages/logs/log_entry_rate/use_log_entry_rate_results_url_state.tsx#:~:text=TimeRange)+ 1 more | 8.1 | | | [use_kibana_index_patterns.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/hooks/use_kibana_index_patterns.ts#:~:text=indexPatterns) | - | -| | [kibana_framework_adapter.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/server/lib/adapters/framework/kibana_framework_adapter.ts#:~:text=indexPatternsServiceFactory) | - | +| | [use_log_entry_rate_results_url_state.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/pages/logs/log_entry_rate/use_log_entry_rate_results_url_state.tsx#:~:text=TimeRange), [use_kibana_timefilter_time.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx#:~:text=TimeRange), [use_kibana_timefilter_time.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx#:~:text=TimeRange), [use_kibana_timefilter_time.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx#:~:text=TimeRange), [use_kibana_timefilter_time.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx#:~:text=TimeRange), [use_kibana_timefilter_time.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx#:~:text=TimeRange), [log_stream_embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/components/log_stream/log_stream_embeddable.tsx#:~:text=TimeRange), [log_stream_embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/components/log_stream/log_stream_embeddable.tsx#:~:text=TimeRange), [use_log_entry_rate_results_url_state.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/pages/logs/log_entry_rate/use_log_entry_rate_results_url_state.tsx#:~:text=TimeRange), [use_log_entry_rate_results_url_state.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/pages/logs/log_entry_rate/use_log_entry_rate_results_url_state.tsx#:~:text=TimeRange)+ 1 more | 8.1 | +| | [use_log_entry_rate_results_url_state.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/pages/logs/log_entry_rate/use_log_entry_rate_results_url_state.tsx#:~:text=TimeRange), [use_kibana_timefilter_time.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx#:~:text=TimeRange), [use_kibana_timefilter_time.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx#:~:text=TimeRange), [use_kibana_timefilter_time.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx#:~:text=TimeRange), [use_kibana_timefilter_time.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx#:~:text=TimeRange), [use_kibana_timefilter_time.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx#:~:text=TimeRange), [log_stream_embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/components/log_stream/log_stream_embeddable.tsx#:~:text=TimeRange), [log_stream_embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/components/log_stream/log_stream_embeddable.tsx#:~:text=TimeRange), [use_log_entry_rate_results_url_state.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/pages/logs/log_entry_rate/use_log_entry_rate_results_url_state.tsx#:~:text=TimeRange), [use_log_entry_rate_results_url_state.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/pages/logs/log_entry_rate/use_log_entry_rate_results_url_state.tsx#:~:text=TimeRange)+ 1 more | 8.1 | | | [page_template.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/pages/logs/page_template.tsx#:~:text=KibanaPageTemplateProps), [page_template.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/pages/logs/page_template.tsx#:~:text=KibanaPageTemplateProps), [page_template.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/pages/metrics/page_template.tsx#:~:text=KibanaPageTemplateProps), [page_template.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/pages/metrics/page_template.tsx#:~:text=KibanaPageTemplateProps) | - | @@ -365,10 +379,13 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| +| | [embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/embeddable/embeddable.tsx#:~:text=TimeRange), [embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/embeddable/embeddable.tsx#:~:text=TimeRange), [embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/embeddable/embeddable.tsx#:~:text=TimeRange), [embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/embeddable/embeddable.tsx#:~:text=TimeRange), [embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/embeddable/embeddable.tsx#:~:text=TimeRange), [open_in_discover_helpers.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/trigger_actions/open_in_discover_helpers.ts#:~:text=TimeRange), [open_in_discover_helpers.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/trigger_actions/open_in_discover_helpers.ts#:~:text=TimeRange), [open_in_discover_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/trigger_actions/open_in_discover_drilldown.tsx#:~:text=TimeRange), [open_in_discover_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/trigger_actions/open_in_discover_drilldown.tsx#:~:text=TimeRange), [time_scale.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/common/expressions/time_scale/time_scale.test.ts#:~:text=TimeRange)+ 1 more | 8.1 | | | [app.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/app_plugin/app.tsx#:~:text=syncQueryStateWithUrl), [app.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/app_plugin/app.tsx#:~:text=syncQueryStateWithUrl) | - | | | [ranges.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/ranges/ranges.tsx#:~:text=fieldFormats), [droppable.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/indexpattern_datasource/dimension_panel/droppable/droppable.test.ts#:~:text=fieldFormats) | - | | | [open_in_discover_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/trigger_actions/open_in_discover_drilldown.tsx#:~:text=Filter), [open_in_discover_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/trigger_actions/open_in_discover_drilldown.tsx#:~:text=Filter) | 8.1 | | | [open_in_discover_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/trigger_actions/open_in_discover_drilldown.tsx#:~:text=Filter), [open_in_discover_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/trigger_actions/open_in_discover_drilldown.tsx#:~:text=Filter) | 8.1 | +| | [embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/embeddable/embeddable.tsx#:~:text=TimeRange), [embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/embeddable/embeddable.tsx#:~:text=TimeRange), [embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/embeddable/embeddable.tsx#:~:text=TimeRange), [embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/embeddable/embeddable.tsx#:~:text=TimeRange), [embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/embeddable/embeddable.tsx#:~:text=TimeRange), [open_in_discover_helpers.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/trigger_actions/open_in_discover_helpers.ts#:~:text=TimeRange), [open_in_discover_helpers.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/trigger_actions/open_in_discover_helpers.ts#:~:text=TimeRange), [open_in_discover_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/trigger_actions/open_in_discover_drilldown.tsx#:~:text=TimeRange), [open_in_discover_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/trigger_actions/open_in_discover_drilldown.tsx#:~:text=TimeRange), [time_scale.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/common/expressions/time_scale/time_scale.test.ts#:~:text=TimeRange)+ 1 more | 8.1 | +| | [embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/embeddable/embeddable.tsx#:~:text=TimeRange), [embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/embeddable/embeddable.tsx#:~:text=TimeRange), [embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/embeddable/embeddable.tsx#:~:text=TimeRange), [embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/embeddable/embeddable.tsx#:~:text=TimeRange), [embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/embeddable/embeddable.tsx#:~:text=TimeRange), [open_in_discover_helpers.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/trigger_actions/open_in_discover_helpers.ts#:~:text=TimeRange), [open_in_discover_helpers.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/trigger_actions/open_in_discover_helpers.ts#:~:text=TimeRange), [open_in_discover_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/trigger_actions/open_in_discover_drilldown.tsx#:~:text=TimeRange), [open_in_discover_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/trigger_actions/open_in_discover_drilldown.tsx#:~:text=TimeRange), [time_scale.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/common/expressions/time_scale/time_scale.test.ts#:~:text=TimeRange)+ 1 more | 8.1 | | | [open_in_discover_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/trigger_actions/open_in_discover_drilldown.tsx#:~:text=Filter), [open_in_discover_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/trigger_actions/open_in_discover_drilldown.tsx#:~:text=Filter) | 8.1 | | | [workspace_panel.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/editor_frame_service/editor_frame/workspace_panel/workspace_panel.tsx#:~:text=RedirectAppLinks), [workspace_panel.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/editor_frame_service/editor_frame/workspace_panel/workspace_panel.tsx#:~:text=RedirectAppLinks), [workspace_panel.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/editor_frame_service/editor_frame/workspace_panel/workspace_panel.tsx#:~:text=RedirectAppLinks) | - | | | [display_duplicate_title_confirm_modal.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/persistence/saved_objects_utils/display_duplicate_title_confirm_modal.ts#:~:text=SavedObject), [display_duplicate_title_confirm_modal.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/persistence/saved_objects_utils/display_duplicate_title_confirm_modal.ts#:~:text=SavedObject), [check_for_duplicate_title.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/persistence/saved_objects_utils/check_for_duplicate_title.ts#:~:text=SavedObject), [check_for_duplicate_title.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/persistence/saved_objects_utils/check_for_duplicate_title.ts#:~:text=SavedObject) | 8.8.0 | @@ -407,23 +424,14 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| -| | [create_doc_source.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/server/data_indexing/create_doc_source.ts#:~:text=IndexPatternsService), [create_doc_source.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/server/data_indexing/create_doc_source.ts#:~:text=IndexPatternsService), [create_doc_source.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/server/data_indexing/create_doc_source.ts#:~:text=IndexPatternsService), [create_doc_source.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/server/data_indexing/create_doc_source.ts#:~:text=IndexPatternsService) | - | -| | [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/lazy_load_bundle/index.ts#:~:text=IndexPatternsContract), [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/lazy_load_bundle/index.ts#:~:text=IndexPatternsContract), [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/lazy_load_bundle/index.ts#:~:text=IndexPatternsContract), [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/lazy_load_bundle/index.ts#:~:text=IndexPatternsContract) | - | -| | [es_tooltip_property.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts#:~:text=IndexPattern), [es_tooltip_property.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts#:~:text=IndexPattern), [percentile_agg_field.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/fields/agg/percentile_agg_field.test.ts#:~:text=IndexPattern), [percentile_agg_field.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/fields/agg/percentile_agg_field.test.ts#:~:text=IndexPattern), [get_docvalue_source_fields.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts#:~:text=IndexPattern), [get_docvalue_source_fields.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts#:~:text=IndexPattern), [get_docvalue_source_fields.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts#:~:text=IndexPattern), [es_tooltip_property.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts#:~:text=IndexPattern), [es_tooltip_property.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts#:~:text=IndexPattern), [percentile_agg_field.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/fields/agg/percentile_agg_field.test.ts#:~:text=IndexPattern)+ 4 more | - | -| | [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField)+ 84 more | - | +| | [vector_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx#:~:text=TimeRange), [vector_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/reducers/map/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/reducers/map/types.ts#:~:text=TimeRange), [map_selectors.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/selectors/map_selectors.ts#:~:text=TimeRange), [map_selectors.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/selectors/map_selectors.ts#:~:text=TimeRange), [map_actions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/actions/map_actions.ts#:~:text=TimeRange), [map_actions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/actions/map_actions.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/routes/map_page/saved_map/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/routes/map_page/saved_map/types.ts#:~:text=TimeRange)+ 36 more | 8.1 | | | [global_sync.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/routes/map_page/url_state/global_sync.ts#:~:text=syncQueryStateWithUrl), [global_sync.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/routes/map_page/url_state/global_sync.ts#:~:text=syncQueryStateWithUrl) | - | | | [kibana_services.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/kibana_services.ts#:~:text=indexPatterns) | - | -| | [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/lazy_load_bundle/index.ts#:~:text=IndexPatternsContract), [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/lazy_load_bundle/index.ts#:~:text=IndexPatternsContract), [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/lazy_load_bundle/index.ts#:~:text=IndexPatternsContract), [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/lazy_load_bundle/index.ts#:~:text=IndexPatternsContract) | - | -| | [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField)+ 84 more | - | -| | [create_doc_source.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/server/data_indexing/create_doc_source.ts#:~:text=IndexPatternsService), [create_doc_source.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/server/data_indexing/create_doc_source.ts#:~:text=IndexPatternsService), [create_doc_source.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/server/data_indexing/create_doc_source.ts#:~:text=IndexPatternsService), [create_doc_source.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/server/data_indexing/create_doc_source.ts#:~:text=IndexPatternsService) | - | -| | [es_tooltip_property.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts#:~:text=IndexPattern), [es_tooltip_property.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts#:~:text=IndexPattern), [percentile_agg_field.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/fields/agg/percentile_agg_field.test.ts#:~:text=IndexPattern), [percentile_agg_field.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/fields/agg/percentile_agg_field.test.ts#:~:text=IndexPattern), [get_docvalue_source_fields.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts#:~:text=IndexPattern), [get_docvalue_source_fields.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts#:~:text=IndexPattern), [get_docvalue_source_fields.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts#:~:text=IndexPattern), [es_tooltip_property.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts#:~:text=IndexPattern), [es_tooltip_property.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts#:~:text=IndexPattern), [percentile_agg_field.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/fields/agg/percentile_agg_field.test.ts#:~:text=IndexPattern)+ 4 more | - | +| | [vector_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx#:~:text=TimeRange), [vector_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/reducers/map/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/reducers/map/types.ts#:~:text=TimeRange), [map_selectors.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/selectors/map_selectors.ts#:~:text=TimeRange), [map_selectors.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/selectors/map_selectors.ts#:~:text=TimeRange), [map_actions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/actions/map_actions.ts#:~:text=TimeRange), [map_actions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/actions/map_actions.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/routes/map_page/saved_map/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/routes/map_page/saved_map/types.ts#:~:text=TimeRange)+ 36 more | 8.1 | | | [es_search_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx#:~:text=flattenHit), [es_search_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx#:~:text=flattenHit), [es_search_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx#:~:text=flattenHit), [es_search_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx#:~:text=flattenHit) | - | -| | [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField)+ 37 more | - | -| | [es_tooltip_property.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts#:~:text=IndexPattern), [es_tooltip_property.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts#:~:text=IndexPattern), [percentile_agg_field.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/fields/agg/percentile_agg_field.test.ts#:~:text=IndexPattern), [percentile_agg_field.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/fields/agg/percentile_agg_field.test.ts#:~:text=IndexPattern), [get_docvalue_source_fields.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts#:~:text=IndexPattern), [get_docvalue_source_fields.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts#:~:text=IndexPattern), [get_docvalue_source_fields.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts#:~:text=IndexPattern) | - | -| | [create_doc_source.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/server/data_indexing/create_doc_source.ts#:~:text=IndexPatternsService), [create_doc_source.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/server/data_indexing/create_doc_source.ts#:~:text=IndexPatternsService), [create_doc_source.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/server/data_indexing/create_doc_source.ts#:~:text=IndexPatternsService), [create_doc_source.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/server/data_indexing/create_doc_source.ts#:~:text=IndexPatternsService) | - | -| | [es_search_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx#:~:text=flattenHit), [es_search_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx#:~:text=flattenHit) | - | +| | [es_search_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx#:~:text=flattenHit), [es_search_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx#:~:text=flattenHit), [es_search_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx#:~:text=flattenHit), [es_search_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx#:~:text=flattenHit) | - | +| | [vector_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx#:~:text=TimeRange), [vector_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/reducers/map/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/reducers/map/types.ts#:~:text=TimeRange), [map_selectors.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/selectors/map_selectors.ts#:~:text=TimeRange), [map_selectors.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/selectors/map_selectors.ts#:~:text=TimeRange), [map_actions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/actions/map_actions.ts#:~:text=TimeRange), [map_actions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/actions/map_actions.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/routes/map_page/saved_map/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/routes/map_page/saved_map/types.ts#:~:text=TimeRange)+ 36 more | 8.1 | | | [es_search_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx#:~:text=flattenHit), [es_search_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx#:~:text=flattenHit) | - | -| | [kibana_server_services.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/server/kibana_server_services.ts#:~:text=indexPatternsServiceFactory), [indexing_routes.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/server/data_indexing/indexing_routes.ts#:~:text=indexPatternsServiceFactory) | - | | | [render_app.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/render_app.tsx#:~:text=onAppLeave), [map_app.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/routes/map_page/map_app/map_app.tsx#:~:text=onAppLeave), [map_page.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/routes/map_page/map_page.tsx#:~:text=onAppLeave) | 8.8.0 | | | [saved_object_migrations.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/server/saved_objects/saved_object_migrations.ts#:~:text=warning) | 8.8.0 | @@ -442,6 +450,9 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| +| | [anomaly_timeline_service.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/services/anomaly_timeline_service.ts#:~:text=TimeRange), [anomaly_timeline_service.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/services/anomaly_timeline_service.ts#:~:text=TimeRange), [anomaly_timeline_service.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/services/anomaly_timeline_service.ts#:~:text=TimeRange), [anomaly_explorer_charts_service.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/services/anomaly_explorer_charts_service.ts#:~:text=TimeRange), [anomaly_explorer_charts_service.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/services/anomaly_explorer_charts_service.ts#:~:text=TimeRange), [anomaly_explorer_charts_service.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/services/anomaly_explorer_charts_service.ts#:~:text=TimeRange), [date_picker_wrapper.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/components/navigation_menu/date_picker_wrapper/date_picker_wrapper.tsx#:~:text=TimeRange), [date_picker_wrapper.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/components/navigation_menu/date_picker_wrapper/date_picker_wrapper.tsx#:~:text=TimeRange), [date_utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/common/util/date_utils.ts#:~:text=TimeRange), [date_utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/common/util/date_utils.ts#:~:text=TimeRange)+ 4 more | 8.1 | +| | [anomaly_timeline_service.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/services/anomaly_timeline_service.ts#:~:text=TimeRange), [anomaly_timeline_service.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/services/anomaly_timeline_service.ts#:~:text=TimeRange), [anomaly_timeline_service.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/services/anomaly_timeline_service.ts#:~:text=TimeRange), [anomaly_explorer_charts_service.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/services/anomaly_explorer_charts_service.ts#:~:text=TimeRange), [anomaly_explorer_charts_service.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/services/anomaly_explorer_charts_service.ts#:~:text=TimeRange), [anomaly_explorer_charts_service.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/services/anomaly_explorer_charts_service.ts#:~:text=TimeRange), [date_picker_wrapper.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/components/navigation_menu/date_picker_wrapper/date_picker_wrapper.tsx#:~:text=TimeRange), [date_picker_wrapper.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/components/navigation_menu/date_picker_wrapper/date_picker_wrapper.tsx#:~:text=TimeRange), [date_utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/common/util/date_utils.ts#:~:text=TimeRange), [date_utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/common/util/date_utils.ts#:~:text=TimeRange)+ 4 more | 8.1 | +| | [anomaly_timeline_service.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/services/anomaly_timeline_service.ts#:~:text=TimeRange), [anomaly_timeline_service.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/services/anomaly_timeline_service.ts#:~:text=TimeRange), [anomaly_timeline_service.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/services/anomaly_timeline_service.ts#:~:text=TimeRange), [anomaly_explorer_charts_service.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/services/anomaly_explorer_charts_service.ts#:~:text=TimeRange), [anomaly_explorer_charts_service.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/services/anomaly_explorer_charts_service.ts#:~:text=TimeRange), [anomaly_explorer_charts_service.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/services/anomaly_explorer_charts_service.ts#:~:text=TimeRange), [date_picker_wrapper.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/components/navigation_menu/date_picker_wrapper/date_picker_wrapper.tsx#:~:text=TimeRange), [date_picker_wrapper.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/components/navigation_menu/date_picker_wrapper/date_picker_wrapper.tsx#:~:text=TimeRange), [date_utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/common/util/date_utils.ts#:~:text=TimeRange), [date_utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/common/util/date_utils.ts#:~:text=TimeRange)+ 4 more | 8.1 | | | [ml_page.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/components/ml_page/ml_page.tsx#:~:text=KibanaPageTemplate), [ml_page.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/components/ml_page/ml_page.tsx#:~:text=KibanaPageTemplate), [ml_page.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/components/ml_page/ml_page.tsx#:~:text=KibanaPageTemplate) | - | | | [ml_page.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/components/ml_page/ml_page.tsx#:~:text=RedirectAppLinks), [ml_page.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/components/ml_page/ml_page.tsx#:~:text=RedirectAppLinks), [ml_page.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/components/ml_page/ml_page.tsx#:~:text=RedirectAppLinks), [jobs_list_page.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/management/jobs_list/components/jobs_list_page/jobs_list_page.tsx#:~:text=RedirectAppLinks), [jobs_list_page.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/management/jobs_list/components/jobs_list_page/jobs_list_page.tsx#:~:text=RedirectAppLinks), [jobs_list_page.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/management/jobs_list/components/jobs_list_page/jobs_list_page.tsx#:~:text=RedirectAppLinks) | - | | | [check_license.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/license/check_license.tsx#:~:text=license%24), [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/plugin.ts#:~:text=license%24) | 8.8.0 | @@ -460,8 +471,10 @@ so TS and code-reference navigation might not highlight them. | | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| +| | [url_state.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/url_state.ts#:~:text=TimeRange), [url_state.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/url_state.ts#:~:text=TimeRange), [global_state_context.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/application/contexts/global_state_context.tsx#:~:text=TimeRange), [global_state_context.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/application/contexts/global_state_context.tsx#:~:text=TimeRange) | 8.1 | | | [url_state.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/url_state.ts#:~:text=syncQueryStateWithUrl), [url_state.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/url_state.ts#:~:text=syncQueryStateWithUrl) | - | -| | [legacy_shims.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/legacy_shims.ts#:~:text=injectedMetadata) | 8.8.0 | +| | [url_state.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/url_state.ts#:~:text=TimeRange), [url_state.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/url_state.ts#:~:text=TimeRange), [global_state_context.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/application/contexts/global_state_context.tsx#:~:text=TimeRange), [global_state_context.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/application/contexts/global_state_context.tsx#:~:text=TimeRange) | 8.1 | +| | [url_state.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/url_state.ts#:~:text=TimeRange), [url_state.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/url_state.ts#:~:text=TimeRange), [global_state_context.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/application/contexts/global_state_context.tsx#:~:text=TimeRange), [global_state_context.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/application/contexts/global_state_context.tsx#:~:text=TimeRange) | 8.1 | | | [bulk_uploader.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/server/kibana_monitoring/bulk_uploader.ts#:~:text=process) | 8.8.0 | @@ -521,10 +534,7 @@ so TS and code-reference navigation might not highlight them. | | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| -| | [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects/public/types.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects/public/types.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects/public/types.ts#:~:text=IndexPattern), [apply_es_resp.ts](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects/public/saved_object/helpers/apply_es_resp.ts#:~:text=IndexPattern), [apply_es_resp.ts](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects/public/saved_object/helpers/apply_es_resp.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects/public/types.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects/public/types.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects/public/types.ts#:~:text=IndexPattern), [apply_es_resp.ts](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects/public/saved_object/helpers/apply_es_resp.ts#:~:text=IndexPattern), [apply_es_resp.ts](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects/public/saved_object/helpers/apply_es_resp.ts#:~:text=IndexPattern) | - | | | [saved_object.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects/public/saved_object/saved_object.test.ts#:~:text=indexPatterns), [saved_object.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects/public/saved_object/saved_object.test.ts#:~:text=indexPatterns) | - | -| | [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects/public/types.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects/public/types.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects/public/types.ts#:~:text=IndexPattern), [apply_es_resp.ts](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects/public/saved_object/helpers/apply_es_resp.ts#:~:text=IndexPattern), [apply_es_resp.ts](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects/public/saved_object/helpers/apply_es_resp.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects/public/types.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects/public/types.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects/public/types.ts#:~:text=IndexPattern), [apply_es_resp.ts](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects/public/saved_object/helpers/apply_es_resp.ts#:~:text=IndexPattern), [apply_es_resp.ts](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects/public/saved_object/helpers/apply_es_resp.ts#:~:text=IndexPattern) | - | -| | [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects/public/types.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects/public/types.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects/public/types.ts#:~:text=IndexPattern), [apply_es_resp.ts](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects/public/saved_object/helpers/apply_es_resp.ts#:~:text=IndexPattern), [apply_es_resp.ts](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects/public/saved_object/helpers/apply_es_resp.ts#:~:text=IndexPattern) | - | @@ -595,9 +605,12 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/ | ---------------|-----------|-----------| | | [wrap_search_source_client.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.ts#:~:text=create) | - | | | [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts#:~:text=fetch) | 8.1 | +| | [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/query_bar/index.tsx#:~:text=TimeRange), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/query_bar/index.tsx#:~:text=TimeRange), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/query_bar/index.tsx#:~:text=TimeRange), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/search_bar/index.tsx#:~:text=TimeRange), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/search_bar/index.tsx#:~:text=TimeRange), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/search_bar/index.tsx#:~:text=TimeRange) | 8.1 | | | [middleware.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/middleware.ts#:~:text=indexPatterns), [dependencies_start_mock.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/mock/endpoint/dependencies_start_mock.ts#:~:text=indexPatterns) | - | +| | [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/query_bar/index.tsx#:~:text=TimeRange), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/query_bar/index.tsx#:~:text=TimeRange), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/query_bar/index.tsx#:~:text=TimeRange), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/search_bar/index.tsx#:~:text=TimeRange), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/search_bar/index.tsx#:~:text=TimeRange), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/search_bar/index.tsx#:~:text=TimeRange) | 8.1 | | | [wrap_search_source_client.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.ts#:~:text=create) | - | | | [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts#:~:text=fetch) | 8.1 | +| | [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/query_bar/index.tsx#:~:text=TimeRange), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/query_bar/index.tsx#:~:text=TimeRange), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/query_bar/index.tsx#:~:text=TimeRange), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/search_bar/index.tsx#:~:text=TimeRange), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/search_bar/index.tsx#:~:text=TimeRange), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/search_bar/index.tsx#:~:text=TimeRange) | 8.1 | | | [policy_config.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [policy_config.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [policy_config.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [fleet_integration.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts#:~:text=mode), [fleet_integration.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [isolation.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/actions/isolation.test.ts#:~:text=mode), [isolation.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/actions/isolation.test.ts#:~:text=mode)+ 2 more | 8.8.0 | | | [policy_config.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [policy_config.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [policy_config.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [fleet_integration.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts#:~:text=mode), [fleet_integration.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [isolation.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/actions/isolation.test.ts#:~:text=mode), [isolation.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/actions/isolation.test.ts#:~:text=mode)+ 2 more | 8.8.0 | | | [request_context_factory.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/request_context_factory.ts#:~:text=authc), [request_context_factory.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/request_context_factory.ts#:~:text=authc), [create_signals_migration_route.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/create_signals_migration_route.ts#:~:text=authc), [delete_signals_migration_route.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/delete_signals_migration_route.ts#:~:text=authc), [finalize_signals_migration_route.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/finalize_signals_migration_route.ts#:~:text=authc), [open_close_signals_route.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/open_close_signals_route.ts#:~:text=authc), [preview_rules_route.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/preview_rules_route.ts#:~:text=authc), [common.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/timeline/utils/common.ts#:~:text=authc) | - | @@ -631,10 +644,10 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/ | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| -| | [fetch_search_source_query.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/server/alert_types/es_query/lib/fetch_search_source_query.ts#:~:text=fetch), [alert_type.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/server/alert_types/es_query/alert_type.test.ts#:~:text=fetch), [alert_type.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/server/alert_types/es_query/alert_type.test.ts#:~:text=fetch) | 8.1 | +| | [fetch_search_source_query.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/server/alert_types/es_query/lib/fetch_search_source_query.ts#:~:text=fetch), [rule_type.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/server/alert_types/es_query/rule_type.test.ts#:~:text=fetch), [rule_type.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/server/alert_types/es_query/rule_type.test.ts#:~:text=fetch) | 8.1 | | | [entity_index_expression.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/entity_index_expression.tsx#:~:text=indexPatterns), [boundary_index_expression.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/boundary_index_expression.tsx#:~:text=indexPatterns), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/index.tsx#:~:text=indexPatterns), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/index.tsx#:~:text=indexPatterns), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/index.tsx#:~:text=indexPatterns) | - | | | [expression.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/threshold/expression.tsx#:~:text=fieldFormats) | - | -| | [fetch_search_source_query.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/server/alert_types/es_query/lib/fetch_search_source_query.ts#:~:text=fetch), [alert_type.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/server/alert_types/es_query/alert_type.test.ts#:~:text=fetch), [alert_type.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/server/alert_types/es_query/alert_type.test.ts#:~:text=fetch) | 8.1 | +| | [fetch_search_source_query.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/server/alert_types/es_query/lib/fetch_search_source_query.ts#:~:text=fetch), [rule_type.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/server/alert_types/es_query/rule_type.test.ts#:~:text=fetch), [rule_type.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/server/alert_types/es_query/rule_type.test.ts#:~:text=fetch) | 8.1 | @@ -655,16 +668,23 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/ +## uiActionsEnhanced + +| Deprecated API | Reference location(s) | Remove By | +| ---------------|-----------|-----------| +| | [customize_time_range_modal.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ui_actions_enhanced/public/customize_time_range_modal.tsx#:~:text=TimeRange), [customize_time_range_modal.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ui_actions_enhanced/public/customize_time_range_modal.tsx#:~:text=TimeRange), [custom_time_range_action.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ui_actions_enhanced/public/custom_time_range_action.tsx#:~:text=TimeRange), [custom_time_range_action.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ui_actions_enhanced/public/custom_time_range_action.tsx#:~:text=TimeRange), [custom_time_range_badge.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ui_actions_enhanced/public/custom_time_range_badge.tsx#:~:text=TimeRange), [custom_time_range_badge.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ui_actions_enhanced/public/custom_time_range_badge.tsx#:~:text=TimeRange), [can_inherit_time_range.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ui_actions_enhanced/public/can_inherit_time_range.ts#:~:text=TimeRange), [can_inherit_time_range.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ui_actions_enhanced/public/can_inherit_time_range.ts#:~:text=TimeRange), [time_range_embeddable.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ui_actions_enhanced/public/test_helpers/time_range_embeddable.ts#:~:text=TimeRange), [time_range_embeddable.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ui_actions_enhanced/public/test_helpers/time_range_embeddable.ts#:~:text=TimeRange)+ 5 more | 8.1 | +| | [customize_time_range_modal.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ui_actions_enhanced/public/customize_time_range_modal.tsx#:~:text=TimeRange), [customize_time_range_modal.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ui_actions_enhanced/public/customize_time_range_modal.tsx#:~:text=TimeRange), [custom_time_range_action.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ui_actions_enhanced/public/custom_time_range_action.tsx#:~:text=TimeRange), [custom_time_range_action.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ui_actions_enhanced/public/custom_time_range_action.tsx#:~:text=TimeRange), [custom_time_range_badge.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ui_actions_enhanced/public/custom_time_range_badge.tsx#:~:text=TimeRange), [custom_time_range_badge.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ui_actions_enhanced/public/custom_time_range_badge.tsx#:~:text=TimeRange), [can_inherit_time_range.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ui_actions_enhanced/public/can_inherit_time_range.ts#:~:text=TimeRange), [can_inherit_time_range.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ui_actions_enhanced/public/can_inherit_time_range.ts#:~:text=TimeRange), [time_range_embeddable.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ui_actions_enhanced/public/test_helpers/time_range_embeddable.ts#:~:text=TimeRange), [time_range_embeddable.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ui_actions_enhanced/public/test_helpers/time_range_embeddable.ts#:~:text=TimeRange)+ 5 more | 8.1 | +| | [customize_time_range_modal.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ui_actions_enhanced/public/customize_time_range_modal.tsx#:~:text=TimeRange), [customize_time_range_modal.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ui_actions_enhanced/public/customize_time_range_modal.tsx#:~:text=TimeRange), [custom_time_range_action.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ui_actions_enhanced/public/custom_time_range_action.tsx#:~:text=TimeRange), [custom_time_range_action.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ui_actions_enhanced/public/custom_time_range_action.tsx#:~:text=TimeRange), [custom_time_range_badge.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ui_actions_enhanced/public/custom_time_range_badge.tsx#:~:text=TimeRange), [custom_time_range_badge.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ui_actions_enhanced/public/custom_time_range_badge.tsx#:~:text=TimeRange), [can_inherit_time_range.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ui_actions_enhanced/public/can_inherit_time_range.ts#:~:text=TimeRange), [can_inherit_time_range.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ui_actions_enhanced/public/can_inherit_time_range.ts#:~:text=TimeRange), [time_range_embeddable.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ui_actions_enhanced/public/test_helpers/time_range_embeddable.ts#:~:text=TimeRange), [time_range_embeddable.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ui_actions_enhanced/public/test_helpers/time_range_embeddable.ts#:~:text=TimeRange)+ 5 more | 8.1 | + + + ## unifiedSearch | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| -| | [query_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts#:~:text=IIndexPattern), [query_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts#:~:text=IIndexPattern), [value_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts#:~:text=IIndexPattern), [value_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts#:~:text=IIndexPattern), [value_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts#:~:text=IIndexPattern), [value.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts#:~:text=IIndexPattern), [value.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts#:~:text=IIndexPattern) | - | -| | [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.tsx#:~:text=IFieldType), [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.tsx#:~:text=IFieldType), [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.tsx#:~:text=IFieldType), [value_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts#:~:text=IFieldType), [value_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts#:~:text=IFieldType), [value_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts#:~:text=IFieldType), [value_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts#:~:text=IFieldType), [value.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts#:~:text=IFieldType), [value.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts#:~:text=IFieldType) | 8.2 | | | [query_string_input.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/query_string_input/query_string_input.tsx#:~:text=indexPatterns) | - | -| | [apply_filter_action.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/actions/apply_filter_action.ts#:~:text=esFilters), [apply_filter_action.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/actions/apply_filter_action.ts#:~:text=esFilters), [apply_filter_action.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/actions/apply_filter_action.ts#:~:text=esFilters) | 8.1 | -| | [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.tsx#:~:text=IFieldType), [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.tsx#:~:text=IFieldType), [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.tsx#:~:text=IFieldType), [value_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts#:~:text=IFieldType), [value_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts#:~:text=IFieldType), [value_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts#:~:text=IFieldType), [value_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts#:~:text=IFieldType), [value.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts#:~:text=IFieldType), [value.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts#:~:text=IFieldType), [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.tsx#:~:text=IFieldType)+ 8 more | 8.2 | -| | [query_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts#:~:text=IIndexPattern), [query_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts#:~:text=IIndexPattern), [value_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts#:~:text=IIndexPattern), [value_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts#:~:text=IIndexPattern), [value_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts#:~:text=IIndexPattern), [value.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts#:~:text=IIndexPattern), [value.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts#:~:text=IIndexPattern), [query_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts#:~:text=IIndexPattern), [query_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts#:~:text=IIndexPattern), [value_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts#:~:text=IIndexPattern)+ 4 more | - | +| | [terms_enum.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/server/autocomplete/terms_enum.ts#:~:text=getFieldByName), [terms_enum.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/server/autocomplete/terms_enum.ts#:~:text=getFieldByName), [terms_agg.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/server/autocomplete/terms_agg.ts#:~:text=getFieldByName), [terms_agg.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/server/autocomplete/terms_agg.ts#:~:text=getFieldByName) | - | +| | [terms_enum.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/server/autocomplete/terms_enum.ts#:~:text=findIndexPatternById), [terms_enum.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/server/autocomplete/terms_enum.ts#:~:text=findIndexPatternById), [terms_agg.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/server/autocomplete/terms_agg.ts#:~:text=findIndexPatternById), [terms_agg.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/server/autocomplete/terms_agg.ts#:~:text=findIndexPatternById) | - | @@ -681,8 +701,11 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/ | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| +| | [context_variables.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/variables/context_variables.ts#:~:text=TimeRange), [context_variables.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/variables/context_variables.ts#:~:text=TimeRange), [url_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/url_drilldown.tsx#:~:text=TimeRange), [url_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/url_drilldown.tsx#:~:text=TimeRange), [data.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/test/data.ts#:~:text=TimeRange), [data.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/test/data.ts#:~:text=TimeRange) | 8.1 | | | [context_variables.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/variables/context_variables.ts#:~:text=Filter), [context_variables.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/variables/context_variables.ts#:~:text=Filter), [url_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/url_drilldown.tsx#:~:text=Filter), [url_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/url_drilldown.tsx#:~:text=Filter), [data.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/test/data.ts#:~:text=Filter), [data.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/test/data.ts#:~:text=Filter) | 8.1 | | | [context_variables.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/variables/context_variables.ts#:~:text=Filter), [context_variables.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/variables/context_variables.ts#:~:text=Filter), [url_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/url_drilldown.tsx#:~:text=Filter), [url_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/url_drilldown.tsx#:~:text=Filter), [data.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/test/data.ts#:~:text=Filter), [data.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/test/data.ts#:~:text=Filter) | 8.1 | +| | [context_variables.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/variables/context_variables.ts#:~:text=TimeRange), [context_variables.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/variables/context_variables.ts#:~:text=TimeRange), [url_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/url_drilldown.tsx#:~:text=TimeRange), [url_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/url_drilldown.tsx#:~:text=TimeRange), [data.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/test/data.ts#:~:text=TimeRange), [data.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/test/data.ts#:~:text=TimeRange) | 8.1 | +| | [context_variables.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/variables/context_variables.ts#:~:text=TimeRange), [context_variables.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/variables/context_variables.ts#:~:text=TimeRange), [url_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/url_drilldown.tsx#:~:text=TimeRange), [url_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/url_drilldown.tsx#:~:text=TimeRange), [data.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/test/data.ts#:~:text=TimeRange), [data.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/test/data.ts#:~:text=TimeRange) | 8.1 | | | [context_variables.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/variables/context_variables.ts#:~:text=Filter), [context_variables.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/variables/context_variables.ts#:~:text=Filter), [url_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/url_drilldown.tsx#:~:text=Filter), [url_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/url_drilldown.tsx#:~:text=Filter), [data.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/test/data.ts#:~:text=Filter), [data.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/test/data.ts#:~:text=Filter) | 8.1 | @@ -691,9 +714,6 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/ | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| -| | [selected_filters.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_filters.tsx#:~:text=IndexPattern), [selected_filters.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_filters.tsx#:~:text=IndexPattern), [selected_wildcards.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_wildcards.tsx#:~:text=IndexPattern), [selected_wildcards.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_wildcards.tsx#:~:text=IndexPattern), [selected_filters.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_filters.tsx#:~:text=IndexPattern), [selected_filters.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_filters.tsx#:~:text=IndexPattern), [selected_wildcards.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_wildcards.tsx#:~:text=IndexPattern), [selected_wildcards.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_wildcards.tsx#:~:text=IndexPattern) | - | -| | [selected_filters.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_filters.tsx#:~:text=IndexPattern), [selected_filters.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_filters.tsx#:~:text=IndexPattern), [selected_wildcards.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_wildcards.tsx#:~:text=IndexPattern), [selected_wildcards.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_wildcards.tsx#:~:text=IndexPattern), [selected_filters.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_filters.tsx#:~:text=IndexPattern), [selected_filters.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_filters.tsx#:~:text=IndexPattern), [selected_wildcards.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_wildcards.tsx#:~:text=IndexPattern), [selected_wildcards.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_wildcards.tsx#:~:text=IndexPattern) | - | -| | [selected_filters.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_filters.tsx#:~:text=IndexPattern), [selected_filters.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_filters.tsx#:~:text=IndexPattern), [selected_wildcards.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_wildcards.tsx#:~:text=IndexPattern), [selected_wildcards.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_wildcards.tsx#:~:text=IndexPattern) | - | | | [rum_home.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ux/public/components/app/rum_dashboard/rum_home.tsx#:~:text=KibanaPageTemplateProps), [rum_home.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ux/public/components/app/rum_dashboard/rum_home.tsx#:~:text=KibanaPageTemplateProps) | - | | | [ux_app.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ux/public/application/ux_app.tsx#:~:text=RedirectAppLinks), [ux_app.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ux/public/application/ux_app.tsx#:~:text=RedirectAppLinks), [ux_app.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ux/public/application/ux_app.tsx#:~:text=RedirectAppLinks) | - | @@ -703,12 +723,9 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/ | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| -| | [agg_type_filters.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/agg_filters/agg_type_filters.ts#:~:text=IndexPattern), [agg_type_filters.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/agg_filters/agg_type_filters.ts#:~:text=IndexPattern), [agg_type_filters.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/agg_filters/agg_type_filters.ts#:~:text=IndexPattern), [editor_config.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/utils/editor_config.ts#:~:text=IndexPattern), [editor_config.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/utils/editor_config.ts#:~:text=IndexPattern), [agg_params_helper.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg_params_helper.ts#:~:text=IndexPattern), [agg_params_helper.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg_params_helper.ts#:~:text=IndexPattern), [agg_select.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg_select.tsx#:~:text=IndexPattern), [agg_select.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg_select.tsx#:~:text=IndexPattern), [agg_params.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg_params.tsx#:~:text=IndexPattern)+ 16 more | - | -| | [agg_type_field_filters.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/agg_filters/agg_type_field_filters.ts#:~:text=IndexPatternField), [agg_type_field_filters.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/agg_filters/agg_type_field_filters.ts#:~:text=IndexPatternField), [agg_type_field_filters.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/agg_filters/agg_type_field_filters.ts#:~:text=IndexPatternField), [agg_param_props.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg_param_props.ts#:~:text=IndexPatternField), [agg_param_props.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg_param_props.ts#:~:text=IndexPatternField), [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/controls/field.tsx#:~:text=IndexPatternField), [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/controls/field.tsx#:~:text=IndexPatternField), [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/controls/field.tsx#:~:text=IndexPatternField), [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/controls/field.tsx#:~:text=IndexPatternField), [top_field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/controls/top_field.tsx#:~:text=IndexPatternField)+ 26 more | - | -| | [agg_type_field_filters.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/agg_filters/agg_type_field_filters.ts#:~:text=IndexPatternField), [agg_type_field_filters.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/agg_filters/agg_type_field_filters.ts#:~:text=IndexPatternField), [agg_type_field_filters.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/agg_filters/agg_type_field_filters.ts#:~:text=IndexPatternField), [agg_param_props.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg_param_props.ts#:~:text=IndexPatternField), [agg_param_props.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg_param_props.ts#:~:text=IndexPatternField), [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/controls/field.tsx#:~:text=IndexPatternField), [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/controls/field.tsx#:~:text=IndexPatternField), [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/controls/field.tsx#:~:text=IndexPatternField), [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/controls/field.tsx#:~:text=IndexPatternField), [top_field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/controls/top_field.tsx#:~:text=IndexPatternField)+ 26 more | - | -| | [agg_type_filters.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/agg_filters/agg_type_filters.ts#:~:text=IndexPattern), [agg_type_filters.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/agg_filters/agg_type_filters.ts#:~:text=IndexPattern), [agg_type_filters.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/agg_filters/agg_type_filters.ts#:~:text=IndexPattern), [editor_config.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/utils/editor_config.ts#:~:text=IndexPattern), [editor_config.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/utils/editor_config.ts#:~:text=IndexPattern), [agg_params_helper.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg_params_helper.ts#:~:text=IndexPattern), [agg_params_helper.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg_params_helper.ts#:~:text=IndexPattern), [agg_select.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg_select.tsx#:~:text=IndexPattern), [agg_select.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg_select.tsx#:~:text=IndexPattern), [agg_params.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg_params.tsx#:~:text=IndexPattern)+ 16 more | - | -| | [agg_type_field_filters.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/agg_filters/agg_type_field_filters.ts#:~:text=IndexPatternField), [agg_type_field_filters.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/agg_filters/agg_type_field_filters.ts#:~:text=IndexPatternField), [agg_type_field_filters.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/agg_filters/agg_type_field_filters.ts#:~:text=IndexPatternField), [agg_param_props.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg_param_props.ts#:~:text=IndexPatternField), [agg_param_props.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg_param_props.ts#:~:text=IndexPatternField), [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/controls/field.tsx#:~:text=IndexPatternField), [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/controls/field.tsx#:~:text=IndexPatternField), [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/controls/field.tsx#:~:text=IndexPatternField), [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/controls/field.tsx#:~:text=IndexPatternField), [top_field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/controls/top_field.tsx#:~:text=IndexPatternField)+ 8 more | - | -| | [agg_type_filters.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/agg_filters/agg_type_filters.ts#:~:text=IndexPattern), [agg_type_filters.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/agg_filters/agg_type_filters.ts#:~:text=IndexPattern), [agg_type_filters.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/agg_filters/agg_type_filters.ts#:~:text=IndexPattern), [editor_config.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/utils/editor_config.ts#:~:text=IndexPattern), [editor_config.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/utils/editor_config.ts#:~:text=IndexPattern), [agg_params_helper.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg_params_helper.ts#:~:text=IndexPattern), [agg_params_helper.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg_params_helper.ts#:~:text=IndexPattern), [agg_select.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg_select.tsx#:~:text=IndexPattern), [agg_select.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg_select.tsx#:~:text=IndexPattern), [agg_params.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg_params.tsx#:~:text=IndexPattern)+ 3 more | - | +| | [agg.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg.tsx#:~:text=TimeRange), [agg.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg.tsx#:~:text=TimeRange), [agg_group.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg_group.tsx#:~:text=TimeRange), [agg_group.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg_group.tsx#:~:text=TimeRange), [data_tab.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/sidebar/data_tab.tsx#:~:text=TimeRange), [data_tab.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/sidebar/data_tab.tsx#:~:text=TimeRange), [sidebar.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/sidebar/sidebar.tsx#:~:text=TimeRange), [sidebar.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/sidebar/sidebar.tsx#:~:text=TimeRange) | 8.1 | +| | [agg.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg.tsx#:~:text=TimeRange), [agg.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg.tsx#:~:text=TimeRange), [agg_group.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg_group.tsx#:~:text=TimeRange), [agg_group.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg_group.tsx#:~:text=TimeRange), [data_tab.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/sidebar/data_tab.tsx#:~:text=TimeRange), [data_tab.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/sidebar/data_tab.tsx#:~:text=TimeRange), [sidebar.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/sidebar/sidebar.tsx#:~:text=TimeRange), [sidebar.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/sidebar/sidebar.tsx#:~:text=TimeRange) | 8.1 | +| | [agg.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg.tsx#:~:text=TimeRange), [agg.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg.tsx#:~:text=TimeRange), [agg_group.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg_group.tsx#:~:text=TimeRange), [agg_group.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg_group.tsx#:~:text=TimeRange), [data_tab.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/sidebar/data_tab.tsx#:~:text=TimeRange), [data_tab.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/sidebar/data_tab.tsx#:~:text=TimeRange), [sidebar.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/sidebar/sidebar.tsx#:~:text=TimeRange), [sidebar.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/sidebar/sidebar.tsx#:~:text=TimeRange) | 8.1 | @@ -737,18 +754,41 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/ +## visTypeTimelion + +| Deprecated API | Reference location(s) | Remove By | +| ---------------|-----------|-----------| +| | [timelion_vis_fn.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timelion/public/timelion_vis_fn.ts#:~:text=TimeRange), [timelion_vis_fn.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timelion/public/timelion_vis_fn.ts#:~:text=TimeRange), [timelion_request_handler.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timelion/public/helpers/timelion_request_handler.ts#:~:text=TimeRange), [timelion_request_handler.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timelion/public/helpers/timelion_request_handler.ts#:~:text=TimeRange) | 8.1 | +| | [timelion_vis_fn.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timelion/public/timelion_vis_fn.ts#:~:text=TimeRange), [timelion_vis_fn.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timelion/public/timelion_vis_fn.ts#:~:text=TimeRange), [timelion_request_handler.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timelion/public/helpers/timelion_request_handler.ts#:~:text=TimeRange), [timelion_request_handler.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timelion/public/helpers/timelion_request_handler.ts#:~:text=TimeRange) | 8.1 | +| | [timelion_vis_fn.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timelion/public/timelion_vis_fn.ts#:~:text=TimeRange), [timelion_vis_fn.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timelion/public/timelion_vis_fn.ts#:~:text=TimeRange), [timelion_request_handler.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timelion/public/helpers/timelion_request_handler.ts#:~:text=TimeRange), [timelion_request_handler.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timelion/public/helpers/timelion_request_handler.ts#:~:text=TimeRange) | 8.1 | + + + ## visTypeTimeseries | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| +| | [vis_editor.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/public/application/components/vis_editor.tsx#:~:text=TimeRange), [vis_editor.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/public/application/components/vis_editor.tsx#:~:text=TimeRange) | 8.1 | | | [plugin.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/public/plugin.ts#:~:text=fieldFormats) | - | +| | [vis_editor.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/public/application/components/vis_editor.tsx#:~:text=TimeRange), [vis_editor.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/public/application/components/vis_editor.tsx#:~:text=TimeRange) | 8.1 | | | [abstract_search_strategy.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/abstract_search_strategy.ts#:~:text=getNonScriptedFields), [fetch_fields.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/public/application/lib/fetch_fields.ts#:~:text=getNonScriptedFields), [abstract_search_strategy.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/abstract_search_strategy.ts#:~:text=getNonScriptedFields), [fetch_fields.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/public/application/lib/fetch_fields.ts#:~:text=getNonScriptedFields) | - | -| | [abstract_search_strategy.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/abstract_search_strategy.ts#:~:text=getNonScriptedFields), [fetch_fields.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/public/application/lib/fetch_fields.ts#:~:text=getNonScriptedFields) | - | +| | [abstract_search_strategy.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/abstract_search_strategy.ts#:~:text=getNonScriptedFields), [fetch_fields.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/public/application/lib/fetch_fields.ts#:~:text=getNonScriptedFields), [abstract_search_strategy.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/abstract_search_strategy.ts#:~:text=getNonScriptedFields), [fetch_fields.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/public/application/lib/fetch_fields.ts#:~:text=getNonScriptedFields) | - | +| | [vis_editor.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/public/application/components/vis_editor.tsx#:~:text=TimeRange), [vis_editor.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/public/application/components/vis_editor.tsx#:~:text=TimeRange) | 8.1 | | | [plugin.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/server/plugin.ts#:~:text=fieldFormats) | - | | | [abstract_search_strategy.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/abstract_search_strategy.ts#:~:text=getNonScriptedFields), [fetch_fields.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/public/application/lib/fetch_fields.ts#:~:text=getNonScriptedFields) | - | +## visTypeVega + +| Deprecated API | Reference location(s) | Remove By | +| ---------------|-----------|-----------| +| | [vega_fn.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/vega/public/vega_fn.ts#:~:text=TimeRange), [vega_fn.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/vega/public/vega_fn.ts#:~:text=TimeRange), [vega_request_handler.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/vega/public/vega_request_handler.ts#:~:text=TimeRange), [vega_request_handler.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/vega/public/vega_request_handler.ts#:~:text=TimeRange), [time_cache.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/vega/public/data_model/time_cache.ts#:~:text=TimeRange), [time_cache.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/vega/public/data_model/time_cache.ts#:~:text=TimeRange), [time_cache.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/vega/public/data_model/time_cache.ts#:~:text=TimeRange) | 8.1 | +| | [vega_fn.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/vega/public/vega_fn.ts#:~:text=TimeRange), [vega_fn.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/vega/public/vega_fn.ts#:~:text=TimeRange), [vega_request_handler.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/vega/public/vega_request_handler.ts#:~:text=TimeRange), [vega_request_handler.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/vega/public/vega_request_handler.ts#:~:text=TimeRange), [time_cache.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/vega/public/data_model/time_cache.ts#:~:text=TimeRange), [time_cache.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/vega/public/data_model/time_cache.ts#:~:text=TimeRange), [time_cache.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/vega/public/data_model/time_cache.ts#:~:text=TimeRange) | 8.1 | +| | [vega_fn.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/vega/public/vega_fn.ts#:~:text=TimeRange), [vega_fn.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/vega/public/vega_fn.ts#:~:text=TimeRange), [vega_request_handler.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/vega/public/vega_request_handler.ts#:~:text=TimeRange), [vega_request_handler.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/vega/public/vega_request_handler.ts#:~:text=TimeRange), [time_cache.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/vega/public/data_model/time_cache.ts#:~:text=TimeRange), [time_cache.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/vega/public/data_model/time_cache.ts#:~:text=TimeRange), [time_cache.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/vega/public/data_model/time_cache.ts#:~:text=TimeRange) | 8.1 | + + + ## visTypeVislib | Deprecated API | Reference location(s) | Remove By | @@ -773,7 +813,10 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/ | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| +| | [visualize_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx#:~:text=TimeRange), [visualize_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx#:~:text=TimeRange), [visualize_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/types.ts#:~:text=TimeRange), [locator.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/common/locator.ts#:~:text=TimeRange), [locator.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/common/locator.ts#:~:text=TimeRange) | 8.1 | | | [app.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/app.tsx#:~:text=syncQueryStateWithUrl), [app.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/app.tsx#:~:text=syncQueryStateWithUrl) | - | +| | [visualize_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx#:~:text=TimeRange), [visualize_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx#:~:text=TimeRange), [visualize_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/types.ts#:~:text=TimeRange), [locator.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/common/locator.ts#:~:text=TimeRange), [locator.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/common/locator.ts#:~:text=TimeRange) | 8.1 | +| | [visualize_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx#:~:text=TimeRange), [visualize_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx#:~:text=TimeRange), [visualize_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/types.ts#:~:text=TimeRange), [locator.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/common/locator.ts#:~:text=TimeRange), [locator.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/common/locator.ts#:~:text=TimeRange) | 8.1 | | | [get_table_columns.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/utils/get_table_columns.tsx#:~:text=RedirectAppLinks), [get_table_columns.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/utils/get_table_columns.tsx#:~:text=RedirectAppLinks), [get_table_columns.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/utils/get_table_columns.tsx#:~:text=RedirectAppLinks) | - | | | [display_duplicate_title_confirm_modal.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/utils/saved_objects_utils/display_duplicate_title_confirm_modal.ts#:~:text=SavedObject), [display_duplicate_title_confirm_modal.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/utils/saved_objects_utils/display_duplicate_title_confirm_modal.ts#:~:text=SavedObject), [check_for_duplicate_title.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/utils/saved_objects_utils/check_for_duplicate_title.ts#:~:text=SavedObject), [check_for_duplicate_title.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/utils/saved_objects_utils/check_for_duplicate_title.ts#:~:text=SavedObject) | 8.8.0 | | | [visualize_top_nav.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/components/visualize_top_nav.tsx#:~:text=onAppLeave), [visualize_editor_common.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/components/visualize_editor_common.tsx#:~:text=onAppLeave), [app.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/app.tsx#:~:text=onAppLeave), [index.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/index.tsx#:~:text=onAppLeave) | 8.8.0 | diff --git a/api_docs/deprecations_by_team.mdx b/api_docs/deprecations_by_team.mdx index 8c94102fdb2b6c..857b50bfc6422a 100644 --- a/api_docs/deprecations_by_team.mdx +++ b/api_docs/deprecations_by_team.mdx @@ -3,7 +3,7 @@ id: kibDevDocsDeprecationsDueByTeam slug: /kibana-dev-docs/api-meta/deprecations-due-by-team title: Deprecated APIs due to be removed, by team summary: Lists the teams that are referencing deprecated APIs with a remove by date. -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. --- @@ -25,8 +25,9 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Plugin | Deprecated API | Reference location(s) | Remove By | | --------|-------|-----------|-----------| -| dataViews | | [utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/utils.ts#:~:text=IFieldType), [utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/utils.ts#:~:text=IFieldType), [data_view_field.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.ts#:~:text=IFieldType), [data_view_field.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/index.ts#:~:text=IFieldType), [data_view.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.ts#:~:text=IFieldType)+ 7 more | 8.2 | -| dataViews | | [utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/utils.ts#:~:text=IFieldType), [utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/utils.ts#:~:text=IFieldType), [data_view_field.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.ts#:~:text=IFieldType), [data_view_field.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/index.ts#:~:text=IFieldType), [data_view.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.ts#:~:text=IFieldType)+ 23 more | 8.2 | +| uiActionsEnhanced | | [customize_time_range_modal.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ui_actions_enhanced/public/customize_time_range_modal.tsx#:~:text=TimeRange), [customize_time_range_modal.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ui_actions_enhanced/public/customize_time_range_modal.tsx#:~:text=TimeRange), [custom_time_range_action.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ui_actions_enhanced/public/custom_time_range_action.tsx#:~:text=TimeRange), [custom_time_range_action.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ui_actions_enhanced/public/custom_time_range_action.tsx#:~:text=TimeRange), [custom_time_range_badge.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ui_actions_enhanced/public/custom_time_range_badge.tsx#:~:text=TimeRange), [custom_time_range_badge.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ui_actions_enhanced/public/custom_time_range_badge.tsx#:~:text=TimeRange), [can_inherit_time_range.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ui_actions_enhanced/public/can_inherit_time_range.ts#:~:text=TimeRange), [can_inherit_time_range.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ui_actions_enhanced/public/can_inherit_time_range.ts#:~:text=TimeRange), [time_range_embeddable.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ui_actions_enhanced/public/test_helpers/time_range_embeddable.ts#:~:text=TimeRange), [time_range_embeddable.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ui_actions_enhanced/public/test_helpers/time_range_embeddable.ts#:~:text=TimeRange)+ 13 more | 8.1 | +| uiActionsEnhanced | | [customize_time_range_modal.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ui_actions_enhanced/public/customize_time_range_modal.tsx#:~:text=TimeRange), [customize_time_range_modal.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ui_actions_enhanced/public/customize_time_range_modal.tsx#:~:text=TimeRange), [custom_time_range_action.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ui_actions_enhanced/public/custom_time_range_action.tsx#:~:text=TimeRange), [custom_time_range_action.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ui_actions_enhanced/public/custom_time_range_action.tsx#:~:text=TimeRange), [custom_time_range_badge.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ui_actions_enhanced/public/custom_time_range_badge.tsx#:~:text=TimeRange), [custom_time_range_badge.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ui_actions_enhanced/public/custom_time_range_badge.tsx#:~:text=TimeRange), [can_inherit_time_range.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ui_actions_enhanced/public/can_inherit_time_range.ts#:~:text=TimeRange), [can_inherit_time_range.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ui_actions_enhanced/public/can_inherit_time_range.ts#:~:text=TimeRange), [time_range_embeddable.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ui_actions_enhanced/public/test_helpers/time_range_embeddable.ts#:~:text=TimeRange), [time_range_embeddable.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ui_actions_enhanced/public/test_helpers/time_range_embeddable.ts#:~:text=TimeRange)+ 13 more | 8.1 | +| uiActionsEnhanced | | [customize_time_range_modal.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ui_actions_enhanced/public/customize_time_range_modal.tsx#:~:text=TimeRange), [customize_time_range_modal.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ui_actions_enhanced/public/customize_time_range_modal.tsx#:~:text=TimeRange), [custom_time_range_action.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ui_actions_enhanced/public/custom_time_range_action.tsx#:~:text=TimeRange), [custom_time_range_action.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ui_actions_enhanced/public/custom_time_range_action.tsx#:~:text=TimeRange), [custom_time_range_badge.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ui_actions_enhanced/public/custom_time_range_badge.tsx#:~:text=TimeRange), [custom_time_range_badge.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ui_actions_enhanced/public/custom_time_range_badge.tsx#:~:text=TimeRange), [can_inherit_time_range.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ui_actions_enhanced/public/can_inherit_time_range.ts#:~:text=TimeRange), [can_inherit_time_range.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ui_actions_enhanced/public/can_inherit_time_range.ts#:~:text=TimeRange), [time_range_embeddable.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ui_actions_enhanced/public/test_helpers/time_range_embeddable.ts#:~:text=TimeRange), [time_range_embeddable.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ui_actions_enhanced/public/test_helpers/time_range_embeddable.ts#:~:text=TimeRange)+ 13 more | 8.1 | | urlDrilldown | | [context_variables.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/variables/context_variables.ts#:~:text=Filter), [context_variables.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/variables/context_variables.ts#:~:text=Filter), [url_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/url_drilldown.tsx#:~:text=Filter), [url_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/url_drilldown.tsx#:~:text=Filter), [data.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/test/data.ts#:~:text=Filter), [data.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/test/data.ts#:~:text=Filter) | 8.1 | | urlDrilldown | | [context_variables.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/variables/context_variables.ts#:~:text=Filter), [context_variables.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/variables/context_variables.ts#:~:text=Filter), [url_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/url_drilldown.tsx#:~:text=Filter), [url_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/url_drilldown.tsx#:~:text=Filter), [data.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/test/data.ts#:~:text=Filter), [data.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/test/data.ts#:~:text=Filter) | 8.1 | | urlDrilldown | | [context_variables.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/variables/context_variables.ts#:~:text=Filter), [context_variables.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/variables/context_variables.ts#:~:text=Filter), [url_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/url_drilldown.tsx#:~:text=Filter), [url_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/url_drilldown.tsx#:~:text=Filter), [data.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/test/data.ts#:~:text=Filter), [data.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/test/data.ts#:~:text=Filter) | 8.1 | @@ -38,8 +39,11 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Plugin | Deprecated API | Reference location(s) | Remove By | | --------|-------|-----------|-----------| +| discover | | [locator.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/locator.ts#:~:text=TimeRange), [locator.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/locator.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/types.ts#:~:text=TimeRange), [saved_search_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/saved_search_embeddable.tsx#:~:text=TimeRange), [saved_search_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/saved_search_embeddable.tsx#:~:text=TimeRange), [search_embeddable_factory.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/search_embeddable_factory.ts#:~:text=TimeRange), [search_embeddable_factory.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/search_embeddable_factory.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/components/layout/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/components/layout/types.ts#:~:text=TimeRange)+ 4 more | 8.1 | | discover | | [view_alert_route.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/view_alert/view_alert_route.tsx#:~:text=Filter), [view_alert_route.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/view_alert/view_alert_route.tsx#:~:text=Filter) | 8.1 | | discover | | [view_alert_route.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/view_alert/view_alert_route.tsx#:~:text=Filter), [view_alert_route.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/view_alert/view_alert_route.tsx#:~:text=Filter) | 8.1 | +| discover | | [locator.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/locator.ts#:~:text=TimeRange), [locator.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/locator.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/types.ts#:~:text=TimeRange), [saved_search_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/saved_search_embeddable.tsx#:~:text=TimeRange), [saved_search_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/saved_search_embeddable.tsx#:~:text=TimeRange), [search_embeddable_factory.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/search_embeddable_factory.ts#:~:text=TimeRange), [search_embeddable_factory.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/search_embeddable_factory.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/components/layout/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/components/layout/types.ts#:~:text=TimeRange)+ 4 more | 8.1 | +| discover | | [locator.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/locator.ts#:~:text=TimeRange), [locator.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/locator.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/types.ts#:~:text=TimeRange), [saved_search_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/saved_search_embeddable.tsx#:~:text=TimeRange), [saved_search_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/saved_search_embeddable.tsx#:~:text=TimeRange), [search_embeddable_factory.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/search_embeddable_factory.ts#:~:text=TimeRange), [search_embeddable_factory.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/search_embeddable_factory.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/components/layout/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/components/layout/types.ts#:~:text=TimeRange)+ 4 more | 8.1 | | discover | | [view_alert_route.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/view_alert/view_alert_route.tsx#:~:text=Filter), [view_alert_route.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/view_alert/view_alert_route.tsx#:~:text=Filter) | 8.1 | | discover | | [on_save_search.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/components/top_nav/on_save_search.tsx#:~:text=SavedObjectSaveModal), [on_save_search.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/components/top_nav/on_save_search.tsx#:~:text=SavedObjectSaveModal), [save_modal.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/public/components/save_modal.tsx#:~:text=SavedObjectSaveModal), [save_modal.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/public/components/save_modal.tsx#:~:text=SavedObjectSaveModal) | 8.8.0 | | graph | | [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/server/plugin.ts#:~:text=license%24) | 8.8.0 | @@ -50,6 +54,9 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Plugin | Deprecated API | Reference location(s) | Remove By | | --------|-------|-----------|-----------| +| fleet | | [agent_logs.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/agent_logs.tsx#:~:text=TimeRange), [agent_logs.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/agent_logs.tsx#:~:text=TimeRange), [agent_logs.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/agent_logs.tsx#:~:text=TimeRange) | 8.1 | +| fleet | | [agent_logs.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/agent_logs.tsx#:~:text=TimeRange), [agent_logs.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/agent_logs.tsx#:~:text=TimeRange), [agent_logs.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/agent_logs.tsx#:~:text=TimeRange) | 8.1 | +| fleet | | [agent_logs.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/agent_logs.tsx#:~:text=TimeRange), [agent_logs.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/agent_logs.tsx#:~:text=TimeRange), [agent_logs.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/agent_logs.tsx#:~:text=TimeRange) | 8.1 | | fleet | | [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/server/plugin.ts#:~:text=disabled) | 8.8.0 | | fleet | | [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/server/plugin.ts#:~:text=disabled) | 8.8.0 | | fleet | | [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/server/plugin.ts#:~:text=disabled) | 8.8.0 | @@ -61,6 +68,9 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Plugin | Deprecated API | Reference location(s) | Remove By | | --------|-------|-----------|-----------| +| maps | | [vector_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx#:~:text=TimeRange), [vector_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/reducers/map/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/reducers/map/types.ts#:~:text=TimeRange), [map_selectors.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/selectors/map_selectors.ts#:~:text=TimeRange), [map_selectors.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/selectors/map_selectors.ts#:~:text=TimeRange), [map_actions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/actions/map_actions.ts#:~:text=TimeRange), [map_actions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/actions/map_actions.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/routes/map_page/saved_map/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/routes/map_page/saved_map/types.ts#:~:text=TimeRange)+ 36 more | 8.1 | +| maps | | [vector_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx#:~:text=TimeRange), [vector_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/reducers/map/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/reducers/map/types.ts#:~:text=TimeRange), [map_selectors.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/selectors/map_selectors.ts#:~:text=TimeRange), [map_selectors.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/selectors/map_selectors.ts#:~:text=TimeRange), [map_actions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/actions/map_actions.ts#:~:text=TimeRange), [map_actions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/actions/map_actions.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/routes/map_page/saved_map/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/routes/map_page/saved_map/types.ts#:~:text=TimeRange)+ 36 more | 8.1 | +| maps | | [vector_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx#:~:text=TimeRange), [vector_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/reducers/map/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/reducers/map/types.ts#:~:text=TimeRange), [map_selectors.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/selectors/map_selectors.ts#:~:text=TimeRange), [map_selectors.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/selectors/map_selectors.ts#:~:text=TimeRange), [map_actions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/actions/map_actions.ts#:~:text=TimeRange), [map_actions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/actions/map_actions.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/routes/map_page/saved_map/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/routes/map_page/saved_map/types.ts#:~:text=TimeRange)+ 36 more | 8.1 | | maps | | [render_app.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/render_app.tsx#:~:text=onAppLeave), [map_app.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/routes/map_page/map_app/map_app.tsx#:~:text=onAppLeave), [map_page.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/routes/map_page/map_page.tsx#:~:text=onAppLeave) | 8.8.0 | | maps | | [saved_object_migrations.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/server/saved_objects/saved_object_migrations.ts#:~:text=warning) | 8.8.0 | | mapsEms | | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/maps_ems/server/index.ts#:~:text=license%24) | 8.8.0 | @@ -84,8 +94,11 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | --------|-------|-----------|-----------| | inputControlVis | | [list_control_factory.ts](https://github.com/elastic/kibana/tree/master/src/plugins/input_control_vis/public/control/list_control_factory.ts#:~:text=fetch), [range_control_factory.ts](https://github.com/elastic/kibana/tree/master/src/plugins/input_control_vis/public/control/range_control_factory.ts#:~:text=fetch) | 8.1 | | inputControlVis | | [list_control_factory.ts](https://github.com/elastic/kibana/tree/master/src/plugins/input_control_vis/public/control/list_control_factory.ts#:~:text=fetch), [range_control_factory.ts](https://github.com/elastic/kibana/tree/master/src/plugins/input_control_vis/public/control/range_control_factory.ts#:~:text=fetch) | 8.1 | +| dashboard | | [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=TimeRange), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=TimeRange), [dashboard_state_slice.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/state/dashboard_state_slice.ts#:~:text=TimeRange), [dashboard_state_slice.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/state/dashboard_state_slice.ts#:~:text=TimeRange), [convert_dashboard_state.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/convert_dashboard_state.ts#:~:text=TimeRange), [convert_dashboard_state.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/convert_dashboard_state.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/types.ts#:~:text=TimeRange), [dashboard_container.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#:~:text=TimeRange)+ 20 more | 8.1 | | dashboard | | [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [saved_dashboard.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#:~:text=Filter), [saved_dashboard.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#:~:text=Filter), [dashboard_state_slice.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/state/dashboard_state_slice.ts#:~:text=Filter), [dashboard_state_slice.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/state/dashboard_state_slice.ts#:~:text=Filter), [dashboard_state_slice.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/state/dashboard_state_slice.ts#:~:text=Filter)+ 5 more | 8.1 | | dashboard | | [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [saved_dashboard.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#:~:text=Filter), [saved_dashboard.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#:~:text=Filter), [dashboard_state_slice.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/state/dashboard_state_slice.ts#:~:text=Filter), [dashboard_state_slice.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/state/dashboard_state_slice.ts#:~:text=Filter), [dashboard_state_slice.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/state/dashboard_state_slice.ts#:~:text=Filter)+ 5 more | 8.1 | +| dashboard | | [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=TimeRange), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=TimeRange), [dashboard_state_slice.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/state/dashboard_state_slice.ts#:~:text=TimeRange), [dashboard_state_slice.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/state/dashboard_state_slice.ts#:~:text=TimeRange), [convert_dashboard_state.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/convert_dashboard_state.ts#:~:text=TimeRange), [convert_dashboard_state.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/convert_dashboard_state.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/types.ts#:~:text=TimeRange), [dashboard_container.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#:~:text=TimeRange)+ 20 more | 8.1 | +| dashboard | | [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=TimeRange), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=TimeRange), [dashboard_state_slice.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/state/dashboard_state_slice.ts#:~:text=TimeRange), [dashboard_state_slice.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/state/dashboard_state_slice.ts#:~:text=TimeRange), [convert_dashboard_state.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/convert_dashboard_state.ts#:~:text=TimeRange), [convert_dashboard_state.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/convert_dashboard_state.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/types.ts#:~:text=TimeRange), [dashboard_container.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#:~:text=TimeRange)+ 20 more | 8.1 | | dashboard | | [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [saved_dashboard.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#:~:text=Filter), [saved_dashboard.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#:~:text=Filter), [dashboard_state_slice.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/state/dashboard_state_slice.ts#:~:text=Filter), [dashboard_state_slice.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/state/dashboard_state_slice.ts#:~:text=Filter), [dashboard_state_slice.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/state/dashboard_state_slice.ts#:~:text=Filter)+ 5 more | 8.1 | | dashboard | | [saved_objects.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/services/saved_objects.ts#:~:text=SavedObjectSaveModal), [save_modal.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/top_nav/save_modal.tsx#:~:text=SavedObjectSaveModal), [save_modal.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/top_nav/save_modal.tsx#:~:text=SavedObjectSaveModal), [saved_object_save_modal_dashboard.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/presentation_util/public/components/saved_object_save_modal_dashboard.tsx#:~:text=SavedObjectSaveModal), [saved_object_save_modal_dashboard.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/presentation_util/public/components/saved_object_save_modal_dashboard.tsx#:~:text=SavedObjectSaveModal) | 8.8.0 | | dashboard | | [saved_object_loader.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/services/saved_object_loader.ts#:~:text=SavedObject), [saved_object_loader.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/services/saved_object_loader.ts#:~:text=SavedObject), [saved_object_loader.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/services/saved_object_loader.ts#:~:text=SavedObject), [saved_objects.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/services/saved_objects.ts#:~:text=SavedObject), [saved_dashboard.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#:~:text=SavedObject), [saved_dashboard.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#:~:text=SavedObject), [dashboard_tagging.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/dashboard_tagging.ts#:~:text=SavedObject), [dashboard_tagging.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/dashboard_tagging.ts#:~:text=SavedObject), [clone_panel_action.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/actions/clone_panel_action.tsx#:~:text=SavedObject), [clone_panel_action.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/actions/clone_panel_action.tsx#:~:text=SavedObject)+ 1 more | 8.8.0 | @@ -103,6 +116,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex +## Logs and Metrics UI + +| Plugin | Deprecated API | Reference location(s) | Remove By | +| --------|-------|-----------|-----------| +| infra | | [use_log_entry_rate_results_url_state.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/pages/logs/log_entry_rate/use_log_entry_rate_results_url_state.tsx#:~:text=TimeRange), [use_kibana_timefilter_time.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx#:~:text=TimeRange), [use_kibana_timefilter_time.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx#:~:text=TimeRange), [use_kibana_timefilter_time.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx#:~:text=TimeRange), [use_kibana_timefilter_time.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx#:~:text=TimeRange), [use_kibana_timefilter_time.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx#:~:text=TimeRange), [log_stream_embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/components/log_stream/log_stream_embeddable.tsx#:~:text=TimeRange), [log_stream_embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/components/log_stream/log_stream_embeddable.tsx#:~:text=TimeRange), [use_log_entry_rate_results_url_state.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/pages/logs/log_entry_rate/use_log_entry_rate_results_url_state.tsx#:~:text=TimeRange), [use_log_entry_rate_results_url_state.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/pages/logs/log_entry_rate/use_log_entry_rate_results_url_state.tsx#:~:text=TimeRange)+ 1 more | 8.1 | +| infra | | [use_log_entry_rate_results_url_state.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/pages/logs/log_entry_rate/use_log_entry_rate_results_url_state.tsx#:~:text=TimeRange), [use_kibana_timefilter_time.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx#:~:text=TimeRange), [use_kibana_timefilter_time.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx#:~:text=TimeRange), [use_kibana_timefilter_time.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx#:~:text=TimeRange), [use_kibana_timefilter_time.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx#:~:text=TimeRange), [use_kibana_timefilter_time.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx#:~:text=TimeRange), [log_stream_embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/components/log_stream/log_stream_embeddable.tsx#:~:text=TimeRange), [log_stream_embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/components/log_stream/log_stream_embeddable.tsx#:~:text=TimeRange), [use_log_entry_rate_results_url_state.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/pages/logs/log_entry_rate/use_log_entry_rate_results_url_state.tsx#:~:text=TimeRange), [use_log_entry_rate_results_url_state.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/pages/logs/log_entry_rate/use_log_entry_rate_results_url_state.tsx#:~:text=TimeRange)+ 1 more | 8.1 | +| infra | | [use_log_entry_rate_results_url_state.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/pages/logs/log_entry_rate/use_log_entry_rate_results_url_state.tsx#:~:text=TimeRange), [use_kibana_timefilter_time.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx#:~:text=TimeRange), [use_kibana_timefilter_time.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx#:~:text=TimeRange), [use_kibana_timefilter_time.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx#:~:text=TimeRange), [use_kibana_timefilter_time.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx#:~:text=TimeRange), [use_kibana_timefilter_time.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx#:~:text=TimeRange), [log_stream_embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/components/log_stream/log_stream_embeddable.tsx#:~:text=TimeRange), [log_stream_embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/components/log_stream/log_stream_embeddable.tsx#:~:text=TimeRange), [use_log_entry_rate_results_url_state.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/pages/logs/log_entry_rate/use_log_entry_rate_results_url_state.tsx#:~:text=TimeRange), [use_log_entry_rate_results_url_state.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/pages/logs/log_entry_rate/use_log_entry_rate_results_url_state.tsx#:~:text=TimeRange)+ 1 more | 8.1 | + + + ## Logstash | Plugin | Deprecated API | Reference location(s) | Remove By | @@ -115,6 +138,9 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Plugin | Deprecated API | Reference location(s) | Remove By | | --------|-------|-----------|-----------| +| dataVisualizer | | [results_links.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/common/components/results_links/results_links.tsx#:~:text=TimeRange), [results_links.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/common/components/results_links/results_links.tsx#:~:text=TimeRange), [date_picker_wrapper.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/common/components/date_picker_wrapper/date_picker_wrapper.tsx#:~:text=TimeRange), [date_picker_wrapper.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/common/components/date_picker_wrapper/date_picker_wrapper.tsx#:~:text=TimeRange), [search_panel.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/search_panel/search_panel.tsx#:~:text=TimeRange), [search_panel.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/search_panel/search_panel.tsx#:~:text=TimeRange), [locator.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/locator/locator.ts#:~:text=TimeRange), [locator.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/locator/locator.ts#:~:text=TimeRange), [anomaly_timeline_service.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/services/anomaly_timeline_service.ts#:~:text=TimeRange), [anomaly_timeline_service.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/services/anomaly_timeline_service.ts#:~:text=TimeRange)+ 12 more | 8.1 | +| dataVisualizer | | [results_links.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/common/components/results_links/results_links.tsx#:~:text=TimeRange), [results_links.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/common/components/results_links/results_links.tsx#:~:text=TimeRange), [date_picker_wrapper.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/common/components/date_picker_wrapper/date_picker_wrapper.tsx#:~:text=TimeRange), [date_picker_wrapper.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/common/components/date_picker_wrapper/date_picker_wrapper.tsx#:~:text=TimeRange), [search_panel.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/search_panel/search_panel.tsx#:~:text=TimeRange), [search_panel.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/search_panel/search_panel.tsx#:~:text=TimeRange), [locator.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/locator/locator.ts#:~:text=TimeRange), [locator.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/locator/locator.ts#:~:text=TimeRange), [anomaly_timeline_service.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/services/anomaly_timeline_service.ts#:~:text=TimeRange), [anomaly_timeline_service.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/services/anomaly_timeline_service.ts#:~:text=TimeRange)+ 12 more | 8.1 | +| dataVisualizer | | [results_links.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/common/components/results_links/results_links.tsx#:~:text=TimeRange), [results_links.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/common/components/results_links/results_links.tsx#:~:text=TimeRange), [date_picker_wrapper.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/common/components/date_picker_wrapper/date_picker_wrapper.tsx#:~:text=TimeRange), [date_picker_wrapper.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/common/components/date_picker_wrapper/date_picker_wrapper.tsx#:~:text=TimeRange), [search_panel.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/search_panel/search_panel.tsx#:~:text=TimeRange), [search_panel.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/search_panel/search_panel.tsx#:~:text=TimeRange), [locator.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/locator/locator.ts#:~:text=TimeRange), [locator.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/locator/locator.ts#:~:text=TimeRange), [anomaly_timeline_service.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/services/anomaly_timeline_service.ts#:~:text=TimeRange), [anomaly_timeline_service.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/services/anomaly_timeline_service.ts#:~:text=TimeRange)+ 12 more | 8.1 | | ml | | [check_license.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/license/check_license.tsx#:~:text=license%24), [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/plugin.ts#:~:text=license%24) | 8.8.0 | | ml | | [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/server/plugin.ts#:~:text=license%24), [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/server/plugin.ts#:~:text=license%24), [license.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/transform/server/services/license.ts#:~:text=license%24) | 8.8.0 | | ml | | [app.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/app.tsx#:~:text=onAppLeave) | 8.8.0 | @@ -155,19 +181,32 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/ | Plugin | Deprecated API | Reference location(s) | Remove By | | --------|-------|-----------|-----------| -| alerting | | [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [fetch_search_source_query.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/server/alert_types/es_query/lib/fetch_search_source_query.ts#:~:text=fetch), [alert_type.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/server/alert_types/es_query/alert_type.test.ts#:~:text=fetch), [alert_type.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/server/alert_types/es_query/alert_type.test.ts#:~:text=fetch) | 8.1 | -| alerting | | [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [fetch_search_source_query.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/server/alert_types/es_query/lib/fetch_search_source_query.ts#:~:text=fetch), [alert_type.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/server/alert_types/es_query/alert_type.test.ts#:~:text=fetch), [alert_type.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/server/alert_types/es_query/alert_type.test.ts#:~:text=fetch) | 8.1 | +| alerting | | [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [fetch_search_source_query.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/server/alert_types/es_query/lib/fetch_search_source_query.ts#:~:text=fetch), [rule_type.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/server/alert_types/es_query/rule_type.test.ts#:~:text=fetch), [rule_type.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/server/alert_types/es_query/rule_type.test.ts#:~:text=fetch) | 8.1 | +| alerting | | [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [fetch_search_source_query.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/server/alert_types/es_query/lib/fetch_search_source_query.ts#:~:text=fetch), [rule_type.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/server/alert_types/es_query/rule_type.test.ts#:~:text=fetch), [rule_type.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/server/alert_types/es_query/rule_type.test.ts#:~:text=fetch) | 8.1 | | alerting | | [plugin.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/plugin.test.ts#:~:text=getKibanaFeatures) | 8.8.0 | | alerting | | [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/plugin.ts#:~:text=license%24), [license_state.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/license_state.test.ts#:~:text=license%24), [license_state.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/license_state.test.ts#:~:text=license%24), [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/actions/server/plugin.ts#:~:text=license%24), [license_state.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/actions/server/lib/license_state.test.ts#:~:text=license%24), [license_state.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/actions/server/lib/license_state.test.ts#:~:text=license%24) | 8.8.0 | +## ResponseOps + +| Plugin | Deprecated API | Reference location(s) | Remove By | +| --------|-------|-----------|-----------| +| cases | | [serializer.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cases/common/utils/markdown_plugins/lens/serializer.ts#:~:text=TimeRange), [serializer.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cases/common/utils/markdown_plugins/lens/serializer.ts#:~:text=TimeRange), [utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cases/common/utils/markdown_plugins/utils.ts#:~:text=TimeRange), [utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cases/common/utils/markdown_plugins/utils.ts#:~:text=TimeRange) | 8.1 | +| cases | | [serializer.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cases/common/utils/markdown_plugins/lens/serializer.ts#:~:text=TimeRange), [serializer.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cases/common/utils/markdown_plugins/lens/serializer.ts#:~:text=TimeRange), [utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cases/common/utils/markdown_plugins/utils.ts#:~:text=TimeRange), [utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cases/common/utils/markdown_plugins/utils.ts#:~:text=TimeRange) | 8.1 | +| cases | | [serializer.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cases/common/utils/markdown_plugins/lens/serializer.ts#:~:text=TimeRange), [serializer.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cases/common/utils/markdown_plugins/lens/serializer.ts#:~:text=TimeRange), [utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cases/common/utils/markdown_plugins/utils.ts#:~:text=TimeRange), [utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cases/common/utils/markdown_plugins/utils.ts#:~:text=TimeRange) | 8.1 | + + + ## Security solution | Plugin | Deprecated API | Reference location(s) | Remove By | | --------|-------|-----------|-----------| | securitySolution | | [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts#:~:text=fetch) | 8.1 | +| securitySolution | | [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/query_bar/index.tsx#:~:text=TimeRange), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/query_bar/index.tsx#:~:text=TimeRange), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/query_bar/index.tsx#:~:text=TimeRange), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/search_bar/index.tsx#:~:text=TimeRange), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/search_bar/index.tsx#:~:text=TimeRange), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/search_bar/index.tsx#:~:text=TimeRange) | 8.1 | +| securitySolution | | [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/query_bar/index.tsx#:~:text=TimeRange), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/query_bar/index.tsx#:~:text=TimeRange), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/query_bar/index.tsx#:~:text=TimeRange), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/search_bar/index.tsx#:~:text=TimeRange), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/search_bar/index.tsx#:~:text=TimeRange), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/search_bar/index.tsx#:~:text=TimeRange) | 8.1 | | securitySolution | | [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts#:~:text=fetch) | 8.1 | +| securitySolution | | [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/query_bar/index.tsx#:~:text=TimeRange), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/query_bar/index.tsx#:~:text=TimeRange), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/query_bar/index.tsx#:~:text=TimeRange), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/search_bar/index.tsx#:~:text=TimeRange), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/search_bar/index.tsx#:~:text=TimeRange), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/search_bar/index.tsx#:~:text=TimeRange) | 8.1 | | securitySolution | | [policy_config.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [policy_config.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [policy_config.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [fleet_integration.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts#:~:text=mode), [fleet_integration.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [isolation.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/actions/isolation.test.ts#:~:text=mode), [isolation.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/actions/isolation.test.ts#:~:text=mode)+ 2 more | 8.8.0 | | securitySolution | | [policy_config.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [policy_config.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [policy_config.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [fleet_integration.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts#:~:text=mode), [fleet_integration.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [isolation.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/actions/isolation.test.ts#:~:text=mode), [isolation.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/actions/isolation.test.ts#:~:text=mode)+ 2 more | 8.8.0 | | securitySolution | | [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/app/index.tsx#:~:text=onAppLeave) | 8.8.0 | @@ -188,25 +227,20 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/ | Plugin | Deprecated API | Reference location(s) | Remove By | | --------|-------|-----------|-----------| -| monitoring | | [legacy_shims.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/legacy_shims.ts#:~:text=injectedMetadata) | 8.8.0 | +| monitoring | | [url_state.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/url_state.ts#:~:text=TimeRange), [url_state.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/url_state.ts#:~:text=TimeRange), [global_state_context.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/application/contexts/global_state_context.tsx#:~:text=TimeRange), [global_state_context.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/application/contexts/global_state_context.tsx#:~:text=TimeRange) | 8.1 | +| monitoring | | [url_state.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/url_state.ts#:~:text=TimeRange), [url_state.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/url_state.ts#:~:text=TimeRange), [global_state_context.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/application/contexts/global_state_context.tsx#:~:text=TimeRange), [global_state_context.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/application/contexts/global_state_context.tsx#:~:text=TimeRange) | 8.1 | +| monitoring | | [url_state.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/url_state.ts#:~:text=TimeRange), [url_state.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/url_state.ts#:~:text=TimeRange), [global_state_context.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/application/contexts/global_state_context.tsx#:~:text=TimeRange), [global_state_context.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/application/contexts/global_state_context.tsx#:~:text=TimeRange) | 8.1 | | monitoring | | [bulk_uploader.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/server/kibana_monitoring/bulk_uploader.ts#:~:text=process) | 8.8.0 | -## Unified Search - -| Plugin | Deprecated API | Reference location(s) | Remove By | -| --------|-------|-----------|-----------| -| unifiedSearch | | [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.tsx#:~:text=IFieldType), [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.tsx#:~:text=IFieldType), [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.tsx#:~:text=IFieldType), [value_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts#:~:text=IFieldType), [value_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts#:~:text=IFieldType), [value_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts#:~:text=IFieldType), [value_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts#:~:text=IFieldType), [value.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts#:~:text=IFieldType), [value.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts#:~:text=IFieldType) | 8.2 | -| unifiedSearch | | [apply_filter_action.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/actions/apply_filter_action.ts#:~:text=esFilters), [apply_filter_action.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/actions/apply_filter_action.ts#:~:text=esFilters), [apply_filter_action.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/actions/apply_filter_action.ts#:~:text=esFilters) | 8.1 | -| unifiedSearch | | [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.tsx#:~:text=IFieldType), [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.tsx#:~:text=IFieldType), [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.tsx#:~:text=IFieldType), [value_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts#:~:text=IFieldType), [value_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts#:~:text=IFieldType), [value_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts#:~:text=IFieldType), [value_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts#:~:text=IFieldType), [value.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts#:~:text=IFieldType), [value.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts#:~:text=IFieldType), [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.tsx#:~:text=IFieldType)+ 8 more | 8.2 | - - - ## Vis Editors | Plugin | Deprecated API | Reference location(s) | Remove By | | --------|-------|-----------|-----------| +| visualizations | | [visualize_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx#:~:text=TimeRange), [visualize_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx#:~:text=TimeRange), [visualize_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/types.ts#:~:text=TimeRange), [locator.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/common/locator.ts#:~:text=TimeRange), [locator.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/common/locator.ts#:~:text=TimeRange), [embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/embeddable/embeddable.tsx#:~:text=TimeRange), [embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/embeddable/embeddable.tsx#:~:text=TimeRange), [embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/embeddable/embeddable.tsx#:~:text=TimeRange)+ 29 more | 8.1 | +| visualizations | | [visualize_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx#:~:text=TimeRange), [visualize_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx#:~:text=TimeRange), [visualize_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/types.ts#:~:text=TimeRange), [locator.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/common/locator.ts#:~:text=TimeRange), [locator.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/common/locator.ts#:~:text=TimeRange), [embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/embeddable/embeddable.tsx#:~:text=TimeRange), [embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/embeddable/embeddable.tsx#:~:text=TimeRange), [embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/embeddable/embeddable.tsx#:~:text=TimeRange)+ 29 more | 8.1 | +| visualizations | | [visualize_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx#:~:text=TimeRange), [visualize_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx#:~:text=TimeRange), [visualize_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/types.ts#:~:text=TimeRange), [locator.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/common/locator.ts#:~:text=TimeRange), [locator.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/common/locator.ts#:~:text=TimeRange), [embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/embeddable/embeddable.tsx#:~:text=TimeRange), [embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/embeddable/embeddable.tsx#:~:text=TimeRange), [embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/embeddable/embeddable.tsx#:~:text=TimeRange)+ 29 more | 8.1 | | visualizations | | [display_duplicate_title_confirm_modal.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/utils/saved_objects_utils/display_duplicate_title_confirm_modal.ts#:~:text=SavedObject), [display_duplicate_title_confirm_modal.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/utils/saved_objects_utils/display_duplicate_title_confirm_modal.ts#:~:text=SavedObject), [check_for_duplicate_title.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/utils/saved_objects_utils/check_for_duplicate_title.ts#:~:text=SavedObject), [check_for_duplicate_title.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/utils/saved_objects_utils/check_for_duplicate_title.ts#:~:text=SavedObject), [display_duplicate_title_confirm_modal.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/persistence/saved_objects_utils/display_duplicate_title_confirm_modal.ts#:~:text=SavedObject), [display_duplicate_title_confirm_modal.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/persistence/saved_objects_utils/display_duplicate_title_confirm_modal.ts#:~:text=SavedObject), [check_for_duplicate_title.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/persistence/saved_objects_utils/check_for_duplicate_title.ts#:~:text=SavedObject), [check_for_duplicate_title.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/persistence/saved_objects_utils/check_for_duplicate_title.ts#:~:text=SavedObject) | 8.8.0 | | visualizations | | [visualize_top_nav.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/components/visualize_top_nav.tsx#:~:text=onAppLeave), [visualize_editor_common.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/components/visualize_editor_common.tsx#:~:text=onAppLeave), [app.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/app.tsx#:~:text=onAppLeave), [index.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/index.tsx#:~:text=onAppLeave), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/app_plugin/types.ts#:~:text=onAppLeave), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/app_plugin/types.ts#:~:text=onAppLeave), [mounter.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/app_plugin/mounter.tsx#:~:text=onAppLeave) | 8.8.0 | | lens | | [open_in_discover_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/trigger_actions/open_in_discover_drilldown.tsx#:~:text=Filter), [open_in_discover_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/trigger_actions/open_in_discover_drilldown.tsx#:~:text=Filter) | 8.1 | diff --git a/api_docs/dev_tools.mdx b/api_docs/dev_tools.mdx index aca0ece095362d..066fb7e1500769 100644 --- a/api_docs/dev_tools.mdx +++ b/api_docs/dev_tools.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/devTools title: "devTools" image: https://source.unsplash.com/400x175/?github summary: API docs for the devTools plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'devTools'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/discover.devdocs.json b/api_docs/discover.devdocs.json index 2680b1282dac29..8a8bc7f7e869a8 100644 --- a/api_docs/discover.devdocs.json +++ b/api_docs/discover.devdocs.json @@ -289,13 +289,7 @@ "\nOptionally set the time range in the time picker." ], "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, + "TimeRange", " | undefined" ], "path": "src/plugins/discover/public/locator.ts", @@ -777,7 +771,15 @@ }, "; serialize: () => { searchSourceJSON: string; references: ", "SavedObjectReference", - "[]; }; }" + "[]; }; toExpressionAst: ({ asDatatable }?: ExpressionAstOptions) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + "; }" ], "path": "src/plugins/discover/public/services/saved_searches/types.ts", "deprecated": false diff --git a/api_docs/discover.mdx b/api_docs/discover.mdx index 07f47f01f9cb08..7e03f7afbfb5e3 100644 --- a/api_docs/discover.mdx +++ b/api_docs/discover.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/discover title: "discover" image: https://source.unsplash.com/400x175/?github summary: API docs for the discover plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discover'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/discover_enhanced.mdx b/api_docs/discover_enhanced.mdx index b836a8f1a4ca82..13ce6dba5e74db 100644 --- a/api_docs/discover_enhanced.mdx +++ b/api_docs/discover_enhanced.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/discoverEnhanced title: "discoverEnhanced" image: https://source.unsplash.com/400x175/?github summary: API docs for the discoverEnhanced plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discoverEnhanced'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/elastic_apm_synthtrace.devdocs.json b/api_docs/elastic_apm_synthtrace.devdocs.json index 9cae9120751e98..7795015f81289c 100644 --- a/api_docs/elastic_apm_synthtrace.devdocs.json +++ b/api_docs/elastic_apm_synthtrace.devdocs.json @@ -955,7 +955,7 @@ "section": "def-server.ApmException", "text": "ApmException" }, - "[]; 'error.grouping_name': string; 'error.grouping_key': string; 'host.name': string; 'kubernetes.pod.uid': string; 'metricset.name': string; observer: ", + "[]; 'error.grouping_name': string; 'error.grouping_key': string; 'host.name': string; 'host.hostname': string; 'kubernetes.pod.uid': string; 'kubernetes.pod.name': string; 'metricset.name': string; observer: ", "Observer", "; 'parent.id': string; 'processor.event': string; 'processor.name': string; 'trace.id': string; 'transaction.name': string; 'transaction.type': string; 'transaction.id': string; 'transaction.duration.us': number; 'transaction.duration.histogram': { values: number[]; counts: number[]; }; 'transaction.sampled': true; 'service.name': string; 'service.version': string; 'service.environment': string; 'service.node.name': string; 'service.runtime.name': string; 'service.runtime.version': string; 'service.framework.name': string; 'span.id': string; 'span.name': string; 'span.type': string; 'span.subtype': string; 'span.duration.us': number; 'span.destination.service.name': string; 'span.destination.service.resource': string; 'span.destination.service.type': string; 'span.destination.service.response_time.sum.us': number; 'span.destination.service.response_time.count': number; 'span.self_time.count': number; 'span.self_time.sum.us': number; 'span.links': { trace: { id: string; }; span: { id: string; }; }[]; 'cloud.provider': string; 'cloud.project.name': string; 'cloud.service.name': string; 'cloud.availability_zone': string; 'cloud.machine.type': string; 'cloud.region': string; 'host.os.platform': string; 'faas.id': string; 'faas.coldstart': boolean; 'faas.execution': string; 'faas.trigger.type': string; 'faas.trigger.request_id': string; }> & Partial<{ 'system.process.memory.size': number; 'system.memory.actual.free': number; 'system.memory.total': number; 'system.cpu.total.norm.pct': number; 'system.process.memory.rss.bytes': number; 'system.process.cpu.total.norm.pct': number; 'jvm.memory.heap.used': number; 'jvm.memory.non_heap.used': number; 'jvm.thread.count': number; }>" ], @@ -1096,7 +1096,7 @@ "section": "def-server.ApmException", "text": "ApmException" }, - "[] | undefined; 'error.grouping_name'?: string | undefined; 'error.grouping_key'?: string | undefined; 'host.name'?: string | undefined; 'kubernetes.pod.uid'?: string | undefined; observer?: ", + "[] | undefined; 'error.grouping_name'?: string | undefined; 'error.grouping_key'?: string | undefined; 'host.name'?: string | undefined; 'host.hostname'?: string | undefined; 'kubernetes.pod.uid'?: string | undefined; 'kubernetes.pod.name'?: string | undefined; observer?: ", "Observer", " | undefined; 'parent.id'?: string | undefined; 'processor.event'?: string | undefined; 'processor.name'?: string | undefined; 'trace.id'?: string | undefined; 'transaction.name'?: string | undefined; 'transaction.type'?: string | undefined; 'transaction.id'?: string | undefined; 'transaction.duration.us'?: number | undefined; 'transaction.sampled'?: true | undefined; 'service.name'?: string | undefined; 'service.version'?: string | undefined; 'service.environment'?: string | undefined; 'service.node.name'?: string | undefined; 'service.runtime.name'?: string | undefined; 'service.runtime.version'?: string | undefined; 'service.framework.name'?: string | undefined; 'span.id'?: string | undefined; 'span.name'?: string | undefined; 'span.type'?: string | undefined; 'span.subtype'?: string | undefined; 'span.duration.us'?: number | undefined; 'span.destination.service.name'?: string | undefined; 'span.destination.service.resource'?: string | undefined; 'span.destination.service.type'?: string | undefined; 'span.destination.service.response_time.sum.us'?: number | undefined; 'span.destination.service.response_time.count'?: number | undefined; 'span.self_time.count'?: number | undefined; 'span.self_time.sum.us'?: number | undefined; 'span.links'?: { trace: { id: string; }; span: { id: string; }; }[] | undefined; 'cloud.provider'?: string | undefined; 'cloud.project.name'?: string | undefined; 'cloud.service.name'?: string | undefined; 'cloud.availability_zone'?: string | undefined; 'cloud.machine.type'?: string | undefined; 'cloud.region'?: string | undefined; 'host.os.platform'?: string | undefined; 'faas.id'?: string | undefined; 'faas.coldstart'?: boolean | undefined; 'faas.execution'?: string | undefined; 'faas.trigger.type'?: string | undefined; 'faas.trigger.request_id'?: string | undefined; 'system.process.memory.size'?: number | undefined; 'system.memory.actual.free'?: number | undefined; 'system.memory.total'?: number | undefined; 'system.cpu.total.norm.pct'?: number | undefined; 'system.process.memory.rss.bytes'?: number | undefined; 'system.process.cpu.total.norm.pct'?: number | undefined; 'jvm.memory.heap.used'?: number | undefined; 'jvm.memory.non_heap.used'?: number | undefined; 'jvm.thread.count'?: number | undefined; }[]" ], @@ -1150,7 +1150,7 @@ "section": "def-server.ApmException", "text": "ApmException" }, - "[] | undefined; 'error.grouping_name'?: string | undefined; 'error.grouping_key'?: string | undefined; 'host.name'?: string | undefined; 'kubernetes.pod.uid'?: string | undefined; observer?: ", + "[] | undefined; 'error.grouping_name'?: string | undefined; 'error.grouping_key'?: string | undefined; 'host.name'?: string | undefined; 'host.hostname'?: string | undefined; 'kubernetes.pod.uid'?: string | undefined; 'kubernetes.pod.name'?: string | undefined; observer?: ", "Observer", " | undefined; 'parent.id'?: string | undefined; 'processor.event'?: string | undefined; 'processor.name'?: string | undefined; 'trace.id'?: string | undefined; 'transaction.name'?: string | undefined; 'transaction.type'?: string | undefined; 'transaction.id'?: string | undefined; 'transaction.duration.us'?: number | undefined; 'transaction.duration.histogram'?: { values: number[]; counts: number[]; } | undefined; 'transaction.sampled'?: true | undefined; 'service.name'?: string | undefined; 'service.version'?: string | undefined; 'service.environment'?: string | undefined; 'service.node.name'?: string | undefined; 'service.runtime.name'?: string | undefined; 'service.runtime.version'?: string | undefined; 'service.framework.name'?: string | undefined; 'span.id'?: string | undefined; 'span.name'?: string | undefined; 'span.type'?: string | undefined; 'span.subtype'?: string | undefined; 'span.duration.us'?: number | undefined; 'span.destination.service.name'?: string | undefined; 'span.destination.service.resource'?: string | undefined; 'span.destination.service.type'?: string | undefined; 'span.self_time.count'?: number | undefined; 'span.self_time.sum.us'?: number | undefined; 'span.links'?: { trace: { id: string; }; span: { id: string; }; }[] | undefined; 'cloud.provider'?: string | undefined; 'cloud.project.name'?: string | undefined; 'cloud.service.name'?: string | undefined; 'cloud.availability_zone'?: string | undefined; 'cloud.machine.type'?: string | undefined; 'cloud.region'?: string | undefined; 'host.os.platform'?: string | undefined; 'faas.id'?: string | undefined; 'faas.coldstart'?: boolean | undefined; 'faas.execution'?: string | undefined; 'faas.trigger.type'?: string | undefined; 'faas.trigger.request_id'?: string | undefined; 'system.process.memory.size'?: number | undefined; 'system.memory.actual.free'?: number | undefined; 'system.memory.total'?: number | undefined; 'system.cpu.total.norm.pct'?: number | undefined; 'system.process.memory.rss.bytes'?: number | undefined; 'system.process.cpu.total.norm.pct'?: number | undefined; 'jvm.memory.heap.used'?: number | undefined; 'jvm.memory.non_heap.used'?: number | undefined; 'jvm.thread.count'?: number | undefined; }[]" ], diff --git a/api_docs/elastic_apm_synthtrace.mdx b/api_docs/elastic_apm_synthtrace.mdx index 8393de70a5e6ae..267202feea7618 100644 --- a/api_docs/elastic_apm_synthtrace.mdx +++ b/api_docs/elastic_apm_synthtrace.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/elastic-apm-synthtrace title: "@elastic/apm-synthtrace" image: https://source.unsplash.com/400x175/?github summary: API docs for the @elastic/apm-synthtrace plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@elastic/apm-synthtrace'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/embeddable.devdocs.json b/api_docs/embeddable.devdocs.json index a5976ceb8f4696..a0411a244b8c5f 100644 --- a/api_docs/embeddable.devdocs.json +++ b/api_docs/embeddable.devdocs.json @@ -3887,7 +3887,7 @@ "\nA wrapper around the {@link ApplicationStart.navigateToApp} method which navigates to the specified appId\nwith {@link EmbeddableEditorState | embeddable editor state}" ], "signature": [ - "(appId: string, options?: { path?: string | undefined; openInNewTab?: boolean | undefined; state: ", + "(appId: string, options?: { path?: string | undefined; openInNewTab?: boolean | undefined; skipAppLeave?: boolean | undefined; state: ", { "pluginId": "embeddable", "scope": "public", @@ -3950,6 +3950,19 @@ "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", "deprecated": false }, + { + "parentPluginId": "embeddable", + "id": "def-public.EmbeddableStateTransfer.navigateToEditor.$2.skipAppLeave", + "type": "CompoundType", + "tags": [], + "label": "skipAppLeave", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", + "deprecated": false + }, { "parentPluginId": "embeddable", "id": "def-public.EmbeddableStateTransfer.navigateToEditor.$2.state", diff --git a/api_docs/embeddable.mdx b/api_docs/embeddable.mdx index a13e8eb4c357a9..21f3b6f7e77d50 100644 --- a/api_docs/embeddable.mdx +++ b/api_docs/embeddable.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/embeddable title: "embeddable" image: https://source.unsplash.com/400x175/?github summary: API docs for the embeddable plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'embeddable'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 486 | 0 | 396 | 3 | +| 487 | 0 | 397 | 3 | ## Client diff --git a/api_docs/embeddable_enhanced.mdx b/api_docs/embeddable_enhanced.mdx index 05fff13665fcb1..a163985350ea40 100644 --- a/api_docs/embeddable_enhanced.mdx +++ b/api_docs/embeddable_enhanced.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/embeddableEnhanced title: "embeddableEnhanced" image: https://source.unsplash.com/400x175/?github summary: API docs for the embeddableEnhanced plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'embeddableEnhanced'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/encrypted_saved_objects.mdx b/api_docs/encrypted_saved_objects.mdx index 4756a8ea73fa54..f8098eb1c52493 100644 --- a/api_docs/encrypted_saved_objects.mdx +++ b/api_docs/encrypted_saved_objects.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/encryptedSavedObjects title: "encryptedSavedObjects" image: https://source.unsplash.com/400x175/?github summary: API docs for the encryptedSavedObjects plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'encryptedSavedObjects'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/enterprise_search.mdx b/api_docs/enterprise_search.mdx index 9e648e6ca85cc0..c5f3475fa88915 100644 --- a/api_docs/enterprise_search.mdx +++ b/api_docs/enterprise_search.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/enterpriseSearch title: "enterpriseSearch" image: https://source.unsplash.com/400x175/?github summary: API docs for the enterpriseSearch plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'enterpriseSearch'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/es_ui_shared.mdx b/api_docs/es_ui_shared.mdx index c85fb60616b151..8c47cb5baa4df5 100644 --- a/api_docs/es_ui_shared.mdx +++ b/api_docs/es_ui_shared.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/esUiShared title: "esUiShared" image: https://source.unsplash.com/400x175/?github summary: API docs for the esUiShared plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'esUiShared'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/event_annotation.mdx b/api_docs/event_annotation.mdx index d998330158a071..343b895aa45714 100644 --- a/api_docs/event_annotation.mdx +++ b/api_docs/event_annotation.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/eventAnnotation title: "eventAnnotation" image: https://source.unsplash.com/400x175/?github summary: API docs for the eventAnnotation plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventAnnotation'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/event_log.devdocs.json b/api_docs/event_log.devdocs.json index 37aeae0f18f446..9474154ebe004c 100644 --- a/api_docs/event_log.devdocs.json +++ b/api_docs/event_log.devdocs.json @@ -1123,7 +1123,7 @@ "label": "data", "description": [], "signature": [ - "(Readonly<{ error?: Readonly<{ message?: string | undefined; id?: string | undefined; type?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; kibana?: Readonly<{ alert?: Readonly<{ rule?: Readonly<{ consumer?: string | undefined; execution?: Readonly<{ status?: string | undefined; metrics?: Readonly<{ number_of_triggered_actions?: string | number | undefined; number_of_generated_actions?: string | number | undefined; alert_counts?: Readonly<{ recovered?: string | number | undefined; active?: string | number | undefined; new?: string | number | undefined; } & {}> | undefined; number_of_searches?: string | number | undefined; total_indexing_duration_ms?: string | number | undefined; es_search_duration_ms?: string | number | undefined; total_search_duration_ms?: string | number | undefined; execution_gap_duration_s?: string | number | undefined; } & {}> | undefined; uuid?: string | undefined; status_order?: string | number | undefined; } & {}> | undefined; rule_type_id?: string | undefined; } & {}> | undefined; } & {}> | undefined; version?: string | undefined; saved_objects?: Readonly<{ id?: string | undefined; type?: string | undefined; namespace?: string | undefined; rel?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ id?: string | undefined; schedule_delay?: string | number | undefined; scheduled?: string | undefined; } & {}> | undefined; space_ids?: string[] | undefined; } & {}> | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; rule?: Readonly<{ id?: string | undefined; description?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; id?: string | undefined; type?: string[] | undefined; outcome?: string | undefined; created?: string | undefined; category?: string[] | undefined; url?: string | undefined; end?: string | undefined; original?: string | undefined; duration?: string | number | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; hash?: string | undefined; severity?: string | number | undefined; dataset?: string | undefined; ingested?: string | undefined; module?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: string | number | undefined; timezone?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; } & {}> | undefined)[]" + "(Readonly<{ error?: Readonly<{ message?: string | undefined; id?: string | undefined; type?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; kibana?: Readonly<{ alert?: Readonly<{ rule?: Readonly<{ consumer?: string | undefined; execution?: Readonly<{ status?: string | undefined; metrics?: Readonly<{ number_of_triggered_actions?: string | number | undefined; number_of_generated_actions?: string | number | undefined; alert_counts?: Readonly<{ recovered?: string | number | undefined; active?: string | number | undefined; new?: string | number | undefined; } & {}> | undefined; number_of_searches?: string | number | undefined; total_indexing_duration_ms?: string | number | undefined; es_search_duration_ms?: string | number | undefined; total_search_duration_ms?: string | number | undefined; execution_gap_duration_s?: string | number | undefined; } & {}> | undefined; uuid?: string | undefined; status_order?: string | number | undefined; } & {}> | undefined; rule_type_id?: string | undefined; } & {}> | undefined; } & {}> | undefined; version?: string | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ id?: string | undefined; schedule_delay?: string | number | undefined; scheduled?: string | undefined; } & {}> | undefined; saved_objects?: Readonly<{ id?: string | undefined; type?: string | undefined; namespace?: string | undefined; rel?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; space_ids?: string[] | undefined; } & {}> | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; rule?: Readonly<{ id?: string | undefined; description?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; id?: string | undefined; type?: string[] | undefined; outcome?: string | undefined; created?: string | undefined; category?: string[] | undefined; url?: string | undefined; end?: string | undefined; original?: string | undefined; duration?: string | number | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; hash?: string | undefined; severity?: string | number | undefined; dataset?: string | undefined; ingested?: string | undefined; module?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: string | number | undefined; timezone?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; } & {}> | undefined)[]" ], "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", "deprecated": false @@ -1142,7 +1142,7 @@ "label": "IEvent", "description": [], "signature": [ - "DeepPartial | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; kibana?: Readonly<{ alert?: Readonly<{ rule?: Readonly<{ consumer?: string | undefined; execution?: Readonly<{ status?: string | undefined; metrics?: Readonly<{ number_of_triggered_actions?: string | number | undefined; number_of_generated_actions?: string | number | undefined; alert_counts?: Readonly<{ recovered?: string | number | undefined; active?: string | number | undefined; new?: string | number | undefined; } & {}> | undefined; number_of_searches?: string | number | undefined; total_indexing_duration_ms?: string | number | undefined; es_search_duration_ms?: string | number | undefined; total_search_duration_ms?: string | number | undefined; execution_gap_duration_s?: string | number | undefined; } & {}> | undefined; uuid?: string | undefined; status_order?: string | number | undefined; } & {}> | undefined; rule_type_id?: string | undefined; } & {}> | undefined; } & {}> | undefined; version?: string | undefined; saved_objects?: Readonly<{ id?: string | undefined; type?: string | undefined; namespace?: string | undefined; rel?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ id?: string | undefined; schedule_delay?: string | number | undefined; scheduled?: string | undefined; } & {}> | undefined; space_ids?: string[] | undefined; } & {}> | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; rule?: Readonly<{ id?: string | undefined; description?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; id?: string | undefined; type?: string[] | undefined; outcome?: string | undefined; created?: string | undefined; category?: string[] | undefined; url?: string | undefined; end?: string | undefined; original?: string | undefined; duration?: string | number | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; hash?: string | undefined; severity?: string | number | undefined; dataset?: string | undefined; ingested?: string | undefined; module?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: string | number | undefined; timezone?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; } & {}>>> | undefined" + "DeepPartial | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; kibana?: Readonly<{ alert?: Readonly<{ rule?: Readonly<{ consumer?: string | undefined; execution?: Readonly<{ status?: string | undefined; metrics?: Readonly<{ number_of_triggered_actions?: string | number | undefined; number_of_generated_actions?: string | number | undefined; alert_counts?: Readonly<{ recovered?: string | number | undefined; active?: string | number | undefined; new?: string | number | undefined; } & {}> | undefined; number_of_searches?: string | number | undefined; total_indexing_duration_ms?: string | number | undefined; es_search_duration_ms?: string | number | undefined; total_search_duration_ms?: string | number | undefined; execution_gap_duration_s?: string | number | undefined; } & {}> | undefined; uuid?: string | undefined; status_order?: string | number | undefined; } & {}> | undefined; rule_type_id?: string | undefined; } & {}> | undefined; } & {}> | undefined; version?: string | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ id?: string | undefined; schedule_delay?: string | number | undefined; scheduled?: string | undefined; } & {}> | undefined; saved_objects?: Readonly<{ id?: string | undefined; type?: string | undefined; namespace?: string | undefined; rel?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; space_ids?: string[] | undefined; } & {}> | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; rule?: Readonly<{ id?: string | undefined; description?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; id?: string | undefined; type?: string[] | undefined; outcome?: string | undefined; created?: string | undefined; category?: string[] | undefined; url?: string | undefined; end?: string | undefined; original?: string | undefined; duration?: string | number | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; hash?: string | undefined; severity?: string | number | undefined; dataset?: string | undefined; ingested?: string | undefined; module?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: string | number | undefined; timezone?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; } & {}>>> | undefined" ], "path": "x-pack/plugins/event_log/generated/schemas.ts", "deprecated": false, @@ -1156,7 +1156,7 @@ "label": "IValidatedEvent", "description": [], "signature": [ - "Readonly<{ error?: Readonly<{ message?: string | undefined; id?: string | undefined; type?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; kibana?: Readonly<{ alert?: Readonly<{ rule?: Readonly<{ consumer?: string | undefined; execution?: Readonly<{ status?: string | undefined; metrics?: Readonly<{ number_of_triggered_actions?: string | number | undefined; number_of_generated_actions?: string | number | undefined; alert_counts?: Readonly<{ recovered?: string | number | undefined; active?: string | number | undefined; new?: string | number | undefined; } & {}> | undefined; number_of_searches?: string | number | undefined; total_indexing_duration_ms?: string | number | undefined; es_search_duration_ms?: string | number | undefined; total_search_duration_ms?: string | number | undefined; execution_gap_duration_s?: string | number | undefined; } & {}> | undefined; uuid?: string | undefined; status_order?: string | number | undefined; } & {}> | undefined; rule_type_id?: string | undefined; } & {}> | undefined; } & {}> | undefined; version?: string | undefined; saved_objects?: Readonly<{ id?: string | undefined; type?: string | undefined; namespace?: string | undefined; rel?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ id?: string | undefined; schedule_delay?: string | number | undefined; scheduled?: string | undefined; } & {}> | undefined; space_ids?: string[] | undefined; } & {}> | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; rule?: Readonly<{ id?: string | undefined; description?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; id?: string | undefined; type?: string[] | undefined; outcome?: string | undefined; created?: string | undefined; category?: string[] | undefined; url?: string | undefined; end?: string | undefined; original?: string | undefined; duration?: string | number | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; hash?: string | undefined; severity?: string | number | undefined; dataset?: string | undefined; ingested?: string | undefined; module?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: string | number | undefined; timezone?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; } & {}> | undefined" + "Readonly<{ error?: Readonly<{ message?: string | undefined; id?: string | undefined; type?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; kibana?: Readonly<{ alert?: Readonly<{ rule?: Readonly<{ consumer?: string | undefined; execution?: Readonly<{ status?: string | undefined; metrics?: Readonly<{ number_of_triggered_actions?: string | number | undefined; number_of_generated_actions?: string | number | undefined; alert_counts?: Readonly<{ recovered?: string | number | undefined; active?: string | number | undefined; new?: string | number | undefined; } & {}> | undefined; number_of_searches?: string | number | undefined; total_indexing_duration_ms?: string | number | undefined; es_search_duration_ms?: string | number | undefined; total_search_duration_ms?: string | number | undefined; execution_gap_duration_s?: string | number | undefined; } & {}> | undefined; uuid?: string | undefined; status_order?: string | number | undefined; } & {}> | undefined; rule_type_id?: string | undefined; } & {}> | undefined; } & {}> | undefined; version?: string | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ id?: string | undefined; schedule_delay?: string | number | undefined; scheduled?: string | undefined; } & {}> | undefined; saved_objects?: Readonly<{ id?: string | undefined; type?: string | undefined; namespace?: string | undefined; rel?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; space_ids?: string[] | undefined; } & {}> | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; rule?: Readonly<{ id?: string | undefined; description?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; id?: string | undefined; type?: string[] | undefined; outcome?: string | undefined; created?: string | undefined; category?: string[] | undefined; url?: string | undefined; end?: string | undefined; original?: string | undefined; duration?: string | number | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; hash?: string | undefined; severity?: string | number | undefined; dataset?: string | undefined; ingested?: string | undefined; module?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: string | number | undefined; timezone?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; } & {}> | undefined" ], "path": "x-pack/plugins/event_log/generated/schemas.ts", "deprecated": false, diff --git a/api_docs/event_log.mdx b/api_docs/event_log.mdx index 2145ea524c6b73..e7fb6cf15e7118 100644 --- a/api_docs/event_log.mdx +++ b/api_docs/event_log.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/eventLog title: "eventLog" image: https://source.unsplash.com/400x175/?github summary: API docs for the eventLog plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventLog'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expression_error.mdx b/api_docs/expression_error.mdx index ed92bc259f3481..e1b38d2b4891ea 100644 --- a/api_docs/expression_error.mdx +++ b/api_docs/expression_error.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionError title: "expressionError" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionError plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionError'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expression_gauge.mdx b/api_docs/expression_gauge.mdx index 2f67074b09ff3f..1b67fb47ad007a 100644 --- a/api_docs/expression_gauge.mdx +++ b/api_docs/expression_gauge.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionGauge title: "expressionGauge" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionGauge plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionGauge'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expression_heatmap.mdx b/api_docs/expression_heatmap.mdx index d52fc5c6ac8f41..4879ace5444cf1 100644 --- a/api_docs/expression_heatmap.mdx +++ b/api_docs/expression_heatmap.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionHeatmap title: "expressionHeatmap" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionHeatmap plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionHeatmap'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expression_image.mdx b/api_docs/expression_image.mdx index 9227f43df484cc..6d157d16018d21 100644 --- a/api_docs/expression_image.mdx +++ b/api_docs/expression_image.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionImage title: "expressionImage" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionImage plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionImage'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expression_metric.mdx b/api_docs/expression_metric.mdx index 8a77a609d2c948..8ca60507b88474 100644 --- a/api_docs/expression_metric.mdx +++ b/api_docs/expression_metric.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionMetric title: "expressionMetric" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionMetric plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionMetric'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expression_metric_vis.mdx b/api_docs/expression_metric_vis.mdx index ad4ff663df3447..210320d0b0128f 100644 --- a/api_docs/expression_metric_vis.mdx +++ b/api_docs/expression_metric_vis.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionMetricVis title: "expressionMetricVis" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionMetricVis plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionMetricVis'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expression_partition_vis.mdx b/api_docs/expression_partition_vis.mdx index e35d34a78a3881..1dc882c83d59b8 100644 --- a/api_docs/expression_partition_vis.mdx +++ b/api_docs/expression_partition_vis.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionPartitionVis title: "expressionPartitionVis" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionPartitionVis plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionPartitionVis'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expression_repeat_image.mdx b/api_docs/expression_repeat_image.mdx index 9dbaddde6b0ce2..e0a41e98806dd8 100644 --- a/api_docs/expression_repeat_image.mdx +++ b/api_docs/expression_repeat_image.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionRepeatImage title: "expressionRepeatImage" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionRepeatImage plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionRepeatImage'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expression_reveal_image.mdx b/api_docs/expression_reveal_image.mdx index aa0e2f15ad1ade..48d5ffda1084c6 100644 --- a/api_docs/expression_reveal_image.mdx +++ b/api_docs/expression_reveal_image.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionRevealImage title: "expressionRevealImage" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionRevealImage plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionRevealImage'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expression_shape.devdocs.json b/api_docs/expression_shape.devdocs.json index 74311788d10a43..722cf3d1474c74 100644 --- a/api_docs/expression_shape.devdocs.json +++ b/api_docs/expression_shape.devdocs.json @@ -636,7 +636,7 @@ "label": "strokeLinecap", "description": [], "signature": [ - "\"square\" | \"inherit\" | \"butt\" | \"round\" | undefined" + "\"inherit\" | \"butt\" | \"round\" | \"square\" | undefined" ], "path": "src/plugins/expression_shape/public/components/reusable/types.tsx", "deprecated": false diff --git a/api_docs/expression_shape.mdx b/api_docs/expression_shape.mdx index 1d7b9d029305e6..37c5aef639bd30 100644 --- a/api_docs/expression_shape.mdx +++ b/api_docs/expression_shape.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionShape title: "expressionShape" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionShape plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionShape'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expression_tagcloud.mdx b/api_docs/expression_tagcloud.mdx index 3b04ac523d9cea..2570f7cce1de73 100644 --- a/api_docs/expression_tagcloud.mdx +++ b/api_docs/expression_tagcloud.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionTagcloud title: "expressionTagcloud" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionTagcloud plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionTagcloud'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expression_x_y.devdocs.json b/api_docs/expression_x_y.devdocs.json index 6e0298f3ebc5cf..f48d22e5c5f23e 100644 --- a/api_docs/expression_x_y.devdocs.json +++ b/api_docs/expression_x_y.devdocs.json @@ -468,6 +468,19 @@ "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", "deprecated": false }, + { + "parentPluginId": "expressionXY", + "id": "def-common.DataLayerArgs.showLines", + "type": "CompoundType", + "tags": [], + "label": "showLines", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", + "deprecated": false + }, { "parentPluginId": "expressionXY", "id": "def-common.DataLayerArgs.pointsRadius", @@ -1141,7 +1154,7 @@ "label": "yLeftScale", "description": [], "signature": [ - "\"time\" | \"log\" | \"sqrt\" | \"linear\"" + "\"time\" | \"log\" | \"linear\" | \"sqrt\"" ], "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", "deprecated": false @@ -1154,7 +1167,7 @@ "label": "yRightScale", "description": [], "signature": [ - "\"time\" | \"log\" | \"sqrt\" | \"linear\"" + "\"time\" | \"log\" | \"linear\" | \"sqrt\"" ], "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", "deprecated": false @@ -1505,6 +1518,42 @@ ], "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", "deprecated": false + }, + { + "parentPluginId": "expressionXY", + "id": "def-common.XYArgs.detailedTooltip", + "type": "CompoundType", + "tags": [], + "label": "detailedTooltip", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", + "deprecated": false + }, + { + "parentPluginId": "expressionXY", + "id": "def-common.XYArgs.orderBucketsBySum", + "type": "CompoundType", + "tags": [], + "label": "orderBucketsBySum", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", + "deprecated": false + }, + { + "parentPluginId": "expressionXY", + "id": "def-common.XYArgs.showTooltip", + "type": "boolean", + "tags": [], + "label": "showTooltip", + "description": [], + "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", + "deprecated": false } ], "initialIsOpen": false @@ -2353,7 +2402,7 @@ "label": "YScaleType", "description": [], "signature": [ - "\"time\" | \"log\" | \"sqrt\" | \"linear\"" + "\"time\" | \"log\" | \"linear\" | \"sqrt\"" ], "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", "deprecated": false, diff --git a/api_docs/expression_x_y.mdx b/api_docs/expression_x_y.mdx index 82084906cd0b21..a1190535ec0afa 100644 --- a/api_docs/expression_x_y.mdx +++ b/api_docs/expression_x_y.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionXY title: "expressionXY" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionXY plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionXY'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 143 | 0 | 133 | 14 | +| 147 | 0 | 137 | 14 | ## Client diff --git a/api_docs/expressions.devdocs.json b/api_docs/expressions.devdocs.json index 4650ac90f934e6..f0d7d9683af42a 100644 --- a/api_docs/expressions.devdocs.json +++ b/api_docs/expressions.devdocs.json @@ -6107,7 +6107,7 @@ "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, - " | ", + " | FunctionArgs[K] | ", { "pluginId": "expressions", "scope": "common", @@ -6120,16 +6120,16 @@ "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstExpression", - "text": "ExpressionAstExpression" + "section": "def-common.ExpressionAstExpressionBuilder", + "text": "ExpressionAstExpressionBuilder" }, - "[] | FunctionArgs[K] | ", + "[] | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstExpressionBuilder", - "text": "ExpressionAstExpressionBuilder" + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" }, "[]; }) => ", { @@ -6185,7 +6185,7 @@ "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, - " | ", + " | FunctionArgs[K] | ", { "pluginId": "expressions", "scope": "common", @@ -6198,16 +6198,16 @@ "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstExpression", - "text": "ExpressionAstExpression" + "section": "def-common.ExpressionAstExpressionBuilder", + "text": "ExpressionAstExpressionBuilder" }, - "[] | FunctionArgs[K] | ", + "[] | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstExpressionBuilder", - "text": "ExpressionAstExpressionBuilder" + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" }, "[]; }" ], @@ -7953,10 +7953,6 @@ "plugin": "canvas", "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/browser/esdocs.ts" }, - { - "plugin": "canvas", - "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/browser/essql.ts" - }, { "plugin": "canvas", "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/server/pointseries/index.ts" @@ -16528,7 +16524,7 @@ "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, - " | ", + " | FunctionArgs[K] | ", { "pluginId": "expressions", "scope": "common", @@ -16541,16 +16537,16 @@ "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstExpression", - "text": "ExpressionAstExpression" + "section": "def-common.ExpressionAstExpressionBuilder", + "text": "ExpressionAstExpressionBuilder" }, - "[] | FunctionArgs[K] | ", + "[] | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstExpressionBuilder", - "text": "ExpressionAstExpressionBuilder" + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" }, "[]; }) => ", { @@ -16606,7 +16602,7 @@ "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, - " | ", + " | FunctionArgs[K] | ", { "pluginId": "expressions", "scope": "common", @@ -16619,16 +16615,16 @@ "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstExpression", - "text": "ExpressionAstExpression" + "section": "def-common.ExpressionAstExpressionBuilder", + "text": "ExpressionAstExpressionBuilder" }, - "[] | FunctionArgs[K] | ", + "[] | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstExpressionBuilder", - "text": "ExpressionAstExpressionBuilder" + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" }, "[]; }" ], @@ -18384,10 +18380,6 @@ "plugin": "canvas", "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/browser/esdocs.ts" }, - { - "plugin": "canvas", - "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/browser/essql.ts" - }, { "plugin": "canvas", "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/server/pointseries/index.ts" @@ -26234,7 +26226,7 @@ "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, - " | ", + " | FunctionArgs[K] | ", { "pluginId": "expressions", "scope": "common", @@ -26247,16 +26239,16 @@ "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstExpression", - "text": "ExpressionAstExpression" + "section": "def-common.ExpressionAstExpressionBuilder", + "text": "ExpressionAstExpressionBuilder" }, - "[] | FunctionArgs[K] | ", + "[] | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstExpressionBuilder", - "text": "ExpressionAstExpressionBuilder" + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" }, "[]; }) => ", { @@ -26312,7 +26304,7 @@ "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, - " | ", + " | FunctionArgs[K] | ", { "pluginId": "expressions", "scope": "common", @@ -26325,16 +26317,16 @@ "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstExpression", - "text": "ExpressionAstExpression" + "section": "def-common.ExpressionAstExpressionBuilder", + "text": "ExpressionAstExpressionBuilder" }, - "[] | FunctionArgs[K] | ", + "[] | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstExpressionBuilder", - "text": "ExpressionAstExpressionBuilder" + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" }, "[]; }" ], @@ -30205,10 +30197,6 @@ "plugin": "canvas", "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/browser/esdocs.ts" }, - { - "plugin": "canvas", - "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/browser/essql.ts" - }, { "plugin": "canvas", "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/server/pointseries/index.ts" @@ -33194,7 +33182,7 @@ "label": "metric", "description": [], "signature": [ - "\"sum\" | \"max\" | \"min\" | \"average\"" + "\"min\" | \"max\" | \"sum\" | \"average\"" ], "path": "src/plugins/expressions/common/expression_functions/specs/overall_metric.ts", "deprecated": false @@ -40290,7 +40278,7 @@ "label": "options", "description": [], "signature": [ - "(\"sum\" | \"max\" | \"min\" | \"average\")[]" + "(\"min\" | \"max\" | \"sum\" | \"average\")[]" ], "path": "src/plugins/expressions/common/expression_functions/specs/overall_metric.ts", "deprecated": false diff --git a/api_docs/expressions.mdx b/api_docs/expressions.mdx index 589244ab069cc5..4eecf372a39eeb 100644 --- a/api_docs/expressions.mdx +++ b/api_docs/expressions.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressions title: "expressions" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressions plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressions'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/features.mdx b/api_docs/features.mdx index 5b2e5c980f2095..f54e79cb083c3a 100644 --- a/api_docs/features.mdx +++ b/api_docs/features.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/features title: "features" image: https://source.unsplash.com/400x175/?github summary: API docs for the features plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'features'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/field_formats.devdocs.json b/api_docs/field_formats.devdocs.json index c95d19bc0e365a..9834f314afd8b1 100644 --- a/api_docs/field_formats.devdocs.json +++ b/api_docs/field_formats.devdocs.json @@ -485,7 +485,15 @@ "label": "textConvert", "description": [], "signature": [ - "(val: string | number, options?: { timezone?: string | undefined; } | undefined) => any" + "(val: string | number, options: ", + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.TextContextTypeOptions", + "text": "TextContextTypeOptions" + }, + " | undefined) => any" ], "path": "src/plugins/field_formats/server/lib/converters/date_server.ts", "deprecated": false, @@ -511,23 +519,19 @@ "tags": [], "label": "options", "description": [], + "signature": [ + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.TextContextTypeOptions", + "text": "TextContextTypeOptions" + }, + " | undefined" + ], "path": "src/plugins/field_formats/server/lib/converters/date_server.ts", "deprecated": false, - "children": [ - { - "parentPluginId": "fieldFormats", - "id": "def-server.DateFormat.textConvert.$2.timezone", - "type": "string", - "tags": [], - "label": "timezone", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/field_formats/server/lib/converters/date_server.ts", - "deprecated": false - } - ] + "isRequired": false } ], "returnComment": [] @@ -558,7 +562,15 @@ "label": "textConvert", "description": [], "signature": [ - "(val: string | number, options?: { timezone?: string | undefined; } | undefined) => any" + "(val: string | number, options: ", + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.TextContextTypeOptions", + "text": "TextContextTypeOptions" + }, + " | undefined) => any" ], "path": "src/plugins/field_formats/server/lib/converters/date_nanos_server.ts", "deprecated": false, @@ -584,23 +596,19 @@ "tags": [], "label": "options", "description": [], + "signature": [ + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.TextContextTypeOptions", + "text": "TextContextTypeOptions" + }, + " | undefined" + ], "path": "src/plugins/field_formats/server/lib/converters/date_nanos_server.ts", "deprecated": false, - "children": [ - { - "parentPluginId": "fieldFormats", - "id": "def-server.DateNanosFormatServer.textConvert.$2.timezone", - "type": "string", - "tags": [], - "label": "timezone", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/field_formats/server/lib/converters/date_nanos_server.ts", - "deprecated": false - } - ] + "isRequired": false } ], "returnComment": [] @@ -827,7 +835,15 @@ "label": "textConvert", "description": [], "signature": [ - "(value: string | number | boolean) => string" + "(value: string | number | boolean, options: ", + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.TextContextTypeOptions", + "text": "TextContextTypeOptions" + }, + " | undefined) => string" ], "path": "src/plugins/field_formats/common/converters/boolean.ts", "deprecated": false, @@ -845,6 +861,27 @@ "path": "src/plugins/field_formats/common/converters/boolean.ts", "deprecated": false, "isRequired": true + }, + { + "parentPluginId": "fieldFormats", + "id": "def-common.BoolFormat.textConvert.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.TextContextTypeOptions", + "text": "TextContextTypeOptions" + }, + " | undefined" + ], + "path": "src/plugins/field_formats/common/converters/boolean.ts", + "deprecated": false, + "isRequired": false } ], "returnComment": [] @@ -1067,7 +1104,15 @@ "label": "htmlConvert", "description": [], "signature": [ - "(val: string | number) => string" + "(val: string | number, options: ", + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.HtmlContextTypeOptions", + "text": "HtmlContextTypeOptions" + }, + " | undefined) => string" ], "path": "src/plugins/field_formats/common/converters/color.tsx", "deprecated": false, @@ -1085,6 +1130,27 @@ "path": "src/plugins/field_formats/common/converters/color.tsx", "deprecated": false, "isRequired": true + }, + { + "parentPluginId": "fieldFormats", + "id": "def-common.ColorFormat.htmlConvert.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.HtmlContextTypeOptions", + "text": "HtmlContextTypeOptions" + }, + " | undefined" + ], + "path": "src/plugins/field_formats/common/converters/color.tsx", + "deprecated": false, + "isRequired": false } ], "returnComment": [] @@ -1579,7 +1645,15 @@ "section": "def-common.FieldFormatsContentType", "text": "FieldFormatsContentType" }, - ", options?: object | ", + ", options?: ", + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.TextContextTypeOptions", + "text": "TextContextTypeOptions" + }, + " | ", { "pluginId": "fieldFormats", "scope": "common", @@ -1636,7 +1710,14 @@ "label": "options", "description": [], "signature": [ - "object | ", + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.TextContextTypeOptions", + "text": "TextContextTypeOptions" + }, + " | ", { "pluginId": "fieldFormats", "scope": "common", @@ -3083,7 +3164,15 @@ "label": "textConvert", "description": [], "signature": [ - "(val: string | GeoJSON.Point | { lat: number; lon: number; }) => string" + "(val: string | GeoJSON.Point | { lat: number; lon: number; }, options: ", + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.TextContextTypeOptions", + "text": "TextContextTypeOptions" + }, + " | undefined) => string" ], "path": "src/plugins/field_formats/common/converters/geo_point.ts", "deprecated": false, @@ -3101,6 +3190,27 @@ "path": "src/plugins/field_formats/common/converters/geo_point.ts", "deprecated": false, "isRequired": true + }, + { + "parentPluginId": "fieldFormats", + "id": "def-common.GeoPointFormat.textConvert.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.TextContextTypeOptions", + "text": "TextContextTypeOptions" + }, + " | undefined" + ], + "path": "src/plugins/field_formats/common/converters/geo_point.ts", + "deprecated": false, + "isRequired": false } ], "returnComment": [] @@ -3239,7 +3349,15 @@ "label": "textConvert", "description": [], "signature": [ - "(val: number) => string" + "(val: number, options: ", + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.TextContextTypeOptions", + "text": "TextContextTypeOptions" + }, + " | undefined) => string" ], "path": "src/plugins/field_formats/common/converters/histogram.ts", "deprecated": false, @@ -3257,6 +3375,27 @@ "path": "src/plugins/field_formats/common/converters/histogram.ts", "deprecated": false, "isRequired": true + }, + { + "parentPluginId": "fieldFormats", + "id": "def-common.HistogramFormat.textConvert.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.TextContextTypeOptions", + "text": "TextContextTypeOptions" + }, + " | undefined" + ], + "path": "src/plugins/field_formats/common/converters/histogram.ts", + "deprecated": false, + "isRequired": false } ], "returnComment": [] @@ -3921,7 +4060,15 @@ "label": "textConvert", "description": [], "signature": [ - "(val: string | number) => string" + "(val: string | number, options: ", + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.TextContextTypeOptions", + "text": "TextContextTypeOptions" + }, + " | undefined) => string" ], "path": "src/plugins/field_formats/common/converters/string.ts", "deprecated": false, @@ -3939,6 +4086,27 @@ "path": "src/plugins/field_formats/common/converters/string.ts", "deprecated": false, "isRequired": true + }, + { + "parentPluginId": "fieldFormats", + "id": "def-common.StringFormat.textConvert.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.TextContextTypeOptions", + "text": "TextContextTypeOptions" + }, + " | undefined" + ], + "path": "src/plugins/field_formats/common/converters/string.ts", + "deprecated": false, + "isRequired": false } ], "returnComment": [] @@ -4449,7 +4617,15 @@ "label": "text", "description": [], "signature": [ - "(value: any, options?: object | undefined) => string" + "(value: any, options?: ", + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.TextContextTypeOptions", + "text": "TextContextTypeOptions" + }, + " | undefined) => string" ], "path": "src/plugins/field_formats/common/types.ts", "deprecated": false, @@ -4471,12 +4647,19 @@ { "parentPluginId": "fieldFormats", "id": "def-common.FieldFormatConvert.text.$2", - "type": "Uncategorized", + "type": "Object", "tags": [], "label": "options", "description": [], "signature": [ - "object | undefined" + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.TextContextTypeOptions", + "text": "TextContextTypeOptions" + }, + " | undefined" ], "path": "src/plugins/field_formats/common/types.ts", "deprecated": false @@ -4632,7 +4815,20 @@ "label": "hit", "description": [], "signature": [ - "{ highlight: Record; } | undefined" + "{ highlight?: Record | undefined; } | undefined" + ], + "path": "src/plugins/field_formats/common/types.ts", + "deprecated": false + }, + { + "parentPluginId": "fieldFormats", + "id": "def-common.HtmlContextTypeOptions.skipFormattingInStringifiedJSON", + "type": "CompoundType", + "tags": [], + "label": "skipFormattingInStringifiedJSON", + "description": [], + "signature": [ + "boolean | undefined" ], "path": "src/plugins/field_formats/common/types.ts", "deprecated": false @@ -4690,6 +4886,47 @@ } ], "initialIsOpen": false + }, + { + "parentPluginId": "fieldFormats", + "id": "def-common.TextContextTypeOptions", + "type": "Interface", + "tags": [], + "label": "TextContextTypeOptions", + "description": [ + "\nPlain text converter options" + ], + "path": "src/plugins/field_formats/common/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "fieldFormats", + "id": "def-common.TextContextTypeOptions.skipFormattingInStringifiedJSON", + "type": "CompoundType", + "tags": [], + "label": "skipFormattingInStringifiedJSON", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/field_formats/common/types.ts", + "deprecated": false + }, + { + "parentPluginId": "fieldFormats", + "id": "def-common.TextContextTypeOptions.timezone", + "type": "string", + "tags": [], + "label": "timezone", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/field_formats/common/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false } ], "enums": [ @@ -4756,41 +4993,7 @@ "path": "src/plugins/field_formats/common/types.ts", "deprecated": false, "returnComment": [], - "children": [ - { - "parentPluginId": "fieldFormats", - "id": "def-common.FieldFormatConvertFunction.$1", - "type": "Any", - "tags": [], - "label": "value", - "description": [], - "signature": [ - "any" - ], - "path": "src/plugins/field_formats/common/types.ts", - "deprecated": false - }, - { - "parentPluginId": "fieldFormats", - "id": "def-common.FieldFormatConvertFunction.$2", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - { - "pluginId": "fieldFormats", - "scope": "common", - "docId": "kibFieldFormatsPluginApi", - "section": "def-common.HtmlContextTypeOptions", - "text": "HtmlContextTypeOptions" - }, - " | undefined" - ], - "path": "src/plugins/field_formats/common/types.ts", - "deprecated": false - } - ], + "children": [], "initialIsOpen": false }, { @@ -5251,23 +5454,23 @@ "section": "def-common.FieldFormatInstanceType", "text": "FieldFormatInstanceType" }, - "[]) => void; register: (fieldFormats: ", + "[]) => void; deserialize: ", { "pluginId": "fieldFormats", "scope": "common", "docId": "kibFieldFormatsPluginApi", - "section": "def-common.FieldFormatInstanceType", - "text": "FieldFormatInstanceType" + "section": "def-common.FormatFactory", + "text": "FormatFactory" }, - "[]) => void; deserialize: ", + "; register: (fieldFormats: ", { "pluginId": "fieldFormats", "scope": "common", "docId": "kibFieldFormatsPluginApi", - "section": "def-common.FormatFactory", - "text": "FormatFactory" + "section": "def-common.FieldFormatInstanceType", + "text": "FieldFormatInstanceType" }, - "; getDefaultConfig: (fieldType: ", + "[]) => void; getDefaultConfig: (fieldType: ", "KBN_FIELD_TYPES", ", esTypes?: ", "ES_FIELD_TYPES", @@ -5427,7 +5630,15 @@ "\nTo plain text converter function" ], "signature": [ - "(value: any, options?: object | undefined) => string" + "(value: any, options?: ", + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.TextContextTypeOptions", + "text": "TextContextTypeOptions" + }, + " | undefined) => string" ], "path": "src/plugins/field_formats/common/types.ts", "deprecated": false, @@ -5449,34 +5660,25 @@ { "parentPluginId": "fieldFormats", "id": "def-common.TextContextTypeConvert.$2", - "type": "Uncategorized", + "type": "Object", "tags": [], "label": "options", "description": [], "signature": [ - "object | undefined" + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.TextContextTypeOptions", + "text": "TextContextTypeOptions" + }, + " | undefined" ], "path": "src/plugins/field_formats/common/types.ts", "deprecated": false } ], "initialIsOpen": false - }, - { - "parentPluginId": "fieldFormats", - "id": "def-common.TextContextTypeOptions", - "type": "Type", - "tags": [], - "label": "TextContextTypeOptions", - "description": [ - "\nPlain text converter options" - ], - "signature": [ - "object" - ], - "path": "src/plugins/field_formats/common/types.ts", - "deprecated": false, - "initialIsOpen": false } ], "objects": [ diff --git a/api_docs/field_formats.mdx b/api_docs/field_formats.mdx index d41029a5f0ff33..3e83a0b3421e62 100644 --- a/api_docs/field_formats.mdx +++ b/api_docs/field_formats.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/fieldFormats title: "fieldFormats" image: https://source.unsplash.com/400x175/?github summary: API docs for the fieldFormats plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fieldFormats'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 290 | 6 | 251 | 3 | +| 294 | 5 | 255 | 3 | ## Client diff --git a/api_docs/file_upload.mdx b/api_docs/file_upload.mdx index 909343c10aae37..decf3c9cd5ff71 100644 --- a/api_docs/file_upload.mdx +++ b/api_docs/file_upload.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/fileUpload title: "fileUpload" image: https://source.unsplash.com/400x175/?github summary: API docs for the fileUpload plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fileUpload'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/fleet.devdocs.json b/api_docs/fleet.devdocs.json index 32ba33ff902a63..e3c431e3335f82 100644 --- a/api_docs/fleet.devdocs.json +++ b/api_docs/fleet.devdocs.json @@ -385,6 +385,21 @@ ], "path": "x-pack/plugins/fleet/public/types/intra_app_route_state.ts", "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-public.IntegrationsAppBrowseRouteState.fromIntegrations", + "type": "CompoundType", + "tags": [], + "label": "fromIntegrations", + "description": [ + "The integration tab the user navigated to details from" + ], + "signature": [ + "\"installed\" | \"updates_available\" | undefined" + ], + "path": "x-pack/plugins/fleet/public/types/intra_app_route_state.ts", + "deprecated": false } ], "initialIsOpen": false @@ -1329,6 +1344,169 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "fleet", + "id": "def-public.PackagePolicyResponseExtension", + "type": "Interface", + "tags": [], + "label": "PackagePolicyResponseExtension", + "description": [], + "path": "x-pack/plugins/fleet/public/types/ui_extensions.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "fleet", + "id": "def-public.PackagePolicyResponseExtension.package", + "type": "string", + "tags": [], + "label": "package", + "description": [], + "path": "x-pack/plugins/fleet/public/types/ui_extensions.ts", + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-public.PackagePolicyResponseExtension.view", + "type": "string", + "tags": [], + "label": "view", + "description": [], + "signature": [ + "\"package-policy-response\"" + ], + "path": "x-pack/plugins/fleet/public/types/ui_extensions.ts", + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-public.PackagePolicyResponseExtension.Component", + "type": "Function", + "tags": [], + "label": "Component", + "description": [], + "signature": [ + "React.ExoticComponent<(", + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.PackagePolicyResponseExtensionComponentProps", + "text": "PackagePolicyResponseExtensionComponentProps" + }, + " & React.RefAttributes>) | (", + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.PackagePolicyResponseExtensionComponentProps", + "text": "PackagePolicyResponseExtensionComponentProps" + }, + " & { children?: React.ReactNode; })> & { readonly _result: ", + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.PackagePolicyResponseExtensionComponent", + "text": "PackagePolicyResponseExtensionComponent" + }, + "; }" + ], + "path": "x-pack/plugins/fleet/public/types/ui_extensions.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "fleet", + "id": "def-public.PackagePolicyResponseExtension.Component.$1", + "type": "Uncategorized", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "P" + ], + "path": "node_modules/@types/react/index.d.ts", + "deprecated": false + } + ] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "fleet", + "id": "def-public.PackagePolicyResponseExtensionComponentProps", + "type": "Interface", + "tags": [], + "label": "PackagePolicyResponseExtensionComponentProps", + "description": [], + "path": "x-pack/plugins/fleet/public/types/ui_extensions.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "fleet", + "id": "def-public.PackagePolicyResponseExtensionComponentProps.agent", + "type": "Object", + "tags": [], + "label": "agent", + "description": [ + "The current agent to retrieve response from" + ], + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.Agent", + "text": "Agent" + } + ], + "path": "x-pack/plugins/fleet/public/types/ui_extensions.ts", + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-public.PackagePolicyResponseExtensionComponentProps.onShowNeedsAttentionBadge", + "type": "Function", + "tags": [], + "label": "onShowNeedsAttentionBadge", + "description": [ + "A callback function to set the `needs attention` state" + ], + "signature": [ + "((val: boolean) => void) | undefined" + ], + "path": "x-pack/plugins/fleet/public/types/ui_extensions.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "fleet", + "id": "def-public.PackagePolicyResponseExtensionComponentProps.onShowNeedsAttentionBadge.$1", + "type": "boolean", + "tags": [], + "label": "val", + "description": [], + "signature": [ + "boolean" + ], + "path": "x-pack/plugins/fleet/public/types/ui_extensions.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, { "parentPluginId": "fleet", "id": "def-public.UIExtensionsStorage", @@ -1346,10 +1524,10 @@ "id": "def-public.UIExtensionsStorage.Unnamed", "type": "IndexSignature", "tags": [], - "label": "[key: string]: Partial>", + "label": "[key: string]: Partial>", "description": [], "signature": [ - "[key: string]: Partial | React.FunctionComponent<", + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.PackagePolicyResponseExtensionComponentProps", + "text": "PackagePolicyResponseExtensionComponentProps" + }, + ">" + ], + "path": "x-pack/plugins/fleet/public/types/ui_extensions.ts", + "deprecated": false, + "initialIsOpen": false + }, { "parentPluginId": "fleet", "id": "def-public.UIExtensionPoint", @@ -1568,6 +1778,14 @@ "text": "PackagePolicyEditExtension" }, " | ", + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.PackagePolicyResponseExtension", + "text": "PackagePolicyResponseExtension" + }, + " | ", { "pluginId": "fleet", "scope": "public", @@ -1652,6 +1870,14 @@ "text": "PackagePolicyEditExtension" }, " | ", + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.PackagePolicyResponseExtension", + "text": "PackagePolicyResponseExtension" + }, + " | ", { "pluginId": "fleet", "scope": "public", @@ -1863,6 +2089,60 @@ ], "returnComment": [] }, + { + "parentPluginId": "fleet", + "id": "def-public.pagePathGetters.integrations_installed_updates_available", + "type": "Function", + "tags": [], + "label": "integrations_installed_updates_available", + "description": [], + "signature": [ + "({ query, category, }: { query?: string | undefined; category?: string | undefined; }) => [string, string]" + ], + "path": "x-pack/plugins/fleet/public/constants/page_paths.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "fleet", + "id": "def-public.pagePathGetters.integrations_installed_updates_available.$1", + "type": "Object", + "tags": [], + "label": "{\n query,\n category,\n }", + "description": [], + "path": "x-pack/plugins/fleet/public/constants/page_paths.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "fleet", + "id": "def-public.pagePathGetters.integrations_installed_updates_available.$1.query", + "type": "string", + "tags": [], + "label": "query", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/fleet/public/constants/page_paths.ts", + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-public.pagePathGetters.integrations_installed_updates_available.$1.category", + "type": "string", + "tags": [], + "label": "category", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/fleet/public/constants/page_paths.ts", + "deprecated": false + } + ] + } + ], + "returnComment": [] + }, { "parentPluginId": "fleet", "id": "def-public.pagePathGetters.integration_details_overview", @@ -2538,6 +2818,14 @@ "text": "PackagePolicyEditExtension" }, " | ", + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.PackagePolicyResponseExtension", + "text": "PackagePolicyResponseExtension" + }, + " | ", { "pluginId": "fleet", "scope": "public", @@ -8528,6 +8816,68 @@ "returnComment": [], "initialIsOpen": false }, + { + "parentPluginId": "fleet", + "id": "def-common.getMaxVersion", + "type": "Function", + "tags": [], + "label": "getMaxVersion", + "description": [], + "signature": [ + "(versions: string[]) => string" + ], + "path": "x-pack/plugins/fleet/common/services/get_min_max_version.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "fleet", + "id": "def-common.getMaxVersion.$1", + "type": "Array", + "tags": [], + "label": "versions", + "description": [], + "signature": [ + "string[]" + ], + "path": "x-pack/plugins/fleet/common/services/get_min_max_version.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.getMinVersion", + "type": "Function", + "tags": [], + "label": "getMinVersion", + "description": [], + "signature": [ + "(versions: string[]) => string" + ], + "path": "x-pack/plugins/fleet/common/services/get_min_max_version.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "fleet", + "id": "def-common.getMinVersion.$1", + "type": "Array", + "tags": [], + "label": "versions", + "description": [], + "signature": [ + "string[]" + ], + "path": "x-pack/plugins/fleet/common/services/get_min_max_version.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, { "parentPluginId": "fleet", "id": "def-common.getStreamsForInputType", @@ -8625,7 +8975,7 @@ "section": "def-common.Agent", "text": "Agent" }, - ", kibanaVersion: string) => boolean" + ", kibanaVersion: string, versionToUpgrade: string | undefined) => boolean" ], "path": "x-pack/plugins/fleet/common/services/is_agent_upgradeable.ts", "deprecated": false, @@ -8663,6 +9013,20 @@ "path": "x-pack/plugins/fleet/common/services/is_agent_upgradeable.ts", "deprecated": false, "isRequired": true + }, + { + "parentPluginId": "fleet", + "id": "def-common.isAgentUpgradeable.$3", + "type": "string", + "tags": [], + "label": "versionToUpgrade", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/fleet/common/services/is_agent_upgradeable.ts", + "deprecated": false, + "isRequired": false } ], "returnComment": [], @@ -10419,6 +10783,9 @@ "tags": [], "label": "startTime", "description": [], + "signature": [ + "string | undefined" + ], "path": "x-pack/plugins/fleet/common/types/models/agent.ts", "deprecated": false } @@ -10540,6 +10907,19 @@ ], "path": "x-pack/plugins/fleet/common/types/models/data_stream.ts", "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.DataStream.serviceDetails", + "type": "CompoundType", + "tags": [], + "label": "serviceDetails", + "description": [], + "signature": [ + "{ environment: string; serviceName: string; } | null" + ], + "path": "x-pack/plugins/fleet/common/types/models/data_stream.ts", + "deprecated": false } ], "initialIsOpen": false @@ -12580,7 +12960,7 @@ "label": "query", "description": [], "signature": [ - "{ agentsIds: string[]; }" + "{ agentsIds: string[]; previewData?: boolean | undefined; }" ], "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", "deprecated": false @@ -12617,6 +12997,20 @@ ], "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.GetAgentIncomingDataResponse.dataPreview", + "type": "Array", + "tags": [], + "label": "dataPreview", + "description": [], + "signature": [ + "SearchHit", + "[]" + ], + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "deprecated": false } ], "initialIsOpen": false @@ -14550,6 +14944,19 @@ ], "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.IntegrationCardItem.fromIntegrations", + "type": "string", + "tags": [], + "label": "fromIntegrations", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "deprecated": false } ], "initialIsOpen": false @@ -16079,7 +16486,7 @@ "label": "release", "description": [], "signature": [ - "\"experimental\" | \"beta\" | \"ga\"" + "\"experimental\" | \"beta\" | \"ga\" | undefined" ], "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", "deprecated": false @@ -17845,7 +18252,7 @@ "label": "[RegistryVarsEntryKeys.type]", "description": [], "signature": [ - "\"string\" | \"text\" | \"integer\" | \"yaml\" | \"password\" | \"bool\"" + "\"string\" | \"text\" | \"yaml\" | \"password\" | \"integer\" | \"bool\"" ], "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false @@ -19305,7 +19712,7 @@ "label": "DetailViewPanelName", "description": [], "signature": [ - "\"custom\" | \"settings\" | \"overview\" | \"policies\" | \"assets\"" + "\"custom\" | \"overview\" | \"settings\" | \"policies\" | \"assets\"" ], "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false, @@ -21088,7 +21495,7 @@ "section": "def-common.PackageSpecCategory", "text": "PackageSpecCategory" }, - " | undefined)[] | undefined; name: string; version: string; internal?: boolean | undefined; path: string; data_streams?: ", + " | undefined)[] | undefined; name: string; version: string; path: string; internal?: boolean | undefined; data_streams?: ", { "pluginId": "fleet", "scope": "common", @@ -21096,7 +21503,7 @@ "section": "def-common.RegistryDataStream", "text": "RegistryDataStream" }, - "[] | undefined; release: \"experimental\" | \"beta\" | \"ga\"; policy_templates?: ", + "[] | undefined; release?: \"experimental\" | \"beta\" | \"ga\" | undefined; policy_templates?: ", { "pluginId": "fleet", "scope": "common", @@ -21139,7 +21546,7 @@ "label": "RegistryVarType", "description": [], "signature": [ - "\"string\" | \"text\" | \"integer\" | \"yaml\" | \"password\" | \"bool\"" + "\"string\" | \"text\" | \"yaml\" | \"password\" | \"integer\" | \"bool\"" ], "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false, diff --git a/api_docs/fleet.mdx b/api_docs/fleet.mdx index bf494b554b1320..d05a5319ee5bad 100644 --- a/api_docs/fleet.mdx +++ b/api_docs/fleet.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/fleet title: "fleet" image: https://source.unsplash.com/400x175/?github summary: API docs for the fleet plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fleet'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Fleet](https://github.com/orgs/elastic/teams/fleet) for questions regar | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 1404 | 8 | 1282 | 10 | +| 1427 | 8 | 1300 | 10 | ## Client diff --git a/api_docs/global_search.mdx b/api_docs/global_search.mdx index 498822856f7b2a..514a71e6e3c652 100644 --- a/api_docs/global_search.mdx +++ b/api_docs/global_search.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/globalSearch title: "globalSearch" image: https://source.unsplash.com/400x175/?github summary: API docs for the globalSearch plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'globalSearch'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/home.mdx b/api_docs/home.mdx index 8bcc950a5fed84..92a7da7e81a55b 100644 --- a/api_docs/home.mdx +++ b/api_docs/home.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/home title: "home" image: https://source.unsplash.com/400x175/?github summary: API docs for the home plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'home'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/index_lifecycle_management.mdx b/api_docs/index_lifecycle_management.mdx index 61200651e17038..dbcceff52f9675 100644 --- a/api_docs/index_lifecycle_management.mdx +++ b/api_docs/index_lifecycle_management.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/indexLifecycleManagement title: "indexLifecycleManagement" image: https://source.unsplash.com/400x175/?github summary: API docs for the indexLifecycleManagement plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'indexLifecycleManagement'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/index_management.devdocs.json b/api_docs/index_management.devdocs.json index 93ffcfc2fe1f40..e2d722c677307a 100644 --- a/api_docs/index_management.devdocs.json +++ b/api_docs/index_management.devdocs.json @@ -2411,7 +2411,7 @@ "label": "MAJOR_VERSION", "description": [], "signature": [ - "\"8.3.0\"" + "\"8.4.0\"" ], "path": "x-pack/plugins/index_management/common/constants/plugin.ts", "deprecated": false, diff --git a/api_docs/index_management.mdx b/api_docs/index_management.mdx index 8ba811f087533b..a95684acc0d8cb 100644 --- a/api_docs/index_management.mdx +++ b/api_docs/index_management.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/indexManagement title: "indexManagement" image: https://source.unsplash.com/400x175/?github summary: API docs for the indexManagement plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'indexManagement'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/infra.mdx b/api_docs/infra.mdx index 1df9391a1c7c35..de671307e17ec3 100644 --- a/api_docs/infra.mdx +++ b/api_docs/infra.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/infra title: "infra" image: https://source.unsplash.com/400x175/?github summary: API docs for the infra plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'infra'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/inspector.mdx b/api_docs/inspector.mdx index 67465c5389b79a..cbb6faade01d8e 100644 --- a/api_docs/inspector.mdx +++ b/api_docs/inspector.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/inspector title: "inspector" image: https://source.unsplash.com/400x175/?github summary: API docs for the inspector plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'inspector'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/interactive_setup.mdx b/api_docs/interactive_setup.mdx index e35bf90f171052..dbb73f081eba5d 100644 --- a/api_docs/interactive_setup.mdx +++ b/api_docs/interactive_setup.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/interactiveSetup title: "interactiveSetup" image: https://source.unsplash.com/400x175/?github summary: API docs for the interactiveSetup plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'interactiveSetup'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_ace.mdx b/api_docs/kbn_ace.mdx index e00ced9559448b..27ef2f4cc213e7 100644 --- a/api_docs/kbn_ace.mdx +++ b/api_docs/kbn_ace.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-ace title: "@kbn/ace" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/ace plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ace'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_aiops_utils.mdx b/api_docs/kbn_aiops_utils.mdx index 699e608a4fe40b..41fd88fb0462f6 100644 --- a/api_docs/kbn_aiops_utils.mdx +++ b/api_docs/kbn_aiops_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-aiops-utils title: "@kbn/aiops-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/aiops-utils plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/aiops-utils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_alerts.mdx b/api_docs/kbn_alerts.mdx index 27a0f6fe1647d3..3103dd4a5dfc65 100644 --- a/api_docs/kbn_alerts.mdx +++ b/api_docs/kbn_alerts.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-alerts title: "@kbn/alerts" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/alerts plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/alerts'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_analytics.mdx b/api_docs/kbn_analytics.mdx index d1f6dd0176827c..e4019c9ac92e10 100644 --- a/api_docs/kbn_analytics.mdx +++ b/api_docs/kbn_analytics.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-analytics title: "@kbn/analytics" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/analytics plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_analytics_client.devdocs.json b/api_docs/kbn_analytics_client.devdocs.json index 6a8f5e77dedd24..73362447540f83 100644 --- a/api_docs/kbn_analytics_client.devdocs.json +++ b/api_docs/kbn_analytics_client.devdocs.json @@ -372,6 +372,21 @@ "path": "packages/analytics/client/src/events/types.ts", "deprecated": false }, + { + "parentPluginId": "@kbn/analytics-client", + "id": "def-common.EventContext.isElasticCloudUser", + "type": "CompoundType", + "tags": [], + "label": "isElasticCloudUser", + "description": [ + "\n`true` if the user is logged in via the Elastic Cloud authentication provider." + ], + "signature": [ + "boolean | undefined" + ], + "path": "packages/analytics/client/src/events/types.ts", + "deprecated": false + }, { "parentPluginId": "@kbn/analytics-client", "id": "def-common.EventContext.version", @@ -1238,7 +1253,9 @@ "type": "string", "tags": [], "label": "type", - "description": [], + "description": [ + "The type must be an array" + ], "signature": [ "\"array\"" ], @@ -1251,7 +1268,9 @@ "type": "CompoundType", "tags": [], "label": "items", - "description": [], + "description": [ + "The schema of the items in the array is defined in the `items` property" + ], "signature": [ "{ type: \"pass_through\"; _meta: { description: string; } & ", { @@ -1331,7 +1350,9 @@ "type": "Interface", "tags": [], "label": "SchemaChildValue", - "description": [], + "description": [ + "\nSchema to define a primitive value" + ], "signature": [ { "pluginId": "@kbn/analytics-client", @@ -1351,7 +1372,9 @@ "type": "Uncategorized", "tags": [], "label": "type", - "description": [], + "description": [ + "The type of the value" + ], "signature": [ "NonNullable extends string | Date ? ", { @@ -1387,7 +1410,9 @@ "type": "CompoundType", "tags": [], "label": "_meta", - "description": [], + "description": [ + "Meta properties of the value: description and is optional" + ], "signature": [ "{ description: string; } & ", { @@ -1433,7 +1458,9 @@ "type": "CompoundType", "tags": [], "label": "_meta", - "description": [], + "description": [ + "Meta properties of the pass through: description and is optional" + ], "signature": [ "({ description?: string | undefined; } & ", { @@ -1487,7 +1514,9 @@ "type": "Object", "tags": [], "label": "properties", - "description": [], + "description": [ + "\nThe schemas of the keys of the object are defined in the `properties` object." + ], "signature": [ "{ [Key in keyof Required]: ", { @@ -1725,7 +1754,7 @@ "Types matching number values" ], "signature": [ - "\"date\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"double\"" + "\"date\" | \"long\" | \"double\" | \"short\" | \"float\" | \"integer\" | \"byte\"" ], "path": "packages/analytics/client/src/schema/types.ts", "deprecated": false, @@ -1757,7 +1786,7 @@ "\nPossible type values in the schema" ], "signature": [ - "\"boolean\" | \"keyword\" | \"text\" | \"date\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"double\"" + "\"boolean\" | \"keyword\" | \"text\" | \"date\" | \"long\" | \"double\" | \"short\" | \"float\" | \"integer\" | \"byte\"" ], "path": "packages/analytics/client/src/schema/types.ts", "deprecated": false, diff --git a/api_docs/kbn_analytics_client.mdx b/api_docs/kbn_analytics_client.mdx index 4b4c5efe2f7031..95de55836113d9 100644 --- a/api_docs/kbn_analytics_client.mdx +++ b/api_docs/kbn_analytics_client.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-analytics-client title: "@kbn/analytics-client" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/analytics-client plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-client'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Owner missing] for questions regarding this plugin. | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 95 | 0 | 7 | 0 | +| 96 | 0 | 0 | 0 | ## Common diff --git a/api_docs/kbn_analytics_shippers_elastic_v3_browser.devdocs.json b/api_docs/kbn_analytics_shippers_elastic_v3_browser.devdocs.json index 8728f86815d4a7..0a89fd88fca054 100644 --- a/api_docs/kbn_analytics_shippers_elastic_v3_browser.devdocs.json +++ b/api_docs/kbn_analytics_shippers_elastic_v3_browser.devdocs.json @@ -24,7 +24,9 @@ "type": "Class", "tags": [], "label": "ElasticV3BrowserShipper", - "description": [], + "description": [ + "\nElastic V3 shipper to use in the browser." + ], "signature": [ { "pluginId": "@kbn/analytics-shippers-elastic-v3-browser", @@ -45,7 +47,9 @@ "type": "string", "tags": [], "label": "shipperName", - "description": [], + "description": [ + "Shipper's unique name" + ], "path": "packages/analytics/shippers/elastic_v3/browser/src/browser_shipper.ts", "deprecated": false }, @@ -55,7 +59,9 @@ "type": "Object", "tags": [], "label": "telemetryCounter$", - "description": [], + "description": [ + "Observable to emit the stats of the processed events." + ], "signature": [ "Subject", "<", @@ -71,7 +77,9 @@ "type": "Function", "tags": [], "label": "Constructor", - "description": [], + "description": [ + "\nCreates a new instance of the {@link ElasticV3BrowserShipper}." + ], "signature": [ "any" ], @@ -84,7 +92,9 @@ "type": "Object", "tags": [], "label": "options", - "description": [], + "description": [ + "{@link ElasticV3ShipperOptions }" + ], "signature": [ "ElasticV3ShipperOptions" ], @@ -98,7 +108,9 @@ "type": "Object", "tags": [], "label": "initContext", - "description": [], + "description": [ + "{@link AnalyticsClientInitContext }" + ], "signature": [ "AnalyticsClientInitContext" ], @@ -115,7 +127,9 @@ "type": "Function", "tags": [], "label": "extendContext", - "description": [], + "description": [ + "\nUses the `cluster_uuid` and `license_id` from the context to hold them in memory for the generation of the headers\nused later on in the HTTP request." + ], "signature": [ "(newContext: ", "EventContext", @@ -130,7 +144,9 @@ "type": "Object", "tags": [], "label": "newContext", - "description": [], + "description": [ + "The full new context to set {@link EventContext }" + ], "signature": [ "EventContext" ], @@ -147,7 +163,9 @@ "type": "Function", "tags": [], "label": "optIn", - "description": [], + "description": [ + "\nWhen `false`, it flushes the internal queue and stops sending events." + ], "signature": [ "(isOptedIn: boolean) => void" ], @@ -160,7 +178,9 @@ "type": "boolean", "tags": [], "label": "isOptedIn", - "description": [], + "description": [ + "`true` for resume sending events. `false` to stop." + ], "signature": [ "boolean" ], @@ -177,7 +197,9 @@ "type": "Function", "tags": [], "label": "reportEvents", - "description": [], + "description": [ + "\nEnqueues the events to be sent to in a batched approach." + ], "signature": [ "(events: ", "Event", @@ -192,7 +214,9 @@ "type": "Array", "tags": [], "label": "events", - "description": [], + "description": [ + "batched events {@link Event }" + ], "signature": [ "Event", "[]" @@ -210,7 +234,9 @@ "type": "Function", "tags": [], "label": "shutdown", - "description": [], + "description": [ + "\nShuts down the shipper.\nTriggers a flush of the internal queue to attempt to send any events held in the queue." + ], "signature": [ "() => void" ], @@ -234,6 +260,9 @@ "description": [ "\r\nOptions for the Elastic V3 shipper" ], + "signature": [ + "ElasticV3ShipperOptions" + ], "path": "node_modules/@types/kbn__analytics-shippers-elastic-v3-common/index.d.ts", "deprecated": false, "children": [ diff --git a/api_docs/kbn_analytics_shippers_elastic_v3_browser.mdx b/api_docs/kbn_analytics_shippers_elastic_v3_browser.mdx index b9d3b815f53659..31abf36dc9dc2d 100644 --- a/api_docs/kbn_analytics_shippers_elastic_v3_browser.mdx +++ b/api_docs/kbn_analytics_shippers_elastic_v3_browser.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-analytics-shippers-elastic-v3-browser title: "@kbn/analytics-shippers-elastic-v3-browser" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/analytics-shippers-elastic-v3-browser plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-shippers-elastic-v3-browser'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Owner missing] for questions regarding this plugin. | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 18 | 0 | 13 | 0 | +| 18 | 0 | 0 | 0 | ## Common diff --git a/api_docs/kbn_analytics_shippers_elastic_v3_common.devdocs.json b/api_docs/kbn_analytics_shippers_elastic_v3_common.devdocs.json index cae7144976799e..addbc3fa6f877a 100644 --- a/api_docs/kbn_analytics_shippers_elastic_v3_common.devdocs.json +++ b/api_docs/kbn_analytics_shippers_elastic_v3_common.devdocs.json @@ -24,7 +24,9 @@ "type": "Class", "tags": [], "label": "ErrorWithCode", - "description": [], + "description": [ + "\nCustom error to report the error message with an additional error code." + ], "signature": [ { "pluginId": "@kbn/analytics-shippers-elastic-v3-common", @@ -44,7 +46,9 @@ "type": "Function", "tags": [], "label": "Constructor", - "description": [], + "description": [ + "\nConstructor of the error." + ], "signature": [ "any" ], @@ -57,7 +61,9 @@ "type": "string", "tags": [], "label": "message", - "description": [], + "description": [ + "The error message." + ], "signature": [ "string" ], @@ -71,7 +77,9 @@ "type": "string", "tags": [], "label": "code", - "description": [], + "description": [ + "The code of the error." + ], "signature": [ "string" ], @@ -93,7 +101,9 @@ "type": "Function", "tags": [], "label": "buildHeaders", - "description": [], + "description": [ + "\nReturns the headers to send to the Remote Telemetry Service." + ], "signature": [ "(clusterUuid: string, version: string, licenseId: string | undefined) => { 'x-elastic-license-id'?: string | undefined; 'content-type': string; 'x-elastic-cluster-id': string; 'x-elastic-stack-version': string; }" ], @@ -106,7 +116,9 @@ "type": "string", "tags": [], "label": "clusterUuid", - "description": [], + "description": [ + "The UUID of the ES cluster." + ], "signature": [ "string" ], @@ -120,7 +132,9 @@ "type": "string", "tags": [], "label": "version", - "description": [], + "description": [ + "The version of the ES cluster." + ], "signature": [ "string" ], @@ -134,7 +148,9 @@ "type": "string", "tags": [], "label": "licenseId", - "description": [], + "description": [ + "The ID of the license (if available)." + ], "signature": [ "string | undefined" ], @@ -156,7 +172,15 @@ "\nBuilds the URL for the V3 API." ], "signature": [ - "({\n sendTo,\n channelName,\n}: { sendTo: \"staging\" | \"production\"; channelName: string; }) => string" + "(urlOptions: ", + { + "pluginId": "@kbn/analytics-shippers-elastic-v3-common", + "scope": "common", + "docId": "kibKbnAnalyticsShippersElasticV3CommonPluginApi", + "section": "def-common.BuildUrlOptions", + "text": "BuildUrlOptions" + }, + ") => string" ], "path": "packages/analytics/shippers/elastic_v3/common/src/build_url.ts", "deprecated": false, @@ -166,35 +190,22 @@ "id": "def-common.buildUrl.$1", "type": "Object", "tags": [], - "label": "{\n sendTo,\n channelName,\n}", - "description": [], - "path": "packages/analytics/shippers/elastic_v3/common/src/build_url.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/analytics-shippers-elastic-v3-common", - "id": "def-common.buildUrl.$1.sendTo", - "type": "CompoundType", - "tags": [], - "label": "sendTo", - "description": [], - "signature": [ - "\"staging\" | \"production\"" - ], - "path": "packages/analytics/shippers/elastic_v3/common/src/build_url.ts", - "deprecated": false - }, + "label": "urlOptions", + "description": [ + "The options to build the URL of the V3 API." + ], + "signature": [ { - "parentPluginId": "@kbn/analytics-shippers-elastic-v3-common", - "id": "def-common.buildUrl.$1.channelName", - "type": "string", - "tags": [], - "label": "channelName", - "description": [], - "path": "packages/analytics/shippers/elastic_v3/common/src/build_url.ts", - "deprecated": false + "pluginId": "@kbn/analytics-shippers-elastic-v3-common", + "scope": "common", + "docId": "kibKbnAnalyticsShippersElasticV3CommonPluginApi", + "section": "def-common.BuildUrlOptions", + "text": "BuildUrlOptions" } - ] + ], + "path": "packages/analytics/shippers/elastic_v3/common/src/build_url.ts", + "deprecated": false, + "isRequired": true } ], "returnComment": [], @@ -268,7 +279,9 @@ "type": "Function", "tags": [], "label": "eventsToNDJSON", - "description": [], + "description": [ + "\nConverts an array of events to a single ndjson string." + ], "signature": [ "(events: ", "Event", @@ -283,7 +296,9 @@ "type": "Array", "tags": [], "label": "events", - "description": [], + "description": [ + "An array of events {@link Event }" + ], "signature": [ "Event", "[]" @@ -298,6 +313,48 @@ } ], "interfaces": [ + { + "parentPluginId": "@kbn/analytics-shippers-elastic-v3-common", + "id": "def-common.BuildUrlOptions", + "type": "Interface", + "tags": [], + "label": "BuildUrlOptions", + "description": [ + "The options to build the URL of the V3 API." + ], + "path": "packages/analytics/shippers/elastic_v3/common/src/build_url.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/analytics-shippers-elastic-v3-common", + "id": "def-common.BuildUrlOptions.sendTo", + "type": "CompoundType", + "tags": [], + "label": "sendTo", + "description": [ + "Whether to send it to production or staging." + ], + "signature": [ + "\"staging\" | \"production\"" + ], + "path": "packages/analytics/shippers/elastic_v3/common/src/build_url.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/analytics-shippers-elastic-v3-common", + "id": "def-common.BuildUrlOptions.channelName", + "type": "string", + "tags": [], + "label": "channelName", + "description": [ + "The name of the channel to send the data to." + ], + "path": "packages/analytics/shippers/elastic_v3/common/src/build_url.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, { "parentPluginId": "@kbn/analytics-shippers-elastic-v3-common", "id": "def-common.ElasticV3ShipperOptions", diff --git a/api_docs/kbn_analytics_shippers_elastic_v3_common.mdx b/api_docs/kbn_analytics_shippers_elastic_v3_common.mdx index 9e099e103115d0..b35b38d85c8b83 100644 --- a/api_docs/kbn_analytics_shippers_elastic_v3_common.mdx +++ b/api_docs/kbn_analytics_shippers_elastic_v3_common.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-analytics-shippers-elastic-v3-common title: "@kbn/analytics-shippers-elastic-v3-common" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/analytics-shippers-elastic-v3-common plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-shippers-elastic-v3-common'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Owner missing] for questions regarding this plugin. | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 22 | 0 | 13 | 0 | +| 23 | 0 | 0 | 0 | ## Common diff --git a/api_docs/kbn_analytics_shippers_elastic_v3_server.devdocs.json b/api_docs/kbn_analytics_shippers_elastic_v3_server.devdocs.json index a0ca93e38501bc..32d47b8153c180 100644 --- a/api_docs/kbn_analytics_shippers_elastic_v3_server.devdocs.json +++ b/api_docs/kbn_analytics_shippers_elastic_v3_server.devdocs.json @@ -16,7 +16,9 @@ "type": "Class", "tags": [], "label": "ElasticV3ServerShipper", - "description": [], + "description": [ + "\nElastic V3 shipper to use on the server side." + ], "signature": [ { "pluginId": "@kbn/analytics-shippers-elastic-v3-server", @@ -37,7 +39,9 @@ "type": "string", "tags": [], "label": "shipperName", - "description": [], + "description": [ + "Shipper's unique name" + ], "path": "packages/analytics/shippers/elastic_v3/server/src/server_shipper.ts", "deprecated": false }, @@ -47,7 +51,9 @@ "type": "Object", "tags": [], "label": "telemetryCounter$", - "description": [], + "description": [ + "Observable to emit the stats of the processed events." + ], "signature": [ "Subject", "<", @@ -63,7 +69,9 @@ "type": "Function", "tags": [], "label": "Constructor", - "description": [], + "description": [ + "\nCreates a new instance of the {@link ElasticV3ServerShipper}." + ], "signature": [ "any" ], @@ -76,7 +84,9 @@ "type": "Object", "tags": [], "label": "options", - "description": [], + "description": [ + "{@link ElasticV3ShipperOptions }" + ], "signature": [ "ElasticV3ShipperOptions" ], @@ -90,7 +100,9 @@ "type": "Object", "tags": [], "label": "initContext", - "description": [], + "description": [ + "{@link AnalyticsClientInitContext }" + ], "signature": [ "AnalyticsClientInitContext" ], @@ -107,7 +119,9 @@ "type": "Function", "tags": [], "label": "extendContext", - "description": [], + "description": [ + "\nUses the `cluster_uuid` and `license_id` from the context to hold them in memory for the generation of the headers\nused later on in the HTTP request." + ], "signature": [ "(newContext: ", "EventContext", @@ -122,7 +136,9 @@ "type": "Object", "tags": [], "label": "newContext", - "description": [], + "description": [ + "The full new context to set {@link EventContext }" + ], "signature": [ "EventContext" ], @@ -139,7 +155,9 @@ "type": "Function", "tags": [], "label": "optIn", - "description": [], + "description": [ + "\nWhen `false`, it flushes the internal queue and stops sending events." + ], "signature": [ "(isOptedIn: boolean) => void" ], @@ -152,7 +170,9 @@ "type": "boolean", "tags": [], "label": "isOptedIn", - "description": [], + "description": [ + "`true` for resume sending events. `false` to stop." + ], "signature": [ "boolean" ], @@ -169,7 +189,9 @@ "type": "Function", "tags": [], "label": "reportEvents", - "description": [], + "description": [ + "\nEnqueues the events to be sent via the leaky bucket algorithm." + ], "signature": [ "(events: ", "Event", @@ -184,7 +206,9 @@ "type": "Array", "tags": [], "label": "events", - "description": [], + "description": [ + "batched events {@link Event }" + ], "signature": [ "Event", "[]" @@ -202,7 +226,9 @@ "type": "Function", "tags": [], "label": "shutdown", - "description": [], + "description": [ + "\nShuts down the shipper.\nTriggers a flush of the internal queue to attempt to send any events held in the queue." + ], "signature": [ "() => void" ], @@ -226,6 +252,9 @@ "description": [ "\r\nOptions for the Elastic V3 shipper" ], + "signature": [ + "ElasticV3ShipperOptions" + ], "path": "node_modules/@types/kbn__analytics-shippers-elastic-v3-common/index.d.ts", "deprecated": false, "children": [ diff --git a/api_docs/kbn_analytics_shippers_elastic_v3_server.mdx b/api_docs/kbn_analytics_shippers_elastic_v3_server.mdx index ab07342c4fe90a..af0ed0661d18ae 100644 --- a/api_docs/kbn_analytics_shippers_elastic_v3_server.mdx +++ b/api_docs/kbn_analytics_shippers_elastic_v3_server.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-analytics-shippers-elastic-v3-server title: "@kbn/analytics-shippers-elastic-v3-server" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/analytics-shippers-elastic-v3-server plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-shippers-elastic-v3-server'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Owner missing] for questions regarding this plugin. | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 18 | 0 | 13 | 0 | +| 18 | 0 | 0 | 0 | ## Server diff --git a/api_docs/kbn_analytics_shippers_fullstory.devdocs.json b/api_docs/kbn_analytics_shippers_fullstory.devdocs.json index 7fcf744c078066..19cd61dd2651fd 100644 --- a/api_docs/kbn_analytics_shippers_fullstory.devdocs.json +++ b/api_docs/kbn_analytics_shippers_fullstory.devdocs.json @@ -113,12 +113,10 @@ "parentPluginId": "@kbn/analytics-shippers-fullstory", "id": "def-common.FullStoryShipper.extendContext", "type": "Function", - "tags": [ - "inheritDoc" - ], + "tags": [], "label": "extendContext", "description": [ - "\n{@inheritDoc IShipper.extendContext}" + "\nCalls `fs.identify`, `fs.setUserVars` and `fs.setVars` depending on the fields provided in the newContext." ], "signature": [ "(newContext: ", @@ -134,7 +132,9 @@ "type": "Object", "tags": [], "label": "newContext", - "description": [], + "description": [ + "The full new context to set {@link EventContext }" + ], "signature": [ "EventContext" ], @@ -149,12 +149,10 @@ "parentPluginId": "@kbn/analytics-shippers-fullstory", "id": "def-common.FullStoryShipper.optIn", "type": "Function", - "tags": [ - "inheritDoc" - ], + "tags": [], "label": "optIn", "description": [ - "\n{@inheritDoc IShipper.optIn}" + "\nStops/restarts the shipping mechanism based on the value of isOptedIn" ], "signature": [ "(isOptedIn: boolean) => void" @@ -168,7 +166,9 @@ "type": "boolean", "tags": [], "label": "isOptedIn", - "description": [], + "description": [ + "`true` for resume sending events. `false` to stop." + ], "signature": [ "boolean" ], @@ -183,12 +183,10 @@ "parentPluginId": "@kbn/analytics-shippers-fullstory", "id": "def-common.FullStoryShipper.reportEvents", "type": "Function", - "tags": [ - "inheritDoc" - ], + "tags": [], "label": "reportEvents", "description": [ - "\n{@inheritDoc IShipper.reportEvents}" + "\nFilters the events by the eventTypesAllowlist from the config.\nThen it transforms the event into a FS valid format and calls `fs.event`." ], "signature": [ "(events: ", @@ -204,7 +202,9 @@ "type": "Array", "tags": [], "label": "events", - "description": [], + "description": [ + "batched events {@link Event }" + ], "signature": [ "Event", "[]" @@ -222,7 +222,9 @@ "type": "Function", "tags": [], "label": "shutdown", - "description": [], + "description": [ + "\nShuts down the shipper.\nIt doesn't really do anything inside because this shipper doesn't hold any internal queues." + ], "signature": [ "() => void" ], diff --git a/api_docs/kbn_analytics_shippers_fullstory.mdx b/api_docs/kbn_analytics_shippers_fullstory.mdx index 494f04c7c43b20..949726e3d7731a 100644 --- a/api_docs/kbn_analytics_shippers_fullstory.mdx +++ b/api_docs/kbn_analytics_shippers_fullstory.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-analytics-shippers-fullstory title: "@kbn/analytics-shippers-fullstory" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/analytics-shippers-fullstory plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-shippers-fullstory'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Owner missing] for questions regarding this plugin. | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 20 | 0 | 4 | 0 | +| 20 | 0 | 0 | 0 | ## Common diff --git a/api_docs/kbn_apm_config_loader.mdx b/api_docs/kbn_apm_config_loader.mdx index be9d9e7d05c2ba..daf56d907467a9 100644 --- a/api_docs/kbn_apm_config_loader.mdx +++ b/api_docs/kbn_apm_config_loader.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-apm-config-loader title: "@kbn/apm-config-loader" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/apm-config-loader plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/apm-config-loader'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_apm_utils.mdx b/api_docs/kbn_apm_utils.mdx index 9dd20f183b9a36..70eac813712320 100644 --- a/api_docs/kbn_apm_utils.mdx +++ b/api_docs/kbn_apm_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-apm-utils title: "@kbn/apm-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/apm-utils plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/apm-utils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_axe_config.mdx b/api_docs/kbn_axe_config.mdx index e65bbf192fd7f6..38fee75f061e42 100644 --- a/api_docs/kbn_axe_config.mdx +++ b/api_docs/kbn_axe_config.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-axe-config title: "@kbn/axe-config" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/axe-config plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/axe-config'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_bazel_packages.mdx b/api_docs/kbn_bazel_packages.mdx index d92763dd2d5562..0f7817a5639e84 100644 --- a/api_docs/kbn_bazel_packages.mdx +++ b/api_docs/kbn_bazel_packages.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-bazel-packages title: "@kbn/bazel-packages" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/bazel-packages plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/bazel-packages'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_bazel_runner.mdx b/api_docs/kbn_bazel_runner.mdx index d9968b151fef00..ae4f309b3eecae 100644 --- a/api_docs/kbn_bazel_runner.mdx +++ b/api_docs/kbn_bazel_runner.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-bazel-runner title: "@kbn/bazel-runner" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/bazel-runner plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/bazel-runner'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_ci_stats_core.mdx b/api_docs/kbn_ci_stats_core.mdx index 3debd9472a83d3..89ed0e85202a7c 100644 --- a/api_docs/kbn_ci_stats_core.mdx +++ b/api_docs/kbn_ci_stats_core.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-ci-stats-core title: "@kbn/ci-stats-core" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/ci-stats-core plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ci-stats-core'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_ci_stats_reporter.mdx b/api_docs/kbn_ci_stats_reporter.mdx index eb8fe1ea645f2c..d23397b342af8a 100644 --- a/api_docs/kbn_ci_stats_reporter.mdx +++ b/api_docs/kbn_ci_stats_reporter.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-ci-stats-reporter title: "@kbn/ci-stats-reporter" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/ci-stats-reporter plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ci-stats-reporter'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_cli_dev_mode.mdx b/api_docs/kbn_cli_dev_mode.mdx index 475736d3d94b53..48384f3bac755d 100644 --- a/api_docs/kbn_cli_dev_mode.mdx +++ b/api_docs/kbn_cli_dev_mode.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-cli-dev-mode title: "@kbn/cli-dev-mode" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/cli-dev-mode plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/cli-dev-mode'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_coloring.mdx b/api_docs/kbn_coloring.mdx index 0dab3fa9131365..901b36c273d2bd 100644 --- a/api_docs/kbn_coloring.mdx +++ b/api_docs/kbn_coloring.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-coloring title: "@kbn/coloring" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/coloring plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/coloring'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_config.mdx b/api_docs/kbn_config.mdx index d54225307c088b..c1d8869402a2d2 100644 --- a/api_docs/kbn_config.mdx +++ b/api_docs/kbn_config.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-config title: "@kbn/config" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/config plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/config'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_config_mocks.devdocs.json b/api_docs/kbn_config_mocks.devdocs.json new file mode 100644 index 00000000000000..5253c9041e0bdf --- /dev/null +++ b/api_docs/kbn_config_mocks.devdocs.json @@ -0,0 +1,328 @@ +{ + "id": "@kbn/config-mocks", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [ + { + "parentPluginId": "@kbn/config-mocks", + "id": "def-server.getEnvOptions", + "type": "Function", + "tags": [], + "label": "getEnvOptions", + "description": [], + "signature": [ + "(options: DeepPartial<", + "EnvOptions", + ">) => ", + "EnvOptions" + ], + "path": "packages/kbn-config-mocks/src/env.mock.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/config-mocks", + "id": "def-server.getEnvOptions.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "DeepPartial<", + "EnvOptions", + ">" + ], + "path": "packages/kbn-config-mocks/src/env.mock.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [], + "enums": [], + "misc": [ + { + "parentPluginId": "@kbn/config-mocks", + "id": "def-server.ConfigDeprecationContextMock", + "type": "Type", + "tags": [], + "label": "ConfigDeprecationContextMock", + "description": [], + "signature": [ + "ConfigDeprecationContext" + ], + "path": "packages/kbn-config-mocks/src/deprecations.mock.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/config-mocks", + "id": "def-server.ConfigMock", + "type": "Type", + "tags": [], + "label": "ConfigMock", + "description": [], + "signature": [ + "{ has: jest.MockInstance; get: jest.MockInstance; set: jest.MockInstance; getFlattenedPaths: jest.MockInstance; toRaw: jest.MockInstance, []>; } & ", + "Config" + ], + "path": "packages/kbn-config-mocks/src/config.mock.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/config-mocks", + "id": "def-server.IConfigServiceMock", + "type": "Type", + "tags": [], + "label": "IConfigServiceMock", + "description": [], + "signature": [ + "{ validate: jest.MockInstance, [params?: ", + "ConfigValidateParameters", + " | undefined]>; getConfig$: jest.MockInstance<", + "Observable", + "<", + "Config", + ">, []>; setSchema: jest.MockInstance]>; addDeprecationProvider: jest.MockInstance; getHandledDeprecatedConfigs: jest.MockInstance<[string, DeprecatedConfigDetails[]][], []>; atPath: jest.MockInstance<", + "Observable", + ", [path: ", + "ConfigPath", + "]>; atPathSync: jest.MockInstance; isEnabledAtPath: jest.MockInstance, [path: ", + "ConfigPath", + "]>; getUnusedPaths: jest.MockInstance, []>; getUsedPaths: jest.MockInstance, []>; getDeprecatedConfigPath$: jest.MockInstance<", + "Observable", + "<", + "ChangedDeprecatedPaths", + ">, []>; } & ", + "IConfigService" + ], + "path": "packages/kbn-config-mocks/src/config_service.mock.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/config-mocks", + "id": "def-server.RawConfigServiceMock", + "type": "Type", + "tags": [], + "label": "RawConfigServiceMock", + "description": [], + "signature": [ + "{ stop: jest.MockInstance; getConfig$: jest.MockInstance<", + "Observable", + ">, []>; loadConfig: jest.MockInstance; reloadConfig: jest.MockInstance; } & ", + "PublicMethodsOf", + "<", + "RawConfigService", + ">" + ], + "path": "packages/kbn-config-mocks/src/raw_config_service.mock.ts", + "deprecated": false, + "initialIsOpen": false + } + ], + "objects": [ + { + "parentPluginId": "@kbn/config-mocks", + "id": "def-server.configDeprecationsMock", + "type": "Object", + "tags": [], + "label": "configDeprecationsMock", + "description": [], + "path": "packages/kbn-config-mocks/src/deprecations.mock.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/config-mocks", + "id": "def-server.configDeprecationsMock.createContext", + "type": "Function", + "tags": [], + "label": "createContext", + "description": [], + "signature": [ + "() => ", + "ConfigDeprecationContext" + ], + "path": "packages/kbn-config-mocks/src/deprecations.mock.ts", + "deprecated": false, + "returnComment": [], + "children": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/config-mocks", + "id": "def-server.configMock", + "type": "Object", + "tags": [], + "label": "configMock", + "description": [], + "path": "packages/kbn-config-mocks/src/config.mock.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/config-mocks", + "id": "def-server.configMock.create", + "type": "Function", + "tags": [], + "label": "create", + "description": [], + "signature": [ + "() => ", + { + "pluginId": "@kbn/config-mocks", + "scope": "server", + "docId": "kibKbnConfigMocksPluginApi", + "section": "def-server.ConfigMock", + "text": "ConfigMock" + } + ], + "path": "packages/kbn-config-mocks/src/config.mock.ts", + "deprecated": false, + "returnComment": [], + "children": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/config-mocks", + "id": "def-server.configServiceMock", + "type": "Object", + "tags": [], + "label": "configServiceMock", + "description": [], + "path": "packages/kbn-config-mocks/src/config_service.mock.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/config-mocks", + "id": "def-server.configServiceMock.create", + "type": "Function", + "tags": [], + "label": "create", + "description": [], + "signature": [ + "({ atPath, getConfig$, }?: { atPath?: Record | undefined; getConfig$?: Record | undefined; }) => ", + { + "pluginId": "@kbn/config-mocks", + "scope": "server", + "docId": "kibKbnConfigMocksPluginApi", + "section": "def-server.IConfigServiceMock", + "text": "IConfigServiceMock" + } + ], + "path": "packages/kbn-config-mocks/src/config_service.mock.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/config-mocks", + "id": "def-server.configServiceMock.create.$1", + "type": "Object", + "tags": [], + "label": "__0", + "description": [], + "signature": [ + "{ atPath?: Record | undefined; getConfig$?: Record | undefined; }" + ], + "path": "packages/kbn-config-mocks/src/config_service.mock.ts", + "deprecated": false + } + ] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/config-mocks", + "id": "def-server.rawConfigServiceMock", + "type": "Object", + "tags": [], + "label": "rawConfigServiceMock", + "description": [], + "path": "packages/kbn-config-mocks/src/raw_config_service.mock.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/config-mocks", + "id": "def-server.rawConfigServiceMock.create", + "type": "Function", + "tags": [], + "label": "create", + "description": [], + "signature": [ + "({ rawConfig, rawConfig$, }?: { rawConfig?: Record | undefined; rawConfig$?: ", + "Observable", + "> | undefined; }) => ", + { + "pluginId": "@kbn/config-mocks", + "scope": "server", + "docId": "kibKbnConfigMocksPluginApi", + "section": "def-server.RawConfigServiceMock", + "text": "RawConfigServiceMock" + } + ], + "path": "packages/kbn-config-mocks/src/raw_config_service.mock.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/config-mocks", + "id": "def-server.rawConfigServiceMock.create.$1", + "type": "Object", + "tags": [], + "label": "__0", + "description": [], + "signature": [ + "{ rawConfig?: Record | undefined; rawConfig$?: ", + "Observable", + "> | undefined; }" + ], + "path": "packages/kbn-config-mocks/src/raw_config_service.mock.ts", + "deprecated": false + } + ] + } + ], + "initialIsOpen": false + } + ] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_config_mocks.mdx b/api_docs/kbn_config_mocks.mdx new file mode 100644 index 00000000000000..f28999376acbb1 --- /dev/null +++ b/api_docs/kbn_config_mocks.mdx @@ -0,0 +1,33 @@ +--- +id: kibKbnConfigMocksPluginApi +slug: /kibana-dev-docs/api/kbn-config-mocks +title: "@kbn/config-mocks" +image: https://source.unsplash.com/400x175/?github +summary: API docs for the @kbn/config-mocks plugin +date: 2022-06-07 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/config-mocks'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- +import kbnConfigMocksObj from './kbn_config_mocks.devdocs.json'; + + + +Contact [Owner missing] for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 16 | 0 | 16 | 0 | + +## Server + +### Objects + + +### Functions + + +### Consts, variables and types + + diff --git a/api_docs/kbn_config_schema.mdx b/api_docs/kbn_config_schema.mdx index 3ef3259547b394..4759c009975457 100644 --- a/api_docs/kbn_config_schema.mdx +++ b/api_docs/kbn_config_schema.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-config-schema title: "@kbn/config-schema" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/config-schema plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/config-schema'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_base_common.devdocs.json b/api_docs/kbn_core_base_common.devdocs.json new file mode 100644 index 00000000000000..688bcffef53a0e --- /dev/null +++ b/api_docs/kbn_core_base_common.devdocs.json @@ -0,0 +1,194 @@ +{ + "id": "@kbn/core-base-common", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [ + { + "parentPluginId": "@kbn/core-base-common", + "id": "def-server.DiscoveredPlugin", + "type": "Interface", + "tags": [], + "label": "DiscoveredPlugin", + "description": [ + "\nSmall container object used to expose information about discovered plugins that may\nor may not have been started." + ], + "path": "packages/core/base/core-base-common/src/plugins.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-base-common", + "id": "def-server.DiscoveredPlugin.id", + "type": "string", + "tags": [], + "label": "id", + "description": [ + "\nIdentifier of the plugin." + ], + "path": "packages/core/base/core-base-common/src/plugins.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-base-common", + "id": "def-server.DiscoveredPlugin.configPath", + "type": "CompoundType", + "tags": [], + "label": "configPath", + "description": [ + "\nRoot configuration path used by the plugin, defaults to \"id\" in snake_case format." + ], + "signature": [ + "string | string[]" + ], + "path": "packages/core/base/core-base-common/src/plugins.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-base-common", + "id": "def-server.DiscoveredPlugin.type", + "type": "Enum", + "tags": [], + "label": "type", + "description": [ + "\nType of the plugin, defaults to `standard`." + ], + "signature": [ + { + "pluginId": "@kbn/core-base-common", + "scope": "server", + "docId": "kibKbnCoreBaseCommonPluginApi", + "section": "def-server.PluginType", + "text": "PluginType" + } + ], + "path": "packages/core/base/core-base-common/src/plugins.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-base-common", + "id": "def-server.DiscoveredPlugin.requiredPlugins", + "type": "Object", + "tags": [], + "label": "requiredPlugins", + "description": [ + "\nAn optional list of the other plugins that **must be** installed and enabled\nfor this plugin to function properly." + ], + "signature": [ + "readonly string[]" + ], + "path": "packages/core/base/core-base-common/src/plugins.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-base-common", + "id": "def-server.DiscoveredPlugin.optionalPlugins", + "type": "Object", + "tags": [], + "label": "optionalPlugins", + "description": [ + "\nAn optional list of the other plugins that if installed and enabled **may be**\nleveraged by this plugin for some additional functionality but otherwise are\nnot required for this plugin to work properly." + ], + "signature": [ + "readonly string[]" + ], + "path": "packages/core/base/core-base-common/src/plugins.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-base-common", + "id": "def-server.DiscoveredPlugin.requiredBundles", + "type": "Object", + "tags": [], + "label": "requiredBundles", + "description": [ + "\nList of plugin ids that this plugin's UI code imports modules from that are\nnot in `requiredPlugins`.\n" + ], + "signature": [ + "readonly string[]" + ], + "path": "packages/core/base/core-base-common/src/plugins.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-base-common", + "id": "def-server.DiscoveredPlugin.enabledOnAnonymousPages", + "type": "CompoundType", + "tags": [], + "label": "enabledOnAnonymousPages", + "description": [ + "\nSpecifies whether this plugin - and its required dependencies - will be enabled for anonymous pages (login page, status page when\nconfigured, etc.) Default is false." + ], + "signature": [ + "boolean | undefined" + ], + "path": "packages/core/base/core-base-common/src/plugins.ts", + "deprecated": false + } + ], + "initialIsOpen": false + } + ], + "enums": [ + { + "parentPluginId": "@kbn/core-base-common", + "id": "def-server.PluginType", + "type": "Enum", + "tags": [], + "label": "PluginType", + "description": [], + "path": "packages/core/base/core-base-common/src/plugins.ts", + "deprecated": false, + "initialIsOpen": false + } + ], + "misc": [ + { + "parentPluginId": "@kbn/core-base-common", + "id": "def-server.PluginName", + "type": "Type", + "tags": [], + "label": "PluginName", + "description": [ + "\nDedicated type for plugin name/id that is supposed to make Map/Set/Arrays\nthat use it as a key or value more obvious.\n" + ], + "signature": [ + "string" + ], + "path": "packages/core/base/core-base-common/src/plugins.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-base-common", + "id": "def-server.PluginOpaqueId", + "type": "Type", + "tags": [], + "label": "PluginOpaqueId", + "description": [], + "signature": [ + "symbol" + ], + "path": "packages/core/base/core-base-common/src/plugins.ts", + "deprecated": false, + "initialIsOpen": false + } + ], + "objects": [] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_core_base_common.mdx b/api_docs/kbn_core_base_common.mdx new file mode 100644 index 00000000000000..4919f88d90bf89 --- /dev/null +++ b/api_docs/kbn_core_base_common.mdx @@ -0,0 +1,33 @@ +--- +id: kibKbnCoreBaseCommonPluginApi +slug: /kibana-dev-docs/api/kbn-core-base-common +title: "@kbn/core-base-common" +image: https://source.unsplash.com/400x175/?github +summary: API docs for the @kbn/core-base-common plugin +date: 2022-06-07 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-base-common'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- +import kbnCoreBaseCommonObj from './kbn_core_base_common.devdocs.json'; + + + +Contact [Owner missing] for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 11 | 0 | 2 | 0 | + +## Server + +### Interfaces + + +### Enums + + +### Consts, variables and types + + diff --git a/api_docs/kbn_core_injected_metadata_browser.devdocs.json b/api_docs/kbn_core_injected_metadata_browser.devdocs.json new file mode 100644 index 00000000000000..07a1a9cbfa9004 --- /dev/null +++ b/api_docs/kbn_core_injected_metadata_browser.devdocs.json @@ -0,0 +1,154 @@ +{ + "id": "@kbn/core-injected-metadata-browser", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [ + { + "parentPluginId": "@kbn/core-injected-metadata-browser", + "id": "def-common.InjectedMetadataSetup", + "type": "Interface", + "tags": [ + "deprecated" + ], + "label": "InjectedMetadataSetup", + "description": [ + "\nexposed temporarily until https://github.com/elastic/kibana/issues/41990 done\nuse *only* to retrieve config values. There is no way to set injected values\nin the new platform." + ], + "path": "packages/core/injected-metadata/core-injected-metadata-browser/src/contract.ts", + "deprecated": true, + "removeBy": "8.8.0", + "references": [], + "children": [ + { + "parentPluginId": "@kbn/core-injected-metadata-browser", + "id": "def-common.InjectedMetadataSetup.getInjectedVar", + "type": "Function", + "tags": [], + "label": "getInjectedVar", + "description": [], + "signature": [ + "(name: string, defaultValue?: any) => unknown" + ], + "path": "packages/core/injected-metadata/core-injected-metadata-browser/src/contract.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-injected-metadata-browser", + "id": "def-common.InjectedMetadataSetup.getInjectedVar.$1", + "type": "string", + "tags": [], + "label": "name", + "description": [], + "signature": [ + "string" + ], + "path": "packages/core/injected-metadata/core-injected-metadata-browser/src/contract.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-injected-metadata-browser", + "id": "def-common.InjectedMetadataSetup.getInjectedVar.$2", + "type": "Any", + "tags": [], + "label": "defaultValue", + "description": [], + "signature": [ + "any" + ], + "path": "packages/core/injected-metadata/core-injected-metadata-browser/src/contract.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-injected-metadata-browser", + "id": "def-common.InjectedMetadataStart", + "type": "Interface", + "tags": [ + "deprecated" + ], + "label": "InjectedMetadataStart", + "description": [ + "\nexposed temporarily until https://github.com/elastic/kibana/issues/41990 done\nuse *only* to retrieve config values. There is no way to set injected values\nin the new platform." + ], + "path": "packages/core/injected-metadata/core-injected-metadata-browser/src/contract.ts", + "deprecated": true, + "removeBy": "8.8.0", + "references": [], + "children": [ + { + "parentPluginId": "@kbn/core-injected-metadata-browser", + "id": "def-common.InjectedMetadataStart.getInjectedVar", + "type": "Function", + "tags": [], + "label": "getInjectedVar", + "description": [], + "signature": [ + "(name: string, defaultValue?: any) => unknown" + ], + "path": "packages/core/injected-metadata/core-injected-metadata-browser/src/contract.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-injected-metadata-browser", + "id": "def-common.InjectedMetadataStart.getInjectedVar.$1", + "type": "string", + "tags": [], + "label": "name", + "description": [], + "signature": [ + "string" + ], + "path": "packages/core/injected-metadata/core-injected-metadata-browser/src/contract.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-injected-metadata-browser", + "id": "def-common.InjectedMetadataStart.getInjectedVar.$2", + "type": "Any", + "tags": [], + "label": "defaultValue", + "description": [], + "signature": [ + "any" + ], + "path": "packages/core/injected-metadata/core-injected-metadata-browser/src/contract.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + } + ], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_core_injected_metadata_browser.mdx b/api_docs/kbn_core_injected_metadata_browser.mdx new file mode 100644 index 00000000000000..5d1f0cd7e58ec7 --- /dev/null +++ b/api_docs/kbn_core_injected_metadata_browser.mdx @@ -0,0 +1,27 @@ +--- +id: kibKbnCoreInjectedMetadataBrowserPluginApi +slug: /kibana-dev-docs/api/kbn-core-injected-metadata-browser +title: "@kbn/core-injected-metadata-browser" +image: https://source.unsplash.com/400x175/?github +summary: API docs for the @kbn/core-injected-metadata-browser plugin +date: 2022-06-07 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-injected-metadata-browser'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- +import kbnCoreInjectedMetadataBrowserObj from './kbn_core_injected_metadata_browser.devdocs.json'; + + + +Contact [Owner missing] for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 8 | 2 | 6 | 0 | + +## Common + +### Interfaces + + diff --git a/api_docs/kbn_core_injected_metadata_browser_mocks.devdocs.json b/api_docs/kbn_core_injected_metadata_browser_mocks.devdocs.json new file mode 100644 index 00000000000000..2cd742c417c2b5 --- /dev/null +++ b/api_docs/kbn_core_injected_metadata_browser_mocks.devdocs.json @@ -0,0 +1,90 @@ +{ + "id": "@kbn/core-injected-metadata-browser-mocks", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [ + { + "parentPluginId": "@kbn/core-injected-metadata-browser-mocks", + "id": "def-common.injectedMetadataServiceMock", + "type": "Object", + "tags": [], + "label": "injectedMetadataServiceMock", + "description": [], + "path": "packages/core/injected-metadata/core-injected-metadata-browser-mocks/src/injected_metadata_service.mock.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-injected-metadata-browser-mocks", + "id": "def-common.injectedMetadataServiceMock.create", + "type": "Function", + "tags": [], + "label": "create", + "description": [], + "signature": [ + "() => jest.Mocked" + ], + "path": "packages/core/injected-metadata/core-injected-metadata-browser-mocks/src/injected_metadata_service.mock.ts", + "deprecated": false, + "returnComment": [], + "children": [] + }, + { + "parentPluginId": "@kbn/core-injected-metadata-browser-mocks", + "id": "def-common.injectedMetadataServiceMock.createSetupContract", + "type": "Function", + "tags": [], + "label": "createSetupContract", + "description": [], + "signature": [ + "() => jest.Mocked<", + "InternalInjectedMetadataSetup", + ">" + ], + "path": "packages/core/injected-metadata/core-injected-metadata-browser-mocks/src/injected_metadata_service.mock.ts", + "deprecated": false, + "returnComment": [], + "children": [] + }, + { + "parentPluginId": "@kbn/core-injected-metadata-browser-mocks", + "id": "def-common.injectedMetadataServiceMock.createStartContract", + "type": "Function", + "tags": [], + "label": "createStartContract", + "description": [], + "signature": [ + "() => jest.Mocked<", + "InternalInjectedMetadataSetup", + ">" + ], + "path": "packages/core/injected-metadata/core-injected-metadata-browser-mocks/src/injected_metadata_service.mock.ts", + "deprecated": false, + "returnComment": [], + "children": [] + } + ], + "initialIsOpen": false + } + ] + } +} \ No newline at end of file diff --git a/api_docs/kbn_core_injected_metadata_browser_mocks.mdx b/api_docs/kbn_core_injected_metadata_browser_mocks.mdx new file mode 100644 index 00000000000000..57e6526833758b --- /dev/null +++ b/api_docs/kbn_core_injected_metadata_browser_mocks.mdx @@ -0,0 +1,27 @@ +--- +id: kibKbnCoreInjectedMetadataBrowserMocksPluginApi +slug: /kibana-dev-docs/api/kbn-core-injected-metadata-browser-mocks +title: "@kbn/core-injected-metadata-browser-mocks" +image: https://source.unsplash.com/400x175/?github +summary: API docs for the @kbn/core-injected-metadata-browser-mocks plugin +date: 2022-06-07 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-injected-metadata-browser-mocks'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- +import kbnCoreInjectedMetadataBrowserMocksObj from './kbn_core_injected_metadata_browser_mocks.devdocs.json'; + + + +Contact [Owner missing] for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 4 | 0 | 4 | 0 | + +## Common + +### Objects + + diff --git a/api_docs/kbn_crypto.mdx b/api_docs/kbn_crypto.mdx index 718cf77fefe1cd..b8a5afb263a2ef 100644 --- a/api_docs/kbn_crypto.mdx +++ b/api_docs/kbn_crypto.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-crypto title: "@kbn/crypto" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/crypto plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/crypto'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_datemath.mdx b/api_docs/kbn_datemath.mdx index ded8431106421a..857f71d397d90d 100644 --- a/api_docs/kbn_datemath.mdx +++ b/api_docs/kbn_datemath.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-datemath title: "@kbn/datemath" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/datemath plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/datemath'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_dev_cli_errors.mdx b/api_docs/kbn_dev_cli_errors.mdx index 7d2e623535ba2f..c4618a1f2e5d7b 100644 --- a/api_docs/kbn_dev_cli_errors.mdx +++ b/api_docs/kbn_dev_cli_errors.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-dev-cli-errors title: "@kbn/dev-cli-errors" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/dev-cli-errors plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/dev-cli-errors'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_dev_cli_runner.mdx b/api_docs/kbn_dev_cli_runner.mdx index 56055ee3b9030f..106fb77d928000 100644 --- a/api_docs/kbn_dev_cli_runner.mdx +++ b/api_docs/kbn_dev_cli_runner.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-dev-cli-runner title: "@kbn/dev-cli-runner" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/dev-cli-runner plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/dev-cli-runner'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_dev_proc_runner.mdx b/api_docs/kbn_dev_proc_runner.mdx index 45b27ecf3c15b6..a647f61b373113 100644 --- a/api_docs/kbn_dev_proc_runner.mdx +++ b/api_docs/kbn_dev_proc_runner.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-dev-proc-runner title: "@kbn/dev-proc-runner" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/dev-proc-runner plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/dev-proc-runner'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_dev_utils.mdx b/api_docs/kbn_dev_utils.mdx index 40a6e1132c3174..a3b7e0d46c8165 100644 --- a/api_docs/kbn_dev_utils.mdx +++ b/api_docs/kbn_dev_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-dev-utils title: "@kbn/dev-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/dev-utils plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/dev-utils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_doc_links.devdocs.json b/api_docs/kbn_doc_links.devdocs.json index 5f01f92b064de1..848d48fff3212b 100644 --- a/api_docs/kbn_doc_links.devdocs.json +++ b/api_docs/kbn_doc_links.devdocs.json @@ -770,7 +770,7 @@ "label": "fleet", "description": [], "signature": [ - "{ readonly beatsAgentComparison: string; readonly guide: string; readonly fleetServer: string; readonly fleetServerAddFleetServer: string; readonly settings: string; readonly settingsFleetServerHostSettings: string; readonly settingsFleetServerProxySettings: string; readonly troubleshooting: string; readonly elasticAgent: string; readonly datastreams: string; readonly datastreamsILM: string; readonly datastreamsNamingScheme: string; readonly installElasticAgent: string; readonly installElasticAgentStandalone: string; readonly upgradeElasticAgent: string; readonly learnMoreBlog: string; readonly apiKeysLearnMore: string; readonly onPremRegistry: string; readonly secureLogstash: string; }" + "{ readonly beatsAgentComparison: string; readonly guide: string; readonly fleetServer: string; readonly fleetServerAddFleetServer: string; readonly settings: string; readonly settingsFleetServerHostSettings: string; readonly settingsFleetServerProxySettings: string; readonly troubleshooting: string; readonly elasticAgent: string; readonly datastreams: string; readonly datastreamsILM: string; readonly datastreamsNamingScheme: string; readonly installElasticAgent: string; readonly installElasticAgentStandalone: string; readonly upgradeElasticAgent: string; readonly learnMoreBlog: string; readonly apiKeysLearnMore: string; readonly onPremRegistry: string; readonly secureLogstash: string; readonly agentPolicy: string; }" ], "path": "packages/kbn-doc-links/src/types.ts", "deprecated": false diff --git a/api_docs/kbn_doc_links.mdx b/api_docs/kbn_doc_links.mdx index 5740f46ca82614..550b023bc6d3c0 100644 --- a/api_docs/kbn_doc_links.mdx +++ b/api_docs/kbn_doc_links.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-doc-links title: "@kbn/doc-links" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/doc-links plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/doc-links'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_docs_utils.mdx b/api_docs/kbn_docs_utils.mdx index 44f2207af05805..4a9db2484ccf8a 100644 --- a/api_docs/kbn_docs_utils.mdx +++ b/api_docs/kbn_docs_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-docs-utils title: "@kbn/docs-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/docs-utils plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/docs-utils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_es_archiver.mdx b/api_docs/kbn_es_archiver.mdx index 00c8183a7c173f..81134605c901e7 100644 --- a/api_docs/kbn_es_archiver.mdx +++ b/api_docs/kbn_es_archiver.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-es-archiver title: "@kbn/es-archiver" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/es-archiver plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/es-archiver'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_es_query.devdocs.json b/api_docs/kbn_es_query.devdocs.json index a1d716484b7934..4d623b6a8d59b0 100644 --- a/api_docs/kbn_es_query.devdocs.json +++ b/api_docs/kbn_es_query.devdocs.json @@ -1172,7 +1172,7 @@ "section": "def-common.RangeFilterParams", "text": "RangeFilterParams" }, - ", indexPattern: ", + ", indexPattern?: ", { "pluginId": "@kbn/es-query", "scope": "common", @@ -1180,7 +1180,7 @@ "section": "def-common.DataViewBase", "text": "DataViewBase" }, - ", formattedValue?: string | undefined) => ", + " | undefined, formattedValue?: string | undefined) => ", { "pluginId": "@kbn/es-query", "scope": "common", @@ -1256,11 +1256,12 @@ "docId": "kibKbnEsQueryPluginApi", "section": "def-common.DataViewBase", "text": "DataViewBase" - } + }, + " | undefined" ], "path": "packages/kbn-es-query/src/filters/build_filters/range_filter.ts", "deprecated": false, - "isRequired": true + "isRequired": false }, { "parentPluginId": "@kbn/es-query", @@ -1482,6 +1483,51 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "@kbn/es-query", + "id": "def-common.convertRangeFilterToTimeRange", + "type": "Function", + "tags": [], + "label": "convertRangeFilterToTimeRange", + "description": [], + "signature": [ + "(filter: ", + { + "pluginId": "@kbn/es-query", + "scope": "common", + "docId": "kibKbnEsQueryPluginApi", + "section": "def-common.RangeFilter", + "text": "RangeFilter" + }, + ") => { from: moment.Moment; to: moment.Moment; }" + ], + "path": "packages/kbn-es-query/src/filters/helpers/convert_range_filter.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/es-query", + "id": "def-common.convertRangeFilterToTimeRange.$1", + "type": "CompoundType", + "tags": [], + "label": "filter", + "description": [], + "signature": [ + { + "pluginId": "@kbn/es-query", + "scope": "common", + "docId": "kibKbnEsQueryPluginApi", + "section": "def-common.RangeFilter", + "text": "RangeFilter" + } + ], + "path": "packages/kbn-es-query/src/filters/helpers/convert_range_filter.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, { "parentPluginId": "@kbn/es-query", "id": "def-common.decorateQuery", @@ -1695,6 +1741,158 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "@kbn/es-query", + "id": "def-common.extractTimeFilter", + "type": "Function", + "tags": [], + "label": "extractTimeFilter", + "description": [], + "signature": [ + "(timeFieldName: string, filters: ", + { + "pluginId": "@kbn/es-query", + "scope": "common", + "docId": "kibKbnEsQueryPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[]) => { restOfFilters: ", + { + "pluginId": "@kbn/es-query", + "scope": "common", + "docId": "kibKbnEsQueryPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[]; timeRangeFilter: ", + { + "pluginId": "@kbn/es-query", + "scope": "common", + "docId": "kibKbnEsQueryPluginApi", + "section": "def-common.RangeFilter", + "text": "RangeFilter" + }, + " | undefined; }" + ], + "path": "packages/kbn-es-query/src/filters/helpers/extract_time_filter.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/es-query", + "id": "def-common.extractTimeFilter.$1", + "type": "string", + "tags": [], + "label": "timeFieldName", + "description": [], + "signature": [ + "string" + ], + "path": "packages/kbn-es-query/src/filters/helpers/extract_time_filter.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/es-query", + "id": "def-common.extractTimeFilter.$2", + "type": "Array", + "tags": [], + "label": "filters", + "description": [], + "signature": [ + { + "pluginId": "@kbn/es-query", + "scope": "common", + "docId": "kibKbnEsQueryPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[]" + ], + "path": "packages/kbn-es-query/src/filters/helpers/extract_time_filter.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/es-query", + "id": "def-common.extractTimeRange", + "type": "Function", + "tags": [], + "label": "extractTimeRange", + "description": [], + "signature": [ + "(filters: ", + { + "pluginId": "@kbn/es-query", + "scope": "common", + "docId": "kibKbnEsQueryPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[], timeFieldName: string | undefined) => { restOfFilters: ", + { + "pluginId": "@kbn/es-query", + "scope": "common", + "docId": "kibKbnEsQueryPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[]; timeRange?: ", + { + "pluginId": "@kbn/es-query", + "scope": "common", + "docId": "kibKbnEsQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + }, + " | undefined; }" + ], + "path": "packages/kbn-es-query/src/filters/helpers/extract_time_filter.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/es-query", + "id": "def-common.extractTimeRange.$1", + "type": "Array", + "tags": [], + "label": "filters", + "description": [], + "signature": [ + { + "pluginId": "@kbn/es-query", + "scope": "common", + "docId": "kibKbnEsQueryPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[]" + ], + "path": "packages/kbn-es-query/src/filters/helpers/extract_time_filter.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/es-query", + "id": "def-common.extractTimeRange.$2", + "type": "string", + "tags": [], + "label": "timeFieldName", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "packages/kbn-es-query/src/filters/helpers/extract_time_filter.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [], + "initialIsOpen": false + }, { "parentPluginId": "@kbn/es-query", "id": "def-common.fromKueryExpression", @@ -3420,7 +3618,7 @@ "label": "function", "description": [], "signature": [ - "\"nested\" | \"exists\" | \"and\" | \"or\" | \"is\" | \"range\" | \"not\"" + "\"nested\" | \"exists\" | \"range\" | \"is\" | \"and\" | \"or\" | \"not\"" ], "path": "packages/kbn-es-query/src/kuery/node_types/types.ts", "deprecated": false @@ -4256,6 +4454,20 @@ "path": "packages/kbn-es-query/src/filters/build_filters/range_filter.ts", "deprecated": false, "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/es-query", + "id": "def-common.TimeRange", + "type": "Type", + "tags": [], + "label": "TimeRange", + "description": [], + "signature": [ + "{ from: string; to: string; mode?: \"absolute\" | \"relative\" | undefined; }" + ], + "path": "packages/kbn-es-query/src/filters/helpers/types.ts", + "deprecated": false, + "initialIsOpen": false } ], "objects": [ diff --git a/api_docs/kbn_es_query.mdx b/api_docs/kbn_es_query.mdx index d7bcee06654582..0214222f266b6a 100644 --- a/api_docs/kbn_es_query.mdx +++ b/api_docs/kbn_es_query.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-es-query title: "@kbn/es-query" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/es-query plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/es-query'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Owner missing] for questions regarding this plugin. | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 213 | 1 | 159 | 11 | +| 222 | 1 | 168 | 11 | ## Common diff --git a/api_docs/kbn_eslint_plugin_imports.mdx b/api_docs/kbn_eslint_plugin_imports.mdx index a6cd7adf4f641c..616b08d20dafe4 100644 --- a/api_docs/kbn_eslint_plugin_imports.mdx +++ b/api_docs/kbn_eslint_plugin_imports.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-eslint-plugin-imports title: "@kbn/eslint-plugin-imports" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/eslint-plugin-imports plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/eslint-plugin-imports'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_field_types.mdx b/api_docs/kbn_field_types.mdx index e180f17bbc2f64..64bb25e65aafec 100644 --- a/api_docs/kbn_field_types.mdx +++ b/api_docs/kbn_field_types.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-field-types title: "@kbn/field-types" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/field-types plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/field-types'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_find_used_node_modules.mdx b/api_docs/kbn_find_used_node_modules.mdx index 5be9c941e585d6..199a5e81c41328 100644 --- a/api_docs/kbn_find_used_node_modules.mdx +++ b/api_docs/kbn_find_used_node_modules.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-find-used-node-modules title: "@kbn/find-used-node-modules" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/find-used-node-modules plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/find-used-node-modules'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_generate.mdx b/api_docs/kbn_generate.mdx index 4ed7a9b37dca09..caf08bec0e48ec 100644 --- a/api_docs/kbn_generate.mdx +++ b/api_docs/kbn_generate.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-generate title: "@kbn/generate" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/generate plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/generate'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_handlebars.mdx b/api_docs/kbn_handlebars.mdx index b9955fc792beaf..a3199ecf9db477 100644 --- a/api_docs/kbn_handlebars.mdx +++ b/api_docs/kbn_handlebars.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-handlebars title: "@kbn/handlebars" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/handlebars plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/handlebars'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_i18n.mdx b/api_docs/kbn_i18n.mdx index 0385c399205fa1..868208840d39d1 100644 --- a/api_docs/kbn_i18n.mdx +++ b/api_docs/kbn_i18n.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-i18n title: "@kbn/i18n" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/i18n plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/i18n'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_import_resolver.mdx b/api_docs/kbn_import_resolver.mdx index edde41219d667e..6507ecc1f9378d 100644 --- a/api_docs/kbn_import_resolver.mdx +++ b/api_docs/kbn_import_resolver.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-import-resolver title: "@kbn/import-resolver" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/import-resolver plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/import-resolver'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_interpreter.mdx b/api_docs/kbn_interpreter.mdx index 634184ca6bdded..6d41b9fa03b597 100644 --- a/api_docs/kbn_interpreter.mdx +++ b/api_docs/kbn_interpreter.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-interpreter title: "@kbn/interpreter" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/interpreter plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/interpreter'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_io_ts_utils.mdx b/api_docs/kbn_io_ts_utils.mdx index 35a5203b9ea019..1a2c3d62627e43 100644 --- a/api_docs/kbn_io_ts_utils.mdx +++ b/api_docs/kbn_io_ts_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-io-ts-utils title: "@kbn/io-ts-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/io-ts-utils plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/io-ts-utils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_jest_serializers.mdx b/api_docs/kbn_jest_serializers.mdx index 4163d96e41085a..e8d673c56f4503 100644 --- a/api_docs/kbn_jest_serializers.mdx +++ b/api_docs/kbn_jest_serializers.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-jest-serializers title: "@kbn/jest-serializers" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/jest-serializers plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/jest-serializers'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_kibana_json_schema.mdx b/api_docs/kbn_kibana_json_schema.mdx index d4976f635a3a37..a25f2d2d828c0d 100644 --- a/api_docs/kbn_kibana_json_schema.mdx +++ b/api_docs/kbn_kibana_json_schema.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-kibana-json-schema title: "@kbn/kibana-json-schema" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/kibana-json-schema plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/kibana-json-schema'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_logging.mdx b/api_docs/kbn_logging.mdx index 1c659966258281..707a364cbd5e4a 100644 --- a/api_docs/kbn_logging.mdx +++ b/api_docs/kbn_logging.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-logging title: "@kbn/logging" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/logging plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/logging'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_logging_mocks.mdx b/api_docs/kbn_logging_mocks.mdx index add97416dff8ac..4569783efbb093 100644 --- a/api_docs/kbn_logging_mocks.mdx +++ b/api_docs/kbn_logging_mocks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-logging-mocks title: "@kbn/logging-mocks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/logging-mocks plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/logging-mocks'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_mapbox_gl.mdx b/api_docs/kbn_mapbox_gl.mdx index c45a65ac0f5527..ac2a3cdcc126eb 100644 --- a/api_docs/kbn_mapbox_gl.mdx +++ b/api_docs/kbn_mapbox_gl.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-mapbox-gl title: "@kbn/mapbox-gl" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/mapbox-gl plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/mapbox-gl'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_monaco.mdx b/api_docs/kbn_monaco.mdx index 2e4a085565f102..1330ab711f0495 100644 --- a/api_docs/kbn_monaco.mdx +++ b/api_docs/kbn_monaco.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-monaco title: "@kbn/monaco" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/monaco plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/monaco'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_optimizer.mdx b/api_docs/kbn_optimizer.mdx index a36790bde6bfae..ab70944c4e4cd8 100644 --- a/api_docs/kbn_optimizer.mdx +++ b/api_docs/kbn_optimizer.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-optimizer title: "@kbn/optimizer" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/optimizer plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/optimizer'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_performance_testing_dataset_extractor.mdx b/api_docs/kbn_performance_testing_dataset_extractor.mdx index e4b0a6d7f9b026..2f69dd7190f7b2 100644 --- a/api_docs/kbn_performance_testing_dataset_extractor.mdx +++ b/api_docs/kbn_performance_testing_dataset_extractor.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-performance-testing-dataset-extractor title: "@kbn/performance-testing-dataset-extractor" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/performance-testing-dataset-extractor plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/performance-testing-dataset-extractor'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_plugin_discovery.mdx b/api_docs/kbn_plugin_discovery.mdx index 4d8341eee376f2..724c48291445f7 100644 --- a/api_docs/kbn_plugin_discovery.mdx +++ b/api_docs/kbn_plugin_discovery.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-plugin-discovery title: "@kbn/plugin-discovery" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/plugin-discovery plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/plugin-discovery'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_plugin_generator.mdx b/api_docs/kbn_plugin_generator.mdx index 9ba1efa764ab2d..03b143abb0dc89 100644 --- a/api_docs/kbn_plugin_generator.mdx +++ b/api_docs/kbn_plugin_generator.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-plugin-generator title: "@kbn/plugin-generator" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/plugin-generator plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/plugin-generator'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_plugin_helpers.mdx b/api_docs/kbn_plugin_helpers.mdx index abb341979ec40f..6412a5a086b9c1 100644 --- a/api_docs/kbn_plugin_helpers.mdx +++ b/api_docs/kbn_plugin_helpers.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-plugin-helpers title: "@kbn/plugin-helpers" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/plugin-helpers plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/plugin-helpers'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_pm.mdx b/api_docs/kbn_pm.mdx index 8412a120ff2a49..4092ae3b785db9 100644 --- a/api_docs/kbn_pm.mdx +++ b/api_docs/kbn_pm.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-pm title: "@kbn/pm" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/pm plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/pm'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_react_field.mdx b/api_docs/kbn_react_field.mdx index d86226fcee3a6f..050d94a899bc96 100644 --- a/api_docs/kbn_react_field.mdx +++ b/api_docs/kbn_react_field.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-react-field title: "@kbn/react-field" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/react-field plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/react-field'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_rule_data_utils.devdocs.json b/api_docs/kbn_rule_data_utils.devdocs.json index 291375f8827c9e..461ba64123a3de 100644 --- a/api_docs/kbn_rule_data_utils.devdocs.json +++ b/api_docs/kbn_rule_data_utils.devdocs.json @@ -855,7 +855,7 @@ "label": "AlertConsumers", "description": [], "signature": [ - "\"logs\" | \"apm\" | \"observability\" | \"uptime\" | \"infrastructure\" | \"siem\"" + "\"logs\" | \"apm\" | \"infrastructure\" | \"observability\" | \"uptime\" | \"siem\"" ], "path": "packages/kbn-rule-data-utils/src/alerts_as_data_rbac.ts", "deprecated": false, @@ -1037,7 +1037,7 @@ "label": "ValidFeatureId", "description": [], "signature": [ - "\"logs\" | \"apm\" | \"observability\" | \"uptime\" | \"infrastructure\" | \"siem\"" + "\"logs\" | \"apm\" | \"infrastructure\" | \"observability\" | \"uptime\" | \"siem\"" ], "path": "packages/kbn-rule-data-utils/src/alerts_as_data_rbac.ts", "deprecated": false, diff --git a/api_docs/kbn_rule_data_utils.mdx b/api_docs/kbn_rule_data_utils.mdx index bf19fdfc35d368..1eaf261161bf63 100644 --- a/api_docs/kbn_rule_data_utils.mdx +++ b/api_docs/kbn_rule_data_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-rule-data-utils title: "@kbn/rule-data-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/rule-data-utils plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/rule-data-utils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_autocomplete.devdocs.json b/api_docs/kbn_securitysolution_autocomplete.devdocs.json index 3c23bf9f438228..19f0d8fc2a5c9b 100644 --- a/api_docs/kbn_securitysolution_autocomplete.devdocs.json +++ b/api_docs/kbn_securitysolution_autocomplete.devdocs.json @@ -305,9 +305,9 @@ "\nGiven an array of lists and optionally a field this will return all\nthe lists that match against the field based on the types from the field\n\nNOTE: That we support one additional property from \"FieldSpec\" located here:\nsrc/plugins/data/common/index_patterns/fields/types.ts\nThis type property is esTypes. If it exists and is on there we will read off the esTypes." ], "signature": [ - "(lists: { _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; version: number; }[], field?: (", + "(lists: { _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; }[], field?: (", "DataViewFieldBase", - " & { esTypes?: string[] | undefined; }) | undefined) => { _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; version: number; }[]" + " & { esTypes?: string[] | undefined; }) | undefined) => { _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; }[]" ], "path": "packages/kbn-securitysolution-autocomplete/src/filter_field_to_list/index.ts", "deprecated": false, @@ -322,7 +322,7 @@ "The lists to match against the field" ], "signature": [ - "{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; version: number; }[]" + "{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; }[]" ], "path": "packages/kbn-securitysolution-autocomplete/src/filter_field_to_list/index.ts", "deprecated": false, diff --git a/api_docs/kbn_securitysolution_autocomplete.mdx b/api_docs/kbn_securitysolution_autocomplete.mdx index 6c4077ccf27f35..35198909605dff 100644 --- a/api_docs/kbn_securitysolution_autocomplete.mdx +++ b/api_docs/kbn_securitysolution_autocomplete.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-autocomplete title: "@kbn/securitysolution-autocomplete" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-autocomplete plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-autocomplete'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_es_utils.mdx b/api_docs/kbn_securitysolution_es_utils.mdx index 0c78f787e3a908..8aabba4361cf83 100644 --- a/api_docs/kbn_securitysolution_es_utils.mdx +++ b/api_docs/kbn_securitysolution_es_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-es-utils title: "@kbn/securitysolution-es-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-es-utils plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-es-utils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_hook_utils.mdx b/api_docs/kbn_securitysolution_hook_utils.mdx index 72d15369ce1acd..3c89fe16f96dec 100644 --- a/api_docs/kbn_securitysolution_hook_utils.mdx +++ b/api_docs/kbn_securitysolution_hook_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-hook-utils title: "@kbn/securitysolution-hook-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-hook-utils plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-hook-utils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_io_ts_alerting_types.mdx b/api_docs/kbn_securitysolution_io_ts_alerting_types.mdx index 5cea36c3e21a3f..3a6afe06cd8b07 100644 --- a/api_docs/kbn_securitysolution_io_ts_alerting_types.mdx +++ b/api_docs/kbn_securitysolution_io_ts_alerting_types.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-io-ts-alerting-types title: "@kbn/securitysolution-io-ts-alerting-types" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-io-ts-alerting-types plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-io-ts-alerting-types'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_io_ts_list_types.devdocs.json b/api_docs/kbn_securitysolution_io_ts_list_types.devdocs.json index 333ab73f958fc4..401b41b8bd714d 100644 --- a/api_docs/kbn_securitysolution_io_ts_list_types.devdocs.json +++ b/api_docs/kbn_securitysolution_io_ts_list_types.devdocs.json @@ -27,7 +27,7 @@ "label": "updateExceptionListItemValidate", "description": [], "signature": [ - "(schema: { description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; name: string; type: \"simple\"; } & { _version?: string | undefined; comments?: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id?: string | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }) => string[]" + "(schema: { description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; name: string; type: \"simple\"; } & { _version?: string | undefined; comments?: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id?: string | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }) => string[]" ], "path": "packages/kbn-securitysolution-io-ts-list-types/src/request/update_exception_list_item_validation/index.ts", "deprecated": false, @@ -40,7 +40,7 @@ "label": "schema", "description": [], "signature": [ - "{ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; name: string; type: \"simple\"; } & { _version?: string | undefined; comments?: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id?: string | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }" + "{ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; name: string; type: \"simple\"; } & { _version?: string | undefined; comments?: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id?: string | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }" ], "path": "packages/kbn-securitysolution-io-ts-list-types/src/request/update_exception_list_item_validation/index.ts", "deprecated": false, @@ -58,7 +58,7 @@ "label": "validateComments", "description": [], "signature": [ - "(item: { description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; name: string; type: \"simple\"; } & { _version?: string | undefined; comments?: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id?: string | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }) => string[]" + "(item: { description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; name: string; type: \"simple\"; } & { _version?: string | undefined; comments?: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id?: string | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }) => string[]" ], "path": "packages/kbn-securitysolution-io-ts-list-types/src/request/update_exception_list_item_validation/index.ts", "deprecated": false, @@ -71,7 +71,7 @@ "label": "item", "description": [], "signature": [ - "{ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; name: string; type: \"simple\"; } & { _version?: string | undefined; comments?: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id?: string | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }" + "{ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; name: string; type: \"simple\"; } & { _version?: string | undefined; comments?: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id?: string | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }" ], "path": "packages/kbn-securitysolution-io-ts-list-types/src/request/update_exception_list_item_validation/index.ts", "deprecated": false, @@ -153,7 +153,7 @@ "label": "listItem", "description": [], "signature": [ - "{ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; list_id: string; name: string; type: \"simple\"; } & { comments?: { comment: string; }[] | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }" + "{ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; list_id: string; name: string; type: \"simple\"; } & { comments?: { comment: string; }[] | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }" ], "path": "packages/kbn-securitysolution-io-ts-list-types/src/typescript_types/index.ts", "deprecated": false @@ -1216,7 +1216,7 @@ "label": "listItem", "description": [], "signature": [ - "{ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; name: string; type: \"simple\"; } & { _version?: string | undefined; comments?: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id?: string | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }" + "{ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; name: string; type: \"simple\"; } & { _version?: string | undefined; comments?: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id?: string | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }" ], "path": "packages/kbn-securitysolution-io-ts-list-types/src/typescript_types/index.ts", "deprecated": false @@ -1307,7 +1307,7 @@ "label": "exceptions", "description": [], "signature": [ - "{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }[]" + "{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }[]" ], "path": "packages/kbn-securitysolution-io-ts-list-types/src/typescript_types/index.ts", "deprecated": false @@ -1897,7 +1897,7 @@ "label": "CreateEndpointListItemSchemaDecoded", "description": [], "signature": [ - "Omit<{ description: string; entries: ({ field: string; operator: \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; })[]; name: string; type: \"simple\"; comments: { comment: string; }[] | undefined; item_id: string | undefined; meta: object | undefined; os_types: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags: string[] | undefined; }, \"tags\" | \"entries\" | \"comments\" | \"item_id\" | \"os_types\"> & { comments: { comment: string; }[]; tags: string[]; item_id: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; os_types: (\"windows\" | \"linux\" | \"macos\")[]; }" + "Omit<{ description: string; entries: ({ field: string; operator: \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; })[]; name: string; type: \"simple\"; comments: { comment: string; }[] | undefined; item_id: string | undefined; meta: object | undefined; os_types: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags: string[] | undefined; }, \"tags\" | \"entries\" | \"comments\" | \"item_id\" | \"os_types\"> & { comments: { comment: string; }[]; tags: string[]; item_id: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; os_types: (\"windows\" | \"linux\" | \"macos\")[]; }" ], "path": "packages/kbn-securitysolution-io-ts-list-types/src/request/create_endpoint_list_item_schema/index.ts", "deprecated": false, @@ -1925,7 +1925,7 @@ "label": "CreateExceptionListItemSchema", "description": [], "signature": [ - "{ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; list_id: string; name: string; type: \"simple\"; } & { comments?: { comment: string; }[] | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }" + "{ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; list_id: string; name: string; type: \"simple\"; } & { comments?: { comment: string; }[] | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }" ], "path": "packages/kbn-securitysolution-io-ts-list-types/src/request/create_exception_list_item_schema/index.ts", "deprecated": false, @@ -1939,7 +1939,7 @@ "label": "CreateExceptionListItemSchemaDecoded", "description": [], "signature": [ - "Omit<{ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; list_id: string; name: string; type: \"simple\"; comments: { comment: string; }[] | undefined; item_id: string | undefined; meta: object | undefined; namespace_type: \"single\" | \"agnostic\" | undefined; os_types: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags: string[] | undefined; }, \"tags\" | \"entries\" | \"comments\" | \"item_id\" | \"namespace_type\"> & { comments: { comment: string; }[]; tags: string[]; item_id: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; }" + "Omit<{ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; list_id: string; name: string; type: \"simple\"; comments: { comment: string; }[] | undefined; item_id: string | undefined; meta: object | undefined; namespace_type: \"single\" | \"agnostic\" | undefined; os_types: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags: string[] | undefined; }, \"tags\" | \"entries\" | \"comments\" | \"item_id\" | \"namespace_type\"> & { comments: { comment: string; }[]; tags: string[]; item_id: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; }" ], "path": "packages/kbn-securitysolution-io-ts-list-types/src/request/create_exception_list_item_schema/index.ts", "deprecated": false, @@ -2009,7 +2009,7 @@ "label": "CreateListSchema", "description": [], "signature": [ - "{ description: string; name: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; } & { deserializer?: string | undefined; id?: string | undefined; meta?: object | undefined; serializer?: string | undefined; version?: number | undefined; }" + "{ description: string; name: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; } & { deserializer?: string | undefined; id?: string | undefined; meta?: object | undefined; serializer?: string | undefined; version?: number | undefined; }" ], "path": "packages/kbn-securitysolution-io-ts-list-types/src/request/create_list_schema/index.ts", "deprecated": false, @@ -2023,7 +2023,7 @@ "label": "CreateListSchemaDecoded", "description": [], "signature": [ - "{ id: string | undefined; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; description: string; name: string; meta: object | undefined; serializer: string | undefined; deserializer: string | undefined; } & { version: number; }" + "{ id: string | undefined; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; description: string; name: string; meta: object | undefined; serializer: string | undefined; deserializer: string | undefined; } & { version: number; }" ], "path": "packages/kbn-securitysolution-io-ts-list-types/src/request/create_list_schema/index.ts", "deprecated": false, @@ -2317,7 +2317,7 @@ "label": "EntriesArray", "description": [], "signature": [ - "({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]" + "({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]" ], "path": "packages/kbn-securitysolution-io-ts-list-types/src/common/entries/index.ts", "deprecated": false, @@ -2331,7 +2331,7 @@ "label": "EntriesArrayOrUndefined", "description": [], "signature": [ - "({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[] | undefined" + "({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[] | undefined" ], "path": "packages/kbn-securitysolution-io-ts-list-types/src/common/entries/index.ts", "deprecated": false, @@ -2345,7 +2345,7 @@ "label": "Entry", "description": [], "signature": [ - "{ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; }" + "{ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; }" ], "path": "packages/kbn-securitysolution-io-ts-list-types/src/common/entries/index.ts", "deprecated": false, @@ -2373,7 +2373,7 @@ "label": "EntryList", "description": [], "signature": [ - "{ field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; }" + "{ field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; }" ], "path": "packages/kbn-securitysolution-io-ts-list-types/src/common/entries_list/index.ts", "deprecated": false, @@ -2443,7 +2443,7 @@ "label": "ExceptionListItemSchema", "description": [], "signature": [ - "{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }" + "{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }" ], "path": "packages/kbn-securitysolution-io-ts-list-types/src/response/exception_list_item_schema/index.ts", "deprecated": false, @@ -2765,7 +2765,7 @@ "label": "FoundExceptionListItemSchema", "description": [], "signature": [ - "{ data: { _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }[]; page: number; per_page: number; total: number; } & { pit?: string | undefined; }" + "{ data: { _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }[]; page: number; per_page: number; total: number; } & { pit?: string | undefined; }" ], "path": "packages/kbn-securitysolution-io-ts-list-types/src/response/found_exception_list_item_schema/index.ts", "deprecated": false, @@ -2793,7 +2793,7 @@ "label": "FoundListItemSchema", "description": [], "signature": [ - "{ cursor: string; data: { _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; value: string; }[]; page: number; per_page: number; total: number; }" + "{ cursor: string; data: { _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; value: string; }[]; page: number; per_page: number; total: number; }" ], "path": "packages/kbn-securitysolution-io-ts-list-types/src/response/found_list_item_schema/index.ts", "deprecated": false, @@ -2807,7 +2807,7 @@ "label": "FoundListSchema", "description": [], "signature": [ - "{ cursor: string; data: { _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; version: number; }[]; page: number; per_page: number; total: number; }" + "{ cursor: string; data: { _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; }[]; page: number; per_page: number; total: number; }" ], "path": "packages/kbn-securitysolution-io-ts-list-types/src/response/found_list_schema/index.ts", "deprecated": false, @@ -2919,7 +2919,7 @@ "label": "ImportExceptionListItemSchema", "description": [], "signature": [ - "{ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; item_id: string; list_id: string; name: string; type: \"simple\"; } & { id?: string | undefined; comments?: (({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; }) | { comment: string; })[] | undefined; created_at?: string | undefined; updated_at?: string | undefined; created_by?: string | undefined; updated_by?: string | undefined; _version?: string | undefined; tie_breaker_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }" + "{ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; item_id: string; list_id: string; name: string; type: \"simple\"; } & { id?: string | undefined; comments?: (({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; }) | { comment: string; })[] | undefined; created_at?: string | undefined; updated_at?: string | undefined; created_by?: string | undefined; updated_by?: string | undefined; _version?: string | undefined; tie_breaker_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }" ], "path": "packages/kbn-securitysolution-io-ts-list-types/src/request/import_exception_item_schema/index.ts", "deprecated": false, @@ -2933,7 +2933,7 @@ "label": "ImportExceptionListItemSchemaDecoded", "description": [], "signature": [ - "Omit<{ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; item_id: string; list_id: string; name: string; type: \"simple\"; } & { id?: string | undefined; comments?: (({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; }) | { comment: string; })[] | undefined; created_at?: string | undefined; updated_at?: string | undefined; created_by?: string | undefined; updated_by?: string | undefined; _version?: string | undefined; tie_breaker_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }, \"tags\" | \"entries\" | \"comments\" | \"item_id\" | \"namespace_type\"> & { comments: (({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; }) | { comment: string; })[]; tags: string[]; item_id: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; }" + "Omit<{ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; item_id: string; list_id: string; name: string; type: \"simple\"; } & { id?: string | undefined; comments?: (({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; }) | { comment: string; })[] | undefined; created_at?: string | undefined; updated_at?: string | undefined; created_by?: string | undefined; updated_by?: string | undefined; _version?: string | undefined; tie_breaker_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }, \"tags\" | \"entries\" | \"comments\" | \"item_id\" | \"namespace_type\"> & { comments: (({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; }) | { comment: string; })[]; tags: string[]; item_id: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; }" ], "path": "packages/kbn-securitysolution-io-ts-list-types/src/request/import_exception_item_schema/index.ts", "deprecated": false, @@ -2989,7 +2989,7 @@ "label": "ImportListItemQuerySchema", "description": [], "signature": [ - "{ deserializer: string | undefined; list_id: string | undefined; serializer: string | undefined; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\" | undefined; }" + "{ deserializer: string | undefined; list_id: string | undefined; serializer: string | undefined; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\" | undefined; }" ], "path": "packages/kbn-securitysolution-io-ts-list-types/src/request/import_list_item_query_schema/index.ts", "deprecated": false, @@ -3003,7 +3003,7 @@ "label": "ImportListItemQuerySchemaEncoded", "description": [], "signature": [ - "{ deserializer?: string | undefined; list_id?: string | undefined; serializer?: string | undefined; type?: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\" | undefined; }" + "{ deserializer?: string | undefined; list_id?: string | undefined; serializer?: string | undefined; type?: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\" | undefined; }" ], "path": "packages/kbn-securitysolution-io-ts-list-types/src/request/import_list_item_query_schema/index.ts", "deprecated": false, @@ -3115,7 +3115,7 @@ "label": "ListArraySchema", "description": [], "signature": [ - "{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; version: number; }[]" + "{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; }[]" ], "path": "packages/kbn-securitysolution-io-ts-list-types/src/response/list_schema/index.ts", "deprecated": false, @@ -3157,7 +3157,7 @@ "label": "ListItemArraySchema", "description": [], "signature": [ - "{ _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; value: string; }[]" + "{ _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; value: string; }[]" ], "path": "packages/kbn-securitysolution-io-ts-list-types/src/response/list_item_schema/index.ts", "deprecated": false, @@ -3185,7 +3185,7 @@ "label": "ListItemSchema", "description": [], "signature": [ - "{ _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; value: string; }" + "{ _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; value: string; }" ], "path": "packages/kbn-securitysolution-io-ts-list-types/src/response/list_item_schema/index.ts", "deprecated": false, @@ -3213,7 +3213,7 @@ "label": "ListSchema", "description": [], "signature": [ - "{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; version: number; }" + "{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; }" ], "path": "packages/kbn-securitysolution-io-ts-list-types/src/response/list_schema/index.ts", "deprecated": false, @@ -3423,7 +3423,7 @@ "label": "NonEmptyEntriesArray", "description": [], "signature": [ - "({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]" + "({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]" ], "path": "packages/kbn-securitysolution-io-ts-list-types/src/common/non_empty_entries_array/index.ts", "deprecated": false, @@ -3437,7 +3437,7 @@ "label": "NonEmptyEntriesArrayDecoded", "description": [], "signature": [ - "({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]" + "({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]" ], "path": "packages/kbn-securitysolution-io-ts-list-types/src/common/non_empty_entries_array/index.ts", "deprecated": false, @@ -3829,7 +3829,7 @@ "label": "SearchListItemArraySchema", "description": [], "signature": [ - "{ items: { _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; value: string; }[]; value: unknown; }[]" + "{ items: { _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; value: string; }[]; value: unknown; }[]" ], "path": "packages/kbn-securitysolution-io-ts-list-types/src/response/search_list_item_schema/index.ts", "deprecated": false, @@ -3843,7 +3843,7 @@ "label": "SearchListItemSchema", "description": [], "signature": [ - "{ items: { _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; value: string; }[]; value: unknown; }" + "{ items: { _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; value: string; }[]; value: unknown; }" ], "path": "packages/kbn-securitysolution-io-ts-list-types/src/response/search_list_item_schema/index.ts", "deprecated": false, @@ -3983,7 +3983,7 @@ "label": "Type", "description": [], "signature": [ - "\"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"" + "\"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"" ], "path": "packages/kbn-securitysolution-io-ts-list-types/src/common/type/index.ts", "deprecated": false, @@ -3997,7 +3997,7 @@ "label": "TypeOrUndefined", "description": [], "signature": [ - "\"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\" | undefined" + "\"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\" | undefined" ], "path": "packages/kbn-securitysolution-io-ts-list-types/src/common/type/index.ts", "deprecated": false, @@ -4053,7 +4053,7 @@ "label": "UpdateEndpointListItemSchema", "description": [], "signature": [ - "{ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; name: string; type: \"simple\"; } & { _version?: string | undefined; comments?: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id?: string | undefined; item_id?: string | undefined; meta?: object | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }" + "{ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; name: string; type: \"simple\"; } & { _version?: string | undefined; comments?: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id?: string | undefined; item_id?: string | undefined; meta?: object | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }" ], "path": "packages/kbn-securitysolution-io-ts-list-types/src/request/update_endpoint_list_item_schema/index.ts", "deprecated": false, @@ -4067,7 +4067,7 @@ "label": "UpdateEndpointListItemSchemaDecoded", "description": [], "signature": [ - "Omit<{ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; name: string; type: \"simple\"; _version: string | undefined; comments: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id: string | undefined; item_id: string | undefined; meta: object | undefined; os_types: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags: string[] | undefined; }, \"tags\" | \"entries\" | \"comments\"> & { comments: ({ comment: string; } & { id?: string | undefined; })[]; tags: string[]; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; os_types: (\"windows\" | \"linux\" | \"macos\")[]; }" + "Omit<{ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; name: string; type: \"simple\"; _version: string | undefined; comments: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id: string | undefined; item_id: string | undefined; meta: object | undefined; os_types: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags: string[] | undefined; }, \"tags\" | \"entries\" | \"comments\"> & { comments: ({ comment: string; } & { id?: string | undefined; })[]; tags: string[]; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; os_types: (\"windows\" | \"linux\" | \"macos\")[]; }" ], "path": "packages/kbn-securitysolution-io-ts-list-types/src/request/update_endpoint_list_item_schema/index.ts", "deprecated": false, @@ -4081,7 +4081,7 @@ "label": "UpdateExceptionListItemSchema", "description": [], "signature": [ - "{ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; name: string; type: \"simple\"; } & { _version?: string | undefined; comments?: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id?: string | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }" + "{ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; name: string; type: \"simple\"; } & { _version?: string | undefined; comments?: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id?: string | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }" ], "path": "packages/kbn-securitysolution-io-ts-list-types/src/request/update_exception_list_item_schema/index.ts", "deprecated": false, @@ -4095,7 +4095,7 @@ "label": "UpdateExceptionListItemSchemaDecoded", "description": [], "signature": [ - "Omit<{ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; name: string; type: \"simple\"; _version: string | undefined; comments: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id: string | undefined; item_id: string | undefined; meta: object | undefined; namespace_type: \"single\" | \"agnostic\" | undefined; os_types: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags: string[] | undefined; }, \"tags\" | \"entries\" | \"comments\" | \"namespace_type\" | \"os_types\"> & { comments: ({ comment: string; } & { id?: string | undefined; })[]; tags: string[]; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; }" + "Omit<{ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; name: string; type: \"simple\"; _version: string | undefined; comments: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id: string | undefined; item_id: string | undefined; meta: object | undefined; namespace_type: \"single\" | \"agnostic\" | undefined; os_types: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags: string[] | undefined; }, \"tags\" | \"entries\" | \"comments\" | \"namespace_type\" | \"os_types\"> & { comments: ({ comment: string; } & { id?: string | undefined; })[]; tags: string[]; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; }" ], "path": "packages/kbn-securitysolution-io-ts-list-types/src/request/update_exception_list_item_schema/index.ts", "deprecated": false, @@ -4628,7 +4628,7 @@ "StringC", "; entries: ", "Type", - "<({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[], ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[], unknown>; list_id: ", + "<({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[], ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[], unknown>; list_id: ", "Type", "; name: ", "StringC", @@ -6914,7 +6914,7 @@ "StringC", "; entries: ", "Type", - "<({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[], ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[], unknown>; item_id: ", + "<({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[], ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[], unknown>; item_id: ", "Type", "; list_id: ", "Type", @@ -7847,7 +7847,7 @@ ], "signature": [ "Type", - "<({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[], ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[], unknown>" + "<({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[], ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[], unknown>" ], "path": "packages/kbn-securitysolution-io-ts-list-types/src/common/non_empty_entries_array/index.ts", "deprecated": false, @@ -8780,7 +8780,7 @@ "StringC", "; entries: ", "Type", - "<({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[], ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[], unknown>; name: ", + "<({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[], ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[], unknown>; name: ", "StringC", "; type: ", "KeyofC", @@ -8833,7 +8833,7 @@ "StringC", "; entries: ", "Type", - "<({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[], ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[], unknown>; name: ", + "<({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[], ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[], unknown>; name: ", "StringC", "; type: ", "KeyofC", diff --git a/api_docs/kbn_securitysolution_io_ts_list_types.mdx b/api_docs/kbn_securitysolution_io_ts_list_types.mdx index 0b6382bd750fbb..953ee01b628b31 100644 --- a/api_docs/kbn_securitysolution_io_ts_list_types.mdx +++ b/api_docs/kbn_securitysolution_io_ts_list_types.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-io-ts-list-types title: "@kbn/securitysolution-io-ts-list-types" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-io-ts-list-types plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-io-ts-list-types'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_io_ts_types.mdx b/api_docs/kbn_securitysolution_io_ts_types.mdx index 9d26bc5c6130fd..f5db1bde20bd1d 100644 --- a/api_docs/kbn_securitysolution_io_ts_types.mdx +++ b/api_docs/kbn_securitysolution_io_ts_types.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-io-ts-types title: "@kbn/securitysolution-io-ts-types" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-io-ts-types plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-io-ts-types'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_io_ts_utils.mdx b/api_docs/kbn_securitysolution_io_ts_utils.mdx index 29705b6a783620..4a9c7171b7c28f 100644 --- a/api_docs/kbn_securitysolution_io_ts_utils.mdx +++ b/api_docs/kbn_securitysolution_io_ts_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-io-ts-utils title: "@kbn/securitysolution-io-ts-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-io-ts-utils plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-io-ts-utils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_list_api.devdocs.json b/api_docs/kbn_securitysolution_list_api.devdocs.json index 8c92d4257224ab..11cbbb65c3edd2 100644 --- a/api_docs/kbn_securitysolution_list_api.devdocs.json +++ b/api_docs/kbn_securitysolution_list_api.devdocs.json @@ -62,7 +62,7 @@ "signature": [ "({ http, listItem, signal, }: ", "AddExceptionListItemProps", - ") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }>" + ") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }>" ], "path": "packages/kbn-securitysolution-list-api/src/api/index.ts", "deprecated": false, @@ -206,7 +206,7 @@ "signature": [ "({ http, id, namespaceType, signal, }: ", "ApiCallByIdProps", - ") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }>" + ") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }>" ], "path": "packages/kbn-securitysolution-list-api/src/api/index.ts", "deprecated": false, @@ -245,7 +245,7 @@ "section": "def-common.DeleteListParams", "text": "DeleteListParams" }, - ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; version: number; }>" + ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; }>" ], "path": "packages/kbn-securitysolution-list-api/src/list_api/index.ts", "deprecated": false, @@ -399,7 +399,7 @@ "signature": [ "({ http, id, namespaceType, signal, }: ", "ApiCallByIdProps", - ") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }>" + ") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }>" ], "path": "packages/kbn-securitysolution-list-api/src/api/index.ts", "deprecated": false, @@ -432,7 +432,7 @@ "signature": [ "({ filterOptions, http, listIds, namespaceTypes, pagination, signal, }: ", "ApiCallByListIdProps", - ") => Promise<{ data: { _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }[]; page: number; per_page: number; total: number; } & { pit?: string | undefined; }>" + ") => Promise<{ data: { _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }[]; page: number; per_page: number; total: number; } & { pit?: string | undefined; }>" ], "path": "packages/kbn-securitysolution-list-api/src/api/index.ts", "deprecated": false, @@ -504,7 +504,7 @@ "section": "def-common.FindListsParams", "text": "FindListsParams" }, - ") => Promise<{ cursor: string; data: { _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; version: number; }[]; page: number; per_page: number; total: number; }>" + ") => Promise<{ cursor: string; data: { _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; }[]; page: number; per_page: number; total: number; }>" ], "path": "packages/kbn-securitysolution-list-api/src/list_api/index.ts", "deprecated": false, @@ -549,7 +549,7 @@ "section": "def-common.ImportListParams", "text": "ImportListParams" }, - ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; version: number; }>" + ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; }>" ], "path": "packages/kbn-securitysolution-list-api/src/list_api/index.ts", "deprecated": false, @@ -743,7 +743,7 @@ "signature": [ "({ http, listItem, signal, }: ", "UpdateExceptionListItemProps", - ") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }>" + ") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }>" ], "path": "packages/kbn-securitysolution-list-api/src/api/index.ts", "deprecated": false, @@ -1076,7 +1076,7 @@ "label": "type", "description": [], "signature": [ - "\"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\" | undefined" + "\"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\" | undefined" ], "path": "packages/kbn-securitysolution-list-api/src/list_api/types.ts", "deprecated": false diff --git a/api_docs/kbn_securitysolution_list_api.mdx b/api_docs/kbn_securitysolution_list_api.mdx index cba2d200c80cb5..feb98d20289dde 100644 --- a/api_docs/kbn_securitysolution_list_api.mdx +++ b/api_docs/kbn_securitysolution_list_api.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-list-api title: "@kbn/securitysolution-list-api" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-list-api plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-list-api'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_list_constants.mdx b/api_docs/kbn_securitysolution_list_constants.mdx index eb0fdf30dc31e5..085b81fe628c11 100644 --- a/api_docs/kbn_securitysolution_list_constants.mdx +++ b/api_docs/kbn_securitysolution_list_constants.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-list-constants title: "@kbn/securitysolution-list-constants" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-list-constants plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-list-constants'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_list_hooks.devdocs.json b/api_docs/kbn_securitysolution_list_hooks.devdocs.json index 48a866f37b9f3a..22422020888040 100644 --- a/api_docs/kbn_securitysolution_list_hooks.devdocs.json +++ b/api_docs/kbn_securitysolution_list_hooks.devdocs.json @@ -29,7 +29,7 @@ "\nThis adds an id to the incoming exception item entries as ReactJS prefers to have\nan id added to them for use as a stable id. Later if we decide to change the data\nmodel to have id's within the array then this code should be removed. If not, then\nthis code should stay as an adapter for ReactJS.\n\nThis does break the type system slightly as we are lying a bit to the type system as we return\nthe same exceptionItem as we have previously but are augmenting the arrays with an id which TypeScript\ndoesn't mind us doing here. However, downstream you will notice that you have an id when the type\ndoes not indicate it. In that case use (ExceptionItem & { id: string }) temporarily if you're using the id. If you're not,\nyou can ignore the id and just use the normal TypeScript with ReactJS.\n" ], "signature": [ - "(exceptionItem: { _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }) => { _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }" + "(exceptionItem: { _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }) => { _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }" ], "path": "packages/kbn-securitysolution-list-hooks/src/transforms/index.ts", "deprecated": false, @@ -44,7 +44,7 @@ "The exceptionItem to add an id to the threat matches." ], "signature": [ - "{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }" + "{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }" ], "path": "packages/kbn-securitysolution-list-hooks/src/transforms/index.ts", "deprecated": false, @@ -66,7 +66,7 @@ "\nThis removes an id from the exceptionItem entries as ReactJS prefers to have\nan id added to them for use as a stable id. Later if we decide to change the data\nmodel to have id's within the array then this code should be removed. If not, then\nthis code should stay as an adapter for ReactJS.\n" ], "signature": [ - "(exceptionItem: T) => T" + "(exceptionItem: T) => T" ], "path": "packages/kbn-securitysolution-list-hooks/src/transforms/index.ts", "deprecated": false, @@ -103,7 +103,7 @@ "\nTransforms the output of rules to compensate for technical debt or UI concerns such as\nReactJS preferences for having ids within arrays if the data is not modeled that way.\n\nIf you add a new transform of the input called \"myNewTransform\" do it\nin the form of:\nflow(addIdToExceptionItemEntries, myNewTransform)(exceptionItem)\n" ], "signature": [ - "(exceptionItem: { _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }) => { _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }" + "(exceptionItem: { _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }) => { _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }" ], "path": "packages/kbn-securitysolution-list-hooks/src/transforms/index.ts", "deprecated": false, @@ -118,7 +118,7 @@ "The exceptionItem to transform the output of" ], "signature": [ - "{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }" + "{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }" ], "path": "packages/kbn-securitysolution-list-hooks/src/transforms/index.ts", "deprecated": false, @@ -138,7 +138,7 @@ "label": "transformNewItemOutput", "description": [], "signature": [ - "(exceptionItem: { description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; })[]; list_id: string; name: string; type: \"simple\"; } & { comments?: { comment: string; }[] | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }) => { description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; })[]; list_id: string; name: string; type: \"simple\"; } & { comments?: { comment: string; }[] | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }" + "(exceptionItem: { description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; })[]; list_id: string; name: string; type: \"simple\"; } & { comments?: { comment: string; }[] | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }) => { description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; })[]; list_id: string; name: string; type: \"simple\"; } & { comments?: { comment: string; }[] | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }" ], "path": "packages/kbn-securitysolution-list-hooks/src/transforms/index.ts", "deprecated": false, @@ -151,7 +151,7 @@ "label": "exceptionItem", "description": [], "signature": [ - "{ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; })[]; list_id: string; name: string; type: \"simple\"; } & { comments?: { comment: string; }[] | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }" + "{ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; })[]; list_id: string; name: string; type: \"simple\"; } & { comments?: { comment: string; }[] | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }" ], "path": "packages/kbn-securitysolution-list-hooks/src/transforms/index.ts", "deprecated": false, @@ -171,7 +171,7 @@ "\nTransforms the output of exception items to compensate for technical debt or UI concerns such as\nReactJS preferences for having ids within arrays if the data is not modeled that way.\n\nIf you add a new transform of the output called \"myNewTransform\" do it\nin the form of:\nflow(removeIdFromExceptionItemsEntries, myNewTransform)(exceptionItem)\n" ], "signature": [ - "(exceptionItem: { _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; } | ({ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; })[]; name: string; type: \"simple\"; } & { _version?: string | undefined; comments?: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id?: string | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; })) => { _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; } | ({ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; })[]; name: string; type: \"simple\"; } & { _version?: string | undefined; comments?: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id?: string | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; })" + "(exceptionItem: { _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; } | ({ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; })[]; name: string; type: \"simple\"; } & { _version?: string | undefined; comments?: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id?: string | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; })) => { _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; } | ({ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; })[]; name: string; type: \"simple\"; } & { _version?: string | undefined; comments?: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id?: string | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; })" ], "path": "packages/kbn-securitysolution-list-hooks/src/transforms/index.ts", "deprecated": false, @@ -186,7 +186,7 @@ "The exceptionItem to transform the output of" ], "signature": [ - "{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; } | ({ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; })[]; name: string; type: \"simple\"; } & { _version?: string | undefined; comments?: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id?: string | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; })" + "{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; } | ({ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; })[]; name: string; type: \"simple\"; } & { _version?: string | undefined; comments?: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id?: string | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; })" ], "path": "packages/kbn-securitysolution-list-hooks/src/transforms/index.ts", "deprecated": false, @@ -317,7 +317,7 @@ "OptionalSignalArgs", "<", "DeleteListParams", - ">], { _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; version: number; }>" + ">], { _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; }>" ], "path": "packages/kbn-securitysolution-list-hooks/src/use_delete_list/index.ts", "deprecated": false, @@ -445,7 +445,7 @@ "OptionalSignalArgs", "<", "FindListsParams", - ">], { cursor: string; data: { _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; version: number; }[]; page: number; per_page: number; total: number; }>" + ">], { cursor: string; data: { _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; }[]; page: number; per_page: number; total: number; }>" ], "path": "packages/kbn-securitysolution-list-hooks/src/use_find_lists/index.ts", "deprecated": false, @@ -467,7 +467,7 @@ "OptionalSignalArgs", "<", "ImportListParams", - ">], { _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; version: number; }>" + ">], { _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; }>" ], "path": "packages/kbn-securitysolution-list-hooks/src/use_import_list/index.ts", "deprecated": false, @@ -623,7 +623,7 @@ "label": "addExceptionListItem", "description": [], "signature": [ - "(arg: { listItem: { description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; })[]; list_id: string; name: string; type: \"simple\"; } & { comments?: { comment: string; }[] | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }; }) => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }>" + "(arg: { listItem: { description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; })[]; list_id: string; name: string; type: \"simple\"; } & { comments?: { comment: string; }[] | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }; }) => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }>" ], "path": "packages/kbn-securitysolution-list-hooks/src/use_api/index.ts", "deprecated": false, @@ -646,7 +646,7 @@ "label": "listItem", "description": [], "signature": [ - "{ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; })[]; list_id: string; name: string; type: \"simple\"; } & { comments?: { comment: string; }[] | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }" + "{ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; })[]; list_id: string; name: string; type: \"simple\"; } & { comments?: { comment: string; }[] | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }" ], "path": "packages/kbn-securitysolution-list-hooks/src/use_api/index.ts", "deprecated": false @@ -664,7 +664,7 @@ "label": "updateExceptionListItem", "description": [], "signature": [ - "(arg: { listItem: { description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; })[]; name: string; type: \"simple\"; } & { _version?: string | undefined; comments?: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id?: string | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }; }) => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }>" + "(arg: { listItem: { description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; })[]; name: string; type: \"simple\"; } & { _version?: string | undefined; comments?: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id?: string | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }; }) => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }>" ], "path": "packages/kbn-securitysolution-list-hooks/src/use_api/index.ts", "deprecated": false, @@ -687,7 +687,7 @@ "label": "listItem", "description": [], "signature": [ - "{ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; })[]; name: string; type: \"simple\"; } & { _version?: string | undefined; comments?: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id?: string | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }" + "{ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; })[]; name: string; type: \"simple\"; } & { _version?: string | undefined; comments?: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id?: string | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }" ], "path": "packages/kbn-securitysolution-list-hooks/src/use_api/index.ts", "deprecated": false @@ -771,7 +771,7 @@ "signature": [ "(arg: ", "ApiCallMemoProps", - " & { onSuccess: (arg: { _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }) => void; }) => Promise" + " & { onSuccess: (arg: { _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }) => void; }) => Promise" ], "path": "packages/kbn-securitysolution-list-hooks/src/use_api/index.ts", "deprecated": false, @@ -785,7 +785,7 @@ "description": [], "signature": [ "ApiCallMemoProps", - " & { onSuccess: (arg: { _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }) => void; }" + " & { onSuccess: (arg: { _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }) => void; }" ], "path": "packages/kbn-securitysolution-list-hooks/src/use_api/index.ts", "deprecated": false, @@ -954,7 +954,7 @@ "label": "ReturnExceptionListAndItems", "description": [], "signature": [ - "[boolean, { _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }[], ", + "[boolean, { _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }[], ", "Pagination", ", Func | null]" ], @@ -996,7 +996,7 @@ "label": "ReturnPersistExceptionItem", "description": [], "signature": [ - "[PersistReturnExceptionItem, React.Dispatch<({ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; })[]; list_id: string; name: string; type: \"simple\"; } & { comments?: { comment: string; }[] | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }) | ({ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; })[]; name: string; type: \"simple\"; } & { _version?: string | undefined; comments?: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id?: string | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }) | null>]" + "[PersistReturnExceptionItem, React.Dispatch<({ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; })[]; list_id: string; name: string; type: \"simple\"; } & { comments?: { comment: string; }[] | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }) | ({ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; })[]; name: string; type: \"simple\"; } & { _version?: string | undefined; comments?: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id?: string | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }) | null>]" ], "path": "packages/kbn-securitysolution-list-hooks/src/use_persist_exception_item/index.ts", "deprecated": false, diff --git a/api_docs/kbn_securitysolution_list_hooks.mdx b/api_docs/kbn_securitysolution_list_hooks.mdx index e16588825974a0..755451919a6083 100644 --- a/api_docs/kbn_securitysolution_list_hooks.mdx +++ b/api_docs/kbn_securitysolution_list_hooks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-list-hooks title: "@kbn/securitysolution-list-hooks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-list-hooks plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-list-hooks'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_list_utils.devdocs.json b/api_docs/kbn_securitysolution_list_utils.devdocs.json index 89f36219cbe6b6..cacc895fdce60e 100644 --- a/api_docs/kbn_securitysolution_list_utils.devdocs.json +++ b/api_docs/kbn_securitysolution_list_utils.devdocs.json @@ -27,7 +27,7 @@ "label": "addIdToEntries", "description": [], "signature": [ - "(entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]) => ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]" + "(entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]) => ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]" ], "path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts", "deprecated": false, @@ -40,7 +40,7 @@ "label": "entries", "description": [], "signature": [ - "({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]" + "({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]" ], "path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts", "deprecated": false, @@ -58,7 +58,7 @@ "label": "buildExceptionFilter", "description": [], "signature": [ - "({ lists, excludeExceptions, chunkSize, alias, }: { lists: ({ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; } | ({ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; })[]; list_id: string; name: string; type: \"simple\"; } & { comments?: { comment: string; }[] | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }))[]; excludeExceptions: boolean; chunkSize: number; alias: string | null; }) => ", + "({ lists, excludeExceptions, chunkSize, alias, }: { lists: ({ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; } | ({ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; })[]; list_id: string; name: string; type: \"simple\"; } & { comments?: { comment: string; }[] | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }))[]; excludeExceptions: boolean; chunkSize: number; alias: string | null; }) => ", "Filter", " | undefined" ], @@ -83,7 +83,7 @@ "label": "lists", "description": [], "signature": [ - "({ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; } | ({ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; })[]; list_id: string; name: string; type: \"simple\"; } & { comments?: { comment: string; }[] | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }))[]" + "({ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; } | ({ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; })[]; list_id: string; name: string; type: \"simple\"; } & { comments?: { comment: string; }[] | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }))[]" ], "path": "packages/kbn-securitysolution-list-utils/src/build_exception_filter/index.ts", "deprecated": false @@ -703,7 +703,7 @@ "section": "def-common.ExceptionsBuilderExceptionItem", "text": "ExceptionsBuilderExceptionItem" }, - "[]) => ({ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; } | ({ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; })[]; list_id: string; name: string; type: \"simple\"; } & { comments?: { comment: string; }[] | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }))[]" + "[]) => ({ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; } | ({ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; })[]; list_id: string; name: string; type: \"simple\"; } & { comments?: { comment: string; }[] | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }))[]" ], "path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts", "deprecated": false, @@ -957,7 +957,7 @@ "section": "def-common.FormattedBuilderEntry", "text": "FormattedBuilderEntry" }, - ") => ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; }) & { id?: string | undefined; }" + ") => ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; }) & { id?: string | undefined; }" ], "path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts", "deprecated": false, @@ -1099,7 +1099,7 @@ "section": "def-common.FormattedBuilderEntry", "text": "FormattedBuilderEntry" }, - ", newField: { _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; version: number; }) => { index: number; updatedEntry: ", + ", newField: { _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; }) => { index: number; updatedEntry: ", { "pluginId": "@kbn/securitysolution-list-utils", "scope": "common", @@ -1144,7 +1144,7 @@ "- newly selected list" ], "signature": [ - "{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; version: number; }" + "{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; }" ], "path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts", "deprecated": false, @@ -2529,7 +2529,7 @@ "label": "hasLargeValueList", "description": [], "signature": [ - "(entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]) => boolean" + "(entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]) => boolean" ], "path": "packages/kbn-securitysolution-list-utils/src/has_large_value_list/index.ts", "deprecated": false, @@ -2542,7 +2542,7 @@ "label": "entries", "description": [], "signature": [ - "({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]" + "({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]" ], "path": "packages/kbn-securitysolution-list-utils/src/has_large_value_list/index.ts", "deprecated": false, @@ -3170,7 +3170,7 @@ "label": "BuilderEntry", "description": [], "signature": [ - "(({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; }) & { id?: string | undefined; }) | ", + "(({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; }) & { id?: string | undefined; }) | ", { "pluginId": "@kbn/securitysolution-list-utils", "scope": "common", @@ -3229,7 +3229,7 @@ "label": "CreateExceptionListItemBuilderSchema", "description": [], "signature": [ - "Omit<{ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; })[]; list_id: string; name: string; type: \"simple\"; } & { comments?: { comment: string; }[] | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }, \"meta\" | \"entries\"> & { meta: { temporaryUuid: string; }; entries: ", + "Omit<{ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; })[]; list_id: string; name: string; type: \"simple\"; } & { comments?: { comment: string; }[] | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }, \"meta\" | \"entries\"> & { meta: { temporaryUuid: string; }; entries: ", { "pluginId": "@kbn/securitysolution-list-utils", "scope": "common", @@ -3363,7 +3363,7 @@ "label": "ExceptionListItemBuilderSchema", "description": [], "signature": [ - "Omit<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }, \"entries\"> & { entries: ", + "Omit<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }, \"entries\"> & { entries: ", { "pluginId": "@kbn/securitysolution-list-utils", "scope": "common", diff --git a/api_docs/kbn_securitysolution_list_utils.mdx b/api_docs/kbn_securitysolution_list_utils.mdx index fc6896d6164f12..f102b8583df344 100644 --- a/api_docs/kbn_securitysolution_list_utils.mdx +++ b/api_docs/kbn_securitysolution_list_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-list-utils title: "@kbn/securitysolution-list-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-list-utils plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-list-utils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_rules.mdx b/api_docs/kbn_securitysolution_rules.mdx index 5898c59fde6118..dfeff6aae63bc6 100644 --- a/api_docs/kbn_securitysolution_rules.mdx +++ b/api_docs/kbn_securitysolution_rules.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-rules title: "@kbn/securitysolution-rules" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-rules plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-rules'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_t_grid.mdx b/api_docs/kbn_securitysolution_t_grid.mdx index 3657d94564bb0f..9b80f234d0f264 100644 --- a/api_docs/kbn_securitysolution_t_grid.mdx +++ b/api_docs/kbn_securitysolution_t_grid.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-t-grid title: "@kbn/securitysolution-t-grid" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-t-grid plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-t-grid'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_utils.mdx b/api_docs/kbn_securitysolution_utils.mdx index 358b967e0e1abd..40f473bd382112 100644 --- a/api_docs/kbn_securitysolution_utils.mdx +++ b/api_docs/kbn_securitysolution_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-utils title: "@kbn/securitysolution-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-utils plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-utils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_server_http_tools.mdx b/api_docs/kbn_server_http_tools.mdx index 435a1791cc7fda..51364e7b47f236 100644 --- a/api_docs/kbn_server_http_tools.mdx +++ b/api_docs/kbn_server_http_tools.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-server-http-tools title: "@kbn/server-http-tools" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/server-http-tools plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/server-http-tools'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_server_route_repository.mdx b/api_docs/kbn_server_route_repository.mdx index c054b944bd3e63..b64bcf94500ce8 100644 --- a/api_docs/kbn_server_route_repository.mdx +++ b/api_docs/kbn_server_route_repository.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-server-route-repository title: "@kbn/server-route-repository" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/server-route-repository plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/server-route-repository'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_shared_ux_button_exit_full_screen.devdocs.json b/api_docs/kbn_shared_ux_button_exit_full_screen.devdocs.json deleted file mode 100644 index bec75a657ccc1d..00000000000000 --- a/api_docs/kbn_shared_ux_button_exit_full_screen.devdocs.json +++ /dev/null @@ -1,242 +0,0 @@ -{ - "id": "@kbn/shared-ux-button-exit-full-screen", - "client": { - "classes": [], - "functions": [], - "interfaces": [], - "enums": [], - "misc": [], - "objects": [] - }, - "server": { - "classes": [], - "functions": [], - "interfaces": [], - "enums": [], - "misc": [], - "objects": [] - }, - "common": { - "classes": [], - "functions": [ - { - "parentPluginId": "@kbn/shared-ux-button-exit-full-screen", - "id": "def-common.ExitFullScreenButton", - "type": "Function", - "tags": [], - "label": "ExitFullScreenButton", - "description": [ - "\nA component that can be used to exit full screen mode in Kibana. Requires a Provider for\nrelevant services." - ], - "signature": [ - "React.ForwardRefExoticComponent<", - "Props", - " & React.RefAttributes<{}>>" - ], - "path": "packages/shared-ux/button/exit_full_screen/src/index.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "@kbn/shared-ux-button-exit-full-screen", - "id": "def-common.ExitFullScreenButton.$1", - "type": "Uncategorized", - "tags": [], - "label": "props", - "description": [], - "signature": [ - "P" - ], - "path": "node_modules/@types/react/index.d.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/shared-ux-button-exit-full-screen", - "id": "def-common.ExitFullScreenButtonComponent", - "type": "Function", - "tags": [], - "label": "ExitFullScreenButtonComponent", - "description": [ - "\nA pure component that resembles a button to exit full screen mode." - ], - "signature": [ - "React.ForwardRefExoticComponent<", - "Props", - " & React.RefAttributes<{}>>" - ], - "path": "packages/shared-ux/button/exit_full_screen/src/index.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "@kbn/shared-ux-button-exit-full-screen", - "id": "def-common.ExitFullScreenButtonComponent.$1", - "type": "Uncategorized", - "tags": [], - "label": "props", - "description": [], - "signature": [ - "P" - ], - "path": "node_modules/@types/react/index.d.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/shared-ux-button-exit-full-screen", - "id": "def-common.ExitFullScreenButtonKibanaProvider", - "type": "Function", - "tags": [], - "label": "ExitFullScreenButtonKibanaProvider", - "description": [ - "\nKibana-specific Provider that maps to known dependency types." - ], - "signature": [ - "({ children, ...services }: React.PropsWithChildren<", - "KibanaServices", - ">) => JSX.Element" - ], - "path": "packages/shared-ux/button/exit_full_screen/src/services.tsx", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/shared-ux-button-exit-full-screen", - "id": "def-common.ExitFullScreenButtonKibanaProvider.$1", - "type": "CompoundType", - "tags": [], - "label": "{\n children,\n ...services\n}", - "description": [], - "signature": [ - "React.PropsWithChildren<", - "KibanaServices", - ">" - ], - "path": "packages/shared-ux/button/exit_full_screen/src/services.tsx", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/shared-ux-button-exit-full-screen", - "id": "def-common.ExitFullScreenButtonProvider", - "type": "Function", - "tags": [], - "label": "ExitFullScreenButtonProvider", - "description": [ - "\nAbstract external service Provider." - ], - "signature": [ - "({ children, ...services }: React.PropsWithChildren<", - "Services", - ">) => JSX.Element" - ], - "path": "packages/shared-ux/button/exit_full_screen/src/services.tsx", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/shared-ux-button-exit-full-screen", - "id": "def-common.ExitFullScreenButtonProvider.$1", - "type": "CompoundType", - "tags": [], - "label": "{ children, ...services }", - "description": [], - "signature": [ - "React.PropsWithChildren<", - "Services", - ">" - ], - "path": "packages/shared-ux/button/exit_full_screen/src/services.tsx", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/shared-ux-button-exit-full-screen", - "id": "def-common.LazyExitFullScreenButton", - "type": "Function", - "tags": [], - "label": "LazyExitFullScreenButton", - "description": [ - "\nLazy-loaded connected component. Must be wrapped in `React.Suspense` and a Provider." - ], - "signature": [ - "React.ExoticComponent<", - "Props", - "> & { readonly _result: ({ onExit, toggleChrome }: ", - "Props", - ") => JSX.Element; }" - ], - "path": "packages/shared-ux/button/exit_full_screen/src/index.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "@kbn/shared-ux-button-exit-full-screen", - "id": "def-common.LazyExitFullScreenButton.$1", - "type": "Uncategorized", - "tags": [], - "label": "props", - "description": [], - "signature": [ - "P" - ], - "path": "node_modules/@types/react/index.d.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/shared-ux-button-exit-full-screen", - "id": "def-common.LazyExitFullScreenButtonComponent", - "type": "Function", - "tags": [], - "label": "LazyExitFullScreenButtonComponent", - "description": [ - "\nLazy-loaded pure component. Must be wrapped in `React.Suspense`." - ], - "signature": [ - "React.ExoticComponent<", - "Props", - "> & { readonly _result: ({ onClick, className }: ", - "Props", - ") => JSX.Element; }" - ], - "path": "packages/shared-ux/button/exit_full_screen/src/index.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "@kbn/shared-ux-button-exit-full-screen", - "id": "def-common.LazyExitFullScreenButtonComponent.$1", - "type": "Uncategorized", - "tags": [], - "label": "props", - "description": [], - "signature": [ - "P" - ], - "path": "node_modules/@types/react/index.d.ts", - "deprecated": false - } - ], - "initialIsOpen": false - } - ], - "interfaces": [], - "enums": [], - "misc": [], - "objects": [] - } -} \ No newline at end of file diff --git a/api_docs/kbn_shared_ux_button_exit_full_screen.mdx b/api_docs/kbn_shared_ux_button_exit_full_screen.mdx deleted file mode 100644 index 1418f076fa3742..00000000000000 --- a/api_docs/kbn_shared_ux_button_exit_full_screen.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -id: kibKbnSharedUxButtonExitFullScreenPluginApi -slug: /kibana-dev-docs/api/kbn-shared-ux-button-exit-full-screen -title: "@kbn/shared-ux-button-exit-full-screen" -image: https://source.unsplash.com/400x175/?github -summary: API docs for the @kbn/shared-ux-button-exit-full-screen plugin -date: 2022-05-24 -tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-button-exit-full-screen'] -warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. ---- -import kbnSharedUxButtonExitFullScreenObj from './kbn_shared_ux_button_exit_full_screen.devdocs.json'; - - - -Contact [Owner missing] for questions regarding this plugin. - -**Code health stats** - -| Public API count | Any count | Items lacking comments | Missing exports | -|-------------------|-----------|------------------------|-----------------| -| 12 | 0 | 2 | 3 | - -## Common - -### Functions - - diff --git a/api_docs/kbn_shared_ux_components.devdocs.json b/api_docs/kbn_shared_ux_components.devdocs.json index dacb43793ba265..ddf58d1babc8ef 100644 --- a/api_docs/kbn_shared_ux_components.devdocs.json +++ b/api_docs/kbn_shared_ux_components.devdocs.json @@ -58,32 +58,31 @@ "type": "Function", "tags": [], "label": "IconButtonGroup", - "description": [ - "\nThe IconButtonGroup component that is wrapped by the `withSuspence` HOC." - ], + "description": [], "signature": [ - "React.ForwardRefExoticComponent<", + "({ buttons, legend }: ", "Props", - " & React.RefAttributes<{}>>" + ") => JSX.Element" ], - "path": "packages/kbn-shared-ux-components/src/index.ts", + "path": "packages/kbn-shared-ux-components/src/toolbar/buttons/icon_button_group/icon_button_group.tsx", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "@kbn/shared-ux-components", "id": "def-common.IconButtonGroup.$1", - "type": "Uncategorized", + "type": "Object", "tags": [], - "label": "props", + "label": "{ buttons, legend }", "description": [], "signature": [ - "P" + "Props" ], - "path": "node_modules/@types/react/index.d.ts", - "deprecated": false + "path": "packages/kbn-shared-ux-components/src/toolbar/buttons/icon_button_group/icon_button_group.tsx", + "deprecated": false, + "isRequired": true } ], + "returnComment": [], "initialIsOpen": false }, { @@ -162,83 +161,9 @@ "type": "Function", "tags": [], "label": "KibanaPageTemplate", - "description": [ - "\nA `KibanaPageTemplate` component that is wrapped by the `withSuspense` HOC. This component can\nbe used directly by consumers and will load the `KibanaPageTemplateLazy` component lazily with\na predefined fallback and error boundary." - ], - "signature": [ - "React.ForwardRefExoticComponent & { template?: \"default\" | \"empty\" | \"centeredBody\" | \"centeredContent\" | undefined; paddingSize?: \"none\" | \"m\" | \"s\" | \"l\" | undefined; pageSideBar?: React.ReactNode; pageSideBarProps?: ", - "EuiPageSideBarProps", - " | undefined; pageHeader?: ", - "EuiPageHeaderProps", - " | undefined; pageBodyProps?: ", - "EuiPageBodyProps", - "<\"main\"> | undefined; pageContentProps?: ", - "EuiPageContentProps", - " | undefined; pageContentBodyProps?: ", - "EuiPageContentBodyProps", - " | undefined; bottomBar?: React.ReactNode; bottomBarProps?: ", - "EuiBottomBarProps", - " | undefined; fullHeight?: boolean | \"noscroll\" | undefined; minHeight?: ", - "Property", - ".MinHeight | undefined; } & { isEmptyState?: boolean | undefined; solutionNav?: ", - "KibanaPageTemplateSolutionNavProps", - " | undefined; noDataConfig?: ", - "NoDataPageProps", - " | undefined; } & React.RefAttributes<{}>>" - ], - "path": "packages/kbn-shared-ux-components/src/index.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "@kbn/shared-ux-components", - "id": "def-common.KibanaPageTemplate.$1", - "type": "Uncategorized", - "tags": [], - "label": "props", - "description": [], - "signature": [ - "P" - ], - "path": "node_modules/@types/react/index.d.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/shared-ux-components", - "id": "def-common.KibanaPageTemplateLazy", - "type": "Function", - "tags": [], - "label": "KibanaPageTemplateLazy", - "description": [ - "\nThe lazily loaded `KibanaPageTemplate` component that is wrapped by the `withSuspense` HOC. Consumers should use\n`React.Suspense` or `withSuspense` HOC to load this component." - ], + "description": [], "signature": [ - "React.ExoticComponent & { template?: \"default\" | \"empty\" | \"centeredBody\" | \"centeredContent\" | undefined; paddingSize?: \"none\" | \"m\" | \"s\" | \"l\" | undefined; pageSideBar?: React.ReactNode; pageSideBarProps?: ", - "EuiPageSideBarProps", - " | undefined; pageHeader?: ", - "EuiPageHeaderProps", - " | undefined; pageBodyProps?: ", - "EuiPageBodyProps", - "<\"main\"> | undefined; pageContentProps?: ", - "EuiPageContentProps", - " | undefined; pageContentBodyProps?: ", - "EuiPageContentBodyProps", - " | undefined; bottomBar?: React.ReactNode; bottomBarProps?: ", - "EuiBottomBarProps", - " | undefined; fullHeight?: boolean | \"noscroll\" | undefined; minHeight?: ", - "Property", - ".MinHeight | undefined; } & { isEmptyState?: boolean | undefined; solutionNav?: ", - "KibanaPageTemplateSolutionNavProps", - " | undefined; noDataConfig?: ", - "NoDataPageProps", - " | undefined; } & { children?: React.ReactNode; }> & { readonly _result: React.FunctionComponent<", + "({ template, className, children, solutionNav, noDataConfig, ...rest }: React.PropsWithChildren<", { "pluginId": "@kbn/shared-ux-components", "scope": "common", @@ -246,136 +171,72 @@ "section": "def-common.KibanaPageTemplateProps", "text": "KibanaPageTemplateProps" }, - ">; }" + ">) => JSX.Element" ], - "path": "packages/kbn-shared-ux-components/src/index.ts", + "path": "packages/kbn-shared-ux-components/src/page_template/page_template.tsx", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "@kbn/shared-ux-components", - "id": "def-common.KibanaPageTemplateLazy.$1", - "type": "Uncategorized", + "id": "def-common.KibanaPageTemplate.$1", + "type": "CompoundType", "tags": [], - "label": "props", + "label": "{\n template,\n className,\n children,\n solutionNav,\n noDataConfig,\n ...rest\n}", "description": [], "signature": [ - "P" + "React.PropsWithChildren<", + { + "pluginId": "@kbn/shared-ux-components", + "scope": "common", + "docId": "kibKbnSharedUxComponentsPluginApi", + "section": "def-common.KibanaPageTemplateProps", + "text": "KibanaPageTemplateProps" + }, + ">" ], - "path": "node_modules/@types/react/index.d.ts", - "deprecated": false + "path": "packages/kbn-shared-ux-components/src/page_template/page_template.tsx", + "deprecated": false, + "isRequired": true } ], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/shared-ux-components", - "id": "def-common.KibanaPageTemplateSolutionNavLazy", - "type": "Function", - "tags": [], - "label": "KibanaPageTemplateSolutionNavLazy", - "description": [ - "\nThe lazily loaded `KibanaPageTemplateSolutionNav` component that is wrapped by the `withSuspense` HOC. Consumers should use\n`React.Suspense` or `withSuspense` HOC to load this component." - ], - "signature": [ - "React.ExoticComponent, \"children\" | \"heading\" | \"items\"> & { name: string; icon?: ", - "IconType", - " | undefined; items?: ", - "EuiSideNavItemType", - "<{}>[] | undefined; children?: React.ReactNode; closeFlyoutButtonPosition?: \"outside\" | \"inside\" | undefined; isOpenOnDesktop?: boolean | undefined; onCollapse?: (() => void) | undefined; } & { children?: React.ReactNode; }> & { readonly _result: React.FunctionComponent<", - "KibanaPageTemplateSolutionNavProps", - ">; }" - ], - "path": "packages/kbn-shared-ux-components/src/index.ts", - "deprecated": false, "returnComment": [], - "children": [ - { - "parentPluginId": "@kbn/shared-ux-components", - "id": "def-common.KibanaPageTemplateSolutionNavLazy.$1", - "type": "Uncategorized", - "tags": [], - "label": "props", - "description": [], - "signature": [ - "P" - ], - "path": "node_modules/@types/react/index.d.ts", - "deprecated": false - } - ], "initialIsOpen": false }, { "parentPluginId": "@kbn/shared-ux-components", - "id": "def-common.LazyIconButtonGroup", + "id": "def-common.KibanaPageTemplateSolutionNav", "type": "Function", "tags": [], - "label": "LazyIconButtonGroup", + "label": "KibanaPageTemplateSolutionNav", "description": [ - "\nThe Lazily-loaded `IconButtonGroup` component. Consumers should use `React.Suspense` or the\n`withSuspense` HOC to load this component." + "\nA wrapper around EuiSideNav but also creates the appropriate title with optional solution logo" ], "signature": [ - "React.ExoticComponent<", - "Props", - "> & { readonly _result: ({ buttons, legend }: ", - "Props", - ") => JSX.Element; }" + "({ children, headingProps, icon, isOpenOnDesktop, items, mobileBreakpoints, closeFlyoutButtonPosition, name, onCollapse, ...rest }: React.PropsWithChildren<", + "KibanaPageTemplateSolutionNavProps", + ">) => JSX.Element" ], - "path": "packages/kbn-shared-ux-components/src/index.ts", + "path": "packages/kbn-shared-ux-components/src/page_template/solution_nav/solution_nav.tsx", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "@kbn/shared-ux-components", - "id": "def-common.LazyIconButtonGroup.$1", - "type": "Uncategorized", + "id": "def-common.KibanaPageTemplateSolutionNav.$1", + "type": "CompoundType", "tags": [], - "label": "props", + "label": "{\n children,\n headingProps,\n icon,\n isOpenOnDesktop = false,\n items,\n mobileBreakpoints = ['xs', 's'],\n closeFlyoutButtonPosition = 'outside',\n name,\n onCollapse,\n ...rest\n}", "description": [], "signature": [ - "P" + "React.PropsWithChildren<", + "KibanaPageTemplateSolutionNavProps", + ">" ], - "path": "node_modules/@types/react/index.d.ts", - "deprecated": false + "path": "packages/kbn-shared-ux-components/src/page_template/solution_nav/solution_nav.tsx", + "deprecated": false, + "isRequired": true } ], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/shared-ux-components", - "id": "def-common.LazyToolbarButton", - "type": "Function", - "tags": [], - "label": "LazyToolbarButton", - "description": [], - "signature": [ - "React.ExoticComponent<", - "Props", - "> & { readonly _result: ({ label, iconSide, ...rest }: ", - "Props", - ") => JSX.Element; }" - ], - "path": "packages/kbn-shared-ux-components/src/index.ts", - "deprecated": false, "returnComment": [], - "children": [ - { - "parentPluginId": "@kbn/shared-ux-components", - "id": "def-common.LazyToolbarButton.$1", - "type": "Uncategorized", - "tags": [], - "label": "props", - "description": [], - "signature": [ - "P" - ], - "path": "node_modules/@types/react/index.d.ts", - "deprecated": false - } - ], "initialIsOpen": false }, { @@ -384,32 +245,31 @@ "type": "Function", "tags": [], "label": "ToolbarButton", - "description": [ - "\nA `ToolbarButton` component that is wrapped by the `withSuspense` HOC. This component can\nbe used directly by consumers and will load the `LazyToolbarButton` component lazily with\na predefined fallback and error boundary." - ], + "description": [], "signature": [ - "React.ForwardRefExoticComponent<", + "({ label, iconSide, ...rest }: ", "Props", - " & React.RefAttributes<{}>>" + ") => JSX.Element" ], - "path": "packages/kbn-shared-ux-components/src/index.ts", + "path": "packages/kbn-shared-ux-components/src/toolbar/buttons/primary/primary.tsx", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "@kbn/shared-ux-components", "id": "def-common.ToolbarButton.$1", - "type": "Uncategorized", + "type": "Object", "tags": [], - "label": "props", + "label": "{ label, iconSide = 'left', ...rest }", "description": [], "signature": [ - "P" + "Props" ], - "path": "node_modules/@types/react/index.d.ts", - "deprecated": false + "path": "packages/kbn-shared-ux-components/src/toolbar/buttons/primary/primary.tsx", + "deprecated": false, + "isRequired": true } ], + "returnComment": [], "initialIsOpen": false }, { diff --git a/api_docs/kbn_shared_ux_components.mdx b/api_docs/kbn_shared_ux_components.mdx index 7e2d57701531d3..dead4931843650 100644 --- a/api_docs/kbn_shared_ux_components.mdx +++ b/api_docs/kbn_shared_ux_components.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-components title: "@kbn/shared-ux-components" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/shared-ux-components plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-components'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Owner missing] for questions regarding this plugin. | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 23 | 0 | 6 | 3 | +| 17 | 0 | 12 | 3 | ## Common diff --git a/api_docs/kbn_shared_ux_page_analytics_no_data.devdocs.json b/api_docs/kbn_shared_ux_page_analytics_no_data.devdocs.json index b018c18bce13b8..207b026b31495b 100644 --- a/api_docs/kbn_shared_ux_page_analytics_no_data.devdocs.json +++ b/api_docs/kbn_shared_ux_page_analytics_no_data.devdocs.json @@ -26,31 +26,32 @@ "tags": [], "label": "AnalyticsNoDataPage", "description": [ - "\nAn entire page that can be displayed when Kibana \"has no data\", specifically for Analytics.\nRequires a Provider for relevant services." + "\nAn entire page that can be displayed when Kibana \"has no data\", specifically for Analytics. Uses\nservices from a provider to provide props to a pure component." ], "signature": [ - "React.ForwardRefExoticComponent<", + "({ onDataViewCreated }: ", "AnalyticsNoDataPageProps", - " & React.RefAttributes<{}>>" + ") => JSX.Element" ], - "path": "packages/shared-ux/page/analytics_no_data/src/index.ts", + "path": "packages/shared-ux/page/analytics_no_data/src/analytics_no_data_page.tsx", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "@kbn/shared-ux-page-analytics-no-data", "id": "def-common.AnalyticsNoDataPage.$1", - "type": "Uncategorized", + "type": "Object", "tags": [], - "label": "props", + "label": "{ onDataViewCreated }", "description": [], "signature": [ - "P" + "AnalyticsNoDataPageProps" ], - "path": "node_modules/@types/react/index.d.ts", - "deprecated": false + "path": "packages/shared-ux/page/analytics_no_data/src/analytics_no_data_page.tsx", + "deprecated": false, + "isRequired": true } ], + "returnComment": [], "initialIsOpen": false }, { @@ -126,42 +127,6 @@ ], "returnComment": [], "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/shared-ux-page-analytics-no-data", - "id": "def-common.LazyAnalyticsNoDataPage", - "type": "Function", - "tags": [], - "label": "LazyAnalyticsNoDataPage", - "description": [ - "\nLazy-loaded connected component. Must be wrapped in `React.Suspense`." - ], - "signature": [ - "React.ExoticComponent<", - "AnalyticsNoDataPageProps", - "> & { readonly _result: ({ onDataViewCreated }: ", - "AnalyticsNoDataPageProps", - ") => JSX.Element; }" - ], - "path": "packages/shared-ux/page/analytics_no_data/src/index.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "@kbn/shared-ux-page-analytics-no-data", - "id": "def-common.LazyAnalyticsNoDataPage.$1", - "type": "Uncategorized", - "tags": [], - "label": "props", - "description": [], - "signature": [ - "P" - ], - "path": "node_modules/@types/react/index.d.ts", - "deprecated": false - } - ], - "initialIsOpen": false } ], "interfaces": [], diff --git a/api_docs/kbn_shared_ux_page_analytics_no_data.mdx b/api_docs/kbn_shared_ux_page_analytics_no_data.mdx index df4375727d5b8b..4fb9998081551b 100644 --- a/api_docs/kbn_shared_ux_page_analytics_no_data.mdx +++ b/api_docs/kbn_shared_ux_page_analytics_no_data.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-page-analytics-no-data title: "@kbn/shared-ux-page-analytics-no-data" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/shared-ux-page-analytics-no-data plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-page-analytics-no-data'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Owner missing] for questions regarding this plugin. | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 8 | 0 | 2 | 3 | +| 6 | 0 | 3 | 3 | ## Common diff --git a/api_docs/kbn_shared_ux_prompt_no_data_views.devdocs.json b/api_docs/kbn_shared_ux_prompt_no_data_views.devdocs.json new file mode 100644 index 00000000000000..a86a53f43d3470 --- /dev/null +++ b/api_docs/kbn_shared_ux_prompt_no_data_views.devdocs.json @@ -0,0 +1,309 @@ +{ + "id": "@kbn/shared-ux-prompt-no-data-views", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [ + { + "parentPluginId": "@kbn/shared-ux-prompt-no-data-views", + "id": "def-common.NoDataViewsPrompt", + "type": "Function", + "tags": [], + "label": "NoDataViewsPrompt", + "description": [ + "\nA service-enabled component that provides Kibana-specific functionality to the `NoDataViewsPrompt`\ncomponent.\n\nUse of this component requires both the `EuiTheme` context as well as either a configured Shared UX\n`ServicesProvider` or the `ServicesContext` provided by the Shared UX public plugin contract.\n\nSee shared-ux/public/services for information." + ], + "signature": [ + "({ onDataViewCreated }: ", + "Props", + ") => JSX.Element" + ], + "path": "packages/shared-ux/prompt/no_data_views/src/no_data_views.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/shared-ux-prompt-no-data-views", + "id": "def-common.NoDataViewsPrompt.$1", + "type": "Object", + "tags": [], + "label": "{ onDataViewCreated }", + "description": [], + "signature": [ + "Props" + ], + "path": "packages/shared-ux/prompt/no_data_views/src/no_data_views.tsx", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/shared-ux-prompt-no-data-views", + "id": "def-common.NoDataViewsPrompt", + "type": "Function", + "tags": [], + "label": "NoDataViewsPrompt", + "description": [ + "\nA presentational component that is shown in cases when there are no data views created yet." + ], + "signature": [ + "({ onClickCreate, canCreateNewDataView, dataViewsDocLink, emptyPromptColor, }: ", + "Props", + ") => JSX.Element" + ], + "path": "packages/shared-ux/prompt/no_data_views/src/no_data_views.component.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/shared-ux-prompt-no-data-views", + "id": "def-common.NoDataViewsPrompt.$1", + "type": "Object", + "tags": [], + "label": "{\n onClickCreate,\n canCreateNewDataView,\n dataViewsDocLink,\n emptyPromptColor = 'plain',\n}", + "description": [], + "signature": [ + "Props" + ], + "path": "packages/shared-ux/prompt/no_data_views/src/no_data_views.component.tsx", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/shared-ux-prompt-no-data-views", + "id": "def-common.NoDataViewsPromptKibanaProvider", + "type": "Function", + "tags": [], + "label": "NoDataViewsPromptKibanaProvider", + "description": [ + "\nKibana-specific Provider that maps to known dependency types." + ], + "signature": [ + "({ children, ...services }: React.PropsWithChildren<", + { + "pluginId": "@kbn/shared-ux-prompt-no-data-views", + "scope": "common", + "docId": "kibKbnSharedUxPromptNoDataViewsPluginApi", + "section": "def-common.NoDataViewsPromptKibanaServices", + "text": "NoDataViewsPromptKibanaServices" + }, + ">) => JSX.Element" + ], + "path": "packages/shared-ux/prompt/no_data_views/src/services.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/shared-ux-prompt-no-data-views", + "id": "def-common.NoDataViewsPromptKibanaProvider.$1", + "type": "CompoundType", + "tags": [], + "label": "{\n children,\n ...services\n}", + "description": [], + "signature": [ + "React.PropsWithChildren<", + { + "pluginId": "@kbn/shared-ux-prompt-no-data-views", + "scope": "common", + "docId": "kibKbnSharedUxPromptNoDataViewsPluginApi", + "section": "def-common.NoDataViewsPromptKibanaServices", + "text": "NoDataViewsPromptKibanaServices" + }, + ">" + ], + "path": "packages/shared-ux/prompt/no_data_views/src/services.tsx", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/shared-ux-prompt-no-data-views", + "id": "def-common.NoDataViewsPromptProvider", + "type": "Function", + "tags": [], + "label": "NoDataViewsPromptProvider", + "description": [ + "\nAbstract external service Provider." + ], + "signature": [ + "({ children, ...services }: React.PropsWithChildren<", + { + "pluginId": "@kbn/shared-ux-prompt-no-data-views", + "scope": "common", + "docId": "kibKbnSharedUxPromptNoDataViewsPluginApi", + "section": "def-common.NoDataViewsPromptServices", + "text": "NoDataViewsPromptServices" + }, + ">) => JSX.Element" + ], + "path": "packages/shared-ux/prompt/no_data_views/src/services.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/shared-ux-prompt-no-data-views", + "id": "def-common.NoDataViewsPromptProvider.$1", + "type": "CompoundType", + "tags": [], + "label": "{\n children,\n ...services\n}", + "description": [], + "signature": [ + "React.PropsWithChildren<", + { + "pluginId": "@kbn/shared-ux-prompt-no-data-views", + "scope": "common", + "docId": "kibKbnSharedUxPromptNoDataViewsPluginApi", + "section": "def-common.NoDataViewsPromptServices", + "text": "NoDataViewsPromptServices" + }, + ">" + ], + "path": "packages/shared-ux/prompt/no_data_views/src/services.tsx", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [ + { + "parentPluginId": "@kbn/shared-ux-prompt-no-data-views", + "id": "def-common.NoDataViewsPromptKibanaServices", + "type": "Interface", + "tags": [], + "label": "NoDataViewsPromptKibanaServices", + "description": [ + "\nKibana-specific service types." + ], + "path": "packages/shared-ux/prompt/no_data_views/src/services.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/shared-ux-prompt-no-data-views", + "id": "def-common.NoDataViewsPromptKibanaServices.coreStart", + "type": "Object", + "tags": [], + "label": "coreStart", + "description": [], + "signature": [ + "{ docLinks: { links: { indexPatterns: { introduction: string; }; }; }; }" + ], + "path": "packages/shared-ux/prompt/no_data_views/src/services.tsx", + "deprecated": false + }, + { + "parentPluginId": "@kbn/shared-ux-prompt-no-data-views", + "id": "def-common.NoDataViewsPromptKibanaServices.dataViewEditor", + "type": "Object", + "tags": [], + "label": "dataViewEditor", + "description": [], + "signature": [ + "{ userPermissions: { editDataView: () => boolean; }; openEditor: (options: DataViewEditorOptions) => () => void; }" + ], + "path": "packages/shared-ux/prompt/no_data_views/src/services.tsx", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/shared-ux-prompt-no-data-views", + "id": "def-common.NoDataViewsPromptServices", + "type": "Interface", + "tags": [], + "label": "NoDataViewsPromptServices", + "description": [ + "\nAbstract external services for this component." + ], + "path": "packages/shared-ux/prompt/no_data_views/src/services.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/shared-ux-prompt-no-data-views", + "id": "def-common.NoDataViewsPromptServices.canCreateNewDataView", + "type": "boolean", + "tags": [], + "label": "canCreateNewDataView", + "description": [ + "True if the user has permission to create a new Data View, false otherwise." + ], + "path": "packages/shared-ux/prompt/no_data_views/src/services.tsx", + "deprecated": false + }, + { + "parentPluginId": "@kbn/shared-ux-prompt-no-data-views", + "id": "def-common.NoDataViewsPromptServices.openDataViewEditor", + "type": "Function", + "tags": [], + "label": "openDataViewEditor", + "description": [ + "A method to open the Data View Editor flow." + ], + "signature": [ + "(options: DataViewEditorOptions) => () => void" + ], + "path": "packages/shared-ux/prompt/no_data_views/src/services.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/shared-ux-prompt-no-data-views", + "id": "def-common.NoDataViewsPromptServices.openDataViewEditor.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "DataViewEditorOptions" + ], + "path": "packages/shared-ux/prompt/no_data_views/src/services.tsx", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/shared-ux-prompt-no-data-views", + "id": "def-common.NoDataViewsPromptServices.dataViewsDocLink", + "type": "string", + "tags": [], + "label": "dataViewsDocLink", + "description": [ + "A link to information about Data Views in Kibana" + ], + "path": "packages/shared-ux/prompt/no_data_views/src/services.tsx", + "deprecated": false + } + ], + "initialIsOpen": false + } + ], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_shared_ux_prompt_no_data_views.mdx b/api_docs/kbn_shared_ux_prompt_no_data_views.mdx new file mode 100644 index 00000000000000..96a0f7c0a5b1fc --- /dev/null +++ b/api_docs/kbn_shared_ux_prompt_no_data_views.mdx @@ -0,0 +1,30 @@ +--- +id: kibKbnSharedUxPromptNoDataViewsPluginApi +slug: /kibana-dev-docs/api/kbn-shared-ux-prompt-no-data-views +title: "@kbn/shared-ux-prompt-no-data-views" +image: https://source.unsplash.com/400x175/?github +summary: API docs for the @kbn/shared-ux-prompt-no-data-views plugin +date: 2022-06-07 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-prompt-no-data-views'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- +import kbnSharedUxPromptNoDataViewsObj from './kbn_shared_ux_prompt_no_data_views.devdocs.json'; + + + +Contact [Owner missing] for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 16 | 0 | 7 | 1 | + +## Common + +### Functions + + +### Interfaces + + diff --git a/api_docs/kbn_shared_ux_services.mdx b/api_docs/kbn_shared_ux_services.mdx index 55159c05b21437..f26ac2e3c6ce98 100644 --- a/api_docs/kbn_shared_ux_services.mdx +++ b/api_docs/kbn_shared_ux_services.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-services title: "@kbn/shared-ux-services" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/shared-ux-services plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-services'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_shared_ux_storybook.mdx b/api_docs/kbn_shared_ux_storybook.mdx index 11fec87a6cf87c..f2985cbb92cd9b 100644 --- a/api_docs/kbn_shared_ux_storybook.mdx +++ b/api_docs/kbn_shared_ux_storybook.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-storybook title: "@kbn/shared-ux-storybook" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/shared-ux-storybook plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-storybook'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_shared_ux_utility.mdx b/api_docs/kbn_shared_ux_utility.mdx index b3f543547c75d4..3f62c07f0447f7 100644 --- a/api_docs/kbn_shared_ux_utility.mdx +++ b/api_docs/kbn_shared_ux_utility.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-utility title: "@kbn/shared-ux-utility" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/shared-ux-utility plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-utility'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_sort_package_json.mdx b/api_docs/kbn_sort_package_json.mdx index 0275bfd7bba160..99c142b9f45590 100644 --- a/api_docs/kbn_sort_package_json.mdx +++ b/api_docs/kbn_sort_package_json.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-sort-package-json title: "@kbn/sort-package-json" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/sort-package-json plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/sort-package-json'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_std.mdx b/api_docs/kbn_std.mdx index dcdb86397e80ad..f8e4ccfba48a3b 100644 --- a/api_docs/kbn_std.mdx +++ b/api_docs/kbn_std.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-std title: "@kbn/std" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/std plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/std'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_stdio_dev_helpers.mdx b/api_docs/kbn_stdio_dev_helpers.mdx index 32d48520e85da1..cd2a338b997dc8 100644 --- a/api_docs/kbn_stdio_dev_helpers.mdx +++ b/api_docs/kbn_stdio_dev_helpers.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-stdio-dev-helpers title: "@kbn/stdio-dev-helpers" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/stdio-dev-helpers plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/stdio-dev-helpers'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_storybook.devdocs.json b/api_docs/kbn_storybook.devdocs.json index 7388a90ac8ed21..ddfb4665d511ad 100644 --- a/api_docs/kbn_storybook.devdocs.json +++ b/api_docs/kbn_storybook.devdocs.json @@ -108,6 +108,9 @@ "description": [ "\nThe interface for Storybook configuration in `main.ts` files." ], + "signature": [ + "StorybookConfig" + ], "path": "node_modules/@storybook/core-common/dist/ts3.9/types.d.ts", "deprecated": false, "children": [ diff --git a/api_docs/kbn_storybook.mdx b/api_docs/kbn_storybook.mdx index cfb4febbde6af5..60e6b28e853d69 100644 --- a/api_docs/kbn_storybook.mdx +++ b/api_docs/kbn_storybook.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-storybook title: "@kbn/storybook" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/storybook plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/storybook'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_telemetry_tools.mdx b/api_docs/kbn_telemetry_tools.mdx index f74dba049bbd54..6b4e2d9a2e548e 100644 --- a/api_docs/kbn_telemetry_tools.mdx +++ b/api_docs/kbn_telemetry_tools.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-telemetry-tools title: "@kbn/telemetry-tools" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/telemetry-tools plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/telemetry-tools'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_test.devdocs.json b/api_docs/kbn_test.devdocs.json index 2fac6616fed527..b049321dd2e411 100644 --- a/api_docs/kbn_test.devdocs.json +++ b/api_docs/kbn_test.devdocs.json @@ -1977,6 +1977,22 @@ "returnComment": [], "initialIsOpen": false }, + { + "parentPluginId": "@kbn/test", + "id": "def-server.runCheckFtrConfigsCli", + "type": "Function", + "tags": [], + "label": "runCheckFtrConfigsCli", + "description": [], + "signature": [ + "() => Promise" + ], + "path": "packages/kbn-test/src/functional_test_runner/lib/config/run_check_ftr_configs_cli.ts", + "deprecated": false, + "children": [], + "returnComment": [], + "initialIsOpen": false + }, { "parentPluginId": "@kbn/test", "id": "def-server.runCheckJestConfigsCli", diff --git a/api_docs/kbn_test.mdx b/api_docs/kbn_test.mdx index 0f6a3137487dcd..39c30f6d2180e8 100644 --- a/api_docs/kbn_test.mdx +++ b/api_docs/kbn_test.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-test title: "@kbn/test" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/test plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/test'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact Operations for questions regarding this plugin. | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 240 | 5 | 201 | 9 | +| 241 | 5 | 202 | 9 | ## Server diff --git a/api_docs/kbn_test_jest_helpers.mdx b/api_docs/kbn_test_jest_helpers.mdx index ac9cb43379fb2b..57f6854e9b61c3 100644 --- a/api_docs/kbn_test_jest_helpers.mdx +++ b/api_docs/kbn_test_jest_helpers.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-test-jest-helpers title: "@kbn/test-jest-helpers" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/test-jest-helpers plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/test-jest-helpers'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_tooling_log.mdx b/api_docs/kbn_tooling_log.mdx index bc4884d81cb69d..f35f8b76366fe0 100644 --- a/api_docs/kbn_tooling_log.mdx +++ b/api_docs/kbn_tooling_log.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-tooling-log title: "@kbn/tooling-log" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/tooling-log plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/tooling-log'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_type_summarizer.mdx b/api_docs/kbn_type_summarizer.mdx index 4d2af6b05b0b03..926450aa4b7a4e 100644 --- a/api_docs/kbn_type_summarizer.mdx +++ b/api_docs/kbn_type_summarizer.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-type-summarizer title: "@kbn/type-summarizer" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/type-summarizer plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/type-summarizer'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_typed_react_router_config.mdx b/api_docs/kbn_typed_react_router_config.mdx index fb8060ef2712e2..58629985bcff06 100644 --- a/api_docs/kbn_typed_react_router_config.mdx +++ b/api_docs/kbn_typed_react_router_config.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-typed-react-router-config title: "@kbn/typed-react-router-config" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/typed-react-router-config plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/typed-react-router-config'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_ui_theme.mdx b/api_docs/kbn_ui_theme.mdx index 2484a73cc6652e..9a851c00b2fb3e 100644 --- a/api_docs/kbn_ui_theme.mdx +++ b/api_docs/kbn_ui_theme.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-ui-theme title: "@kbn/ui-theme" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/ui-theme plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ui-theme'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_utility_types.mdx b/api_docs/kbn_utility_types.mdx index b856aadc1bfd79..5b7fac399b877a 100644 --- a/api_docs/kbn_utility_types.mdx +++ b/api_docs/kbn_utility_types.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-utility-types title: "@kbn/utility-types" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/utility-types plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/utility-types'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_utility_types_jest.devdocs.json b/api_docs/kbn_utility_types_jest.devdocs.json new file mode 100644 index 00000000000000..80761e1218f2be --- /dev/null +++ b/api_docs/kbn_utility_types_jest.devdocs.json @@ -0,0 +1,64 @@ +{ + "id": "@kbn/utility-types-jest", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [ + { + "parentPluginId": "@kbn/utility-types-jest", + "id": "def-server.DeeplyMockedKeys", + "type": "Type", + "tags": [], + "label": "DeeplyMockedKeys", + "description": [], + "signature": [ + "{ [P in keyof T]: T[P] extends (...args: any[]) => any ? jest.MockInstance, Parameters> : ", + { + "pluginId": "@kbn/utility-types-jest", + "scope": "server", + "docId": "kibKbnUtilityTypesJestPluginApi", + "section": "def-server.DeeplyMockedKeys", + "text": "DeeplyMockedKeys" + }, + "; } & T" + ], + "path": "packages/kbn-utility-types-jest/src/index.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/utility-types-jest", + "id": "def-server.MockedKeys", + "type": "Type", + "tags": [], + "label": "MockedKeys", + "description": [], + "signature": [ + "{ [P in keyof T]: jest.Mocked; }" + ], + "path": "packages/kbn-utility-types-jest/src/index.ts", + "deprecated": false, + "initialIsOpen": false + } + ], + "objects": [] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_utility_types_jest.mdx b/api_docs/kbn_utility_types_jest.mdx new file mode 100644 index 00000000000000..07ac6236c984c6 --- /dev/null +++ b/api_docs/kbn_utility_types_jest.mdx @@ -0,0 +1,27 @@ +--- +id: kibKbnUtilityTypesJestPluginApi +slug: /kibana-dev-docs/api/kbn-utility-types-jest +title: "@kbn/utility-types-jest" +image: https://source.unsplash.com/400x175/?github +summary: API docs for the @kbn/utility-types-jest plugin +date: 2022-06-07 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/utility-types-jest'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- +import kbnUtilityTypesJestObj from './kbn_utility_types_jest.devdocs.json'; + + + +Contact [Owner missing] for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 2 | 0 | 2 | 0 | + +## Server + +### Consts, variables and types + + diff --git a/api_docs/kbn_utils.mdx b/api_docs/kbn_utils.mdx index 8a8ce384d7a414..72b72867ae3e67 100644 --- a/api_docs/kbn_utils.mdx +++ b/api_docs/kbn_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-utils title: "@kbn/utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/utils plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/utils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kibana_overview.mdx b/api_docs/kibana_overview.mdx index 67f670cd7fd6e0..66d52d6bff6f80 100644 --- a/api_docs/kibana_overview.mdx +++ b/api_docs/kibana_overview.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kibanaOverview title: "kibanaOverview" image: https://source.unsplash.com/400x175/?github summary: API docs for the kibanaOverview plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'kibanaOverview'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kibana_react.devdocs.json b/api_docs/kibana_react.devdocs.json index 6335f6d2771c15..11025e215a4d20 100644 --- a/api_docs/kibana_react.devdocs.json +++ b/api_docs/kibana_react.devdocs.json @@ -417,7 +417,7 @@ "description": [], "signature": [ "(criteria: ", - "Criteria", + "CriteriaWithPagination", ") => void" ], "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", @@ -431,7 +431,7 @@ "label": "criteria", "description": [], "signature": [ - "Criteria", + "CriteriaWithPagination", "" ], "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", @@ -3888,6 +3888,19 @@ "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", "deprecated": false }, + { + "parentPluginId": "kibanaReact", + "id": "def-public.TableListViewState.pagination", + "type": "Object", + "tags": [], + "label": "pagination", + "description": [], + "signature": [ + "Pagination" + ], + "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", + "deprecated": false + }, { "parentPluginId": "kibanaReact", "id": "def-public.TableListViewState.tableSort", @@ -4589,7 +4602,9 @@ "section": "def-public.ThemeServiceStart", "text": "ThemeServiceStart" }, - " | undefined; injectedMetadata?: { getInjectedVar: (name: string, defaultValue?: any) => unknown; } | undefined; }" + " | undefined; injectedMetadata?: ", + "InjectedMetadataStart", + " | undefined; }" ], "path": "src/plugins/kibana_react/public/context/types.ts", "deprecated": false, diff --git a/api_docs/kibana_react.mdx b/api_docs/kibana_react.mdx index 6be54ccb0f28d8..4ba4120ac12762 100644 --- a/api_docs/kibana_react.mdx +++ b/api_docs/kibana_react.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kibanaReact title: "kibanaReact" image: https://source.unsplash.com/400x175/?github summary: API docs for the kibanaReact plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'kibanaReact'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 250 | 0 | 213 | 5 | +| 251 | 0 | 214 | 5 | ## Client diff --git a/api_docs/kibana_utils.mdx b/api_docs/kibana_utils.mdx index 519dea4b7f5391..981b971f448ff6 100644 --- a/api_docs/kibana_utils.mdx +++ b/api_docs/kibana_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kibanaUtils title: "kibanaUtils" image: https://source.unsplash.com/400x175/?github summary: API docs for the kibanaUtils plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'kibanaUtils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kubernetes_security.devdocs.json b/api_docs/kubernetes_security.devdocs.json new file mode 100644 index 00000000000000..ed5443d3dffa48 --- /dev/null +++ b/api_docs/kubernetes_security.devdocs.json @@ -0,0 +1,73 @@ +{ + "id": "kubernetesSecurity", + "client": { + "classes": [], + "functions": [], + "interfaces": [ + { + "parentPluginId": "kubernetesSecurity", + "id": "def-public.KubernetesSecurityStart", + "type": "Interface", + "tags": [], + "label": "KubernetesSecurityStart", + "description": [], + "path": "x-pack/plugins/kubernetes_security/public/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "kubernetesSecurity", + "id": "def-public.KubernetesSecurityStart.getKubernetesPage", + "type": "Function", + "tags": [], + "label": "getKubernetesPage", + "description": [], + "signature": [ + "(kubernetesSecurityDeps: ", + "KubernetesSecurityDeps", + ") => JSX.Element" + ], + "path": "x-pack/plugins/kubernetes_security/public/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "kubernetesSecurity", + "id": "def-public.KubernetesSecurityStart.getKubernetesPage.$1", + "type": "Object", + "tags": [], + "label": "kubernetesSecurityDeps", + "description": [], + "signature": [ + "KubernetesSecurityDeps" + ], + "path": "x-pack/plugins/kubernetes_security/public/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + } + ], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kubernetes_security.mdx b/api_docs/kubernetes_security.mdx new file mode 100644 index 00000000000000..4ea020ba1f1593 --- /dev/null +++ b/api_docs/kubernetes_security.mdx @@ -0,0 +1,27 @@ +--- +id: kibKubernetesSecurityPluginApi +slug: /kibana-dev-docs/api/kubernetesSecurity +title: "kubernetesSecurity" +image: https://source.unsplash.com/400x175/?github +summary: API docs for the kubernetesSecurity plugin +date: 2022-06-07 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'kubernetesSecurity'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- +import kubernetesSecurityObj from './kubernetes_security.devdocs.json'; + + + +Contact [Security Team](https://github.com/orgs/elastic/teams/security-team) for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 3 | 0 | 3 | 1 | + +## Client + +### Interfaces + + diff --git a/api_docs/lens.devdocs.json b/api_docs/lens.devdocs.json index dc5b6bc3657550..c0f6fe965a4fbc 100644 --- a/api_docs/lens.devdocs.json +++ b/api_docs/lens.devdocs.json @@ -927,6 +927,19 @@ "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", "deprecated": false }, + { + "parentPluginId": "lens", + "id": "def-public.DataLayerArgs.showLines", + "type": "CompoundType", + "tags": [], + "label": "showLines", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", + "deprecated": false + }, { "parentPluginId": "lens", "id": "def-public.DataLayerArgs.pointsRadius", @@ -1117,7 +1130,7 @@ "tags": [], "label": "getFilters", "description": [ - "\nCollect all defined filters from all the operations in the layer" + "\nCollect all defined filters from all the operations in the layer. If it returns undefined, this means that filters can't be constructed for the current layer" ], "signature": [ "(activeData?: Record | undefined) => Record<\"disabled\" | \"enabled\", { kuery: ", + "> | undefined, timeRange?: ", + "TimeRange", + " | undefined) => { error: string; } | Record<\"disabled\" | \"enabled\", { kuery: ", "Query", "[][]; lucene: ", "Query", @@ -1158,6 +1173,21 @@ "path": "x-pack/plugins/lens/public/types.ts", "deprecated": false, "isRequired": false + }, + { + "parentPluginId": "lens", + "id": "def-public.DatasourcePublicAPI.getFilters.$2", + "type": "Object", + "tags": [], + "label": "timeRange", + "description": [], + "signature": [ + "TimeRange", + " | undefined" + ], + "path": "x-pack/plugins/lens/public/types.ts", + "deprecated": false, + "isRequired": false } ], "returnComment": [] @@ -2390,7 +2420,7 @@ "section": "def-public.LensEmbeddableInput", "text": "LensEmbeddableInput" }, - " | undefined, options?: { openInNewTab?: boolean | undefined; originatingApp?: string | undefined; originatingPath?: string | undefined; } | undefined) => void" + " | undefined, options?: { openInNewTab?: boolean | undefined; originatingApp?: string | undefined; originatingPath?: string | undefined; skipAppLeave?: boolean | undefined; } | undefined) => void" ], "path": "x-pack/plugins/lens/public/plugin.ts", "deprecated": false, @@ -2464,6 +2494,19 @@ ], "path": "x-pack/plugins/lens/public/plugin.ts", "deprecated": false + }, + { + "parentPluginId": "lens", + "id": "def-public.LensPublicStart.navigateToPrefilledEditor.$2.skipAppLeave", + "type": "CompoundType", + "tags": [], + "label": "skipAppLeave", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "x-pack/plugins/lens/public/plugin.ts", + "deprecated": false } ] } @@ -2588,6 +2631,130 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "lens", + "id": "def-public.MetricState", + "type": "Interface", + "tags": [], + "label": "MetricState", + "description": [], + "path": "x-pack/plugins/lens/common/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "lens", + "id": "def-public.MetricState.layerId", + "type": "string", + "tags": [], + "label": "layerId", + "description": [], + "path": "x-pack/plugins/lens/common/types.ts", + "deprecated": false + }, + { + "parentPluginId": "lens", + "id": "def-public.MetricState.accessor", + "type": "string", + "tags": [], + "label": "accessor", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/lens/common/types.ts", + "deprecated": false + }, + { + "parentPluginId": "lens", + "id": "def-public.MetricState.layerType", + "type": "CompoundType", + "tags": [], + "label": "layerType", + "description": [], + "signature": [ + "\"data\" | \"annotations\" | \"referenceLine\"" + ], + "path": "x-pack/plugins/lens/common/types.ts", + "deprecated": false + }, + { + "parentPluginId": "lens", + "id": "def-public.MetricState.colorMode", + "type": "CompoundType", + "tags": [], + "label": "colorMode", + "description": [], + "signature": [ + { + "pluginId": "charts", + "scope": "common", + "docId": "kibChartsPluginApi", + "section": "def-common.ColorMode", + "text": "ColorMode" + }, + " | undefined" + ], + "path": "x-pack/plugins/lens/common/types.ts", + "deprecated": false + }, + { + "parentPluginId": "lens", + "id": "def-public.MetricState.palette", + "type": "Object", + "tags": [], + "label": "palette", + "description": [], + "signature": [ + "PaletteOutput", + "<", + "CustomPaletteParams", + "> | undefined" + ], + "path": "x-pack/plugins/lens/common/types.ts", + "deprecated": false + }, + { + "parentPluginId": "lens", + "id": "def-public.MetricState.titlePosition", + "type": "CompoundType", + "tags": [], + "label": "titlePosition", + "description": [], + "signature": [ + "\"top\" | \"bottom\" | undefined" + ], + "path": "x-pack/plugins/lens/common/types.ts", + "deprecated": false + }, + { + "parentPluginId": "lens", + "id": "def-public.MetricState.size", + "type": "string", + "tags": [], + "label": "size", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/lens/common/types.ts", + "deprecated": false + }, + { + "parentPluginId": "lens", + "id": "def-public.MetricState.textAlign", + "type": "CompoundType", + "tags": [], + "label": "textAlign", + "description": [], + "signature": [ + "\"left\" | \"right\" | \"center\" | undefined" + ], + "path": "x-pack/plugins/lens/common/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, { "parentPluginId": "lens", "id": "def-public.OperationMetadata", @@ -2709,6 +2876,62 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "lens", + "id": "def-public.PercentileRanksIndexPatternColumn", + "type": "Interface", + "tags": [], + "label": "PercentileRanksIndexPatternColumn", + "description": [], + "signature": [ + { + "pluginId": "lens", + "scope": "public", + "docId": "kibLensPluginApi", + "section": "def-public.PercentileRanksIndexPatternColumn", + "text": "PercentileRanksIndexPatternColumn" + }, + " extends ", + { + "pluginId": "lens", + "scope": "public", + "docId": "kibLensPluginApi", + "section": "def-public.FieldBasedIndexPatternColumn", + "text": "FieldBasedIndexPatternColumn" + } + ], + "path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/percentile_ranks.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "lens", + "id": "def-public.PercentileRanksIndexPatternColumn.operationType", + "type": "string", + "tags": [], + "label": "operationType", + "description": [], + "signature": [ + "\"percentile_rank\"" + ], + "path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/percentile_ranks.tsx", + "deprecated": false + }, + { + "parentPluginId": "lens", + "id": "def-public.PercentileRanksIndexPatternColumn.params", + "type": "Object", + "tags": [], + "label": "params", + "description": [], + "signature": [ + "{ value: number; }" + ], + "path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/percentile_ranks.tsx", + "deprecated": false + } + ], + "initialIsOpen": false + }, { "parentPluginId": "lens", "id": "def-public.PieVisualizationState", @@ -5146,7 +5369,7 @@ "label": "yLeftScale", "description": [], "signature": [ - "\"time\" | \"log\" | \"sqrt\" | \"linear\"" + "\"time\" | \"log\" | \"linear\" | \"sqrt\"" ], "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", "deprecated": false @@ -5159,7 +5382,7 @@ "label": "yRightScale", "description": [], "signature": [ - "\"time\" | \"log\" | \"sqrt\" | \"linear\"" + "\"time\" | \"log\" | \"linear\" | \"sqrt\"" ], "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", "deprecated": false @@ -5510,6 +5733,42 @@ ], "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", "deprecated": false + }, + { + "parentPluginId": "lens", + "id": "def-public.XYArgs.detailedTooltip", + "type": "CompoundType", + "tags": [], + "label": "detailedTooltip", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", + "deprecated": false + }, + { + "parentPluginId": "lens", + "id": "def-public.XYArgs.orderBucketsBySum", + "type": "CompoundType", + "tags": [], + "label": "orderBucketsBySum", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", + "deprecated": false + }, + { + "parentPluginId": "lens", + "id": "def-public.XYArgs.showTooltip", + "type": "boolean", + "tags": [], + "label": "showTooltip", + "description": [], + "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", + "deprecated": false } ], "initialIsOpen": false @@ -6558,7 +6817,7 @@ "section": "def-common.GaugeState", "text": "GaugeState" }, - ", \"goal\" | \"max\" | \"min\" | \"metric\"> & { metricAccessor?: string | undefined; minAccessor?: string | undefined; maxAccessor?: string | undefined; goalAccessor?: string | undefined; } & { layerId: string; layerType: ", + ", \"goal\" | \"min\" | \"max\" | \"metric\"> & { metricAccessor?: string | undefined; minAccessor?: string | undefined; maxAccessor?: string | undefined; goalAccessor?: string | undefined; } & { layerId: string; layerType: ", { "pluginId": "lens", "scope": "common", @@ -7253,7 +7512,7 @@ "label": "YScaleType", "description": [], "signature": [ - "\"time\" | \"log\" | \"sqrt\" | \"linear\"" + "\"time\" | \"log\" | \"linear\" | \"sqrt\"" ], "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", "deprecated": false, @@ -8389,7 +8648,7 @@ "label": "OperationTypePost712", "description": [], "signature": [ - "\"filters\" | \"count\" | \"sum\" | \"max\" | \"min\" | \"median\" | \"date_histogram\" | \"percentile\" | \"average\" | \"range\" | \"terms\" | \"cumulative_sum\" | \"moving_average\" | \"unique_count\" | \"last_value\" | \"counter_rate\" | \"differences\"" + "\"filters\" | \"count\" | \"date_histogram\" | \"percentile\" | \"min\" | \"max\" | \"sum\" | \"average\" | \"range\" | \"terms\" | \"median\" | \"cumulative_sum\" | \"moving_average\" | \"unique_count\" | \"last_value\" | \"counter_rate\" | \"differences\"" ], "path": "x-pack/plugins/lens/server/migrations/types.ts", "deprecated": false, @@ -8403,7 +8662,7 @@ "label": "OperationTypePre712", "description": [], "signature": [ - "\"filters\" | \"count\" | \"sum\" | \"avg\" | \"max\" | \"min\" | \"median\" | \"date_histogram\" | \"percentile\" | \"range\" | \"terms\" | \"cumulative_sum\" | \"derivative\" | \"moving_average\" | \"last_value\" | \"counter_rate\" | \"cardinality\"" + "\"filters\" | \"count\" | \"date_histogram\" | \"percentile\" | \"min\" | \"max\" | \"sum\" | \"range\" | \"terms\" | \"avg\" | \"median\" | \"cumulative_sum\" | \"derivative\" | \"moving_average\" | \"last_value\" | \"counter_rate\" | \"cardinality\"" ], "path": "x-pack/plugins/lens/server/migrations/types.ts", "deprecated": false, diff --git a/api_docs/lens.mdx b/api_docs/lens.mdx index 775282a3cc6b1c..6e183e2ad8845e 100644 --- a/api_docs/lens.mdx +++ b/api_docs/lens.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/lens title: "lens" image: https://source.unsplash.com/400x175/?github summary: API docs for the lens plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'lens'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 574 | 0 | 497 | 35 | +| 592 | 0 | 515 | 35 | ## Client diff --git a/api_docs/license_api_guard.mdx b/api_docs/license_api_guard.mdx index 2cdf9aee5ef7c2..e45049fe8c48df 100644 --- a/api_docs/license_api_guard.mdx +++ b/api_docs/license_api_guard.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/licenseApiGuard title: "licenseApiGuard" image: https://source.unsplash.com/400x175/?github summary: API docs for the licenseApiGuard plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'licenseApiGuard'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/license_management.mdx b/api_docs/license_management.mdx index aca09e5bba03fc..92f8093f446f4a 100644 --- a/api_docs/license_management.mdx +++ b/api_docs/license_management.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/licenseManagement title: "licenseManagement" image: https://source.unsplash.com/400x175/?github summary: API docs for the licenseManagement plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'licenseManagement'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/licensing.devdocs.json b/api_docs/licensing.devdocs.json index 8839d4fac64653..d75cca0699ceb6 100644 --- a/api_docs/licensing.devdocs.json +++ b/api_docs/licensing.devdocs.json @@ -323,7 +323,7 @@ "\nThe state of checking the results of a license type meeting the license minimum." ], "signature": [ - "\"valid\" | \"invalid\" | \"unavailable\" | \"expired\"" + "\"invalid\" | \"unavailable\" | \"valid\" | \"expired\"" ], "path": "x-pack/plugins/licensing/common/types.ts", "deprecated": false @@ -636,7 +636,7 @@ "label": "LicenseCheckState", "description": [], "signature": [ - "\"valid\" | \"invalid\" | \"unavailable\" | \"expired\"" + "\"invalid\" | \"unavailable\" | \"valid\" | \"expired\"" ], "path": "x-pack/plugins/licensing/common/types.ts", "deprecated": false, @@ -2025,7 +2025,7 @@ "\nThe state of checking the results of a license type meeting the license minimum." ], "signature": [ - "\"valid\" | \"invalid\" | \"unavailable\" | \"expired\"" + "\"invalid\" | \"unavailable\" | \"valid\" | \"expired\"" ], "path": "x-pack/plugins/licensing/common/types.ts", "deprecated": false @@ -2429,7 +2429,7 @@ "label": "LicenseCheckState", "description": [], "signature": [ - "\"valid\" | \"invalid\" | \"unavailable\" | \"expired\"" + "\"invalid\" | \"unavailable\" | \"valid\" | \"expired\"" ], "path": "x-pack/plugins/licensing/common/types.ts", "deprecated": false, diff --git a/api_docs/licensing.mdx b/api_docs/licensing.mdx index 1d642ed33498f3..fd06cdf83faefa 100644 --- a/api_docs/licensing.mdx +++ b/api_docs/licensing.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/licensing title: "licensing" image: https://source.unsplash.com/400x175/?github summary: API docs for the licensing plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'licensing'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/lists.devdocs.json b/api_docs/lists.devdocs.json index a2134a2c8ffb3b..c158f3bc048fdc 100644 --- a/api_docs/lists.devdocs.json +++ b/api_docs/lists.devdocs.json @@ -311,7 +311,7 @@ "label": "exceptionItems", "description": [], "signature": [ - "({ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; } | ({ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; })[]; list_id: string; name: string; type: \"simple\"; } & { comments?: { comment: string; }[] | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }))[]" + "({ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; } | ({ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; })[]; list_id: string; name: string; type: \"simple\"; } & { comments?: { comment: string; }[] | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }))[]" ], "path": "x-pack/plugins/lists/public/exceptions/components/builder/exception_items_renderer.tsx", "deprecated": false @@ -324,7 +324,7 @@ "label": "exceptionsToDelete", "description": [], "signature": [ - "{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }[]" + "{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }[]" ], "path": "x-pack/plugins/lists/public/exceptions/components/builder/exception_items_renderer.tsx", "deprecated": false @@ -585,7 +585,7 @@ "signature": [ "({ itemId, id, namespaceType, }: ", "GetExceptionListItemOptions", - ") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; } | null>" + ") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; } | null>" ], "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts", "deprecated": false, @@ -659,7 +659,7 @@ "signature": [ "({ comments, description, entries, itemId, meta, name, osTypes, tags, type, }: ", "CreateEndpointListItemOptions", - ") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }>" + ") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }>" ], "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts", "deprecated": false, @@ -695,7 +695,7 @@ "signature": [ "({ _version, comments, description, entries, id, itemId, meta, name, osTypes, tags, type, }: ", "UpdateEndpointListItemOptions", - ") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; } | null>" + ") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; } | null>" ], "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts", "deprecated": false, @@ -731,7 +731,7 @@ "signature": [ "({ itemId, id, }: ", "GetEndpointListItemOptions", - ") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; } | null>" + ") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; } | null>" ], "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts", "deprecated": false, @@ -881,7 +881,7 @@ "section": "def-server.CreateExceptionListItemOptions", "text": "CreateExceptionListItemOptions" }, - ") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }>" + ") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }>" ], "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts", "deprecated": false, @@ -929,7 +929,7 @@ "section": "def-server.UpdateExceptionListItemOptions", "text": "UpdateExceptionListItemOptions" }, - ") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; } | null>" + ") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; } | null>" ], "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts", "deprecated": false, @@ -971,7 +971,7 @@ "signature": [ "({ id, itemId, namespaceType, }: ", "DeleteExceptionListItemOptions", - ") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; } | null>" + ") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; } | null>" ], "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts", "deprecated": false, @@ -1041,7 +1041,7 @@ "signature": [ "({ id, itemId, }: ", "DeleteEndpointListItemOptions", - ") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; } | null>" + ") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; } | null>" ], "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts", "deprecated": false, @@ -1075,7 +1075,7 @@ "signature": [ "({ listId, filter, perPage, pit, page, searchAfter, sortField, sortOrder, namespaceType, }: ", "FindExceptionListItemOptions", - ") => Promise<({ data: { _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }[]; page: number; per_page: number; total: number; } & { pit?: string | undefined; }) | null>" + ") => Promise<({ data: { _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }[]; page: number; per_page: number; total: number; } & { pit?: string | undefined; }) | null>" ], "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts", "deprecated": false, @@ -1111,7 +1111,7 @@ "signature": [ "({ listId, filter, perPage, pit, page, searchAfter, sortField, sortOrder, namespaceType, }: ", "FindExceptionListsItemOptions", - ") => Promise<({ data: { _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }[]; page: number; per_page: number; total: number; } & { pit?: string | undefined; }) | null>" + ") => Promise<({ data: { _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }[]; page: number; per_page: number; total: number; } & { pit?: string | undefined; }) | null>" ], "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts", "deprecated": false, @@ -1147,7 +1147,7 @@ "signature": [ "({ perPage, pit, page, searchAfter, sortField, sortOrder, valueListId, }: ", "FindValueListExceptionListsItems", - ") => Promise<({ data: { _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }[]; page: number; per_page: number; total: number; } & { pit?: string | undefined; }) | null>" + ") => Promise<({ data: { _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }[]; page: number; per_page: number; total: number; } & { pit?: string | undefined; }) | null>" ], "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts", "deprecated": false, @@ -1219,7 +1219,7 @@ "signature": [ "({ filter, perPage, page, pit, searchAfter, sortField, sortOrder, }: ", "FindEndpointListItemOptions", - ") => Promise<({ data: { _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }[]; page: number; per_page: number; total: number; } & { pit?: string | undefined; }) | null>" + ") => Promise<({ data: { _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }[]; page: number; per_page: number; total: number; } & { pit?: string | undefined; }) | null>" ], "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts", "deprecated": false, @@ -1680,7 +1680,7 @@ "signature": [ "({ id }: ", "GetListOptions", - ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; version: number; } | null>" + ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; } | null>" ], "path": "x-pack/plugins/lists/server/services/lists/list_client.ts", "deprecated": false, @@ -1716,7 +1716,7 @@ "signature": [ "({ id, deserializer, immutable, serializer, name, description, type, meta, version, }: ", "CreateListOptions", - ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; version: number; }>" + ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; }>" ], "path": "x-pack/plugins/lists/server/services/lists/list_client.ts", "deprecated": false, @@ -1752,7 +1752,7 @@ "signature": [ "({ id, deserializer, serializer, name, description, immutable, type, meta, version, }: ", "CreateListIfItDoesNotExistOptions", - ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; version: number; }>" + ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; }>" ], "path": "x-pack/plugins/lists/server/services/lists/list_client.ts", "deprecated": false, @@ -2168,7 +2168,7 @@ "signature": [ "({ id }: ", "DeleteListItemOptions", - ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; value: string; } | null>" + ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; value: string; } | null>" ], "path": "x-pack/plugins/lists/server/services/lists/list_client.ts", "deprecated": false, @@ -2204,7 +2204,7 @@ "signature": [ "({ listId, value, type, }: ", "DeleteListItemByValueOptions", - ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; value: string; }[]>" + ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; value: string; }[]>" ], "path": "x-pack/plugins/lists/server/services/lists/list_client.ts", "deprecated": false, @@ -2240,7 +2240,7 @@ "signature": [ "({ id }: ", "DeleteListOptions", - ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; version: number; } | null>" + ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; } | null>" ], "path": "x-pack/plugins/lists/server/services/lists/list_client.ts", "deprecated": false, @@ -2310,7 +2310,7 @@ "signature": [ "({ deserializer, serializer, type, listId, stream, meta, version, }: ", "ImportListItemsToStreamOptions", - ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; version: number; } | null>" + ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; } | null>" ], "path": "x-pack/plugins/lists/server/services/lists/list_client.ts", "deprecated": false, @@ -2344,7 +2344,7 @@ "signature": [ "({ listId, value, type, }: ", "GetListItemByValueOptions", - ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; value: string; }[]>" + ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; value: string; }[]>" ], "path": "x-pack/plugins/lists/server/services/lists/list_client.ts", "deprecated": false, @@ -2380,7 +2380,7 @@ "signature": [ "({ id, deserializer, serializer, listId, value, type, meta, }: ", "CreateListItemOptions", - ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; value: string; } | null>" + ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; value: string; } | null>" ], "path": "x-pack/plugins/lists/server/services/lists/list_client.ts", "deprecated": false, @@ -2414,7 +2414,7 @@ "signature": [ "({ _version, id, value, meta, }: ", "UpdateListItemOptions", - ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; value: string; } | null>" + ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; value: string; } | null>" ], "path": "x-pack/plugins/lists/server/services/lists/list_client.ts", "deprecated": false, @@ -2448,7 +2448,7 @@ "signature": [ "({ _version, id, name, description, meta, version, }: ", "UpdateListOptions", - ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; version: number; } | null>" + ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; } | null>" ], "path": "x-pack/plugins/lists/server/services/lists/list_client.ts", "deprecated": false, @@ -2482,7 +2482,7 @@ "signature": [ "({ id }: ", "GetListItemOptions", - ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; value: string; } | null>" + ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; value: string; } | null>" ], "path": "x-pack/plugins/lists/server/services/lists/list_client.ts", "deprecated": false, @@ -2518,7 +2518,7 @@ "signature": [ "({ type, listId, value, }: ", "GetListItemsByValueOptions", - ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; value: string; }[]>" + ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; value: string; }[]>" ], "path": "x-pack/plugins/lists/server/services/lists/list_client.ts", "deprecated": false, @@ -2554,7 +2554,7 @@ "signature": [ "({ type, listId, value, }: ", "SearchListItemByValuesOptions", - ") => Promise<{ items: { _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; value: string; }[]; value: unknown; }[]>" + ") => Promise<{ items: { _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; value: string; }[]; value: unknown; }[]>" ], "path": "x-pack/plugins/lists/server/services/lists/list_client.ts", "deprecated": false, @@ -2590,7 +2590,7 @@ "signature": [ "({ filter, currentIndexPosition, perPage, page, sortField, sortOrder, searchAfter, }: ", "FindListOptions", - ") => Promise<{ cursor: string; data: { _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; version: number; }[]; page: number; per_page: number; total: number; }>" + ") => Promise<{ cursor: string; data: { _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; }[]; page: number; per_page: number; total: number; }>" ], "path": "x-pack/plugins/lists/server/services/lists/list_client.ts", "deprecated": false, @@ -2626,7 +2626,7 @@ "signature": [ "({ listId, filter, currentIndexPosition, perPage, page, sortField, sortOrder, searchAfter, }: ", "FindListItemOptions", - ") => Promise<{ cursor: string; data: { _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; value: string; }[]; page: number; per_page: number; total: number; } | null>" + ") => Promise<{ cursor: string; data: { _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; value: string; }[]; page: number; per_page: number; total: number; } | null>" ], "path": "x-pack/plugins/lists/server/services/lists/list_client.ts", "deprecated": false, @@ -2693,7 +2693,7 @@ "an array with the exception list item entries" ], "signature": [ - "({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]" + "({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]" ], "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client_types.ts", "deprecated": false @@ -2985,7 +2985,7 @@ "item exception entries logic" ], "signature": [ - "({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]" + "({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]" ], "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client_types.ts", "deprecated": false diff --git a/api_docs/lists.mdx b/api_docs/lists.mdx index 87a2b53d3c9641..90b523587adb0e 100644 --- a/api_docs/lists.mdx +++ b/api_docs/lists.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/lists title: "lists" image: https://source.unsplash.com/400x175/?github summary: API docs for the lists plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'lists'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/management.mdx b/api_docs/management.mdx index 0c62b6c8f41e23..198d5440540379 100644 --- a/api_docs/management.mdx +++ b/api_docs/management.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/management title: "management" image: https://source.unsplash.com/400x175/?github summary: API docs for the management plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'management'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/maps.mdx b/api_docs/maps.mdx index 70c0c168266f36..76c093caacaa0e 100644 --- a/api_docs/maps.mdx +++ b/api_docs/maps.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/maps title: "maps" image: https://source.unsplash.com/400x175/?github summary: API docs for the maps plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'maps'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/maps_ems.mdx b/api_docs/maps_ems.mdx index eb70963bb6e732..0cef11acb0d32e 100644 --- a/api_docs/maps_ems.mdx +++ b/api_docs/maps_ems.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/mapsEms title: "mapsEms" image: https://source.unsplash.com/400x175/?github summary: API docs for the mapsEms plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'mapsEms'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/ml.mdx b/api_docs/ml.mdx index d7077b822f23f9..97755c5e68f37b 100644 --- a/api_docs/ml.mdx +++ b/api_docs/ml.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/ml title: "ml" image: https://source.unsplash.com/400x175/?github summary: API docs for the ml plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'ml'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/monitoring.mdx b/api_docs/monitoring.mdx index 2a7d8b6d026070..e5952293eb66e7 100644 --- a/api_docs/monitoring.mdx +++ b/api_docs/monitoring.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/monitoring title: "monitoring" image: https://source.unsplash.com/400x175/?github summary: API docs for the monitoring plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'monitoring'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/monitoring_collection.mdx b/api_docs/monitoring_collection.mdx index f75527b21b6358..959ff3cde297a5 100644 --- a/api_docs/monitoring_collection.mdx +++ b/api_docs/monitoring_collection.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/monitoringCollection title: "monitoringCollection" image: https://source.unsplash.com/400x175/?github summary: API docs for the monitoringCollection plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'monitoringCollection'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/navigation.mdx b/api_docs/navigation.mdx index bbe1bd669c088f..6e33be38ffe354 100644 --- a/api_docs/navigation.mdx +++ b/api_docs/navigation.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/navigation title: "navigation" image: https://source.unsplash.com/400x175/?github summary: API docs for the navigation plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'navigation'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/newsfeed.mdx b/api_docs/newsfeed.mdx index 77621c025af10c..4daf3e0bcfebbb 100644 --- a/api_docs/newsfeed.mdx +++ b/api_docs/newsfeed.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/newsfeed title: "newsfeed" image: https://source.unsplash.com/400x175/?github summary: API docs for the newsfeed plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'newsfeed'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/observability.devdocs.json b/api_docs/observability.devdocs.json index 1c935afbcebc30..bd2a33eaf82212 100644 --- a/api_docs/observability.devdocs.json +++ b/api_docs/observability.devdocs.json @@ -101,7 +101,7 @@ }, "; }, baseHref: string, appId: string) => string" ], - "path": "x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/utils.ts", + "path": "x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/exploratory_view_url.ts", "deprecated": false, "children": [ { @@ -111,7 +111,7 @@ "tags": [], "label": "{ reportType, allSeries }", "description": [], - "path": "x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/utils.ts", + "path": "x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/exploratory_view_url.ts", "deprecated": false, "children": [ { @@ -122,9 +122,9 @@ "label": "reportType", "description": [], "signature": [ - "\"data-distribution\" | \"kpi-over-time\" | \"core-web-vitals\" | \"device-data-distribution\"" + "\"data-distribution\" | \"kpi-over-time\" | \"core-web-vitals\" | \"device-data-distribution\" | \"single-metric\"" ], - "path": "x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/utils.ts", + "path": "x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/exploratory_view_url.ts", "deprecated": false }, { @@ -144,7 +144,7 @@ }, "[]" ], - "path": "x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/utils.ts", + "path": "x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/exploratory_view_url.ts", "deprecated": false } ] @@ -159,7 +159,7 @@ "signature": [ "string" ], - "path": "x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/utils.ts", + "path": "x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/exploratory_view_url.ts", "deprecated": false, "isRequired": true }, @@ -173,7 +173,7 @@ "signature": [ "string" ], - "path": "x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/utils.ts", + "path": "x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/exploratory_view_url.ts", "deprecated": false, "isRequired": true } @@ -363,7 +363,7 @@ "label": "ExploratoryViewContextProvider", "description": [], "signature": [ - "({\n children,\n reportTypes,\n dataTypes,\n dataViews,\n reportConfigMap,\n setHeaderActionMenu,\n theme$,\n}: { children: JSX.Element; } & ExploratoryViewContextValue) => JSX.Element" + "({\n children,\n reportTypes,\n dataTypes,\n dataViews,\n reportConfigMap,\n setHeaderActionMenu,\n asPanel = true,\n theme$,\n}: { children: JSX.Element; } & ExploratoryViewContextValue) => JSX.Element" ], "path": "x-pack/plugins/observability/public/components/shared/exploratory_view/contexts/exploratory_view_config.tsx", "deprecated": false, @@ -373,7 +373,7 @@ "id": "def-public.ExploratoryViewContextProvider.$1", "type": "CompoundType", "tags": [], - "label": "{\n children,\n reportTypes,\n dataTypes,\n dataViews,\n reportConfigMap,\n setHeaderActionMenu,\n theme$,\n}", + "label": "{\n children,\n reportTypes,\n dataTypes,\n dataViews,\n reportConfigMap,\n setHeaderActionMenu,\n asPanel = true,\n theme$,\n}", "description": [], "signature": [ "{ children: JSX.Element; } & ExploratoryViewContextValue" @@ -678,9 +678,9 @@ }, " | undefined; list: () => string[]; }; selectedAlertId?: string | undefined; } & ", "CommonProps", - " & { as?: \"div\" | undefined; } & _EuiFlyoutProps & Omit, HTMLDivElement>, keyof _EuiFlyoutProps> & Omit, HTMLDivElement>, \"key\" | \"css\" | keyof React.HTMLAttributes> & { ref?: React.RefObject | ((instance: HTMLDivElement | null) => void) | null | undefined; }, \"children\" | \"color\" | \"title\" | \"onChange\" | \"onKeyDown\" | \"onClick\" | \"id\" | \"security\" | \"defaultValue\" | \"hidden\" | \"defaultChecked\" | \"suppressContentEditableWarning\" | \"suppressHydrationWarning\" | \"accessKey\" | \"contentEditable\" | \"contextMenu\" | \"dir\" | \"draggable\" | \"lang\" | \"placeholder\" | \"slot\" | \"spellCheck\" | \"tabIndex\" | \"translate\" | \"radioGroup\" | \"about\" | \"datatype\" | \"inlist\" | \"prefix\" | \"property\" | \"resource\" | \"typeof\" | \"vocab\" | \"autoCapitalize\" | \"autoCorrect\" | \"autoSave\" | \"itemProp\" | \"itemScope\" | \"itemType\" | \"itemID\" | \"itemRef\" | \"results\" | \"unselectable\" | \"inputMode\" | \"is\" | \"aria-activedescendant\" | \"aria-atomic\" | \"aria-autocomplete\" | \"aria-busy\" | \"aria-checked\" | \"aria-colcount\" | \"aria-colindex\" | \"aria-colspan\" | \"aria-controls\" | \"aria-current\" | \"aria-describedby\" | \"aria-details\" | \"aria-disabled\" | \"aria-dropeffect\" | \"aria-errormessage\" | \"aria-expanded\" | \"aria-flowto\" | \"aria-grabbed\" | \"aria-haspopup\" | \"aria-hidden\" | \"aria-invalid\" | \"aria-keyshortcuts\" | \"aria-labelledby\" | \"aria-level\" | \"aria-live\" | \"aria-modal\" | \"aria-multiline\" | \"aria-multiselectable\" | \"aria-orientation\" | \"aria-owns\" | \"aria-placeholder\" | \"aria-posinset\" | \"aria-pressed\" | \"aria-readonly\" | \"aria-relevant\" | \"aria-required\" | \"aria-roledescription\" | \"aria-rowcount\" | \"aria-rowindex\" | \"aria-rowspan\" | \"aria-selected\" | \"aria-setsize\" | \"aria-sort\" | \"aria-valuemax\" | \"aria-valuemin\" | \"aria-valuenow\" | \"aria-valuetext\" | \"dangerouslySetInnerHTML\" | \"onCopy\" | \"onCopyCapture\" | \"onCut\" | \"onCutCapture\" | \"onPaste\" | \"onPasteCapture\" | \"onCompositionEnd\" | \"onCompositionEndCapture\" | \"onCompositionStart\" | \"onCompositionStartCapture\" | \"onCompositionUpdate\" | \"onCompositionUpdateCapture\" | \"onFocus\" | \"onFocusCapture\" | \"onBlur\" | \"onBlurCapture\" | \"onChangeCapture\" | \"onBeforeInput\" | \"onBeforeInputCapture\" | \"onInput\" | \"onInputCapture\" | \"onReset\" | \"onResetCapture\" | \"onSubmit\" | \"onSubmitCapture\" | \"onInvalid\" | \"onInvalidCapture\" | \"onLoad\" | \"onLoadCapture\" | \"onError\" | \"onErrorCapture\" | \"onKeyDownCapture\" | \"onKeyPress\" | \"onKeyPressCapture\" | \"onKeyUp\" | \"onKeyUpCapture\" | \"onAbort\" | \"onAbortCapture\" | \"onCanPlay\" | \"onCanPlayCapture\" | \"onCanPlayThrough\" | \"onCanPlayThroughCapture\" | \"onDurationChange\" | \"onDurationChangeCapture\" | \"onEmptied\" | \"onEmptiedCapture\" | \"onEncrypted\" | \"onEncryptedCapture\" | \"onEnded\" | \"onEndedCapture\" | \"onLoadedData\" | \"onLoadedDataCapture\" | \"onLoadedMetadata\" | \"onLoadedMetadataCapture\" | \"onLoadStart\" | \"onLoadStartCapture\" | \"onPause\" | \"onPauseCapture\" | \"onPlay\" | \"onPlayCapture\" | \"onPlaying\" | \"onPlayingCapture\" | \"onProgress\" | \"onProgressCapture\" | \"onRateChange\" | \"onRateChangeCapture\" | \"onSeeked\" | \"onSeekedCapture\" | \"onSeeking\" | \"onSeekingCapture\" | \"onStalled\" | \"onStalledCapture\" | \"onSuspend\" | \"onSuspendCapture\" | \"onTimeUpdate\" | \"onTimeUpdateCapture\" | \"onVolumeChange\" | \"onVolumeChangeCapture\" | \"onWaiting\" | \"onWaitingCapture\" | \"onAuxClick\" | \"onAuxClickCapture\" | \"onClickCapture\" | \"onContextMenu\" | \"onContextMenuCapture\" | \"onDoubleClick\" | \"onDoubleClickCapture\" | \"onDrag\" | \"onDragCapture\" | \"onDragEnd\" | \"onDragEndCapture\" | \"onDragEnter\" | \"onDragEnterCapture\" | \"onDragExit\" | \"onDragExitCapture\" | \"onDragLeave\" | \"onDragLeaveCapture\" | \"onDragOver\" | \"onDragOverCapture\" | \"onDragStart\" | \"onDragStartCapture\" | \"onDrop\" | \"onDropCapture\" | \"onMouseDown\" | \"onMouseDownCapture\" | \"onMouseEnter\" | \"onMouseLeave\" | \"onMouseMove\" | \"onMouseMoveCapture\" | \"onMouseOut\" | \"onMouseOutCapture\" | \"onMouseOver\" | \"onMouseOverCapture\" | \"onMouseUp\" | \"onMouseUpCapture\" | \"onSelect\" | \"onSelectCapture\" | \"onTouchCancel\" | \"onTouchCancelCapture\" | \"onTouchEnd\" | \"onTouchEndCapture\" | \"onTouchMove\" | \"onTouchMoveCapture\" | \"onTouchStart\" | \"onTouchStartCapture\" | \"onPointerDown\" | \"onPointerDownCapture\" | \"onPointerMove\" | \"onPointerMoveCapture\" | \"onPointerUp\" | \"onPointerUpCapture\" | \"onPointerCancel\" | \"onPointerCancelCapture\" | \"onPointerEnter\" | \"onPointerEnterCapture\" | \"onPointerLeave\" | \"onPointerLeaveCapture\" | \"onPointerOver\" | \"onPointerOverCapture\" | \"onPointerOut\" | \"onPointerOutCapture\" | \"onGotPointerCapture\" | \"onGotPointerCaptureCapture\" | \"onLostPointerCapture\" | \"onLostPointerCaptureCapture\" | \"onScroll\" | \"onScrollCapture\" | \"onWheel\" | \"onWheelCapture\" | \"onAnimationStart\" | \"onAnimationStartCapture\" | \"onAnimationEnd\" | \"onAnimationEndCapture\" | \"onAnimationIteration\" | \"onAnimationIterationCapture\" | \"onTransitionEnd\" | \"onTransitionEndCapture\" | \"as\" | keyof ", + " & { as?: \"div\" | undefined; } & _EuiFlyoutProps & Omit, HTMLDivElement>, keyof _EuiFlyoutProps> & Omit, HTMLDivElement>, \"key\" | \"css\" | keyof React.HTMLAttributes> & { ref?: React.RefObject | ((instance: HTMLDivElement | null) => void) | null | undefined; }, \"children\" | \"color\" | \"title\" | \"onChange\" | \"onKeyDown\" | \"onClick\" | \"id\" | \"security\" | \"defaultValue\" | \"hidden\" | \"lang\" | \"onError\" | \"defaultChecked\" | \"suppressContentEditableWarning\" | \"suppressHydrationWarning\" | \"accessKey\" | \"contentEditable\" | \"contextMenu\" | \"dir\" | \"draggable\" | \"placeholder\" | \"slot\" | \"spellCheck\" | \"tabIndex\" | \"translate\" | \"radioGroup\" | \"about\" | \"datatype\" | \"inlist\" | \"prefix\" | \"property\" | \"resource\" | \"typeof\" | \"vocab\" | \"autoCapitalize\" | \"autoCorrect\" | \"autoSave\" | \"itemProp\" | \"itemScope\" | \"itemType\" | \"itemID\" | \"itemRef\" | \"results\" | \"unselectable\" | \"inputMode\" | \"is\" | \"aria-activedescendant\" | \"aria-atomic\" | \"aria-autocomplete\" | \"aria-busy\" | \"aria-checked\" | \"aria-colcount\" | \"aria-colindex\" | \"aria-colspan\" | \"aria-controls\" | \"aria-current\" | \"aria-describedby\" | \"aria-details\" | \"aria-disabled\" | \"aria-dropeffect\" | \"aria-errormessage\" | \"aria-expanded\" | \"aria-flowto\" | \"aria-grabbed\" | \"aria-haspopup\" | \"aria-hidden\" | \"aria-invalid\" | \"aria-keyshortcuts\" | \"aria-labelledby\" | \"aria-level\" | \"aria-live\" | \"aria-modal\" | \"aria-multiline\" | \"aria-multiselectable\" | \"aria-orientation\" | \"aria-owns\" | \"aria-placeholder\" | \"aria-posinset\" | \"aria-pressed\" | \"aria-readonly\" | \"aria-relevant\" | \"aria-required\" | \"aria-roledescription\" | \"aria-rowcount\" | \"aria-rowindex\" | \"aria-rowspan\" | \"aria-selected\" | \"aria-setsize\" | \"aria-sort\" | \"aria-valuemax\" | \"aria-valuemin\" | \"aria-valuenow\" | \"aria-valuetext\" | \"dangerouslySetInnerHTML\" | \"onCopy\" | \"onCopyCapture\" | \"onCut\" | \"onCutCapture\" | \"onPaste\" | \"onPasteCapture\" | \"onCompositionEnd\" | \"onCompositionEndCapture\" | \"onCompositionStart\" | \"onCompositionStartCapture\" | \"onCompositionUpdate\" | \"onCompositionUpdateCapture\" | \"onFocus\" | \"onFocusCapture\" | \"onBlur\" | \"onBlurCapture\" | \"onChangeCapture\" | \"onBeforeInput\" | \"onBeforeInputCapture\" | \"onInput\" | \"onInputCapture\" | \"onReset\" | \"onResetCapture\" | \"onSubmit\" | \"onSubmitCapture\" | \"onInvalid\" | \"onInvalidCapture\" | \"onLoad\" | \"onLoadCapture\" | \"onErrorCapture\" | \"onKeyDownCapture\" | \"onKeyPress\" | \"onKeyPressCapture\" | \"onKeyUp\" | \"onKeyUpCapture\" | \"onAbort\" | \"onAbortCapture\" | \"onCanPlay\" | \"onCanPlayCapture\" | \"onCanPlayThrough\" | \"onCanPlayThroughCapture\" | \"onDurationChange\" | \"onDurationChangeCapture\" | \"onEmptied\" | \"onEmptiedCapture\" | \"onEncrypted\" | \"onEncryptedCapture\" | \"onEnded\" | \"onEndedCapture\" | \"onLoadedData\" | \"onLoadedDataCapture\" | \"onLoadedMetadata\" | \"onLoadedMetadataCapture\" | \"onLoadStart\" | \"onLoadStartCapture\" | \"onPause\" | \"onPauseCapture\" | \"onPlay\" | \"onPlayCapture\" | \"onPlaying\" | \"onPlayingCapture\" | \"onProgress\" | \"onProgressCapture\" | \"onRateChange\" | \"onRateChangeCapture\" | \"onSeeked\" | \"onSeekedCapture\" | \"onSeeking\" | \"onSeekingCapture\" | \"onStalled\" | \"onStalledCapture\" | \"onSuspend\" | \"onSuspendCapture\" | \"onTimeUpdate\" | \"onTimeUpdateCapture\" | \"onVolumeChange\" | \"onVolumeChangeCapture\" | \"onWaiting\" | \"onWaitingCapture\" | \"onAuxClick\" | \"onAuxClickCapture\" | \"onClickCapture\" | \"onContextMenu\" | \"onContextMenuCapture\" | \"onDoubleClick\" | \"onDoubleClickCapture\" | \"onDrag\" | \"onDragCapture\" | \"onDragEnd\" | \"onDragEndCapture\" | \"onDragEnter\" | \"onDragEnterCapture\" | \"onDragExit\" | \"onDragExitCapture\" | \"onDragLeave\" | \"onDragLeaveCapture\" | \"onDragOver\" | \"onDragOverCapture\" | \"onDragStart\" | \"onDragStartCapture\" | \"onDrop\" | \"onDropCapture\" | \"onMouseDown\" | \"onMouseDownCapture\" | \"onMouseEnter\" | \"onMouseLeave\" | \"onMouseMove\" | \"onMouseMoveCapture\" | \"onMouseOut\" | \"onMouseOutCapture\" | \"onMouseOver\" | \"onMouseOverCapture\" | \"onMouseUp\" | \"onMouseUpCapture\" | \"onSelect\" | \"onSelectCapture\" | \"onTouchCancel\" | \"onTouchCancelCapture\" | \"onTouchEnd\" | \"onTouchEndCapture\" | \"onTouchMove\" | \"onTouchMoveCapture\" | \"onTouchStart\" | \"onTouchStartCapture\" | \"onPointerDown\" | \"onPointerDownCapture\" | \"onPointerMove\" | \"onPointerMoveCapture\" | \"onPointerUp\" | \"onPointerUpCapture\" | \"onPointerCancel\" | \"onPointerCancelCapture\" | \"onPointerEnter\" | \"onPointerEnterCapture\" | \"onPointerLeave\" | \"onPointerLeaveCapture\" | \"onPointerOver\" | \"onPointerOverCapture\" | \"onPointerOut\" | \"onPointerOutCapture\" | \"onGotPointerCapture\" | \"onGotPointerCaptureCapture\" | \"onLostPointerCapture\" | \"onLostPointerCaptureCapture\" | \"onScroll\" | \"onScrollCapture\" | \"onWheel\" | \"onWheelCapture\" | \"onAnimationStart\" | \"onAnimationStartCapture\" | \"onAnimationEnd\" | \"onAnimationEndCapture\" | \"onAnimationIteration\" | \"onAnimationIterationCapture\" | \"onTransitionEnd\" | \"onTransitionEndCapture\" | \"as\" | keyof ", "CommonProps", - " | keyof React.ClassAttributes | keyof _EuiFlyoutProps>, \"children\" | \"alert\" | \"color\" | \"title\" | \"onChange\" | \"onKeyDown\" | \"onClick\" | \"key\" | \"id\" | \"css\" | \"security\" | \"defaultValue\" | \"hidden\" | \"defaultChecked\" | \"suppressContentEditableWarning\" | \"suppressHydrationWarning\" | \"accessKey\" | \"contentEditable\" | \"contextMenu\" | \"dir\" | \"draggable\" | \"lang\" | \"placeholder\" | \"slot\" | \"spellCheck\" | \"tabIndex\" | \"translate\" | \"radioGroup\" | \"about\" | \"datatype\" | \"inlist\" | \"prefix\" | \"property\" | \"resource\" | \"typeof\" | \"vocab\" | \"autoCapitalize\" | \"autoCorrect\" | \"autoSave\" | \"itemProp\" | \"itemScope\" | \"itemType\" | \"itemID\" | \"itemRef\" | \"results\" | \"unselectable\" | \"inputMode\" | \"is\" | \"aria-activedescendant\" | \"aria-atomic\" | \"aria-autocomplete\" | \"aria-busy\" | \"aria-checked\" | \"aria-colcount\" | \"aria-colindex\" | \"aria-colspan\" | \"aria-controls\" | \"aria-current\" | \"aria-describedby\" | \"aria-details\" | \"aria-disabled\" | \"aria-dropeffect\" | \"aria-errormessage\" | \"aria-expanded\" | \"aria-flowto\" | \"aria-grabbed\" | \"aria-haspopup\" | \"aria-hidden\" | \"aria-invalid\" | \"aria-keyshortcuts\" | \"aria-labelledby\" | \"aria-level\" | \"aria-live\" | \"aria-modal\" | \"aria-multiline\" | \"aria-multiselectable\" | \"aria-orientation\" | \"aria-owns\" | \"aria-placeholder\" | \"aria-posinset\" | \"aria-pressed\" | \"aria-readonly\" | \"aria-relevant\" | \"aria-required\" | \"aria-roledescription\" | \"aria-rowcount\" | \"aria-rowindex\" | \"aria-rowspan\" | \"aria-selected\" | \"aria-setsize\" | \"aria-sort\" | \"aria-valuemax\" | \"aria-valuemin\" | \"aria-valuenow\" | \"aria-valuetext\" | \"dangerouslySetInnerHTML\" | \"onCopy\" | \"onCopyCapture\" | \"onCut\" | \"onCutCapture\" | \"onPaste\" | \"onPasteCapture\" | \"onCompositionEnd\" | \"onCompositionEndCapture\" | \"onCompositionStart\" | \"onCompositionStartCapture\" | \"onCompositionUpdate\" | \"onCompositionUpdateCapture\" | \"onFocus\" | \"onFocusCapture\" | \"onBlur\" | \"onBlurCapture\" | \"onChangeCapture\" | \"onBeforeInput\" | \"onBeforeInputCapture\" | \"onInput\" | \"onInputCapture\" | \"onReset\" | \"onResetCapture\" | \"onSubmit\" | \"onSubmitCapture\" | \"onInvalid\" | \"onInvalidCapture\" | \"onLoad\" | \"onLoadCapture\" | \"onError\" | \"onErrorCapture\" | \"onKeyDownCapture\" | \"onKeyPress\" | \"onKeyPressCapture\" | \"onKeyUp\" | \"onKeyUpCapture\" | \"onAbort\" | \"onAbortCapture\" | \"onCanPlay\" | \"onCanPlayCapture\" | \"onCanPlayThrough\" | \"onCanPlayThroughCapture\" | \"onDurationChange\" | \"onDurationChangeCapture\" | \"onEmptied\" | \"onEmptiedCapture\" | \"onEncrypted\" | \"onEncryptedCapture\" | \"onEnded\" | \"onEndedCapture\" | \"onLoadedData\" | \"onLoadedDataCapture\" | \"onLoadedMetadata\" | \"onLoadedMetadataCapture\" | \"onLoadStart\" | \"onLoadStartCapture\" | \"onPause\" | \"onPauseCapture\" | \"onPlay\" | \"onPlayCapture\" | \"onPlaying\" | \"onPlayingCapture\" | \"onProgress\" | \"onProgressCapture\" | \"onRateChange\" | \"onRateChangeCapture\" | \"onSeeked\" | \"onSeekedCapture\" | \"onSeeking\" | \"onSeekingCapture\" | \"onStalled\" | \"onStalledCapture\" | \"onSuspend\" | \"onSuspendCapture\" | \"onTimeUpdate\" | \"onTimeUpdateCapture\" | \"onVolumeChange\" | \"onVolumeChangeCapture\" | \"onWaiting\" | \"onWaitingCapture\" | \"onAuxClick\" | \"onAuxClickCapture\" | \"onClickCapture\" | \"onContextMenu\" | \"onContextMenuCapture\" | \"onDoubleClick\" | \"onDoubleClickCapture\" | \"onDrag\" | \"onDragCapture\" | \"onDragEnd\" | \"onDragEndCapture\" | \"onDragEnter\" | \"onDragEnterCapture\" | \"onDragExit\" | \"onDragExitCapture\" | \"onDragLeave\" | \"onDragLeaveCapture\" | \"onDragOver\" | \"onDragOverCapture\" | \"onDragStart\" | \"onDragStartCapture\" | \"onDrop\" | \"onDropCapture\" | \"onMouseDown\" | \"onMouseDownCapture\" | \"onMouseEnter\" | \"onMouseLeave\" | \"onMouseMove\" | \"onMouseMoveCapture\" | \"onMouseOut\" | \"onMouseOutCapture\" | \"onMouseOver\" | \"onMouseOverCapture\" | \"onMouseUp\" | \"onMouseUpCapture\" | \"onSelect\" | \"onSelectCapture\" | \"onTouchCancel\" | \"onTouchCancelCapture\" | \"onTouchEnd\" | \"onTouchEndCapture\" | \"onTouchMove\" | \"onTouchMoveCapture\" | \"onTouchStart\" | \"onTouchStartCapture\" | \"onPointerDown\" | \"onPointerDownCapture\" | \"onPointerMove\" | \"onPointerMoveCapture\" | \"onPointerUp\" | \"onPointerUpCapture\" | \"onPointerCancel\" | \"onPointerCancelCapture\" | \"onPointerEnter\" | \"onPointerEnterCapture\" | \"onPointerLeave\" | \"onPointerLeaveCapture\" | \"onPointerOver\" | \"onPointerOverCapture\" | \"onPointerOut\" | \"onPointerOutCapture\" | \"onGotPointerCapture\" | \"onGotPointerCaptureCapture\" | \"onLostPointerCapture\" | \"onLostPointerCaptureCapture\" | \"onScroll\" | \"onScrollCapture\" | \"onWheel\" | \"onWheelCapture\" | \"onAnimationStart\" | \"onAnimationStartCapture\" | \"onAnimationEnd\" | \"onAnimationEndCapture\" | \"onAnimationIteration\" | \"onAnimationIterationCapture\" | \"onTransitionEnd\" | \"onTransitionEndCapture\" | \"as\" | keyof ", + " | keyof React.ClassAttributes | keyof _EuiFlyoutProps>, \"children\" | \"alert\" | \"color\" | \"title\" | \"onChange\" | \"onKeyDown\" | \"onClick\" | \"key\" | \"id\" | \"css\" | \"security\" | \"defaultValue\" | \"hidden\" | \"lang\" | \"onError\" | \"defaultChecked\" | \"suppressContentEditableWarning\" | \"suppressHydrationWarning\" | \"accessKey\" | \"contentEditable\" | \"contextMenu\" | \"dir\" | \"draggable\" | \"placeholder\" | \"slot\" | \"spellCheck\" | \"tabIndex\" | \"translate\" | \"radioGroup\" | \"about\" | \"datatype\" | \"inlist\" | \"prefix\" | \"property\" | \"resource\" | \"typeof\" | \"vocab\" | \"autoCapitalize\" | \"autoCorrect\" | \"autoSave\" | \"itemProp\" | \"itemScope\" | \"itemType\" | \"itemID\" | \"itemRef\" | \"results\" | \"unselectable\" | \"inputMode\" | \"is\" | \"aria-activedescendant\" | \"aria-atomic\" | \"aria-autocomplete\" | \"aria-busy\" | \"aria-checked\" | \"aria-colcount\" | \"aria-colindex\" | \"aria-colspan\" | \"aria-controls\" | \"aria-current\" | \"aria-describedby\" | \"aria-details\" | \"aria-disabled\" | \"aria-dropeffect\" | \"aria-errormessage\" | \"aria-expanded\" | \"aria-flowto\" | \"aria-grabbed\" | \"aria-haspopup\" | \"aria-hidden\" | \"aria-invalid\" | \"aria-keyshortcuts\" | \"aria-labelledby\" | \"aria-level\" | \"aria-live\" | \"aria-modal\" | \"aria-multiline\" | \"aria-multiselectable\" | \"aria-orientation\" | \"aria-owns\" | \"aria-placeholder\" | \"aria-posinset\" | \"aria-pressed\" | \"aria-readonly\" | \"aria-relevant\" | \"aria-required\" | \"aria-roledescription\" | \"aria-rowcount\" | \"aria-rowindex\" | \"aria-rowspan\" | \"aria-selected\" | \"aria-setsize\" | \"aria-sort\" | \"aria-valuemax\" | \"aria-valuemin\" | \"aria-valuenow\" | \"aria-valuetext\" | \"dangerouslySetInnerHTML\" | \"onCopy\" | \"onCopyCapture\" | \"onCut\" | \"onCutCapture\" | \"onPaste\" | \"onPasteCapture\" | \"onCompositionEnd\" | \"onCompositionEndCapture\" | \"onCompositionStart\" | \"onCompositionStartCapture\" | \"onCompositionUpdate\" | \"onCompositionUpdateCapture\" | \"onFocus\" | \"onFocusCapture\" | \"onBlur\" | \"onBlurCapture\" | \"onChangeCapture\" | \"onBeforeInput\" | \"onBeforeInputCapture\" | \"onInput\" | \"onInputCapture\" | \"onReset\" | \"onResetCapture\" | \"onSubmit\" | \"onSubmitCapture\" | \"onInvalid\" | \"onInvalidCapture\" | \"onLoad\" | \"onLoadCapture\" | \"onErrorCapture\" | \"onKeyDownCapture\" | \"onKeyPress\" | \"onKeyPressCapture\" | \"onKeyUp\" | \"onKeyUpCapture\" | \"onAbort\" | \"onAbortCapture\" | \"onCanPlay\" | \"onCanPlayCapture\" | \"onCanPlayThrough\" | \"onCanPlayThroughCapture\" | \"onDurationChange\" | \"onDurationChangeCapture\" | \"onEmptied\" | \"onEmptiedCapture\" | \"onEncrypted\" | \"onEncryptedCapture\" | \"onEnded\" | \"onEndedCapture\" | \"onLoadedData\" | \"onLoadedDataCapture\" | \"onLoadedMetadata\" | \"onLoadedMetadataCapture\" | \"onLoadStart\" | \"onLoadStartCapture\" | \"onPause\" | \"onPauseCapture\" | \"onPlay\" | \"onPlayCapture\" | \"onPlaying\" | \"onPlayingCapture\" | \"onProgress\" | \"onProgressCapture\" | \"onRateChange\" | \"onRateChangeCapture\" | \"onSeeked\" | \"onSeekedCapture\" | \"onSeeking\" | \"onSeekingCapture\" | \"onStalled\" | \"onStalledCapture\" | \"onSuspend\" | \"onSuspendCapture\" | \"onTimeUpdate\" | \"onTimeUpdateCapture\" | \"onVolumeChange\" | \"onVolumeChangeCapture\" | \"onWaiting\" | \"onWaitingCapture\" | \"onAuxClick\" | \"onAuxClickCapture\" | \"onClickCapture\" | \"onContextMenu\" | \"onContextMenuCapture\" | \"onDoubleClick\" | \"onDoubleClickCapture\" | \"onDrag\" | \"onDragCapture\" | \"onDragEnd\" | \"onDragEndCapture\" | \"onDragEnter\" | \"onDragEnterCapture\" | \"onDragExit\" | \"onDragExitCapture\" | \"onDragLeave\" | \"onDragLeaveCapture\" | \"onDragOver\" | \"onDragOverCapture\" | \"onDragStart\" | \"onDragStartCapture\" | \"onDrop\" | \"onDropCapture\" | \"onMouseDown\" | \"onMouseDownCapture\" | \"onMouseEnter\" | \"onMouseLeave\" | \"onMouseMove\" | \"onMouseMoveCapture\" | \"onMouseOut\" | \"onMouseOutCapture\" | \"onMouseOver\" | \"onMouseOverCapture\" | \"onMouseUp\" | \"onMouseUpCapture\" | \"onSelect\" | \"onSelectCapture\" | \"onTouchCancel\" | \"onTouchCancelCapture\" | \"onTouchEnd\" | \"onTouchEndCapture\" | \"onTouchMove\" | \"onTouchMoveCapture\" | \"onTouchStart\" | \"onTouchStartCapture\" | \"onPointerDown\" | \"onPointerDownCapture\" | \"onPointerMove\" | \"onPointerMoveCapture\" | \"onPointerUp\" | \"onPointerUpCapture\" | \"onPointerCancel\" | \"onPointerCancelCapture\" | \"onPointerEnter\" | \"onPointerEnterCapture\" | \"onPointerLeave\" | \"onPointerLeaveCapture\" | \"onPointerOver\" | \"onPointerOverCapture\" | \"onPointerOut\" | \"onPointerOutCapture\" | \"onGotPointerCapture\" | \"onGotPointerCaptureCapture\" | \"onLostPointerCapture\" | \"onLostPointerCaptureCapture\" | \"onScroll\" | \"onScrollCapture\" | \"onWheel\" | \"onWheelCapture\" | \"onAnimationStart\" | \"onAnimationStartCapture\" | \"onAnimationEnd\" | \"onAnimationEndCapture\" | \"onAnimationIteration\" | \"onAnimationIterationCapture\" | \"onTransitionEnd\" | \"onTransitionEndCapture\" | \"as\" | keyof ", "CommonProps", " | \"alerts\" | keyof _EuiFlyoutProps | \"isInApp\" | \"observabilityRuleTypeRegistry\" | \"selectedAlertId\"> & { ref?: React.RefObject | ((instance: HTMLDivElement | null) => void) | null | undefined; }> & { readonly _result: ({ alert, alerts, isInApp, observabilityRuleTypeRegistry, onClose, selectedAlertId, }: AlertsFlyoutProps) => JSX.Element | null; }" ], @@ -1704,7 +1704,8 @@ "docId": "kibDataViewsPluginApi", "section": "def-common.DataView", "text": "DataView" - } + }, + " | undefined" ], "path": "x-pack/plugins/observability/public/components/shared/exploratory_view/types.ts", "deprecated": false @@ -2152,7 +2153,7 @@ "label": "reportType", "description": [], "signature": [ - "\"data-distribution\" | \"kpi-over-time\" | \"core-web-vitals\" | \"device-data-distribution\"" + "\"data-distribution\" | \"kpi-over-time\" | \"core-web-vitals\" | \"device-data-distribution\" | \"single-metric\"" ], "path": "x-pack/plugins/observability/public/components/shared/exploratory_view/embeddable/embeddable.tsx", "deprecated": false @@ -3293,7 +3294,13 @@ "label": "dataViews", "description": [], "signature": [ - "DataViewsServicePublic" + { + "pluginId": "dataViews", + "scope": "public", + "docId": "kibDataViewsPluginApi", + "section": "def-public.DataViewsServicePublic", + "text": "DataViewsServicePublic" + } ], "path": "x-pack/plugins/observability/public/plugin.ts", "deprecated": false @@ -3494,13 +3501,10 @@ { "parentPluginId": "observability", "id": "def-public.SeriesConfig.reportType", - "type": "CompoundType", + "type": "string", "tags": [], "label": "reportType", "description": [], - "signature": [ - "\"data-distribution\" | \"kpi-over-time\" | \"core-web-vitals\" | \"device-data-distribution\"" - ], "path": "x-pack/plugins/observability/public/components/shared/exploratory_view/types.ts", "deprecated": false }, @@ -3936,6 +3940,19 @@ "path": "x-pack/plugins/observability/public/components/shared/exploratory_view/types.ts", "deprecated": false }, + { + "parentPluginId": "observability", + "id": "def-public.SeriesUrl.showPercentileAnnotations", + "type": "CompoundType", + "tags": [], + "label": "showPercentileAnnotations", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "x-pack/plugins/observability/public/components/shared/exploratory_view/types.ts", + "deprecated": false + }, { "parentPluginId": "observability", "id": "def-public.SeriesUrl.color", @@ -4373,6 +4390,9 @@ "tags": [], "label": "METRIC_TYPE", "description": [], + "signature": [ + "METRIC_TYPE" + ], "path": "node_modules/@types/kbn__analytics/index.d.ts", "deprecated": false, "initialIsOpen": false @@ -4441,7 +4461,7 @@ "signature": [ "\"ALL_VALUES\"" ], - "path": "x-pack/plugins/observability/public/components/shared/field_value_suggestions/field_value_combobox.tsx", + "path": "x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/constants/url_constants.ts", "deprecated": false, "initialIsOpen": false }, @@ -4488,6 +4508,9 @@ "tags": [], "label": "DropResult", "description": [], + "signature": [ + "DropResult" + ], "path": "x-pack/plugins/observability/public/typings/eui_draggable/index.ts", "deprecated": false, "initialIsOpen": false @@ -4606,6 +4629,20 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "observability", + "id": "def-public.FILTER_RECORDS", + "type": "string", + "tags": [], + "label": "FILTER_RECORDS", + "description": [], + "signature": [ + "\"FILTER_RECORDS\"" + ], + "path": "x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/constants/constants.ts", + "deprecated": false, + "initialIsOpen": false + }, { "parentPluginId": "observability", "id": "def-public.HasData", @@ -4777,6 +4814,20 @@ "deprecated": false, "initialIsOpen": false }, + { + "parentPluginId": "observability", + "id": "def-public.OPERATION_COLUMN", + "type": "string", + "tags": [], + "label": "OPERATION_COLUMN", + "description": [], + "signature": [ + "\"operation\"" + ], + "path": "x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/constants/constants.ts", + "deprecated": false, + "initialIsOpen": false + }, { "parentPluginId": "observability", "id": "def-public.RECORDS_FIELD", @@ -4870,6 +4921,20 @@ "deprecated": false, "initialIsOpen": false }, + { + "parentPluginId": "observability", + "id": "def-public.TERMS_COLUMN", + "type": "string", + "tags": [], + "label": "TERMS_COLUMN", + "description": [], + "signature": [ + "\"TERMS_COLUMN\"" + ], + "path": "x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/constants/constants.ts", + "deprecated": false, + "initialIsOpen": false + }, { "parentPluginId": "observability", "id": "def-public.TrackMetricOptions", @@ -4935,6 +5000,20 @@ "path": "x-pack/plugins/observability/common/index.ts", "deprecated": false, "initialIsOpen": false + }, + { + "parentPluginId": "observability", + "id": "def-public.USE_BREAK_DOWN_COLUMN", + "type": "string", + "tags": [], + "label": "USE_BREAK_DOWN_COLUMN", + "description": [], + "signature": [ + "\"USE_BREAK_DOWN_COLUMN\"" + ], + "path": "x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/constants/constants.ts", + "deprecated": false, + "initialIsOpen": false } ], "objects": [], diff --git a/api_docs/observability.mdx b/api_docs/observability.mdx index 0050a336bfec48..1ed27e3d234964 100644 --- a/api_docs/observability.mdx +++ b/api_docs/observability.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/observability title: "observability" image: https://source.unsplash.com/400x175/?github summary: API docs for the observability plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'observability'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Observability UI](https://github.com/orgs/elastic/teams/observability-u | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 377 | 2 | 374 | 30 | +| 382 | 2 | 379 | 30 | ## Client diff --git a/api_docs/osquery.mdx b/api_docs/osquery.mdx index b965ea5c2de6d1..5638a9fbf81c3a 100644 --- a/api_docs/osquery.mdx +++ b/api_docs/osquery.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/osquery title: "osquery" image: https://source.unsplash.com/400x175/?github summary: API docs for the osquery plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'osquery'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/plugin_directory.mdx b/api_docs/plugin_directory.mdx index 4100d2e76ad44f..ce482ae8d55334 100644 --- a/api_docs/plugin_directory.mdx +++ b/api_docs/plugin_directory.mdx @@ -3,7 +3,7 @@ id: kibDevDocsPluginDirectory slug: /kibana-dev-docs/api-meta/plugin-api-directory title: Directory summary: Directory of public APIs available through plugins or packages. -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -12,13 +12,13 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Count | Plugins or Packages with a
public API | Number of teams | |--------------|----------|------------------------| -| 259 | 210 | 35 | +| 270 | 216 | 35 | ### Public API health stats | API Count | Any Count | Missing comments | Missing exports | |--------------|----------|-----------------|--------| -| 26298 | 171 | 19826 | 1223 | +| 26442 | 167 | 18995 | 860 | ## Plugin Directory @@ -37,22 +37,22 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 29 | 0 | 24 | 0 | | | [Cloud Security Posture](https://github.com/orgs/elastic/teams/cloud-posture-security) | The cloud security posture plugin | 14 | 0 | 14 | 0 | | | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 13 | 0 | 13 | 1 | -| | [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | The Controls Plugin contains embeddable components intended to create a simple query interface for end users, and a powerful editing suite that allows dashboard authors to build controls | 205 | 0 | 199 | 7 | -| | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 2541 | 15 | 977 | 33 | +| | [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | The Controls Plugin contains embeddable components intended to create a simple query interface for end users, and a powerful editing suite that allows dashboard authors to build controls | 206 | 0 | 198 | 7 | +| | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 2524 | 15 | 956 | 33 | | crossClusterReplication | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 0 | 0 | 0 | 0 | | | [Fleet](https://github.com/orgs/elastic/teams/fleet) | Add custom data integrations so they can be displayed in the Fleet integrations app | 101 | 0 | 82 | 1 | | | [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | Adds the Dashboard app to Kibana | 143 | 0 | 141 | 12 | | | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | - | 52 | 0 | 51 | 0 | -| | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Data services are useful for searching and querying data from Elasticsearch. Helpful utilities include: a re-usable react query bar, KQL autocomplete, async search, Data Views (Index Patterns) and field formatters. | 3489 | 38 | 2874 | 20 | +| | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Data services are useful for searching and querying data from Elasticsearch. Helpful utilities include: a re-usable react query bar, KQL autocomplete, async search, Data Views (Index Patterns) and field formatters. | 3402 | 35 | 2521 | 20 | | | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | This plugin provides the ability to create data views via a modal flyout from any kibana app | 14 | 0 | 7 | 0 | | | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Reusable data view field editor across Kibana | 42 | 0 | 37 | 3 | | | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Data view management app | 2 | 0 | 2 | 0 | -| | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Data services are useful for searching and querying data from Elasticsearch. Helpful utilities include: a re-usable react query bar, KQL autocomplete, async search, Data Views (Index Patterns) and field formatters. | 866 | 3 | 714 | 15 | +| | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Data services are useful for searching and querying data from Elasticsearch. Helpful utilities include: a re-usable react query bar, KQL autocomplete, async search, Data Views (Index Patterns) and field formatters. | 987 | 1 | 187 | 1 | | | [Machine Learning UI](https://github.com/orgs/elastic/teams/ml-ui) | The Data Visualizer tools help you understand your data, by analyzing the metrics and fields in a log file or an existing Elasticsearch index. | 28 | 3 | 24 | 1 | | | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 10 | 0 | 8 | 2 | | | [Data Discovery](https://github.com/orgs/elastic/teams/kibana-data-discovery) | This plugin contains the Discover application and the saved search embeddable. | 78 | 0 | 62 | 7 | | | [Data Discovery](https://github.com/orgs/elastic/teams/kibana-data-discovery) | - | 37 | 0 | 35 | 2 | -| | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Adds embeddables service to Kibana | 486 | 0 | 396 | 3 | +| | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Adds embeddables service to Kibana | 487 | 0 | 397 | 3 | | | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Extends embeddable plugin with more functionality | 14 | 0 | 14 | 0 | | | [Platform Security](https://github.com/orgs/elastic/teams/kibana-security) | This plugin provides encryption and decryption utilities for saved objects containing sensitive information. | 51 | 0 | 44 | 0 | | | [Enterprise Search](https://github.com/orgs/elastic/teams/enterprise-search-frontend) | Adds dashboards for discovering and managing Enterprise Search products. | 2 | 0 | 2 | 0 | @@ -70,12 +70,12 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | Adds 'revealImage' function and renderer to expressions | 14 | 0 | 14 | 3 | | | [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | Adds 'shape' function and renderer to expressions | 148 | 0 | 146 | 0 | | | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Expression Tagcloud plugin adds a `tagcloud` renderer and function to the expression plugin. The renderer will display the `Wordcloud` chart. | 7 | 0 | 7 | 0 | -| | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Expression XY plugin adds a `xy` renderer and function to the expression plugin. The renderer will display the `xy` chart. | 143 | 0 | 133 | 14 | +| | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Expression XY plugin adds a `xy` renderer and function to the expression plugin. The renderer will display the `xy` chart. | 147 | 0 | 137 | 14 | | | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Adds expression runtime to Kibana | 2176 | 17 | 1722 | 5 | | | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 222 | 0 | 95 | 2 | -| | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Index pattern fields and ambiguous values formatters | 290 | 6 | 251 | 3 | +| | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Index pattern fields and ambiguous values formatters | 294 | 5 | 255 | 3 | | | [Machine Learning UI](https://github.com/orgs/elastic/teams/ml-ui) | The file upload plugin contains components and services for uploading a file, analyzing its data, and then importing the data into an Elasticsearch index. Supported file types include CSV, TSV, newline-delimited JSON and GeoJSON. | 62 | 0 | 62 | 2 | -| | [Fleet](https://github.com/orgs/elastic/teams/fleet) | - | 1404 | 8 | 1282 | 10 | +| | [Fleet](https://github.com/orgs/elastic/teams/fleet) | - | 1427 | 8 | 1300 | 10 | | | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 68 | 0 | 14 | 5 | | globalSearchBar | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 0 | 0 | 0 | 0 | | globalSearchProviders | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 0 | 0 | 0 | 0 | @@ -90,10 +90,11 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | - | 123 | 2 | 96 | 4 | | | [Platform Security](https://github.com/orgs/elastic/teams/kibana-security) | This plugin provides UI and APIs for the interactive setup mode. | 28 | 0 | 18 | 0 | | | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 6 | 0 | 6 | 0 | -| | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | - | 250 | 0 | 213 | 5 | +| | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | - | 251 | 0 | 214 | 5 | | kibanaUsageCollection | [Kibana Telemetry](https://github.com/orgs/elastic/teams/kibana-telemetry) | - | 0 | 0 | 0 | 0 | | | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | - | 615 | 3 | 420 | 9 | -| | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Visualization editor allowing to quickly and easily configure compelling visualizations to use on dashboards and canvas workpads. Exposes components to embed visualizations and link into the Lens editor from within other apps in Kibana. | 574 | 0 | 497 | 35 | +| | [Security Team](https://github.com/orgs/elastic/teams/security-team) | - | 3 | 0 | 3 | 1 | +| | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Visualization editor allowing to quickly and easily configure compelling visualizations to use on dashboards and canvas workpads. Exposes components to embed visualizations and link into the Lens editor from within other apps in Kibana. | 592 | 0 | 515 | 35 | | | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 8 | 0 | 8 | 0 | | | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 3 | 0 | 3 | 0 | | | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 117 | 0 | 42 | 10 | @@ -107,7 +108,7 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [Stack Monitoring](https://github.com/orgs/elastic/teams/stack-monitoring-ui) | - | 9 | 0 | 9 | 0 | | | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | - | 34 | 0 | 34 | 2 | | | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 17 | 0 | 17 | 0 | -| | [Observability UI](https://github.com/orgs/elastic/teams/observability-ui) | - | 377 | 2 | 374 | 30 | +| | [Observability UI](https://github.com/orgs/elastic/teams/observability-ui) | - | 382 | 2 | 379 | 30 | | | [Security asset management](https://github.com/orgs/elastic/teams/security-asset-management) | - | 13 | 0 | 13 | 0 | | painlessLab | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 0 | 0 | 0 | 0 | | | [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | The Presentation Utility Plugin is a set of common, shared components and toolkits for solutions within the Presentation space, (e.g. Dashboards, Canvas). | 228 | 2 | 177 | 11 | @@ -121,10 +122,10 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 76 | 0 | 70 | 3 | | | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 90 | 0 | 45 | 0 | | | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | - | 32 | 0 | 13 | 0 | -| | [Kibana Reporting Services](https://github.com/orgs/elastic/teams/kibana-reporting-services) | Kibana Screenshotting Plugin | 28 | 0 | 8 | 4 | +| | [Kibana Reporting Services](https://github.com/orgs/elastic/teams/kibana-reporting-services) | Kibana Screenshotting Plugin | 27 | 0 | 8 | 4 | | searchprofiler | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 0 | 0 | 0 | 0 | | | [Platform Security](https://github.com/orgs/elastic/teams/kibana-security) | This plugin provides authentication and authorization features, and exposes functionality to understand the capabilities of the currently authenticated user. | 179 | 0 | 99 | 0 | -| | [Security solution](https://github.com/orgs/elastic/teams/security-solution) | - | 49 | 0 | 49 | 21 | +| | [Security solution](https://github.com/orgs/elastic/teams/security-solution) | - | 52 | 0 | 51 | 21 | | | [Security Team](https://github.com/orgs/elastic/teams/security-team) | - | 3 | 0 | 3 | 1 | | | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Adds URL Service and sharing capabilities to Kibana | 113 | 0 | 54 | 10 | | | [Shared UX](https://github.com/orgs/elastic/teams/shared-ux) | A plugin providing components and services for shared user experiences in Kibana. | 4 | 0 | 0 | 0 | @@ -140,7 +141,7 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [Security solution](https://github.com/orgs/elastic/teams/security-solution) | - | 436 | 1 | 332 | 35 | | | [Machine Learning UI](https://github.com/orgs/elastic/teams/ml-ui) | This plugin provides access to the transforms features provided by Elastic. Transforms enable you to convert existing Elasticsearch indices into summarized indices, which provide opportunities for new insights and analytics. | 4 | 0 | 4 | 1 | | translations | [Kibana Localization](https://github.com/orgs/elastic/teams/kibana-localization) | - | 0 | 0 | 0 | 0 | -| | [Response Ops](https://github.com/orgs/elastic/teams/response-ops) | - | 374 | 0 | 360 | 34 | +| | [Response Ops](https://github.com/orgs/elastic/teams/response-ops) | - | 383 | 0 | 369 | 33 | | | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Adds UI Actions service to Kibana | 130 | 0 | 91 | 11 | | | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Extends UI Actions plugin with more functionality | 205 | 0 | 142 | 9 | | | [Unified Search](https://github.com/orgs/elastic/teams/kibana-app-services) | Contains all the key functionality of Kibana's unified search experience.Contains all the key functionality of Kibana's unified search experience. | 82 | 2 | 78 | 13 | @@ -162,7 +163,7 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Registers the vega visualization. Is the elastic version of vega and vega-lite libraries. | 2 | 0 | 2 | 0 | | | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Contains the vislib visualizations. These are the classical area/line/bar, pie, gauge/goal and heatmap charts. We want to replace them with elastic-charts. | 26 | 0 | 25 | 1 | | | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Contains the new xy-axis chart using the elastic-charts library, which will eventually replace the vislib xy-axis charts including bar, area, and line. | 57 | 0 | 51 | 5 | -| | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Contains the shared architecture among all the legacy visualizations, e.g. the visualization type registry or the visualization embeddable. | 372 | 12 | 351 | 14 | +| | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Contains the shared architecture among all the legacy visualizations, e.g. the visualization type registry or the visualization embeddable. | 379 | 12 | 355 | 14 | | watcher | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 0 | 0 | 0 | 0 | ## Package Directory @@ -174,11 +175,11 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [Owner missing] | - | 35 | 0 | 18 | 0 | | | [Owner missing] | Alerts components and hooks | 9 | 1 | 9 | 0 | | | Ahmad Bamieh ahmadbamieh@gmail.com | Kibana Analytics tool | 69 | 0 | 69 | 2 | -| | [Owner missing] | - | 95 | 0 | 7 | 0 | -| | [Owner missing] | - | 18 | 0 | 13 | 0 | -| | [Owner missing] | - | 22 | 0 | 13 | 0 | -| | [Owner missing] | - | 18 | 0 | 13 | 0 | -| | [Owner missing] | - | 20 | 0 | 4 | 0 | +| | [Owner missing] | - | 96 | 0 | 0 | 0 | +| | [Owner missing] | - | 18 | 0 | 0 | 0 | +| | [Owner missing] | - | 23 | 0 | 0 | 0 | +| | [Owner missing] | - | 18 | 0 | 0 | 0 | +| | [Owner missing] | - | 20 | 0 | 0 | 0 | | | [Owner missing] | - | 16 | 0 | 16 | 0 | | | [Owner missing] | - | 11 | 0 | 11 | 0 | | | [Owner missing] | - | 10 | 0 | 10 | 0 | @@ -189,7 +190,11 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [Owner missing] | - | 2 | 0 | 2 | 0 | | | [Owner missing] | - | 106 | 0 | 80 | 1 | | | [Owner missing] | - | 65 | 0 | 44 | 2 | +| | [Owner missing] | - | 16 | 0 | 16 | 0 | | | [Owner missing] | - | 129 | 3 | 127 | 17 | +| | [Owner missing] | - | 11 | 0 | 2 | 0 | +| | [Owner missing] | - | 8 | 2 | 6 | 0 | +| | [Owner missing] | - | 4 | 0 | 4 | 0 | | | [Owner missing] | - | 13 | 0 | 7 | 0 | | | [Owner missing] | elasticsearch datemath parser, used in kibana | 44 | 0 | 43 | 0 | | | [Owner missing] | - | 9 | 1 | 9 | 0 | @@ -199,7 +204,7 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [Owner missing] | - | 65 | 0 | 65 | 2 | | | [Owner missing] | - | 1 | 0 | 1 | 0 | | | [Owner missing] | - | 27 | 0 | 14 | 1 | -| | [Owner missing] | - | 213 | 1 | 159 | 11 | +| | [Owner missing] | - | 222 | 1 | 168 | 11 | | | [Owner missing] | - | 2 | 0 | 1 | 0 | | | [Owner missing] | - | 20 | 0 | 16 | 0 | | | [Owner missing] | - | 2 | 0 | 0 | 0 | @@ -239,9 +244,9 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [Owner missing] | security solution utilities to use across plugins such lists, security_solution, cases, etc... | 31 | 0 | 29 | 0 | | | [Owner missing] | - | 53 | 0 | 50 | 1 | | | [Owner missing] | - | 25 | 0 | 24 | 1 | -| | [Owner missing] | - | 12 | 0 | 2 | 3 | -| | [Owner missing] | - | 23 | 0 | 6 | 3 | -| | [Owner missing] | - | 8 | 0 | 2 | 3 | +| | [Owner missing] | - | 17 | 0 | 12 | 3 | +| | [Owner missing] | - | 6 | 0 | 3 | 3 | +| | [Owner missing] | - | 16 | 0 | 7 | 1 | | | [Owner missing] | - | 78 | 0 | 49 | 2 | | | [Owner missing] | - | 16 | 0 | 7 | 0 | | | [Owner missing] | - | 9 | 0 | 3 | 0 | @@ -250,12 +255,13 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [Owner missing] | - | 4 | 0 | 2 | 0 | | | Operations | - | 38 | 2 | 21 | 0 | | | [Owner missing] | - | 2 | 0 | 2 | 0 | -| | Operations | - | 240 | 5 | 201 | 9 | +| | Operations | - | 241 | 5 | 202 | 9 | | | [Owner missing] | - | 135 | 8 | 103 | 2 | | | [Owner missing] | - | 72 | 0 | 55 | 0 | | | [Owner missing] | - | 29 | 0 | 2 | 0 | | | [Owner missing] | - | 83 | 0 | 83 | 1 | | | [Owner missing] | - | 7 | 0 | 6 | 0 | | | [Owner missing] | - | 29 | 0 | 10 | 1 | +| | [Owner missing] | - | 2 | 0 | 2 | 0 | | | [Owner missing] | - | 31 | 1 | 21 | 0 | diff --git a/api_docs/presentation_util.mdx b/api_docs/presentation_util.mdx index c96b93d968ceab..39db525603dd0d 100644 --- a/api_docs/presentation_util.mdx +++ b/api_docs/presentation_util.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/presentationUtil title: "presentationUtil" image: https://source.unsplash.com/400x175/?github summary: API docs for the presentationUtil plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'presentationUtil'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/remote_clusters.mdx b/api_docs/remote_clusters.mdx index 68f021c05e83ab..d1c08c5810c28f 100644 --- a/api_docs/remote_clusters.mdx +++ b/api_docs/remote_clusters.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/remoteClusters title: "remoteClusters" image: https://source.unsplash.com/400x175/?github summary: API docs for the remoteClusters plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'remoteClusters'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/reporting.devdocs.json b/api_docs/reporting.devdocs.json index 5d2eecdff0fcb2..d256af7da9a0af 100644 --- a/api_docs/reporting.devdocs.json +++ b/api_docs/reporting.devdocs.json @@ -26,7 +26,15 @@ "\nA function that Reporting calls to get the sharing data from the application." ], "signature": [ - "(forShareUrl?: boolean | undefined) => Omit<{ layout?: { id?: string | undefined; dimensions?: { width: number; height: number; } | undefined; selectors?: Partial<", + "(forShareUrl?: boolean | undefined) => Omit<{ layout?: { id?: ", + { + "pluginId": "screenshotting", + "scope": "common", + "docId": "kibScreenshottingPluginApi", + "section": "def-common.LayoutType", + "text": "LayoutType" + }, + " | undefined; dimensions?: { width: number; height: number; } | undefined; selectors?: Partial<", "LayoutSelectorDictionary", "> | undefined; zoom?: number | undefined; } | undefined; objectType: string; title: string; browserTimezone: string; version: string; }, \"version\" | \"browserTimezone\">" ], @@ -335,7 +343,15 @@ "section": "def-common.BasePayload", "text": "BasePayload" }, - " extends { layout?: { id?: string | undefined; dimensions?: { width: number; height: number; } | undefined; selectors?: Partial<", + " extends { layout?: { id?: ", + { + "pluginId": "screenshotting", + "scope": "common", + "docId": "kibScreenshottingPluginApi", + "section": "def-common.LayoutType", + "text": "LayoutType" + }, + " | undefined; dimensions?: { width: number; height: number; } | undefined; selectors?: Partial<", "LayoutSelectorDictionary", "> | undefined; zoom?: number | undefined; } | undefined; objectType: string; title: string; browserTimezone: string; version: string; }" ], @@ -523,7 +539,15 @@ "label": "BaseParams", "description": [], "signature": [ - "{ layout?: { id?: string | undefined; dimensions?: { width: number; height: number; } | undefined; selectors?: Partial<", + "{ layout?: { id?: ", + { + "pluginId": "screenshotting", + "scope": "common", + "docId": "kibScreenshottingPluginApi", + "section": "def-common.LayoutType", + "text": "LayoutType" + }, + " | undefined; dimensions?: { width: number; height: number; } | undefined; selectors?: Partial<", "LayoutSelectorDictionary", "> | undefined; zoom?: number | undefined; } | undefined; objectType: string; title: string; browserTimezone: string; version: string; }" ], @@ -542,7 +566,15 @@ "\nReport job parameters that an application must return from its\ngetSharingData function." ], "signature": [ - "{ layout?: { id?: string | undefined; dimensions?: { width: number; height: number; } | undefined; selectors?: Partial<", + "{ layout?: { id?: ", + { + "pluginId": "screenshotting", + "scope": "common", + "docId": "kibScreenshottingPluginApi", + "section": "def-common.LayoutType", + "text": "LayoutType" + }, + " | undefined; dimensions?: { width: number; height: number; } | undefined; selectors?: Partial<", "LayoutSelectorDictionary", "> | undefined; zoom?: number | undefined; } | undefined; objectType: string; title: string; browserTimezone: string; version: string; } & { locatorParams: ", { @@ -570,7 +602,15 @@ "label": "JobAppParamsPDF", "description": [], "signature": [ - "{ title: string; layout: { id?: string | undefined; dimensions?: { width: number; height: number; } | undefined; selectors?: Partial<", + "{ title: string; layout: { id?: ", + { + "pluginId": "screenshotting", + "scope": "common", + "docId": "kibScreenshottingPluginApi", + "section": "def-common.LayoutType", + "text": "LayoutType" + }, + " | undefined; dimensions?: { width: number; height: number; } | undefined; selectors?: Partial<", "LayoutSelectorDictionary", "> | undefined; zoom?: number | undefined; }; objectType: string; relativeUrls: string[]; isDeprecated?: boolean | undefined; }" ], @@ -587,7 +627,15 @@ "label": "JobAppParamsPDFV2", "description": [], "signature": [ - "{ title: string; layout: { id?: string | undefined; dimensions?: { width: number; height: number; } | undefined; selectors?: Partial<", + "{ title: string; layout: { id?: ", + { + "pluginId": "screenshotting", + "scope": "common", + "docId": "kibScreenshottingPluginApi", + "section": "def-common.LayoutType", + "text": "LayoutType" + }, + " | undefined; dimensions?: { width: number; height: number; } | undefined; selectors?: Partial<", "LayoutSelectorDictionary", "> | undefined; zoom?: number | undefined; }; objectType: string; locatorParams: ", { diff --git a/api_docs/reporting.mdx b/api_docs/reporting.mdx index ae135b6c79a23e..c2b6a80f748caa 100644 --- a/api_docs/reporting.mdx +++ b/api_docs/reporting.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/reporting title: "reporting" image: https://source.unsplash.com/400x175/?github summary: API docs for the reporting plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'reporting'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/rollup.mdx b/api_docs/rollup.mdx index 300dae7ca04e64..6309085d7faeeb 100644 --- a/api_docs/rollup.mdx +++ b/api_docs/rollup.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/rollup title: "rollup" image: https://source.unsplash.com/400x175/?github summary: API docs for the rollup plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'rollup'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/rule_registry.devdocs.json b/api_docs/rule_registry.devdocs.json index 32b84823f28d37..7878a8f8c1ca45 100644 --- a/api_docs/rule_registry.devdocs.json +++ b/api_docs/rule_registry.devdocs.json @@ -1710,7 +1710,7 @@ "\nID of the Kibana feature associated with the index.\nUsed by alerts-as-data RBAC.\n\nNote from @dhurley14\nThe purpose of the `feature` param is to force the user to update\nthe data structure which contains the mapping of consumers to alerts\nas data indices. The idea is it is typed such that it forces the\nuser to go to the code and modify it. At least until a better system\nis put in place or we move the alerts as data client out of rule registry.\n" ], "signature": [ - "\"logs\" | \"apm\" | \"observability\" | \"uptime\" | \"infrastructure\" | \"siem\"" + "\"logs\" | \"apm\" | \"infrastructure\" | \"observability\" | \"uptime\" | \"siem\"" ], "path": "x-pack/plugins/rule_registry/server/rule_data_plugin_service/index_options.ts", "deprecated": false diff --git a/api_docs/rule_registry.mdx b/api_docs/rule_registry.mdx index 0b8eda4b842f47..d7398709fa9229 100644 --- a/api_docs/rule_registry.mdx +++ b/api_docs/rule_registry.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/ruleRegistry title: "ruleRegistry" image: https://source.unsplash.com/400x175/?github summary: API docs for the ruleRegistry plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'ruleRegistry'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/runtime_fields.mdx b/api_docs/runtime_fields.mdx index 6048f91c0ec533..4c4d370c7fcd38 100644 --- a/api_docs/runtime_fields.mdx +++ b/api_docs/runtime_fields.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/runtimeFields title: "runtimeFields" image: https://source.unsplash.com/400x175/?github summary: API docs for the runtimeFields plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'runtimeFields'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/saved_objects.devdocs.json b/api_docs/saved_objects.devdocs.json index fe5794ec8c9efa..f0280fde583d73 100644 --- a/api_docs/saved_objects.devdocs.json +++ b/api_docs/saved_objects.devdocs.json @@ -1129,121 +1129,13 @@ "label": "savedObjectsClient", "description": [], "signature": [ - "{ create: (type: string, attributes: T, options?: ", { "pluginId": "core", "scope": "public", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsCreateOptions", - "text": "SavedObjectsCreateOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SimpleSavedObject", - "text": "SimpleSavedObject" - }, - ">; bulkCreate: (objects?: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsBulkCreateObject", - "text": "SavedObjectsBulkCreateObject" - }, - "[], options?: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsBulkCreateOptions", - "text": "SavedObjectsBulkCreateOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsBatchResponse", - "text": "SavedObjectsBatchResponse" - }, - ">; delete: (type: string, id: string, options?: ", - "SavedObjectsDeleteOptions", - " | undefined) => Promise<{}>; find: (options: SavedObjectsFindOptions) => Promise<", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsFindResponsePublic", - "text": "SavedObjectsFindResponsePublic" - }, - ">; bulkGet: (objects?: { id: string; type: string; }[]) => Promise<", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsBatchResponse", - "text": "SavedObjectsBatchResponse" - }, - ">; bulkResolve: (objects?: { id: string; type: string; }[]) => Promise<{ resolved_objects: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.ResolvedSimpleSavedObject", - "text": "ResolvedSimpleSavedObject" - }, - "[]; }>; get: (type: string, id: string) => Promise<", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SimpleSavedObject", - "text": "SimpleSavedObject" - }, - ">; resolve: (type: string, id: string) => Promise<", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.ResolvedSimpleSavedObject", - "text": "ResolvedSimpleSavedObject" - }, - ">; update: (type: string, id: string, attributes: T, { version, references, upsert }?: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsUpdateOptions", - "text": "SavedObjectsUpdateOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SimpleSavedObject", - "text": "SimpleSavedObject" - }, - ">; bulkUpdate: (objects?: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsBulkUpdateObject", - "text": "SavedObjectsBulkUpdateObject" - }, - "[]) => Promise<", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsBatchResponse", - "text": "SavedObjectsBatchResponse" - }, - ">; }" + "section": "def-public.SavedObjectsClientContract", + "text": "SavedObjectsClientContract" + } ], "path": "src/plugins/saved_objects/public/saved_object/helpers/save_with_confirmation.ts", "deprecated": false @@ -1916,8 +1808,8 @@ "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" + "section": "def-common.DataView", + "text": "DataView" }, " | null>) | undefined" ], @@ -2350,8 +2242,8 @@ "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" + "section": "def-common.DataView", + "text": "DataView" }, " | undefined" ], diff --git a/api_docs/saved_objects.mdx b/api_docs/saved_objects.mdx index c3bc4af35e706e..8112e4568ed85c 100644 --- a/api_docs/saved_objects.mdx +++ b/api_docs/saved_objects.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/savedObjects title: "savedObjects" image: https://source.unsplash.com/400x175/?github summary: API docs for the savedObjects plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'savedObjects'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/saved_objects_management.devdocs.json b/api_docs/saved_objects_management.devdocs.json index fd286b0782e6d5..c62b68b738f4d0 100644 --- a/api_docs/saved_objects_management.devdocs.json +++ b/api_docs/saved_objects_management.devdocs.json @@ -286,7 +286,7 @@ "section": "def-public.SavedObjectsManagementRecord", "text": "SavedObjectsManagementRecord" }, - "; defaultValue?: string | number | readonly string[] | undefined; hidden?: boolean | undefined; defaultChecked?: boolean | undefined; suppressContentEditableWarning?: boolean | undefined; suppressHydrationWarning?: boolean | undefined; accessKey?: string | undefined; contentEditable?: Booleanish | \"inherit\" | undefined; contextMenu?: string | undefined; dir?: string | undefined; draggable?: Booleanish | undefined; lang?: string | undefined; placeholder?: string | undefined; slot?: string | undefined; spellCheck?: Booleanish | undefined; style?: React.CSSProperties | undefined; tabIndex?: number | undefined; translate?: \"yes\" | \"no\" | undefined; radioGroup?: string | undefined; role?: React.AriaRole | undefined; about?: string | undefined; datatype?: string | undefined; inlist?: any; prefix?: string | undefined; property?: string | undefined; resource?: string | undefined; typeof?: string | undefined; vocab?: string | undefined; autoCapitalize?: string | undefined; autoCorrect?: string | undefined; autoSave?: string | undefined; itemProp?: string | undefined; itemScope?: boolean | undefined; itemType?: string | undefined; itemID?: string | undefined; itemRef?: string | undefined; results?: number | undefined; unselectable?: \"on\" | \"off\" | undefined; inputMode?: \"none\" | \"email\" | \"search\" | \"text\" | \"tel\" | \"url\" | \"numeric\" | \"decimal\" | undefined; is?: string | undefined; 'aria-activedescendant'?: string | undefined; 'aria-atomic'?: boolean | \"true\" | \"false\" | undefined; 'aria-autocomplete'?: \"none\" | \"list\" | \"inline\" | \"both\" | undefined; 'aria-busy'?: boolean | \"true\" | \"false\" | undefined; 'aria-checked'?: boolean | \"mixed\" | \"true\" | \"false\" | undefined; 'aria-colcount'?: number | undefined; 'aria-colindex'?: number | undefined; 'aria-colspan'?: number | undefined; 'aria-controls'?: string | undefined; 'aria-current'?: boolean | \"date\" | \"page\" | \"time\" | \"true\" | \"false\" | \"step\" | \"location\" | undefined; 'aria-describedby'?: string | undefined; 'aria-details'?: string | undefined; 'aria-disabled'?: boolean | \"true\" | \"false\" | undefined; 'aria-dropeffect'?: \"none\" | \"copy\" | \"link\" | \"execute\" | \"move\" | \"popup\" | undefined; 'aria-errormessage'?: string | undefined; 'aria-expanded'?: boolean | \"true\" | \"false\" | undefined; 'aria-flowto'?: string | undefined; 'aria-grabbed'?: boolean | \"true\" | \"false\" | undefined; 'aria-haspopup'?: boolean | \"grid\" | \"menu\" | \"true\" | \"false\" | \"dialog\" | \"listbox\" | \"tree\" | undefined; 'aria-hidden'?: boolean | \"true\" | \"false\" | undefined; 'aria-invalid'?: boolean | \"true\" | \"false\" | \"grammar\" | \"spelling\" | undefined; 'aria-keyshortcuts'?: string | undefined; 'aria-label'?: string | undefined; 'aria-labelledby'?: string | undefined; 'aria-level'?: number | undefined; 'aria-live'?: \"off\" | \"assertive\" | \"polite\" | undefined; 'aria-modal'?: boolean | \"true\" | \"false\" | undefined; 'aria-multiline'?: boolean | \"true\" | \"false\" | undefined; 'aria-multiselectable'?: boolean | \"true\" | \"false\" | undefined; 'aria-orientation'?: \"horizontal\" | \"vertical\" | undefined; 'aria-owns'?: string | undefined; 'aria-placeholder'?: string | undefined; 'aria-posinset'?: number | undefined; 'aria-pressed'?: boolean | \"mixed\" | \"true\" | \"false\" | undefined; 'aria-readonly'?: boolean | \"true\" | \"false\" | undefined; 'aria-relevant'?: \"all\" | \"text\" | \"additions\" | \"additions removals\" | \"additions text\" | \"removals\" | \"removals additions\" | \"removals text\" | \"text additions\" | \"text removals\" | undefined; 'aria-required'?: boolean | \"true\" | \"false\" | undefined; 'aria-roledescription'?: string | undefined; 'aria-rowcount'?: number | undefined; 'aria-rowindex'?: number | undefined; 'aria-rowspan'?: number | undefined; 'aria-selected'?: boolean | \"true\" | \"false\" | undefined; 'aria-setsize'?: number | undefined; 'aria-sort'?: \"none\" | \"other\" | \"ascending\" | \"descending\" | undefined; 'aria-valuemax'?: number | undefined; 'aria-valuemin'?: number | undefined; 'aria-valuenow'?: number | undefined; 'aria-valuetext'?: string | undefined; dangerouslySetInnerHTML?: { __html: string; } | undefined; onCopy?: React.ClipboardEventHandler | undefined; onCopyCapture?: React.ClipboardEventHandler | undefined; onCut?: React.ClipboardEventHandler | undefined; onCutCapture?: React.ClipboardEventHandler | undefined; onPaste?: React.ClipboardEventHandler | undefined; onPasteCapture?: React.ClipboardEventHandler | undefined; onCompositionEnd?: React.CompositionEventHandler | undefined; onCompositionEndCapture?: React.CompositionEventHandler | undefined; onCompositionStart?: React.CompositionEventHandler | undefined; onCompositionStartCapture?: React.CompositionEventHandler | undefined; onCompositionUpdate?: React.CompositionEventHandler | undefined; onCompositionUpdateCapture?: React.CompositionEventHandler | undefined; onFocus?: React.FocusEventHandler | undefined; onFocusCapture?: React.FocusEventHandler | undefined; onBlur?: React.FocusEventHandler | undefined; onBlurCapture?: React.FocusEventHandler | undefined; onChangeCapture?: React.FormEventHandler | undefined; onBeforeInput?: React.FormEventHandler | undefined; onBeforeInputCapture?: React.FormEventHandler | undefined; onInput?: React.FormEventHandler | undefined; onInputCapture?: React.FormEventHandler | undefined; onReset?: React.FormEventHandler | undefined; onResetCapture?: React.FormEventHandler | undefined; onSubmit?: React.FormEventHandler | undefined; onSubmitCapture?: React.FormEventHandler | undefined; onInvalid?: React.FormEventHandler | undefined; onInvalidCapture?: React.FormEventHandler | undefined; onLoad?: React.ReactEventHandler | undefined; onLoadCapture?: React.ReactEventHandler | undefined; onError?: React.ReactEventHandler | undefined; onErrorCapture?: React.ReactEventHandler | undefined; onKeyDownCapture?: React.KeyboardEventHandler | undefined; onKeyPress?: React.KeyboardEventHandler | undefined; onKeyPressCapture?: React.KeyboardEventHandler | undefined; onKeyUp?: React.KeyboardEventHandler | undefined; onKeyUpCapture?: React.KeyboardEventHandler | undefined; onAbort?: React.ReactEventHandler | undefined; onAbortCapture?: React.ReactEventHandler | undefined; onCanPlay?: React.ReactEventHandler | undefined; onCanPlayCapture?: React.ReactEventHandler | undefined; onCanPlayThrough?: React.ReactEventHandler | undefined; onCanPlayThroughCapture?: React.ReactEventHandler | undefined; onDurationChange?: React.ReactEventHandler | undefined; onDurationChangeCapture?: React.ReactEventHandler | undefined; onEmptied?: React.ReactEventHandler | undefined; onEmptiedCapture?: React.ReactEventHandler | undefined; onEncrypted?: React.ReactEventHandler | undefined; onEncryptedCapture?: React.ReactEventHandler | undefined; onEnded?: React.ReactEventHandler | undefined; onEndedCapture?: React.ReactEventHandler | undefined; onLoadedData?: React.ReactEventHandler | undefined; onLoadedDataCapture?: React.ReactEventHandler | undefined; onLoadedMetadata?: React.ReactEventHandler | undefined; onLoadedMetadataCapture?: React.ReactEventHandler | undefined; onLoadStart?: React.ReactEventHandler | undefined; onLoadStartCapture?: React.ReactEventHandler | undefined; onPause?: React.ReactEventHandler | undefined; onPauseCapture?: React.ReactEventHandler | undefined; onPlay?: React.ReactEventHandler | undefined; onPlayCapture?: React.ReactEventHandler | undefined; onPlaying?: React.ReactEventHandler | undefined; onPlayingCapture?: React.ReactEventHandler | undefined; onProgress?: React.ReactEventHandler | undefined; onProgressCapture?: React.ReactEventHandler | undefined; onRateChange?: React.ReactEventHandler | undefined; onRateChangeCapture?: React.ReactEventHandler | undefined; onSeeked?: React.ReactEventHandler | undefined; onSeekedCapture?: React.ReactEventHandler | undefined; onSeeking?: React.ReactEventHandler | undefined; onSeekingCapture?: React.ReactEventHandler | undefined; onStalled?: React.ReactEventHandler | undefined; onStalledCapture?: React.ReactEventHandler | undefined; onSuspend?: React.ReactEventHandler | undefined; onSuspendCapture?: React.ReactEventHandler | undefined; onTimeUpdate?: React.ReactEventHandler | undefined; onTimeUpdateCapture?: React.ReactEventHandler | undefined; onVolumeChange?: React.ReactEventHandler | undefined; onVolumeChangeCapture?: React.ReactEventHandler | undefined; onWaiting?: React.ReactEventHandler | undefined; onWaitingCapture?: React.ReactEventHandler | undefined; onAuxClick?: React.MouseEventHandler | undefined; onAuxClickCapture?: React.MouseEventHandler | undefined; onClickCapture?: React.MouseEventHandler | undefined; onContextMenu?: React.MouseEventHandler | undefined; onContextMenuCapture?: React.MouseEventHandler | undefined; onDoubleClick?: React.MouseEventHandler | undefined; onDoubleClickCapture?: React.MouseEventHandler | undefined; onDrag?: React.DragEventHandler | undefined; onDragCapture?: React.DragEventHandler | undefined; onDragEnd?: React.DragEventHandler | undefined; onDragEndCapture?: React.DragEventHandler | undefined; onDragEnter?: React.DragEventHandler | undefined; onDragEnterCapture?: React.DragEventHandler | undefined; onDragExit?: React.DragEventHandler | undefined; onDragExitCapture?: React.DragEventHandler | undefined; onDragLeave?: React.DragEventHandler | undefined; onDragLeaveCapture?: React.DragEventHandler | undefined; onDragOver?: React.DragEventHandler | undefined; onDragOverCapture?: React.DragEventHandler | undefined; onDragStart?: React.DragEventHandler | undefined; onDragStartCapture?: React.DragEventHandler | undefined; onDrop?: React.DragEventHandler | undefined; onDropCapture?: React.DragEventHandler | undefined; onMouseDown?: React.MouseEventHandler | undefined; onMouseDownCapture?: React.MouseEventHandler | undefined; onMouseEnter?: React.MouseEventHandler | undefined; onMouseLeave?: React.MouseEventHandler | undefined; onMouseMove?: React.MouseEventHandler | undefined; onMouseMoveCapture?: React.MouseEventHandler | undefined; onMouseOut?: React.MouseEventHandler | undefined; onMouseOutCapture?: React.MouseEventHandler | undefined; onMouseOver?: React.MouseEventHandler | undefined; onMouseOverCapture?: React.MouseEventHandler | undefined; onMouseUp?: React.MouseEventHandler | undefined; onMouseUpCapture?: React.MouseEventHandler | undefined; onSelect?: React.ReactEventHandler | undefined; onSelectCapture?: React.ReactEventHandler | undefined; onTouchCancel?: React.TouchEventHandler | undefined; onTouchCancelCapture?: React.TouchEventHandler | undefined; onTouchEnd?: React.TouchEventHandler | undefined; onTouchEndCapture?: React.TouchEventHandler | undefined; onTouchMove?: React.TouchEventHandler | undefined; onTouchMoveCapture?: React.TouchEventHandler | undefined; onTouchStart?: React.TouchEventHandler | undefined; onTouchStartCapture?: React.TouchEventHandler | undefined; onPointerDown?: React.PointerEventHandler | undefined; onPointerDownCapture?: React.PointerEventHandler | undefined; onPointerMove?: React.PointerEventHandler | undefined; onPointerMoveCapture?: React.PointerEventHandler | undefined; onPointerUp?: React.PointerEventHandler | undefined; onPointerUpCapture?: React.PointerEventHandler | undefined; onPointerCancel?: React.PointerEventHandler | undefined; onPointerCancelCapture?: React.PointerEventHandler | undefined; onPointerEnter?: React.PointerEventHandler | undefined; onPointerEnterCapture?: React.PointerEventHandler | undefined; onPointerLeave?: React.PointerEventHandler | undefined; onPointerLeaveCapture?: React.PointerEventHandler | undefined; onPointerOver?: React.PointerEventHandler | undefined; onPointerOverCapture?: React.PointerEventHandler | undefined; onPointerOut?: React.PointerEventHandler | undefined; onPointerOutCapture?: React.PointerEventHandler | undefined; onGotPointerCapture?: React.PointerEventHandler | undefined; onGotPointerCaptureCapture?: React.PointerEventHandler | undefined; onLostPointerCapture?: React.PointerEventHandler | undefined; onLostPointerCaptureCapture?: React.PointerEventHandler | undefined; onScroll?: React.UIEventHandler | undefined; onScrollCapture?: React.UIEventHandler | undefined; onWheel?: React.WheelEventHandler | undefined; onWheelCapture?: React.WheelEventHandler | undefined; onAnimationStart?: React.AnimationEventHandler | undefined; onAnimationStartCapture?: React.AnimationEventHandler | undefined; onAnimationEnd?: React.AnimationEventHandler | undefined; onAnimationEndCapture?: React.AnimationEventHandler | undefined; onAnimationIteration?: React.AnimationEventHandler | undefined; onAnimationIterationCapture?: React.AnimationEventHandler | undefined; onTransitionEnd?: React.TransitionEventHandler | undefined; onTransitionEndCapture?: React.TransitionEventHandler | undefined; 'data-test-subj'?: string | undefined; render?: ((value: any, record: ", + "; defaultValue?: string | number | readonly string[] | undefined; hidden?: boolean | undefined; lang?: string | undefined; onError?: React.ReactEventHandler | undefined; defaultChecked?: boolean | undefined; suppressContentEditableWarning?: boolean | undefined; suppressHydrationWarning?: boolean | undefined; accessKey?: string | undefined; contentEditable?: Booleanish | \"inherit\" | undefined; contextMenu?: string | undefined; dir?: string | undefined; draggable?: Booleanish | undefined; placeholder?: string | undefined; slot?: string | undefined; spellCheck?: Booleanish | undefined; style?: React.CSSProperties | undefined; tabIndex?: number | undefined; translate?: \"yes\" | \"no\" | undefined; radioGroup?: string | undefined; role?: React.AriaRole | undefined; about?: string | undefined; datatype?: string | undefined; inlist?: any; prefix?: string | undefined; property?: string | undefined; resource?: string | undefined; typeof?: string | undefined; vocab?: string | undefined; autoCapitalize?: string | undefined; autoCorrect?: string | undefined; autoSave?: string | undefined; itemProp?: string | undefined; itemScope?: boolean | undefined; itemType?: string | undefined; itemID?: string | undefined; itemRef?: string | undefined; results?: number | undefined; unselectable?: \"on\" | \"off\" | undefined; inputMode?: \"none\" | \"email\" | \"search\" | \"text\" | \"tel\" | \"url\" | \"numeric\" | \"decimal\" | undefined; is?: string | undefined; 'aria-activedescendant'?: string | undefined; 'aria-atomic'?: boolean | \"true\" | \"false\" | undefined; 'aria-autocomplete'?: \"none\" | \"list\" | \"inline\" | \"both\" | undefined; 'aria-busy'?: boolean | \"true\" | \"false\" | undefined; 'aria-checked'?: boolean | \"mixed\" | \"true\" | \"false\" | undefined; 'aria-colcount'?: number | undefined; 'aria-colindex'?: number | undefined; 'aria-colspan'?: number | undefined; 'aria-controls'?: string | undefined; 'aria-current'?: boolean | \"date\" | \"page\" | \"time\" | \"true\" | \"false\" | \"step\" | \"location\" | undefined; 'aria-describedby'?: string | undefined; 'aria-details'?: string | undefined; 'aria-disabled'?: boolean | \"true\" | \"false\" | undefined; 'aria-dropeffect'?: \"none\" | \"copy\" | \"link\" | \"execute\" | \"move\" | \"popup\" | undefined; 'aria-errormessage'?: string | undefined; 'aria-expanded'?: boolean | \"true\" | \"false\" | undefined; 'aria-flowto'?: string | undefined; 'aria-grabbed'?: boolean | \"true\" | \"false\" | undefined; 'aria-haspopup'?: boolean | \"grid\" | \"menu\" | \"true\" | \"false\" | \"dialog\" | \"listbox\" | \"tree\" | undefined; 'aria-hidden'?: boolean | \"true\" | \"false\" | undefined; 'aria-invalid'?: boolean | \"true\" | \"false\" | \"grammar\" | \"spelling\" | undefined; 'aria-keyshortcuts'?: string | undefined; 'aria-label'?: string | undefined; 'aria-labelledby'?: string | undefined; 'aria-level'?: number | undefined; 'aria-live'?: \"off\" | \"assertive\" | \"polite\" | undefined; 'aria-modal'?: boolean | \"true\" | \"false\" | undefined; 'aria-multiline'?: boolean | \"true\" | \"false\" | undefined; 'aria-multiselectable'?: boolean | \"true\" | \"false\" | undefined; 'aria-orientation'?: \"horizontal\" | \"vertical\" | undefined; 'aria-owns'?: string | undefined; 'aria-placeholder'?: string | undefined; 'aria-posinset'?: number | undefined; 'aria-pressed'?: boolean | \"mixed\" | \"true\" | \"false\" | undefined; 'aria-readonly'?: boolean | \"true\" | \"false\" | undefined; 'aria-relevant'?: \"all\" | \"text\" | \"additions\" | \"additions removals\" | \"additions text\" | \"removals\" | \"removals additions\" | \"removals text\" | \"text additions\" | \"text removals\" | undefined; 'aria-required'?: boolean | \"true\" | \"false\" | undefined; 'aria-roledescription'?: string | undefined; 'aria-rowcount'?: number | undefined; 'aria-rowindex'?: number | undefined; 'aria-rowspan'?: number | undefined; 'aria-selected'?: boolean | \"true\" | \"false\" | undefined; 'aria-setsize'?: number | undefined; 'aria-sort'?: \"none\" | \"other\" | \"ascending\" | \"descending\" | undefined; 'aria-valuemax'?: number | undefined; 'aria-valuemin'?: number | undefined; 'aria-valuenow'?: number | undefined; 'aria-valuetext'?: string | undefined; dangerouslySetInnerHTML?: { __html: string; } | undefined; onCopy?: React.ClipboardEventHandler | undefined; onCopyCapture?: React.ClipboardEventHandler | undefined; onCut?: React.ClipboardEventHandler | undefined; onCutCapture?: React.ClipboardEventHandler | undefined; onPaste?: React.ClipboardEventHandler | undefined; onPasteCapture?: React.ClipboardEventHandler | undefined; onCompositionEnd?: React.CompositionEventHandler | undefined; onCompositionEndCapture?: React.CompositionEventHandler | undefined; onCompositionStart?: React.CompositionEventHandler | undefined; onCompositionStartCapture?: React.CompositionEventHandler | undefined; onCompositionUpdate?: React.CompositionEventHandler | undefined; onCompositionUpdateCapture?: React.CompositionEventHandler | undefined; onFocus?: React.FocusEventHandler | undefined; onFocusCapture?: React.FocusEventHandler | undefined; onBlur?: React.FocusEventHandler | undefined; onBlurCapture?: React.FocusEventHandler | undefined; onChangeCapture?: React.FormEventHandler | undefined; onBeforeInput?: React.FormEventHandler | undefined; onBeforeInputCapture?: React.FormEventHandler | undefined; onInput?: React.FormEventHandler | undefined; onInputCapture?: React.FormEventHandler | undefined; onReset?: React.FormEventHandler | undefined; onResetCapture?: React.FormEventHandler | undefined; onSubmit?: React.FormEventHandler | undefined; onSubmitCapture?: React.FormEventHandler | undefined; onInvalid?: React.FormEventHandler | undefined; onInvalidCapture?: React.FormEventHandler | undefined; onLoad?: React.ReactEventHandler | undefined; onLoadCapture?: React.ReactEventHandler | undefined; onErrorCapture?: React.ReactEventHandler | undefined; onKeyDownCapture?: React.KeyboardEventHandler | undefined; onKeyPress?: React.KeyboardEventHandler | undefined; onKeyPressCapture?: React.KeyboardEventHandler | undefined; onKeyUp?: React.KeyboardEventHandler | undefined; onKeyUpCapture?: React.KeyboardEventHandler | undefined; onAbort?: React.ReactEventHandler | undefined; onAbortCapture?: React.ReactEventHandler | undefined; onCanPlay?: React.ReactEventHandler | undefined; onCanPlayCapture?: React.ReactEventHandler | undefined; onCanPlayThrough?: React.ReactEventHandler | undefined; onCanPlayThroughCapture?: React.ReactEventHandler | undefined; onDurationChange?: React.ReactEventHandler | undefined; onDurationChangeCapture?: React.ReactEventHandler | undefined; onEmptied?: React.ReactEventHandler | undefined; onEmptiedCapture?: React.ReactEventHandler | undefined; onEncrypted?: React.ReactEventHandler | undefined; onEncryptedCapture?: React.ReactEventHandler | undefined; onEnded?: React.ReactEventHandler | undefined; onEndedCapture?: React.ReactEventHandler | undefined; onLoadedData?: React.ReactEventHandler | undefined; onLoadedDataCapture?: React.ReactEventHandler | undefined; onLoadedMetadata?: React.ReactEventHandler | undefined; onLoadedMetadataCapture?: React.ReactEventHandler | undefined; onLoadStart?: React.ReactEventHandler | undefined; onLoadStartCapture?: React.ReactEventHandler | undefined; onPause?: React.ReactEventHandler | undefined; onPauseCapture?: React.ReactEventHandler | undefined; onPlay?: React.ReactEventHandler | undefined; onPlayCapture?: React.ReactEventHandler | undefined; onPlaying?: React.ReactEventHandler | undefined; onPlayingCapture?: React.ReactEventHandler | undefined; onProgress?: React.ReactEventHandler | undefined; onProgressCapture?: React.ReactEventHandler | undefined; onRateChange?: React.ReactEventHandler | undefined; onRateChangeCapture?: React.ReactEventHandler | undefined; onSeeked?: React.ReactEventHandler | undefined; onSeekedCapture?: React.ReactEventHandler | undefined; onSeeking?: React.ReactEventHandler | undefined; onSeekingCapture?: React.ReactEventHandler | undefined; onStalled?: React.ReactEventHandler | undefined; onStalledCapture?: React.ReactEventHandler | undefined; onSuspend?: React.ReactEventHandler | undefined; onSuspendCapture?: React.ReactEventHandler | undefined; onTimeUpdate?: React.ReactEventHandler | undefined; onTimeUpdateCapture?: React.ReactEventHandler | undefined; onVolumeChange?: React.ReactEventHandler | undefined; onVolumeChangeCapture?: React.ReactEventHandler | undefined; onWaiting?: React.ReactEventHandler | undefined; onWaitingCapture?: React.ReactEventHandler | undefined; onAuxClick?: React.MouseEventHandler | undefined; onAuxClickCapture?: React.MouseEventHandler | undefined; onClickCapture?: React.MouseEventHandler | undefined; onContextMenu?: React.MouseEventHandler | undefined; onContextMenuCapture?: React.MouseEventHandler | undefined; onDoubleClick?: React.MouseEventHandler | undefined; onDoubleClickCapture?: React.MouseEventHandler | undefined; onDrag?: React.DragEventHandler | undefined; onDragCapture?: React.DragEventHandler | undefined; onDragEnd?: React.DragEventHandler | undefined; onDragEndCapture?: React.DragEventHandler | undefined; onDragEnter?: React.DragEventHandler | undefined; onDragEnterCapture?: React.DragEventHandler | undefined; onDragExit?: React.DragEventHandler | undefined; onDragExitCapture?: React.DragEventHandler | undefined; onDragLeave?: React.DragEventHandler | undefined; onDragLeaveCapture?: React.DragEventHandler | undefined; onDragOver?: React.DragEventHandler | undefined; onDragOverCapture?: React.DragEventHandler | undefined; onDragStart?: React.DragEventHandler | undefined; onDragStartCapture?: React.DragEventHandler | undefined; onDrop?: React.DragEventHandler | undefined; onDropCapture?: React.DragEventHandler | undefined; onMouseDown?: React.MouseEventHandler | undefined; onMouseDownCapture?: React.MouseEventHandler | undefined; onMouseEnter?: React.MouseEventHandler | undefined; onMouseLeave?: React.MouseEventHandler | undefined; onMouseMove?: React.MouseEventHandler | undefined; onMouseMoveCapture?: React.MouseEventHandler | undefined; onMouseOut?: React.MouseEventHandler | undefined; onMouseOutCapture?: React.MouseEventHandler | undefined; onMouseOver?: React.MouseEventHandler | undefined; onMouseOverCapture?: React.MouseEventHandler | undefined; onMouseUp?: React.MouseEventHandler | undefined; onMouseUpCapture?: React.MouseEventHandler | undefined; onSelect?: React.ReactEventHandler | undefined; onSelectCapture?: React.ReactEventHandler | undefined; onTouchCancel?: React.TouchEventHandler | undefined; onTouchCancelCapture?: React.TouchEventHandler | undefined; onTouchEnd?: React.TouchEventHandler | undefined; onTouchEndCapture?: React.TouchEventHandler | undefined; onTouchMove?: React.TouchEventHandler | undefined; onTouchMoveCapture?: React.TouchEventHandler | undefined; onTouchStart?: React.TouchEventHandler | undefined; onTouchStartCapture?: React.TouchEventHandler | undefined; onPointerDown?: React.PointerEventHandler | undefined; onPointerDownCapture?: React.PointerEventHandler | undefined; onPointerMove?: React.PointerEventHandler | undefined; onPointerMoveCapture?: React.PointerEventHandler | undefined; onPointerUp?: React.PointerEventHandler | undefined; onPointerUpCapture?: React.PointerEventHandler | undefined; onPointerCancel?: React.PointerEventHandler | undefined; onPointerCancelCapture?: React.PointerEventHandler | undefined; onPointerEnter?: React.PointerEventHandler | undefined; onPointerEnterCapture?: React.PointerEventHandler | undefined; onPointerLeave?: React.PointerEventHandler | undefined; onPointerLeaveCapture?: React.PointerEventHandler | undefined; onPointerOver?: React.PointerEventHandler | undefined; onPointerOverCapture?: React.PointerEventHandler | undefined; onPointerOut?: React.PointerEventHandler | undefined; onPointerOutCapture?: React.PointerEventHandler | undefined; onGotPointerCapture?: React.PointerEventHandler | undefined; onGotPointerCaptureCapture?: React.PointerEventHandler | undefined; onLostPointerCapture?: React.PointerEventHandler | undefined; onLostPointerCaptureCapture?: React.PointerEventHandler | undefined; onScroll?: React.UIEventHandler | undefined; onScrollCapture?: React.UIEventHandler | undefined; onWheel?: React.WheelEventHandler | undefined; onWheelCapture?: React.WheelEventHandler | undefined; onAnimationStart?: React.AnimationEventHandler | undefined; onAnimationStartCapture?: React.AnimationEventHandler | undefined; onAnimationEnd?: React.AnimationEventHandler | undefined; onAnimationEndCapture?: React.AnimationEventHandler | undefined; onAnimationIteration?: React.AnimationEventHandler | undefined; onAnimationIterationCapture?: React.AnimationEventHandler | undefined; onTransitionEnd?: React.TransitionEventHandler | undefined; onTransitionEndCapture?: React.TransitionEventHandler | undefined; 'data-test-subj'?: string | undefined; render?: ((value: any, record: ", { "pluginId": "savedObjectsManagement", "scope": "public", diff --git a/api_docs/saved_objects_management.mdx b/api_docs/saved_objects_management.mdx index 195617e70af50a..af0cc2d5ddded2 100644 --- a/api_docs/saved_objects_management.mdx +++ b/api_docs/saved_objects_management.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/savedObjectsManagement title: "savedObjectsManagement" image: https://source.unsplash.com/400x175/?github summary: API docs for the savedObjectsManagement plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'savedObjectsManagement'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/saved_objects_tagging.mdx b/api_docs/saved_objects_tagging.mdx index 7df65d6384cbad..d16caea1cd5423 100644 --- a/api_docs/saved_objects_tagging.mdx +++ b/api_docs/saved_objects_tagging.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/savedObjectsTagging title: "savedObjectsTagging" image: https://source.unsplash.com/400x175/?github summary: API docs for the savedObjectsTagging plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'savedObjectsTagging'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/saved_objects_tagging_oss.mdx b/api_docs/saved_objects_tagging_oss.mdx index 9098ec908eb52b..07a494ac669397 100644 --- a/api_docs/saved_objects_tagging_oss.mdx +++ b/api_docs/saved_objects_tagging_oss.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/savedObjectsTaggingOss title: "savedObjectsTaggingOss" image: https://source.unsplash.com/400x175/?github summary: API docs for the savedObjectsTaggingOss plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'savedObjectsTaggingOss'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/screenshot_mode.mdx b/api_docs/screenshot_mode.mdx index 5b05c998cb2108..842245d46f72e1 100644 --- a/api_docs/screenshot_mode.mdx +++ b/api_docs/screenshot_mode.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/screenshotMode title: "screenshotMode" image: https://source.unsplash.com/400x175/?github summary: API docs for the screenshotMode plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'screenshotMode'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/screenshotting.devdocs.json b/api_docs/screenshotting.devdocs.json index 61fae68af4724c..d2fbf0545d8beb 100644 --- a/api_docs/screenshotting.devdocs.json +++ b/api_docs/screenshotting.devdocs.json @@ -4,21 +4,7 @@ "classes": [], "functions": [], "interfaces": [], - "enums": [ - { - "parentPluginId": "screenshotting", - "id": "def-public.LayoutTypes", - "type": "Enum", - "tags": [], - "label": "LayoutTypes", - "description": [ - "\nSupported layout types." - ], - "path": "x-pack/plugins/screenshotting/common/layout.ts", - "deprecated": false, - "initialIsOpen": false - } - ], + "enums": [], "misc": [ { "parentPluginId": "screenshotting", @@ -134,8 +120,8 @@ "pluginId": "screenshotting", "scope": "common", "docId": "kibScreenshottingPluginApi", - "section": "def-common.LayoutTypes", - "text": "LayoutTypes" + "section": "def-common.LayoutType", + "text": "LayoutType" }, " | undefined; dimensions?: { width: number; height: number; } | undefined; selectors?: Partial<", "LayoutSelectorDictionary", @@ -270,15 +256,7 @@ "label": "layout", "description": [], "signature": [ - "{ id?: ", - { - "pluginId": "screenshotting", - "scope": "common", - "docId": "kibScreenshottingPluginApi", - "section": "def-common.LayoutTypes", - "text": "LayoutTypes" - }, - ".PRESERVE_LAYOUT | undefined; dimensions?: { width: number; height: number; } | undefined; selectors?: Partial<", + "{ id?: \"preserve_layout\" | undefined; dimensions?: { width: number; height: number; } | undefined; selectors?: Partial<", "LayoutSelectorDictionary", "> | undefined; zoom?: number | undefined; } | undefined" ], @@ -478,21 +456,7 @@ "classes": [], "functions": [], "interfaces": [], - "enums": [ - { - "parentPluginId": "screenshotting", - "id": "def-common.LayoutTypes", - "type": "Enum", - "tags": [], - "label": "LayoutTypes", - "description": [ - "\nSupported layout types." - ], - "path": "x-pack/plugins/screenshotting/common/layout.ts", - "deprecated": false, - "initialIsOpen": false - } - ], + "enums": [], "misc": [ { "parentPluginId": "screenshotting", @@ -518,6 +482,22 @@ "deprecated": false, "initialIsOpen": false }, + { + "parentPluginId": "screenshotting", + "id": "def-common.LayoutType", + "type": "Type", + "tags": [], + "label": "LayoutType", + "description": [ + "\nSupported layout types." + ], + "signature": [ + "\"canvas\" | \"preserve_layout\" | \"print\"" + ], + "path": "x-pack/plugins/screenshotting/common/layout.ts", + "deprecated": false, + "initialIsOpen": false + }, { "parentPluginId": "screenshotting", "id": "def-common.PLUGIN_ID", diff --git a/api_docs/screenshotting.mdx b/api_docs/screenshotting.mdx index 69bd8874e10a61..d3c49f9fcbae03 100644 --- a/api_docs/screenshotting.mdx +++ b/api_docs/screenshotting.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/screenshotting title: "screenshotting" image: https://source.unsplash.com/400x175/?github summary: API docs for the screenshotting plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'screenshotting'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,13 +18,10 @@ Contact [Kibana Reporting Services](https://github.com/orgs/elastic/teams/kibana | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 28 | 0 | 8 | 4 | +| 27 | 0 | 8 | 4 | ## Client -### Enums - - ### Consts, variables and types @@ -41,9 +38,6 @@ Contact [Kibana Reporting Services](https://github.com/orgs/elastic/teams/kibana ## Common -### Enums - - ### Consts, variables and types diff --git a/api_docs/security.mdx b/api_docs/security.mdx index 66e878e0ee30e6..4e603b405d752e 100644 --- a/api_docs/security.mdx +++ b/api_docs/security.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/security title: "security" image: https://source.unsplash.com/400x175/?github summary: API docs for the security plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'security'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/security_solution.devdocs.json b/api_docs/security_solution.devdocs.json index b510d12d18d8f6..7603cbcdce2aeb 100644 --- a/api_docs/security_solution.devdocs.json +++ b/api_docs/security_solution.devdocs.json @@ -62,7 +62,7 @@ "label": "experimentalFeatures", "description": [], "signature": [ - "{ readonly tGridEnabled: boolean; readonly tGridEventRenderedViewEnabled: boolean; readonly excludePoliciesInFilterEnabled: boolean; readonly usersEnabled: boolean; readonly detectionResponseEnabled: boolean; readonly disableIsolationUIPendingStatuses: boolean; readonly riskyHostsEnabled: boolean; readonly riskyUsersEnabled: boolean; readonly pendingActionResponsesWithAck: boolean; readonly policyListEnabled: boolean; readonly groupedNavigation: boolean; readonly previewTelemetryUrlEnabled: boolean; readonly responseActionsConsoleEnabled: boolean; }" + "{ readonly tGridEnabled: boolean; readonly tGridEventRenderedViewEnabled: boolean; readonly excludePoliciesInFilterEnabled: boolean; readonly usersEnabled: boolean; readonly kubernetesEnabled: boolean; readonly disableIsolationUIPendingStatuses: boolean; readonly riskyHostsEnabled: boolean; readonly riskyUsersEnabled: boolean; readonly pendingActionResponsesWithAck: boolean; readonly policyListEnabled: boolean; readonly policyResponseInFleetEnabled: boolean; readonly groupedNavigation: boolean; readonly previewTelemetryUrlEnabled: boolean; readonly responseActionsConsoleEnabled: boolean; }" ], "path": "x-pack/plugins/security_solution/public/plugin.tsx", "deprecated": false @@ -254,6 +254,68 @@ "deprecated": false, "children": [], "returnComment": [] + }, + { + "parentPluginId": "securitySolution", + "id": "def-public.Plugin.registerAppLinks", + "type": "Function", + "tags": [], + "label": "registerAppLinks", + "description": [ + "\nRegister deepLinks and appUpdater for all app links, to change deepLinks as needed when licensing changes." + ], + "signature": [ + "(core: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.CoreStart", + "text": "CoreStart" + }, + ", plugins: ", + "StartPlugins", + ") => Promise" + ], + "path": "x-pack/plugins/security_solution/public/plugin.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "securitySolution", + "id": "def-public.Plugin.registerAppLinks.$1", + "type": "Object", + "tags": [], + "label": "core", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.CoreStart", + "text": "CoreStart" + } + ], + "path": "x-pack/plugins/security_solution/public/plugin.tsx", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "securitySolution", + "id": "def-public.Plugin.registerAppLinks.$2", + "type": "Object", + "tags": [], + "label": "plugins", + "description": [], + "signature": [ + "StartPlugins" + ], + "path": "x-pack/plugins/security_solution/public/plugin.tsx", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] } ], "initialIsOpen": false @@ -953,7 +1015,7 @@ "label": "ConfigType", "description": [], "signature": [ - "Readonly<{} & { signalsIndex: string; maxRuleImportExportSize: number; maxRuleImportPayloadBytes: number; maxTimelineImportExportSize: number; maxTimelineImportPayloadBytes: number; alertMergeStrategy: \"allFields\" | \"missingFields\" | \"noFields\"; alertIgnoreFields: string[]; enableExperimental: string[]; packagerTaskInterval: string; prebuiltRulesFromFileSystem: boolean; prebuiltRulesFromSavedObjects: boolean; }> & { experimentalFeatures: Readonly<{ tGridEnabled: boolean; tGridEventRenderedViewEnabled: boolean; excludePoliciesInFilterEnabled: boolean; usersEnabled: boolean; detectionResponseEnabled: boolean; disableIsolationUIPendingStatuses: boolean; riskyHostsEnabled: boolean; riskyUsersEnabled: boolean; pendingActionResponsesWithAck: boolean; policyListEnabled: boolean; groupedNavigation: boolean; previewTelemetryUrlEnabled: boolean; responseActionsConsoleEnabled: boolean; }>; }" + "Readonly<{} & { signalsIndex: string; maxRuleImportExportSize: number; maxRuleImportPayloadBytes: number; maxTimelineImportExportSize: number; maxTimelineImportPayloadBytes: number; alertMergeStrategy: \"allFields\" | \"missingFields\" | \"noFields\"; alertIgnoreFields: string[]; enableExperimental: string[]; packagerTaskInterval: string; prebuiltRulesFromFileSystem: boolean; prebuiltRulesFromSavedObjects: boolean; }> & { experimentalFeatures: Readonly<{ tGridEnabled: boolean; tGridEventRenderedViewEnabled: boolean; excludePoliciesInFilterEnabled: boolean; usersEnabled: boolean; kubernetesEnabled: boolean; disableIsolationUIPendingStatuses: boolean; riskyHostsEnabled: boolean; riskyUsersEnabled: boolean; pendingActionResponsesWithAck: boolean; policyListEnabled: boolean; policyResponseInFleetEnabled: boolean; groupedNavigation: boolean; previewTelemetryUrlEnabled: boolean; responseActionsConsoleEnabled: boolean; }>; }" ], "path": "x-pack/plugins/security_solution/server/config.ts", "deprecated": false, diff --git a/api_docs/security_solution.mdx b/api_docs/security_solution.mdx index a37edc96d2060c..ad7ef9cac8971f 100644 --- a/api_docs/security_solution.mdx +++ b/api_docs/security_solution.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/securitySolution title: "securitySolution" image: https://source.unsplash.com/400x175/?github summary: API docs for the securitySolution plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'securitySolution'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Security solution](https://github.com/orgs/elastic/teams/security-solut | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 49 | 0 | 49 | 21 | +| 52 | 0 | 51 | 21 | ## Client diff --git a/api_docs/session_view.mdx b/api_docs/session_view.mdx index d3b6d17e7624da..c2545a31f65adc 100644 --- a/api_docs/session_view.mdx +++ b/api_docs/session_view.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/sessionView title: "sessionView" image: https://source.unsplash.com/400x175/?github summary: API docs for the sessionView plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'sessionView'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/share.mdx b/api_docs/share.mdx index 7b69549f62cf1d..95891eb30ca5e8 100644 --- a/api_docs/share.mdx +++ b/api_docs/share.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/share title: "share" image: https://source.unsplash.com/400x175/?github summary: API docs for the share plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'share'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/shared_u_x.mdx b/api_docs/shared_u_x.mdx index a2d2fbc185419c..02e774926f40ce 100644 --- a/api_docs/shared_u_x.mdx +++ b/api_docs/shared_u_x.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/sharedUX title: "sharedUX" image: https://source.unsplash.com/400x175/?github summary: API docs for the sharedUX plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'sharedUX'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/snapshot_restore.mdx b/api_docs/snapshot_restore.mdx index 25e2f00a1770c5..cc2366dabe29a7 100644 --- a/api_docs/snapshot_restore.mdx +++ b/api_docs/snapshot_restore.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/snapshotRestore title: "snapshotRestore" image: https://source.unsplash.com/400x175/?github summary: API docs for the snapshotRestore plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'snapshotRestore'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/spaces.mdx b/api_docs/spaces.mdx index 4156c70193c839..30364ed1318b40 100644 --- a/api_docs/spaces.mdx +++ b/api_docs/spaces.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/spaces title: "spaces" image: https://source.unsplash.com/400x175/?github summary: API docs for the spaces plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'spaces'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/stack_alerts.mdx b/api_docs/stack_alerts.mdx index 1137da3a6a530f..fd893072b29425 100644 --- a/api_docs/stack_alerts.mdx +++ b/api_docs/stack_alerts.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/stackAlerts title: "stackAlerts" image: https://source.unsplash.com/400x175/?github summary: API docs for the stackAlerts plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'stackAlerts'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/task_manager.mdx b/api_docs/task_manager.mdx index efaf83f850bb48..3e6e0fe3f0f404 100644 --- a/api_docs/task_manager.mdx +++ b/api_docs/task_manager.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/taskManager title: "taskManager" image: https://source.unsplash.com/400x175/?github summary: API docs for the taskManager plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'taskManager'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/telemetry.mdx b/api_docs/telemetry.mdx index 5fb46d9a614fd2..740047f0ec7d02 100644 --- a/api_docs/telemetry.mdx +++ b/api_docs/telemetry.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/telemetry title: "telemetry" image: https://source.unsplash.com/400x175/?github summary: API docs for the telemetry plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'telemetry'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/telemetry_collection_manager.mdx b/api_docs/telemetry_collection_manager.mdx index 866ba5d473b011..4d296963847df1 100644 --- a/api_docs/telemetry_collection_manager.mdx +++ b/api_docs/telemetry_collection_manager.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/telemetryCollectionManager title: "telemetryCollectionManager" image: https://source.unsplash.com/400x175/?github summary: API docs for the telemetryCollectionManager plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'telemetryCollectionManager'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/telemetry_collection_xpack.mdx b/api_docs/telemetry_collection_xpack.mdx index e2a078c59465fc..fa633c57e6610b 100644 --- a/api_docs/telemetry_collection_xpack.mdx +++ b/api_docs/telemetry_collection_xpack.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/telemetryCollectionXpack title: "telemetryCollectionXpack" image: https://source.unsplash.com/400x175/?github summary: API docs for the telemetryCollectionXpack plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'telemetryCollectionXpack'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/telemetry_management_section.mdx b/api_docs/telemetry_management_section.mdx index 257046f752eca8..c08f17cf85bf5e 100644 --- a/api_docs/telemetry_management_section.mdx +++ b/api_docs/telemetry_management_section.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/telemetryManagementSection title: "telemetryManagementSection" image: https://source.unsplash.com/400x175/?github summary: API docs for the telemetryManagementSection plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'telemetryManagementSection'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/timelines.mdx b/api_docs/timelines.mdx index 0bcefaf0d0c03c..8a556ed142a9c3 100644 --- a/api_docs/timelines.mdx +++ b/api_docs/timelines.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/timelines title: "timelines" image: https://source.unsplash.com/400x175/?github summary: API docs for the timelines plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'timelines'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/transform.mdx b/api_docs/transform.mdx index e347e792da4df2..4e987b57a104ce 100644 --- a/api_docs/transform.mdx +++ b/api_docs/transform.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/transform title: "transform" image: https://source.unsplash.com/400x175/?github summary: API docs for the transform plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'transform'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/triggers_actions_ui.devdocs.json b/api_docs/triggers_actions_ui.devdocs.json index 66cfb23af2a459..012218453a20fc 100644 --- a/api_docs/triggers_actions_ui.devdocs.json +++ b/api_docs/triggers_actions_ui.devdocs.json @@ -729,6 +729,24 @@ "returnComment": [], "initialIsOpen": false }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.getNotifyWhenOptions", + "type": "Function", + "tags": [], + "label": "getNotifyWhenOptions", + "description": [], + "signature": [ + "() => Promise<", + "EuiSuperSelectOption", + "<\"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\">[]>" + ], + "path": "x-pack/plugins/triggers_actions_ui/public/index.ts", + "deprecated": false, + "children": [], + "returnComment": [], + "initialIsOpen": false + }, { "parentPluginId": "triggersActionsUi", "id": "def-public.getTimeFieldOptions", @@ -2043,6 +2061,42 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.AlertsTableFlyoutBaseProps", + "type": "Interface", + "tags": [], + "label": "AlertsTableFlyoutBaseProps", + "description": [], + "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.AlertsTableFlyoutBaseProps.alert", + "type": "Object", + "tags": [], + "label": "alert", + "description": [], + "signature": [ + "{ [x: `email.to.${number}`]: string[]; [x: `email.cc.${number}`]: string[]; [x: `email.bcc.${number}`]: string[]; [x: `email.attachments.${number}`]: string[]; [x: `user.roles.${number}`]: string[]; [x: `user.target.roles.${number}`]: string[]; [x: `user.changes.roles.${number}`]: string[]; [x: `user.effective.roles.${number}`]: string[]; [x: `source.user.roles.${number}`]: string[]; [x: `tags.${number}`]: string[]; [x: `client.user.roles.${number}`]: string[]; [x: `file.attributes.${number}`]: string[]; [x: `file.elf.exports.${number}`]: string[]; [x: `file.elf.imports.${number}`]: string[]; [x: `file.elf.sections.${number}`]: string[]; [x: `file.elf.segments.${number}`]: string[]; [x: `file.elf.shared_libraries.${number}`]: string[]; [x: `file.x509.issuer.organization.${number}`]: string[]; [x: `file.x509.issuer.common_name.${number}`]: string[]; [x: `file.x509.issuer.country.${number}`]: string[]; [x: `file.x509.issuer.locality.${number}`]: string[]; [x: `file.x509.issuer.organizational_unit.${number}`]: string[]; [x: `file.x509.issuer.state_or_province.${number}`]: string[]; [x: `file.x509.subject.organization.${number}`]: string[]; [x: `file.x509.subject.common_name.${number}`]: string[]; [x: `file.x509.subject.country.${number}`]: string[]; [x: `file.x509.subject.locality.${number}`]: string[]; [x: `file.x509.subject.organizational_unit.${number}`]: string[]; [x: `file.x509.subject.state_or_province.${number}`]: string[]; [x: `file.x509.alternative_names.${number}`]: string[]; [x: `host.ip.${number}`]: string[]; [x: `host.mac.${number}`]: string[]; [x: `container.image.tag.${number}`]: string[]; [x: `server.user.roles.${number}`]: string[]; [x: `rule.author.${number}`]: string[]; [x: `event.type.${number}`]: string[]; [x: `event.category.${number}`]: string[]; [x: `registry.data.strings.${number}`]: string[]; [x: `destination.user.roles.${number}`]: string[]; [x: `dns.answers.${number}`]: string[]; [x: `dns.header_flags.${number}`]: string[]; [x: `dns.resolved_ip.${number}`]: string[]; [x: `observer.ip.${number}`]: string[]; [x: `observer.mac.${number}`]: string[]; [x: `process.elf.exports.${number}`]: string[]; [x: `process.elf.imports.${number}`]: string[]; [x: `process.elf.sections.${number}`]: string[]; [x: `process.elf.segments.${number}`]: string[]; [x: `process.elf.shared_libraries.${number}`]: string[]; [x: `process.args.${number}`]: string[]; [x: `process.parent.args.${number}`]: string[]; [x: `process.target.args.${number}`]: string[]; [x: `process.parent.elf.exports.${number}`]: string[]; [x: `process.parent.elf.imports.${number}`]: string[]; [x: `process.parent.elf.sections.${number}`]: string[]; [x: `process.parent.elf.segments.${number}`]: string[]; [x: `process.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.args.${number}`]: string[]; [x: `process.parent.target.args.${number}`]: string[]; [x: `process.target.elf.exports.${number}`]: string[]; [x: `process.target.elf.imports.${number}`]: string[]; [x: `process.target.elf.sections.${number}`]: string[]; [x: `process.target.elf.segments.${number}`]: string[]; [x: `process.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.args.${number}`]: string[]; [x: `process.target.target.args.${number}`]: string[]; [x: `process.parent.parent.elf.exports.${number}`]: string[]; [x: `process.parent.parent.elf.imports.${number}`]: string[]; [x: `process.parent.parent.elf.sections.${number}`]: string[]; [x: `process.parent.parent.elf.segments.${number}`]: string[]; [x: `process.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.parent.args.${number}`]: string[]; [x: `process.parent.parent.target.args.${number}`]: string[]; [x: `process.parent.target.elf.exports.${number}`]: string[]; [x: `process.parent.target.elf.imports.${number}`]: string[]; [x: `process.parent.target.elf.sections.${number}`]: string[]; [x: `process.parent.target.elf.segments.${number}`]: string[]; [x: `process.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.parent.args.${number}`]: string[]; [x: `process.parent.target.target.args.${number}`]: string[]; [x: `process.target.parent.elf.exports.${number}`]: string[]; [x: `process.target.parent.elf.imports.${number}`]: string[]; [x: `process.target.parent.elf.sections.${number}`]: string[]; [x: `process.target.parent.elf.segments.${number}`]: string[]; [x: `process.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.parent.args.${number}`]: string[]; [x: `process.target.parent.target.args.${number}`]: string[]; [x: `process.target.target.elf.exports.${number}`]: string[]; [x: `process.target.target.elf.imports.${number}`]: string[]; [x: `process.target.target.elf.sections.${number}`]: string[]; [x: `process.target.target.elf.segments.${number}`]: string[]; [x: `process.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.parent.args.${number}`]: string[]; [x: `process.target.target.target.args.${number}`]: string[]; [x: `process.parent.parent.parent.elf.exports.${number}`]: string[]; [x: `process.parent.parent.parent.elf.imports.${number}`]: string[]; [x: `process.parent.parent.parent.elf.sections.${number}`]: string[]; [x: `process.parent.parent.parent.elf.segments.${number}`]: string[]; [x: `process.parent.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.parent.parent.args.${number}`]: string[]; [x: `process.parent.parent.parent.target.args.${number}`]: string[]; [x: `process.parent.parent.target.elf.exports.${number}`]: string[]; [x: `process.parent.parent.target.elf.imports.${number}`]: string[]; [x: `process.parent.parent.target.elf.sections.${number}`]: string[]; [x: `process.parent.parent.target.elf.segments.${number}`]: string[]; [x: `process.parent.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.target.parent.args.${number}`]: string[]; [x: `process.parent.parent.target.target.args.${number}`]: string[]; [x: `process.parent.target.parent.elf.exports.${number}`]: string[]; [x: `process.parent.target.parent.elf.imports.${number}`]: string[]; [x: `process.parent.target.parent.elf.sections.${number}`]: string[]; [x: `process.parent.target.parent.elf.segments.${number}`]: string[]; [x: `process.parent.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.parent.parent.args.${number}`]: string[]; [x: `process.parent.target.parent.target.args.${number}`]: string[]; [x: `process.parent.target.target.elf.exports.${number}`]: string[]; [x: `process.parent.target.target.elf.imports.${number}`]: string[]; [x: `process.parent.target.target.elf.sections.${number}`]: string[]; [x: `process.parent.target.target.elf.segments.${number}`]: string[]; [x: `process.parent.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.target.parent.args.${number}`]: string[]; [x: `process.parent.target.target.target.args.${number}`]: string[]; [x: `process.target.parent.parent.elf.exports.${number}`]: string[]; [x: `process.target.parent.parent.elf.imports.${number}`]: string[]; [x: `process.target.parent.parent.elf.sections.${number}`]: string[]; [x: `process.target.parent.parent.elf.segments.${number}`]: string[]; [x: `process.target.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.parent.parent.args.${number}`]: string[]; [x: `process.target.parent.parent.target.args.${number}`]: string[]; [x: `process.target.parent.target.elf.exports.${number}`]: string[]; [x: `process.target.parent.target.elf.imports.${number}`]: string[]; [x: `process.target.parent.target.elf.sections.${number}`]: string[]; [x: `process.target.parent.target.elf.segments.${number}`]: string[]; [x: `process.target.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.target.parent.args.${number}`]: string[]; [x: `process.target.parent.target.target.args.${number}`]: string[]; [x: `process.target.target.parent.elf.exports.${number}`]: string[]; [x: `process.target.target.parent.elf.imports.${number}`]: string[]; [x: `process.target.target.parent.elf.sections.${number}`]: string[]; [x: `process.target.target.parent.elf.segments.${number}`]: string[]; [x: `process.target.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.parent.parent.args.${number}`]: string[]; [x: `process.target.target.parent.target.args.${number}`]: string[]; [x: `process.target.target.target.elf.exports.${number}`]: string[]; [x: `process.target.target.target.elf.imports.${number}`]: string[]; [x: `process.target.target.target.elf.sections.${number}`]: string[]; [x: `process.target.target.target.elf.segments.${number}`]: string[]; [x: `process.target.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.target.parent.args.${number}`]: string[]; [x: `process.target.target.target.target.args.${number}`]: string[]; [x: `process.parent.parent.parent.parent.elf.exports.${number}`]: string[]; [x: `process.parent.parent.parent.parent.elf.imports.${number}`]: string[]; [x: `process.parent.parent.parent.parent.elf.sections.${number}`]: string[]; [x: `process.parent.parent.parent.parent.elf.segments.${number}`]: string[]; [x: `process.parent.parent.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.args.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.args.${number}`]: string[]; [x: `process.parent.parent.parent.target.elf.exports.${number}`]: string[]; [x: `process.parent.parent.parent.target.elf.imports.${number}`]: string[]; [x: `process.parent.parent.parent.target.elf.sections.${number}`]: string[]; [x: `process.parent.parent.parent.target.elf.segments.${number}`]: string[]; [x: `process.parent.parent.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.args.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.args.${number}`]: string[]; [x: `process.parent.parent.target.parent.elf.exports.${number}`]: string[]; [x: `process.parent.parent.target.parent.elf.imports.${number}`]: string[]; [x: `process.parent.parent.target.parent.elf.sections.${number}`]: string[]; [x: `process.parent.parent.target.parent.elf.segments.${number}`]: string[]; [x: `process.parent.parent.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.args.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.args.${number}`]: string[]; [x: `process.parent.parent.target.target.elf.exports.${number}`]: string[]; [x: `process.parent.parent.target.target.elf.imports.${number}`]: string[]; [x: `process.parent.parent.target.target.elf.sections.${number}`]: string[]; [x: `process.parent.parent.target.target.elf.segments.${number}`]: string[]; [x: `process.parent.parent.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.args.${number}`]: string[]; [x: `process.parent.parent.target.target.target.args.${number}`]: string[]; [x: `process.parent.target.parent.parent.elf.exports.${number}`]: string[]; [x: `process.parent.target.parent.parent.elf.imports.${number}`]: string[]; [x: `process.parent.target.parent.parent.elf.sections.${number}`]: string[]; [x: `process.parent.target.parent.parent.elf.segments.${number}`]: string[]; [x: `process.parent.target.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.args.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.args.${number}`]: string[]; [x: `process.parent.target.parent.target.elf.exports.${number}`]: string[]; [x: `process.parent.target.parent.target.elf.imports.${number}`]: string[]; [x: `process.parent.target.parent.target.elf.sections.${number}`]: string[]; [x: `process.parent.target.parent.target.elf.segments.${number}`]: string[]; [x: `process.parent.target.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.args.${number}`]: string[]; [x: `process.parent.target.parent.target.target.args.${number}`]: string[]; [x: `process.parent.target.target.parent.elf.exports.${number}`]: string[]; [x: `process.parent.target.target.parent.elf.imports.${number}`]: string[]; [x: `process.parent.target.target.parent.elf.sections.${number}`]: string[]; [x: `process.parent.target.target.parent.elf.segments.${number}`]: string[]; [x: `process.parent.target.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.args.${number}`]: string[]; [x: `process.parent.target.target.parent.target.args.${number}`]: string[]; [x: `process.parent.target.target.target.elf.exports.${number}`]: string[]; [x: `process.parent.target.target.target.elf.imports.${number}`]: string[]; [x: `process.parent.target.target.target.elf.sections.${number}`]: string[]; [x: `process.parent.target.target.target.elf.segments.${number}`]: string[]; [x: `process.parent.target.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.target.target.parent.args.${number}`]: string[]; [x: `process.parent.target.target.target.target.args.${number}`]: string[]; [x: `process.target.parent.parent.parent.elf.exports.${number}`]: string[]; [x: `process.target.parent.parent.parent.elf.imports.${number}`]: string[]; [x: `process.target.parent.parent.parent.elf.sections.${number}`]: string[]; [x: `process.target.parent.parent.parent.elf.segments.${number}`]: string[]; [x: `process.target.parent.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.args.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.args.${number}`]: string[]; [x: `process.target.parent.parent.target.elf.exports.${number}`]: string[]; [x: `process.target.parent.parent.target.elf.imports.${number}`]: string[]; [x: `process.target.parent.parent.target.elf.sections.${number}`]: string[]; [x: `process.target.parent.parent.target.elf.segments.${number}`]: string[]; [x: `process.target.parent.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.args.${number}`]: string[]; [x: `process.target.parent.parent.target.target.args.${number}`]: string[]; [x: `process.target.parent.target.parent.elf.exports.${number}`]: string[]; [x: `process.target.parent.target.parent.elf.imports.${number}`]: string[]; [x: `process.target.parent.target.parent.elf.sections.${number}`]: string[]; [x: `process.target.parent.target.parent.elf.segments.${number}`]: string[]; [x: `process.target.parent.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.args.${number}`]: string[]; [x: `process.target.parent.target.parent.target.args.${number}`]: string[]; [x: `process.target.parent.target.target.elf.exports.${number}`]: string[]; [x: `process.target.parent.target.target.elf.imports.${number}`]: string[]; [x: `process.target.parent.target.target.elf.sections.${number}`]: string[]; [x: `process.target.parent.target.target.elf.segments.${number}`]: string[]; [x: `process.target.parent.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.target.target.parent.args.${number}`]: string[]; [x: `process.target.parent.target.target.target.args.${number}`]: string[]; [x: `process.target.target.parent.parent.elf.exports.${number}`]: string[]; [x: `process.target.target.parent.parent.elf.imports.${number}`]: string[]; [x: `process.target.target.parent.parent.elf.sections.${number}`]: string[]; [x: `process.target.target.parent.parent.elf.segments.${number}`]: string[]; [x: `process.target.target.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.args.${number}`]: string[]; [x: `process.target.target.parent.parent.target.args.${number}`]: string[]; [x: `process.target.target.parent.target.elf.exports.${number}`]: string[]; [x: `process.target.target.parent.target.elf.imports.${number}`]: string[]; [x: `process.target.target.parent.target.elf.sections.${number}`]: string[]; [x: `process.target.target.parent.target.elf.segments.${number}`]: string[]; [x: `process.target.target.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.parent.target.parent.args.${number}`]: string[]; [x: `process.target.target.parent.target.target.args.${number}`]: string[]; [x: `process.target.target.target.parent.elf.exports.${number}`]: string[]; [x: `process.target.target.target.parent.elf.imports.${number}`]: string[]; [x: `process.target.target.target.parent.elf.sections.${number}`]: string[]; [x: `process.target.target.target.parent.elf.segments.${number}`]: string[]; [x: `process.target.target.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.target.parent.parent.args.${number}`]: string[]; [x: `process.target.target.target.parent.target.args.${number}`]: string[]; [x: `process.target.target.target.target.elf.exports.${number}`]: string[]; [x: `process.target.target.target.target.elf.imports.${number}`]: string[]; [x: `process.target.target.target.target.elf.sections.${number}`]: string[]; [x: `process.target.target.target.target.elf.segments.${number}`]: string[]; [x: `process.target.target.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.target.target.parent.args.${number}`]: string[]; [x: `process.target.target.target.target.target.args.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.elf.exports.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.elf.imports.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.elf.sections.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.elf.segments.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.parent.args.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.target.args.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.elf.exports.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.elf.imports.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.elf.sections.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.elf.segments.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.parent.args.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.target.args.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.elf.exports.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.elf.imports.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.elf.sections.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.elf.segments.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.parent.args.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.target.args.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.elf.exports.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.elf.imports.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.elf.sections.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.elf.segments.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.parent.args.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.target.args.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.elf.exports.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.elf.imports.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.elf.sections.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.elf.segments.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.parent.args.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.target.args.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.elf.exports.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.elf.imports.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.elf.sections.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.elf.segments.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.parent.args.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.target.args.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.elf.exports.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.elf.imports.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.elf.sections.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.elf.segments.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.parent.args.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.target.args.${number}`]: string[]; [x: `process.parent.parent.target.target.target.elf.exports.${number}`]: string[]; [x: `process.parent.parent.target.target.target.elf.imports.${number}`]: string[]; [x: `process.parent.parent.target.target.target.elf.sections.${number}`]: string[]; [x: `process.parent.parent.target.target.target.elf.segments.${number}`]: string[]; [x: `process.parent.parent.target.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.target.target.target.parent.args.${number}`]: string[]; [x: `process.parent.parent.target.target.target.target.args.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.elf.exports.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.elf.imports.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.elf.sections.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.elf.segments.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.parent.args.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.target.args.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.elf.exports.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.elf.imports.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.elf.sections.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.elf.segments.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.parent.args.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.target.args.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.elf.exports.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.elf.imports.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.elf.sections.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.elf.segments.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.parent.args.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.target.args.${number}`]: string[]; [x: `process.parent.target.parent.target.target.elf.exports.${number}`]: string[]; [x: `process.parent.target.parent.target.target.elf.imports.${number}`]: string[]; [x: `process.parent.target.parent.target.target.elf.sections.${number}`]: string[]; [x: `process.parent.target.parent.target.target.elf.segments.${number}`]: string[]; [x: `process.parent.target.parent.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.parent.target.target.parent.args.${number}`]: string[]; [x: `process.parent.target.parent.target.target.target.args.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.elf.exports.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.elf.imports.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.elf.sections.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.elf.segments.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.parent.args.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.target.args.${number}`]: string[]; [x: `process.parent.target.target.parent.target.elf.exports.${number}`]: string[]; [x: `process.parent.target.target.parent.target.elf.imports.${number}`]: string[]; [x: `process.parent.target.target.parent.target.elf.sections.${number}`]: string[]; [x: `process.parent.target.target.parent.target.elf.segments.${number}`]: string[]; [x: `process.parent.target.target.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.target.parent.target.parent.args.${number}`]: string[]; [x: `process.parent.target.target.parent.target.target.args.${number}`]: string[]; [x: `process.parent.target.target.target.parent.elf.exports.${number}`]: string[]; [x: `process.parent.target.target.target.parent.elf.imports.${number}`]: string[]; [x: `process.parent.target.target.target.parent.elf.sections.${number}`]: string[]; [x: `process.parent.target.target.target.parent.elf.segments.${number}`]: string[]; [x: `process.parent.target.target.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.target.target.parent.parent.args.${number}`]: string[]; [x: `process.parent.target.target.target.parent.target.args.${number}`]: string[]; [x: `process.parent.target.target.target.target.elf.exports.${number}`]: string[]; [x: `process.parent.target.target.target.target.elf.imports.${number}`]: string[]; [x: `process.parent.target.target.target.target.elf.sections.${number}`]: string[]; [x: `process.parent.target.target.target.target.elf.segments.${number}`]: string[]; [x: `process.parent.target.target.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.target.target.target.parent.args.${number}`]: string[]; [x: `process.parent.target.target.target.target.target.args.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.elf.exports.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.elf.imports.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.elf.sections.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.elf.segments.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.parent.args.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.target.args.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.elf.exports.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.elf.imports.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.elf.sections.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.elf.segments.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.parent.args.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.target.args.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.elf.exports.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.elf.imports.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.elf.sections.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.elf.segments.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.parent.args.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.target.args.${number}`]: string[]; [x: `process.target.parent.parent.target.target.elf.exports.${number}`]: string[]; [x: `process.target.parent.parent.target.target.elf.imports.${number}`]: string[]; [x: `process.target.parent.parent.target.target.elf.sections.${number}`]: string[]; [x: `process.target.parent.parent.target.target.elf.segments.${number}`]: string[]; [x: `process.target.parent.parent.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.parent.target.target.parent.args.${number}`]: string[]; [x: `process.target.parent.parent.target.target.target.args.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.elf.exports.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.elf.imports.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.elf.sections.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.elf.segments.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.parent.args.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.target.args.${number}`]: string[]; [x: `process.target.parent.target.parent.target.elf.exports.${number}`]: string[]; [x: `process.target.parent.target.parent.target.elf.imports.${number}`]: string[]; [x: `process.target.parent.target.parent.target.elf.sections.${number}`]: string[]; [x: `process.target.parent.target.parent.target.elf.segments.${number}`]: string[]; [x: `process.target.parent.target.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.target.parent.target.parent.args.${number}`]: string[]; [x: `process.target.parent.target.parent.target.target.args.${number}`]: string[]; [x: `process.target.parent.target.target.parent.elf.exports.${number}`]: string[]; [x: `process.target.parent.target.target.parent.elf.imports.${number}`]: string[]; [x: `process.target.parent.target.target.parent.elf.sections.${number}`]: string[]; [x: `process.target.parent.target.target.parent.elf.segments.${number}`]: string[]; [x: `process.target.parent.target.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.target.target.parent.parent.args.${number}`]: string[]; [x: `process.target.parent.target.target.parent.target.args.${number}`]: string[]; [x: `process.target.parent.target.target.target.elf.exports.${number}`]: string[]; [x: `process.target.parent.target.target.target.elf.imports.${number}`]: string[]; [x: `process.target.parent.target.target.target.elf.sections.${number}`]: string[]; [x: `process.target.parent.target.target.target.elf.segments.${number}`]: string[]; [x: `process.target.parent.target.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.target.target.target.parent.args.${number}`]: string[]; [x: `process.target.parent.target.target.target.target.args.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.elf.exports.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.elf.imports.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.elf.sections.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.elf.segments.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.parent.args.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.target.args.${number}`]: string[]; [x: `process.target.target.parent.parent.target.elf.exports.${number}`]: string[]; [x: `process.target.target.parent.parent.target.elf.imports.${number}`]: string[]; [x: `process.target.target.parent.parent.target.elf.sections.${number}`]: string[]; [x: `process.target.target.parent.parent.target.elf.segments.${number}`]: string[]; [x: `process.target.target.parent.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.parent.parent.target.parent.args.${number}`]: string[]; [x: `process.target.target.parent.parent.target.target.args.${number}`]: string[]; [x: `process.target.target.parent.target.parent.elf.exports.${number}`]: string[]; [x: `process.target.target.parent.target.parent.elf.imports.${number}`]: string[]; [x: `process.target.target.parent.target.parent.elf.sections.${number}`]: string[]; [x: `process.target.target.parent.target.parent.elf.segments.${number}`]: string[]; [x: `process.target.target.parent.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.parent.target.parent.parent.args.${number}`]: string[]; [x: `process.target.target.parent.target.parent.target.args.${number}`]: string[]; [x: `process.target.target.parent.target.target.elf.exports.${number}`]: string[]; [x: `process.target.target.parent.target.target.elf.imports.${number}`]: string[]; [x: `process.target.target.parent.target.target.elf.sections.${number}`]: string[]; [x: `process.target.target.parent.target.target.elf.segments.${number}`]: string[]; [x: `process.target.target.parent.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.parent.target.target.parent.args.${number}`]: string[]; [x: `process.target.target.parent.target.target.target.args.${number}`]: string[]; [x: `process.target.target.target.parent.parent.elf.exports.${number}`]: string[]; [x: `process.target.target.target.parent.parent.elf.imports.${number}`]: string[]; [x: `process.target.target.target.parent.parent.elf.sections.${number}`]: string[]; [x: `process.target.target.target.parent.parent.elf.segments.${number}`]: string[]; [x: `process.target.target.target.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.target.parent.parent.parent.args.${number}`]: string[]; [x: `process.target.target.target.parent.parent.target.args.${number}`]: string[]; [x: `process.target.target.target.parent.target.elf.exports.${number}`]: string[]; [x: `process.target.target.target.parent.target.elf.imports.${number}`]: string[]; [x: `process.target.target.target.parent.target.elf.sections.${number}`]: string[]; [x: `process.target.target.target.parent.target.elf.segments.${number}`]: string[]; [x: `process.target.target.target.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.target.parent.target.parent.args.${number}`]: string[]; [x: `process.target.target.target.parent.target.target.args.${number}`]: string[]; [x: `process.target.target.target.target.parent.elf.exports.${number}`]: string[]; [x: `process.target.target.target.target.parent.elf.imports.${number}`]: string[]; [x: `process.target.target.target.target.parent.elf.sections.${number}`]: string[]; [x: `process.target.target.target.target.parent.elf.segments.${number}`]: string[]; [x: `process.target.target.target.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.target.target.parent.parent.args.${number}`]: string[]; [x: `process.target.target.target.target.parent.target.args.${number}`]: string[]; [x: `process.target.target.target.target.target.elf.exports.${number}`]: string[]; [x: `process.target.target.target.target.target.elf.imports.${number}`]: string[]; [x: `process.target.target.target.target.target.elf.sections.${number}`]: string[]; [x: `process.target.target.target.target.target.elf.segments.${number}`]: string[]; [x: `process.target.target.target.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.target.target.target.parent.args.${number}`]: string[]; [x: `process.target.target.target.target.target.target.args.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.parent.elf.exports.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.parent.elf.imports.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.parent.elf.sections.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.parent.elf.segments.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.parent.parent.args.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.parent.target.args.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.target.elf.exports.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.target.elf.imports.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.target.elf.sections.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.target.elf.segments.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.target.parent.args.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.target.target.args.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.parent.elf.exports.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.parent.elf.imports.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.parent.elf.sections.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.parent.elf.segments.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.parent.parent.args.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.parent.target.args.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.target.elf.exports.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.target.elf.imports.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.target.elf.sections.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.target.elf.segments.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.target.parent.args.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.target.target.args.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.parent.elf.exports.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.parent.elf.imports.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.parent.elf.sections.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.parent.elf.segments.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.parent.parent.args.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.parent.target.args.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.target.elf.exports.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.target.elf.imports.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.target.elf.sections.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.target.elf.segments.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.target.parent.args.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.target.target.args.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.parent.elf.exports.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.parent.elf.imports.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.parent.elf.sections.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.parent.elf.segments.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.parent.parent.args.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.parent.target.args.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.target.elf.exports.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.target.elf.imports.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.target.elf.sections.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.target.elf.segments.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.target.parent.args.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.target.target.args.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.parent.elf.exports.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.parent.elf.imports.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.parent.elf.sections.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.parent.elf.segments.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.parent.parent.args.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.parent.target.args.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.target.elf.exports.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.target.elf.imports.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.target.elf.sections.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.target.elf.segments.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.target.parent.args.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.target.target.args.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.parent.elf.exports.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.parent.elf.imports.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.parent.elf.sections.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.parent.elf.segments.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.parent.parent.args.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.parent.target.args.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.target.elf.exports.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.target.elf.imports.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.target.elf.sections.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.target.elf.segments.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.target.parent.args.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.target.target.args.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.parent.elf.exports.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.parent.elf.imports.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.parent.elf.sections.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.parent.elf.segments.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.parent.parent.args.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.parent.target.args.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.target.elf.exports.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.target.elf.imports.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.target.elf.sections.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.target.elf.segments.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.target.parent.args.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.target.target.args.${number}`]: string[]; [x: `process.parent.parent.target.target.target.parent.elf.exports.${number}`]: string[]; [x: `process.parent.parent.target.target.target.parent.elf.imports.${number}`]: string[]; [x: `process.parent.parent.target.target.target.parent.elf.sections.${number}`]: string[]; [x: `process.parent.parent.target.target.target.parent.elf.segments.${number}`]: string[]; [x: `process.parent.parent.target.target.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.target.target.target.parent.parent.args.${number}`]: string[]; [x: `process.parent.parent.target.target.target.parent.target.args.${number}`]: string[]; [x: `process.parent.parent.target.target.target.target.elf.exports.${number}`]: string[]; [x: `process.parent.parent.target.target.target.target.elf.imports.${number}`]: string[]; [x: `process.parent.parent.target.target.target.target.elf.sections.${number}`]: string[]; [x: `process.parent.parent.target.target.target.target.elf.segments.${number}`]: string[]; [x: `process.parent.parent.target.target.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.target.target.target.target.parent.args.${number}`]: string[]; [x: `process.parent.parent.target.target.target.target.target.args.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.parent.elf.exports.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.parent.elf.imports.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.parent.elf.sections.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.parent.elf.segments.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.parent.parent.args.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.parent.target.args.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.target.elf.exports.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.target.elf.imports.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.target.elf.sections.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.target.elf.segments.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.target.parent.args.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.target.target.args.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.parent.elf.exports.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.parent.elf.imports.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.parent.elf.sections.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.parent.elf.segments.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.parent.parent.args.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.parent.target.args.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.target.elf.exports.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.target.elf.imports.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.target.elf.sections.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.target.elf.segments.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.target.parent.args.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.target.target.args.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.parent.elf.exports.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.parent.elf.imports.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.parent.elf.sections.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.parent.elf.segments.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.parent.parent.args.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.parent.target.args.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.target.elf.exports.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.target.elf.imports.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.target.elf.sections.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.target.elf.segments.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.target.parent.args.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.target.target.args.${number}`]: string[]; [x: `process.parent.target.parent.target.target.parent.elf.exports.${number}`]: string[]; [x: `process.parent.target.parent.target.target.parent.elf.imports.${number}`]: string[]; [x: `process.parent.target.parent.target.target.parent.elf.sections.${number}`]: string[]; [x: `process.parent.target.parent.target.target.parent.elf.segments.${number}`]: string[]; [x: `process.parent.target.parent.target.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.parent.target.target.parent.parent.args.${number}`]: string[]; [x: `process.parent.target.parent.target.target.parent.target.args.${number}`]: string[]; [x: `process.parent.target.parent.target.target.target.elf.exports.${number}`]: string[]; [x: `process.parent.target.parent.target.target.target.elf.imports.${number}`]: string[]; [x: `process.parent.target.parent.target.target.target.elf.sections.${number}`]: string[]; [x: `process.parent.target.parent.target.target.target.elf.segments.${number}`]: string[]; [x: `process.parent.target.parent.target.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.parent.target.target.target.parent.args.${number}`]: string[]; [x: `process.parent.target.parent.target.target.target.target.args.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.parent.elf.exports.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.parent.elf.imports.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.parent.elf.sections.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.parent.elf.segments.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.parent.parent.args.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.parent.target.args.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.target.elf.exports.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.target.elf.imports.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.target.elf.sections.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.target.elf.segments.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.target.parent.args.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.target.target.args.${number}`]: string[]; [x: `process.parent.target.target.parent.target.parent.elf.exports.${number}`]: string[]; [x: `process.parent.target.target.parent.target.parent.elf.imports.${number}`]: string[]; [x: `process.parent.target.target.parent.target.parent.elf.sections.${number}`]: string[]; [x: `process.parent.target.target.parent.target.parent.elf.segments.${number}`]: string[]; [x: `process.parent.target.target.parent.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.target.parent.target.parent.parent.args.${number}`]: string[]; [x: `process.parent.target.target.parent.target.parent.target.args.${number}`]: string[]; [x: `process.parent.target.target.parent.target.target.elf.exports.${number}`]: string[]; [x: `process.parent.target.target.parent.target.target.elf.imports.${number}`]: string[]; [x: `process.parent.target.target.parent.target.target.elf.sections.${number}`]: string[]; [x: `process.parent.target.target.parent.target.target.elf.segments.${number}`]: string[]; [x: `process.parent.target.target.parent.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.target.parent.target.target.parent.args.${number}`]: string[]; [x: `process.parent.target.target.parent.target.target.target.args.${number}`]: string[]; [x: `process.parent.target.target.target.parent.parent.elf.exports.${number}`]: string[]; [x: `process.parent.target.target.target.parent.parent.elf.imports.${number}`]: string[]; [x: `process.parent.target.target.target.parent.parent.elf.sections.${number}`]: string[]; [x: `process.parent.target.target.target.parent.parent.elf.segments.${number}`]: string[]; [x: `process.parent.target.target.target.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.target.target.parent.parent.parent.args.${number}`]: string[]; [x: `process.parent.target.target.target.parent.parent.target.args.${number}`]: string[]; [x: `process.parent.target.target.target.parent.target.elf.exports.${number}`]: string[]; [x: `process.parent.target.target.target.parent.target.elf.imports.${number}`]: string[]; [x: `process.parent.target.target.target.parent.target.elf.sections.${number}`]: string[]; [x: `process.parent.target.target.target.parent.target.elf.segments.${number}`]: string[]; [x: `process.parent.target.target.target.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.target.target.parent.target.parent.args.${number}`]: string[]; [x: `process.parent.target.target.target.parent.target.target.args.${number}`]: string[]; [x: `process.parent.target.target.target.target.parent.elf.exports.${number}`]: string[]; [x: `process.parent.target.target.target.target.parent.elf.imports.${number}`]: string[]; [x: `process.parent.target.target.target.target.parent.elf.sections.${number}`]: string[]; [x: `process.parent.target.target.target.target.parent.elf.segments.${number}`]: string[]; [x: `process.parent.target.target.target.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.target.target.target.parent.parent.args.${number}`]: string[]; [x: `process.parent.target.target.target.target.parent.target.args.${number}`]: string[]; [x: `process.parent.target.target.target.target.target.elf.exports.${number}`]: string[]; [x: `process.parent.target.target.target.target.target.elf.imports.${number}`]: string[]; [x: `process.parent.target.target.target.target.target.elf.sections.${number}`]: string[]; [x: `process.parent.target.target.target.target.target.elf.segments.${number}`]: string[]; [x: `process.parent.target.target.target.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.target.target.target.target.parent.args.${number}`]: string[]; [x: `process.parent.target.target.target.target.target.target.args.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.parent.elf.exports.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.parent.elf.imports.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.parent.elf.sections.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.parent.elf.segments.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.parent.parent.args.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.parent.target.args.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.target.elf.exports.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.target.elf.imports.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.target.elf.sections.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.target.elf.segments.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.target.parent.args.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.target.target.args.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.parent.elf.exports.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.parent.elf.imports.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.parent.elf.sections.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.parent.elf.segments.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.parent.parent.args.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.parent.target.args.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.target.elf.exports.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.target.elf.imports.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.target.elf.sections.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.target.elf.segments.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.target.parent.args.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.target.target.args.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.parent.elf.exports.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.parent.elf.imports.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.parent.elf.sections.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.parent.elf.segments.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.parent.parent.args.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.parent.target.args.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.target.elf.exports.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.target.elf.imports.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.target.elf.sections.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.target.elf.segments.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.target.parent.args.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.target.target.args.${number}`]: string[]; [x: `process.target.parent.parent.target.target.parent.elf.exports.${number}`]: string[]; [x: `process.target.parent.parent.target.target.parent.elf.imports.${number}`]: string[]; [x: `process.target.parent.parent.target.target.parent.elf.sections.${number}`]: string[]; [x: `process.target.parent.parent.target.target.parent.elf.segments.${number}`]: string[]; [x: `process.target.parent.parent.target.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.parent.target.target.parent.parent.args.${number}`]: string[]; [x: `process.target.parent.parent.target.target.parent.target.args.${number}`]: string[]; [x: `process.target.parent.parent.target.target.target.elf.exports.${number}`]: string[]; [x: `process.target.parent.parent.target.target.target.elf.imports.${number}`]: string[]; [x: `process.target.parent.parent.target.target.target.elf.sections.${number}`]: string[]; [x: `process.target.parent.parent.target.target.target.elf.segments.${number}`]: string[]; [x: `process.target.parent.parent.target.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.parent.target.target.target.parent.args.${number}`]: string[]; [x: `process.target.parent.parent.target.target.target.target.args.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.parent.elf.exports.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.parent.elf.imports.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.parent.elf.sections.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.parent.elf.segments.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.parent.parent.args.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.parent.target.args.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.target.elf.exports.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.target.elf.imports.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.target.elf.sections.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.target.elf.segments.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.target.parent.args.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.target.target.args.${number}`]: string[]; [x: `process.target.parent.target.parent.target.parent.elf.exports.${number}`]: string[]; [x: `process.target.parent.target.parent.target.parent.elf.imports.${number}`]: string[]; [x: `process.target.parent.target.parent.target.parent.elf.sections.${number}`]: string[]; [x: `process.target.parent.target.parent.target.parent.elf.segments.${number}`]: string[]; [x: `process.target.parent.target.parent.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.target.parent.target.parent.parent.args.${number}`]: string[]; [x: `process.target.parent.target.parent.target.parent.target.args.${number}`]: string[]; [x: `process.target.parent.target.parent.target.target.elf.exports.${number}`]: string[]; [x: `process.target.parent.target.parent.target.target.elf.imports.${number}`]: string[]; [x: `process.target.parent.target.parent.target.target.elf.sections.${number}`]: string[]; [x: `process.target.parent.target.parent.target.target.elf.segments.${number}`]: string[]; [x: `process.target.parent.target.parent.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.target.parent.target.target.parent.args.${number}`]: string[]; [x: `process.target.parent.target.parent.target.target.target.args.${number}`]: string[]; [x: `process.target.parent.target.target.parent.parent.elf.exports.${number}`]: string[]; [x: `process.target.parent.target.target.parent.parent.elf.imports.${number}`]: string[]; [x: `process.target.parent.target.target.parent.parent.elf.sections.${number}`]: string[]; [x: `process.target.parent.target.target.parent.parent.elf.segments.${number}`]: string[]; [x: `process.target.parent.target.target.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.target.target.parent.parent.parent.args.${number}`]: string[]; [x: `process.target.parent.target.target.parent.parent.target.args.${number}`]: string[]; [x: `process.target.parent.target.target.parent.target.elf.exports.${number}`]: string[]; [x: `process.target.parent.target.target.parent.target.elf.imports.${number}`]: string[]; [x: `process.target.parent.target.target.parent.target.elf.sections.${number}`]: string[]; [x: `process.target.parent.target.target.parent.target.elf.segments.${number}`]: string[]; [x: `process.target.parent.target.target.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.target.target.parent.target.parent.args.${number}`]: string[]; [x: `process.target.parent.target.target.parent.target.target.args.${number}`]: string[]; [x: `process.target.parent.target.target.target.parent.elf.exports.${number}`]: string[]; [x: `process.target.parent.target.target.target.parent.elf.imports.${number}`]: string[]; [x: `process.target.parent.target.target.target.parent.elf.sections.${number}`]: string[]; [x: `process.target.parent.target.target.target.parent.elf.segments.${number}`]: string[]; [x: `process.target.parent.target.target.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.target.target.target.parent.parent.args.${number}`]: string[]; [x: `process.target.parent.target.target.target.parent.target.args.${number}`]: string[]; [x: `process.target.parent.target.target.target.target.elf.exports.${number}`]: string[]; [x: `process.target.parent.target.target.target.target.elf.imports.${number}`]: string[]; [x: `process.target.parent.target.target.target.target.elf.sections.${number}`]: string[]; [x: `process.target.parent.target.target.target.target.elf.segments.${number}`]: string[]; [x: `process.target.parent.target.target.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.target.target.target.target.parent.args.${number}`]: string[]; [x: `process.target.parent.target.target.target.target.target.args.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.parent.elf.exports.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.parent.elf.imports.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.parent.elf.sections.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.parent.elf.segments.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.parent.parent.args.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.parent.target.args.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.target.elf.exports.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.target.elf.imports.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.target.elf.sections.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.target.elf.segments.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.target.parent.args.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.target.target.args.${number}`]: string[]; [x: `process.target.target.parent.parent.target.parent.elf.exports.${number}`]: string[]; [x: `process.target.target.parent.parent.target.parent.elf.imports.${number}`]: string[]; [x: `process.target.target.parent.parent.target.parent.elf.sections.${number}`]: string[]; [x: `process.target.target.parent.parent.target.parent.elf.segments.${number}`]: string[]; [x: `process.target.target.parent.parent.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.parent.parent.target.parent.parent.args.${number}`]: string[]; [x: `process.target.target.parent.parent.target.parent.target.args.${number}`]: string[]; [x: `process.target.target.parent.parent.target.target.elf.exports.${number}`]: string[]; [x: `process.target.target.parent.parent.target.target.elf.imports.${number}`]: string[]; [x: `process.target.target.parent.parent.target.target.elf.sections.${number}`]: string[]; [x: `process.target.target.parent.parent.target.target.elf.segments.${number}`]: string[]; [x: `process.target.target.parent.parent.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.parent.parent.target.target.parent.args.${number}`]: string[]; [x: `process.target.target.parent.parent.target.target.target.args.${number}`]: string[]; [x: `process.target.target.parent.target.parent.parent.elf.exports.${number}`]: string[]; [x: `process.target.target.parent.target.parent.parent.elf.imports.${number}`]: string[]; [x: `process.target.target.parent.target.parent.parent.elf.sections.${number}`]: string[]; [x: `process.target.target.parent.target.parent.parent.elf.segments.${number}`]: string[]; [x: `process.target.target.parent.target.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.parent.target.parent.parent.parent.args.${number}`]: string[]; [x: `process.target.target.parent.target.parent.parent.target.args.${number}`]: string[]; [x: `process.target.target.parent.target.parent.target.elf.exports.${number}`]: string[]; [x: `process.target.target.parent.target.parent.target.elf.imports.${number}`]: string[]; [x: `process.target.target.parent.target.parent.target.elf.sections.${number}`]: string[]; [x: `process.target.target.parent.target.parent.target.elf.segments.${number}`]: string[]; [x: `process.target.target.parent.target.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.parent.target.parent.target.parent.args.${number}`]: string[]; [x: `process.target.target.parent.target.parent.target.target.args.${number}`]: string[]; [x: `process.target.target.parent.target.target.parent.elf.exports.${number}`]: string[]; [x: `process.target.target.parent.target.target.parent.elf.imports.${number}`]: string[]; [x: `process.target.target.parent.target.target.parent.elf.sections.${number}`]: string[]; [x: `process.target.target.parent.target.target.parent.elf.segments.${number}`]: string[]; [x: `process.target.target.parent.target.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.parent.target.target.parent.parent.args.${number}`]: string[]; [x: `process.target.target.parent.target.target.parent.target.args.${number}`]: string[]; [x: `process.target.target.parent.target.target.target.elf.exports.${number}`]: string[]; [x: `process.target.target.parent.target.target.target.elf.imports.${number}`]: string[]; [x: `process.target.target.parent.target.target.target.elf.sections.${number}`]: string[]; [x: `process.target.target.parent.target.target.target.elf.segments.${number}`]: string[]; [x: `process.target.target.parent.target.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.parent.target.target.target.parent.args.${number}`]: string[]; [x: `process.target.target.parent.target.target.target.target.args.${number}`]: string[]; [x: `process.target.target.target.parent.parent.parent.elf.exports.${number}`]: string[]; [x: `process.target.target.target.parent.parent.parent.elf.imports.${number}`]: string[]; [x: `process.target.target.target.parent.parent.parent.elf.sections.${number}`]: string[]; [x: `process.target.target.target.parent.parent.parent.elf.segments.${number}`]: string[]; [x: `process.target.target.target.parent.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.target.parent.parent.parent.parent.args.${number}`]: string[]; [x: `process.target.target.target.parent.parent.parent.target.args.${number}`]: string[]; [x: `process.target.target.target.parent.parent.target.elf.exports.${number}`]: string[]; [x: `process.target.target.target.parent.parent.target.elf.imports.${number}`]: string[]; [x: `process.target.target.target.parent.parent.target.elf.sections.${number}`]: string[]; [x: `process.target.target.target.parent.parent.target.elf.segments.${number}`]: string[]; [x: `process.target.target.target.parent.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.target.parent.parent.target.parent.args.${number}`]: string[]; [x: `process.target.target.target.parent.parent.target.target.args.${number}`]: string[]; [x: `process.target.target.target.parent.target.parent.elf.exports.${number}`]: string[]; [x: `process.target.target.target.parent.target.parent.elf.imports.${number}`]: string[]; [x: `process.target.target.target.parent.target.parent.elf.sections.${number}`]: string[]; [x: `process.target.target.target.parent.target.parent.elf.segments.${number}`]: string[]; [x: `process.target.target.target.parent.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.target.parent.target.parent.parent.args.${number}`]: string[]; [x: `process.target.target.target.parent.target.parent.target.args.${number}`]: string[]; [x: `process.target.target.target.parent.target.target.elf.exports.${number}`]: string[]; [x: `process.target.target.target.parent.target.target.elf.imports.${number}`]: string[]; [x: `process.target.target.target.parent.target.target.elf.sections.${number}`]: string[]; [x: `process.target.target.target.parent.target.target.elf.segments.${number}`]: string[]; [x: `process.target.target.target.parent.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.target.parent.target.target.parent.args.${number}`]: string[]; [x: `process.target.target.target.parent.target.target.target.args.${number}`]: string[]; [x: `process.target.target.target.target.parent.parent.elf.exports.${number}`]: string[]; [x: `process.target.target.target.target.parent.parent.elf.imports.${number}`]: string[]; [x: `process.target.target.target.target.parent.parent.elf.sections.${number}`]: string[]; [x: `process.target.target.target.target.parent.parent.elf.segments.${number}`]: string[]; [x: `process.target.target.target.target.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.target.target.parent.parent.parent.args.${number}`]: string[]; [x: `process.target.target.target.target.parent.parent.target.args.${number}`]: string[]; [x: `process.target.target.target.target.parent.target.elf.exports.${number}`]: string[]; [x: `process.target.target.target.target.parent.target.elf.imports.${number}`]: string[]; [x: `process.target.target.target.target.parent.target.elf.sections.${number}`]: string[]; [x: `process.target.target.target.target.parent.target.elf.segments.${number}`]: string[]; [x: `process.target.target.target.target.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.target.target.parent.target.parent.args.${number}`]: string[]; [x: `process.target.target.target.target.parent.target.target.args.${number}`]: string[]; [x: `process.target.target.target.target.target.parent.elf.exports.${number}`]: string[]; [x: `process.target.target.target.target.target.parent.elf.imports.${number}`]: string[]; [x: `process.target.target.target.target.target.parent.elf.sections.${number}`]: string[]; [x: `process.target.target.target.target.target.parent.elf.segments.${number}`]: string[]; [x: `process.target.target.target.target.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.target.target.target.parent.parent.args.${number}`]: string[]; [x: `process.target.target.target.target.target.parent.target.args.${number}`]: string[]; [x: `process.target.target.target.target.target.target.elf.exports.${number}`]: string[]; [x: `process.target.target.target.target.target.target.elf.imports.${number}`]: string[]; [x: `process.target.target.target.target.target.target.elf.sections.${number}`]: string[]; [x: `process.target.target.target.target.target.target.elf.segments.${number}`]: string[]; [x: `process.target.target.target.target.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.target.target.target.target.parent.args.${number}`]: string[]; [x: `process.target.target.target.target.target.target.target.args.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.parent.parent.elf.exports.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.parent.parent.elf.imports.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.parent.parent.elf.sections.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.parent.parent.elf.segments.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.parent.parent.parent.args.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.parent.parent.target.args.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.parent.target.elf.exports.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.parent.target.elf.imports.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.parent.target.elf.sections.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.parent.target.elf.segments.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.parent.target.parent.args.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.parent.target.target.args.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.target.parent.elf.exports.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.target.parent.elf.imports.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.target.parent.elf.sections.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.target.parent.elf.segments.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.target.parent.parent.args.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.target.parent.target.args.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.target.target.elf.exports.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.target.target.elf.imports.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.target.target.elf.sections.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.target.target.elf.segments.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.target.target.parent.args.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.target.target.target.args.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.parent.parent.elf.exports.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.parent.parent.elf.imports.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.parent.parent.elf.sections.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.parent.parent.elf.segments.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.parent.parent.parent.args.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.parent.parent.target.args.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.parent.target.elf.exports.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.parent.target.elf.imports.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.parent.target.elf.sections.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.parent.target.elf.segments.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.parent.target.parent.args.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.parent.target.target.args.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.target.parent.elf.exports.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.target.parent.elf.imports.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.target.parent.elf.sections.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.target.parent.elf.segments.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.target.parent.parent.args.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.target.parent.target.args.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.target.target.elf.exports.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.target.target.elf.imports.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.target.target.elf.sections.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.target.target.elf.segments.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.target.target.parent.args.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.target.target.target.args.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.parent.parent.elf.exports.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.parent.parent.elf.imports.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.parent.parent.elf.sections.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.parent.parent.elf.segments.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.parent.parent.parent.args.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.parent.parent.target.args.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.parent.target.elf.exports.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.parent.target.elf.imports.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.parent.target.elf.sections.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.parent.target.elf.segments.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.parent.target.parent.args.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.parent.target.target.args.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.target.parent.elf.exports.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.target.parent.elf.imports.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.target.parent.elf.sections.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.target.parent.elf.segments.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.target.parent.parent.args.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.target.parent.target.args.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.target.target.elf.exports.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.target.target.elf.imports.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.target.target.elf.sections.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.target.target.elf.segments.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.target.target.parent.args.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.target.target.target.args.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.parent.parent.elf.exports.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.parent.parent.elf.imports.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.parent.parent.elf.sections.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.parent.parent.elf.segments.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.parent.parent.parent.args.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.parent.parent.target.args.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.parent.target.elf.exports.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.parent.target.elf.imports.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.parent.target.elf.sections.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.parent.target.elf.segments.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.parent.target.parent.args.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.parent.target.target.args.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.target.parent.elf.exports.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.target.parent.elf.imports.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.target.parent.elf.sections.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.target.parent.elf.segments.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.target.parent.parent.args.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.target.parent.target.args.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.target.target.elf.exports.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.target.target.elf.imports.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.target.target.elf.sections.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.target.target.elf.segments.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.target.target.parent.args.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.target.target.target.args.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.parent.parent.elf.exports.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.parent.parent.elf.imports.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.parent.parent.elf.sections.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.parent.parent.elf.segments.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.parent.parent.parent.args.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.parent.parent.target.args.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.parent.target.elf.exports.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.parent.target.elf.imports.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.parent.target.elf.sections.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.parent.target.elf.segments.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.parent.target.parent.args.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.parent.target.target.args.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.target.parent.elf.exports.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.target.parent.elf.imports.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.target.parent.elf.sections.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.target.parent.elf.segments.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.target.parent.parent.args.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.target.parent.target.args.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.target.target.elf.exports.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.target.target.elf.imports.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.target.target.elf.sections.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.target.target.elf.segments.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.target.target.parent.args.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.target.target.target.args.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.parent.parent.elf.exports.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.parent.parent.elf.imports.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.parent.parent.elf.sections.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.parent.parent.elf.segments.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.parent.parent.parent.args.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.parent.parent.target.args.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.parent.target.elf.exports.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.parent.target.elf.imports.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.parent.target.elf.sections.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.parent.target.elf.segments.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.parent.target.parent.args.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.parent.target.target.args.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.target.parent.elf.exports.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.target.parent.elf.imports.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.target.parent.elf.sections.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.target.parent.elf.segments.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.target.parent.parent.args.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.target.parent.target.args.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.target.target.elf.exports.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.target.target.elf.imports.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.target.target.elf.sections.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.target.target.elf.segments.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.target.target.parent.args.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.target.target.target.args.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.parent.parent.elf.exports.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.parent.parent.elf.imports.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.parent.parent.elf.sections.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.parent.parent.elf.segments.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.parent.parent.parent.args.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.parent.parent.target.args.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.parent.target.elf.exports.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.parent.target.elf.imports.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.parent.target.elf.sections.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.parent.target.elf.segments.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.parent.target.parent.args.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.parent.target.target.args.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.target.parent.elf.exports.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.target.parent.elf.imports.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.target.parent.elf.sections.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.target.parent.elf.segments.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.target.parent.parent.args.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.target.parent.target.args.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.target.target.elf.exports.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.target.target.elf.imports.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.target.target.elf.sections.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.target.target.elf.segments.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.target.target.parent.args.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.target.target.target.args.${number}`]: string[]; [x: `process.parent.parent.target.target.target.parent.parent.elf.exports.${number}`]: string[]; [x: `process.parent.parent.target.target.target.parent.parent.elf.imports.${number}`]: string[]; [x: `process.parent.parent.target.target.target.parent.parent.elf.sections.${number}`]: string[]; [x: `process.parent.parent.target.target.target.parent.parent.elf.segments.${number}`]: string[]; [x: `process.parent.parent.target.target.target.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.target.target.target.parent.parent.parent.args.${number}`]: string[]; [x: `process.parent.parent.target.target.target.parent.parent.target.args.${number}`]: string[]; [x: `process.parent.parent.target.target.target.parent.target.elf.exports.${number}`]: string[]; [x: `process.parent.parent.target.target.target.parent.target.elf.imports.${number}`]: string[]; [x: `process.parent.parent.target.target.target.parent.target.elf.sections.${number}`]: string[]; [x: `process.parent.parent.target.target.target.parent.target.elf.segments.${number}`]: string[]; [x: `process.parent.parent.target.target.target.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.target.target.target.parent.target.parent.args.${number}`]: string[]; [x: `process.parent.parent.target.target.target.parent.target.target.args.${number}`]: string[]; [x: `process.parent.parent.target.target.target.target.parent.elf.exports.${number}`]: string[]; [x: `process.parent.parent.target.target.target.target.parent.elf.imports.${number}`]: string[]; [x: `process.parent.parent.target.target.target.target.parent.elf.sections.${number}`]: string[]; [x: `process.parent.parent.target.target.target.target.parent.elf.segments.${number}`]: string[]; [x: `process.parent.parent.target.target.target.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.target.target.target.target.parent.parent.args.${number}`]: string[]; [x: `process.parent.parent.target.target.target.target.parent.target.args.${number}`]: string[]; [x: `process.parent.parent.target.target.target.target.target.elf.exports.${number}`]: string[]; [x: `process.parent.parent.target.target.target.target.target.elf.imports.${number}`]: string[]; [x: `process.parent.parent.target.target.target.target.target.elf.sections.${number}`]: string[]; [x: `process.parent.parent.target.target.target.target.target.elf.segments.${number}`]: string[]; [x: `process.parent.parent.target.target.target.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.target.target.target.target.target.parent.args.${number}`]: string[]; [x: `process.parent.parent.target.target.target.target.target.target.args.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.parent.parent.elf.exports.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.parent.parent.elf.imports.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.parent.parent.elf.sections.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.parent.parent.elf.segments.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.parent.parent.parent.args.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.parent.parent.target.args.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.parent.target.elf.exports.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.parent.target.elf.imports.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.parent.target.elf.sections.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.parent.target.elf.segments.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.parent.target.parent.args.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.parent.target.target.args.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.target.parent.elf.exports.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.target.parent.elf.imports.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.target.parent.elf.sections.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.target.parent.elf.segments.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.target.parent.parent.args.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.target.parent.target.args.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.target.target.elf.exports.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.target.target.elf.imports.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.target.target.elf.sections.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.target.target.elf.segments.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.target.target.parent.args.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.target.target.target.args.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.parent.parent.elf.exports.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.parent.parent.elf.imports.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.parent.parent.elf.sections.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.parent.parent.elf.segments.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.parent.parent.parent.args.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.parent.parent.target.args.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.parent.target.elf.exports.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.parent.target.elf.imports.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.parent.target.elf.sections.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.parent.target.elf.segments.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.parent.target.parent.args.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.parent.target.target.args.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.target.parent.elf.exports.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.target.parent.elf.imports.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.target.parent.elf.sections.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.target.parent.elf.segments.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.target.parent.parent.args.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.target.parent.target.args.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.target.target.elf.exports.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.target.target.elf.imports.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.target.target.elf.sections.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.target.target.elf.segments.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.target.target.parent.args.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.target.target.target.args.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.parent.parent.elf.exports.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.parent.parent.elf.imports.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.parent.parent.elf.sections.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.parent.parent.elf.segments.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.parent.parent.parent.args.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.parent.parent.target.args.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.parent.target.elf.exports.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.parent.target.elf.imports.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.parent.target.elf.sections.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.parent.target.elf.segments.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.parent.target.parent.args.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.parent.target.target.args.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.target.parent.elf.exports.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.target.parent.elf.imports.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.target.parent.elf.sections.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.target.parent.elf.segments.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.target.parent.parent.args.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.target.parent.target.args.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.target.target.elf.exports.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.target.target.elf.imports.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.target.target.elf.sections.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.target.target.elf.segments.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.target.target.parent.args.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.target.target.target.args.${number}`]: string[]; [x: `process.parent.target.parent.target.target.parent.parent.elf.exports.${number}`]: string[]; [x: `process.parent.target.parent.target.target.parent.parent.elf.imports.${number}`]: string[]; [x: `process.parent.target.parent.target.target.parent.parent.elf.sections.${number}`]: string[]; [x: `process.parent.target.parent.target.target.parent.parent.elf.segments.${number}`]: string[]; [x: `process.parent.target.parent.target.target.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.parent.target.target.parent.parent.parent.args.${number}`]: string[]; [x: `process.parent.target.parent.target.target.parent.parent.target.args.${number}`]: string[]; [x: `process.parent.target.parent.target.target.parent.target.elf.exports.${number}`]: string[]; [x: `process.parent.target.parent.target.target.parent.target.elf.imports.${number}`]: string[]; [x: `process.parent.target.parent.target.target.parent.target.elf.sections.${number}`]: string[]; [x: `process.parent.target.parent.target.target.parent.target.elf.segments.${number}`]: string[]; [x: `process.parent.target.parent.target.target.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.parent.target.target.parent.target.parent.args.${number}`]: string[]; [x: `process.parent.target.parent.target.target.parent.target.target.args.${number}`]: string[]; [x: `process.parent.target.parent.target.target.target.parent.elf.exports.${number}`]: string[]; [x: `process.parent.target.parent.target.target.target.parent.elf.imports.${number}`]: string[]; [x: `process.parent.target.parent.target.target.target.parent.elf.sections.${number}`]: string[]; [x: `process.parent.target.parent.target.target.target.parent.elf.segments.${number}`]: string[]; [x: `process.parent.target.parent.target.target.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.parent.target.target.target.parent.parent.args.${number}`]: string[]; [x: `process.parent.target.parent.target.target.target.parent.target.args.${number}`]: string[]; [x: `process.parent.target.parent.target.target.target.target.elf.exports.${number}`]: string[]; [x: `process.parent.target.parent.target.target.target.target.elf.imports.${number}`]: string[]; [x: `process.parent.target.parent.target.target.target.target.elf.sections.${number}`]: string[]; [x: `process.parent.target.parent.target.target.target.target.elf.segments.${number}`]: string[]; [x: `process.parent.target.parent.target.target.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.parent.target.target.target.target.parent.args.${number}`]: string[]; [x: `process.parent.target.parent.target.target.target.target.target.args.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.parent.parent.elf.exports.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.parent.parent.elf.imports.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.parent.parent.elf.sections.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.parent.parent.elf.segments.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.parent.parent.parent.args.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.parent.parent.target.args.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.parent.target.elf.exports.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.parent.target.elf.imports.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.parent.target.elf.sections.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.parent.target.elf.segments.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.parent.target.parent.args.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.parent.target.target.args.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.target.parent.elf.exports.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.target.parent.elf.imports.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.target.parent.elf.sections.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.target.parent.elf.segments.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.target.parent.parent.args.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.target.parent.target.args.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.target.target.elf.exports.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.target.target.elf.imports.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.target.target.elf.sections.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.target.target.elf.segments.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.target.target.parent.args.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.target.target.target.args.${number}`]: string[]; [x: `process.parent.target.target.parent.target.parent.parent.elf.exports.${number}`]: string[]; [x: `process.parent.target.target.parent.target.parent.parent.elf.imports.${number}`]: string[]; [x: `process.parent.target.target.parent.target.parent.parent.elf.sections.${number}`]: string[]; [x: `process.parent.target.target.parent.target.parent.parent.elf.segments.${number}`]: string[]; [x: `process.parent.target.target.parent.target.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.target.parent.target.parent.parent.parent.args.${number}`]: string[]; [x: `process.parent.target.target.parent.target.parent.parent.target.args.${number}`]: string[]; [x: `process.parent.target.target.parent.target.parent.target.elf.exports.${number}`]: string[]; [x: `process.parent.target.target.parent.target.parent.target.elf.imports.${number}`]: string[]; [x: `process.parent.target.target.parent.target.parent.target.elf.sections.${number}`]: string[]; [x: `process.parent.target.target.parent.target.parent.target.elf.segments.${number}`]: string[]; [x: `process.parent.target.target.parent.target.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.target.parent.target.parent.target.parent.args.${number}`]: string[]; [x: `process.parent.target.target.parent.target.parent.target.target.args.${number}`]: string[]; [x: `process.parent.target.target.parent.target.target.parent.elf.exports.${number}`]: string[]; [x: `process.parent.target.target.parent.target.target.parent.elf.imports.${number}`]: string[]; [x: `process.parent.target.target.parent.target.target.parent.elf.sections.${number}`]: string[]; [x: `process.parent.target.target.parent.target.target.parent.elf.segments.${number}`]: string[]; [x: `process.parent.target.target.parent.target.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.target.parent.target.target.parent.parent.args.${number}`]: string[]; [x: `process.parent.target.target.parent.target.target.parent.target.args.${number}`]: string[]; [x: `process.parent.target.target.parent.target.target.target.elf.exports.${number}`]: string[]; [x: `process.parent.target.target.parent.target.target.target.elf.imports.${number}`]: string[]; [x: `process.parent.target.target.parent.target.target.target.elf.sections.${number}`]: string[]; [x: `process.parent.target.target.parent.target.target.target.elf.segments.${number}`]: string[]; [x: `process.parent.target.target.parent.target.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.target.parent.target.target.target.parent.args.${number}`]: string[]; [x: `process.parent.target.target.parent.target.target.target.target.args.${number}`]: string[]; [x: `process.parent.target.target.target.parent.parent.parent.elf.exports.${number}`]: string[]; [x: `process.parent.target.target.target.parent.parent.parent.elf.imports.${number}`]: string[]; [x: `process.parent.target.target.target.parent.parent.parent.elf.sections.${number}`]: string[]; [x: `process.parent.target.target.target.parent.parent.parent.elf.segments.${number}`]: string[]; [x: `process.parent.target.target.target.parent.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.target.target.parent.parent.parent.parent.args.${number}`]: string[]; [x: `process.parent.target.target.target.parent.parent.parent.target.args.${number}`]: string[]; [x: `process.parent.target.target.target.parent.parent.target.elf.exports.${number}`]: string[]; [x: `process.parent.target.target.target.parent.parent.target.elf.imports.${number}`]: string[]; [x: `process.parent.target.target.target.parent.parent.target.elf.sections.${number}`]: string[]; [x: `process.parent.target.target.target.parent.parent.target.elf.segments.${number}`]: string[]; [x: `process.parent.target.target.target.parent.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.target.target.parent.parent.target.parent.args.${number}`]: string[]; [x: `process.parent.target.target.target.parent.parent.target.target.args.${number}`]: string[]; [x: `process.parent.target.target.target.parent.target.parent.elf.exports.${number}`]: string[]; [x: `process.parent.target.target.target.parent.target.parent.elf.imports.${number}`]: string[]; [x: `process.parent.target.target.target.parent.target.parent.elf.sections.${number}`]: string[]; [x: `process.parent.target.target.target.parent.target.parent.elf.segments.${number}`]: string[]; [x: `process.parent.target.target.target.parent.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.target.target.parent.target.parent.parent.args.${number}`]: string[]; [x: `process.parent.target.target.target.parent.target.parent.target.args.${number}`]: string[]; [x: `process.parent.target.target.target.parent.target.target.elf.exports.${number}`]: string[]; [x: `process.parent.target.target.target.parent.target.target.elf.imports.${number}`]: string[]; [x: `process.parent.target.target.target.parent.target.target.elf.sections.${number}`]: string[]; [x: `process.parent.target.target.target.parent.target.target.elf.segments.${number}`]: string[]; [x: `process.parent.target.target.target.parent.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.target.target.parent.target.target.parent.args.${number}`]: string[]; [x: `process.parent.target.target.target.parent.target.target.target.args.${number}`]: string[]; [x: `process.parent.target.target.target.target.parent.parent.elf.exports.${number}`]: string[]; [x: `process.parent.target.target.target.target.parent.parent.elf.imports.${number}`]: string[]; [x: `process.parent.target.target.target.target.parent.parent.elf.sections.${number}`]: string[]; [x: `process.parent.target.target.target.target.parent.parent.elf.segments.${number}`]: string[]; [x: `process.parent.target.target.target.target.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.target.target.target.parent.parent.parent.args.${number}`]: string[]; [x: `process.parent.target.target.target.target.parent.parent.target.args.${number}`]: string[]; [x: `process.parent.target.target.target.target.parent.target.elf.exports.${number}`]: string[]; [x: `process.parent.target.target.target.target.parent.target.elf.imports.${number}`]: string[]; [x: `process.parent.target.target.target.target.parent.target.elf.sections.${number}`]: string[]; [x: `process.parent.target.target.target.target.parent.target.elf.segments.${number}`]: string[]; [x: `process.parent.target.target.target.target.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.target.target.target.parent.target.parent.args.${number}`]: string[]; [x: `process.parent.target.target.target.target.parent.target.target.args.${number}`]: string[]; [x: `process.parent.target.target.target.target.target.parent.elf.exports.${number}`]: string[]; [x: `process.parent.target.target.target.target.target.parent.elf.imports.${number}`]: string[]; [x: `process.parent.target.target.target.target.target.parent.elf.sections.${number}`]: string[]; [x: `process.parent.target.target.target.target.target.parent.elf.segments.${number}`]: string[]; [x: `process.parent.target.target.target.target.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.target.target.target.target.parent.parent.args.${number}`]: string[]; [x: `process.parent.target.target.target.target.target.parent.target.args.${number}`]: string[]; [x: `process.parent.target.target.target.target.target.target.elf.exports.${number}`]: string[]; [x: `process.parent.target.target.target.target.target.target.elf.imports.${number}`]: string[]; [x: `process.parent.target.target.target.target.target.target.elf.sections.${number}`]: string[]; [x: `process.parent.target.target.target.target.target.target.elf.segments.${number}`]: string[]; [x: `process.parent.target.target.target.target.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.target.target.target.target.target.parent.args.${number}`]: string[]; [x: `process.parent.target.target.target.target.target.target.target.args.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.parent.parent.elf.exports.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.parent.parent.elf.imports.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.parent.parent.elf.sections.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.parent.parent.elf.segments.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.parent.parent.parent.args.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.parent.parent.target.args.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.parent.target.elf.exports.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.parent.target.elf.imports.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.parent.target.elf.sections.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.parent.target.elf.segments.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.parent.target.parent.args.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.parent.target.target.args.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.target.parent.elf.exports.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.target.parent.elf.imports.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.target.parent.elf.sections.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.target.parent.elf.segments.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.target.parent.parent.args.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.target.parent.target.args.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.target.target.elf.exports.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.target.target.elf.imports.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.target.target.elf.sections.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.target.target.elf.segments.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.target.target.parent.args.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.target.target.target.args.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.parent.parent.elf.exports.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.parent.parent.elf.imports.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.parent.parent.elf.sections.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.parent.parent.elf.segments.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.parent.parent.parent.args.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.parent.parent.target.args.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.parent.target.elf.exports.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.parent.target.elf.imports.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.parent.target.elf.sections.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.parent.target.elf.segments.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.parent.target.parent.args.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.parent.target.target.args.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.target.parent.elf.exports.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.target.parent.elf.imports.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.target.parent.elf.sections.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.target.parent.elf.segments.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.target.parent.parent.args.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.target.parent.target.args.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.target.target.elf.exports.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.target.target.elf.imports.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.target.target.elf.sections.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.target.target.elf.segments.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.target.target.parent.args.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.target.target.target.args.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.parent.parent.elf.exports.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.parent.parent.elf.imports.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.parent.parent.elf.sections.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.parent.parent.elf.segments.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.parent.parent.parent.args.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.parent.parent.target.args.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.parent.target.elf.exports.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.parent.target.elf.imports.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.parent.target.elf.sections.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.parent.target.elf.segments.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.parent.target.parent.args.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.parent.target.target.args.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.target.parent.elf.exports.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.target.parent.elf.imports.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.target.parent.elf.sections.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.target.parent.elf.segments.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.target.parent.parent.args.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.target.parent.target.args.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.target.target.elf.exports.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.target.target.elf.imports.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.target.target.elf.sections.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.target.target.elf.segments.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.target.target.parent.args.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.target.target.target.args.${number}`]: string[]; [x: `process.target.parent.parent.target.target.parent.parent.elf.exports.${number}`]: string[]; [x: `process.target.parent.parent.target.target.parent.parent.elf.imports.${number}`]: string[]; [x: `process.target.parent.parent.target.target.parent.parent.elf.sections.${number}`]: string[]; [x: `process.target.parent.parent.target.target.parent.parent.elf.segments.${number}`]: string[]; [x: `process.target.parent.parent.target.target.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.parent.target.target.parent.parent.parent.args.${number}`]: string[]; [x: `process.target.parent.parent.target.target.parent.parent.target.args.${number}`]: string[]; [x: `process.target.parent.parent.target.target.parent.target.elf.exports.${number}`]: string[]; [x: `process.target.parent.parent.target.target.parent.target.elf.imports.${number}`]: string[]; [x: `process.target.parent.parent.target.target.parent.target.elf.sections.${number}`]: string[]; [x: `process.target.parent.parent.target.target.parent.target.elf.segments.${number}`]: string[]; [x: `process.target.parent.parent.target.target.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.parent.target.target.parent.target.parent.args.${number}`]: string[]; [x: `process.target.parent.parent.target.target.parent.target.target.args.${number}`]: string[]; [x: `process.target.parent.parent.target.target.target.parent.elf.exports.${number}`]: string[]; [x: `process.target.parent.parent.target.target.target.parent.elf.imports.${number}`]: string[]; [x: `process.target.parent.parent.target.target.target.parent.elf.sections.${number}`]: string[]; [x: `process.target.parent.parent.target.target.target.parent.elf.segments.${number}`]: string[]; [x: `process.target.parent.parent.target.target.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.parent.target.target.target.parent.parent.args.${number}`]: string[]; [x: `process.target.parent.parent.target.target.target.parent.target.args.${number}`]: string[]; [x: `process.target.parent.parent.target.target.target.target.elf.exports.${number}`]: string[]; [x: `process.target.parent.parent.target.target.target.target.elf.imports.${number}`]: string[]; [x: `process.target.parent.parent.target.target.target.target.elf.sections.${number}`]: string[]; [x: `process.target.parent.parent.target.target.target.target.elf.segments.${number}`]: string[]; [x: `process.target.parent.parent.target.target.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.parent.target.target.target.target.parent.args.${number}`]: string[]; [x: `process.target.parent.parent.target.target.target.target.target.args.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.parent.parent.elf.exports.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.parent.parent.elf.imports.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.parent.parent.elf.sections.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.parent.parent.elf.segments.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.parent.parent.parent.args.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.parent.parent.target.args.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.parent.target.elf.exports.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.parent.target.elf.imports.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.parent.target.elf.sections.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.parent.target.elf.segments.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.parent.target.parent.args.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.parent.target.target.args.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.target.parent.elf.exports.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.target.parent.elf.imports.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.target.parent.elf.sections.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.target.parent.elf.segments.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.target.parent.parent.args.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.target.parent.target.args.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.target.target.elf.exports.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.target.target.elf.imports.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.target.target.elf.sections.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.target.target.elf.segments.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.target.target.parent.args.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.target.target.target.args.${number}`]: string[]; [x: `process.target.parent.target.parent.target.parent.parent.elf.exports.${number}`]: string[]; [x: `process.target.parent.target.parent.target.parent.parent.elf.imports.${number}`]: string[]; [x: `process.target.parent.target.parent.target.parent.parent.elf.sections.${number}`]: string[]; [x: `process.target.parent.target.parent.target.parent.parent.elf.segments.${number}`]: string[]; [x: `process.target.parent.target.parent.target.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.target.parent.target.parent.parent.parent.args.${number}`]: string[]; [x: `process.target.parent.target.parent.target.parent.parent.target.args.${number}`]: string[]; [x: `process.target.parent.target.parent.target.parent.target.elf.exports.${number}`]: string[]; [x: `process.target.parent.target.parent.target.parent.target.elf.imports.${number}`]: string[]; [x: `process.target.parent.target.parent.target.parent.target.elf.sections.${number}`]: string[]; [x: `process.target.parent.target.parent.target.parent.target.elf.segments.${number}`]: string[]; [x: `process.target.parent.target.parent.target.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.target.parent.target.parent.target.parent.args.${number}`]: string[]; [x: `process.target.parent.target.parent.target.parent.target.target.args.${number}`]: string[]; [x: `process.target.parent.target.parent.target.target.parent.elf.exports.${number}`]: string[]; [x: `process.target.parent.target.parent.target.target.parent.elf.imports.${number}`]: string[]; [x: `process.target.parent.target.parent.target.target.parent.elf.sections.${number}`]: string[]; [x: `process.target.parent.target.parent.target.target.parent.elf.segments.${number}`]: string[]; [x: `process.target.parent.target.parent.target.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.target.parent.target.target.parent.parent.args.${number}`]: string[]; [x: `process.target.parent.target.parent.target.target.parent.target.args.${number}`]: string[]; [x: `process.target.parent.target.parent.target.target.target.elf.exports.${number}`]: string[]; [x: `process.target.parent.target.parent.target.target.target.elf.imports.${number}`]: string[]; [x: `process.target.parent.target.parent.target.target.target.elf.sections.${number}`]: string[]; [x: `process.target.parent.target.parent.target.target.target.elf.segments.${number}`]: string[]; [x: `process.target.parent.target.parent.target.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.target.parent.target.target.target.parent.args.${number}`]: string[]; [x: `process.target.parent.target.parent.target.target.target.target.args.${number}`]: string[]; [x: `process.target.parent.target.target.parent.parent.parent.elf.exports.${number}`]: string[]; [x: `process.target.parent.target.target.parent.parent.parent.elf.imports.${number}`]: string[]; [x: `process.target.parent.target.target.parent.parent.parent.elf.sections.${number}`]: string[]; [x: `process.target.parent.target.target.parent.parent.parent.elf.segments.${number}`]: string[]; [x: `process.target.parent.target.target.parent.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.target.target.parent.parent.parent.parent.args.${number}`]: string[]; [x: `process.target.parent.target.target.parent.parent.parent.target.args.${number}`]: string[]; [x: `process.target.parent.target.target.parent.parent.target.elf.exports.${number}`]: string[]; [x: `process.target.parent.target.target.parent.parent.target.elf.imports.${number}`]: string[]; [x: `process.target.parent.target.target.parent.parent.target.elf.sections.${number}`]: string[]; [x: `process.target.parent.target.target.parent.parent.target.elf.segments.${number}`]: string[]; [x: `process.target.parent.target.target.parent.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.target.target.parent.parent.target.parent.args.${number}`]: string[]; [x: `process.target.parent.target.target.parent.parent.target.target.args.${number}`]: string[]; [x: `process.target.parent.target.target.parent.target.parent.elf.exports.${number}`]: string[]; [x: `process.target.parent.target.target.parent.target.parent.elf.imports.${number}`]: string[]; [x: `process.target.parent.target.target.parent.target.parent.elf.sections.${number}`]: string[]; [x: `process.target.parent.target.target.parent.target.parent.elf.segments.${number}`]: string[]; [x: `process.target.parent.target.target.parent.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.target.target.parent.target.parent.parent.args.${number}`]: string[]; [x: `process.target.parent.target.target.parent.target.parent.target.args.${number}`]: string[]; [x: `process.target.parent.target.target.parent.target.target.elf.exports.${number}`]: string[]; [x: `process.target.parent.target.target.parent.target.target.elf.imports.${number}`]: string[]; [x: `process.target.parent.target.target.parent.target.target.elf.sections.${number}`]: string[]; [x: `process.target.parent.target.target.parent.target.target.elf.segments.${number}`]: string[]; [x: `process.target.parent.target.target.parent.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.target.target.parent.target.target.parent.args.${number}`]: string[]; [x: `process.target.parent.target.target.parent.target.target.target.args.${number}`]: string[]; [x: `process.target.parent.target.target.target.parent.parent.elf.exports.${number}`]: string[]; [x: `process.target.parent.target.target.target.parent.parent.elf.imports.${number}`]: string[]; [x: `process.target.parent.target.target.target.parent.parent.elf.sections.${number}`]: string[]; [x: `process.target.parent.target.target.target.parent.parent.elf.segments.${number}`]: string[]; [x: `process.target.parent.target.target.target.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.target.target.target.parent.parent.parent.args.${number}`]: string[]; [x: `process.target.parent.target.target.target.parent.parent.target.args.${number}`]: string[]; [x: `process.target.parent.target.target.target.parent.target.elf.exports.${number}`]: string[]; [x: `process.target.parent.target.target.target.parent.target.elf.imports.${number}`]: string[]; [x: `process.target.parent.target.target.target.parent.target.elf.sections.${number}`]: string[]; [x: `process.target.parent.target.target.target.parent.target.elf.segments.${number}`]: string[]; [x: `process.target.parent.target.target.target.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.target.target.target.parent.target.parent.args.${number}`]: string[]; [x: `process.target.parent.target.target.target.parent.target.target.args.${number}`]: string[]; [x: `process.target.parent.target.target.target.target.parent.elf.exports.${number}`]: string[]; [x: `process.target.parent.target.target.target.target.parent.elf.imports.${number}`]: string[]; [x: `process.target.parent.target.target.target.target.parent.elf.sections.${number}`]: string[]; [x: `process.target.parent.target.target.target.target.parent.elf.segments.${number}`]: string[]; [x: `process.target.parent.target.target.target.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.target.target.target.target.parent.parent.args.${number}`]: string[]; [x: `process.target.parent.target.target.target.target.parent.target.args.${number}`]: string[]; [x: `process.target.parent.target.target.target.target.target.elf.exports.${number}`]: string[]; [x: `process.target.parent.target.target.target.target.target.elf.imports.${number}`]: string[]; [x: `process.target.parent.target.target.target.target.target.elf.sections.${number}`]: string[]; [x: `process.target.parent.target.target.target.target.target.elf.segments.${number}`]: string[]; [x: `process.target.parent.target.target.target.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.target.target.target.target.target.parent.args.${number}`]: string[]; [x: `process.target.parent.target.target.target.target.target.target.args.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.parent.parent.elf.exports.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.parent.parent.elf.imports.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.parent.parent.elf.sections.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.parent.parent.elf.segments.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.parent.parent.parent.args.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.parent.parent.target.args.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.parent.target.elf.exports.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.parent.target.elf.imports.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.parent.target.elf.sections.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.parent.target.elf.segments.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.parent.target.parent.args.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.parent.target.target.args.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.target.parent.elf.exports.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.target.parent.elf.imports.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.target.parent.elf.sections.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.target.parent.elf.segments.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.target.parent.parent.args.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.target.parent.target.args.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.target.target.elf.exports.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.target.target.elf.imports.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.target.target.elf.sections.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.target.target.elf.segments.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.target.target.parent.args.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.target.target.target.args.${number}`]: string[]; [x: `process.target.target.parent.parent.target.parent.parent.elf.exports.${number}`]: string[]; [x: `process.target.target.parent.parent.target.parent.parent.elf.imports.${number}`]: string[]; [x: `process.target.target.parent.parent.target.parent.parent.elf.sections.${number}`]: string[]; [x: `process.target.target.parent.parent.target.parent.parent.elf.segments.${number}`]: string[]; [x: `process.target.target.parent.parent.target.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.parent.parent.target.parent.parent.parent.args.${number}`]: string[]; [x: `process.target.target.parent.parent.target.parent.parent.target.args.${number}`]: string[]; [x: `process.target.target.parent.parent.target.parent.target.elf.exports.${number}`]: string[]; [x: `process.target.target.parent.parent.target.parent.target.elf.imports.${number}`]: string[]; [x: `process.target.target.parent.parent.target.parent.target.elf.sections.${number}`]: string[]; [x: `process.target.target.parent.parent.target.parent.target.elf.segments.${number}`]: string[]; [x: `process.target.target.parent.parent.target.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.parent.parent.target.parent.target.parent.args.${number}`]: string[]; [x: `process.target.target.parent.parent.target.parent.target.target.args.${number}`]: string[]; [x: `process.target.target.parent.parent.target.target.parent.elf.exports.${number}`]: string[]; [x: `process.target.target.parent.parent.target.target.parent.elf.imports.${number}`]: string[]; [x: `process.target.target.parent.parent.target.target.parent.elf.sections.${number}`]: string[]; [x: `process.target.target.parent.parent.target.target.parent.elf.segments.${number}`]: string[]; [x: `process.target.target.parent.parent.target.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.parent.parent.target.target.parent.parent.args.${number}`]: string[]; [x: `process.target.target.parent.parent.target.target.parent.target.args.${number}`]: string[]; [x: `process.target.target.parent.parent.target.target.target.elf.exports.${number}`]: string[]; [x: `process.target.target.parent.parent.target.target.target.elf.imports.${number}`]: string[]; [x: `process.target.target.parent.parent.target.target.target.elf.sections.${number}`]: string[]; [x: `process.target.target.parent.parent.target.target.target.elf.segments.${number}`]: string[]; [x: `process.target.target.parent.parent.target.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.parent.parent.target.target.target.parent.args.${number}`]: string[]; [x: `process.target.target.parent.parent.target.target.target.target.args.${number}`]: string[]; [x: `process.target.target.parent.target.parent.parent.parent.elf.exports.${number}`]: string[]; [x: `process.target.target.parent.target.parent.parent.parent.elf.imports.${number}`]: string[]; [x: `process.target.target.parent.target.parent.parent.parent.elf.sections.${number}`]: string[]; [x: `process.target.target.parent.target.parent.parent.parent.elf.segments.${number}`]: string[]; [x: `process.target.target.parent.target.parent.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.parent.target.parent.parent.parent.parent.args.${number}`]: string[]; [x: `process.target.target.parent.target.parent.parent.parent.target.args.${number}`]: string[]; [x: `process.target.target.parent.target.parent.parent.target.elf.exports.${number}`]: string[]; [x: `process.target.target.parent.target.parent.parent.target.elf.imports.${number}`]: string[]; [x: `process.target.target.parent.target.parent.parent.target.elf.sections.${number}`]: string[]; [x: `process.target.target.parent.target.parent.parent.target.elf.segments.${number}`]: string[]; [x: `process.target.target.parent.target.parent.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.parent.target.parent.parent.target.parent.args.${number}`]: string[]; [x: `process.target.target.parent.target.parent.parent.target.target.args.${number}`]: string[]; [x: `process.target.target.parent.target.parent.target.parent.elf.exports.${number}`]: string[]; [x: `process.target.target.parent.target.parent.target.parent.elf.imports.${number}`]: string[]; [x: `process.target.target.parent.target.parent.target.parent.elf.sections.${number}`]: string[]; [x: `process.target.target.parent.target.parent.target.parent.elf.segments.${number}`]: string[]; [x: `process.target.target.parent.target.parent.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.parent.target.parent.target.parent.parent.args.${number}`]: string[]; [x: `process.target.target.parent.target.parent.target.parent.target.args.${number}`]: string[]; [x: `process.target.target.parent.target.parent.target.target.elf.exports.${number}`]: string[]; [x: `process.target.target.parent.target.parent.target.target.elf.imports.${number}`]: string[]; [x: `process.target.target.parent.target.parent.target.target.elf.sections.${number}`]: string[]; [x: `process.target.target.parent.target.parent.target.target.elf.segments.${number}`]: string[]; [x: `process.target.target.parent.target.parent.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.parent.target.parent.target.target.parent.args.${number}`]: string[]; [x: `process.target.target.parent.target.parent.target.target.target.args.${number}`]: string[]; [x: `process.target.target.parent.target.target.parent.parent.elf.exports.${number}`]: string[]; [x: `process.target.target.parent.target.target.parent.parent.elf.imports.${number}`]: string[]; [x: `process.target.target.parent.target.target.parent.parent.elf.sections.${number}`]: string[]; [x: `process.target.target.parent.target.target.parent.parent.elf.segments.${number}`]: string[]; [x: `process.target.target.parent.target.target.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.parent.target.target.parent.parent.parent.args.${number}`]: string[]; [x: `process.target.target.parent.target.target.parent.parent.target.args.${number}`]: string[]; [x: `process.target.target.parent.target.target.parent.target.elf.exports.${number}`]: string[]; [x: `process.target.target.parent.target.target.parent.target.elf.imports.${number}`]: string[]; [x: `process.target.target.parent.target.target.parent.target.elf.sections.${number}`]: string[]; [x: `process.target.target.parent.target.target.parent.target.elf.segments.${number}`]: string[]; [x: `process.target.target.parent.target.target.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.parent.target.target.parent.target.parent.args.${number}`]: string[]; [x: `process.target.target.parent.target.target.parent.target.target.args.${number}`]: string[]; [x: `process.target.target.parent.target.target.target.parent.elf.exports.${number}`]: string[]; [x: `process.target.target.parent.target.target.target.parent.elf.imports.${number}`]: string[]; [x: `process.target.target.parent.target.target.target.parent.elf.sections.${number}`]: string[]; [x: `process.target.target.parent.target.target.target.parent.elf.segments.${number}`]: string[]; [x: `process.target.target.parent.target.target.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.parent.target.target.target.parent.parent.args.${number}`]: string[]; [x: `process.target.target.parent.target.target.target.parent.target.args.${number}`]: string[]; [x: `process.target.target.parent.target.target.target.target.elf.exports.${number}`]: string[]; [x: `process.target.target.parent.target.target.target.target.elf.imports.${number}`]: string[]; [x: `process.target.target.parent.target.target.target.target.elf.sections.${number}`]: string[]; [x: `process.target.target.parent.target.target.target.target.elf.segments.${number}`]: string[]; [x: `process.target.target.parent.target.target.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.parent.target.target.target.target.parent.args.${number}`]: string[]; [x: `process.target.target.parent.target.target.target.target.target.args.${number}`]: string[]; [x: `process.target.target.target.parent.parent.parent.parent.elf.exports.${number}`]: string[]; [x: `process.target.target.target.parent.parent.parent.parent.elf.imports.${number}`]: string[]; [x: `process.target.target.target.parent.parent.parent.parent.elf.sections.${number}`]: string[]; [x: `process.target.target.target.parent.parent.parent.parent.elf.segments.${number}`]: string[]; [x: `process.target.target.target.parent.parent.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.target.parent.parent.parent.parent.parent.args.${number}`]: string[]; [x: `process.target.target.target.parent.parent.parent.parent.target.args.${number}`]: string[]; [x: `process.target.target.target.parent.parent.parent.target.elf.exports.${number}`]: string[]; [x: `process.target.target.target.parent.parent.parent.target.elf.imports.${number}`]: string[]; [x: `process.target.target.target.parent.parent.parent.target.elf.sections.${number}`]: string[]; [x: `process.target.target.target.parent.parent.parent.target.elf.segments.${number}`]: string[]; [x: `process.target.target.target.parent.parent.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.target.parent.parent.parent.target.parent.args.${number}`]: string[]; [x: `process.target.target.target.parent.parent.parent.target.target.args.${number}`]: string[]; [x: `process.target.target.target.parent.parent.target.parent.elf.exports.${number}`]: string[]; [x: `process.target.target.target.parent.parent.target.parent.elf.imports.${number}`]: string[]; [x: `process.target.target.target.parent.parent.target.parent.elf.sections.${number}`]: string[]; [x: `process.target.target.target.parent.parent.target.parent.elf.segments.${number}`]: string[]; [x: `process.target.target.target.parent.parent.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.target.parent.parent.target.parent.parent.args.${number}`]: string[]; [x: `process.target.target.target.parent.parent.target.parent.target.args.${number}`]: string[]; [x: `process.target.target.target.parent.parent.target.target.elf.exports.${number}`]: string[]; [x: `process.target.target.target.parent.parent.target.target.elf.imports.${number}`]: string[]; [x: `process.target.target.target.parent.parent.target.target.elf.sections.${number}`]: string[]; [x: `process.target.target.target.parent.parent.target.target.elf.segments.${number}`]: string[]; [x: `process.target.target.target.parent.parent.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.target.parent.parent.target.target.parent.args.${number}`]: string[]; [x: `process.target.target.target.parent.parent.target.target.target.args.${number}`]: string[]; [x: `process.target.target.target.parent.target.parent.parent.elf.exports.${number}`]: string[]; [x: `process.target.target.target.parent.target.parent.parent.elf.imports.${number}`]: string[]; [x: `process.target.target.target.parent.target.parent.parent.elf.sections.${number}`]: string[]; [x: `process.target.target.target.parent.target.parent.parent.elf.segments.${number}`]: string[]; [x: `process.target.target.target.parent.target.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.target.parent.target.parent.parent.parent.args.${number}`]: string[]; [x: `process.target.target.target.parent.target.parent.parent.target.args.${number}`]: string[]; [x: `process.target.target.target.parent.target.parent.target.elf.exports.${number}`]: string[]; [x: `process.target.target.target.parent.target.parent.target.elf.imports.${number}`]: string[]; [x: `process.target.target.target.parent.target.parent.target.elf.sections.${number}`]: string[]; [x: `process.target.target.target.parent.target.parent.target.elf.segments.${number}`]: string[]; [x: `process.target.target.target.parent.target.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.target.parent.target.parent.target.parent.args.${number}`]: string[]; [x: `process.target.target.target.parent.target.parent.target.target.args.${number}`]: string[]; [x: `process.target.target.target.parent.target.target.parent.elf.exports.${number}`]: string[]; [x: `process.target.target.target.parent.target.target.parent.elf.imports.${number}`]: string[]; [x: `process.target.target.target.parent.target.target.parent.elf.sections.${number}`]: string[]; [x: `process.target.target.target.parent.target.target.parent.elf.segments.${number}`]: string[]; [x: `process.target.target.target.parent.target.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.target.parent.target.target.parent.parent.args.${number}`]: string[]; [x: `process.target.target.target.parent.target.target.parent.target.args.${number}`]: string[]; [x: `process.target.target.target.parent.target.target.target.elf.exports.${number}`]: string[]; [x: `process.target.target.target.parent.target.target.target.elf.imports.${number}`]: string[]; [x: `process.target.target.target.parent.target.target.target.elf.sections.${number}`]: string[]; [x: `process.target.target.target.parent.target.target.target.elf.segments.${number}`]: string[]; [x: `process.target.target.target.parent.target.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.target.parent.target.target.target.parent.args.${number}`]: string[]; [x: `process.target.target.target.parent.target.target.target.target.args.${number}`]: string[]; [x: `process.target.target.target.target.parent.parent.parent.elf.exports.${number}`]: string[]; [x: `process.target.target.target.target.parent.parent.parent.elf.imports.${number}`]: string[]; [x: `process.target.target.target.target.parent.parent.parent.elf.sections.${number}`]: string[]; [x: `process.target.target.target.target.parent.parent.parent.elf.segments.${number}`]: string[]; [x: `process.target.target.target.target.parent.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.target.target.parent.parent.parent.parent.args.${number}`]: string[]; [x: `process.target.target.target.target.parent.parent.parent.target.args.${number}`]: string[]; [x: `process.target.target.target.target.parent.parent.target.elf.exports.${number}`]: string[]; [x: `process.target.target.target.target.parent.parent.target.elf.imports.${number}`]: string[]; [x: `process.target.target.target.target.parent.parent.target.elf.sections.${number}`]: string[]; [x: `process.target.target.target.target.parent.parent.target.elf.segments.${number}`]: string[]; [x: `process.target.target.target.target.parent.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.target.target.parent.parent.target.parent.args.${number}`]: string[]; [x: `process.target.target.target.target.parent.parent.target.target.args.${number}`]: string[]; [x: `process.target.target.target.target.parent.target.parent.elf.exports.${number}`]: string[]; [x: `process.target.target.target.target.parent.target.parent.elf.imports.${number}`]: string[]; [x: `process.target.target.target.target.parent.target.parent.elf.sections.${number}`]: string[]; [x: `process.target.target.target.target.parent.target.parent.elf.segments.${number}`]: string[]; [x: `process.target.target.target.target.parent.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.target.target.parent.target.parent.parent.args.${number}`]: string[]; [x: `process.target.target.target.target.parent.target.parent.target.args.${number}`]: string[]; [x: `process.target.target.target.target.parent.target.target.elf.exports.${number}`]: string[]; [x: `process.target.target.target.target.parent.target.target.elf.imports.${number}`]: string[]; [x: `process.target.target.target.target.parent.target.target.elf.sections.${number}`]: string[]; [x: `process.target.target.target.target.parent.target.target.elf.segments.${number}`]: string[]; [x: `process.target.target.target.target.parent.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.target.target.parent.target.target.parent.args.${number}`]: string[]; [x: `process.target.target.target.target.parent.target.target.target.args.${number}`]: string[]; [x: `process.target.target.target.target.target.parent.parent.elf.exports.${number}`]: string[]; [x: `process.target.target.target.target.target.parent.parent.elf.imports.${number}`]: string[]; [x: `process.target.target.target.target.target.parent.parent.elf.sections.${number}`]: string[]; [x: `process.target.target.target.target.target.parent.parent.elf.segments.${number}`]: string[]; [x: `process.target.target.target.target.target.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.target.target.target.parent.parent.parent.args.${number}`]: string[]; [x: `process.target.target.target.target.target.parent.parent.target.args.${number}`]: string[]; [x: `process.target.target.target.target.target.parent.target.elf.exports.${number}`]: string[]; [x: `process.target.target.target.target.target.parent.target.elf.imports.${number}`]: string[]; [x: `process.target.target.target.target.target.parent.target.elf.sections.${number}`]: string[]; [x: `process.target.target.target.target.target.parent.target.elf.segments.${number}`]: string[]; [x: `process.target.target.target.target.target.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.target.target.target.parent.target.parent.args.${number}`]: string[]; [x: `process.target.target.target.target.target.parent.target.target.args.${number}`]: string[]; [x: `process.target.target.target.target.target.target.parent.elf.exports.${number}`]: string[]; [x: `process.target.target.target.target.target.target.parent.elf.imports.${number}`]: string[]; [x: `process.target.target.target.target.target.target.parent.elf.sections.${number}`]: string[]; [x: `process.target.target.target.target.target.target.parent.elf.segments.${number}`]: string[]; [x: `process.target.target.target.target.target.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.target.target.target.target.parent.parent.args.${number}`]: string[]; [x: `process.target.target.target.target.target.target.parent.target.args.${number}`]: string[]; [x: `process.target.target.target.target.target.target.target.elf.exports.${number}`]: string[]; [x: `process.target.target.target.target.target.target.target.elf.imports.${number}`]: string[]; [x: `process.target.target.target.target.target.target.target.elf.sections.${number}`]: string[]; [x: `process.target.target.target.target.target.target.target.elf.segments.${number}`]: string[]; [x: `process.target.target.target.target.target.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.target.target.target.target.target.parent.args.${number}`]: string[]; [x: `process.target.target.target.target.target.target.target.target.args.${number}`]: string[]; [x: `related.ip.${number}`]: string[]; [x: `related.user.${number}`]: string[]; [x: `related.hash.${number}`]: string[]; [x: `related.hosts.${number}`]: string[]; [x: `threat.group.alias.${number}`]: string[]; [x: `threat.indicator.x509.issuer.organization.${number}`]: string[]; [x: `threat.indicator.x509.issuer.common_name.${number}`]: string[]; [x: `threat.indicator.x509.issuer.country.${number}`]: string[]; [x: `threat.indicator.x509.issuer.locality.${number}`]: string[]; [x: `threat.indicator.x509.issuer.organizational_unit.${number}`]: string[]; [x: `threat.indicator.x509.issuer.state_or_province.${number}`]: string[]; [x: `threat.indicator.x509.subject.organization.${number}`]: string[]; [x: `threat.indicator.x509.subject.common_name.${number}`]: string[]; [x: `threat.indicator.x509.subject.country.${number}`]: string[]; [x: `threat.indicator.x509.subject.locality.${number}`]: string[]; [x: `threat.indicator.x509.subject.organizational_unit.${number}`]: string[]; [x: `threat.indicator.x509.subject.state_or_province.${number}`]: string[]; [x: `threat.indicator.x509.alternative_names.${number}`]: string[]; [x: `threat.indicator.file.attributes.${number}`]: string[]; [x: `threat.indicator.file.elf.exports.${number}`]: string[]; [x: `threat.indicator.file.elf.imports.${number}`]: string[]; [x: `threat.indicator.file.elf.sections.${number}`]: string[]; [x: `threat.indicator.file.elf.segments.${number}`]: string[]; [x: `threat.indicator.file.elf.shared_libraries.${number}`]: string[]; [x: `threat.indicator.file.x509.issuer.organization.${number}`]: string[]; [x: `threat.indicator.file.x509.issuer.common_name.${number}`]: string[]; [x: `threat.indicator.file.x509.issuer.country.${number}`]: string[]; [x: `threat.indicator.file.x509.issuer.locality.${number}`]: string[]; [x: `threat.indicator.file.x509.issuer.organizational_unit.${number}`]: string[]; [x: `threat.indicator.file.x509.issuer.state_or_province.${number}`]: string[]; [x: `threat.indicator.file.x509.subject.organization.${number}`]: string[]; [x: `threat.indicator.file.x509.subject.common_name.${number}`]: string[]; [x: `threat.indicator.file.x509.subject.country.${number}`]: string[]; [x: `threat.indicator.file.x509.subject.locality.${number}`]: string[]; [x: `threat.indicator.file.x509.subject.organizational_unit.${number}`]: string[]; [x: `threat.indicator.file.x509.subject.state_or_province.${number}`]: string[]; [x: `threat.indicator.file.x509.alternative_names.${number}`]: string[]; [x: `threat.indicator.registry.data.strings.${number}`]: string[]; [x: `threat.enrichments.${number}`]: string[]; [x: `threat.enrichments.${number}.indicator.x509.issuer.organization.${number}`]: string[]; [x: `threat.enrichments.${number}.indicator.x509.issuer.common_name.${number}`]: string[]; [x: `threat.enrichments.${number}.indicator.x509.issuer.country.${number}`]: string[]; [x: `threat.enrichments.${number}.indicator.x509.issuer.locality.${number}`]: string[]; [x: `threat.enrichments.${number}.indicator.x509.issuer.organizational_unit.${number}`]: string[]; [x: `threat.enrichments.${number}.indicator.x509.issuer.state_or_province.${number}`]: string[]; [x: `threat.enrichments.${number}.indicator.x509.subject.organization.${number}`]: string[]; [x: `threat.enrichments.${number}.indicator.x509.subject.common_name.${number}`]: string[]; [x: `threat.enrichments.${number}.indicator.x509.subject.country.${number}`]: string[]; [x: `threat.enrichments.${number}.indicator.x509.subject.locality.${number}`]: string[]; [x: `threat.enrichments.${number}.indicator.x509.subject.organizational_unit.${number}`]: string[]; [x: `threat.enrichments.${number}.indicator.x509.subject.state_or_province.${number}`]: string[]; [x: `threat.enrichments.${number}.indicator.x509.alternative_names.${number}`]: string[]; [x: `threat.enrichments.${number}.indicator.file.attributes.${number}`]: string[]; [x: `threat.enrichments.${number}.indicator.file.elf.exports.${number}`]: string[]; [x: `threat.enrichments.${number}.indicator.file.elf.imports.${number}`]: string[]; [x: `threat.enrichments.${number}.indicator.file.elf.sections.${number}`]: string[]; [x: `threat.enrichments.${number}.indicator.file.elf.segments.${number}`]: string[]; [x: `threat.enrichments.${number}.indicator.file.elf.shared_libraries.${number}`]: string[]; [x: `threat.enrichments.${number}.indicator.file.x509.issuer.organization.${number}`]: string[]; [x: `threat.enrichments.${number}.indicator.file.x509.issuer.common_name.${number}`]: string[]; [x: `threat.enrichments.${number}.indicator.file.x509.issuer.country.${number}`]: string[]; [x: `threat.enrichments.${number}.indicator.file.x509.issuer.locality.${number}`]: string[]; [x: `threat.enrichments.${number}.indicator.file.x509.issuer.organizational_unit.${number}`]: string[]; [x: `threat.enrichments.${number}.indicator.file.x509.issuer.state_or_province.${number}`]: string[]; [x: `threat.enrichments.${number}.indicator.file.x509.subject.organization.${number}`]: string[]; [x: `threat.enrichments.${number}.indicator.file.x509.subject.common_name.${number}`]: string[]; [x: `threat.enrichments.${number}.indicator.file.x509.subject.country.${number}`]: string[]; [x: `threat.enrichments.${number}.indicator.file.x509.subject.locality.${number}`]: string[]; [x: `threat.enrichments.${number}.indicator.file.x509.subject.organizational_unit.${number}`]: string[]; [x: `threat.enrichments.${number}.indicator.file.x509.subject.state_or_province.${number}`]: string[]; [x: `threat.enrichments.${number}.indicator.file.x509.alternative_names.${number}`]: string[]; [x: `threat.enrichments.${number}.indicator.registry.data.strings.${number}`]: string[]; [x: `threat.software.platforms.${number}`]: string[]; [x: `threat.tactic.id.${number}`]: string[]; [x: `threat.tactic.name.${number}`]: string[]; [x: `threat.tactic.reference.${number}`]: string[]; [x: `threat.technique.id.${number}`]: string[]; [x: `threat.technique.name.${number}`]: string[]; [x: `threat.technique.reference.${number}`]: string[]; [x: `threat.technique.subtechnique.id.${number}`]: string[]; [x: `threat.technique.subtechnique.name.${number}`]: string[]; [x: `threat.technique.subtechnique.reference.${number}`]: string[]; [x: `threat.technique.subtechnique.subtechnique.id.${number}`]: string[]; [x: `threat.technique.subtechnique.subtechnique.name.${number}`]: string[]; [x: `threat.technique.subtechnique.subtechnique.reference.${number}`]: string[]; [x: `threat.technique.subtechnique.subtechnique.subtechnique.id.${number}`]: string[]; [x: `threat.technique.subtechnique.subtechnique.subtechnique.name.${number}`]: string[]; [x: `threat.technique.subtechnique.subtechnique.subtechnique.reference.${number}`]: string[]; [x: `threat.technique.subtechnique.subtechnique.subtechnique.subtechnique.id.${number}`]: string[]; [x: `threat.technique.subtechnique.subtechnique.subtechnique.subtechnique.name.${number}`]: string[]; [x: `threat.technique.subtechnique.subtechnique.subtechnique.subtechnique.reference.${number}`]: string[]; [x: `threat.technique.subtechnique.subtechnique.subtechnique.subtechnique.subtechnique.id.${number}`]: string[]; [x: `threat.technique.subtechnique.subtechnique.subtechnique.subtechnique.subtechnique.name.${number}`]: string[]; [x: `threat.technique.subtechnique.subtechnique.subtechnique.subtechnique.subtechnique.reference.${number}`]: string[]; [x: `threat.technique.subtechnique.subtechnique.subtechnique.subtechnique.subtechnique.subtechnique.id.${number}`]: string[]; [x: `threat.technique.subtechnique.subtechnique.subtechnique.subtechnique.subtechnique.subtechnique.name.${number}`]: string[]; [x: `threat.technique.subtechnique.subtechnique.subtechnique.subtechnique.subtechnique.subtechnique.reference.${number}`]: string[]; [x: `threat.technique.subtechnique.subtechnique.subtechnique.subtechnique.subtechnique.subtechnique.subtechnique.id.${number}`]: string[]; [x: `threat.technique.subtechnique.subtechnique.subtechnique.subtechnique.subtechnique.subtechnique.subtechnique.name.${number}`]: string[]; [x: `threat.technique.subtechnique.subtechnique.subtechnique.subtechnique.subtechnique.subtechnique.subtechnique.reference.${number}`]: string[]; [x: `tls.client.x509.issuer.organization.${number}`]: string[]; [x: `tls.client.x509.issuer.common_name.${number}`]: string[]; [x: `tls.client.x509.issuer.country.${number}`]: string[]; [x: `tls.client.x509.issuer.locality.${number}`]: string[]; [x: `tls.client.x509.issuer.organizational_unit.${number}`]: string[]; [x: `tls.client.x509.issuer.state_or_province.${number}`]: string[]; [x: `tls.client.x509.subject.organization.${number}`]: string[]; [x: `tls.client.x509.subject.common_name.${number}`]: string[]; [x: `tls.client.x509.subject.country.${number}`]: string[]; [x: `tls.client.x509.subject.locality.${number}`]: string[]; [x: `tls.client.x509.subject.organizational_unit.${number}`]: string[]; [x: `tls.client.x509.subject.state_or_province.${number}`]: string[]; [x: `tls.client.x509.alternative_names.${number}`]: string[]; [x: `tls.client.certificate_chain.${number}`]: string[]; [x: `tls.client.supported_ciphers.${number}`]: string[]; [x: `tls.server.x509.issuer.organization.${number}`]: string[]; [x: `tls.server.x509.issuer.common_name.${number}`]: string[]; [x: `tls.server.x509.issuer.country.${number}`]: string[]; [x: `tls.server.x509.issuer.locality.${number}`]: string[]; [x: `tls.server.x509.issuer.organizational_unit.${number}`]: string[]; [x: `tls.server.x509.issuer.state_or_province.${number}`]: string[]; [x: `tls.server.x509.subject.organization.${number}`]: string[]; [x: `tls.server.x509.subject.common_name.${number}`]: string[]; [x: `tls.server.x509.subject.country.${number}`]: string[]; [x: `tls.server.x509.subject.locality.${number}`]: string[]; [x: `tls.server.x509.subject.organizational_unit.${number}`]: string[]; [x: `tls.server.x509.subject.state_or_province.${number}`]: string[]; [x: `tls.server.x509.alternative_names.${number}`]: string[]; [x: `tls.server.certificate_chain.${number}`]: string[]; [x: `vulnerability.category.${number}`]: string[]; }" + ], + "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", + "deprecated": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.AlertsTableFlyoutBaseProps.isLoading", + "type": "boolean", + "tags": [], + "label": "isLoading", + "description": [], + "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, { "parentPluginId": "triggersActionsUi", "id": "def-public.AlertsTableProps", @@ -2053,6 +2107,19 @@ "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "deprecated": false, "children": [ + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.AlertsTableProps.alertsTableConfiguration", + "type": "Object", + "tags": [], + "label": "alertsTableConfiguration", + "description": [], + "signature": [ + "AlertsTableConfigurationRegistry" + ], + "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", + "deprecated": false + }, { "parentPluginId": "triggersActionsUi", "id": "def-public.AlertsTableProps.columns", @@ -2112,6 +2179,25 @@ "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "deprecated": false }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.AlertsTableProps.flyoutState", + "type": "Enum", + "tags": [], + "label": "flyoutState", + "description": [], + "signature": [ + { + "pluginId": "triggersActionsUi", + "scope": "public", + "docId": "kibTriggersActionsUiPluginApi", + "section": "def-public.AlertsTableFlyoutState", + "text": "AlertsTableFlyoutState" + } + ], + "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", + "deprecated": false + }, { "parentPluginId": "triggersActionsUi", "id": "def-public.AlertsTableProps.pageSize", @@ -2151,42 +2237,20 @@ }, { "parentPluginId": "triggersActionsUi", - "id": "def-public.AlertsTableProps.renderCellValue", - "type": "Function", + "id": "def-public.AlertsTableProps.showCheckboxes", + "type": "boolean", "tags": [], - "label": "renderCellValue", + "label": "showCheckboxes", "description": [], - "signature": [ - "(props: ", - "RenderCellValueProps", - ") => React.ReactNode" - ], "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "triggersActionsUi", - "id": "def-public.AlertsTableProps.renderCellValue.$1", - "type": "CompoundType", - "tags": [], - "label": "props", - "description": [], - "signature": [ - "RenderCellValueProps" - ], - "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] + "deprecated": false }, { "parentPluginId": "triggersActionsUi", - "id": "def-public.AlertsTableProps.showCheckboxes", + "id": "def-public.AlertsTableProps.showExpandToDetails", "type": "boolean", "tags": [], - "label": "showCheckboxes", + "label": "showExpandToDetails", "description": [], "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "deprecated": false @@ -2221,6 +2285,19 @@ "children": [], "returnComment": [] }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.AlertsTableProps.visibleColumns", + "type": "Array", + "tags": [], + "label": "visibleColumns", + "description": [], + "signature": [ + "string[]" + ], + "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", + "deprecated": false + }, { "parentPluginId": "triggersActionsUi", "id": "def-public.AlertsTableProps.datatestsubj", @@ -3309,7 +3386,13 @@ "label": "dataViews", "description": [], "signature": [ - "DataViewsServicePublic" + { + "pluginId": "dataViews", + "scope": "public", + "docId": "kibDataViewsPluginApi", + "section": "def-public.DataViewsServicePublic", + "text": "DataViewsServicePublic" + } ], "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "deprecated": false @@ -3390,7 +3473,13 @@ "label": "dataViews", "description": [], "signature": [ - "DataViewsServicePublic" + { + "pluginId": "dataViews", + "scope": "public", + "docId": "kibDataViewsPluginApi", + "section": "def-public.DataViewsServicePublic", + "text": "DataViewsServicePublic" + } ], "path": "x-pack/plugins/triggers_actions_ui/public/application/app.tsx", "deprecated": false @@ -3744,6 +3833,17 @@ } ], "enums": [ + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.AlertsTableFlyoutState", + "type": "Enum", + "tags": [], + "label": "AlertsTableFlyoutState", + "description": [], + "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", + "deprecated": false, + "initialIsOpen": false + }, { "parentPluginId": "triggersActionsUi", "id": "def-public.COMPARATORS", @@ -3871,6 +3971,36 @@ "deprecated": false, "initialIsOpen": false }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.AlertTableFlyoutComponent", + "type": "Type", + "tags": [], + "label": "AlertTableFlyoutComponent", + "description": [], + "signature": [ + "React.FunctionComponent<", + { + "pluginId": "triggersActionsUi", + "scope": "public", + "docId": "kibTriggersActionsUiPluginApi", + "section": "def-public.AlertsTableFlyoutBaseProps", + "text": "AlertsTableFlyoutBaseProps" + }, + "> | React.LazyExoticComponent> | null" + ], + "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", + "deprecated": false, + "initialIsOpen": false + }, { "parentPluginId": "triggersActionsUi", "id": "def-public.AsApiContract", @@ -3887,17 +4017,32 @@ }, { "parentPluginId": "triggersActionsUi", - "id": "def-public.NOTIFY_WHEN_OPTIONS", - "type": "Array", + "id": "def-public.GetRenderCellValue", + "type": "Type", "tags": [], - "label": "NOTIFY_WHEN_OPTIONS", + "label": "GetRenderCellValue", "description": [], "signature": [ - "EuiSuperSelectOption", - "<\"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\">[]" + "({ setFlyoutAlert, }: { setFlyoutAlert?: ((data: unknown) => void) | undefined; }) => (props: unknown) => React.ReactNode" ], - "path": "x-pack/plugins/triggers_actions_ui/public/application/sections/rule_form/rule_notify_when.tsx", + "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.GetRenderCellValue.$1", + "type": "Object", + "tags": [], + "label": "__0", + "description": [], + "signature": [ + "{ setFlyoutAlert?: ((data: unknown) => void) | undefined; }" + ], + "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { diff --git a/api_docs/triggers_actions_ui.mdx b/api_docs/triggers_actions_ui.mdx index b0933be896e01d..b3640c2043f6cf 100644 --- a/api_docs/triggers_actions_ui.mdx +++ b/api_docs/triggers_actions_ui.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/triggersActionsUi title: "triggersActionsUi" image: https://source.unsplash.com/400x175/?github summary: API docs for the triggersActionsUi plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'triggersActionsUi'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Response Ops](https://github.com/orgs/elastic/teams/response-ops) for q | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 374 | 0 | 360 | 34 | +| 383 | 0 | 369 | 33 | ## Client diff --git a/api_docs/ui_actions.mdx b/api_docs/ui_actions.mdx index 7ac1bf72da390b..f98fd7ff120c06 100644 --- a/api_docs/ui_actions.mdx +++ b/api_docs/ui_actions.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/uiActions title: "uiActions" image: https://source.unsplash.com/400x175/?github summary: API docs for the uiActions plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'uiActions'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/ui_actions_enhanced.mdx b/api_docs/ui_actions_enhanced.mdx index 24bd693b2f85b5..81aec2ed15427b 100644 --- a/api_docs/ui_actions_enhanced.mdx +++ b/api_docs/ui_actions_enhanced.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/uiActionsEnhanced title: "uiActionsEnhanced" image: https://source.unsplash.com/400x175/?github summary: API docs for the uiActionsEnhanced plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'uiActionsEnhanced'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/unified_search.mdx b/api_docs/unified_search.mdx index 5c582da19bdd34..2c08218161a8b0 100644 --- a/api_docs/unified_search.mdx +++ b/api_docs/unified_search.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/unifiedSearch title: "unifiedSearch" image: https://source.unsplash.com/400x175/?github summary: API docs for the unifiedSearch plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'unifiedSearch'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/unified_search_autocomplete.devdocs.json b/api_docs/unified_search_autocomplete.devdocs.json index c3f2543a9c9cb1..3866502e40d223 100644 --- a/api_docs/unified_search_autocomplete.devdocs.json +++ b/api_docs/unified_search_autocomplete.devdocs.json @@ -36,8 +36,8 @@ "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.IIndexPattern", - "text": "IIndexPattern" + "section": "def-common.DataView", + "text": "DataView" }, "[]" ], diff --git a/api_docs/unified_search_autocomplete.mdx b/api_docs/unified_search_autocomplete.mdx index a49b78f67908a9..1c8157fd202a5a 100644 --- a/api_docs/unified_search_autocomplete.mdx +++ b/api_docs/unified_search_autocomplete.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/unifiedSearch-autocomplete title: "unifiedSearch.autocomplete" image: https://source.unsplash.com/400x175/?github summary: API docs for the unifiedSearch.autocomplete plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'unifiedSearch.autocomplete'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/url_forwarding.mdx b/api_docs/url_forwarding.mdx index fe09a9cb32c88e..bba3e23251d715 100644 --- a/api_docs/url_forwarding.mdx +++ b/api_docs/url_forwarding.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/urlForwarding title: "urlForwarding" image: https://source.unsplash.com/400x175/?github summary: API docs for the urlForwarding plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'urlForwarding'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/usage_collection.devdocs.json b/api_docs/usage_collection.devdocs.json index 8978c71dc262e0..c8e999ebd31a43 100644 --- a/api_docs/usage_collection.devdocs.json +++ b/api_docs/usage_collection.devdocs.json @@ -2190,7 +2190,7 @@ "\r\nPossible type values in the schema" ], "signature": [ - "\"boolean\" | \"keyword\" | \"text\" | \"date\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"double\"" + "\"boolean\" | \"keyword\" | \"text\" | \"date\" | \"long\" | \"double\" | \"short\" | \"float\" | \"integer\" | \"byte\"" ], "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, diff --git a/api_docs/usage_collection.mdx b/api_docs/usage_collection.mdx index c1e0bb33fe8396..5d2f5b37565ede 100644 --- a/api_docs/usage_collection.mdx +++ b/api_docs/usage_collection.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/usageCollection title: "usageCollection" image: https://source.unsplash.com/400x175/?github summary: API docs for the usageCollection plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'usageCollection'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/ux.mdx b/api_docs/ux.mdx index 4110f94fb7e481..7a14e9ac04451a 100644 --- a/api_docs/ux.mdx +++ b/api_docs/ux.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/ux title: "ux" image: https://source.unsplash.com/400x175/?github summary: API docs for the ux plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'ux'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/vis_default_editor.mdx b/api_docs/vis_default_editor.mdx index 16d74687338a39..0d5d677285787c 100644 --- a/api_docs/vis_default_editor.mdx +++ b/api_docs/vis_default_editor.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visDefaultEditor title: "visDefaultEditor" image: https://source.unsplash.com/400x175/?github summary: API docs for the visDefaultEditor plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visDefaultEditor'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/vis_type_gauge.mdx b/api_docs/vis_type_gauge.mdx index d332d95f26729b..6ab75ff9db67ac 100644 --- a/api_docs/vis_type_gauge.mdx +++ b/api_docs/vis_type_gauge.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visTypeGauge title: "visTypeGauge" image: https://source.unsplash.com/400x175/?github summary: API docs for the visTypeGauge plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeGauge'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/vis_type_heatmap.mdx b/api_docs/vis_type_heatmap.mdx index 45865f8df920e0..9b95f513183b2a 100644 --- a/api_docs/vis_type_heatmap.mdx +++ b/api_docs/vis_type_heatmap.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visTypeHeatmap title: "visTypeHeatmap" image: https://source.unsplash.com/400x175/?github summary: API docs for the visTypeHeatmap plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeHeatmap'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/vis_type_pie.mdx b/api_docs/vis_type_pie.mdx index 2f684b92a7ac13..d46544ebdbcc12 100644 --- a/api_docs/vis_type_pie.mdx +++ b/api_docs/vis_type_pie.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visTypePie title: "visTypePie" image: https://source.unsplash.com/400x175/?github summary: API docs for the visTypePie plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypePie'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/vis_type_table.mdx b/api_docs/vis_type_table.mdx index 95d0bdd7f8e192..6c09b2e2ee3b87 100644 --- a/api_docs/vis_type_table.mdx +++ b/api_docs/vis_type_table.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visTypeTable title: "visTypeTable" image: https://source.unsplash.com/400x175/?github summary: API docs for the visTypeTable plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeTable'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/vis_type_timelion.mdx b/api_docs/vis_type_timelion.mdx index f274568753a10f..11b5aa7e30a7a9 100644 --- a/api_docs/vis_type_timelion.mdx +++ b/api_docs/vis_type_timelion.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visTypeTimelion title: "visTypeTimelion" image: https://source.unsplash.com/400x175/?github summary: API docs for the visTypeTimelion plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeTimelion'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/vis_type_timeseries.mdx b/api_docs/vis_type_timeseries.mdx index a44c6d12d0b679..b0520767ed9bb0 100644 --- a/api_docs/vis_type_timeseries.mdx +++ b/api_docs/vis_type_timeseries.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visTypeTimeseries title: "visTypeTimeseries" image: https://source.unsplash.com/400x175/?github summary: API docs for the visTypeTimeseries plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeTimeseries'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/vis_type_vega.mdx b/api_docs/vis_type_vega.mdx index 0f2ce9a8489043..e5b756e0cd4abe 100644 --- a/api_docs/vis_type_vega.mdx +++ b/api_docs/vis_type_vega.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visTypeVega title: "visTypeVega" image: https://source.unsplash.com/400x175/?github summary: API docs for the visTypeVega plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeVega'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/vis_type_vislib.devdocs.json b/api_docs/vis_type_vislib.devdocs.json index 502f92a30a92d0..ad1196c6483085 100644 --- a/api_docs/vis_type_vislib.devdocs.json +++ b/api_docs/vis_type_vislib.devdocs.json @@ -39,7 +39,7 @@ "label": "type", "description": [], "signature": [ - "\"goal\" | \"heatmap\" | \"gauge\" | \"metric\" | \"pie\"" + "\"goal\" | \"heatmap\" | \"metric\" | \"gauge\" | \"pie\"" ], "path": "src/plugins/vis_types/vislib/public/types.ts", "deprecated": false @@ -338,7 +338,7 @@ "label": "VislibChartType", "description": [], "signature": [ - "\"goal\" | \"heatmap\" | \"gauge\" | \"metric\" | \"pie\"" + "\"goal\" | \"heatmap\" | \"metric\" | \"gauge\" | \"pie\"" ], "path": "src/plugins/vis_types/vislib/public/types.ts", "deprecated": false, diff --git a/api_docs/vis_type_vislib.mdx b/api_docs/vis_type_vislib.mdx index 5e602875fc604d..a87e68f9497d1f 100644 --- a/api_docs/vis_type_vislib.mdx +++ b/api_docs/vis_type_vislib.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visTypeVislib title: "visTypeVislib" image: https://source.unsplash.com/400x175/?github summary: API docs for the visTypeVislib plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeVislib'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/vis_type_xy.mdx b/api_docs/vis_type_xy.mdx index 56d96e2b404414..7ab3ed1abe0a78 100644 --- a/api_docs/vis_type_xy.mdx +++ b/api_docs/vis_type_xy.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visTypeXy title: "visTypeXy" image: https://source.unsplash.com/400x175/?github summary: API docs for the visTypeXy plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeXy'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/visualizations.devdocs.json b/api_docs/visualizations.devdocs.json index 0955a832d785c5..84b905bdf8b8d5 100644 --- a/api_docs/visualizations.devdocs.json +++ b/api_docs/visualizations.devdocs.json @@ -152,6 +152,16 @@ "path": "src/plugins/visualizations/public/vis_types/base_vis_type.ts", "deprecated": false }, + { + "parentPluginId": "visualizations", + "id": "def-public.BaseVisType.isDeprecated", + "type": "boolean", + "tags": [], + "label": "isDeprecated", + "description": [], + "path": "src/plugins/visualizations/public/vis_types/base_vis_type.ts", + "deprecated": false + }, { "parentPluginId": "visualizations", "id": "def-public.BaseVisType.group", @@ -240,6 +250,19 @@ "path": "src/plugins/visualizations/public/vis_types/base_vis_type.ts", "deprecated": false }, + { + "parentPluginId": "visualizations", + "id": "def-public.BaseVisType.hasPartialRows", + "type": "CompoundType", + "tags": [], + "label": "hasPartialRows", + "description": [], + "signature": [ + "boolean | ((vis: { params: TVisParams; }) => boolean)" + ], + "path": "src/plugins/visualizations/public/vis_types/base_vis_type.ts", + "deprecated": false + }, { "parentPluginId": "visualizations", "id": "def-public.BaseVisType.hierarchicalData", @@ -347,6 +370,16 @@ "path": "src/plugins/visualizations/public/vis_types/base_vis_type.ts", "deprecated": false }, + { + "parentPluginId": "visualizations", + "id": "def-public.BaseVisType.fetchDatatable", + "type": "boolean", + "tags": [], + "label": "fetchDatatable", + "description": [], + "path": "src/plugins/visualizations/public/vis_types/base_vis_type.ts", + "deprecated": false + }, { "parentPluginId": "visualizations", "id": "def-public.BaseVisType.toExpressionAst", @@ -3177,21 +3210,9 @@ ">; getFetch$: () => ", "Observable", "; getTime: () => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, + "TimeRange", "; getAbsoluteTime: () => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, + "TimeRange", "; setTime: (time: ", "InputTimeRange", ") => void; getRefreshInterval: () => ", @@ -3215,17 +3236,11 @@ "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.IIndexPattern", - "text": "IIndexPattern" + "section": "def-common.DataView", + "text": "DataView" }, ", timeRange?: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, + "TimeRange", " | undefined) => ", "RangeFilter", " | ", @@ -3235,17 +3250,11 @@ "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.IIndexPattern", - "text": "IIndexPattern" + "section": "def-common.DataView", + "text": "DataView" }, ", timeRange?: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, + "TimeRange", " | undefined) => ", "RangeFilter", " | ", @@ -3259,13 +3268,7 @@ "text": "TimeRangeBounds" }, "; calculateBounds: (timeRange: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, + "TimeRange", ") => ", { "pluginId": "data", @@ -3283,13 +3286,7 @@ "text": "TimeRangeBounds" }, " | undefined; enableTimeRangeSelector: () => void; disableTimeRangeSelector: () => void; enableAutoRefreshSelector: () => void; disableAutoRefreshSelector: () => void; getTimeDefaults: () => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, + "TimeRange", "; getRefreshIntervalDefaults: () => ", { "pluginId": "data", @@ -3456,6 +3453,19 @@ "path": "src/plugins/visualizations/public/vis_types/vis_type_alias_registry.ts", "deprecated": false }, + { + "parentPluginId": "visualizations", + "id": "def-public.VisTypeAlias.isDeprecated", + "type": "CompoundType", + "tags": [], + "label": "isDeprecated", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/visualizations/public/vis_types/vis_type_alias_registry.ts", + "deprecated": false + }, { "parentPluginId": "visualizations", "id": "def-public.VisTypeAlias.appExtensions", @@ -3775,6 +3785,21 @@ "path": "src/plugins/visualizations/public/vis_types/types.ts", "deprecated": false }, + { + "parentPluginId": "visualizations", + "id": "def-public.VisTypeDefinition.isDeprecated", + "type": "CompoundType", + "tags": [], + "label": "isDeprecated", + "description": [ + "\nIt sets the vis type on a deprecated mode when is true" + ], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/visualizations/public/vis_types/types.ts", + "deprecated": false + }, { "parentPluginId": "visualizations", "id": "def-public.VisTypeDefinition.group", @@ -3829,6 +3854,21 @@ "path": "src/plugins/visualizations/public/vis_types/types.ts", "deprecated": false }, + { + "parentPluginId": "visualizations", + "id": "def-public.VisTypeDefinition.hasPartialRows", + "type": "CompoundType", + "tags": [], + "label": "hasPartialRows", + "description": [ + "\nIn case when the visualization performs an aggregation, this option will be used to display or hide the rows with partial data." + ], + "signature": [ + "boolean | ((vis: { params: TVisParams; }) => boolean) | undefined" + ], + "path": "src/plugins/visualizations/public/vis_types/types.ts", + "deprecated": false + }, { "parentPluginId": "visualizations", "id": "def-public.VisTypeDefinition.hierarchicalData", @@ -3933,6 +3973,23 @@ ], "returnComment": [] }, + { + "parentPluginId": "visualizations", + "id": "def-public.VisTypeDefinition.fetchDatatable", + "type": "CompoundType", + "tags": [ + "default" + ], + "label": "fetchDatatable", + "description": [ + "\nWhen truthy, it will perform a search and pass the results to the visualization as a `datatable`." + ], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/visualizations/public/vis_types/types.ts", + "deprecated": false + }, { "parentPluginId": "visualizations", "id": "def-public.VisTypeDefinition.toExpressionAst", @@ -4720,13 +4777,7 @@ "label": "timeRange", "description": [], "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, + "TimeRange", " | undefined" ], "path": "src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx", diff --git a/api_docs/visualizations.mdx b/api_docs/visualizations.mdx index 7a0ddbd58caefa..4e3d4adb2698e7 100644 --- a/api_docs/visualizations.mdx +++ b/api_docs/visualizations.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visualizations title: "visualizations" image: https://source.unsplash.com/400x175/?github summary: API docs for the visualizations plugin -date: 2022-05-24 +date: 2022-06-07 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visualizations'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 372 | 12 | 351 | 14 | +| 379 | 12 | 355 | 14 | ## Client